Validate Address - AfterShip Address API

Support identify and standardize address.

Contact sales to activate this feature.

Request

Security: API Key

Headers

as-api-key

string

required

An API key is a token that you provide when making API calls. Include the token in a header parameter called as-api-key.

Examples:

as-api-key: 123

Content-Type

string

Content-Type for all calls should be application/json.

Default:

application/json

Example:

application/json

Body

Create an address validation.

request_address

Address

required

Address object. Refer to below address schema.

type

string or null

Allowed values:

businessresidential

street_1

string

required

Address_line1 of address.

Example:

123 Main Street

street_2

string or null

Address_line2 of address.

Example:

Suite 200

street_3

string or null

Address_line3 of address.

street_number

string or null

Street number.

Example:

125

district

string or null

District name.

Example:

South District

county

string or null

County name.

Example:

Santa Clara County

postal_code

string or null

Postal code.

Example:

95113

city

string or null

City name.

Example:

San Jose

state

object or null

State object

country_region

object

required

Country region object.

coordinate

object

Coordinate object.

carrier_slug

string

Unique slug in AfterShip. Supported carrier slug: fedex, ups

Example:

fedex

max_address_response

integer

Maximum suggested addresses count in response.

>= 1<= 10

Example: