Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Required

Description

Address1

String

Yes

Address Line 1 of the International Address

Address2

String

No

Address Line 2 of the International Address

Address3StringNoAddress Line 3 of the International Address
Address4StringNoAddress Line 4 of the International Address
Address5StringNoAddress 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.

AdministrativeAreaStringYes*The name of the administrative division. Commonly the primary division of a country, such as a State, Region, Province, County, Territory or Prefecture.

PostalCode


StringYes**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'.

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

Single cite
citeIDOutputLanguages

Mastering Output Languages in AVI.


StringYes


HTML
<button class="accordion">Specifies service language settings and behavior (ENGLISH, BOTH, LOCAL_ROMAN, LOCAL).</button>
<div class="panel">
<b>ENGLISH</b>
<p>Instructs the service to return the address in English, without any localized text or accents.</p>
<br />
<b>BOTH</b>
<p>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.</p>
<br />
<b>LOCAL_ROMAN</b>
<p>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.</p>
<br />
<b>LOCAL</b>
<p>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.</p>

<p><b>Note: More output languages and settings will be added to the service in the future as they become available.</b></p>
&nbsp;
&nbsp;
</div>


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

...