Address Validation Intro
Introduction to Address Validation
The region field is applicable only for addresses outside the US, while the state field is used exclusively for addresses within the US.
How Address Validation Works
Key Features
1.
Each part of the address—street, city, state, zip code, and country—is validated to detect common errors, such as misspellings or incorrect zip codes.
2.
The API assigns a match level (e.g.,
EXCELLENT
, GOOD
) and a confidence score (0.0 - 1.0) to indicate how closely the provided address matches official records.3.
The system evaluates individual address components, such as country, state, city, street, and zip, with match levels (
EXACT
, GOOD
, etc.) to provide detailed accuracy insights.Error Handling
Error Response Behavior
Example API Response
{
"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
}
}
Modified at 2025-03-26 11:23:12