Options - web_services - 23.1

Spectrum Web Services Guide

Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413

Global Address Validation uses the default options settings to define address validation processing.

Table 1. Global Addressing Options
Option Name Country Support Description
Global Addressing Options All except USA The options specific to global address processing.
City fallback All When a street level match cannot be made, use the input city to determine match candidates.
Custom match fields All These options set custom match criteria for determining match candidates. To enable these options, you must set the Match Mode to Custom. By default, these options are disabled.
Address number
A match must be made to the input address number.
Street
A match must be made to the input street name, type, and directional fields.
City
A match must be made to the input address city.
City subdivision
A match must be made to the input address city subdivision.
State/province
A match must be made to the input address state or province.
State/province subdivision
A match must be made to the input address state or province subdivision.
Postal code
A match must be made to the input address postal code.
Database All The database to use for address processing. Only databases that have been defined in the Database Resources panel in the Management Console are available.
Default country All The default country for address processing.
To improve coding performance when your input addresses do not contain country information, set up an additional instance of the Global Address Validation stage as a preliminary stage to process and retrieve the country code for the input addresses.
  1. Set up an additional instance of the Global Address Validation stage as a preliminary (first) stage in your dataflow.

    Give the preliminary stage a unique label. For example, "Identify Country".

    Specify "World" as the default country for the preliminary stage.

    The preliminary stage uses the available input address elements with additional data sources (available when you select "World" as the default country) to determine the country code. The "country-coded" output from the preliminary stage becomes the input for the next step in the dataflow.

  2. As the next step in the dataflow, the addresses are sent through a second Global Address Validation stage with the proper country code (retrieved in the preliminary stage) to validate the address to the street/house/premise level.
Match mode All Match modes determine the leniency used to make a match between the input address and the reference data. Select one of the following match modes based on the quality of your input and your desired output.
Exact
A very tight match. This restrictive mode generates the fewest match candidates. When using this mode, ensure that your input is very clean; free of misspellings and incomplete addresses.
Relaxed
A loose match. This mode generates the most match candidates and results in more multiple matches. Use this mode if you are not confident that your input is clean and free of misspellings and incomplete addresses.
Custom
A custom match. Allows you to define the matching criteria by selecting Custom Match Fields.
Postal fallback All When a street level match cannot be made, use the input postal code to determine match candidates.
Prefer PO Box over street

CAN

FRA

GBR

Prefer candidates matching the input PO Box over matches to the input street. The default is disabled.
Prefer postal code over city AUS Prefer candidates matching the input postal code over matches to the input city. The default is disabled.

