United States (USA) Country Specific Fields - 23.1

Spectrum Dataflow Designer Guide

Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Dataflow Designer Guide
First publish date
2007
Last updated
2024-05-09
Published on
2024-05-09T23:01:03.226155

All fields are String format.

Field Name Description
USA.AbbreviatedCityName The abbreviated city name.
USA.AddressLocation The location where the address information was found.
  • 01— Input address found on address line 1.
  • 02— Input address found on address line 2.
  • 03— Input address found on address lines 1 and 3.
  • 04— Firm found on input address line 1. No address line found.
  • 06— Input address found on address line 2. Firm found on address line 1.
  • 08— Firm found on input address line 2. No address line found.
  • 09— Input address found on address line 1. Firm found on address line 2.
  • 80— Address line not found.
USA.AdvancedBarcode The returned 14-digit barcode consisting of the beginning frame character, ZIP Code, ZIP + 4, delivery point, check digit, and end framing character.
USA.AltStreet The returned alternate street name.
USA.AltStreetType The returned alternate street name type.
  • B— Base street.
  • A— Alias (other).
  • D— Alternate street.
  • P— Preferred alias.
  • X— Abbreviated alias.
USA.Apartment1 The first apartment (unit) field in the address. This field is used for output. This field will only be populated if the Save unit in separate field is selected. If selected, the data is not included on the AddressLineX field(s).
USA.Apartment2 The second apartment (unit) field in the address. This field is used for output. This field will only be populated if the Save unit in separate field is selected. If selected, the data is not included on the AddressLineX field(s).
USA.BCCheckDigit The valid one-digit modulo check digit required for printing the correct barcode.
USA.CarrierRouteCode The returned carrier route code.
USA.CASSAddressLine1 For successfully-coded addresses, the output label line Address Line 1 contains the coded address line information.
USA.CASSAddressLine2 For successfully-coded addresses, the output label line Address Line 2 contains the city/state/ZIP Code information.
USA.CASSCityName The city name. The city name returned here is the city name mandated by USPS regulations. Variations of the city name (for example, full, abbreviated, and non-mailing) are returned in alternate fields.
USA.CongressionalDistrict The returned congressional district.
USA.DefaultMatch The returned default match.
  • Y— Carrier route, or ZIP + 4, or DPBC default values returned.
  • Blank— No default values returned.
USA.DPV The returned Delivery Point Validation (DPV) indicators.
  • N— The address is not a valid delivery point. The USPS cannot deliver mail to this address.
  • Y— The address is delivery point validated. Primary range and secondary range (when present) are valid. The USPS can deliver mail to this address.
  • S— This address contains a valid primary range. Secondary range is present but is not confirmed. The USPS can deliver mail to this address.
  • D— This address contains a valid primary range. Secondary range is missing. The USPS can deliver mail to this address.
USA.DPV.CMRA The returned Commercial Mail Receiving Agents (CMRA) indicators.
  • Y— The address is a valid CMRA.
  • N— The address is a confirmed delivery point but is not a valid CMRA.
  • Blank— This field is blank if the address is not a confirmed delivery point.
USA.DPV.DNA The DPV Door Not Accessible (DNA) Table status indicator. The DNA Table identifies 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 contact route (HCR), long driveway, or gated community.
  • Y— The address was found in the DPV DNA Table.
  • N— The address was not found in the DPV DNA Table.
  • Blank— The DPV DNA Table was not queried.
USA.DPV.FalsePositive The DPV False Positive Flag.
  • Y— The address is not a confirmed delivery point and a positive response was received from the False Positive File.
  • N— The address is not a confirmed delivery point and a negative response is received from the False Positive File. This field is blank if the address is a confirmed delivery point.
  • Blank— The False/Positive Table was not queried.
USA.DPV.Footnote The returned DPV footnote code.
  • A1— Input address did not match to the ZIP + 4 File.
  • AA— Input address matched to the ZIP + 4 File.
  • BB— Input address matched to DPV (all components).
  • CC— Input address primary number matched to DPV but secondary number did not match (present but invalid).
  • F1— Input address matched to a military ZIP Code.
  • G1— Input address matched to a General Delivery address.
  • M1— Input address primary number missing.
  • M3— Input address primary number is invalid.
  • N1— Input address primary number matched to DPV but address is missing secondary number.
  • P1— Input address missing PO Box, rural route, or highway contract number.
  • P3— Input address PO Box, rural route, or highway contract number invalid.
  • PB— Input address is a PO Box Street Address (PBSA).
  • R1— Input address matched to CMRA but secondary number is not present.
  • R7— Input address is a Carrier Route R777.
  • RR— Input address matched to CMRA.
  • U1— Input address matched to a unique ZIP Code.
