Match app data input

Personal data inputs

When you are ready to submit your PII data to dentsu.Composable Match app, you will need to populate the <APPLICATION_NAME>.APP_PUBLIC.INPUT table.
For details on how to populate this table, please review the "Populate the INPUT table" section of the Cleanse and Match data article.

FIELD ORDER FIELD NAME FIELD TYPE DESCRIPTION MUST 
BE 
POPULATED		 VALID 
VALUES MAX LENGTH
1 REQUEST_ID VARCHAR User defined unique identifier that defined for the batch or job submitted for processing.
All records in the batch set should have the same value. You will use this ID later to retrieve your output.		 YES   99
2 RECORD_ID VARCHAR User defined unique numeric / alphanumeric (must be uppercase) identifier for the record within your batch run. This field will be returned to you on output and will be what you can use to tie a specific output record(s) back to a specific input record. YES   20
3 COUNTRY_CODE VARCHAR The ISO 3166-1 alpha-2 country code where the address is located.
Populate this with US for all records, as the app only supports US data. All other records will be discarded.		 YES US 2
4 NAME_PREFIX VARCHAR Prefix for the individual such as Dr., Mr., Mrs. NO   15
5 FIRST_NAME VARCHAR First name of the individual NO   25
6 MIDDLE_NAME VARCHAR Middle name or Middle Initial of the individual NO   25
7 LAST_NAME VARCHAR Last name of the individual NO   25
8 GENERATION_QUALIFIER VARCHAR Used to distinguish persons who share the same name within a family (e.g. Junior, Senior, III, IV, etc.).  Helps in resolving edge cases during matching. NO   15
9 NAME_SUFFIX VARCHAR Title or other achievement/status denoted at the end of an individual's name. NO   15
10 FULL_NAME VARCHAR Full name of the individual NO   125
11 BIRTH_DATE VARCHAR Date of birth of the individual. Populate only if confident about the accuracy of DOB. Inaccurate DOB can do more harm than good.
A less precise but accurate DOB is acceptable (e.g., YYYYMM)
Date format: YYYYMMDD		 NO   8
12 GENDER VARCHAR M or F to indicate gender of the individual. Populate only if confident about the accuracy of gender. NO M, F, blank 1
13 ADDRESS_LINE_1 VARCHAR First line of street address of the individual NO   60
14 ADDRESS_LINE_2 VARCHAR Second line of street address of the individual, often apartment/unit number NO   60
15 ADDRESS_LINE_3 VARCHAR Third line of street address of the individual NO   60
16 CITY VARCHAR City of residence NO   30
17 STATE_PROVINCE_CODE VARCHAR

2 character abbreviation for state or province of residence. For the full list, refer to US State Abbreviations and
Canadian State Province codes
Populate the following abbreviations when processing postal data for the U.S Territories:

AS: American Samoa
GU: Guam

MP: Northern Mariana Islands
PR: Puerto Rico
VI: U.S. Virgin Islands

 NO   5
18 STATE_PROVINCE_NAME VARCHAR Spelled out State/Province Name NO   30
19 POSTAL_CODE VARCHAR U.S Postal ZIP-5 code

For Canadian postal code, use six-character uniformly structured, alphanumeric code in the format “ANA NAN” where “A” is an alphabetic character and “N” is a numeric)		 NO   7
20 PHONE VARCHAR

10-digit Phone number of the individual formatted without dashes or spaces.

  • U.S phone numbers: The first 3 digits represents the area code identifying a specific region in the US. The next seven digits represents the local phone number.
  • Canadian phone numbers: The first 3 digits represents the NPA (National Plan Area). The next seven digits represents the local phone number.
 NO   10
21 EMAIL_ADDRESS VARCHAR Properly formatted email address of the individual - including an '@' and a '.' ; raw/clear email only (NOT hashed).
Accuracy is key, as an incorrect email can negatively affect match quality.
If you have multiple emails tied to a single name and address record, select the most reliable one or
submit multiple records, keeping Name and Address the same but with distinct emails.		 NO   200


Requests

Requests

You will also need to populate the <APPLICATION_NAME>.APP_PUBLIC.REQUESTS  table. The app monitors this table and triggers processing when a new row is detected.

For details on how to populate this table, please review the "Populate the REQUESTS table" section of the Cleanse and Match data article.

FIELD ORDER FIELD NAME FIELD TYPE SUBFIELD
NAME		 DESCRIPTION REQUIRED MAX 
LENGTH/ OPTIONS
1 REQUEST_ID VARCHAR   Populate with the REQUEST_ID of the job you are submitting. YES 99
2 REQUEST_OPTIONS OBJECT See
REQUESTS PARAMETERS
for a full list of subfield
elements.		 Populate with any non-default runtime options for the job. The format of this field should be JSON with key/value pairs. (e.g., {"NCOA": "Y", "DSF2": "Y"}).
If you want to run with default options, you can leave this as null.		 YES  
3 DATE_CREATED TIMESTAMP   Populate with the currentdatetimestamp meant to track when the job was submitted YES  

 

Requests options

Runtime parameters are specific to each job, allowing customization of output and the specification of additional processing tasks, such as running USPS NCOA (National Change of Address), PAF (Postal Authorization Form) & DSF2 (Delivery Sequence File Second Generation). The table below lists all the available runtime parameters, their value formats, descriptions, and default settings.

You can select any combination of parameters that meet your needs; however, some parameters (noted below) require authorization. These authorizations must be handled during onboarding.

All runtime parameters are optional. If values are left blank, default values will be used.

Field name Key Value Example Description Required Options Default

REQUEST_OPTIONS

NCOA

VARCHAR

"NCOA": "Y"

"Y" will process input addresses through the USPS' NCOA process for direct mailing purposes. Bypass NCOA if primarily use cases are digital channels.
If address is absent in the input record, NCOA will be bypassed for that record, even if parameter is set to "Y" for the batch.
A minimum of 100 unique names and addresses are required in the input to run NCOA per USPS rules.
USPS PAF (Postal Authorization Form) Authorization needed at the time of client onboarding.

No

Y or N or blank

N

DSF2

VARCHAR

"DSF2": "Y"

Set this parameter to "Y" if processing data for direct mail use only. DSF2 specific fields will be populated in the hygiene output if set to "Y" for authorized users.

No

Y or N or blank

N

 

 

Related articles