Parameters for Options

Table 1. ValidateAddressInternational Option
Parameter	Description
Option.OutputCountryFormat	Specifies the format to use for the country name returned in the Country output field. For example, if you select English, the country name "Deutschland" would be returned as "Germany". E Use English country names (default). I Use two-letter ISO abbreviation for the countries instead of country names. U Use Universal Postal Union abbreviation for the countries instead of country names.
Option.OutputScript	Specifies the alphabet or script in which the output should be returned. This option is bi-directional and generally takes place from Native to Latin and Latin to Native. InputScript Do not perform transliteration and provide output in the same script as the input. Latn Use English values. Native Output in the native script for the selected country wherever possible. Note: The default is InputScript.
Option.OutputCasing	Specifies the casing of the output data. The possible values are: M (Mixed) The output in mixed case (default). For example, 123 Main St Mytown FL 12345 U (Upper) The output in upper case. For example, 123 MAIN ST MYTOWN FL 12345 Note: The default is M (Mixed).
Option.OutputAddressBlocks	Specifies whether to return a formatted version of the address as it would be printed on a physical mailpiece. Each line of the address is returned in a separate address block field. There can be up to nine address block output fields: AddressBlock1 through AddressBlock9. For example, this input address: AddressLine1: 4200 Parliament Place AddressLine2: Suite 600 City: Lanham StateProvince: MD PostalCode: 20706 Results in this address block output: AddressBlock1: 4200 PARLIAMENT PL STE 600 AddressBlock2: LANHAM MD 20706-1882 AddressBlock3: UNITED STATES OF AMERICA ValidateAddressInternational formats the address into address blocks using postal authority standards. The country name is returned using the Universal Postal Union country name. Note that the option Option.CountryFormat does not affect the country name in the address block, it only affects the name returned in the Country output field. For addresses outside the U.S. and Canada, if ValidateAddressInternational is unable to validate the address, no address blocks are returned. For addresses in the U.S. and Canada, address blocks are returned even if validation fails. Y Yes, return address blocks. N No, do not return address blocks. Default.
Option.MaximumResults	A number between 1 and 10 that indicates the maximum number of addresses to return. The default is 1. Note: The difference between Keepmultimatch=N and KeepMultimatch=Y/MaximumResults=1 is that a multiple match will return a failure if KeepMultimatch=N, whereas a multiple match will return one record if KeepMultimatch=Y and MaximumResults=1.
Option.OutputRecordType	Type of output record. For more than one option, provide a list such as "AE" or "AEP". The default value for this option is "A", which returns the corrected/validated address. If you want to return individual address elements (House Number, Street Name, and more) as well, set this option to "AE". The supported output types are: A Returns 1 to 4 lines of address data plus city, state, postal code, firm name, and urbanization name information. Each address line represents an actual line of the address as it would appear on an envelope. For more information, see Standard Address Output. If Address validation engine could validate the address, the address lines contain the standardized address. When addresses are standardized, punctuation is removed, directional are abbreviated, street suffixes are abbreviated, and address elements are corrected. If Address validation engine could not validate the address, the address lines contain the address as it appeared in the input ("pass through" data). Non-validated addresses are always included as pass through data in the address line fields even if you do not specify OutputRecordType=A. E Parsed address elements. Each part of the address, such as house number, street name, street suffix, directionals, and more is returned in a separate field. For more information, see Parsed Address Elements Output. Note that if you specify "E" and specify OutputFormattedOnFail=Y, the parsed address elements will contain the input address for addresses that could not be validated. I Parsed input. This option returns the input address in parsed form regardless of whether or not Address validation engine is able to validate the address. Each part of the input address, such as house number, street name, street suffix, directionals, and more is returned in a separate field. Parsed input (value "I") differs from the combination of OutputRecordType=E and OutputFormattedOnFail=Y in that "I" returns all input address in parsed form, not just input that could not be validated. For more information, see Parsed Input. P Postal data. Output addresses contain additional data for each validated address in US and Canada. For more information, see Postal Data Output. Blank/Empty Providing a blank/empty value tells the service not to return any of the updated/corrected addresses. This optional value is retained for backwards compatibility only and is not recommend for use.
Option.OutputFieldLevelReturnCodes	Specifies whether to include field-level result indicators. Field-level result indicators describe how the service handled each address element. Field-level result indicators are returned in the qualifier "Result". For example, the field-level result indicator for HouseNumber is contained in HouseNumber.Result. For a complete listing of result indicator output fields, see Record-Level Result Indicators. Y Yes, include field results. N No, do not include field results (default).
Option.KeepMultimatch	Indicates whether to return multiple address for those input addresses that have more than one possible match. Y Yes, return multiple matches. N No, do not return multiple matches (default). For more information, see Returning Multiple Matches.
Option.InternationalCityStreetSearching	No longer used. Retained for backwards compatibility purposes.

