Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Parameters that can be defined during address validation

street_address
string
required

The primary street address information about the address.

Example:

"600 Congress Avenue"

postal_code
string
required

The postal code of the address.

Example:

"78701"

country_code
string
required

The two-character (ISO 3166-1 alpha-2) country code of the address.

Example:

"US"

extended_address
string

Additional street address information about the address such as, but not limited to, unit number or apartment number.

Example:

"14th Floor"

locality
string

The locality of the address. For US addresses, this corresponds to the city of the address.

Example:

"Austin"

administrative_area
string

The locality of the address. For US addresses, this corresponds to the state of the address.

Example:

"TX"

Response

Action response

data
Validate address action result · object