Option Name optionName Parameter |
Description |
---|---|
Enable Canadian address processing PerformCanadianProcessing Option.PerformCanadianProcessing |
Specifies whether to process Canadian addresses. If you enable Canadian address processing Validate MailingAddressUSCAN will attempt to validate Canadian addresses. If you disable Canadian address processing, Canadian addresses will fail, meaning they is returned with an "F" in the Status output field. The output field Status.Code will say "DisabledCoder." If you are not licensed for Canadian address processing you must disable Canadian address processing in order for your jobs to complete successfully, regardless of whether or not they contain Canadian addresses. Note: You must have a valid license for Canadian address processing
to successfully process Canadian addresses. If you enable
Canadian address processing but are not licensed for this
feature, or your license has expired, your
entire job will fail you will receive an
error.
|
Database Database.Canada Option.Database.Canada |
Specifies which database you want to use for validating Canadian addresses. To specify a database for Canadian address validation, select a database in the Database drop-down list. Only databases that have been defined in the CAN Database Resources panel in the Management Console are available. |
Determine language using CanFrenchFormat Option.CanFrenchFormat |
Specifies how to determine the language (English or French) to use to format the address and directional. The following example shows an address formatted in English and French: English: 123 Main St W The parameter controls the formatting of the address. It also affects the spelling of the directional but not spelling of the suffix.
|
Default English apt label CanEnglishApartmentLabel Option.CanEnglishApartmentLabel |
For English addresses, specifies the default apartment label to use in the output if there is no apartment label in the input address. This setting is ignored if you specify CanStandardAddressFormat=F. This setting is ignored if you specify Option.CanStandardAddressFormat=F. This setting is ignored if you select Number in front in the Secondary address format field.
|
Default French apt label CanFrenchApartmentLabel Option.CanFrenchApartmentLabel |
For French addresses, specifies the default apartment label to use in the output if there is no apartment label in the input address. This setting is ignored if you specify CanStandardAddressFormat=F. This setting is ignored if you specify Option.CanStandardAddressFormat=F. This setting is ignored if you select Number in front in the Secondary address format field.
|
Force Correction for LVR/Single-Single CPC data record ForceCorrectionLVR Option.ForceCorrectionLVR |
Changes the civic and/or suite information to match the Large Volume Receiver (LVR) or single-single record (used when there is only one record for that postal code/street name/street type).
|
Prefer house number on postal code conflict CanPreferHouseNum Option.CanPreferHouseNum |
In cases where the house number and postal code are both valid but in conflict, you can force the postal code to be corrected based on the house number by specifying CanPreferHouseNum=Y. In cases where the house number and postal code are both valid but in conflict, you can force the postal code to be corrected based on the house number by specifying Option.CanPreferHouseNum=Y. In cases where the house number and postal code are both valid but in conflict, you can force the postal code to be corrected based on the house number by selecting Prefer house number on postal code conflict. If you do not select this option the house number is changed to match the postal code.
|
Return city alias CanOutputCityAlias Option.CanOutputCityAlias |
Specifies whether or not to return the city alias when the alias is in the input address. This option is disabled when you specify CanOutputCityFormat=D. This option is disabled when you specify Option.CanOutputCityFormat=D. This option is disabled when you select Use default option in the City format field.
|
Abbreviate non-civic keywords CanNonCivicFormat Option.CanNonCivicFormat |
Specifies whether or not non-civic keywords are abbreviated in the output. For example, Post Office Box vs. PO Box.
|
Enable SERP settings EnableSERP Option.EnableSERP |
Specifies whether or not to use SERP options.
|
Secondary address format CanStandardAddressFormat Option.CanStandardAddressFormat |
Specifies where to place secondary address information in the output address. Secondary address information refers to apartment numbers, suite numbers, and similar designators.
|
City format CanOutputCityFormat Option.CanOutputCityFormat |
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
|
Place rural route into in CanRuralRouteFormat Option.CanRuralRouteFormat |
Specifies where to place rural route delivery information. An example of an address with rural route delivery information is: 36 GRANT RD RR 3 In this address, "RR 3" is the rural route delivery information.
|
Place delivery office info in CanDeliveryOfficeFormat Option.CanDeliveryOfficeFormat |
Specifies where to place station information. An example of an address with station information is: PO BOX 8625 STN A
|
Dual address logic CanDualAddressLogic Option.CanDualAddressLogic |
Specifies whether Validate MailingAddressUSCAN should return a street match or a PO Box/non-civic match when the address contains both civic and non-civic information. One of the following:
For example, given the following input address: AddressLine1: 36 GRANT RD Validate MailingAddressUSCAN would return one of the following:
The address data that is not used to standardize the address is returned in the AdditionalInputData field. For more information, see Output Data Options. |
Switch default valid postal code confidence canSwitchManagedPostalCodeConfidence Option.canSwitchManagedPostalCodeConfidence |
The valid values for this parameter are Y and N. The default value is N. Send the value Y to lower the output Confidence score of the record. This is useful for the non-correctable (VN) records. You can identify such records by the DefaultValidPostalCode value. The value is Y for VN type of records and blank for others. |