Shareworks · Schema
Company Address Body
List of up to three company addresses
Equity CompensationStock OptionsRSUESPPEmployee EquityFinancial ServicesMorgan StanleyEquity AdministrationPrivate CompaniesPublic Companies
Properties
| Name | Type | Description |
|---|---|---|
| addressLine1 | string | First address line |
| addressLine2 | string | Second address line, if needed |
| addressLine3 | string | Third address line, if needed |
| city | string | City or municipality of the address |
| stateProvince | string | State or province of the address |
| country | string | Country of the address |
| postalCode | string | Postal code / ZIP code of the address |
| addressType | string | Whether the business address, mailing address, or address for funds delivery |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/shareworks/main/json-schema/CompanyAddressCrudRequest.json",
"title": "Company Address Body",
"required": [
"addressLine1",
"addressType",
"city",
"country",
"postalCode"
],
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"description": "First address line"
},
"addressLine2": {
"type": "string",
"description": "Second address line, if needed"
},
"addressLine3": {
"type": "string",
"description": "Third address line, if needed"
},
"city": {
"type": "string",
"description": "City or municipality of the address"
},
"stateProvince": {
"type": "string",
"description": "State or province of the address",
"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"
]
},
"country": {
"type": "string",
"description": "Country of the address",
"enum": [
"CA",
"US",
"GB",
"AU",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EA",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"IC",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"XK",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
]
},
"postalCode": {
"type": "string",
"description": "Postal code / ZIP code of the address"
},
"addressType": {
"type": "string",
"description": "Whether the business address, mailing address, or address for funds delivery",
"enum": [
"BUSINESS",
"MAIL",
"FUNDS_DELIVERY"
]
}
},
"description": "List of up to three company addresses"
}