CASS2 Field Descriptions
An output record will contain the following:
A subset of Verify fields, with the following exception:
- For on-premises CASS2, the AVC and AQI fields will be populated by a default value “Z00-Z00-Z0-000” and “Z” respectively. Customers should use the CASS2 output fields DPVConfirmedIndicator, DPVFootnotes, and ResultsString to determine the quality and accuracy of processed record. Loqate Cloud CASS2 customers will see the AVC populated.
The table below displays the CASS2 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. | |
| DNA | DPV Door Not Accessible. Addresses where the USPS cannot knock on a door to deliver a package that will not fit in the mailbox. Y – Address was found in table N – Address was not found in table blank – Address was not presented to table |
|
| DPVConfirmedIndicator | Indicates the deliverability of the address | |
| Y – Confirmed | ||
| N – Primary number failed to DPV confirm | ||
| S – Address was DPV confirmed for the primary number only and the secondary number information was present but invalid, or a single trailing alpha on a primary number was dropped to make a DPV match | ||
| 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 | ||
| C1 – Address is a deliverable address after dropping the subbuilding number from the input address. Subbuilding is required. | ||
| CC – Address is a deliverable address after dropping the subbuilding number from the input address. Subbuilding is not required. | ||
| F1 – Address matched to a military address | ||
| G1 – Address matched to a general delivery address | ||
| IA – Informed Address identified. This replaces the recipient’s name and street address with a special code in the address block. The only information that most people will be able to see about the recipient will be their city, state, and ZIP5. | ||
| 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 or R779) | ||
| TA – Input address premise matched by dropping trailing alpha | ||
| U1 – Address matched to a unique ZIP Code | ||
| DPVLACSIndicator | This field will always be empty. | |
| DropSiteIndicator |
A flag that indicates mail is delivered to a single receptible at a site: Y = Address was found in the table N = Address was not found in the table Blank = Address was not presented to the table |
|
| 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 pre-sort discounts. | |
| blank – Address not submitted for eLOT | ||
| EnhancedReturnCode | Enhanced DPV Return Code. This is populated when there is more than one valid DPVConfirmedIndicator. When present, this should take precedence over DPVConfirmedIndicator. Y – Address was DPV confirmed for primary and secondary numbers necessary to determine a valid delivery point D – Address was DPV confirmed for the primary number only. Secondary information was missing S – Address was DPV confirmed for the primary number only, the secondary number information was present but not confirmed or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required N – Primary number failed to DPV confirm R – Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided blank – Address was not presented to the table |
|
| 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 | The 5 digit FIPS (Federal Information Processing Standard) code which uniquely identifies counties. The first two will be the stage code and the last three are the county. For example, San Francisco, CA is 06075. | |
| 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 | ||
| NDDFlag | DPV Non-Delivery Day Flag that indicates mail delivery is not performed every day of the week. Y – Address was found in table N – Address was not found in table blank – Address was not presented to table |
|
| NDDValues | DPV Non-Delivery Day Values. This seven-character field represents Sunday-Saturday and will contain a Y for the days where mail can be delivered. For example, “NYYYYYN” means mail is is not received on Saturday or Sunday (e.g. the business is closed). | |
| 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 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 | ||
| NoStatReason |
The reason mail delivery was not provided. 01 – Internal Drop Address. These are addresses that do not receive mail delivery directly from the USPS but are delivered to a drop address that services them. 02 –The delivery is new construction and delivery has not been established or on a Rural/CDS/HCR where the delivery point is unoccupied for more than 90 days. 03 – Collision address. Addresses that do not actually DPV confirm. 04 – College/Military Zone, & Other types. 05 – The address is no longer a possible delivery, the address is on an R777/R779 route, or the PO Box has never been rented or has been declared un-rentable, or the No Stat reason is not one of the other reasons. 06 – The address requires secondary information. blank – Address was not presented to the table |
|
| NSL |
DPV No Secure Location. The door is accessible, but a package will not be left due to security concerns. Y – Address was found in table N – Address was not found in table blank – Address was not presented to table |
|
| ParsedGarbage | This field will capture information that the CASS2 engine is able to parse out of the input during the matching process. | |
| PBSAIndicator | PO Box Street Address Indicator. Y – Address was found in table N – Address was not found in table blank – Address was not presented to table |
|
| PMBNumber | Private Mailbox 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 Mailbox Type will be appended to the PrimaryAddressLine field. For example, this will be the “PMB“ in “PMB 252“. | |
| POBoxOnly | There is only one ZIP Code for a given facility and the facility has no other form of postal delivery other than a PO Box. Y – PO Box only N or blank – Zip code was not found in the table |
|
| 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 | ||
| ResidentialDelivery | This field indicates whether the input address is a residential address or a business address Y – residential N – business blank – invalid address |
|
| ResultsString | 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. | ||
| SecondaryAddressLine | 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. | ||
| ThrowbackIndicator | Residence and business that choose to receive delivery through PO Boxes. No delivery is made to the street address. Y – Address was found in table N – Address was not found in table blank – Address was not presented to table |
|
| 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 | ||
| Zip5Valid | ZIP5 Valid Flag. ZIP Code Include in PS Form 3553. Y – Address is counted in PS Form 3553. N – Address is not counted in PS Form 3553. blank – Not a valid DPV address |