Option Name optionName Parameter |
Description |
---|---|
Enable U.S. address processing PerformUSProcessing Option.PerformUSProcessing |
Specifies whether to process U.S. addresses. If you enable U.S. address processing Validate MailingAddressUSCAN 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. Note: You must have a valid license for U.S. address
processing to successfully process U.S. addresses. If you enable
U.S. address processing but are not licensed for this feature,
or your license has expired, you will receive an error.
Note: You must have a valid license for U.S.
address processing to successfully process U.S. addresses. If
you enable U.S. address processing but are not licensed for this
feature, or your license has expired, your entire job will
fail.
|
Database Database.US Option.Database.US |
Specifies which database to use for validating U.S. addresses. Only databases that have been defined in the US Database Resources panel in the Management Console are available. |
Line of travel PerformLOT Option.PerformLOT |
Enhanced Line of Travel (eLOT) processing assigns a Line of Travel sequence code to your addresses. Note that addresses are not sorted into eLOT sequence but they are assigned a Line of Travel sequence code that allows you to sort addresses into eLOT sequence. To perform eLOT processing you must have the eLOT database installed.
For a listing of the output fields returned by this option, see Enhanced Line of Travel Output. |
Residential Delivery Indicator processing PerformRDI Option.PerformRDI |
Residential Delivery Indicator (RDI™) processing checks if an address is a residential address (not a business address). To perform RDI™ processing, you must have the RDI™ database installed. If you enable both DPV® and RDI™ processing, RDI™ information is only returned if the address is a valid delivery point. If DPV® does not validate the address no RDI™ data is returned.
|
Enhanced street matching PerformESM Option.PerformESM |
Enhanced Street Matching (ESM) applies additional matching logic to correct misspelled or complex street names and obtain a match. ESM enables more addresses to be validated but it reduces performance. You cannot perform ESM when ASM is enabled.
|
All street matching PerformASM Option.PerformASM |
All Street Matching (ASM) applies ESM processing as well as additional matching logic to correct errors in street names and obtain a match. It is effective at matching streets when the first letter of the street is incorrect. ASM provides the best address validation but reduces performance.
|
Delivery Point Validation & CMRA PerformDPV Option.PerformDPV |
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.
For a listing of the output fields returned by this option, see DPV and CMRA Output. |
LACS/Link conversion PerformLACSLink Option.PerformLACSLink |
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.
For a listing of the output fields returned by this option, see LACSLink Output |
Early Warning System PerformEWS Option.PerformEWS |
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:
|
Firm name extraction ExtractFirm 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.
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:
Here are some examples of firm name extraction:
|
U.S. urbanization name extraction ExtractUrb 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.
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 |
Suite/Link support PerformSuiteLink Option.PerformSuiteLink |
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 In this case, SuiteLink processing would provide the correct suite number:
Firm Name: Precisely
To perform SuiteLink™ processing, you must have the SuiteLink™ database installed. This option takes one of the following values:
For a listing of fields returned by this option, see SuiteLink Output. |
Preferred alias street name processing OutputPreferredAlias Option.OutputPreferredAlias |
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:
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 Validate MailingAddressUSCAN handles street name aliases. The other two are OutputStreetNameAlias and OutputAbbreviatedAlias. The other two are Option.OutputStreetNameAlias and Option.OutputAbbreviatedAlias. The other two are Return street name alias and Abbreviated street name alias processing. In most cases, if you select both OutputPreferredAlias and OutputAbbreviatedAlias, and Validate MailingAddressUSCAN finds both a preferred and an abbreviated alias in the postal database, the abbreviated alias will be used in the output. In most cases, if you select both Option.OutputPreferredAlias and Option.OutputAbbreviatedAlias, and Validate MailingAddressUSCAN finds both a preferred and an abbreviated alias in the postal database, the abbreviated alias will be used in the output. In most cases, if you select both Preferred street name alias processing and Abbreviated street name alias processing, and Validate Address 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.
Note: If the input address contains a street name alias of type "changed" the output address will always contain the base street name regardless of the options you specify.
|
Abbreviated alias street name processing OutputAbbreviatedAlias Option.OutputAbbreviatedAlias |
Specifies whether to use a street's abbreviated alias in the output if the output address line is longer than 31 characters. This is one of three options that control how Validate MailingAddressUSCAN handles street name aliases. The other two are OutputStreetNameAlias and OutputPreferredAlias. The other two are Option.OutputStreetNameAlias and Option.OutputPreferredAlias. The other two are Return street name alias and Preferred street name alias processing. Note: If a preferred alias is specified in the input, the output street name will always be the preferred alias, even if you enable abbreviated street name alias processing.
Note: If the input address contains a street name alias of type "changed" the output address will always contain the base street name regardless of the options you specify.
|
Determine if delivery point is active DPVDetermineNoStat Option.DPVDetermineNoStat |
Determines the "no stat" status of an address. An address is considered "no stat" if it exists but cannot receive mail, and therefore is not counted as a delivery statistic on a carrier's route (hence the term "no stat"). Examples include buildings under construction or those that the letter carrier has identified as not likely to receive mail.
Note: You must enable DPV processing to use this option.
The result is returned in the DPVNoStat field. For more information see LACSLink Output |
Determine if address is vacant DPVDetermineVacancy Option.DPVDetermineVacancy |
Determines if the location has been unoccupied for at least 90 days.
Note: You must enable DPV processing to use this option.
The result is returned in the DPVVacant field. For more information see LACSLink Output |
Return VeriMove detail data ReturnVerimove Option.ReturnVerimove |
Returns VeriMove detail data in output.
|
Suppress zip+4 carrier route R777 SuppressZplusPhantomCarrierR777 Option.SuppressZplusPhantomCarrierR777 |
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:
|
Street matching StreetMatchingStrictness Option.StreetMatchingStrictness |
Specifies the algorithm to use when determining if an input address matches an address in the postal database. One of the following:
|
Firm matching FirmMatchingStrictness Option.FirmMatchingStrictness |
Specifies the algorithm to use when determining if an input address matches an address in the postal database. One of the following:
|
Directional matching DirectionalMatchingStrictness Option.DirectionalMatchingStrictness |
Specifies the algorithm to use when determining if an input address matches an address in the postal database. One of the following:
|
DPV Success Condition DPVSuccessfulStatusCondition Option.DPVSuccessfulStatusCondition |
Select the match condition where a DPV result does NOT cause a record to fail.
Note: You must enable DPV processing to use this option.
|
Fail on CMRA match FailOnCMRAMatch Option.FailOnCMRAMatch |
Treat Commercial Mail Receiving Agency (CMRA) matches as failures?
Note: You must enable DPV processing to use this option.
|
Place PMB elements in StandardAddressPMBLine Option.StandardAddressPMBLine |
Specifies where Private Mailbox (PMB) information is placed.
|
Preferred City OutputPreferredCity Option.OutputPreferredCity |
Specifies whether the preferred last line city name should be stored.
|
AddressLineSearchOnFail Option.AddressLineSearchOnFail |
This option enables ValidateMailingAddressUSCAN to search the AddressLine input fields for the city, state/province, postal code, and country when the address cannot be matched using the values in the City, StateProvince, and PostalCode input fields. Consider enabling this option if your input addresses have the city, state/province, and postal code information in the AddressLine fields. Consider disabling this option if your input addresses use the City, State/Province and PostalCode fields. If you enable this option and these fields are used, there is an increased possibility that ValidateMailingAddressUSCAN will fail to correct values in these fields (for example, a misspelled city name).
|