Option.OutputCountryFormat

Specifies the format to use for the country name returned in the Country output field. For example, if you select English, the country name "Deutschland" would be returned as "Germany".

E: Use English country names (default).
I: Use two-letter ISO abbreviation for the countries instead of country names.
U: Use Universal Postal Union abbreviation for the countries instead of country names.

Option.OutputScript

Specifies the alphabet or script in which the output should be returned. This option is bi-directional and generally takes place from Native to Latin and Latin to Native.

InputScript: Do not perform transliteration and provide output in the same script as the input.
Latn: Use English values.
Native: Output in the native script for the selected country wherever possible.

Note: The default is InputScript.

Option.OutputCasing

Specifies the casing of the output data. The possible values are:

M (Mixed)

The output in mixed case (default). For example,

123 Main St

Mytown FL 12345

U (Upper)

The output in upper case. For example,

123 MAIN ST

MYTOWN FL 12345

Note: The default is M (Mixed).

Option.OutputAddressBlocks

Specifies whether to return a formatted version of the address as it would be printed on a physical mailpiece. Each line of the address is returned in a separate address block field. There can be up to nine address block output fields: AddressBlock1 through AddressBlock9.

For example, this input address:

AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
City: Lanham
StateProvince: MD
PostalCode: 20706

Results in this address block output:

AddressBlock1: 4200 PARLIAMENT PL STE 600
AddressBlock2: LANHAM MD 20706-1882
AddressBlock3: UNITED STATES OF AMERICA

ValidateAddressInternational formats the address into address blocks using postal authority standards. The country name is returned using the Universal Postal Union country name. Note that the option Option.CountryFormat does not affect the country name in the address block, it only affects the name returned in the Country output field.

For addresses outside the U.S. and Canada, if ValidateAddressInternational is unable to validate the address, no address blocks are returned. For addresses in the U.S. and Canada, address blocks are returned even if validation fails.

Y: Yes, return address blocks.
N: No, do not return address blocks. Default.

Option.MaximumResults

A number between 1 and 10 that indicates the maximum number of addresses to return.

The default is 1.

Note: The difference between Keepmultimatch=N and KeepMultimatch=Y/MaximumResults=1 is that a multiple match will return a failure if KeepMultimatch=N, whereas a multiple match will return one record if KeepMultimatch=Y and MaximumResults=1.

Option.OutputRecordType

Type of output record. For more than one option, provide a list such as "AE" or "AEP".

The default value for this option is "A", which returns the corrected/validated address.

If you want to return individual address elements (House Number, Street Name, and more) as well, set this option to "AE".

The supported output types are:

A: Returns 1 to 4 lines of address data plus city, state, postal code, firm name, and urbanization name information. Each address line represents an actual line of the address as it would appear on an envelope. For more information, see Standard Address Output. If Address validation engine could validate the address, the address lines contain the standardized address. When addresses are standardized, punctuation is removed, directional are abbreviated, street suffixes are abbreviated, and address elements are corrected. If Address validation engine could not validate the address, the address lines contain the address as it appeared in the input ("pass through" data). Non-validated addresses are always included as pass through data in the address line fields even if you do not specify OutputRecordType=A.
E: Parsed address elements. Each part of the address, such as house number, street name, street suffix, directionals, and more is returned in a separate field. For more information, see Parsed Address Elements Output. Note that if you specify "E" and specify OutputFormattedOnFail=Y, the parsed address elements will contain the input address for addresses that could not be validated.
I: Parsed input. This option returns the input address in parsed form regardless of whether or not Address validation engine is able to validate the address. Each part of the input address, such as house number, street name, street suffix, directionals, and more is returned in a separate field. Parsed input (value "I") differs from the combination of OutputRecordType=E and OutputFormattedOnFail=Y in that "I" returns all input address in parsed form, not just input that could not be validated. For more information, see Parsed Input.
P: Postal data. Output addresses contain additional data for each validated address in US and Canada. For more information, see Postal Data Output.
Blank/Empty: Providing a blank/empty value tells the service not to return any of the updated/corrected addresses. This optional value is retained for backwards compatibility only and is not recommend for use.

Option.OutputFieldLevelReturnCodes

Specifies whether to include field-level result indicators. Field-level result indicators describe how the service handled each address element. Field-level result indicators are returned in the qualifier "Result". For example, the field-level result indicator for HouseNumber is contained in HouseNumber.Result. For a complete listing of result indicator output fields, see Record-Level Result Indicators.

Y: Yes, include field results.
N: No, do not include field results (default).

Option.KeepMultimatch

Indicates whether to return multiple address for those input addresses that have more than one possible match.

Y: Yes, return multiple matches.
N: No, do not return multiple matches (default).

For more information, see Returning Multiple Matches.

Option.InternationalCityStreetSearching

No longer used. Retained for backwards compatibility purposes.