A physical location in the form of a street address.
Properties
country
string
Required
The ISO 3166 country code. Preferably the 2-letter code.
maxLength: 10 bytesminLength: 2 byteslocality
string
Optional
The locality of the region. For example, a city in the USA.
name
string
Optional
The name of the location.
postalCode
string
Optional
The postal code of the location.
region
string
Optional
The administrative region of the country. For example, a state in the USA.
street
string
Optional
The street address.
View raw schema
{
"type": "object",
"required": [
"country"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the location."
},
"region": {
"type": "string",
"description": "The administrative region of the country. For example, a state in the USA."
},
"street": {
"type": "string",
"description": "The street address."
},
"country": {
"type": "string",
"maxLength": 10,
"minLength": 2,
"description": "The ISO 3166 country code. Preferably the 2-letter code."
},
"locality": {
"type": "string",
"description": "The locality of the region. For example, a city in the USA."
},
"postalCode": {
"type": "string",
"description": "The postal code of the location."
}
},
"description": "A physical location in the form of a street address."
}