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