CASS2 Field Descriptions
A CASS2 processed record will match the existing output structure of the previous CASS engine, with a few exceptions described below and highlighted in red.
Other processing changes or notable behaviours include:
- Thoroughfare names that may have abbreviations will almost always be returned in the longer format
- USPS supports both long and short names for Locality. By default, the CASS2 engine will return long names for Locality. The CassCityAbbreviation server option can be used to return the abbreviated versions of Locality names that are over 13 characters in length.
An output record will contain the following:
- A subset of Verify fields, with the following exceptions and changes:
-
AVC and AQI fields will be populated by a default value “Z00-Z00-Z0-000” and “Z” respectively. Instead, customers should use the CASS2 output fields DPVConfirmedIndicator, DPVFootnotes, and ResultsString to determine the quality and accuracy of processed record.
2. The table below displays the CASS 2 fields currently available in the Loqate API.
| Field | Definition |
|
AutoZoneIndicator Note this field will be blank due to performance reasons unless the server option CassZipFields is set to “Yes” |
Automated Zone Indicator. The return value is an indicator that specifies the following conditions for letter-size carrier route sorted mail: |
| A – Carrier route sort rates apply. Merge allowed. | |
| B – Carrier route sort rates apply. Merge not allowed. | |
| C – Carrier route sort rates do not apply. Merge allowed. | |
| D – Carrier route sort rates do not apply. Merge not allowed. | |
| CarrierRoute | Carrier route code assigned to a mail delivery or collection route within a 5-digit ZIP Code. This is also referred to as CRID. There are 5 types: |
| B – PO Box | |
| H – Highway contract | |
| R – Rural route | |
| C – City delivery | |
| G – General delivery | |
| CheckDigit | Delivery Point Bar Code check digit. This is the last character of the DeliveryPointBarCode |
| CMRAIndicator | Indicates whether the address is associated with a Commercial Mail Receiving Agency(CMRA). |
| Y – Address was found in the table | |
| N – Address was not found in the table | |
| blank – Address was not presented to the table | |
| CongressionalDistrict | The congressional district to which the address belongs |
| DefaultFlag | A value of “Y” indicates that the record matched to a high rise default, rural route default, or street default record in the ZIP+4 file. |
| blank – Not a default | |
| DeliveryPointBarCode | 3-digit code which consists of the 2-digit delivery point code and 1-digit check digit.This is used to create the 12-digit POSTNET barcode which consists of the 5-digit ZIP Code, 4-digit ZIP+4 addon code, and this 3-digit code. |
| DPVConfirmedIndicator | Indicates the deliverability of the address |
| Y – Confirmed | |
| N – Primary number failed to DPV confirm | |
| S – Confirmed after dropping the subbuilding number | |
| D – Premise number confirmed but subbuilding number is missing | |
| blank – The address was not submitted for DPV confirmation. | |
| DPVFootnotes | Delivery Point Validation footnotes. There can be one or more two character footnotes. This field is used together with the DPVConfirmedIndicator field to understand the input address’ validity and deliverability |
| AA – Street, city, state and ZIP are valid. Address matched a record in the ZIP+4 file. | |
| A1 – Address not found in the ZIP+4 file. Address is invalid | |
| BB – All address components are confirmed. Address is a deliverable | |
| address | |
| CC – Address is a deliverable address after dropping the subbuilding number from the input address | |
| F1 – Address matched to a military address | |
| G1 – Address matched to a general delivery address | |
| N1 – Found a DPV match to the premise number but the subbuilding number is missing from the input record | |
| M1 – Premise number is missing | |
| M3 – Premise number is invalid | |
| P1 – PO, RR, HC Box number missing | |
| P3 – PO, RR, HC Box number is invalid | |
| PB: Input address matched to a post office box street address | |
| RR – Address matched to CMRA and PMB designator is present | |
| R1 – Address matched to CMRA but PMB designator is not present | |
| R7: Input address matched to a physical address that does not receive delivery from the USPS (R777) | |
| U1 – Address matched to a unique ZIP Code | |
| DPVLACSIndicator | This field will always be empty. |
| eLOTCode | eLOT directional indicator. See the eLOTNumber field for additional information. |
| A – ascending | |
| D – descending | |
| eLOTNumber | 4-digit sequence number for eLOT (Enhanced Line of Travel). This number combined with the eLOTCode field is used in mail sortation. eLOT processing may be used by mailers to qualify for enhanced carrier route presort discounts. |
| blank – Address not submitted for eLOT | |
| EWSFlag | A value of “Y” indicates that the address matched a record in the EWS (Early Warning System) file, thus resulting in a ZIP+4 no match |
| blank – Address was not flagged by EWS | |
| FalsePositiveIndicator | The False Positive table flags the False Positive addresses. This is a flag to determine whether a mailing list is being generated or created during validation. Creating a mailing list through DPV certification is not allowed by the USPS. |
| Y – Address was found in the table | |
| N – Address was not found in the table | |
| blank – Address was not presented to the table | |
|
Finance Note this field will be blank due to performance reasons unless the server option CassZipFields is set to “Yes” |
A code assigned to Postal Service™ facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data. An example output for 805 Veterans Blvd, Redwood City, CA 94063 is 056378. Note that the reference for this information can be found here: |
| https://postalpro.usps.com/address-quality/AIS_Products_Technical_Guide | |
| FIPSCountyCode | 3-digit FIPS (Federal Information Processing Standard) code which uniquely identifies counties. |
| This field will be prefixed with the numeric state code. For example, the value for San Francisco, CA will change from 075 to 06075 | |
| Footnotes | This CASS1 field will no longer be returned . Typically, this field is representative of ResultsString, DPVConfirmedIndicator, and DPVFootnotes, and customers are encouraged to use these fields instead. |
| LACSLinkCode | Code returned by LACSLink® after querying the LACSLink® database. |
| A – The input address matched to a record in the LACSLink® database. A new address could be furnished. | |
| 00 – The input address could not be matched to a record in the LACSLink®database. A new address could not be furnished. | |
| 14 – The input record matched to a record in the LACSLink®database. The new address could not be converted to a deliverable address. | |
| 92 – The input address matched to a LACSLink® record but the input address had a subbuilding number and the LACSLink® record did not. | |
| blank – No LACSLink lookup attempted | |
| LACSLinkIndicator | Indicator returned by LACSLink® after querying the LACSLink® database. |
| Y – The input address matched to a record in the LACSLink® database. | |
| S – The input address matched to a LACSLink® record but the input address had a subbuilding number and the LACSLink® record did not. | |
| N – The input address could not be matched to a record in the LACSLink® database. A new address could not be furnished. | |
| F – A false positive record was detected | |
| blank – No LACSLink lookup attempted | |
| LACSStatus | A value of “L” indicates that the input address matched an entry in the Locatable Address Conversion Service database and the input address has been converted from a rural-style address to a city-style address. |
| blank – No LACS Status returned | |
| NoStatIndicator | Indicates the address is not receiving delivery, and the address is not counted as a possible delivery. These addresses are not receiving delivery because A) delivery has not been established; B) customer receives mail as a part of a drop; or C) the address is no longer a possible delivery because the carrier destroys or returns all of the mail. |
| Y – Address was found in the table | |
| N – Address was not found in the table | |
| blank – Address was not presented to the table | |
| ParsedGarbage (NEW) | This field will capture information that the CASS2 engine is able to parse out of the input during the matching process. |
|
PMBNumber
|
Private Mail Box Value will be appended to the PrimaryAddressLine field. This information used to be in SecondaryAddressLine. For example, this will be the “252“ in “PMB 252“. |
| PMBType | Private Mail Box Type will be appended to the PrimaryAddressLine field. For example, this will be the “PMB“ in “PMB 252“. |
| PrimaryAddressLine | Primary delivery address line. This can include any of the following: |
| Premise Number | |
| Thoroughfare Name | |
| Thoroughfare Predirection | |
| Thoroughfare Postdirection | |
| Thoroughfare Trailing Type | |
| Subbuilding Number | |
| PO BOX | |
| RecordType | Record type of address that is confirmed as a valid delivery address |
| S – Street | |
| P – PO Box | |
| R – Rural route | |
| H – Highrise | |
| F – Firm | |
| G – General delivery | |
| blank – No record type because address did not make a valid DPV match | |
| ResultsString (NEW) | Provides information about the process and output address. |
| View all possible values for this field. | |
| ReturnCode | 10 – Invalid input address |
| 11 – Invalid 5-digit ZIP Code | |
| 12 – Invalid state abbreviation code | |
| 13 – Invalid city name | |
| 21 – No match found | |
| 22 – Multiple responses were found and more specific information is required to select a single or default response | |
| 31 – A single matching address was found | |
|
32 – An address was found, but a more specific address could be found with more information Empty – A full match to a CASS record is not possible. |
|
| ResidentialDelivery | This field indicates whether the input address is a residential address or a business address Y – residential N – business blank – invalid address |
| This old field will no longer be returning the value from the USPS RDI product. Instead, Loqate will obtain this value from another source, which is updated by multiple signals on a more frequent basis. | |
|
SecondaryAddressLine Note: this will no longer contain City, State, and Zip. Please use component fields Locality, AdministrativeArea, and PostalCode. |
Secondary delivery address line if present. |
| SUITELinkFootnote | Code returned by SuiteLink® after querying the SuiteLink® database. |
| A – The input address matched to a record in the SuiteLink® database. An improved business address could be furnished. | |
| 00 – The input address could not be matched to a record in the SuiteLink® database. | |
| VacantIndicator | Indicates that the delivery point was active in the past, but is currently vacant (in most cases, unoccupied over 90 days) and is not receiving deliveries. |
| Y – Address was found in the table | |
| N – Address was not found in the table | |
| blank – Address was not presented to the table |