Validate an address
<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan access__plan--off">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan access__plan--off">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipStation API cross references multiple databases to validate addresses and identify potential deliverability issues.
Request body
Example request
[
{
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756",
"country_code": "CA",
"address_residential_indicator": "no"
}
]Response
The request was a success.
Example response
[
{
"status": "verified",
"original_address": {
"name": "Mickey and Minnie Mouse",
"phone": "714-781-4565",
"company_name": "The Walt Disney Company",
"address_line1": "500 South Buena Vista Street",
"city_locality": "Burbank",
"state_province": "CA",
"postal_code": "91521",
"country_code": "US",
"address_residential_indicator": "unknown"
},
"matched_address": {
"name": "MICKEY AND MINNIE MOUSE",
"phone": "714-781-4565",
"company_name": "THE WALT DISNEY COMPANY",
"address_line1": "500 S BUENA VISTA ST",
"city_locality": "BURBANK",
"state_province": "CA",
"postal_code": "91521-0007",
"country_code": "US",
"address_residential_indicator": "no"
},
"messages": [
{
"code": "a1004",
"message": "Address verified successfully",
"type": "info",
"detail_code": "address_verified"
}
]
}
]Changes
Changed in 1 of the 6 revisions of this API.6
- ●
added the new
freight_connection_inactiveenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_provider_id_requiredenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_shipment_not_batchableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_shipment_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_tracking_not_availableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_tracking_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●