Match output
The <APPLICATION_NAME>.APP_PUBLIC.MATCH_OUTPUT The table will be populated based on the runtime parameters you selected at the time of job submission.
This table/view will contain the output of the matching process to the dentsu.ID Universe and provide you with IDs for the INDIVIDUAL, HOUSEHOLD, and ADDRESS levels.
| FIELD ORDER | FIELD NAME | FIELD TYPE | SUBFIELD NAME | DESCRIPTION | VALID VALUES |
|---|---|---|---|---|---|
| 1 | REQUEST_ID | VARCHAR | User defined unique identifier for a batch of records submitted for execution. Unaltered information passed through from input record. | ||
| 2 | RECORD_ID | VARCHAR | User defined unique identifier for the record within your batch run. This field is what you can use to tie a specific output record(s) back to a specific input record. Unaltered information passed through from input record. | ||
| 3 | COUNTRY_CODE | Unaltered information passed through from input record | |||
| 4 | INDIVIDUAL | OBJECT | INDIVIDUAL_ID | Persistent ID assigned to each individual in the dataset. Populated with HMID, if HMID is the chosen ID type for a client. Populated with CMID, if CMID is the chosen ID type for a client. By default, all clients will receive HMID via the Match App. | |
INDIVIDUAL_ID_TYPE | Flag to differentiate between sustained or formulated IDs. Sustained IDs are used for individuals with confirmed matches in the dentsu Knowledge Base (KB), while formulated IDs are used for records that do not match. | S: The INDIVIDUAL_ID is a sustained key indicating a match for the individual was determinedF: The INDIVIDUAL_ID is a formulated key indicating a match for the individual was not found | |||
DECEASED_FLAG | Indicator of Y when the individual record matched to the list of deceased individuals. Field is blank when there is not a match. | ||||
| 6 | ADDRESS_INPUT | OBJECT | ADDRESS_ID | Persistent address ID for the input address before move. | |
HOUSEHOLD_ID | Persistent household ID for the input address before move. | ||||
| 7 | ADDRESS_OUTPUT | OBJECT | ADDRESS_ID | Persistent ID assigned to the output address after move. If an address move is detected for the individual, the output ADDRESS_ID will be different than the input ADDRESS_ ID, provided NCOA was requested by the client for the batch and the client has a valid PAF (Postal Authorization Form) on file. | |
HOUSEHOLD_ID | Persistent household ID for the output address after move |
Hygiene output
The <APPLICATION_NAME>.APP_PUBLIC.HYGIENE_OUTPUT table will contain your cleansed and standardized PII data for U.S. consumers. At this stage, your data has not yet undergone the consumer matching process and dentsu.IDs have not yet been assigned to your input data.
Please note that if you requested NCOA (National Change of Address), you may receive two records on output for a record on input representing both the input address and the output address.
| FIELD ORDER | FIELD NAME | FIELD TYPE | SUBFIELD NAME | DESCRIPTION | VALID VALUES |
|---|---|---|---|---|---|
| 1 | REQUEST_ID | VARCHAR | User defined unique identifier for a batch of records submitted for execution. Unaltered information passed through from input record. | ||
| 2 | RECORD_ID | VARCHAR | User defined unique identifier for the record within your batch run. This field is what you can use to tie a specific output record(s) back to a specific input record. Unaltered information passed through from input record | ||
| 3 | COUNTRY_CODE | VARCHAR | Unaltered information passed through from input record | ||
| 4 | ADDRESS_TYPE | VARCHAR | Indicates if the record and associated address was the result of the USPS' National Change Of Address (NCOA). | INPUT: Record representing the Input addressOUTPU: Record representing the New address | |
| 5 | INDIVIDUAL | OBJECT | NAME_PREFIX | Name Prefix (Mr. Mrs, Dr. etc.) from the Client input file. Some validation and edits may have occurred to uppercase the data, remove special characters or other invalid data | |
FIRST_NAME | First name, aka Given name, from the client input file. Some validation and edits may have occurred to uppercase the data, remove special characters or other invalid data | ||||
MIDDLE_NAME | Middle name from the client input file. Some validation and edits may have occurred to uppercase the data, remove special characters or other invalid data | ||||
LAST_NAME | Last Name, aka Family name, from the client input file. Some validation and edits may have occurred to uppercase the data, remove special characters or other invalid data | ||||
GENERATION_QUALIFIER | Generational qualifier (Jr., Sr., etc.) from the Client input file. Some validation and edits may have occurred to uppercase the data, remove special characters or other invalid data. Standardized version of generational indicator. Jr, II, 2, Junior, Jun, 2nd, should all be standardized to JR | ||||
NAME_SUFFIX | Name appendage (MBA, JD, PHD, etc.) from the client input file. Some validation and edits may have occurred to uppercase the data, remove special characters or other invalid data | ||||
BIRTH_DATE | Scrubbed version of Birth Date from the Client input file. Format: CCYYMMDD format | ||||
GENDER_CODE | Scrubbed gender (M, F, U) from the client input file. If blank or U on input, cR-CDI may attempt improve (U to M or F, blank to M, F or U) | ||||
PHONE | Scrubbed Phone Number which contains only numbers | ||||
EMAIL | Email address from the client input file. Some validation and edits may have occurred to removed special characters or other invalid data, however no standardization occurred | ||||
CONTENT_ALERT_NAME_FLAG | Flag to indicate if one or more of the parsed name fields (Input Name Prefix, Input First Name, Input Last Name, Input Middle Name, Input Generation Indicator, Input Name Appendage) contain words that match to the content alert list. | Y: One or more of the parsed name elements contains content alert words | |||
INVALID_PHONE_FLAG | Flag to indicate the validity of the input phone number | Y: Invalid US Phone Number | |||
INVALID_BIRTH_DATE_FLAG | Flag to indicate validity of the input birth date | Y: Invalid birth date | |||
INVALID_EMAIL_FLAG | Flag to indicate validity of the input email address | Y: Invalid emailN: Valid emailBlank: no email provided | |||
| 6 | ADDRESS | OBJECT | ADDRESS_LINE_1 | Parsed address line 1 from input address standardized based on USPS rules | |
ADDRESS_LINE_2 | Parsed address line 2 from input address standardized based on USPS rules | ||||
ADDRESS_LINE_3 | Parsed address line 3 from input address standardized based on USPS rules | ||||
CITY | Parsed US City from input address standardized based on USPS rules | ||||
CITY_ABBREVIATION | City abbreviation if it exists otherwise blan | ||||
STATE_PROVINCE_CODE | Parsed US State from input address standardized based on USPS rules | ||||
ZIP5 | Parsed US ZIP5 from input address standardized based on USPS rules | ||||
ZIP4 | Parsed US ZIP4 from input address standardized based on USPS rules | ||||
CONTENT_ALERT_ADDRESS_FLAG | Flag to indicate if one or more of the parsed address fields(Input Address 1 or Input Address 2 and Input City) contain words that match the content alert list. | Y: One or more of the parsed address elements contains content alert words | |||
| 7 | ADDRESS_LINE_ELEMENTS | OBJECT | PRIMARY_NUMBER | Parsed US Street Number from input address standardized based on USPS rules | |
PRE_DIRECTIONAL | Parsed US Pre-directional from input address standardized based on USPS rules. For example: East E, North N, South S, West W, Northeast NE, Northwest NW, etc. | ||||
STREET_NAME | Parsed US Street Name from input address standardized based on USPS rules | ||||
STREET_SUFFIX | Parsed US Street Suffix from input address standardized based on USPS rules. For example: Boulevard BLVD, By-pass BYPASS, Byway BYWAY, Center CTR, Chase CHASE, Circle CIR, Square SQ, Street ST, Subdivision SUBDIV, Terrace TERR, etc. | ||||
POST_DIRECTIONAL | Parsed US Post-directional from input address standardized based on USPS rules. For example: East E, North N, South S, West W, Northeast NE, Northwest NW, etc. | ||||
UNIT_DESIGNATOR | Parsed US Street Secondary Abbrev from input address standardized based on USPS rules. For example: Apartment APT, Suite SUITE, Unit UNIT. Non-Standard: Back BACK, Basement BSMT, Floor FLR, Front FRNT, Lobby LBBY | ||||
SECONDARY_NUMBER | Parsed US Street Secondary Number from input address standardized based on USPS rules. | ||||
PMB_DESIGNATOR | Abbreviation used for Commercial Mail Receiving agency box number. (Values: PMB (Private box number) or #) | ||||
PMB_NUMBER | Box number associated with the PMB (Private box number) | ||||
| 8 | ADDRESS_USPS | OBJECT | CARRIER_ROUTE | Carrier route code for standardized address. | |
DELIVERY_POINT | Delivery point 2 digit code required for generating a delivery point barcode and which when combined with the ZIP+4 code, the DPC creates a unique identifier for every address that can be delivered by the USPS. | ||||
DELIVERY_POINT_CHECK_DIGIT | The Check digit (calculated using the modulo 10 algorithm) used to verify if the USPS POSTNET barcode for the address is correct | ||||
ELOT_SEQUENCE_NUMBER | An Enhanced Line of Travel (eLOT) sequence number is a four-digit number that indicates the order in which a mail carrier delivers mail to a delivery point along a route. The United States Postal Service (USPS) manages eLOT numbers. | ||||
ELOT_SORTING_FLAG | Describes whether the Line of Travel is ascending or descending | ||||
STATE_FIPS_CODE | 2 digit FIPS (Federal Information Processing Standard) code of the state to which the county belongs as defined by US government associated to the input address. | 01 to 56 | |||
COUNTY_FIPS_CODE | 3 digit FIPS (Federal Information Processing Standard) code uniquely identifying the county and county equivalents associated to the input address, as defined by US government. | ||||
LACS_INDICATOR | Flag that indicates that the input address matched to the Locatable Address Conversion System (LACS) database maintained by USPS. The LACS was developed to help emergency services – such as paramedics, fire, and police – identify address locations as quickly and accurately as possible. It converts non-specific rural addresses (e.g., Rural Route 7, Box 52), to street addresses. Towns and counties use the LACS to make these address changes and supply the local post office with a list of address conversions. This information is then given to the USPS, creating a LACS database. | L: Address matched to a ZIP + 4 record with a LACS indicatorBlank: Address did not matched to a ZIP + 4 record with a LACS | |||
LOCATION_TYPE | Code indicating the type of address as identified by USPS | S:StreetH: High-riseP: PO BoxR: Rural RouteF: FirmG: General Delivery | |||
CMRA_CONFIRMATION_INDICATOR | Flag that indicates if the input address is a Commercial Mail Receiving Agency (CMRA). A Commercial Mail Receiving Agency (CMRA) is a private business that rents Private Mail Boxes (PMBs) to customers and accepts mail from the United States Postal Service for distribution to their customers. | Y:Address was found in CMRA table.N: Address was not found in CMRA table.
Blank: Address not presented to hash table. | |||
DPV_CONFIRMATION_INDICATOR | A Delivery Point Validation (DPV) confirmation indicator that tells you if the input address is deliverable by the United States Postal Service (USPS). | Y: Address was DPV confirmed for both primary and (if present) secondary numbers.D: Address was DPV confirmed for the primary number only, the secondary number information was missing.S: Address was DPV confirmed for the primary number only, the secondary number information was present but unconfirmed.N: Both primary and (if present) secondary number information failed confirmation.
Blank: Address was not presented to the database | |||
DPV_DELIVERABILITY_INDICATOR | Flag indicating deliverability | See Deliverability Indicator | |||
DPV_FALSE_POSITIVE_INDICATOR | Flag indicating if the input address is a non-existent address and should not be used for mailing purposes, even though it may be identified as deliverable by the USPS Delivery Point Validation (DPV) system. | Y: Address was found in False Positive table.
N: Address was not found in False Positive table.Blank: Address not presented to hash table. | |||
DPV_FOOTNOTE_1 | Zip+4 level Delivery Point Validation (DPV) result of the input address | AA: Input address matched to the ZIP+4 file.A1: Input address did not match to the ZIP+4 file.Null: The address was not presented to the DPV process or DPV data was not loaded | |||
DPV_FOOTNOTE_2 | Code indicating specific additional details about the input address' denoting the deliverability of the address according to USPS' Delivery Point Validation (DPV) process | See DPV Footnote 2 Codes | |||
DPV_FOOTNOTE_3 | Two-character code that determines if an address is part of a Commercial Mail Receiving Agency (CMRA) and if DPV processing changed the PMB information | RR: The input address is a CMRA, and the PMB indicator matches the reference data.R1 The input address is a CMRA, and DPV processing changed the PMB indicatorNULL: The input address does not identify a CMRA. | |||
LACSLINK_INDICATOR | Flag to indicate if the input address matched to the USPS's Locatable Address Conversion System (LACS) Link database. Use this flag to identify if the input address was converted to a rural address for which the USPS has created an urban version. | Y: Address found in LACSLink database.N: Address was looked up in LASCLink database but was not converted or no match found.F: The address is a false positive addressS: A LACSLink conversion was made, but it was necessary to drop the secondary information.Blank: No LACSLink lookup was attempted. | |||
LACSLINK_RETURN_CODE | A postal service code corresponding to the LACS indicator indicating whether the input address successfully matched to a rural address and was converted to an urban style street address based on local 911 system updates by USPS. | A: LACS Record Match - The United States address reference data provides an urban form of the address.00: No Match - The United States address reference data does not provide an urban form of the address.14: The United States address reference recognizes the address as convertible to an urban form, but it cannot provide the urban form of the address.92: The input address matches an address in the address reference data, but the input address contains a secondary number and the reference address does not.Blank: The input address was not passed to the LACS reference database. | |||
SUITELINK_RETURN_CODE | A numeric code generated by a US addressing system, specifically the SuiteLink feature, which indicates the result of a lookup process to verify and potentially enhance an address by identifying missing or incorrect information, like suite numbers, and returning a standardized address based on USPS data | 00: The address does not match an address in the Suitelink reference dataA: The address matches an address in the Suitelink reference data.Blank: The address was not passed to the Suitelink reference data. | |||
DSF2_DELIVERY_TYPE | A code generated by USPS' Delivery Sequence File (DSF2) process to identify the type of delivery that USPS makes at the address. | 1: Curb - A delivery point with a mail receptacle located at the curb2: NDCBU - A delivery point that is serviced by cluster boxes, also known as Neighborhood Delivery and Collection Box Units (NDCBU) assigned to a bank of boxes or floors3: Central - A delivery point within a building that has two or more ZIP+4 codes4: Door slot - A delivery point serviced by something other than Curb, NDCBU or Central DeliveryBlank: Non-match to DSF2 | |||
DSF2_NO_STATS_INDICATOR | Flag to flag input addresses that may considered valid by USPS but not currently receiving mail delivery, indicating the address is likely vacant, has no established delivery point yet due to new constructions, or receives mail as part of a group drop | Y: Indicates the address is listed in the USPS "No Stats" table, meaning mail is not delivered there and the address is not counted as a possible delivery point.N: Indicates the address is not listed in the "No Stats" table, meaning it is considered a potentially deliverable address.
Blank: Address was not checked against the "No Stats" table | |||
DSF2_BUSINESS_INDICATOR | Indicates if the input address is a business address | Y: Is a business address.N: Not a business address.Blank: Address was not matched against the DSF tables. | |||
DSF2_DROP_POINT_INDICATOR | Indicates if the input address is a drop site that that serving multiple families or businesses. | Y: Delivery point is a drop siteN: Delivery point is not a drop siteBlank: Non-match to DSF² | |||
DSF2_DROP_POINT_COUNT | The number of potential businesses or families that are served at a drop site. The DSF2 drop count can be used to eliminate bad address records from mailings. | ||||
DSF2_THROWBACK_INDICATOR | A flag that indicates that the mail will be delivered to a customer's PO Box although the input address is a street address. | Y: PO Box Delivery - The address associated with this delivery point is a street address, but delivery is made to the customer's PO Box address.N :Not a throwback addressBlank: Non-match to DSF2 | |||
DSF2_SEASONAL_INDICATOR | Indicates if the mailing address is occupied seasonally | Y: Seasonal addressN: Not a seasonal addressBlank: Non-match to DSF2 | |||
DSF2_VACANT_INDICATOR | Indicates if the mailing address is vacant for more than 90 days | Y: Location has been vacant for 90+ daysN: Not a vacant addressBlank: Non-match to DSF2 | |||
DSF2_EDUCATIONAL_INDICATOR | Indicates whether the input address is associated with an educational institution (such as colleges or universities, dormitories, sorority or fraternity houses, apartment buildings used primarily by students) and experiences seasonal fluctuations in occupancy, typically meaning the address is primarily occupied during the academic year and largely vacant during breaks like summer vacation | Y: Address is an educational facility.N: Address is not an educational facility.
Blank: Address not presented to hash table. | |||
DSF2_ADDRESS_TYPE | Indicates what type the input mailing address is as per USPS' Delivery Sequence File (DSF2) process | R: ResidentialB : BusinessG : General DeliveryU : Undetermined AddressBlank: No match to DSF2 file | |||
NCOA_EFFECTIVE_DATE | Date associated to the move, as recorded with USPS by the customer | YYYYMM | |||
NCOA_MOVE_TYPE | Move type filed by the customer with USPS | USPS requires different match criteria be used for each of the following move typesB: BusinessF: FamilyI: IndividualR: Residential | |||
NCOA_MOVE_CODE | USPS NCOA Link Return Codes provides additional information about the move / change of address | See NCOA Move Codes | |||
ZIP5_MATCH_RESULTS_CODE | Flag indicating the result of the zip5 code level address validation | A: Zip Code CorrectedB: Blank or Insufficient AddressC: Zip Code ConfirmedH: House / Apartment MismatchL: Locality Not FoundM: Multiple MatchesS: Street MismatchU: UnknownZ: Zip Code Not Found | |||
ZIP4_MATCH_RESULTS_CODE | Flag indicating the result of the zip+4 code level address validation | A: Zip+4 Code AppliedB: Blank or Insufficient AddressE: Early WarningH: House / Apartment MismatchL: No Locality FoundM: Multiple MatchesS: No Match for StreetZ: Input Zip Code Not Found |