Create an address validation

We are excited to announce a new API capability that is now available for use, so we highly recommend that you start using this new API as soon as possible to take full advantage of its benefits.

Request

Security: API Key

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Body

Create an address validation oject

The object contains address object information. Please refer to address object for details.

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

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. Only applies to DHL Express, DHL eCommerce US, DHL eCommerce UK.

vat: Value-Added tax
gst: Goods and Service Tax
eori: European Union Registration and Identification
ioss: Import One Stop Shop
pan: Pan-Aarav
ukims: UK Internal Market Scheme
other: Other

Allowed values:

vatgsteoriiosspanukimsother

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

Responses

Body

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

integer

required

Code of Meta

message

string

required

Message of Meta

details

array[Error]

Details of Meta

retryable

boolean

Whether this request will be retryable or not

data

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.

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

recommended_address

Address

Address object: the description of address information

Auth

Parameters

Body

{
  "address": {
    "contact_name": "AfterShip Shipping",
    "company_name": "AfterShip Shipping",
    "street1": "230 W 200 S LBBY",
    "city": "Salt Lake City",
    "state": "UT",
    "postal_code": "84101",
    "country": "USA",
    "phone": "123456789",
    "email": "[email protected]"
  }
}

Response Example

{
  "meta": {
    "code": 200,
    "type": "OK",
    "message": "Everything worked as expected."
  },
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "valid",
    "created_at": "2022-02-11T08:10:47+00:00",
    "updated_at": "2022-02-11T08:10:47+00:00",
    "address": {
      "contact_name": "AfterShip Shipping",
      "street1": "This is the first streeet",
      "street2": "This is the second streeet",
      "city": "New York",
      "state": "New York",
      "postal_code": "10001",
      "country": "USA",
      "phone": "1-123-456-5496",
      "email": "[email protected]",
      "type": "residential"
    },
    "recommended_address": {
      "contact_name": "AfterShip Shipping",
      "street1": "This is the first streeet",
      "street2": "This is the second streeet",
      "city": "New York",
      "state": "New York",
      "postal_code": "10001",
      "country": "USA",
      "phone": "1-123-456-5496",
      "email": "[email protected]",
      "type": "residential"
    }
  }
}