Post Request Parameters

99999

99999-9999

A9A9A9

A9A 9A9

9999 999

The country in the format determined by what you selected in Data.OutputCountryFormat:

ISO Code

UPU Code

English

French

German

Spanish

If this field is blank, the address is formatted in English. If the field contains any non-blank value, the address is formatted in French. Note that addresses in Quebec are always formatted in French regardless of the value in this field.

Specifies where to place rural route delivery information. An example of an address with rural route delivery information is:

36 GRANT RD RR 3

ANTIGONISH NS

In this address, "RR 3" is the rural route delivery information.

A:

36 GRANT RD RR 3

S:

36 GRANT RD

RR 3

Specifies whether to use the long, medium, or short version of the city if the city has a long name. For example,

Long: BUFFALO HEAD PRAIRIE

Medium: BUFFALO-HEAD-PR

Short: BUFFALO-HD-PR

D: Use the default option specified by the OutputShortCityName parameter. Default. If you specify OutputShortCityName=V, the city is formatted as if you select for this option (see below) andY for CanOutputCityAlias.

S: Output short city name.

L: Output the long city name.

M: Output the medium city name.

I: Use the same city format as used in the input address. Output is L, M, or S.

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.

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

Y: No, do not output field-level return codes (default).

N: Yes, output field-level return codes.

Specifies where to place station information. An example of an address with station information is:

PO BOX 8625 STN A

ST. JOHN'S NL

I: Place station information in the same location as it is in the input address. Default.

A: Place station information on the same line as the address, after the address information. For example, PO BOX 8625 STN A

S: Place station information on a separate address line. For example, PO BOX 8625STN A

N or P:

AddressLine1: PO Box 1

City: Kemp

StateProvince: TX

PostalCode: 75143-0001

S:

AddressLine1: 401 N Main St Apt 1

City: Kemp

StateProvince: TX

PostalCode: 75143-4806

N: Do not change the civic and/or suite information to match the LVR or single-single record. The LVR record will be marked as a valid but non-correctable record (VN). The single-single record will be corrected, if possible, or processed as a non-correctable record.

Y: Change the civic and/or suite information to match the LVR or single-single record.

Apt: Use "Apt" as the label. Default.

Apartment: Use "Apartment" as the label.

Suite: Use "Suite" as the label.

Unit: Use "Unit" as the label.

Y: Output the city alias when the city alias is in the input. Default.

N: Never output the city alias even if it is in the input.

D: Use DualAddressLogic Global Option. Default.

P: Match to PO Box or other non-street data.

S: Match to street.

For example, given the following input address:

AddressLine1: 36 GRANT RD

AddressLine2: RR 4

City: ANTIGONISH

StateProvince: NS

The address data that is not used to standardize the address is returned in the AdditionalInputData field

D: Place apartment information in the location specified in the. Default.

B: Place apartment information at the at the end of the AddressLine1 field.

F: Place the apartment number only (no label) at the beginning of the AddressLine1 field. For example, 400-123 Rue Main

E: Place the apartment number and label at the beginning of the AddressLine1 field. For example, Apt 400 123 Rue Main

S: Place apartment information on a separate line.

I: Place apartment information in the same location as the input address.

N: Change the house number to match the postal code. Default.

Y: Change the postal code to match the house number.

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

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.

Blank

Do not return any address data or postal data.

A

Abbreviate non-civic keywords. Default.

F

Do not abbreviate non-civic keywords. The full keyword is used.

English: 123 Main St W

French: 123 Rue Main O

The parameter controls the formatting of the address. It also affects the spelling of the directional but not spelling of the suffix.

C

Use the street suffix returned by the matching process to determine the language. The street suffix returned by the matching process, which is used internally by ValidateMailingAddressUSCAN during processing, may be different from that in the input address. Ambiguous records are formatted like the input. Default. All addresses in Quebec are formatted using French.

S

