Search
This API validates and enriches address information submitted by the user. It ensures that the address is standardized, accurate, and compliant with geographical and postal standards. The API also adds additional fields, such as county, when possible.
Authorization
Your secret API key. Include it with every request.
Body
Phone number associated with the address.
Primary street address.
Additional street address details, such as an apartment or suite number.
City where the customer resides.
County or district of the customer.
State or province of the customer.
ZIP or Postal code of the customer.
Country code in ISO 3166-1 alpha-2 format
AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EUComplete address string of the customer, which can be used as an alternative to individual fields.
Response
The original address data submitted in the request
The standardized and enriched version of the submitted address
Indicates if the address was VERIFIED, PARTIALLY_VERIFIED, INVALID, UNVERIFIABLE, BLANK
List of additional fields added to enrich the address
Address found successfully
The request is missing a valid x-api-key.
Validation error - Address fields failed validation or are incomplete
An unexpected server error occurred.