Address Format Options

Parameter	Description
Option.ExtractFirm	Specifies whether to extract the firm name from AddressLine1 through AddressLine4 and place it in the FirmName output field. This option works in cases where the input record's FirmName field is blank and there is more than one address line. Y Yes, extract the firm name. N No, do not extract the firm name. Default. To identify firm names in address lines, the address lines are scanned for keywords and patterns that identify which fields are address lines and which are FirmName lines. Since this is done based on patterns, fields may be misidentified. The following tips can help ensure optimal firm extraction: If possible, place the primary address elements in AddressLine1, the secondary elements in AddressLine2, Urbanization in AddressLine3, and firm in AddressLine4. If the address has no urbanization code, then place the firm name in AddressLine3 and leave AddressLine4 blank. For example, AddressLine1: 4200 Parliament Place AddressLine2: Suite 600 AddressLine3:PreciselyAddressLine4: <blank> When you define just two address lines, AddressLine2 is assigned to the secondary address most of the time. If you want to increase the chance that AddressLine2 will be treated as a firm name, put the firm name in AddressLine3 and leave AddressLine2 blank. Numbers in a firm name (such as the "1" in "1 Stop Software") will increase the likelihood that the field will be treated as an address line. Here are some examples of firm name extraction: In this example, AddressLine2 would get extracted into the FirmName output field FirmName: <blank> AddressLine1: 4200 Parliament Place Suite 600 AddressLine2: International Goose Feathers inc. In this example, AddressLine3 would get extracted into the FirmName output field. FirmName: <blank> AddressLine1: 4200 Parliament Place AddressLine2: Suite 600 AddressLine3:Precisely In this example, AddressLine3 would be placed in the AdditionalInputData output field. The firm name would not be extracted because the FirmName input field is not blank. FirmName: International Goose Feathers Inc. AddressLine1: 4200 Parliament Place AddressLine2: Suite 600 AddressLine3:Precisely In this example, no firm name would be extracted because there is only one non-blank address line, which is always treated as the primary address element. FirmName: <blank> AddressLine1: 4200 Parliament Place Suite 600 In this example, AddressLine2 would be treated as a secondary address element because the numeral "1" causes that field to be treated as a secondary address element. FirmName: <blank> AddressLine1: 4200 Parliament Place Suite 600 AddressLine2: 1 Stop Software
Option.ExtractUrb	Specifies whether to extract the urbanization name from AddressLine1 through AddressLine4 and place it in the USUrbanName output field. This option works in cases where the input record's USUrbanName field is blank and there is more than one address line. Y Yes, extract the urbanization name. N No, do not extract the urbanization name. Default. To identify urbanization names, the address lines are scanned for keywords and patterns that identify which fields are address lines and which are urbanization name lines. Since this is done based on patterns, it is possible for fields to be incorrectly identified. To help ensure optimal urbanization extraction, place the primary address elements in AddressLine1, the secondary elements in AddressLine2, Urbanization in AddressLine3, and firm in AddressLine4, if possible. For example, AddressLine1: A1 Calle A AddressLine2:AddressLine3: URB Alamar AddressLine4:Precisely
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). S Use Spanish country names. F Use French country names. G Use German country names. 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.OutputPostalCodeSeparator	Specifies whether 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. Note: Spaces are used in Canadian postal codes and hyphens in U.S. ZIP + 4® Codes.
Option.OutputRecordType	Type of output record. For more than one, provide a list. 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 the address is validated, the address lines contain the standardized address. When addresses are standardized, punctuation is removed, directionals are abbreviated, street suffixes are abbreviated, and address elements are corrected. If the address is not validated, 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 so on is returned in a separate field. 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 the address is validated. Each part of the input address, such as house number, street name, street suffix, directionals, and so on 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. P Postal data. Output addresses contain additional data for each validated address. For more information, see Postal Data Output. Blank Do not return any address data or postal data.
Option.OutputShortCityName	Specifies how to format city names that have short city name or non-mailing city name alternatives. Applies to U.S. and Canadian addresses. Y Returns the USPS®-approved abbreviation for the city, if there is one. The USPS® provides abbreviations for city names that are 14 characters long or longer. City abbreviations are 13 characters or less and can be used when there is limited space on the mailing label. If there is no short city name for the city, then the full city name is returned. N Returns the long city name (default). S Returns the abbreviated city name only if an abbreviated city name is used in the input address. If the input address does not use a short city name, either the long or short city name could be returned, depending on USPS® regulations for the particular city. Select this option if you are performing a CASS™ test. V Output the non-mailing city name (the vanity name) if the input city name is a non-mailing city name. For example, "Hollywood" is a non-mailing city name for "Los Angeles". If you do not select this option and the input city name is a non-mailing city name the long version of the mailing city is returned.
Option.OutputFormattedOnFail	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. If this option is not selected, the output address fields are blank when the address cannot be validated. Note: This option applies only to U.S. and Canadian addresses. Formatted data will not be returned for any other address. N No, do not format failed addresses (default). Y Yes, format failed addresses. Formatted addresses are returned using the format specified by the OutputRecordType option. Note that if you specify `OutputRecordType=E`, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateMailingAddressUSCAN could validate the address, specify `OutputRecordType=I`. Formatted addresses are returned using the format specified by the Option.OutputRecordType option. Note that if you specify `Option.OutputRecordType=E`, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateMailingAddressUSCAN could validate the address, specify `Option.OutputRecordType=I`. Formatted addresses are returned using the format specified by the Include a standard address, Include address line elements, and Include postal information checkboxes. Note that if you select Include address line elements, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateAddress could validate the address, select Include standardized input address elements. If you specify Y, you must specify "A" and/or "E" for OutputRecordType. If you specify Y, you must specify "A" and/or "E" for Option.OutputRecordType. If you check this option, you must select Include a standard address and/or Include address line elements.
Option.StandardAddressFormat	Specifies where to place secondary address information for U.S. addresses. Secondary address information refers to apartment numbers, suite numbers, and similar designators. For example, in this address the secondary address information is "Apt 10E" and the primary address information is "424 Washington Blvd". Apt 10E 424 Washington Blvd Springfield MI 49423 C Place both primary and secondary address information in AddressLine1 (default). S Place the primary address information in AddressLine1 and the secondary address information in AddressLine2. D Place both primary and secondary address information in AddressLine1 and place dropped information from dual addresses in AddressLine2. A dual address is an address that contains both street information and PO Box/Rural Route/Highway Contract information. For more information, see About Dual Address Logic.
Option.StandardAddressPMBLine	Specifies where Private Mailbox (PMB) information is placed. N Do not include the PMB information in Standard Address output (default). 1 Place the PMB information in AddressLine1. If you specify 1, you must set Option.StandardAddressFormat to either C or D. 2 Place the PMB information in AddressLine2.
Option.ValidateAddress-OutputCasing	Specifies the casing of the output address. 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
Data.OutputMultinationalCharacters	Specifies whether or not to return multinational characters, including diacritical marks such as umlauts or accents. (Not supported for U.S. addresses).

