Shareworks · Schema

Company Response

Equity CompensationStock OptionsRSUESPPEmployee EquityFinancial ServicesMorgan StanleyEquity AdministrationPrivate CompaniesPublic Companies

Properties

Name	Type	Description
companyId	integer	Identifier for the company
companyName	string	Name for the company
enforceOneToOneDesignationToFund	boolean	Require unique Fund for each Designation
phone	string	Primary phone number for the company
fiscalYearEnd	string	Fiscal year end for the company
stateOfIncorporation	string	The state of incorporation for the company, if it is U.S.-based
dateOfIncorporation	string	The date of incorporation for the company
entityType	string	Entity type for the company (e.g. LLC)
companyAddresses	array	List of up to three company addresses
contacts	array	List of all company contacts

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/shareworks/main/json-schema/CompanyDetails.json",
  "title": "Company Response",
  "required": [
    "companyName"
  ],
  "type": "object",
  "properties": {
    "companyId": {
      "type": "integer",
      "description": "Identifier for the company",
      "format": "int32"
    },
    "companyName": {
      "type": "string",
      "description": "Name for the company"
    },
    "enforceOneToOneDesignationToFund": {
      "type": "boolean",
      "description": "Require unique Fund for each Designation"
    },
    "phone": {
      "type": "string",
      "description": "Primary phone number for the company"
    },
    "fiscalYearEnd": {
      "type": "string",
      "description": "Fiscal year end for the company",
      "format": "date"
    },
    "stateOfIncorporation": {
      "type": "string",
      "description": "The state of incorporation for the company, if it is U.S.-based",
      "enum": [
        "CA_AB",
        "CA_BC",
        "CA_MB",
        "CA_NB",
        "CA_NL",
        "CA_NS",
        "CA_NT",
        "CA_NU",
        "CA_ON",
        "CA_PE",
        "CA_QC",
        "CA_SK",
        "CA_YT",
        "US_AK",
        "US_AL",
        "US_AR",
        "US_AZ",
        "US_CA",
        "US_CO",
        "US_CT",
        "US_DC",
        "US_DE",
        "US_FL",
        "US_GA",
        "US_HI",
        "US_IA",
        "US_ID",
        "US_IL",
        "US_IN",
        "US_KS",
        "US_KY",
        "US_LA",
        "US_MA",
        "US_MD",
        "US_ME",
        "US_MI",
        "US_MN",
        "US_MO",
        "US_MS",
        "US_MT",
        "US_NC",
        "US_ND",
        "US_NE",
        "US_NH",
        "US_NJ",
        "US_NM",
        "US_NV",
        "US_NY",
        "US_OH",
        "US_OK",
        "US_OR",
        "US_PA",
        "US_RI",
        "US_SC",
        "US_SD",
        "US_TN",
        "US_TX",
        "US_UT",
        "US_VA",
        "US_VT",
        "US_WA",
        "US_WI",
        "US_WV",
        "US_WY",
        "US_AA",
        "US_AE",
        "US_AP",
        "AS",
        "GU",
        "MP",
        "PR",
        "VI",
        "AU_ACT",
        "AU_NSW",
        "AU_NT",
        "AU_QLD",
        "AU_SA",
        "AU_TAS",
        "AU_VIC",
        "AU_WA",
        "DE_BW",
        "DE_BY",
        "DE_BE",
        "DE_BB",
        "DE_HB",
        "DE_HH",
        "DE_HE",
        "DE_MV",
        "DE_NI",
        "DE_NW",
        "DE_RP",
        "DE_SL",
        "DE_SN",
        "DE_ST",
        "DE_SH",
        "DE_TH",
        "CH_ZH",
        "CH_BE",
        "CH_LU",
        "CH_UR",
        "CH_SZ",
        "CH_OW",
        "CH_NW",
        "CH_GL",
        "CH_ZG",
        "CH_FR",
        "CH_SO",
        "CH_BS",
        "CH_BL",
        "CH_SH",
        "CH_AR",
        "CH_AI",
        "CH_SG",
        "CH_GR",
        "CH_AG",
        "CH_TG",
        "CH_TI",
        "CH_VD",
        "CH_VS",
        "CH_NE",
        "CH_GE",
        "CH_JU",
        "IT_21",
        "IT_23",
        "IT_25",
        "IT_32",
        "IT_34",
        "IT_36",
        "IT_42",
        "IT_45",
        "IT_52",
        "IT_55",
        "IT_57",
        "IT_62",
        "IT_65",
        "IT_67",
        "IT_72",
        "IT_75",
        "IT_77",
        "IT_78",
        "IT_82",
        "IT_88"
      ]
    },
    "dateOfIncorporation": {
      "type": "string",
      "description": "The date of incorporation for the company",
      "format": "date"
    },
    "entityType": {
      "type": "string",
      "description": "Entity type for the company (e.g. LLC)",
      "enum": [
        "C_CORP",
        "S_CORP",
        "LLC",
        "SOLE_PROPRIETORSHIP",
        "PARTNERSHIP",
        "UNINCORPORATED_GROUP",
        "ASSOCIATION",
        "UNKNOWN"
      ]
    },
    "companyAddresses": {
      "type": "array",
      "description": "List of up to three company addresses",
      "items": {
        "$ref": "#/components/schemas/CompanyAddressDetails"
      }
    },
    "contacts": {
      "type": "array",
      "description": "List of all company contacts",
      "items": {
        "$ref": "#/components/schemas/CompanyContactDetails"
      }
    }
  }
}