Skip to main content
Version: 1.0

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.

info

Note that the model only works if your input data includes mandatory parameters. See the corresponding column in the table below.

FieldDescriptionTypeMandatoryExample
input_idCustomer service idStringNo1111
input_record_typeRecord (search) type: individual, business, aircraft, vessel, etc.StringNoPerson
input_first_nameFirst name of the personStringNoMustafa
input_last_nameLast name of the personStringNoMohamed
input_dobDate of Birth of the PersonDateNo10/26/1981 (MM/DD/YYYY)
input_e_dorEntity's Date of registrationDateNo10/26/1981 (MM/DD/YYYY)
input_citizenshipCitizenship of the Input Data for PersonStringNoAmman, Jordan
input_residentialResidential of the Input Data for PersonStringNoAmman, Jordan
input_e_country_registrationCountry of business incorporation for Entities (like first registration country)StringNoAmman, Jordan
input_genderGender of the Input Entity Data in case it is an IndividualStringNoMALE
input_documentsList 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 are separated by comma ','

  • List
  • String
  • String
  • No
  • No
  • No
Passport No. 43019941, DriverLisence No. 121212
gold_true_positives_in_alertOptional 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.StringNo34456545
gold_need_escalate_in_alertOptional 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.StringNo2313245

Alert data

Data that comes from systems like DJ.

FieldDescriptionTypeExample
alert_idId of the sanctioned or high risk or politically exposed individual alert.String1362545
alert_primary_nameMain name of person provided by the screening system.StringQasim Al-Rimi
alert_matched_nameParty name from sanctions or PEP list detected as a potential match by the screening software.StringQasim Al-Rimi
alert_matched_name_typeType of name field that was matched.StringPrimary Name
alert_record_typeRecord type of the sanctioned or high risk or politically exposed individual. Supported Values: Person, EntityStringPerson
alert_matched_typeType of match achieved. Valid values: · precise · near · broadStringPRECISE
alert_risk_iconSanction type of the sanctioned or high risk or politically exposed individual alert.StringSAN
alert_country_codeCountry code associated with the profile.StringJORDAN / NOTK (not known, unknown)
alert_p_dobPerson's Birthdate(s) of the sanctioned or high risk or politically exposed individual. Can be not full date.Date06/15/1978, 06/14/1978 (MM/DD/YYYY)09/?/1994, ?/?/1944
alert_e_dorEntity's Date of registration. Can be not full date.Date06/15/1990, 09/?/1994, ?/?/1944
alert_p_country_citizenshipCitizenship Country of the sanctioned or high risk or politically exposed individual alert.StringYemen / NOTK (not known, unknown)
alert_p_country_residentialResidential Country of the sanctioned or high risk or politically exposed individual alert.StringYemen / NOTK (not known, unknown)
alert_e_country_registrationCountry of Registration of the sanctioned or high risk or politically exposed individual alert.StringYemen
alert_e_country_current_ownershipCountry of Current Ownership of the sanctioned or high risk or politically exposed individual alert.StringYemen
alert_e_country_code_past_ownershipCountry Code of Past Ownership of the sanctioned or high risk or politically exposed individual alert.StringYE
alert_e_country_code_affiliationCountry of Affiliation of the sanctioned or high risk or politically exposed individual alert.StringYE
alert_p_genderGender of the individualStringMale
alert_scoreScore of the sanctioned or high risk or politically exposed individual alert.String0..1
alert_update_dateAlert latest revision date.Timestamp2018-08-14 07:13:33.230
alert_search_dateCurrent search dateTimestamp2020-05-05 07:13:33.230
alert_documentsList of documents of the sanctioned or high risk or politically exposed individual alert separatedStringsPassport No. 520951, Passport No. 530951
alert_p_place_of_birthList of the possible Places of Birth of the sanctioned or high risk or politically exposed individual alert separatedStringVillage de Rayma, Yemen
alert_p_imagesLinks to images of the sanctioned or high risk or politically exposed individual alert separated.Stringhttps://web.site/img/image.jpg
alert_sanctions_listInformation about sanctions List of the sanctioned or high risk or politically exposed individual alert separated. Contains Provider, Status, NameStringProvider: Office of Foreign Assets Control, Department of the Treasury, Status: Suspended, Name: OFAC - Specially Designated Terrorist List
alert_associationsInformation about Relatives of the sanctioned or high risk or politically exposed individual alert separated.Stringpeid: 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.

FieldDescriptionTypeColumn RequiredData RequiredExample
input_idCustomer service idStringYesYes
input_record_typeRecord (search) type: Person Entity (org) AllEnumYesYesPerson
input_first_nameFirst name of Person, or Entity nameStringYesYesKasim
input_last_nameLast name of PersonStringYesNoRimsevi
input_dobDate of Birth of the PersonDateYesNo10/26/1981 (MM/DD/YYYY)
input_e_dorEntity's Date of registrationDateYesNo10/26/1981 (MM/DD/YYYY)
input_genderGender of the Input Entity Data in case it is an IndividualStringYesNoMALE
input_citizenshipCitizenship of the Input Data for PersonStringYesNoAmman, Jordan
input_residentialResidential of the Input Data for PersonStringYesNoAmman, Jordan
input_e_country_registrationCountry of business incorporation for Entities (like first registration country)StringYesNoAmman, Jordan
input_documentsList 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 ','StringYesNoPassport No. 43019941, DriverLisence No. 121212
gold_true_positives_in_alertOptional 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.StringNoNo34456545
gold_need_escalate_in_alertoptional 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.StringNoNo2313245
alert_idId of the sanctioned or high risk or politically exposed individual alert.StringYesYes1362545
alert_record_typerecord type of the sanctioned or high risk or politically exposed individual. Supported Values: Person EntityStringYesYesPerson
alert_primary_nameMain name of person provided by the screening system.StringYesYesQasim Al-Rimi
alert_p_dobPerson's Birthdate(s) of the sanctioned or high risk or politically exposed individual. Can be not full date.DateYesNo06/15/1978, 06/14/1978 (MM/DD/YYYY), 09/?/1994, ?/?/1944
alert_e_dorEntity's Date of registration. Can be not full date.DateYesNo06/15/1990, 09/?/1994, ?/?/1944
alert_p_genderGender of the individualStringYesNoMale
alert_p_country_residentialResidential Country of the sanctioned or high risk or politically exposed individual alert.StringYesNoYemen / NOTK (not known, unknown)
alert_p_country_citizenshipCitizenship Country of the sanctioned or high risk or politically exposed individual alert.StringYesNoYemen / NOTK (not known, unknown)
alert_e_country_registrationCountry of Registration of the sanctioned or high risk or politically exposed individual alert.StringYesNoYemen
alert_documentsList of documents of the sanctioned or high risk or politically exposed individual alert separatedStringsYesNoPassport 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)StringNoNo
resolution_match_nameFactor for the decision matrix. If alert.name is match with input.name, = true.booleanYesYesTRUE / FALSE
resolution_match_dobFactor for the decision matrix. If alert.dob is match with input.dob, = true.booleanYesNoTRUE / FALSE
resolution_match_dorFactor for the decision matrix. If alert.dor is match with input.dor, = true.booleanYesNoTRUE / FALSE
resolution_match_genderFactor for the decision matrix. If alert.gender is match with input.gender, = true.booleanYesNoTRUE / FALSE
resolution_match_citizenshipFactor for the decision matrix. If alert.citizenship is match with input.citizenship, = true.booleanYesNoTRUE / FALSE
resolution_match_residentialFactor for the decision matrix. If alert.residential is match with input.residential, = true.booleanYesNoTRUE / FALSE
resolution_match_country_registrationFactor for the decision matrix. If alert.country_registration is match with input.country_registration, = true.booleanYesNoTRUE / FALSE
resolution_match_documentsFactor for the decision matrix. If one of alert.document is match with one of input.document, = true.booleanYesYesTRUE / FALSE
resolution_matrix_decisionFALSE_POSITIVE, TRUE_POSITIVE, MORE_INFORMATION_NEEDEDEnumYesYesFALSE_POSITIVE
resolution_descriptionId of matrix rowStringYesYes01
resolution_matrix_rowMatching Rule resultbinary stringYesYes0100110
resolution_review_decisionFALSE_POSITIVE, TRUE_POSITIVE, MORE_INFORMATION_NEEDEDEnumYesNoFALSE_POSITIVE
resolution_review_statusTO_REVIEW, REVIEWED, SKIPPEDEnumYesNoTO_REVIEW
resolution_goldFALSE_POSITIVE, TRUE_POSITIVE, MORE_INFORMATION_NEEDEDEnumNoYesFALSE_POSITIVE
resolution_correctIs it a correct decision in comparison with the 'resolution_matrix_decision'?booleanNoYesTRUE / FALSE
resolution_missed_true_alertIs it a missed true alert in accordance with the gold data file? 1 of yes, it's missed true alert.intNoYes0 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.