USA.DPV.LeadingDirectional The parsed street predirectional for the record creating the False Positive (Seed) Table violation.
USA.DPV.MatchedZIP The parsed ZIP Code for the record creating the False Positive (Seed) Table violation.
USA.DPV.MatchedZIP4 The parsed Plus4 ZIP Code for the record creating the False Positive (Seed) Table violation.
USA.DPV.NoStat The DPV No-Stat Table status.
  • Y— The address was found in the DPV No-Stat Table.
  • N— The address was not found in the DPV No-Stat Table.
  • Blank— The DPV No-Stat Table was not queried.
USA.DPV.NSL The DPV No Secure Location (NSL) Table status.
  • Y— The address was found in the in the DPV NSL Table.
  • N— The address was not found in the DPV NSL Table.
  • Blank— The DPV NSL Table was not queried.
USA.DPV.PBSAFound The DPV PO Box Street Address (PBSA) Table status indicator.
  • Y— The address was found in the DPV PBSA Table.
  • N— The address was not found in the DPV PBSA Table.
  • Blank— The DPV PBSA Table was not queried.
USA.DPV.Range The parsed street primary range for the record creating the False Positive (Seed) Table violation.
USA.DPV.SeedHit The DPV False Positive (Seed) Table indicator.
  • Y— The address was found in the in the DPV False Positive (Seed) Table.
  • N— The address was not found in the DPV False Positive (Seed) Table.
USA.DPV.StreetName The street name for the address creating the False Positive (Seed) Table violation.
USA.DPV.Suffix The street suffix for the address creating the False Positive (Seed) Table violation.
USA.DPV.Throwback The DPV P.O. Box Throwback Table indicator.
  • Y— The address was found in the in the DPV P.O. Box Throwback Table.
  • N— The address was not found in the DPV P.O. Box Throwback Table.
  • Blank— The DPV P.O. Box Throwback Table was not queried.
USA.DPV.TrailingDirectional The street postdirectional for the address creating the False Positive (Seed) Table violation.
USA.DPV.UnitDesignator The unit designator for the address creating the False Positive (Seed) Table violation.
USA.DPV.UnitNumber The unit number for the record creating the False Positive (Seed) Table violation.
USA.DPV.Vacant The DPV Vacant Table indicator.
  • Y— The address was found in the DPV Vacant Table.
  • N— The address was not found in the DPV Vacant Table.
  • Blank— The DPV Vacant Table was not queried.
USA.DPV.ZIP4 The ZIP + 4 used for DPV processing.
USA.EWSFailure The address was not matched because the address was found in the USPS Early Warning System (EWS) File.
USA.FIPSCountyNumber The returned five-digit FIPS code. Positions 1 and 2 contain the state code. Positions 3 through 5 contain the county code. Used for output information only.
USA.FiveDigitBarcode The returned five-digit barcode.
USA.FiveDigitScheme The returned 5-digit combined ZIP Code.
USA.FullCityName The full city name.
USA.LACS The LACSLink status.
  • L— The address is eligible for LACSLink processing.
  • Blank— No LACSLink processing available.
USA.LACS.Indicator The one-byte CASS Stage file LACSLink Indicator value. If you are not performing a CASS Stage test, this field can be ignored. If you are performing a CASS Stage test, use the value in this field to populate the stage record.
  • Y— Record found in the LACSLink False Positive (Seed) Table.
  • N— Record not found in the LACSLink False Positive (Seed) Table.
USA.LACS.PreLACSAddress The input address before LACSLink processing.
USA.LACS.PreLACSLeadingDirectional The input address street predirectional determined before LACSLink processing.
USA.LACS.PreLACSMatchedZIP The input address matched ZIP Code determined before LACSLink processing.
USA.LACS.PreLACSMatchedZIP4 The input address matched ZIP+4 Code determined before LACSLink processing.
USA.LACS.PreLACSRange The input address street primary range determined before LACSLink processing.
USA.LACS.PreLACSStreetName The input address street name determined before LACSLink processing.
USA.LACS.PreLACSSuffix The input address street suffix determined before LACSLink processing.
USA.LACS.PreLACSTrailingDirectional The input address street postdirectional determined before LACSLink processing.
USA.LACS.PreLACSUnitD The input address unit designator determined before LACSLink processing.
USA.LACS.PreLACSUnitN The input address unit number determined before LACSLink processing.
USA.LACS.ReturnCode The LACSLink return code.
  • A— LACSLink processing successful. Record matched through LACSLink processing.
  • 00— LACSLink processing failed. No matching record found during LACSLink processing.
  • 09— LACSLink processing matched the input address to an older highrise default address. The address has been converted. However, rather than provide an imprecise address, LACSLink processing does not provide a new address.
  • 14— LACSLink processing failed. Match found during LACSLink processing but conversion did not occur due to other USPS regulations.
  • 92— LACSLink processing successful. Record matched through LACSLink processing. Unit number dropped on input.
