Address

This object contains detailed information on a physical address.

Field Type Required Description
city String (error)

The name of the city.

Required if either houseNumberOrName, street, postalCode, or stateOrProvince are provided.

country String (tick)

The two-character country code of the address.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
houseNumberOrName String (error)

The number or name of the house.

postalCode String (error)

The postal code.

A maximum of five (5) digits for an address in the USA, or a maximum of ten (10) characters for an address in all other countries.

Required if either houseNumberOrName, street, city, or stateOrProvince are provided.

stateOrProvince String (error)

Two (2) characters for an address in the USA or Canada, or a maximum of three (3) characters for an address in all other countries.

Required for an address in the USA or Canada if either houseNumberOrName, street, city, or postalCode are provided.

street String (error)

The name of the street.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

Required if either houseNumberOrName, city, postalCode, or stateOrProvince are provided.