Options

Specifies the default country. Specify the country that is the destination of most of your mailpieces. For example, if most of your mailpieces are going to Canada, specify Canada. GetGlobalCandidateAddresses uses the country you specify to attempt validation when it cannot determine the country from the StateProvince, PostalCode, and Country address fields. For a list of ISO codes, see ISO Country Codes and Module Support.

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

M

The output in mixed case (default). For example: 123 Main St Mytown FL 12345

U

The output in upper case. For example: 123 MAIN ST MYTOWN FL 12345

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

E

The country in the output in 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.

Specifies whether or not 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.

Specifies whether or not to use separators (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

The maximum number of candidate addresses to output. The default is 50. The maximum value is 100.