Option.ExtractFirm

Specifies whether to extract the firm name from AddressLine1 through AddressLine4 and place it in the FirmName output field. This option works in cases where the input record's FirmName field is blank and there is more than one address line.

Y: Yes, extract the firm name.
N: No, do not extract the firm name. Default.

To identify firm names in address lines, the address lines are scanned for keywords and patterns that identify which fields are address lines and which are FirmName lines. Since this is done based on patterns, fields may be misidentified. The following tips can help ensure optimal firm extraction:

If possible, place the primary address elements in AddressLine1, the secondary elements in AddressLine2, Urbanization in AddressLine3, and firm in AddressLine4. If the address has no urbanization code, then place the firm name in AddressLine3 and leave AddressLine4 blank. For example,
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
AddressLine3:PreciselyAddressLine4: <blank>
When you define just two address lines, AddressLine2 is assigned to the secondary address most of the time. If you want to increase the chance that AddressLine2 will be treated as a firm name, put the firm name in AddressLine3 and leave AddressLine2 blank.
Numbers in a firm name (such as the "1" in "1 Stop Software") will increase the likelihood that the field will be treated as an address line.

Here are some examples of firm name extraction:

In this example, AddressLine2 would get extracted into the FirmName output field
FirmName: <blank>
AddressLine1: 4200 Parliament Place Suite 600
AddressLine2: International Goose Feathers inc.
In this example, AddressLine3 would get extracted into the FirmName output field.
FirmName: <blank>
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
AddressLine3:Precisely
In this example, AddressLine3 would be placed in the AdditionalInputData output field. The firm name would not be extracted because the FirmName input field is not blank.
FirmName: International Goose Feathers Inc.
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
AddressLine3:Precisely
In this example, no firm name would be extracted because there is only one non-blank address line, which is always treated as the primary address element.
FirmName: <blank>
AddressLine1: 4200 Parliament Place Suite 600
In this example, AddressLine2 would be treated as a secondary address element because the numeral "1" causes that field to be treated as a secondary address element.
FirmName: <blank>
AddressLine1: 4200 Parliament Place Suite 600
AddressLine2: 1 Stop Software

Option.ExtractUrb