USA.LACS.SeedHit Indicates if the address was found in the LACSLink False Positive (Seed) Table.
  • Y— The address was found in the LACSLink False Positive (Seed) Table.
  • N— The address was not found in the LACSLink False Positive (Seed) Table.
USA.LOTCode The returned enhanced Line of Travel (eLOT) code. Used for output information only. If eLOT is unavailable, the default value is 0000D.
USA.LOTSequence The last character of the eLOT code indicates eLOT sequence.
  • A— Ascending.
  • D— Descending.
USA.MatchLevel The returned match level.
  • F— Firm record match.
  • G— General delivery match.
  • H— Highrise match.
  • P— PO Box match.
  • R— Rural route/highway contract match.
  • S— Street level match.
USA.NonMailingCityName The non-mailing city name. A city name that is recognized by the USPS, but is not the preferred name for the ZIP Code. This is often a vanity name for the area.
USA.Parsed.AltPostDirectional The parsed alternate post directional.
USA.Parsed.AltPreDirectional The parsed alternate pre-directional.
USA.Parsed.AltRange The parsed alternate range.
USA.Parsed.AltStreetName The parsed alternate street name.
USA.Parsed.AltStreetSuffix The parsed alternate suffix.
USA.Parsed.PMUnitDesignator The parsed PMB or MSC designator.
USA.Parsed.PMUnitNumber The parsed PMB or MSC unit number.
USA.Parsed.PostDirectional The parsed post-directional.
USA.Parsed.PreDirectional The parsed pre-directional.
USA.Parsed.Range The parsed primary range.
USA.Parsed.StreetName The parsed street name.
USA.Parsed.StreetSuffix The parsed street suffix.
USA.Parsed.Unit2Designator The parsed second unit designator.
USA.Parsed.Unit2Number The parsed second unit number.
USA.Parsed.UnitDesignator The parsed unit designator.
USA.Parsed.UnitNumber The parsed unit number.
USA.POBoxOnly The PO Box only delivery zone status indicator.
  • Y— The address ZIP Code is a PO Box only delivery zone.
  • N— The address ZIP Code is not a PO Box only delivery zone.
  • Blank— Unable to determine USPS ZIP Code for input address.
USA.PostalBarcode The returned delivery point barcode.
USA.PreferredCityName The preferred city name for ZIP Code.
Note: For successfully-coded addresses, the USA.PreferredCityName and the USA.PreferredState fields are always populated.

For non-coded addresses, the USA.PreferredCityName and the USA.PreferredState fields are populated in the following scenarios:

  • ZIP Code only input (city not input, or not found).
  • Single ZIP Code city input (ZIP Code not input, or not found).
  • City/St/ZIP Code input and agree (ZIP Code is part of city).

For all other non-coded scenarios, the preferred fields are blank.

USA.PreferredState The preferred state abbreviation for the preferred city name.
Note: For successfully-coded addresses, the USA.PreferredCityName and USA.PreferredState fields are always populated.

For non-coded addresses, the USA.PreferredCityName and USA.PreferredState fields are populated in the following scenarios:

  • ZIP Code only input (city not input, or not found).
  • Single ZIP Code city input (ZIP Code not input, or not found).
  • City/St/ZIP Code input and agree (ZIP Code is part of city).

For all other non-coded scenarios, the preferred fields are blank.

USA.PrivateMailbox The returned matched Private Mail Box (PMB) or Mail Stop Code (MSC).
USA.PrivateMailbox.Input Reserved for future use.
USA.PrivateMailbox.Type Reserved for future use.
USA.PrivateMailbox.Type.Input Reserved for future use.
USA.RDI The returned Residential Delivery Indicator (RDI).
  • Y— The address is a residential delivery.
  • N— The address is a business delivery.
  • Blank— The address failed address lookup (did not return a ZIP+4), or RDI was not active.
