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.

Note: This endpoint requires an advanced scope. You can enable advanced scopes when creating or editing your API connection.

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

company_name

string | null

≤ 27

The company or organization at the address

line_1

string

required

≤ 35

First line of the street address

line_2

string | null

≤ 35

Second line of the street address

state

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.

city

string

required

≤ 200

City or Suburb

postal_code

string | null

Postal code.

country_alpha2

string

enum

required

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

replace_with_validation_result

boolean

Defaults to false

Override user's address with the address validation results

Responses

Language

Credentials

Bearer

token

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200success with validated address

422invalid request