Table 2. US Addressing Options
Option Name Description
US Addressing Options The options specific to U.S. address processing.
Address Mailer's address. This information displays in section D box 3 on the USPS Form 3553 (CASS Summary Report).
Address2 Additional address line for Mailer's address displays in section D box 3 on the USPS Form 3553 (CASS Summary Report).
Address3 Additional address line for Mailer's address displays in section D box 3 on the USPS Form 3553 (CASS Summary Report).
Address4 Additional address line for Mailer's address displays in section D box 3 on the USPS Form 3553 (CASS Summary Report).
All street matching Perform All Street Matching (ASM) processing. ASM applies additional matching logic to correct errors in street names to find a match. For example, when the first letter of a street is misspelled or missing on input, ASM searches all street names in a locality to find an input address. ASM provides the best address validation but may reduce performance. ASM processing is available for U.S. addresses only.
Assign abbreviated city Return abbreviated city names in the label lines.
Assign enhanced Line of Travel codes Assign enhanced Line of Travel (eLOT) codes. The default is disabled.
CASS flag Process in a United States Postal Service (USPS) CASS-certified mode.
Note: If you are performing Global Address Validation US Addressing processing outside of the physical United States, you must disable the Delivery Point Validation (DPV), LACSLink, SuiteLink, and Residential Delivery Indicator (RDI) options. You will not be able to run in a USPS CASS-certified mode.
CASS Mailer Information The Mailer's name and address that displays on the USPS Form 3553 (CASS Summary Report). This information is required if you are running DPV and optional if you are not running DPV.
City line The Mailer's city, state, and ZIP Code information displays in section D box 3 on the USPS Form 3553 (CASS Summary Report).
Commercial Mail Receiving Agency (CMRA) Perform Commercial Mail Receiving Agency (CMRA) processing. A private company offering mailbox rental services to individuals and businesses is a Commercial Mail Receiving Agency (CMRA). The default is disabled.
Convert secondary to PMB Convert secondary information to Private Mail Box (PMB) under the following conditions:
  • A secondary number is present in the returned ZIP + 4 address.
  • The secondary number does not DPV confirm.
  • The primary number (and/or other secondary number) confirms as a Commercial Mail Receiving Agency (CMRA).
  • The unconfirmed unit designator is not a pound sign (#).
    Note: This processing only applies if the primary address codes to a CMRA.
Delivery Point Validation Perform Delivery Point Validation (DPV) processing. USPS CASS regulations require DPV processing. If you do not perform DPV processing, Global Address Validation does not generate a USPS Form 3553 (CASS Summary Report). The default is disabled.
Note: When DPV is disabled, all DPV options are also disabled and display in a grayed out mode.
Note: If you are performing Global Address Validation US Addressing processing outside of the physical United States, you must disable the Delivery Point Validation (DPV) option. You will not be able to run in a USPS CASS-certified mode.
Do not concatenate dangling lines Check Do not concatenate dangling linesif you do not want to concatenate one-word lines to address lines.
Do not concatenate lines beginning with # Check Do not concatenate lines beginning with # if you do not want to concatenate lines beginning with a # to existing address lines.
Do not identify CitySubdivision Check Do not identify CitySubdivisionif you do not want to perform Urbanization name (Puerto Rico) processing.
Do not identify FirmName Check Do not identify FirmNameif you do not want to perform firm name processing.
Do not identify LastLine Check Do not identify LastLineif you do not want to perform last line (City, State, or ZIP Code) processing.
Do not merge secondary or PMB Check Do not merge secondary or PMBif you do not want to merge a separated second unit and PMB information.
Do not recognize periods (.) as valid characters Check Do not recognize periods (.) as valid charactersif you do not want to recognize periods as valid characters (periods should be removed before scanning address lines).
Door Not Accessible Perform DPV Door Not Accessible (DNA) processing. Use the DNA Table to identify delivery addresses where carriers cannot knock on the door for mail delivery or where carriers cannot physically access a residence/building such as rural/highway contract route (HCR), long driveway, or gated community. Return the proper DNA code to the output. The default is disabled.
Dual address If the input file contains dual addresses (one a conventional address, a second containing a PO Box address), this field determines the order to use to process and match the addresses. If the selected address is valid, processing stops. If the selected address does not validate, processing attempts to code the secondary address.
  • Above city and ZIP Code. The address line closest to the last line in the address is given the highest priority in the match process. Any address line above the last line is not used for matching. Default.
  • Line 1 is given preference. The first line in the dual address is given the highest priority in the match process.
  • Line 2 is given preference. The second line in the dual address is given the highest priority in the match process.
  • Conventional is given preference. The conventional address is given the highest priority in the match process.
  • PO Box is given preference. The PO Box is given the highest priority in the match process.
  • The first valid address is given preference. The first valid address (in the order Address line 1 and then Address line 2) is given the highest priority in the match process.
    Note: When dual addresses are contained on a single line and the CASS flag is enabled, the USPS address type priority is used in the following order:
    1. PO Box
    2. Firm
    3. Highrise
    4. Street
    5. Rural Route
    6. General Delivery
Early Warning System Perform Early Warning System (EWS) processing. Perform Early Warning System (EWS) processing. New address information that is in use, but not yet available on the ZIP + 4 File, can be found as part of the USPS Early Warning System (EWS). The USPS requires all CASS-certified software to verify addresses that are not found in the current ZIP + 4 File against the USPS EWS File. If an address is found in the EWS File, the address is not matched to any similar addresses in the current ZIP + 4 File. Instead, the input address fails and is not coded until the ZIP + 4 File is updated with the correct address from the USPS EWS File. The default is disabled.
LACSLink Perform LACSLink (Locatable Address Conversion System) processing. USPS CASS regulations require LACSLink processing. If you do not perform LACSLink processing, Global Address Validation does not generate a USPS Form 3553 (CASS Summary Report). The default is disabled.
Note: If you are performing Global Address Validation US Addressing processing outside of the physical United States, you must disable the LACSLink option. You will not be able to run in a USPS CASS-certified mode.
Log level The level of the messages to log.
  • No messages.
  • Critical messages
  • Error messages
  • Warning messages
  • Info messages
  • Debug messages
Multiple Address Line Processing The options specific to multiple address line processing. To specify the format of your returned lines address, select three options (one for each returned line and a special option).
Name The Mailer's name displays in section D box 3 on the USPS Form 3553 (CASS Summary Report).
No-Stat Perform DPV No-Stat processing. Use the No-Stat table to identify deliveries that are not valid for Computerized Delivery Sequence (CDS) pre-processing. Return the proper No-Stat code to the output. The default is disabled.
No Secure Location Perform DPV No Secure Location (NSL) processing. Use the NSL table to identify delivery locations that are not secure. For example, a carrier can access a door but cannot leave a package due to security concerns. The NSL designation alerts mailers to locations where businesses are closed on certain days and locations without mail receptacles (for example, a storefront). Return the NSL result to the output. The default is disabled.
PO Box as street address Perform DPV P.O. Box Street Address (PBSA) processing. A PBSA address is a street address that represents a USPS P.O. Box. Use the PBSA table to identify PBSA addresses. Return the PBSA result to the output. The default is disabled.
Processing Mode Defines the intended processing mode.
  • Specify a value of I for Interactive mode. This implies random, single record input. No performance caching will be turned on.
  • Specify the default value of B for Batch mode. An internal cache will be turned on allowing improved performance. Best performance in batch mode is achieved when the input is in PostalCode (ZIP Code) sequence.

This option is only available during with the Web Services API.

R777 deliverable
Addresses with Carrier Route code R777 are phantom routes and are not eligible for street delivery. However, since these addresses are assigned a ZIP + 4 code by the USPS, these addresses are marked as deliverable. If you do not want the addresses with Carrier Route code R777 marked as deliverable, disable this option and the following actions are performed for the address:
  • ZIP + 4 code is not assigned.
  • The address is not counted on the USPS Form 3553 (CASS Summary Report)
  • DPV Footnote Code R7 is returned.
Remove noise characters Remove noise characters (for example, unnecessary punctuation and blanks).
Residential Delivery Indicator Perform Residential Delivery Indicator (RDI) processing. The default is disabled.
Note: If you are performing Global Address Validation US Addressing processing outside of the physical United States, you must disable the Residential Delivery Indicator (RDI) option. You will not be able to run in a USPS CASS-certified mode.
Return alias street Return alias street names in the label line. An alias street name is an alternate name for a street, maintained at the ranged ZIP + 4 Code level.
  • Return input alias or base. If the input address matches to an alias, return the alias. If the input address matches to a base address, but a preferred alias exists, return the preferred alias. If the input address matches to a base address and no Preferred alias exists, return the base address
  • Return preferred alias or base. If a preferred alias exists, return the preferred alias. Otherwise, return the base street.
  • Return preferred, abbreviated, input alias or base. Return the preferred alias. If no preferred alias exists, return the abbreviated alias. If no abbreviated or preferred alias exists, but some other alias type was input, return the input alias. If none of these scenarios apply, return the base street name.
  • Return preferred, abbreviated alias, or base. If a preferred alias exists, return the preferred alias. If no preferred alias exists, return the Abbreviated alias. If neither exists, return the base street name.
  • Return abbreviated, preferred, input alias or base. Return the abbreviated alias. If no abbreviated alias exists, return the preferred alias. If no abbreviated or preferred alias exists, but some other alias type was input, return the input alias. If no alias exists, return the base street name.
  • Return abbreviated, preferred, alias or base. Return the abbreviated alias. If no abbreviated alias exists, return the Preferred alias. If neither exists, return only the base street name
Return input firm Return the input firm.
Return Line 1 Specify the format for returned line 1.
  • Return the first valid line from the top.
  • Return the first firm line from top.
  • Return the first valid line above the city line.
  • Return the street address line above the city line.
  • Return the PO box or RR/HC line above the city line.
  • Return the best street or PO box line from top. If not found, the first firm or rural route line from top. When selecting this option for return line 1, processing selects from the top down in this order:
    1. First PO box line or complete address.
    2. First street line with a range but no suffix.
    3. First Street line with a suffix but no range.
    4. First rural route line.
    5. First firm type.
Return Line 2 Specify the format for returned line 2.
  • Return a blank line.
  • Return the first valid line from the top.
  • Return the second valid line from the top.
  • Return the first firm line from top.
  • Return the second half of the combined address line if the first half is returned in line 1.
  • Return the first valid line above the city line.
  • Return the second valid line above city line.
  • Return the street address line above the city line.
  • Return the PO box or RR/HC line above the city line.
  • Return the first valid line above city line. If that criteria is not met resulting in a blank second line, return the topmost line not used in return line 2.
Return Line Order Specify the order for returning the standardized lines.
  • 0Firm line.
  • 1PO Box address line.
  • 2Address line with both a range and a suffix word.
  • 3Address line with a range but no suffix, Address line with a suffix but no range.
  • 4Rural route address line.
  • 5Personal name, Firm name (w/o firm words), Unidentified.
  • 6Apartment type line.
  • 7Possible city line.
  • 8City line.
  • 9Ignore this line.
  • BBox address line following a rural route address line.
  • MMilitary address line.
  • NBest address line 1, best address line 2, city state, firm. URB and ZIP Code are returned in separate fields. The default is N.
  • RRural route address line preceding a box line.
Return SuiteLink secondary Indicate how to return secondary information when SuiteLink secondary information is available.
  • Both SuiteLink and input. Return both SuiteLink and input secondary information. Default.
  • SuiteLink only. Return SuiteLink secondary only. Do not return input secondary.
  • Input only. Return input secondary only. Do not return SuiteLink secondary.
  • None. Do not return SuiteLink secondary or input secondary.
Save PMB in separate field Do not merge separate second unit and PMB information. Save PMB in separate field.
Save unit in separate field Do not merge separate second unit and PMB information. Save unit in separate field.
Special Options Specify special options for returned lines.
  • Use all special options for returned lines.
  • Do not use any special options for returned lines.
  • Add a range of "0" to street lines without a range. For example, Main St becomes 0 Main St.
  • Separate combined address lines.
SuiteLink Perform SuiteLink processing. USPS CASS regulations require SuiteLink processing. If you do not perform SuiteLink processing, Global Address Validation does not generate a USPS Form 3553 (CASS Summary Report). The default is disabled.
Note: If you are performing Global Address Validation US Addressing processing outside of the physical United States, you must disable the SuiteLink option. You will not be able to run in a USPS CASS-certified mode.
Throwback Perform DPV P.O. Box Throwback processing. Use the P.O. Box Throwback Table to identify a delivery point that is a street address where mail is not delivered. Instead, delivery is made to the customer’s P.O. Box address. Return the P.O. Box Throwback result to the output. The default is disabled.
Tie Break The USPS allows DPV processing to be used as a tie breaker for matching inexact street records. If only one of the records in a tie is delivery point validated, a match is allowed to the inexact record. When processing results in an inexact match due to the input address directional, DPV processing can be used as a tie breaker if only one of the records is found to be delivery point validated and the delivery point validated record does not violate the cardinal direction rule. The default is enabled.

USPS CASS regulations require DPV Tie Break processing to generate the USPS Form 3553 (USPS CASS Summary Report).

Vacant Perform DPV Vacant Table processing. Use the Vacant Table to identify delivery addresses that have been active in the past but, according to USPS data, have not been occupied within the last 90 days. Return the proper Vacant code to the output. The default is disabled.
Table 3. Output Options
Option Name Description
Output Options The elements to be returned by Global Address Validation processing.
Casing The format for the returned address:
Mixed
The output data is returned in a mixed case format. For example, 100 Main Street.
Lower
The output data is returned in an all lower case format. For example, 100 main street.
Upper
The output data is returned in an all upper case format. For example, 100 MAIN STREET. The default is Upper.
Country specific fields Return country-specific output information.
Global Addressing Options The output options specific to global address processing.
Input address Return the original input address.
Maximum records to return The number of match candidates to return. Using a looser Match Mode setting such as "Relaxed" can result in the matching output including multiple match candidates. The specified number of match candidates are presented to the user to select the desired match candidate. If an exact match is found, the single match candidate is returned.
Parsed address The parsed address elements (for example, Address Line 1, postal codes, and country). The meaning of some of these fields may vary by country. Do not select Parsed address when returning G/Z level matches.
Precision Return a code describing the precision of the address match.