Output Data Options

Table 1. ValidateGlobalAddress Output Data Options

optionName

Description

OutputCasing

Specifies the casing of the output data. One of the following:

M
Returns the output in mixed case (default). For example: 123 Main St Mytown FL 12345
U
Returns the output in upper case. For example: 123 MAIN ST MYTOWN FL 12345

OutputCountryFormat

Specifies the format to use for the country name in the output. One of the following:

E
The country in the output is English (default).
I
The country in the output in the two-character ISO code.
U
The country in the output in the three-character UPU code.

StandardizeAddressOnFail

Specifies whether to return a standardized address when an address cannot be validated. The address is formatted using the preferred address format for the address's country. If this option is not selected, the output address component fields (StreetName, HouseNumber, etc.) are blank when address validation fails.

N
No, do not format failed addresses (default).
Y
Yes, standardize failed addresses.

ShowExtraAddressLine

Specifies whether to include the city, state/province, and postal code in one of the AddressLine output fields. Regardless of what you specify with this option, the output fields City, State/Province, and PostalCode will always contain the city, state/province, and postal code.

Y
Yes, include city, state/province, and postal code in an AddressLine output field (default).
N
No, do not include city, state/province, and postal code in an AddressLine output field.

OutputPostalCodeSeparator

Specifies whether to use a separator (spaces or hyphens) in ZIP™ Codes or Canadian postal codes.

For example, a ZIP + 4® Code with the separator would be 20706-1844 and without the separator it would be 207061844. A Canadian postal code with the separator would be P5E"1S7 and without the separator it would be P5E1S7.

Y
Yes, use separator (default)
N
No, do not use separator
Note: Spaces are used in Canadian postal codes and hyphens in U.S. ZIP + 4® Codes.

FormatOnFail

Specifies whether to return a formatted address when an address cannot be validated. The address is formatted using the preferred address format for the address's country.

Y
Yes, return a formatted address when an address cannot be validated.
N
No, do not return a formatted address when an address cannot be validated (default).

ValidateAddress

Enables address validation. Address validation does the following:

  • Matches components to the relevant country's reference data
  • Corrects spelling errors
  • Adds missing components
  • Corrects or adds postal codes
Y
Yes, validate addresses (default).
N
No, do not validate addresses.

FormatAddress

Formats the address components into the statutory postal or custom formats.

Y
Yes, format addresses (default).
N
No, do not format addresses.