Attempts to verify one or more addresses and where possible returns the address components, the formatted address, and any associated report codes. If used with the suggest parameter, the process will provide a list of valid suggestions if the input is ambiguous.
Resource URL
https://api.loqate.com/address/verify
Resource Information
| Preferred method | POST |
| Response formats | JSON, XML, HTML |
| Requires authentication? | Yes, valid API key |
| Chargeable? | Yes |
Request Parameters
lqtkey Required |
A valid API key with sufficient credit available to process the requested transactions.
Example: BFtd2UpC8Gl1jU1pPnDZIVpoz2XnBMyWEfVcAfoI |
input[] Required |
The array containing the list of address objects to verify. Each address object can make use of the following input fields:
Address1, Address2, Address3, Address4, Address5, Address6, Address7, Address8, Locality, AdministrativeArea, PostalCode, Country Sample JSON input[] is enclosed below. |
geocode Optional |
Specifies whether to return geocode fields in the response. This is an chargable add-on.
Example: ...&geocode... (in URL) or "geocode":"on" (within object) |
certify Optional |
Specifies whether to return certified fields in the response. This is an chargable add-on.
Example: ...&certify... (in URL) or "certify":"on" (within object) |
suggest Optional |
If the validation result is ambiguous, this parameter will attempt to return an array of candidate records that are a close match to the input address. There is no additional charge for this add-on.
Example: ...&suggest... (in URL) or "suggest":"on" (within object) |
enhance Optional |
If included and available with the supplied country, supplementary information such as county code (US) or DPS (UK) will be returned with the address. There is no additional charge for this add-on.
Example: ...&enhance... (in URL) or "enhance":"on" (within object) |
options[] Optional |
An array containing one or more advanced parameters that can control or manipulate the verify process. Settings provided with the request will apply to all addresses entered within the input object. Find a full list of available options parameters here.
Sample JSON input[] is enclosed below. |
Response Parameters
Status |
The result of your call. “OK” indicates success, any other status indicates an error.
Example: "Status":"OK" |
output[] |
The array containing the response address objects to the address objects given in the input parameter. The returned fields will be dependent on the parsing methodology and reference data available in each individual country. A full list is available in the documentation.
Sample JSON output[] is enclosed below. |
Example Request
POST https://api.loqate.com/address/verify?geocode
Accept: application/json
Content-Type: application/json
{
"lqtkey":"BFtd2UpC8Gl1jU1pPnDZIVpoz2XnBMyWEfVcAfoI",
"input":[
{
"Address1":"koniginstrasse 5 ",
"Address2":"munich germany"
},
{
"Address1":"537 bs56pe",
"Country":"uk"
},
{
"Address1":"136 bradford",
"Locality":"san francisco",
"Country":"usa"
}
]
}
Example Request (using options)
POST https://api.loqate.com/address/verify?geocode
Accept: application/json
Content-Type: application/json
{
"lqtkey":"BFtd2UpC8Gl1jU1pPnDZIVpoz2XnBMyWEfVcAfoI",
"input":[
{
"Address":"175 Texas St San Francisco"
}
],
"options":
{
"DefaultCountry":"USA",
"OutputCasing":"Upper"
}
}
Example Response
200 OK
Content-Type: application/json; charset=utf8
Date: Wed, 14 Oct 2015 18:43:15 GMT
Server: Apache
X-Powered-By: PHP/5.4.16
Content-Length: 1984
Connection: keep-alive
{
"Status":"OK",
"output":[
{
"AQI":"A",
"AVC":"V44-I44-P3-100",
"Address":"K\u00f6niginstr. 5, 80539 M\u00fcnchen",
"Address1":"K\u00f6niginstr. 5",
"Address2":"80539 M\u00fcnchen",
"AdministrativeArea":"Bayern",
"CountryName":"Germany",
"DeliveryAddress":"K\u00f6niginstr. 5",
"DeliveryAddress1":"K\u00f6niginstr. 5",
"DependentLocality":"Maxvorstadt",
"GeoAccuracy":"P4",
"GeoDistance":"0.0",
"ISO3166-2":"DE",
"ISO3166-3":"DEU",
"ISO3166-N":"276",
"Latitude":"48.144900",
"Locality":"M\u00fcnchen",
"Longitude":"11.583240",
"MatchRuleLabel":"1a",
"PostalCode":"80539",
"PostalCodePrimary":"80539",
"Premise":"5",
"PremiseNumber":"5",
"SubAdministrativeArea":"Oberbayern",
"Thoroughfare":"K\u00f6niginstr."
},
{
"AQI":"A",
"AVC":"V42-I44-P6-100",
"Address":"537 Stapleton Road, Bristol, BS5 6PE",
"Address1":"537 Stapleton Road",
"Address2":"Bristol",
"Address3":"BS5 6PE",
"AdministrativeArea":"Avon",
"CountryName":"United Kingdom",
"DeliveryAddress":"537 Stapleton Road",
"DeliveryAddress1":"537 Stapleton Road",
"GeoAccuracy":"I4",
"GeoDistance":"6.3",
"ISO3166-2":"GB",
"ISO3166-3":"GBR",
"ISO3166-N":"826",
"Latitude":"51.472290",
"Locality":"Bristol",
"Longitude":"-2.562160",
"MatchRuleLabel":"3",
"PostalCode":"BS5 6PE",
"PostalCodePrimary":"BS5 6PE",
"Premise":"537",
"PremiseNumber":"537",
"Thoroughfare":"Stapleton Road"
},
{
"AQI":"C",
"AVC":"V42-I44-P3-094",
"Address":"136 Bradford St, San Francisco CA 94110-5704",
"Address1":"136 Bradford St",
"Address2":"San Francisco CA 94110-5704",
"AdministrativeArea":"CA",
"CountryName":"United States",
"DeliveryAddress":"136 Bradford St",
"DeliveryAddress1":"136 Bradford St",
"GeoAccuracy":"P4",
"GeoDistance":"0.0",
"ISO3166-2":"US",
"ISO3166-3":"USA",
"ISO3166-N":"840",
"Latitude":"37.740740",
"Locality":"San Francisco",
"Longitude":"-122.409810",
"MatchRuleLabel":"2",
"PostalCode":"94110-5704",
"PostalCodePrimary":"94110",
"PostalCodeSecondary":"5704",
"Premise":"136",
"PremiseNumber":"136",
"SubAdministrativeArea":"San Francisco",
"Thoroughfare":"Bradford St",
"ThoroughfareName":"Bradford"
}
]
}