Use the Canadian database to determine the language. The Canadian database contains data from the Canada Post Corporation (CPC). All addresses in Quebec are formatted using French.

T

Use the CanLanguage input field to determine the language. If there is a non-blank value in this field the address are formatted using French.

App

Use "App" as the label. Default.

Appartement

Use "Appartement" as the label.

Bureau

Use "Bureau" as the label

Suite

Use "Suite" as the label.

Unite

Use "Unite" as the label.

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

ValidateMailingAddressUSCAN 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 OutputCountryFormat 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 ValidateAddress 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.

N

No, do not return address blocks.

Y

Yes, return address blocks. Default.

M:

123 Main St

Mytown FL 12345

U:

123 MAIN ST

MYTOWN FL 12345

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.

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

N

No, do not use multinational characters in the output (default). Only standard ASCII characters is returned.

Y

Yes, use multinational characters in the output.

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

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.

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.

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.

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

The default value is 10.

This is one of three options that control how ValidateMailingAddressUSCAN handles street name aliases. The other two are OutputPreferredAlias and OutputAbbreviatedAlias.

N

No, do not return street name aliases in the output.

Y

Yes, return street name aliases in the output if the input street name is an alias (default).

The USPS® Locatable Address Conversion System (LACS) allows you to correct addresses that have changed as a result of a rural route address converting to street-style address, a PO Box renumbering, or a street-style address changing. When enabled, LACSLink processing is attempted for addresses that could not be validated, or addresses were validated and flagged for LACSLink conversion.

To perform LACSLink processing, you must have the LACSLink database installed.

N

No, do not attempt LACSLink conversion.

Y

Yes, attempt LACSLink conversion. Default.

Specifies whether to process U.S. addresses. If you enable U.S. address processing ValidateMailingAddressUSCAN will attempt to validate U.S. addresses. If you disable U.S. address processing, U.S. addresses will fail, meaning they are returned with an "F" in the Status output field. The output field Status.Code will say "DisabledCoder." If you are not licensed for U.S. address processing you must disable U.S. address processing in order for your jobs to complete successfully, regardless of whether or not they contain U.S. addresses.

N

No, do not process U.S. addresses.

Y

Yes, process U.S. addresses. Default.

Delivery Point Validation (DPV®) validates that a specific address exists, as opposed to validating that a specific address is within a range of valid addresses. CMRA processing checks if an address is for a mailbox rented from a private company, referred to as a Commercial Mail Receiving Agent (CMRA).

To perform DPV and CMRA processing, you must have the DPV database installed. The DPV database contains both DPV and CMRA data.

N

No, do not perform Delivery Point Validation or CMRA processing. Default.

Y

Yes, perform Delivery Point Validation and CMRA processing.

For a listing of the output fields returned by this option, see DPV and CMRA Output.

The Early Warning System (EWS) uses the USPS® EWS File to validate addresses that are not in the ZIP + 4® database.

To perform EWS processing, you must have the EWS database installed.

If an input address matches an address in the EWS file, the following record-level result indicators are returned:

Status="F"

Status.Code="EWSFailure"

Status.Description="Address found in EWS table"

N

No, do not perform EWS processing. Default.

Y

Yes, perform EWS processing.

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: Precisely

AddressLine4: <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

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

Specifies whether to perform SuiteLink™ processing.

SuiteLink corrects secondary address information for U.S. business addresses whose secondary address information could not be validated. If SuiteLink processing is enabled, the firm name is matched to a database of known firm names and their secondary address information.

For example,

Firm Name: Precisely

Address Line 1: 4200 Parliament Place

Address Line 2: STE 1

Postal Code: 20706

In this case, SuiteLink processing would change the suite number to the correct suite number:

Firm Name: Precisely

Address Line 1: 4200 Parliament Place

Address Line 2: STE 600

Postal Code: 20706-1844

To perform SuiteLink™ processing, you must have the SuiteLink™ database installed.

