Overview
This guide will help you validate the customer's address during their online order or form submission individually via our API service. Our service will indicate if an address suggestion exists, any RDI underlying information and related rules to the type of address.
Our API service supports the same list of countries that our eCommerce integrations support (240+ countries), for a full list please review our support guide.
To access our API documentation, please click here
Base URL
Body
There are various parameters allowed within the request Body:
order_id - this is optional, but recommended if you're validating an eCommerce based order.
customer_name - this is optional, but helpful for post-validation follow up.
customer_email - this is optional, but helpful for post-validation follow up.
address_line_1
address_line_2
city
state
postal_code
country
Responses
Based on the address provided, our API will respond with a series of results including an in-depth overview of the address details and relevant information to help your brand reduce carrier & redelivery fees from invalid shipping addresses. The below table provides a description of each of these values:
Name | Example | Description |
Validation Code | 1000 | Internal value related to the validation text. |
Validation Text | The provided address is valid | Detailed description of the related validation code. |
RDI | residential | The type of address, such as residential or commercial. Available for US & CA only. |
Rules | missing_house_number | Detailed breakdown of any related issues to the address or the type of address, such as a PO Box. |
Address Suggestion | postal_code: 95054-1770 | If the postal authority recommends an updated address, such as an updated postal code the full address suggestion will be shown. |
Have a Question?
Be sure to ask our team via the Live Chat button on the bottom right, or contact your account manager directly via email / phone to learn more.