> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loqate.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Address Verify Quick Start Guide for Batch Address Validation
> Get started with Address Verify. Validate and standardize addresses globally using certified datasets. Includes geocoding and AVC quality codes.
**Address Verify validates and cleanses address data against reference datasets, correcting errors and standardizing formats to ensure accurate deliveries.**
***
## Coverage
* **Global:** Address verification for 250+ countries and territories
* **Certified datasets:** Includes CASS (US) and PAF (UK) certified postal data
* **Geocoding:** Latitude/longitude coordinates and reverse geocoding capabilities
* **Transliteration:** International address conversion for cross-border operations
## Available Endpoints
Address Verify provides one primary API endpoint:
* [**International Batch Cleanse**](/api-reference/address-verify/international-batch-cleanse) - Verify and cleanse addresses globally in single or batch mode
## Getting Started
1. [Create an API key](https://docs.loqate.com/loqate-basics/create-an-api-key) if you don't have one
2. Structure your address data using the input fields that match your data format
3. Make your first request using the endpoint documentation above
Here's an example request for the **International Batch Cleanse** endpoint:
```shell cURL theme={null}
curl --request POST \
--url https://api.addressy.com/Cleansing/International/Batch/v1.20/json6.ws \
--header 'Content-Type: application/json' \
--data '{
"Key": "",
"GeoCode": false,
"Addresses": [
{
"Latitude": "",
"Longitude": "",
"Address": "",
"Address1": "",
"Address2": "",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"DeliveryAddress": "",
"DeliveryAddress1": "",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"Id": "",
"SuperAdministrativeArea": "",
"AdministrativeArea": "",
"SubAdministrativeArea": "",
"Locality": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"SubBuildingFloor": "",
"PostalCode": "",
"Organization": "",
"PostBox": "",
"Country": "",
"Contact": "",
"Function": "",
"Department": ""
}
],
"Options": {
"ServerOptions": {
"CassAvcEnable": "YES",
"CassUrbFirst": "YES",
"CassZipFields": "YES",
"CassCityAbbreviation": "YES",
"MaxResults": "",
"MinimumMatchscore": "0",
"MinimumVerificationLevel": "0",
"AddressLineSeparator": "
",
"MinimumSimilarity": "70",
"SuppressAddressFields": "",
"SuppressAdditionFields": "",
"SuppressFields": "",
"CombinedSearchMethods": "YES",
"MinimumGeoAccuracyLevel": "0",
"MaximumGeoDistance": "-1",
"OutputScript": "Latn",
"OutputCasing": "Title",
"EnhancedCountryTool": "ON",
"CertifiedCountryList": "",
"DefaultCountry": "",
"CountryFields": "Country",
"FieldNameWeight": "",
"ForceCountry": "",
"MatchScoreAbsoluteThreshold": "60",
"MatchScoreThresholdFactor": "95",
"OutputAddressFormat": "YES",
"TransliterationIgnoreFields": "ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC",
"ToolInfo": "YES",
"UseSymbolicTransliteration": "YES",
"DuplicateHandlingMask": "",
"NativeAddressLineReverse": "",
"SimpleParse": "YES",
"ReturnVerifiedFieldsOnly": "No",
"FieldStatus": "true",
"IgnoreUnmatched": "YES",
"MinimumPostcode": "0",
"SuppressUnmatched": "ON",
"OutputSortType": "Alphabetical",
"RangeDecompose": "Match",
"PreferPrimaryValidAlias": "YES",
"ReferenceDatasetCacheSize": "5"
},
"Version": false,
"Certify": false,
"Enhance": false,
"Process": "Verify"
}
}'
```
```python Python theme={null}
import requests
url = "https://api.addressy.com/Cleansing/International/Batch/v1.20/json6.ws"
payload = {
"Key": "",
"GeoCode": False,
"Addresses": [
{
"Latitude": "",
"Longitude": "",
"Address": "",
"Address1": "",
"Address2": "",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"DeliveryAddress": "",
"DeliveryAddress1": "",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"Id": "",
"SuperAdministrativeArea": "",
"AdministrativeArea": "",
"SubAdministrativeArea": "",
"Locality": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"SubBuildingFloor": "",
"PostalCode": "",
"Organization": "",
"PostBox": "",
"Country": "",
"Contact": "",
"Function": "",
"Department": ""
}
],
"Options": {
"ServerOptions": {
"CassAvcEnable": "YES",
"CassUrbFirst": "YES",
"CassZipFields": "YES",
"CassCityAbbreviation": "YES",
"MaxResults": "",
"MinimumMatchscore": "0",
"MinimumVerificationLevel": "0",
"AddressLineSeparator": "
",
"MinimumSimilarity": "70",
"SuppressAddressFields": "",
"SuppressAdditionFields": "",
"SuppressFields": "",
"CombinedSearchMethods": "YES",
"MinimumGeoAccuracyLevel": "0",
"MaximumGeoDistance": "-1",
"OutputScript": "Latn",
"OutputCasing": "Title",
"EnhancedCountryTool": "ON",
"CertifiedCountryList": "",
"DefaultCountry": "",
"CountryFields": "Country",
"FieldNameWeight": "",
"ForceCountry": "",
"MatchScoreAbsoluteThreshold": "60",
"MatchScoreThresholdFactor": "95",
"OutputAddressFormat": "YES",
"TransliterationIgnoreFields": "ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC",
"ToolInfo": "YES",
"UseSymbolicTransliteration": "YES",
"DuplicateHandlingMask": "",
"NativeAddressLineReverse": "",
"SimpleParse": "YES",
"ReturnVerifiedFieldsOnly": "No",
"FieldStatus": "true",
"IgnoreUnmatched": "YES",
"MinimumPostcode": "0",
"SuppressUnmatched": "ON",
"OutputSortType": "Alphabetical",
"RangeDecompose": "Match",
"PreferPrimaryValidAlias": "YES",
"ReferenceDatasetCacheSize": "5"
},
"Version": False,
"Certify": False,
"Enhance": False,
"Process": "Verify"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
```
```javascript JavaScript theme={null}
const url = 'https://api.addressy.com/Cleansing/International/Batch/v1.20/json6.ws';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: '{"Key":"","GeoCode":false,"Addresses":[{"Latitude":"","Longitude":"","Address":"","Address1":"","Address2":"","Address3":"","Address4":"","Address5":"","Address6":"","Address7":"","Address8":"","DeliveryAddress":"","DeliveryAddress1":"","DeliveryAddress2":"","DeliveryAddress3":"","DeliveryAddress4":"","DeliveryAddress5":"","DeliveryAddress6":"","DeliveryAddress7":"","DeliveryAddress8":"","Id":"","SuperAdministrativeArea":"","AdministrativeArea":"","SubAdministrativeArea":"","Locality":"","DependentLocality":"","DoubleDependentLocality":"","Thoroughfare":"","DependentThoroughfare":"","Building":"","Premise":"","SubBuilding":"","SubBuildingFloor":"","PostalCode":"","Organization":"","PostBox":"","Country":"","Contact":"","Function":"","Department":""}],"Options":{"ServerOptions":{"CassAvcEnable":"YES","CassUrbFirst":"YES","CassZipFields":"YES","CassCityAbbreviation":"YES","MaxResults":"","MinimumMatchscore":"0","MinimumVerificationLevel":"0","AddressLineSeparator":"
","MinimumSimilarity":"70","SuppressAddressFields":"","SuppressAdditionFields":"","SuppressFields":"","CombinedSearchMethods":"YES","MinimumGeoAccuracyLevel":"0","MaximumGeoDistance":"-1","OutputScript":"Latn","OutputCasing":"Title","EnhancedCountryTool":"ON","CertifiedCountryList":"","DefaultCountry":"","CountryFields":"Country","FieldNameWeight":"","ForceCountry":"","MatchScoreAbsoluteThreshold":"60","MatchScoreThresholdFactor":"95","OutputAddressFormat":"YES","TransliterationIgnoreFields":"ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC","ToolInfo":"YES","UseSymbolicTransliteration":"YES","DuplicateHandlingMask":"","NativeAddressLineReverse":"","SimpleParse":"YES","ReturnVerifiedFieldsOnly":"No","FieldStatus":"true","IgnoreUnmatched":"YES","MinimumPostcode":"0","SuppressUnmatched":"ON","OutputSortType":"Alphabetical","RangeDecompose":"Match","PreferPrimaryValidAlias":"YES","ReferenceDatasetCacheSize":"5"},"Version":false,"Certify":false,"Enhance":false,"Process":"Verify"}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
```
```php PHP theme={null}
"https://api.addressy.com/Cleansing/International/Batch/v1.20/json6.ws",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Key' => '',
'GeoCode' => null,
'Addresses' => [
[
'Latitude' => '',
'Longitude' => '',
'Address' => '',
'Address1' => '',
'Address2' => '',
'Address3' => '',
'Address4' => '',
'Address5' => '',
'Address6' => '',
'Address7' => '',
'Address8' => '',
'DeliveryAddress' => '',
'DeliveryAddress1' => '',
'DeliveryAddress2' => '',
'DeliveryAddress3' => '',
'DeliveryAddress4' => '',
'DeliveryAddress5' => '',
'DeliveryAddress6' => '',
'DeliveryAddress7' => '',
'DeliveryAddress8' => '',
'Id' => '',
'SuperAdministrativeArea' => '',
'AdministrativeArea' => '',
'SubAdministrativeArea' => '',
'Locality' => '',
'DependentLocality' => '',
'DoubleDependentLocality' => '',
'Thoroughfare' => '',
'DependentThoroughfare' => '',
'Building' => '',
'Premise' => '',
'SubBuilding' => '',
'SubBuildingFloor' => '',
'PostalCode' => '',
'Organization' => '',
'PostBox' => '',
'Country' => '',
'Contact' => '',
'Function' => '',
'Department' => ''
]
],
'Options' => [
'ServerOptions' => [
'CassAvcEnable' => 'YES',
'CassUrbFirst' => 'YES',
'CassZipFields' => 'YES',
'CassCityAbbreviation' => 'YES',
'MaxResults' => '',
'MinimumMatchscore' => '0',
'MinimumVerificationLevel' => '0',
'AddressLineSeparator' => '
',
'MinimumSimilarity' => '70',
'SuppressAddressFields' => '',
'SuppressAdditionFields' => '',
'SuppressFields' => '',
'CombinedSearchMethods' => 'YES',
'MinimumGeoAccuracyLevel' => '0',
'MaximumGeoDistance' => '-1',
'OutputScript' => 'Latn',
'OutputCasing' => 'Title',
'EnhancedCountryTool' => 'ON',
'CertifiedCountryList' => '',
'DefaultCountry' => '',
'CountryFields' => 'Country',
'FieldNameWeight' => '',
'ForceCountry' => '',
'MatchScoreAbsoluteThreshold' => '60',
'MatchScoreThresholdFactor' => '95',
'OutputAddressFormat' => 'YES',
'TransliterationIgnoreFields' => 'ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC',
'ToolInfo' => 'YES',
'UseSymbolicTransliteration' => 'YES',
'DuplicateHandlingMask' => '',
'NativeAddressLineReverse' => '',
'SimpleParse' => 'YES',
'ReturnVerifiedFieldsOnly' => 'No',
'FieldStatus' => 'true',
'IgnoreUnmatched' => 'YES',
'MinimumPostcode' => '0',
'SuppressUnmatched' => 'ON',
'OutputSortType' => 'Alphabetical',
'RangeDecompose' => 'Match',
'PreferPrimaryValidAlias' => 'YES',
'ReferenceDatasetCacheSize' => '5'
],
'Version' => null,
'Certify' => null,
'Enhance' => null,
'Process' => 'Verify'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
```
```go Go theme={null}
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.addressy.com/Cleansing/International/Batch/v1.20/json6.ws"
payload := strings.NewReader("{\n \"Key\": \"\",\n \"GeoCode\": false,\n \"Addresses\": [\n {\n \"Latitude\": \"\",\n \"Longitude\": \"\",\n \"Address\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"Address5\": \"\",\n \"Address6\": \"\",\n \"Address7\": \"\",\n \"Address8\": \"\",\n \"DeliveryAddress\": \"\",\n \"DeliveryAddress1\": \"\",\n \"DeliveryAddress2\": \"\",\n \"DeliveryAddress3\": \"\",\n \"DeliveryAddress4\": \"\",\n \"DeliveryAddress5\": \"\",\n \"DeliveryAddress6\": \"\",\n \"DeliveryAddress7\": \"\",\n \"DeliveryAddress8\": \"\",\n \"Id\": \"\",\n \"SuperAdministrativeArea\": \"\",\n \"AdministrativeArea\": \"\",\n \"SubAdministrativeArea\": \"\",\n \"Locality\": \"\",\n \"DependentLocality\": \"\",\n \"DoubleDependentLocality\": \"\",\n \"Thoroughfare\": \"\",\n \"DependentThoroughfare\": \"\",\n \"Building\": \"\",\n \"Premise\": \"\",\n \"SubBuilding\": \"\",\n \"SubBuildingFloor\": \"\",\n \"PostalCode\": \"\",\n \"Organization\": \"\",\n \"PostBox\": \"\",\n \"Country\": \"\",\n \"Contact\": \"\",\n \"Function\": \"\",\n \"Department\": \"\"\n }\n ],\n \"Options\": {\n \"ServerOptions\": {\n \"CassAvcEnable\": \"YES\",\n \"CassUrbFirst\": \"YES\",\n \"CassZipFields\": \"YES\",\n \"CassCityAbbreviation\": \"YES\",\n \"MaxResults\": \"\",\n \"MinimumMatchscore\": \"0\",\n \"MinimumVerificationLevel\": \"0\",\n \"AddressLineSeparator\": \"
\",\n \"MinimumSimilarity\": \"70\",\n \"SuppressAddressFields\": \"\",\n \"SuppressAdditionFields\": \"\",\n \"SuppressFields\": \"\",\n \"CombinedSearchMethods\": \"YES\",\n \"MinimumGeoAccuracyLevel\": \"0\",\n \"MaximumGeoDistance\": \"-1\",\n \"OutputScript\": \"Latn\",\n \"OutputCasing\": \"Title\",\n \"EnhancedCountryTool\": \"ON\",\n \"CertifiedCountryList\": \"\",\n \"DefaultCountry\": \"\",\n \"CountryFields\": \"Country\",\n \"FieldNameWeight\": \"\",\n \"ForceCountry\": \"\",\n \"MatchScoreAbsoluteThreshold\": \"60\",\n \"MatchScoreThresholdFactor\": \"95\",\n \"OutputAddressFormat\": \"YES\",\n \"TransliterationIgnoreFields\": \"ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC\",\n \"ToolInfo\": \"YES\",\n \"UseSymbolicTransliteration\": \"YES\",\n \"DuplicateHandlingMask\": \"\",\n \"NativeAddressLineReverse\": \"\",\n \"SimpleParse\": \"YES\",\n \"ReturnVerifiedFieldsOnly\": \"No\",\n \"FieldStatus\": \"true\",\n \"IgnoreUnmatched\": \"YES\",\n \"MinimumPostcode\": \"0\",\n \"SuppressUnmatched\": \"ON\",\n \"OutputSortType\": \"Alphabetical\",\n \"RangeDecompose\": \"Match\",\n \"PreferPrimaryValidAlias\": \"YES\",\n \"ReferenceDatasetCacheSize\": \"5\"\n },\n \"Version\": false,\n \"Certify\": false,\n \"Enhance\": false,\n \"Process\": \"Verify\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
```
```java Java theme={null}
HttpResponse response = Unirest.post("https://api.addressy.com/Cleansing/International/Batch/v1.20/json6.ws")
.header("Content-Type", "application/json")
.body("{\n \"Key\": \"\",\n \"GeoCode\": false,\n \"Addresses\": [\n {\n \"Latitude\": \"\",\n \"Longitude\": \"\",\n \"Address\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"Address5\": \"\",\n \"Address6\": \"\",\n \"Address7\": \"\",\n \"Address8\": \"\",\n \"DeliveryAddress\": \"\",\n \"DeliveryAddress1\": \"\",\n \"DeliveryAddress2\": \"\",\n \"DeliveryAddress3\": \"\",\n \"DeliveryAddress4\": \"\",\n \"DeliveryAddress5\": \"\",\n \"DeliveryAddress6\": \"\",\n \"DeliveryAddress7\": \"\",\n \"DeliveryAddress8\": \"\",\n \"Id\": \"\",\n \"SuperAdministrativeArea\": \"\",\n \"AdministrativeArea\": \"\",\n \"SubAdministrativeArea\": \"\",\n \"Locality\": \"\",\n \"DependentLocality\": \"\",\n \"DoubleDependentLocality\": \"\",\n \"Thoroughfare\": \"\",\n \"DependentThoroughfare\": \"\",\n \"Building\": \"\",\n \"Premise\": \"\",\n \"SubBuilding\": \"\",\n \"SubBuildingFloor\": \"\",\n \"PostalCode\": \"\",\n \"Organization\": \"\",\n \"PostBox\": \"\",\n \"Country\": \"\",\n \"Contact\": \"\",\n \"Function\": \"\",\n \"Department\": \"\"\n }\n ],\n \"Options\": {\n \"ServerOptions\": {\n \"CassAvcEnable\": \"YES\",\n \"CassUrbFirst\": \"YES\",\n \"CassZipFields\": \"YES\",\n \"CassCityAbbreviation\": \"YES\",\n \"MaxResults\": \"\",\n \"MinimumMatchscore\": \"0\",\n \"MinimumVerificationLevel\": \"0\",\n \"AddressLineSeparator\": \"
\",\n \"MinimumSimilarity\": \"70\",\n \"SuppressAddressFields\": \"\",\n \"SuppressAdditionFields\": \"\",\n \"SuppressFields\": \"\",\n \"CombinedSearchMethods\": \"YES\",\n \"MinimumGeoAccuracyLevel\": \"0\",\n \"MaximumGeoDistance\": \"-1\",\n \"OutputScript\": \"Latn\",\n \"OutputCasing\": \"Title\",\n \"EnhancedCountryTool\": \"ON\",\n \"CertifiedCountryList\": \"\",\n \"DefaultCountry\": \"\",\n \"CountryFields\": \"Country\",\n \"FieldNameWeight\": \"\",\n \"ForceCountry\": \"\",\n \"MatchScoreAbsoluteThreshold\": \"60\",\n \"MatchScoreThresholdFactor\": \"95\",\n \"OutputAddressFormat\": \"YES\",\n \"TransliterationIgnoreFields\": \"ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC\",\n \"ToolInfo\": \"YES\",\n \"UseSymbolicTransliteration\": \"YES\",\n \"DuplicateHandlingMask\": \"\",\n \"NativeAddressLineReverse\": \"\",\n \"SimpleParse\": \"YES\",\n \"ReturnVerifiedFieldsOnly\": \"No\",\n \"FieldStatus\": \"true\",\n \"IgnoreUnmatched\": \"YES\",\n \"MinimumPostcode\": \"0\",\n \"SuppressUnmatched\": \"ON\",\n \"OutputSortType\": \"Alphabetical\",\n \"RangeDecompose\": \"Match\",\n \"PreferPrimaryValidAlias\": \"YES\",\n \"ReferenceDatasetCacheSize\": \"5\"\n },\n \"Version\": false,\n \"Certify\": false,\n \"Enhance\": false,\n \"Process\": \"Verify\"\n }\n}")
.asString();
```
```ruby Ruby theme={null}
require 'uri'
require 'net/http'
url = URI("https://api.addressy.com/Cleansing/International/Batch/v1.20/json6.ws")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"Key\": \"\",\n \"GeoCode\": false,\n \"Addresses\": [\n {\n \"Latitude\": \"\",\n \"Longitude\": \"\",\n \"Address\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"Address5\": \"\",\n \"Address6\": \"\",\n \"Address7\": \"\",\n \"Address8\": \"\",\n \"DeliveryAddress\": \"\",\n \"DeliveryAddress1\": \"\",\n \"DeliveryAddress2\": \"\",\n \"DeliveryAddress3\": \"\",\n \"DeliveryAddress4\": \"\",\n \"DeliveryAddress5\": \"\",\n \"DeliveryAddress6\": \"\",\n \"DeliveryAddress7\": \"\",\n \"DeliveryAddress8\": \"\",\n \"Id\": \"\",\n \"SuperAdministrativeArea\": \"\",\n \"AdministrativeArea\": \"\",\n \"SubAdministrativeArea\": \"\",\n \"Locality\": \"\",\n \"DependentLocality\": \"\",\n \"DoubleDependentLocality\": \"\",\n \"Thoroughfare\": \"\",\n \"DependentThoroughfare\": \"\",\n \"Building\": \"\",\n \"Premise\": \"\",\n \"SubBuilding\": \"\",\n \"SubBuildingFloor\": \"\",\n \"PostalCode\": \"\",\n \"Organization\": \"\",\n \"PostBox\": \"\",\n \"Country\": \"\",\n \"Contact\": \"\",\n \"Function\": \"\",\n \"Department\": \"\"\n }\n ],\n \"Options\": {\n \"ServerOptions\": {\n \"CassAvcEnable\": \"YES\",\n \"CassUrbFirst\": \"YES\",\n \"CassZipFields\": \"YES\",\n \"CassCityAbbreviation\": \"YES\",\n \"MaxResults\": \"\",\n \"MinimumMatchscore\": \"0\",\n \"MinimumVerificationLevel\": \"0\",\n \"AddressLineSeparator\": \"
\",\n \"MinimumSimilarity\": \"70\",\n \"SuppressAddressFields\": \"\",\n \"SuppressAdditionFields\": \"\",\n \"SuppressFields\": \"\",\n \"CombinedSearchMethods\": \"YES\",\n \"MinimumGeoAccuracyLevel\": \"0\",\n \"MaximumGeoDistance\": \"-1\",\n \"OutputScript\": \"Latn\",\n \"OutputCasing\": \"Title\",\n \"EnhancedCountryTool\": \"ON\",\n \"CertifiedCountryList\": \"\",\n \"DefaultCountry\": \"\",\n \"CountryFields\": \"Country\",\n \"FieldNameWeight\": \"\",\n \"ForceCountry\": \"\",\n \"MatchScoreAbsoluteThreshold\": \"60\",\n \"MatchScoreThresholdFactor\": \"95\",\n \"OutputAddressFormat\": \"YES\",\n \"TransliterationIgnoreFields\": \"ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC\",\n \"ToolInfo\": \"YES\",\n \"UseSymbolicTransliteration\": \"YES\",\n \"DuplicateHandlingMask\": \"\",\n \"NativeAddressLineReverse\": \"\",\n \"SimpleParse\": \"YES\",\n \"ReturnVerifiedFieldsOnly\": \"No\",\n \"FieldStatus\": \"true\",\n \"IgnoreUnmatched\": \"YES\",\n \"MinimumPostcode\": \"0\",\n \"SuppressUnmatched\": \"ON\",\n \"OutputSortType\": \"Alphabetical\",\n \"RangeDecompose\": \"Match\",\n \"PreferPrimaryValidAlias\": \"YES\",\n \"ReferenceDatasetCacheSize\": \"5\"\n },\n \"Version\": false,\n \"Certify\": false,\n \"Enhance\": false,\n \"Process\": \"Verify\"\n }\n}"
response = http.request(request)
puts response.read_body
```
## What Address Verify Returns
Address Verify provides:
* Verified and standardized address in multiple formats (mailing format, delivery format, structured components)
* Address Verification Code (AVC) indicating verification level and match quality
* Address Quality Index (AQI) for simplified quality assessment
* Geocoding data (latitude/longitude) when available
* Corrected postal codes and administrative areas
Response should be in the following format:
```json theme={null}
[
{
"Input": {
"Address1": "123 Main St",
"Locality": "Boston",
"AdministrativeArea": "MA",
"PostalCode": "02129",
"Country": "USA"
},
"Matches": [
{
"Latitude": "42.379796",
"Longitude": "-71.063420",
"GeoAccuracy": "P1",
"GeoDistance": "0",
"Address": "123 Main St
Boston MA 02129-3533",
"Address1": "123 Main St",
"Address2": "Boston MA 02129-3533",
"DeliveryAddress": "123 Main St",
"DeliveryAddress1": "123 Main St",
"SuperAdministrativeArea": "",
"AdministrativeArea": "MA",
"SubAdministrativeArea": "Suffolk",
"Locality": "Boston",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "Main St",
"DependentThoroughfare": "",
"Building": "",
"Premise": "123",
"SubBuilding": "",
"PostalCode": "02129-3533",
"Organization": "",
"PostBox": "",
"CountryName": "United States",
"ISO3166-2": "US",
"ISO3166-3": "USA",
"ISO3166-N": "840",
"PostalCodePrimary": "02129",
"PostalCodeSecondary": "3533",
"AVC": "V44-I44-P7-100",
"AQI": "A",
"Sequence": "1",
"MatchRuleLabel": "Rlhng",
"HyphenClass": "C"
}
]
}
]
```
And you can use this information below to interpret the response fields:
### Geocoding Data
| Field | Type | Description |
| ------------- | ------ | ------------------------------------------------------------------------------------------------------ |
| `Latitude` | string | WGS 84 latitude in decimal degrees format |
| `Longitude` | string | WGS 84 longitude in decimal degrees format |
| `GeoAccuracy` | string | Geocoding accuracy code indicating precision level |
| `GeoDistance` | string | Radius of accuracy in meters, indicating likely maximum distance between geocode and physical location |
### Formatted Address Output
| Field | Type | Description |
| --------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------- |
| `Address` | string | Complete mailing address with line breaks (`
`). Correctly formatted for mailing in the relevant country |
| `Address1` - `Address8` | string | Individual address lines, correctly formatted for mailing in the relevant country |
| `DeliveryAddress` | string | Full address minus Organization, Locality, AdministrativeArea hierarchy, and PostalCode hierarchy fields |
| `DeliveryAddress1` - `DeliveryAddress8` | string | Individual lines contained within the DeliveryAddress field |
### Address Components
| Field | Type | Description |
| ------------------------- | ------ | ---------------------------------------------------------------------------------------------- |
| `Premise` | string | Alphanumeric code identifying an individual location (commonly house or building number) |
| `Building` | string | Descriptive name identifying an individual location, should one exist |
| `SubBuilding` | string | Secondary identifiers for a particular delivery point (e.g., "FLAT 1" or "SUITE 212") |
| `SubBuildingFloor` | string | Parsed floor information including label and numeric (e.g., "L7" or "Fl 12") |
| `Thoroughfare` | string | Most common street or block data element within a country (e.g., USA Street) |
| `DependentThoroughfare` | string | Dependent street or block data element (e.g., UK Dependent Street) |
| `Locality` | string | Most common population center data element (e.g., USA City, Canadian Municipality) |
| `DependentLocality` | string | Smaller population center dependent on Locality field (e.g., Turkish Neighborhood) |
| `DoubleDependentLocality` | string | Smallest population center dependent on both Locality and DependentLocality (e.g., UK Village) |
| `AdministrativeArea` | string | Most common geographic data element within a country (e.g., USA State, Canadian Province) |
| `SubAdministrativeArea` | string | Smallest geographic data element (e.g., USA County) |
| `SuperAdministrativeArea` | string | Largest geographic data element within a country |
| `PostalCode` | string | Complete postal code for the delivery point |
| `PostalCodePrimary` | string | Primary postal code (e.g., USA ZIP, Canadian Postcode, Indian PINcode) |
| `PostalCodeSecondary` | string | Secondary postal code information (e.g., USA ZIP+4) |
### Organization and Contact
| Field | Type | Description |
| -------------- | ------ | ------------------------------------------------- |
| `Organization` | string | Business name associated with the delivery point |
| `Contact` | string | Contact name information |
| `Function` | string | Function or job title information |
| `Department` | string | Organizational department information |
| `PostBox` | string | Post box for the delivery point, should one exist |
### Country Information
| Field | Type | Description |
| ------------- | ------ | ------------------------------------ |
| `CountryName` | string | ISO 3166 official country name |
| `ISO3166-2` | string | Two-character ISO country code |
| `ISO3166-3` | string | Three-character ISO country code |
| `ISO3166-N` | string | Three-digit numeric ISO country code |
### Verification Indicators
| Field | Type | Description |
| ---------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AVC` | string | Address Verification Code. Four-part code showing verification status, match level, parsing quality, and matchscore. Format: V44-I44-P7-100. See [AVC documentation](/report-codes/address-verification-code/) |
| `AQI` | string | Address Quality Index. Simplified quality indicator (A through F). Use AVC for detailed decision-making |
| `Sequence` | string | Order of addresses from input when multiple addresses are included in a single request (e.g., "7" represents the 7th address) |
| `MatchRuleLabel` | string | Internal matching rule applied during verification |
| `HyphenClass` | string | Hyphenation classification for the address |
| `Unmatched` | string | Information in input address fields unable to be parsed to a particular address field |
### Address Formatting (Optional)
| Field | Type | Description |
| ----------------------- | ------ | ---------------------------------------------------------------------------------------------------- |
| `AddressFormat` | string | Fields used to construct the Address field (when OutputAddressFormat server option is "Yes") |
| `DeliveryAddressFormat` | string | Fields used to construct the DeliveryAddress field (when OutputAddressFormat server option is "Yes") |
**Understanding the AVC:**
* **Verification Status** (1st character): V=Verified, P=Partially verified, A=Ambiguous, R=Reverted, U=Unverified
* **Match Level** (2nd-3rd characters): 0=None through 5=Delivery point (higher is more granular)
* **Parsing Quality** (middle section): How well the input was parsed
* **Matchscore** (final number): Percentage match between input and reference (100=perfect match, no changes needed)
**Note:** This quickstart covers the most commonly used fields. Address Verify returns many additional country-specific and certification-specific fields (CASS, PAF, etc.). See the [full API documentation](/api-reference/address-verify/international-batch-cleanse) for complete field reference.
Address Verify accepts multiple input formats. Use the fields that match your data structure:
### Unstructured Input
| Field | Type | Description |
| --------- | ------ | ------------------------------------------------------------------------ |
| `Address` | string | Complete address in a single field (e.g., "123 Main St Boston MA 02129") |
| `Country` | string | Country name or ISO code (recommended to separate from Address) |
### Structured Input
| Field | Type | Description |
| -------------------- | ------ | -------------------------- |
| `Address1` | string | Street address line 1 |
| `Address2` | string | Street address line 2 |
| `Locality` | string | City or town |
| `AdministrativeArea` | string | State, province, or region |
| `PostalCode` | string | Postal or ZIP code |
| `Country` | string | Country name or ISO code |
### Additional Input Options
| Field | Type | Description |
| ------------------------- | ------ | -------------------------------- |
| `Organization` | string | Company or organization name |
| `Building` | string | Building name |
| `SubBuilding` | string | Apartment, suite, or unit |
| `Premise` | string | House or building number |
| `Thoroughfare` | string | Street name |
| `SuperAdministrativeArea` | string | Region above administrative area |
**Tip:** For best results, use structured input with address components separated when possible. If data is unstructured, pass the complete address in `Address1` and always separate the country into the `Country` field.
When an error occurs, the API returns an error response with the following structure:
| Field | Type | Description |
| ------------- | ------ | ---------------------------- |
| `Error` | string | The error ID |
| `Description` | string | A description of the error |
| `Cause` | string | The cause of the error |
| `Resolution` | string | Actions to resolve the error |
### Common Error Codes
| Status Code | Meaning | Common Causes |
| ----------- | --------------------- | --------------------------------------------------------------------------- |
| **400** | Bad Request | Invalid parameters, malformed JSON, missing required fields |
| **401** | Unauthorized | Invalid or missing API key |
| **403** | Forbidden | API key doesn't have permission for Address Verify, or daily limit exceeded |
| **500** | Internal Server Error | Server-side issue, temporary service disruption |
**Tip:** Check the `Resolution` field for specific steps to fix the error. For more details on error responses, see [International Batch Cleanse](/api-reference/address-verify/international-batch-cleanse) in API documentation.
**Note:** Address Verify corrects and standardizes addresses but does not validate whether an address is currently occupied or deliverable in real-time. It matches against reference datasets which may not reflect the most recent changes.
## Try Address Verify
Test Address Verify using the [International Batch Cleanse Playground](/api-reference/address-verify/international-batch-cleanse?playground=open) to make your first request.
## FAQ
Address Verify returns an AVC (Address Verification Code) that provides detailed information about address quality:
* **Verification level:** How granularly the address matched (from broad Administrative Area to specific Delivery Point)
* **Parsing quality:** How well the input address could be separated into components
* **Postal code accuracy:** How precisely the postal code was verified
* **Matchscore:** How much the address changed during verification (100 = no changes needed)
The AVC helps you decide whether to accept the verified address based on your requirements. For example, direct mail campaigns might require a matchscore of 95+, while other applications might accept 80+. Different countries support different verification levels—some validate to delivery point, others only to administrative area. See [Country Data Coverage](/data-coverage/introduction/) for details.
Address Verify handles addresses formatted in two main ways:
* **Complete address in a single field:** Pass the entire address in `Address1`. Quick to implement but may reduce parsing accuracy
* **Address data divided into multiple fields:** Separate known elements (city, postal code) into specific fields, and group mixed information together. Recommended for best results
We recommend the structured approach when possible: use `Address1` for street information, then populate `Locality`, `AdministrativeArea`, `PostalCode`, and `Country` separately. This gives the verification engine more context and improves match rates.
Always separate the `Country` field when possible, even in unstructured requests.
Use the **AVC (Address Verification Code)** for decision-making. While both codes describe address quality, they serve different purposes:
* **AVC:** Detailed proprietary code showing verification level, parsing quality, and matchscore. Use this to decide whether to accept a verified address
* **AQI:** Simplified quality indicator (A through F) providing a high-level view. Useful for reporting but not recommended for acceptance decisions
When deciding whether to accept a verified address, consider both:
* How granular the verification was (from the AVC match level)
* How much the address changed (from the AVC matchscore)
The AVC provides all this information in one code. See [Address Verification Code documentation](/report-codes/address-verification-code/) for full details.
Address Capture and Address Verify complement each other in the user journey:
* **Address Capture:** Real-time type-ahead search providing verified addresses as users type
* **Address Verify:** Validation and cleansing for manually entered or edited addresses
**Example workflow for ecommerce checkout:**
1. User starts typing in address field, Address Capture provides verified suggestions
2. If user selects from suggestions, then address is already verified
3. If user manually enters or edits address, then Address Verify processes and cleanses it
4. Use the AVC from Verify to decide whether to accept the address or prompt for corrections
This combination ensures all addresses are verified regardless of how they're entered. Contact your account manager or [Loqate support](https://www.loqate.com/en-gb/contact/customer-support/#form) to learn more about using both products together.