Address Object Fields

Read about the fields used to model the addresses of physical locations.

Use this entity to specify elements of an address or addresses.

FieldDetailsDescription
country_subdivision_code

Type: String

Max: 6

The state or province code that represents the subdivision. You must use the full ISO code (here). For example, you would use US-CA to represent California. Leave this field blank if it is not required.
city

Type: String

Max: 256

City.
postal_code

Type: String

Max: 256

Post code.
county

Type: String

Max: 256

County.
country_code

Min: 2

Max: 2

Pattern: ^[A-Z]{2}$

The address's 2 letter ISO country code. If an address is later used for tax or liability determination (like for physical goods), it will use this value to as the geographic location of the address, unless a subdivision exists.
street_name

Type: String

Max: 256

The street name. You can concatenate multiple lines with a comma (,).
address_detail

Type: String

Max: 512

Further address details like apartment number.
freeform_address

Type: String

Max: 256

Specify a free text address.
building_number

Type: String

Max: 256

The number of the building.

Did this page help you?