AddressValidation

The Address Validation object is used to provide information about an address, including the recommended address if available. Production and sandbox APIs support USA addresses by default, and you can contact our support team to enable AUS, BEL, DNK, and DEU in our sandbox API for testing as well.

The Address Validation object is used to provide information about an address, including the recommended address if available. Production and sandbox APIs support USA addresses by default, and you can contact our support team to enable AUS, BEL, DNK, and DEU in our sandbox API for testing as well.

id
string
status
string

Validation result of the address

Allowed values:
validinvalid
created_at
string
updated_at
string
address
Address

Address object: the description of address information

street1
string
required

address_line1 of address

country
string
required

Country in ISO 3166-1 alpha 3 code

contact_name
string
required

contact_name of address

phone
string

contact_phone of address

fax
string or null

fax_number of address

email
string or null

email of address

company_name
string or null

company_name of address

street2
string or null

address_line2 of address

street3
string or null

address_line3 of address

city
string or null

city of address

state
string or null

state of address

postal_code
string or null

postal_code of address

type
string or null

type of address

Allowed values:
residentialbusiness
tax_id
string or null

tax id

tax_id_type
string or null

tax id type

  • vat: Value-Added tax
  • gst: Goods and Service Tax
  • eori: European Union Registration and Identification
  • ioss: Import One Stop Shop
  • pan: Pan-Aarav
  • other: Other
Allowed values:
vatgsteoriiosspanother
identification_number
string or null

identification number

identification_type
string or null

identification type

  • mil: Military Number
  • nid: National Identity Card
  • pas: Passport
  • other: Other
Allowed values:
milnidpasother
eori_number
string or null

eori number

location
object or null
recommended_address
Address

Address object: the description of address information

Example
preparing...