Address Validation Options - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum OnDemand
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Geocoding > Enterprise Tax
Spectrum > Spatial > Spectrum Spatial
Enterprise Geocoding
Spectrum > Dataflow Designer
Spectrum > Discovery
Spectrum > Quality > Addressing
Spectrum > Web Services
Spectrum > Spectrum Platform
Spectrum > Quality > Context Graph
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-06-03
ft:lastPublication
2024-06-03T16:02:19.077100

These parameters control the AssignGeoTaxInfoPlus address validation process.

Parameter

Description

Option.DirectionalMatchingStrictness

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

Option.DPVSuccessfulStatusCondition

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

F
Full match
P
Partial match
A
Always. Default.
Note: You must enable DPV processing to use this option.

Option.DualAddressLogic

Indicates how to return a match if multiple non-blank address lines are present or multiple address types are on the same address line. (U.S. addresses only.)

N
(Default) USPS®CASS™ regulations determine the address returned based on the following order of priority:
  1. PO Box
  2. Firm
  3. Highrise
  4. Street
  5. Rural Route
  6. General Delivery
S
Return a street match, regardless of the address line.
P
Return a PO Box match, regardless of the address line.

For more information, see About Dual Address Logic.

Option.FailOnCMRAMatch

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

N
No, do not treat CMRA matches as failures. Default.
Y
Yes, treat CMRA matches as failures.
Note: You must enable DPV processing to use this option.

Option.FirmMatchingStrictness

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

Option.OutputFieldLevelReturnCodes

Specifies whether to include field-level result indicators. Field-level result indicators describe how each address element was handled. Field-level result indicators are returned in the qualifier "Result". For example, the field-level result indicator for HouseNumber is contained in HouseNumber.Result. For a complete listing of result indicator output fields, see Field-Level Result Indicators.

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

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.

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.

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.

N
No, do not perform enhanced street matching.
Y
Yes, perform enhanced street matching. Default.

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:

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

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.

N
No, do not attempt LACSLink conversion. Default.
Y
Yes, attempt LACSLink conversion.

For a listing of the output fields returned by this option, see LACSLink Output

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.

N
No, do not perform Line of Travel Processing. Default.
Y
Yes, perform Line of Travel processing.

For a listing of the output fields returned by this option, see Enhanced Line of Travel Output.

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.

N
No, do not perform Residential Delivery Indicator processing. Default.
Y
Yes, perform Residential Delivery Indicator processing.

Option.StreetMatchingStrictness

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