API ReferenceDocs
API Reference
Dashboard

Validate a single address

post
https://public-api.easyship.com/2024-09/addresses/validations

Create an address validation.

Required authorization scope:

  • public.address_validation:write for international addresses.
  • public.address_validation_domestic:write for US addresses.

See the Domestic Address Validation endpoint for more details.

This API requires an updated contract with Easyship. Get in touch with your account manager or Easyship Support Team.

Note: Calls to this endpoint count towards your API usage allowance. You can monitor your current usage in the Subscription section of your account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null
≤ 27

The company or organization at the address

string
required
≤ 35

First line of the street address

string | null
≤ 35

Second line of the street address

string | null
≤ 200

State, Province, or other top-level administrative region. Mandatory for these countries: AU, CA, CN, ID, MX, MY, TH, US, VN. Use abbreviations for naming the state if possible (2 letters for the US/CA, 2 or 3 letters for AU). For countries using provinces, use the full province names.

string
required
≤ 200

City or Suburb

string | null

Postal code.

string
enum
required

Country Code in Alpha-2 format (ISO 3166-1)

boolean
Defaults to false

Override user's address with the address validation results

Responses

Updated 3 months ago

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago