2.1 Input Fields for Individual Screening
This section lists the REST input fields used when screening individuals via the real-time process. Ten input attributes are available for the individual screening process. They are available for any additional inputs required by your screening process.
Table 2-1 Input fields for Individual screening
Field | ExpectedData Format | Attribute Requirement | Maximum Character Length | Field Name and Description |
---|---|---|---|---|
Jurisdiction |
String | Mandatory | 4 |
Jurisdiction: This field enables your firm to restrict access using geographic locations. You can only see cases that are assigned to the same jurisdictions. Note: This is the metadata which admin has to configure in ECM
|
Business Domain |
String | Mandatory | 1 |
Business Domain: This field layer enables your firm to restrict access along operational business lines and practices. You can only see cases that are assigned to at least one of the same business domains. Note: This is the metadata which admin has to configure in ECM
|
GivenNames |
String | Mandatory | 255 |
Given Names: The individual matching process is based primarily on the name supplied for the individual. |
FamilyName |
String | Mandatory | 255 |
Family Names: The individual matching process is based primarily on the name supplied for the individual. |
DateOfBirth |
String, representing a date, in the format YYYYMMDD or YYYY-MM-DD; day, month and year are required. |
Recommended | 8 |
Date of Birth: Birth date information can be used in matching to identify particularly strong matches,or to eliminate matches that are too weak. |
City |
String | Recommended | No restriction |
City: City data is used to strengthen potential match information. |
AddressCountryCode |
String | Recommended | No restriction |
Address Country: Address country data is used to strengthen potential match information. Note: This is the user input. The value is used to screen against watchlist. Ideally this field will be the country code of the Individual being screened. |
ResidencyCountryCode |
String | Recommended | No restriction |
Residency Country: The country of residence can be used in optional country prohibition screening. Note: This is the user input. The value is used to screen against watchlist. Ideally this field will be the country code of the Individual being screened. |
CountryOfBirthCode |
String | Recommended | No restriction |
Country of Birth and Nationalities: The country of birth and nationality can be used in optional country prohibition screening. Note: This is the user input. The value is used it to screen against Watchlist. Ideally this field will be the birth country code or nationality code of the Individual being screened. |
NationalityCountryCodes |
String | Recommended | No restriction | |
ExternaIdType |
String | Recommended | No restriction |
External ID Type: The external ID type of the individual. Note: This is the metadata that admin can con- figure in KDD_CODE_SET_TRNLN table (CODE_DISP_TXcolumn). |
External Id |
String | Mandatory if externalID type field is selected | No restriction |
External ID: External identification number that contains unique record identifier. |
IdentificationNumbers |
String | Recommended | No restriction |
IdentificationNumber: Social Security Number or any Unique Identification Number, which is issued to the individual. |
Original ScriptName |
String | Recommended | No restriction |
Original Script Name: The name of the individual in native writ- ten version or in native language. |
Passport IssuingCountry |
String | Recommended | No restriction |
Passport Issuing Country: Name of the country where passport is issued. |
Passport Number |
String | Recommended | No restriction |
Passport Number: The unique, identifying number that is on the passport. |
SourceRequestID |
String | Optional | 3000 |
Source Request ID: The source request Id can be used to provide the customer ID while screening. |
FullName |
String | Optional | No restriction |
Full Name: Full name of the individual. Combination of given name and family name. |
YearOfBirth |
String | Optional | 4 |
YearofBirth: Birth year of the individual. |
Action |
String | - | - | Action parameter is added internally to differentiate between Scan and Scan & Investigate |