USA.SeasonalFlags The seasonal delivery indicator beginning with January. The seasonal indicators for the returned ZIP Code. These indicators identify, at the 5-digit ZIP Code level, the months in which seasonal addresses receive delivery. There are 12 monthly flags (January through December). A "Y" in one of the monthly slots indicates that seasonal addresses are delivered mail in the month indicated by that slot. This field is blank if there are no seasonal deliveries for the ZIP Code.
  • Y— Deliver mail in this month.
  • N— Do not deliver mail in this month.
USA.Status The match status of the address.
  • F— The address failed to match.
  • Blank— The address was successfully matched.
USA.Status.Code

USA.Status.Description

The returned match status code.
  • 4101— No city, state, and ZIP Code in address.
  • 4102— No ZIP Code and no city name in address.
  • 4103— No ZIP Code and no state name in address.
  • 4104— Cannot match to Unique ZIP Code.
  • 4211— Invalid ZIP Code and no city name in address.
  • 4212— No ZIP Code and invalid city name in address.
  • 4213— Invalid ZIP Code and invalid city name in address.
  • 4301— No street name in input address.
  • 4399— Blank address record.
  • 4411— No primary street name found in the Global Address Validation database.
  • 4412— No primary names ranked with certainty.
  • 4421— Invalid range or house number.
  • 4422— Incorrect or missing directional.
  • 4423— Incorrect or missing suffix.
  • 4425— Incorrect or missing suffix and directional.
  • 4450— No range in input address.
  • 4451— Multiple component failure. An address component had multiple options causing the address to fail assignment.
  • 4460— EWS Failure. Address found on EWS table.
  • 4461— eLOT assignment has failed. Address coded successfully but eLOT code not assigned.
  • 4465— The address requires a firm. No firm was provided or the firm failed to match.
  • 4466— The address requires secondary addresses (there is no default street address). No secondary was provided or the secondary did not match.
  • 4467— The address coded but was flagged for ZIP Move processing. The address failed to meet the final ZIP Move criteria. ZIP Move processing requires an exact match of street, suffix, and directional (both pre and post).
  • 4500— Unable to code. If reason for inability to code cannot be determined, this error is issued.
  • 4600— Undeliverable address in the Global Address Validation database.
    Note: This status code can still be valid with a successfully matched address. The combination of the two codes indicates that this is a valid address but is not deliverable by USPS standards.
  • 4601— The address failed Delivery Point Validation (DPV) processing.
  • 4602— The address is flagged as Carrier Route R777 and is not eligible for street delivery. This status code is only generated if the option R777 Deliverable is not activated.
  • 4801— Address is locked and was not be processed.
  • 5101— Warning: Missing apt/suite number.
  • 5102— Warning: Apt/suite was input but is not valid.
  • 5103— Warning: Input firm name is missing or invalid.
  • 5104— Warning: Multiple firms returned for address.
  • 5105— Warning: PO Box number is invalid or unavailable.
  • 5106— Warning: Apt/Suite was input but not allowed for this address.
  • 5200— Information: Address bypassed counted correct in Process Unassign run.
USA.StreetNameAliasType The type of alias street name. An alias street name is an alternate name for a street, maintained at the 5-digit ZIP Code level.
  • Abbreviated— The alias street name is an abbreviation of the street name. For example, HARTS-NM RD is an abbreviated alias for HARTSVILLE NEW MARLBORO RD.
  • Changed— The official street name changed and the alias street name reflects the new official street name. For example, if SHINGLE BROOK RD is changed to CANNING DR, then CANNING DR would be a changed alias type.
  • Other— The alias street name is made up of nicknames, other names, or common abbreviations for the street name.
  • Preferred— The alias street name is the USPS preferred alias street name.
USA.SuiteLink.Fidelity The SuiteLink fidelity code.
  • 1—All words in the business name match.
  • 2—Acceptable match. One or more words in the business name did not match, but acceptance criteria was still met.
  • 3—Unacceptable match. One or more words in the business name did not match. Acceptance criteria was not met.
USA.SuiteLink.MatchCode The SuiteLink match code.
  • A— SuiteLink match found.
  • B— No SuiteLink match found.
  • C— Business name normalized to a blank value.
  • D— ZIP + 4 Code not recognized as a high-rise default.
  • E— SuiteLink database expired.
USA.SuiteLink.ReturnCode The SuiteLink return code.
  • A— Successful SuiteLink match.
  • 00— Failed SuiteLink match.
USA.VeriMoveDataBlock Reserved for future use.
USA.ZIPValid The returned ZIP Code.
USA.ZIP4Valid The returned ZIP + 4 Code.