Canadian Address Options

Parameter	Description
Option.PerformCanadianProcessing	Specifies whether to process Canadian addresses. If you enable Canadian address processing ValidateMailingAddressUSCAN 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, you will receive an error. N No, do not process Canadian addresses. Y Yes, process Canadian addresses (default).
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 dropdown list. Only databases that have been defined in the CAN Database Resources panel in the Management Console are available.
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 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. D Use the CanLanguage input field to format the output address like the input whenever possible to preserve the original format (default). T Use the Formatted in French order field to determine the language. If there is a non-blank value in this field the address are formatted using French.
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 Option.CanStandardAddressFormat=F. 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.
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 Option.CanStandardAddressFormat=F. 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.
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). 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. Note: If you check this box, the Statement of Address Accuracy will not be printed because this is not a SERP-recognized setting.
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 Option.CanPreferHouseNum=Y. If you do not select this option the house number is changed to match the postal code. N Change the house number to match the postal code. Default. Y Change the postal code to match the house number.
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 Option.CanOutputCityFormat=D. 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.
Option.CanNonCivicFormat	Specifies whether or not non-civic keywords are abbreviated in the output. For example, Post Office Box vs. PO Box. A Abbreviate non-civic keywords. Default. F Do not abbreviate non-civic keywords. The full keyword is used.
Option.EnableSERP	Specifies whether or not to use SERP options. Y Enable SERP options. N Do not enable SERP options. Default.
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. D Place apartment information in the location specified in the Default. B Place apartment information at the at the end of the AddressLine1 field. I Place apartment information in the same location as the input address. 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. S Place apartment information in the same location as the input address.
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 Medium: BUFFALO-HEAD-PR Short: BUFFALO-HD-PR D Use the default option specified by the Option.OutputShortCityName parameter. Default. If you specify Option.OutputShortCityName=V, the city is formatted as if you select for this option (see below) and`Y` 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.
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 ANTIGONISH NS In this address, "RR 3" is the rural route delivery information. A Place rural route delivery information on the same line as the address, after the address information. Default. For example, 36 GRANT RD RR 3 S Place rural route delivery information on a separate address line. For example, 36 GRANT RD RR 3
Option.CanDeliveryOfficeFormat	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 8625 STN A
Option.CanDualAddressLogic	Specifies whether ValidateMailingAddressUSCAN 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: 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 ValidateMailingAddressUSCAN would return one of the following: If Option.CanDualAddressLogic is set to S, ValidateMailingAddressUSCAN returns the following: AddressLine1: 36 GRANT RD AddressLine2: RR 3 City: ANTIGONISH StateProvince: NS PostalCode: B2G 2L1 If Option.CanDualAddressLogic is set to P, ValidateMailingAddressUSCAN returns the following: AddressLine1: RR 4 City: ANTIGONISH StateProvince: NS PostalCode: B2G 2L2 The address data that is not used to standardize the address is returned in the AdditionalInputData field. For more information, see Output Data Options.
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.

Option.PerformCanadianProcessing

Specifies whether to process Canadian addresses. If you enable Canadian address processing ValidateMailingAddressUSCAN 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, you will receive an error.

N: No, do not process Canadian addresses.
Y: Yes, process Canadian addresses (default).

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 dropdown list. Only databases that have been defined in the CAN Database Resources panel in the Management Console are available.

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
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.
D: Use the CanLanguage input field to format the output address like the input whenever possible to preserve the original format (default).
T: Use the Formatted in French order field to determine the language. If there is a non-blank value in this field the address are formatted using French.

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 Option.CanStandardAddressFormat=F.

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.

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 Option.CanStandardAddressFormat=F.

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.

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

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.
Note: If you check this box, the Statement of Address Accuracy will not be printed because this is not a SERP-recognized setting.

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 Option.CanPreferHouseNum=Y. If you do not select this option the house number is changed to match the postal code.

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

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 Option.CanOutputCityFormat=D.

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.

Option.CanNonCivicFormat

Specifies whether or not non-civic keywords are abbreviated in the output. For example, Post Office Box vs. PO Box.

A: Abbreviate non-civic keywords. Default.
F: Do not abbreviate non-civic keywords. The full keyword is used.

Option.EnableSERP

Specifies whether or not to use SERP options.

Y: Enable SERP options.
N: Do not enable SERP options. Default.

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.

D: Place apartment information in the location specified in the Default.
B: Place apartment information at the at the end of the AddressLine1 field.
I: Place apartment information in the same location as the input address.
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.
S: Place apartment information in the same location as the input address.

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
Medium: BUFFALO-HEAD-PR
Short: BUFFALO-HD-PR

D: Use the default option specified by the Option.OutputShortCityName parameter. Default. If you specify Option.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.

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
ANTIGONISH NS

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

A: Place rural route delivery information on the same line as the address, after the address information. Default. For example,
36 GRANT RD RR 3
S: Place rural route delivery information on a separate address line. For example,
36 GRANT RD
RR 3

Option.CanDeliveryOfficeFormat

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 8625
STN A

Option.CanDualAddressLogic

Specifies whether ValidateMailingAddressUSCAN 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:

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

ValidateMailingAddressUSCAN would return one of the following:

If Option.CanDualAddressLogic is set to S, ValidateMailingAddressUSCAN returns the following:
AddressLine1: 36 GRANT RD
AddressLine2: RR 3
City: ANTIGONISH
StateProvince: NS
PostalCode: B2G 2L1
If Option.CanDualAddressLogic is set to P, ValidateMailingAddressUSCAN returns the following:
AddressLine1: RR 4
City: ANTIGONISH
StateProvince: NS
PostalCode: B2G 2L2

The address data that is not used to standardize the address is returned in the AdditionalInputData field. For more information, see Output Data Options.

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.