Validate Address
GET
/v1/addresses/validate
address
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/addresses/validate?country&state&zip&isPartial&city&county&street®ion'
Response Response Example
200 - Success
{
"matchedAddresses": [
{
"address": {
"city": "Phoenix",
"country": "United States",
"county": "Maricopa",
"state": "Arizona",
"street": "S 3rd Ave",
"zip": "85041-5705",
},
"scoring": {
"matchLevel": "EXCELLENT",
"score": 0.96,
"fieldScore": {
"countryMatch": "EXACT",
"stateMatch": "EXACT",
"cityMatch": "EXACT",
"streetMatch": "GOOD",
"zipMatch": "EXACT"
}
}
},
{
"address": {
"city": "Phoenix",
"country": "United States",
"county": "Maricopa",
"state": "Arizona",
"street": "S 3rd St",
"zip": "85042-4206"
},
"scoring": {
"matchLevel": "EXCELLENT",
"score": 0.92,
"fieldScore": {
"countryMatch": "EXACT",
"stateMatch": "EXACT",
"cityMatch": "EXACT",
"streetMatch": "GOOD",
"zipMatch": "GOOD"
}
}
}
],
"requestAddress": {
"city": "Phoenix",
"country": "USA",
"state": "Arizona",
"street": "6001 W 3rd St",
"zip": "85041-5705",
"isPartial": false
}
}
Request
Query Params
country
string
required
state
string
required
zip
string
required
isPartial
boolean
required
city
string
optional
county
string
optional
street
string
optional
region
string
optional