A well-formatted request looks like:
All parameters are case sensitive. api_key, a street parameter, and either zip or state is required for a Address Validation request.
|api_key||See here to acquire an API key REQUIRED|
|street_line_1||Number and street name|
1301 5th Ave
|street_line_2||Apartment or other additional address information|
|postal_code||Address postal code in location country format|
|state_code||Address state / administrative area name or code in location country format|
|country_code||Country code or name. If there is no country_code in the request address will be tried against US and CA country codes by default.|
An Address Validation response is formatted as follows.
Click the # to see that field used within the example JSON response.
Address Validation Response
Normalized permanent input address id. Could be used to check if multiple input addresses are actually identical. A durable id will always be returned if the input is valid.
Normalized and validated street_line_1. Contains both primary and the optional secondary address data.
Normalized sub premise part of the address. This field may vary depending on a country.
Normalized city name. Example: “Olympia”.
State or administrative area for the address in the country location. Examples: “WA” for Washington in US or “BC” for British Columbia in CA.
Latitude and longitude associated with the returned address. Includes “accuracy” string that represents the accuracy of the latitude/longitude with levels decreasing in precision in the following order: RoofTop, Street, PostalCode, Neighborhood, City, State, Country.
An array containing one or more of the following warning message strings:
In US/CA only:
An array indicating whether a full address including line 1 was present in the request or only partial input (city level) was provided. Possible response message strings:
Address line 1 and location provided
Only location (city, state, postal code) provided
Only country provided
No input fields
An error object which contains name string and message string. For example:
"street_line_1": "1301 5th Ave Ste 1600",