Output Options

Table 1. ValidateAddressGlobal Output Options

Parameter

Description

Option.Result.MaximumResults

 This option specifies the maximum number of candidate addresses to return. This field is disabled for batch processing; for all other processing modes the default is 1 and the maximum is 99. If you are using FastCompletion mode, you may want to enter a number greater than 1 to ensure you are provided with multiple options for completing a field.

Option.Result.IncludeInputs

Specifies whether to include the input data in the output. If enabled, the output will contain fields that end with .Input containing the corresponding input field. For example, the output field AddressLine1.Input would contain the data specified in the input field AddressLine1.

TRUE
Include the input data in the output.
FALSE
Do not include the input data in the output (default).

Option.Result.StateProvinceType

Specifies the format for the StateProvince field. One of the following.

ABBREVIATION
Return the abbreviation for the state or province. For example, North Carolina would be returned as "NC".
COUNTRY_STANDARD
Return either the abbreviation or the full name depending on the format used by the country's postal authority. (Default)
EXTENDED
Return the full name of the state or province, not the abbreviation. For example "North Carolina".

Option.Result.CountryType

Specifies the language or code to use for the country name returned by ValidateAddressGlobal.

ISO2
The two-character ISO code for the country
ISO3
The three-character ISO code for the country
ISO_NUMBER
The ISO country number
NAME_CN
Chinese
NAME_DA
Danish
NAME_DE
German
NAME_EN
English (default)
NAME_ES
Spanish
NAME_FI
Finnish
NAME_FR
French
NAME_GR
Greek
NAME_HU
Hungarian
NAME_IT
Italian
NAME_JP
Japanese
NAME_KR
Korean
NAME_NL
Dutch
NAME_PL
Polish
NAME_PT
Portuguese
NAME_RU
Russian
NAME_SA
Sanskrit
NAME_SE
Swedish

Option.Result.PreferredScript

Specifies the alphabet in which the output should be returned. The alphabet in which the data is returned differs from country to country. For most countries the output will be Latin I regardless of the selected preferred language.

ASCII_Extended
ASCII characters with expansion of special characters (for example, Ö = OE)
ASCII_Simplified
ASCII characters
Database
(default) Latin I or ASCII characters (as per reference database standard)
Latin
Latin I characters
Latin_Alt
Latin I characters (alternative transliteration)
Postal_Admin_Alt
Latin I or ASCII characters (local postal administration alternative)
Postal_Admin_Pref
Latin I or ASCII characters (as preferred by local postal administration)

For countries that use an alphabet other than Latin I, the returned alphabet differs from country to country. For more information, see Alphabets for Non-Latin 1 Countries.

Option.Result.PreferredLanguage

Specifies the language in which the output should be returned. The alphabet in which the data is returned differs from country to country, but for most countries the output will be Latin, regardless of the selected preferred language.

DATABASE
Language derived from reference data for each address. Default.
ENGLISH
English locality and state/province names output, if available.

Option.Result.FormatDelimiter
Enables you to use non-standard formatting for multiline addresses in the output. Acceptable values for this field include the following:
  • CRLF (default)
  • LF
  • CR
  • SEMICOLON ( 2101 MASSACHUSETTS AVE NW ; WASHINGTON DC 20008)
  • COMMA (2101 MASSACHUSETTS AVE NW , WASHINGTON DC 20008 )
  • TAB (2101 MASSACHUSETTS AVE NW WASHINGTON DC 20008 )
  • PIPE (2101 MASSACHUSETTS AVE NW | WASHINGTON DC 20008 )
  • SPACE (2101 MASSACHUSETTS AVE NW  WASHINGTON DC 20008)
Note: The same value must be selected for both the input option and output option.

Option.Result.Casing

Specifies the casing of the output.

NATIVE
Output will be based on the reference database standard.
UPPER
Output will be in upper case for all countries.
LOWER
Output will be in lower case for all countries.
MIXED
Casing determined by country-specific rules.
NOCHANGE
For parse mode, returns the data the way it was entered. For validation mode, uses the casing found in the reference data and according to postal rules. Values that could not be checked against the reference data will retain their input casing.

Alphabets for Non-Latin 1 Countries

For countries that use an alphabet other than Latin I, the returned alphabet differs from country to country. The following table shows how the output is returned for specific countries. All countries that are not listed use the value specified in the field option.

Country Database Latin
RUS Cyrillic Cyrillic Cyrillic CYRILLIC_ISO CYRILLIC_BGN CYRILLIC_ISO + LATIN_SIMPLE CYRILLIC_ISO + LATIN
JPN Kanji Kanji Kana JAPANESE JAPANESE JAPANESE + LATIN_SIMPLE JAPANESE + LATIN
CHN Hanzi Hanzi Hanzi CHINESE_ MANDARIN CHINESE_ CANTONESE CHINESE_ MANDARIN + LATIN_SIMPLE CHINESE_ MANDARIN + LATIN
HKG Hanzi Hanzi Hanzi CHINESE_ CANTONESE CHINESE_ MANDARIN CHINESE_ CANTONESE + LATIN_SIMPLE CHINESE_ CANTONESE + LATIN
TWN Hanzi Hanzi Hanzi CHINESE_ CANTONESE CHINESE_ MANDARIN CHINESE_ CANTONESE + LATIN_SIMPLE CHINESE_ CANTONESE + LATIN
GRC Greek Greek Greek GREEK_ISO GREEK_BGN GREEK_ISO + LATIN_SIMPLE GREEK_ISO + LATIN
KOR Latin Hangul Hanja KOREAN KOREAN KOREAN + LATIN_SIMPLE KOREAN + LATIN
ISR Latin Hebrew Hebrew HEBREW HEBREW HEBREW + LATIN_SIMPLE HEBREW + LATIN
ROM Latin-3 Latin-3 Latin-3 Latin-3 Latin-3 LATIN_SIMPLE LATIN
POL Latin-2 Latin-2 Latin-2 Latin-2 Latin-2 LATIN_SIMPLE LATIN
CZE Latin-2 Latin-2 Latin-2 Latin-2 Latin-2 LATIN_SIMPLE LATIN
CRI Latin-2 Latin-2 Latin-2 Latin-2 Latin-2 LATIN_SIMPLE LATIN
HUN Latin-2 Latin-2 Latin-2 Latin-2 Latin-2 LATIN_SIMPLE LATIN
MDA Latin-2 Latin-2 Latin-2 Latin-2 Latin-2 LATIN_SIMPLE LATIN
SVK Latin-2 Latin-2 Latin-2 Latin-2 Latin-2 LATIN_SIMPLE LATIN
LAT Latin-7 Latin-7 Latin-7 Latin-7 Latin-7 LATIN_SIMPLE LATIN