Skip to content

addressSchema

type: object

a physical geographical location; This field can optionally include mailing information.

countryCode

type: string
exact length: 2

the ISO 3166-1 Alpha-2 code for the country in which the address is located

city

type: string
optional? yes

the city in which the address is located

state

type: string
optional? yes

the state or province in which the address is located; Some implementations would prefer a 2-letter abbreviation of the state.

postalCode

type: number
optional? yes

the PIN/ZIP code, at which the location can receive mail; This can also be a postbox that is disconnected from the geographical location.