Our real-time International Address Validation API service verifies and corrects global mailing addresses to the unique requirements of each country’s postal address formats and cultural idiosyncrasies. With continual updates from country-specific postal authorities, our data is always up-to-date with genuine and accurate addresses.

 

Name Type Required Description
Address1 String Yes Address Line 1 of the International Address
Address2 String No Address Line 2 of the International Address
Address3 String No Address Line 3 of the International Address
Address4 String No Address Line 4 of the International Address
Address5 String No Address Line 5 of the International Address
Locality String Yes* The name of the distinct population cluster, such as a City, Town or other type of Municipality.
AdministrativeArea String Yes* The name of the administrative division. Commonly the primary division of a country, such as a
State, Region, Province, County, Territory or Prefecture.
PostalCode String Yes** The postal code of the international address. It is recommended that the postal code be
formatted to contain a strong resemblance to the proper country specific format, and that you do
not precede the postal code with a country or region code. For example, use ‘09170’ instead of
‘FR-9170’.
Country String Yes The preferred name of the country or the ISO 3166-1 Alpha-2 Country Code or the Alpha-3
Country Code. Alternate country names and spellings are supported, but the use of the common
English spelled name or ISO2 country code is recommended. For a list of all supported countries
please see the Country Support Table.
OutputLanguage 
[1]		 String Yes

Specifies service language settings and behavior (ENGLISH, BOTH, LOCAL_ROMAN, LOCAL).

ENGLISH

Instructs the service to return the address in English, without any localized text or accents.


BOTH

Instructs the service to return a standardized address in both English and in its localized text (e.g. Cyrillic, Chinese, etc.) and format when applicable. The localized address is returned in the InformationComponents section of the output under the component names LocalAddress1, LocalAddress2, ..., LocalAddress8.


LOCAL_ROMAN

Instructs the service to return the address in its local spelling when applicable using Roman text. For example, the city of Rome will be returned as Roma, Naples as Napoli, Naestved as Næstved, and Cologne as Köln. Street names will also be returned in their local spelling. For example, Gruener to Grüner and Gaetterli to Gätterli.


LOCAL

Instructs the service to return the formatted address and parsed address values in the country's localized text (e.g. Cyrillic, Chinese, etc.) and not in English roman text.

Note: More output languages and settings will be added to the service in the future as they become available.
LicenseKey String Yes Your license key to use the service.  
Sign up for a free trial key at https://www.serviceobjects.com/products/address-geocoding/address-validation-international
  • *  Required if a postal code is not provided.
  • ** Required if a locality and an administrative area are not provided.
  • AddressInfoResponse
Name Type Values Description
AddressInfo AddressInfo Varies The corrected address.
Error Error Varies Error object indicating why the service could not return a result. See “Errors” below for more information.
  • AddressInfo
Name Type Values Description
Status String See “Address Status” for descriptions and possible values. Indicates the validity of the input address. Unless an error is returned this field will always be returned.
ResolutionLevel String See “Address ResolutionLevel” for descriptions and possible values. Indicates the level of accuracy to which the input address could be resolved.
Address1 String or NULL Varies The formatted Address 1 line of the input address.
Address2 String or NULL Varies The formatted Address 2 line of the input address.
Address3 String or NULL Varies The formatted Address 3 line of the input address.
Address4 String or NULL Varies The formatted Address 4 line of the input address.
Address5 String or NULL Varies The formatted Address 5 line of the input address.
Address6 String or NULL Varies The formatted Address 6 line of the input address.
Address7 String or NULL Varies The formatted Address 7 line of the input address.
Address8 String or NULL Varies The formatted Address 8 line of the input address.
Locality String or NULL Varies The preferred English name of the locality, such as a City, Town or other type of Municipality. Can also be an AdministrativeArea.
AdministrativeArea String or NULL Varies The preferred English name of the administrative division of the country, such as a State, Region, Province, County, Territory or Prefecture.
PostalCode String or NULL Varies Represents the standardized postal code.
Country
[2] [3]		 String Varies The preferred english name of the country. This field will always be returned unless an error is returned.
CountryISO2 String Varies Represents the ISO 3166-1 Alpha-2 Country Code. This field will always be returned unless an error is returned.
CountryISO3 String Varies Represents the ISO 3166-1 Alpha-3 Country Code. This field will always be returned unless an error is returned.
InformationComponents InformationComponent[] or NULL Varies A name-value pair collection containing additional information about the address. See the InformationComponent table and the list of Components for more details.
  • InformationComponent
Name Type Values Description
Name String Varies The variable name of the Name-Value pair that is to be returned. See InformationComponents for a full listing.
Value String Varies The resulting value of the of the variable returned in the “Name”.
  1. ^ Mastering Output Languages in AVI.
  2. ^ Understanding Addresses In Australia
  3. ^ Understanding Addresses in the United Kingdom