Specifies whether to extract the urbanization name from AddressLine1 through AddressLine4 and place it in the USUrbanName output field. This option works in cases where the input record's USUrbanName field is blank and there is more than one address line.

Y: Yes, extract the urbanization name.
N: No, do not extract the urbanization name. Default.

To identify urbanization names, the address lines are scanned for keywords and patterns that identify which fields are address lines and which are urbanization name lines. Since this is done based on patterns, it is possible for fields to be incorrectly identified. To help ensure optimal urbanization extraction, place the primary address elements in AddressLine1, the secondary elements in AddressLine2, Urbanization in AddressLine3, and firm in AddressLine4, if possible. For example,

AddressLine1: A1 Calle A
AddressLine2:AddressLine3: URB Alamar
AddressLine4:Precisely

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).
S: Use Spanish country names.
F: Use French country names.
G: Use German country names.
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.OutputPostalCodeSeparator

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

Note: Spaces are used in Canadian postal codes and hyphens in U.S. ZIP + 4® Codes.

Option.OutputRecordType

Type of output record. For more than one, provide a list.

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 the address is validated, the address lines contain the standardized address. When addresses are standardized, punctuation is removed, directionals are abbreviated, street suffixes are abbreviated, and address elements are corrected. If the address is not validated, 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 so on is returned in a separate field. 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 the address is validated. Each part of the input address, such as house number, street name, street suffix, directionals, and so on 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.
P: Postal data. Output addresses contain additional data for each validated address. For more information, see Postal Data Output.
Blank: Do not return any address data or postal data.

Option.OutputShortCityName

Specifies how to format city names that have short city name or non-mailing city name alternatives. Applies to U.S. and Canadian addresses.

Y: Returns the USPS®-approved abbreviation for the city, if there is one. The USPS® provides abbreviations for city names that are 14 characters long or longer. City abbreviations are 13 characters or less and can be used when there is limited space on the mailing label. If there is no short city name for the city, then the full city name is returned.
N: Returns the long city name (default).
S: Returns the abbreviated city name only if an abbreviated city name is used in the input address. If the input address does not use a short city name, either the long or short city name could be returned, depending on USPS® regulations for the particular city. Select this option if you are performing a CASS™ test.
V: Output the non-mailing city name (the vanity name) if the input city name is a non-mailing city name. For example, "Hollywood" is a non-mailing city name for "Los Angeles". If you do not select this option and the input city name is a non-mailing city name the long version of the mailing city is returned.

Option.OutputFormattedOnFail

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. If this option is not selected, the output address fields are blank when the address cannot be validated.

Note: This option applies only to U.S. and Canadian addresses. Formatted data will not be returned for any other address.

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

Formatted addresses are returned using the format specified by the OutputRecordType option. Note that if you specify OutputRecordType=E, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateMailingAddressUSCAN could validate the address, specify OutputRecordType=I.

Formatted addresses are returned using the format specified by the Option.OutputRecordType option. Note that if you specify Option.OutputRecordType=E, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateMailingAddressUSCAN could validate the address, specify Option.OutputRecordType=I.

Formatted addresses are returned using the format specified by the Include a standard address, Include address line elements, and Include postal information checkboxes. Note that if you select Include address line elements, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateAddress could validate the address, select Include standardized input address elements.

If you specify Y, you must specify "A" and/or "E" for OutputRecordType.

If you specify Y, you must specify "A" and/or "E" for Option.OutputRecordType.

If you check this option, you must select Include a standard address and/or Include address line elements.

Option.StandardAddressFormat

Specifies where to place secondary address information for U.S. addresses. Secondary address information refers to apartment numbers, suite numbers, and similar designators. For example, in this address the secondary address information is "Apt 10E" and the primary address information is "424 Washington Blvd".

Apt 10E
424 Washington Blvd
Springfield MI 49423

C: Place both primary and secondary address information in AddressLine1 (default).
S: Place the primary address information in AddressLine1 and the secondary address information in AddressLine2.
D: Place both primary and secondary address information in AddressLine1 and place dropped information from dual addresses in AddressLine2. A dual address is an address that contains both street information and PO Box/Rural Route/Highway Contract information. For more information, see About Dual Address Logic.

Option.StandardAddressPMBLine

Specifies where Private Mailbox (PMB) information is placed.

N: Do not include the PMB information in Standard Address output (default).
1: Place the PMB information in AddressLine1. If you specify 1, you must set Option.StandardAddressFormat to either C or D.
2: Place the PMB information in AddressLine2.

Option.ValidateAddress-OutputCasing

Specifies the casing of the output address. 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

Data.OutputMultinationalCharacters

Specifies whether or not to return multinational characters, including diacritical marks such as umlauts or accents. (Not supported for U.S. addresses).