Address Verify
/api/v3/address/verify
Address Verify: This endpoint provides a way to verify an
address, i.e. it confirms whether or not the address provided in an input
address record is valid or not. If it is valid, it returns the
cleansed/corrected address as an output record.
The input of this POST is a top-level JSON object containing a list of address records called inputs[]. Each address record is a JSON map of fields. All field values are represented as Strings. You can customize the results further by adding a JSON map called options into the top-level object. Options affect the process. For example: OutputScript=Latn, PreferPrimaryValidAlias=Yes, DisableEnhance=No. More details on valid option parameters
The output is a JSON object containing a Status field and a list
of output address records called outputs[]. Each address record is a JSON
map of fields; all field values are represented as Strings. The outputs
array corresponds to the inputs array. In other words, the record
outputs[n] is the response to the record inputs[n].
The output contains a Status field, where the value "OK" means that the
overall transaction could be completed. If Status shows "Error", then the
field "Error" shows the reason.
Except some minor differences, such as no need to transmit a parameter
lqtkey, this endpoint is very similar to Address Verify.
Cost: The user is charged for this record, unless an output address record cannot be verified at all (AVC main code is U or R).
Functionality: Each input record and each output record is a JSON
map, and the fields are described in the following table.
| Attribute Name | Direction | Description |
|---|---|---|
AQI |
Out | The Address Quality Index is
used to indicate the quality of an output address record.
|
AVC |
Out | The Address Verification Code
for this address. The first character of this String conveys the most
important information about the result for this particular address:
|
Address |
In/Out | The full address, correctly formatted for mailing in the relevant country. Different lines are separated via the pipe (|) character. |
Address1 ... Address8 |
In/Out | These fields represent the
same data as the Address parameter, just broken out line by
line. |
AdministrativeArea |
In/Out | The most common geographic data element within a country. For example, a state in the USA or a province in Canada. |
Country |
In | The name of the country or one of the ISO 3166 2 or 3 letter country abbreviations. |
CountryName |
Out | The ISO 3166 official name of the country. |
DeliveryAddress |
In/Out | The full address minus the Organization, Locality, AdministrativeArea hierarchy and PostalCode hierarchy fields, correctly formatted for mailing in the relevant country, including line breaks specified using the pipe character (|). |
DeliveryAddress1 ... DeliveryAddress8 |
In/Out |
These fields represent the same data as the DeliveryAddress
parameter, just broken out line by line. |
DependentLocality |
In/Out | A smaller population center
data element, dependent on the contents of the Locality
parameter. For instance, Turkish neighborhood. |
DoubleDependentLocality |
In/Out | The smallest population center
data element, dependent both on the Locality and
DependentLocality parameters. For instance, UK village. |
ISO3166-2 |
Out | The ISO 3166 2-character country code |
IDO3166-3 |
Out | The ISO 3166 3-character country code |
ISO3166-N |
Out | The ISO 3166 3-digit numeric country code |
Locality |
In/Out | The locality, town, or city of the address. |
PostalCode |
In/Out | The complete postal code for a particular delivery point, should such a detail be able to be determined. |
PostalCodePrimary |
Out | The primary postal code used for a particular country. For instance, USA ZIP. |
PostalCodeSecondary |
Out | The secondary postal code information, if used for a particular country. For instance, USA ZIP Plus 4 |
Premise |
In/Out | The alphanumeric code identifying an individual location, should one exist. |
PremiseNumber |
In/Out | The alphanumeric indicator
within the Premise field, should one exist. For instance, if
Premise contains "Plot 7/7a", then PremiseNumber contains "7/7a" if a
sufficient level of parsing details exists within a particular country. |
SubAdministrativeArea |
In/Out | The smallest geographic data element within a country, where applicable. For example, a county in the USA. |
SuperAdministrativeArea |
In/Out | The largest geographic data element within a country, where applicable |
Thoroughfare |
In/Out | The most common street or block data element within a country. For instance, USA Street. |
Here is an example JSON Verify Request:
{
"inputs":[
{
"Address1":"koniginstrasse 5",
"Address2":"munich germany"
}
]
}
And here is the corresponding JSON Response:
{
"Status": "OK",
"outputs": [
{
"AQI": "A",
"AVC": "V44-I44-P3-100",
"Address": "Kniginstr. 5|80539 Mnchen",
"Address1": "Kniginstr. 5",
"Address2": "80539 Mnchen",
"AdministrativeArea": "Bayern",
"CountryName": "Germany",
"DeliveryAddress": "Kniginstr. 5",
"DeliveryAddress1": "Kniginstr. 5",
"DependentLocality": "Maxvorstadt",
"ISO3166-2": "DE",
"ISO3166-3": "DEU",
"ISO3166-N": "276",
"Locality": "Mnchen",
"PostalCode": "80539",
"PostalCodePrimary": "80539",
"Premise": "5",
"PremiseNumber": "5",
"SubAdministrativeArea": "Oberbayern",
"Thoroughfare": "Kniginstr."
}
],
"Error": null
} Request
There are no request parameters for this operation.
- application/json; charset=UTF-8
- application/json; charset=UTF-8
object-
debug: boolean
-
inputs: array
inputs
-
options: object
options
Additional Properties Allowed: additionalProperties
objectResponse
- application/json; charset=UTF-8
200 Response
array-
Array of:
object items
Additional Properties Allowed: additionalProperties