Note: RDI is available from the USPS
for an annual licensing fee, which includes monthly updates. For more
information about RDI, please visit the USPS Web site at https://ribbs.usps.gov/index.cfm?page=address_manage_products.DataFlux Data Management Studio 2.7: User Guide
The Address Verification (US/Canada) node uses US/Canada verified address data types, which serve to replace a selected field with corresponding verified address information found in the US Postal Service and Canada Post databases. For example, a ZIP code field might be replaced with US ZIP or Canada Post Code verified address data types, which are guaranteed by the US Postal Service and Canada Post to be accurate.
You can either translate a given field (for example, City) with the US/Canada verified field (US City or Canada City), or create new fields in the table to house the US and Canada verified address data.
The following is a list of data types used for both United States and Canadian addresses.
Addressee - Specifies the person (contact) who will receive the mail.
Firm - Specifies a business, association, or organization where the mail is going.
Address Line 1 - Specifies the first line of an address, usually including a street name.
Address Line 2 - Specifies the second line of an address, if the first line carries to a second line.
City - Specifies the city name.
State - Specifies the state name.
ZIP/Postal Code - Specifies the ZIP code or postal code used with the address.
Country - Specifies the country related to the address.
The following is a list of the available US verified address data types:
US ZIP - Specifies the five-digit United States ZIP code.
US ZIP4 - Specifies the nine-digit US ZIP code (also known as ZIP+4).
US Street Number - Specifies the street number.
US Street Pre-direction - Specifies a term used by the US Postal Service (USPS) to refer to the part of the address that provides directional information for delivery (for example, N, S, NW, SE, and so on) when it is the first word in the street name and there is no other directional word to the left of it.
US Street Name - Specifies the street name, not the street number.
US Street Suffix - Specifies the type of street, such as Road, Way, Parkway, Court, and so on.
US Street Post-direction - Specifies a term used by the USPS for directional information located to the right of the street name and street suffix, such as N, S, NE, SW.
US Street Secondary Abbrev - Specifies abbreviations for floor, building, suite, apartment, and so on.
US Street Secondary Number - Specifies the number associated with the secondary abbreviation, such as Apt 95, Bldg 2, Suite 201, and so on.
US Urbanization (PR) - Specifies an area, sector, or development within a geographic area. In addition to being a descriptive word, it precedes the name of the area. This urbanization descriptor, commonly used in urban areas of Puerto Rico, is an important part of the addressing format since it describes the location of a given street.
US Carrier Route - Specifies the US carrier route ID used for mail sorting.
US PMB Designator - Specifies Y or N to indicate whether the number is a private US mailbox.
US PMB Number - Specifies the mailbox number associated with the designator. Private companies offering mailbox rental service to individuals or businesses might require a "box" number for final sorting.
US Deliv Pt - Specifies the delivery point bar code, a two-digit number calculated from the address.
US Deliv Pt Check Digit - Specifies a field that is calculated from the ZIP, ZIP+4, and delivery point bar code.
US LACS Indicator - Specifies records that have been converted to the LACS system, a product/system in a different USPS product line that allows mailers to identify and convert a rural route address to a city-style address. Rural route and some city addresses are being modified to city-style addresses so emergency services can find these addresses more efficiently. The indicators are shown in the following table:
| Result Code | Description |
|---|---|
| L | LACS address, the old (usually rural route) address that has been converted for the LACS system. |
| Blank | Not applicable |
US Default Highrise Ind - Indicates whether the address is located in a high-rise building.
US Early Warning System - Specifies a flag that is used by the USPS to flag an address that is expected to change. The return code is either No Match or Early Warning.
US Record Type - Specifies an alphabetic value that identifies the type of data in the record. Record type codes include the following:
| Record Type | Description |
|---|---|
| F | Firm (ZIP+4 only) |
| G | General delivery (5-digit ZIP, ZIP+4, and carrier route products) |
| H | High-rise (ZIP+4 only) |
| M | Multi-carrier (carrier route product only) |
| P | PO box (5-digit ZIP, ZIP+4, and carrier route products) |
| R | Rural route/highway contract (5-digit ZIP, ZIP+4, and carrier route products) |
| S | Street (5-digit ZIP, ZIP+4, and carrier route products) |
US Congressional District - Specifies a standard value identifying a geographic area within the US served by a member of the US House of Representatives or Senate. If Army/Air Force (APO) or fleet post office (FPO), this field will be blank. If there is only one member of Congress within a state, the code will be "AL" (at large).
US County Code - Specifies the Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a US state. In Alaska, it identifies a region within the state. If APO/FPO and the record type is "S," "H," or "F," the county number will be blank.
US County Name - Specifies the county name associated with the county code.
US State FIPS - Specifies the US State (FIPS) code assigned to a specific state.
US Extra Information - Contains additional information before and after P.O. Box information that must be stripped away when an input address contains PO Box information. This information must be removed under CASS rules.
US Finance Number - Refers to an area encompassing a set of ZIP codes.
US Preferred City Name - Specifies the preferred city name, according to the USPS.
US Abbreviated City Name - Specifies the abbreviated city name, according to the USPS.
US Verified Street-Level Address Flag - Specifies Y or N, which indicates whether the street-level information matches.
US Result Code - Indicates whether the address was successfully verified. In case the address was not successfully verified, a US Return Code indicates the cause of address verification failure, as shown in the following table:
| Text Result Code | Numeric Result Code | Description |
|---|---|---|
| OK | 0 | Address was verified successfully. |
| PARSE | 11 | Error parsing address. Components of the address might be missing. |
| CITY | 12 | Could not locate city/state or zip in the USPS database. At least (city and state) or ZIP must be present in the input. |
| MULTI | 13 | Ambiguous address. There were two or more possible matches for this address with different data. |
| NOMATCH | 14 | No matching address found in the USPS data. |
| OVER | 15 | One or more input strings is too long (maximum 100 characters). |
US Numeric Result Code Contains the numeric result to the US Result Code field. See the Numeric Result Code column above for additional information.
US RDI Result Code - Specifies the Residential Delivery Indicator (RDI), which confirms whether a particular address is residential or business. This information is useful because different postal rates can apply for residential versus business deliveries. If the RDI query process was successful, RDI address confirmation result will be stored in US RDI, as shown in the following table:
| Result Code | Description |
|---|---|
| 0 | Success |
| 5 | Product is locked |
| 9 | Functionality is disabled |
US RDI - Displays the US Residential Delivery Indicator, which displays the residential delivery results, as shown in the following table:
| Result Code | Description |
|---|---|
| Y | Residential Delivery |
| Blank | Not Residential Delivery |
Note: RDI is available from the USPS
for an annual licensing fee, which includes monthly updates. For more
information about RDI, please visit the USPS Web site at https://ribbs.usps.gov/index.cfm?page=address_manage_products.
US eLOT Result Code - Confirms whether an address has a presort sequence number. The result codes include:
| Result Code | Description |
|---|---|
| 0 | Success |
| 5 | Product is locked |
| 9 | Functionality is disabled |
Note: eLOT processing is performed only when the ZIP+4 is present in the output. This means when CASS compliance is selected, the DPV is confirmed. If the DPV Confirmation Indicator does not return a valid confirmation (D, S, or Y), then the return code 9 will be returned for eLOT result code fields.
US eLOT AD Flag - Indicates whether the number is in ascending or descending order, as shown in the following table:
| Result Code | Description |
|---|---|
| A | Ascending |
| D | Descending |
US eLOT Sequence Number - Specifies a four digit number used to presort mail in the delivery order for a specific carrier route.
US DPV Result Code - Confirms the address actually exists, as opposed to a valid range of house numbers on the street. The US DPV Result Code indicates the status of the DPV query process and will contain either a success (0) or an error code (see below). If DPV query process was successful, the DPV address confirmation result will be stored in US DPV Confirmation Indicator. Possible error codes for US DPV Result Code are shown in the following table:
| Result Code | Description |
|---|---|
| 0 | Success |
| 5 | Product is locked |
| 99 | DPV processing was stopped due to an "artificial" address. That address is saved in "dpv_fp_addr" member of the "dfav_us_result" structure. |
US DPV Confirmation Ind - Indicates the delivery point. The following table displays the available result codes and descriptions:
| Result Code | Description |
|---|---|
| D | Address was DPV confirmed for the primary number only, the secondary number information was missing. |
| N | Both primary and (if present) secondary number information failed confirmation. |
| S | Address was DPV confirmed for the primary number only, the secondary number information was present but unconfirmed. |
| Y | Address was DPV confirmed for both primary and (if present) secondary numbers. |
| Blank | Address not presented to hash table. |
US CMRA Confirmation Ind - Indicates whether an address is from a private mail box company, as shown in the following table:
| Result Code | Description |
|---|---|
| Y | Address was found in CMRA table. |
| N | Address was not found in CMRA table. |
| Blank | Address not presented to hash table. |
US DPV Footnote 1 - Contains a notation regarding DPV processing, as shown in the following table:
| Result Code | Description |
|---|---|
| AA | Input address matched to the ZIP+4 file. |
| A1 | Input address did not match to the ZIP+4 file. |
| BB | Input address matched to DPV (all components). |
| CC | The input address primary number matched to DPV but the secondary number did not match (both numbers present but invalid). |
| F1 | Input address is a military address. |
| G1 | Input address is a general delivery address. |
| M1 | Input address primary number missing. |
| M3 | Input address primary number invalid. |
| N1 | Input address primary number matched to DPV but high-rise address missing secondary number. |
| P1 | Input address missing PO, RR, or HC box number. |
| P3 | Input address PO, RR, or HC box number invalid. |
| RR | Input address matched to CMRA and PMB designator present (PMB 123 or #123). |
| R1 | Input address matched to CMRA but PMB designator not present (PMB 123 or #123). |
| U1 | Input address has a unique ZIP code. |
US DPV Footnote 2 - The possible values for US DPV Footnote 2, which are the same as US DPV Footnote 1.
US DPV Footnote 3 - The possible values for US DPV Footnote 3 are the same as US DPV Footnote 1.
US DPV Other Footnotes - Exists for backward compatibility only; it will always contain an empty string.
US DPV False Positive Ind - Indicates that the Delivery Point Value (DPV) processing was terminated due to the detection of what might be an artificially created address. No address beyond this point has been DPV validated. In accordance with the License Agreement between USPS and DataFlux, DPV shall be used to validate legitimately obtained addresses only, and shall not be used for the purpose of artificially creating address lists. Values for this field are shown in the following table:
Note: The DataFlux license with the USPS restricts any DataFlux customer from using DPV to artificially create address lists.
Continuing use of DPV requires compliance with all terms of the DataFlux
agreement with the USPS. If you believe that this address was identified in
error, please contact DataFlux. You should immediately report the
address to DataFlux and DataFlux will notify the USPS of the address.
| Result Code | Description |
|---|---|
| Y | Address was found in false positive table. |
| N | Address was not found in false positive table. |
| Blank | Address not presented to hash table. |
US LACSLink Result Code - Displays an internal result code from LACSLink functional component. The following table displays possible result codes. Any other value is an internal error code.
| Result Code | Description |
|---|---|
| 0 | Success |
| 99 | False positive |
US LACSLink Indicator - Indicates whether an input address exists in LACSLink database. Possible values are shown in the following table:
| Result Code | Description |
|---|---|
| F | Input address is a false positive. This is similar to DPV false positive - USPS believes that the input address was artificially generated. When this type of address is presented to LACSLink the LACSLink functionality is disabled for the remaining verify process. |
| N | Address conversion does not exist. |
| S | Address conversion exists only if secondary information is dropped from the input address. |
| Y | Address conversion exists. |
US LACSLink Return Code - Return codes for LACSLink lookups as defined by USPS. Possible values are shown in the following table:
| Result Code | Description |
|---|---|
| A | New address was found successfully and provided upon output. |
| 00 | Address conversion does not exist. |
| 14 | Could not convert address at run time. This means that the initial lookup table indicated a conversion exists, but further lookups (in other tables) failed to find one. |
| 92 | New address was found only after secondary information from input address was dropped. |
US Data Date - Indicates when the USPS data was last compiled.
US DPV Data Date - Indicates when the DPV data was last compiled.
US LACSLink Data Date - Indicates when the LACSLink data was last compiled.
US eLOT Data Date - Indicates when the eLOT data was last compiled.
The following is a list of the available Canadian Verified Address Data Types:
Canada Result Code - Indicates whether the address was successfully verified. In case the address was not successfully verified, the Canada Return Codes shown in the following table indicate the cause of address verification failure:
| Result Code | Description |
|---|---|
| 0 | No error occurred |
| 1 | Internal error |
| 2 | Cannot load database |
| 3 | Invalid - unspecified reason |
| 4 | Invalid civic number |
| 5 | Invalid street |
| 6 | Invalid unit |
| 7 | Invalid delivery mode |
| 8 | Invalid delivery installation |
| 9 | Invalid city |
| 10 | Invalid province |
| 11 | Invalid postal code |
| 12 | Address is not Canadian |
Canada Civic Number - Indicates the address civic number.
Canada Civic Number Suffix - Indicates the end of the address civic number.
Canada Street Name - Indicates the parsed address street name.
Canada Street Type - Indicates the parsed address street type, such as drive, street, road, and more.
Canada Street Direction - Indicates the parsed address street directional information, such as South, Southwest, Northwest, and so on.
Canada Unit Type - Indicates suite, apartment, building, and more.
Note: Non-Standard Canada Unit Types are no longer a part of the documentation for Canada Post but continue to be acceptable.
Canada Unit Number - Specifies the number representing the unit type, for example Apt. B, Suite 201, and so on.
Canada Deliv Mode Type - This type indicates the delivery type, as shown in the following table:
| Result Code | Description |
|---|---|
| CP | Case Postale |
| GD | General Delivery |
| IM | itinéraire motorisé |
| MR | Mobile Route |
| PO | Post Office Box |
| PR | Poste Restante |
| RR | Route Rurale |
| SS | Service Suburbain |
Canada Deliv Mode Number - Specifies the number associated with the address delivery mode type, if applicable. For example, the number of the Rural Route or Post Office Box.
Canada Deliv Inst Area - Indicates the general location of the postal installation.
Canada Deliv Inst Type - Indicates the type of postal installation.
Canada Deliv Inst Qualifier - Identifies a postal installation if more than one installation shares the same general location.
Canada Non Address - Specifies information that is included in the input address but is not part of any address components required by Canada Post.
Canada Large Volume Receiver Flag - Indicates Y if the address is a large volume receiver and N if it is not.
Canada Rural Address Flag - Indicates Y if the address is a rural address and N if it is not.
|
Documentation Feedback: yourturn@sas.com
|
Doc ID: dfU_PFEnrich_AddrVerUSCan_DataT.html |