XM

Address Validation

Path:

POST api-tax/address/validate

It is critical to validate the address at the point of entry. This endpoint is used to validate the address to avoid incurring cost due to delay in shipping or returned shipping

8.0.1. Headers

x-api-key: d41d8cd98f00b204e9800998ecf8427e

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: Body

Name: Address

Required: true

Sample Request

{
"line1": "10400 N 4TH ST",
"line2": "",
"line3": "",
"city": "BELLEVUE",
"region": "WA",
"country": "US",
"postalCode": "98004-5174"
}

Response

Response Code: 200

Message: OK

Description: You will see this message when the address is validated.

Sample

{
"addressValid": true,
"validatedAddrSuggestions": [
{
"addressType": "HighRiseOrBusinessComplex",
"line1": "10400 NE 4TH ST",
"line2": "",
"line3": "",
"city": "BELLEVUE",
"region": "WA",
"country": "US",
"postalCode": "98004-5174",
"latitude": 47.613923,
"longitude": -122.20114
}
],
"addressesFound": 1
}

Response Code: 400

Message: OK

Description: You will see this message when the address is not valid.

Sample

{
"addressValid": false
}

Changelog

  • Last updated - July 2020