Overview
This endpoint can be used to verify an address. Endpoint:/api/v1/addresses/verify
Method: POST
Request
string
required
For example, “John Smith” or “Acme Products”.Minimum character length:
2Maximum character length: 50string
required
The contact email address.Carriers may send one or more shipment tracking notifications to this email address.Minimum character length:
6Maximum character length: 100string
required
The contact phone number.This must be formatted using the E.164 standard.Minimum character length:
7Maximum character length: 30string
required
Line 1 of the address.Minimum character length:
2Maximum character length: 35string
Line 2 of the address.Minimum character length:
2Maximum character length: 35string
required
The address’ town or city.Minimum character length:
2Maximum character length: 35string
required
The address’ state, province, or region.Minimum character length:
2Maximum character length: 30string
required
The address’ post code.Minimum character length:
2Maximum character length: 16Response
If the address is valid, the API will return a200 OK status code.
The response will not contain any content.
If the address is not valid, the API will return a 400 Bad Request status code.
The response will contain the following content:
string
required
The name that was provided in the request.
string
required
The email address that was provided in the request.
string
required
The phone number that was provided in the request.
string
required
Line 1 of the address.If the corresponding request field is not valid, then this may be set to a recommended alternative.
string
Line 2 of the address.If the corresponding request field is not valid, then this may be set to a recommended alternative.
string
required
The address’ town or city.If the corresponding request field is not valid, then this may be set to a recommended alternative.
string
required
The address’ state, province, or region.If the corresponding request field is not valid, then this may be set to a recommended alternative.
string
required
The address’ post code.If the corresponding request field is not valid, then this may be set to a recommended alternative.
boolean
required
Whether the returned / revised address is recommended.
integer
required
An Address Verification Status enum representing the status of the address verification.
string
required
A message which provides more information about the address verification status.