Properties
| Name | Type | Description |
|---|---|---|
| type | string | The type of the address. |
| streetAddress | string | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines. |
| locality | string | The city or locality component. |
| region | string | The state or region component. |
| postalCode | string | The zip code or postal code component. |
| country | string | The country name component. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/AddressObject",
"title": "AddressObject",
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "The type of the address."
},
"streetAddress": {
"type": "string",
"example": "100 Universal City Plaza",
"description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines."
},
"locality": {
"type": "string",
"example": "Hollywood",
"description": "The city or locality component."
},
"region": {
"type": "string",
"example": "CA",
"description": "The state or region component."
},
"postalCode": {
"type": "string",
"example": "91608",
"description": "The zip code or postal code component."
},
"country": {
"type": "string",
"example": "US",
"description": "The country name component."
}
}
}