This option takes one of the following values:

N

No, do not use SuiteLink™. Default.

Y

Yes, use SuiteLink™ processing.

Specifies whether to use a street's preferred alias in the output.

Street name aliases in the United States are alternative names given to sections of a street. There are four types of street name aliases:

Preferred—A preferred alias is the street name preferred locally. It typically applies only to a specific range of addresses on the street.

Abbreviated—An abbreviated alias is a variation of the street name that can be used in cases where the length of AddressLine1 is longer than 31 characters. For example, the street name 1234 BERKSHIRE VALLEY RD APT 312A could be abbreviated to 1234 BERKSHIRE VLLY RD APT 312A.

Changed—There has been an official street name change and the alias reflects the new name. For example if SHINGLE BROOK RD is changed to CANNING DR, then CANNING DR would be a changed alias type.

Other—The street alias is made up of other names for the street or common abbreviations of the street.

The non-alias version of the street name is called the base street name.

If the preferred alias is used in the input then the preferred alias will be the street name in the output regardless of whether you enable this option.

This is one of three options that control how ValidateAddress handles street name aliases. The other two are OutputStreetNameAlias and OutputAbbreviatedAlias.

In most cases, if you select both OutputPreferredAlias and OutputAbbreviatedAlias, and ValidateAddress finds both a preferred and an abbreviated alias in the postal database, the abbreviated alias will be used in the output. The exception to this rule is if the input street name is a preferred alias. In this case, the preferred alias will be used in the output.

Y

Yes, perform preferred alias processing.

N

Specifies whether to use a street's abbreviated alias in the output if the output address line is longer than 31 characters.

Y

Yes, perform abbreviated alias processing.

N

No, do not perform abbreviated alias processing. Default.

N

No, do not determine "no stat" status. Default.

Y

Determines if the location has been unoccupied for at least 90 days.

N

No, do not determine vacancy. Default.

Y

Specifies whether to supress addresses with Carrier Route R777. These addresses are phantom routes and are not eligible for street delivery. Since these addresses are assigned a ZIP + 4® code by the USPS®, Validate Address marks these addresses as deliverable. Select this option if you do not want addresses with Carrier Route R777 marked as deliverable. This will cause the following actions:

No ZIP + 4 code is assigned

Address is not counted on the USPS Form 3553 (CASS Summary Report)

DPV Footnote of R7 is returned

N

No, do not suppress addresses with Carrier Route R777 (Default).

Y

Yes, suppress addresses with Carrier Route R777.

Specifies the algorithm to use when determining if an input address matches an address in the postal database. One of the following:

E

The input street name must match the database exactly.

T

The matching algorithm is "tight."

M

The matching algorithm is "medium" (default).

L

The matching algorithm is "loose."

Specifies the algorithm to use when determining if an input address matches an address in the postal database. One of the following:

E

The input firm name must match the database exactly.

T

The matching algorithm is "tight."

M

The matching algorithm is "medium" (default).

L

The matching algorithm is "loose."

Specifies the algorithm to use when determining if an input address matches an address in the postal database. One of the following:

E

The input directionals, such as the "N" in 123 N Main St., must match the database exactly.

T

The matching algorithm is "tight."

M

The matching algorithm is "medium". Default.

L

The matching algorithm is "loose."

Select the match condition where a DPV result does NOT cause a record to fail.

F

Full match

P

Partial match

A

Always. Default.

Treat Commercial Mail Receiving Agency (CMRA) matches as failures?

N

No, do not treat CMRA matches as failures. Default.

Y

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 StandardAddressFormat to either C or D.

2

Place the PMB information in AddressLine2.

Z (ZIP+4 Last Line)

Returns the Preferred Last Line City Name from the USPS ZIP+4 File (Override City Name).

C (USPS City/State)

Returns the USPS-preferred City Name from USPS City/State File.

P (Primary)

Returns the Primary City Name from the USPS City/State File.