{
    "name": "Kohler Group",
    "email": "artport.example@example.com",
    "phone": "+123456789",
    "line_1": "123 Example Street",
    "line_2": "Apt. 456",
    "city": "Moenburgh",
    "region": "Colorado",
    "post_code": "72099",
    "country": 1,
}

No Content

​
Overview

This endpoint can be used to verify an address. Endpoint: /api/v1/addresses/verify Method: POST

​
Request

​
name
string
required
For example, “John Smith” or “Acme Products”.Minimum character length: 2Maximum character length: 50
​
email
string
required
The contact email address.Carriers may send one or more shipment tracking notifications to this email address.Minimum character length: 6Maximum character length: 100
​
phone
string
required
The contact phone number.This must be formatted using the E.164 standard.Minimum character length: 7Maximum character length: 30
​
line_1
string
required
Line 1 of the address.Minimum character length: 2Maximum character length: 35
​
line_2
string
Line 2 of the address.Minimum character length: 2Maximum character length: 35
​
city
string
required
The address’ town or city.Minimum character length: 2Maximum character length: 35
​
region
string
required
The address’ state, province, or region.Minimum character length: 2Maximum character length: 30
​
post_code
string
required
The address’ post code.Minimum character length: 2Maximum character length: 16
​
country
integer
required
A Country enum representing the address’ country.

​
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:
​
name
string
required
The name that was provided in the request.
​
email
string
required
The email address that was provided in the request.
​
phone
string
required
The phone number that was provided in the request.
​
line_1
string
required
Line 1 of the address.If the corresponding request field is not valid, then this may be set to a recommended alternative.
​
line_2
string
Line 2 of the address.If the corresponding request field is not valid, then this may be set to a recommended alternative.
​
city
string
required
The address’ town or city.If the corresponding request field is not valid, then this may be set to a recommended alternative.
​
region
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.
​
post_code
string
required
The address’ post code.If the corresponding request field is not valid, then this may be set to a recommended alternative.
​
country
integer
required
A Country enum representing the address’ country that was provided in the request.
​
recommended
boolean
required
Whether the returned / revised address is recommended.
​
status
integer
required
An Address Verification Status enum representing the status of the address verification.
​
message
string
required
A message which provides more information about the address verification status.
{
    "name": "Kohler Group",
    "email": "artport.example@example.com",
    "phone": "+123456789",
    "line_1": "123 Example Street",
    "line_2": "Apt. 456",
    "city": "Moenburgh",
    "region": "Colorado",
    "post_code": "72099",
    "country": 1,
}

No Content