Input and output data
Input entity data
Input data relates to the individual or organization being screened for sanctions or existence on PEP lists. The Business Process uses this data as input for screening.
Various screening systems may need different fields. For example, Dow Jones only requires value from input_full_name.
Remember to provide the data as a CSV file.
Note that the model only works if your input data includes mandatory parameters. See the corresponding column in the table below.
| Field | Description | Type | Mandatory | Example |
|---|---|---|---|---|
input_id | Customer service id | String | No | 1111 |
input_record_type | Record (search) type: individual, business, aircraft, vessel, etc. | String | No | Person |
input_first_name | First name of the person | String | No | Mustafa |
input_last_name | Last name of the person | String | No | Mohamed |
input_dob | Date of Birth of the Person | Date | No | 10/26/1981 (MM/DD/YYYY) |
input_e_dor | Entity's Date of registration | Date | No | 10/26/1981 (MM/DD/YYYY) |
input_citizenship | Citizenship of the Input Data for Person | String | No | Amman, Jordan |
input_residential | Residential of the Input Data for Person | String | No | Amman, Jordan |
input_e_country_registration | Country of business incorporation for Entities (like first registration country) | String | No | Amman, Jordan |
input_gender | Gender of the Input Entity Data in case it is an Individual | String | No | MALE |
input_documents | List of the identifying documents of the Entity Input Data: Consist of:
Documents are separated by comma ',' |
|
| Passport No. 43019941, DriverLisence No. 121212 |
gold_true_positives_in_alert | Optional field needed only for decision model validation by gold data files. This is alert_id by external SS system which is a true positive alert for this name. All other alerts received in search results aren't true. | String | No | 34456545 |
gold_need_escalate_in_alert | Optional field needed only for decision model validation by gold data files. This is alert_id by external SS system which is needed to be escalated for the additional review. | String | No | 2313245 |
Alert data
Data that comes from systems like DJ.
| Field | Description | Type | Example |
|---|---|---|---|
alert_id | Id of the sanctioned or high risk or politically exposed individual alert. | String | 1362545 |
alert_primary_name | Main name of person provided by the screening system. | String | Qasim Al-Rimi |
alert_matched_name | Party name from sanctions or PEP list detected as a potential match by the screening software. | String | Qasim Al-Rimi |
alert_matched_name_type | Type of name field that was matched. | String | Primary Name |
alert_record_type | Record type of the sanctioned or high risk or politically exposed individual. Supported Values: Person, Entity | String | Person |
alert_matched_type | Type of match achieved. Valid values: · precise · near · broad | String | PRECISE |
alert_risk_icon | Sanction type of the sanctioned or high risk or politically exposed individual alert. | String | SAN |
alert_country_code | Country code associated with the profile. | String | JORDAN / NOTK (not known, unknown) |
alert_p_dob | Person's Birthdate(s) of the sanctioned or high risk or politically exposed individual. Can be not full date. | Date | 06/15/1978, 06/14/1978 (MM/DD/YYYY)09/?/1994, ?/?/1944 |
alert_e_dor | Entity's Date of registration. Can be not full date. | Date | 06/15/1990, 09/?/1994, ?/?/1944 |
alert_p_country_citizenship | Citizenship Country of the sanctioned or high risk or politically exposed individual alert. | String | Yemen / NOTK (not known, unknown) |
alert_p_country_residential | Residential Country of the sanctioned or high risk or politically exposed individual alert. | String | Yemen / NOTK (not known, unknown) |
alert_e_country_registration | Country of Registration of the sanctioned or high risk or politically exposed individual alert. | String | Yemen |
alert_e_country_current_ownership | Country of Current Ownership of the sanctioned or high risk or politically exposed individual alert. | String | Yemen |
alert_e_country_code_past_ownership | Country Code of Past Ownership of the sanctioned or high risk or politically exposed individual alert. | String | YE |
alert_e_country_code_affiliation | Country of Affiliation of the sanctioned or high risk or politically exposed individual alert. | String | YE |
alert_p_gender | Gender of the individual | String | Male |
alert_score | Score of the sanctioned or high risk or politically exposed individual alert. | String | 0..1 |
alert_update_date | Alert latest revision date. | Timestamp | 2018-08-14 07:13:33.230 |
alert_search_date | Current search date | Timestamp | 2020-05-05 07:13:33.230 |
alert_documents | List of documents of the sanctioned or high risk or politically exposed individual alert separated | Strings | Passport No. 520951, Passport No. 530951 |
alert_p_place_of_birth | List of the possible Places of Birth of the sanctioned or high risk or politically exposed individual alert separated | String | Village de Rayma, Yemen |
alert_p_images | Links to images of the sanctioned or high risk or politically exposed individual alert separated. | String | https://web.site/img/image.jpg |
alert_sanctions_list | Information about sanctions List of the sanctioned or high risk or politically exposed individual alert separated. Contains Provider, Status, Name | String | Provider: Office of Foreign Assets Control, Department of the Treasury, Status: Suspended, Name: OFAC - Specially Designated Terrorist List |
alert_associations | Information about Relatives of the sanctioned or high risk or politically exposed individual alert separated. | String | peid: 40406, Relationship: Stepmother, Ex: false, Description: [Relative or Close Associate (RCA), ] |
Output data
The output data comes from the screening system.
The Name Screening Alert Review matches the inputs and tries to ascertain whether the generated hit is:
- A true positive, or
- One of the many false positives that are generated, or
- Not enough information is provided.
Output data consists of:
- The Input data that the business process receives.
- Mandatory data used by the decision model and doesn't depend on a sanctions screening system.
- Additional data provided by each particular sanctions screening system.
- Resolution data consists of resolution for input and hit and manual review results.
The Mandatory column contains parameters that the screening system always gives back in the tables below. If a parameter is not mandatory but appears in any hit, this parameter is shown in the data.
| Field | Description | Type | Column Required | Data Required | Example |
|---|---|---|---|---|---|
input_id | Customer service id | String | Yes | Yes | |
input_record_type | Record (search) type: Person Entity (org) All | Enum | Yes | Yes | Person |
input_first_name | First name of Person, or Entity name | String | Yes | Yes | Kasim |
input_last_name | Last name of Person | String | Yes | No | Rimsevi |
input_dob | Date of Birth of the Person | Date | Yes | No | 10/26/1981 (MM/DD/YYYY) |
input_e_dor | Entity's Date of registration | Date | Yes | No | 10/26/1981 (MM/DD/YYYY) |
input_gender | Gender of the Input Entity Data in case it is an Individual | String | Yes | No | MALE |
input_citizenship | Citizenship of the Input Data for Person | String | Yes | No | Amman, Jordan |
input_residential | Residential of the Input Data for Person | String | Yes | No | Amman, Jordan |
| input_e_country_registration | Country of business incorporation for Entities (like first registration country) | String | Yes | No | Amman, Jordan |
| input_documents | List of the identifying documents of the Entity Input Data: Consist of: input_document_type: Passport No, National ID etc - in case of individual LEI/EIN in case of an organization input_document_id Documents separated by comma ',' | String | Yes | No | Passport No. 43019941, DriverLisence No. 121212 |
| gold_true_positives_in_alert | Optional field needed only for decision model validation by gold data files. This is alert_id by external SS system which is a true positive alert for this name. All other alerts received in search results aren't true. | String | No | No | 34456545 |
| gold_need_escalate_in_alert | optional field needed only for decision model validation by gold data files. This is alert_id by external SS system which is needed to be escalated for the additional review. | String | No | No | 2313245 |
| alert_id | Id of the sanctioned or high risk or politically exposed individual alert. | String | Yes | Yes | 1362545 |
| alert_record_type | record type of the sanctioned or high risk or politically exposed individual. Supported Values: Person Entity | String | Yes | Yes | Person |
| alert_primary_name | Main name of person provided by the screening system. | String | Yes | Yes | Qasim Al-Rimi |
| alert_p_dob | Person's Birthdate(s) of the sanctioned or high risk or politically exposed individual. Can be not full date. | Date | Yes | No | 06/15/1978, 06/14/1978 (MM/DD/YYYY), 09/?/1994, ?/?/1944 |
| alert_e_dor | Entity's Date of registration. Can be not full date. | Date | Yes | No | 06/15/1990, 09/?/1994, ?/?/1944 |
| alert_p_gender | Gender of the individual | String | Yes | No | Male |
| alert_p_country_residential | Residential Country of the sanctioned or high risk or politically exposed individual alert. | String | Yes | No | Yemen / NOTK (not known, unknown) |
| alert_p_country_citizenship | Citizenship Country of the sanctioned or high risk or politically exposed individual alert. | String | Yes | No | Yemen / NOTK (not known, unknown) |
| alert_e_country_registration | Country of Registration of the sanctioned or high risk or politically exposed individual alert. | String | Yes | No | Yemen |
| alert_documents | List of documents of the sanctioned or high risk or politically exposed individual alert separated | Strings | Yes | No | Passport No. 520951, Passport No. 530951 |
| alert_* | All other alert data (alert_score, alert_p_place_of_birth, alert_e_country_current_ownership, and so on) | String | No | No | |
| resolution_match_name | Factor for the decision matrix. If alert.name is match with input.name, = true. | boolean | Yes | Yes | TRUE / FALSE |
| resolution_match_dob | Factor for the decision matrix. If alert.dob is match with input.dob, = true. | boolean | Yes | No | TRUE / FALSE |
| resolution_match_dor | Factor for the decision matrix. If alert.dor is match with input.dor, = true. | boolean | Yes | No | TRUE / FALSE |
| resolution_match_gender | Factor for the decision matrix. If alert.gender is match with input.gender, = true. | boolean | Yes | No | TRUE / FALSE |
| resolution_match_citizenship | Factor for the decision matrix. If alert.citizenship is match with input.citizenship, = true. | boolean | Yes | No | TRUE / FALSE |
| resolution_match_residential | Factor for the decision matrix. If alert.residential is match with input.residential, = true. | boolean | Yes | No | TRUE / FALSE |
| resolution_match_country_registration | Factor for the decision matrix. If alert.country_registration is match with input.country_registration, = true. | boolean | Yes | No | TRUE / FALSE |
| resolution_match_documents | Factor for the decision matrix. If one of alert.document is match with one of input.document, = true. | boolean | Yes | Yes | TRUE / FALSE |
| resolution_matrix_decision | FALSE_POSITIVE, TRUE_POSITIVE, MORE_INFORMATION_NEEDED | Enum | Yes | Yes | FALSE_POSITIVE |
| resolution_description | Id of matrix row | String | Yes | Yes | 01 |
| resolution_matrix_row | Matching Rule result | binary string | Yes | Yes | 0100110 |
| resolution_review_decision | FALSE_POSITIVE, TRUE_POSITIVE, MORE_INFORMATION_NEEDED | Enum | Yes | No | FALSE_POSITIVE |
| resolution_review_status | TO_REVIEW, REVIEWED, SKIPPED | Enum | Yes | No | TO_REVIEW |
| resolution_gold | FALSE_POSITIVE, TRUE_POSITIVE, MORE_INFORMATION_NEEDED | Enum | No | Yes | FALSE_POSITIVE |
| resolution_correct | Is it a correct decision in comparison with the 'resolution_matrix_decision'? | boolean | No | Yes | TRUE / FALSE |
| resolution_missed_true_alert | Is it a missed true alert in accordance with the gold data file? 1 of yes, it's missed true alert. | int | No | Yes | 0 1 |
Extend input and hit data
The NSS prepackaged ML Model can work with the fixed amount of data. In this case, the ML Model is enriched with new features on the customer's side, while our BP Java part supports any amount of additional fields for input and hits.
To make everything work together, put the _extdata postfix to input and hit data, for instance, input_haircolor_extdata and hit_haircolor_extdata on the hit side. Mind that the middle part of these new variables is the same.
The extended data will be transferred to the model document as entHaircolor and wleHaircolor.
A MLE engineer is responsible for giving these parameters back to the model response document.