3.2 Using Customer Screening GET RT Events Request
This REST API is used to get real-time events.
End Point Details
- HTTP Link - http://<hostname>:<port>/csxe-real-time/RTEvents/getForRequestId/{requestid}
- Method – GET
- Content Type - Application/JSON
Executing Customer Screening GET RT Events Request
To execute RT event request, see Executing Customer Screening GET RT Events Request.
Request JSON Parameters
| Parameter | Value Type | Description |
|---|---|---|
Request ID |
Integer | Request ID generated for an individual. |
Response JSON Parameters
| Parameter | Value Type | Description |
|---|---|---|
Event Score
|
Integer | The score of the event. |
Bus Domain |
String | The business domain name. (Mandatory) |
Jurisdiction |
String | Enter the jurisdiction name. |
Watchlist SKey |
Integer | Enter the key of the watchlist |
Watch ListJson |
String | Enter the watchlist information. |
Event
Matches |
Integer | Match Score: The matching score in case of match. |
| String | Search String: The string that is to be searched | |
| String | Matched Col Logical Name: The logical name of the column that is matched. | |
| String | Overall Score: The overall total score. | |
| String | Rule Name: Theg name of the rule used. | |
| String | Matched Value: The value that is matched. | |
| String | Matched Column: The column that is matched. | |
Case ID |
Integer | Enter the ID of case |
Request and Response JSON Samples
Request
Sample:
http://<hostname>:<port>/csxe-real-time/RTEvents/getForRequestId/117
Response
Sample:
[
[
{
"EventList": [
{
"eventScore": 95,
"busDomain": "GEN",
"jurisdiction": "AMEA",
"watchlistSkey": 2340267,
"watchlistJson": "{\"v_title\":\" \",\"v_full_name\":\"ENA ELIZABETH
HERNANDEZ AMAYA\",\"n_uid\":2340267,\"v_address_country_code\":\"HN\",\"v_wl_type\":\"PRV_WL1\",\"n_entity_registration_number\":\"
\",\"v_state\":\" \",\"v_identification_type\":\" \",\"v_city\":\"San Pedro Sula;Cortes\",\"v_further_information\":\"
\",\"v_identification_numbers\":\" \",\"v_given_name\":\"ENA ELIZABETH\",\"v_address\":\"
\",\"f_is_active\":\"Y\",\"v_entity_operating_country_codes\":\" \",\"n_wl_skey\":2340267,\"v_date_of_births\":\"1978-09-03;1978-01-01;\",\"v_identification_country\":\"
\",\"v_nationality\":\" \",\"v_jurisdiction_cd\":\"AMEA\",\"v_gender\":\" \",\"v_entity_name\":\"
\",\"v_aliases\":\"ANA ELIZABETH HERNANDEZ;ENA DE HANDAL;ENA ELIZABETH AMAYA;ENA
ELIZABETH HERNANDEZ\",\"v_passports\":\" \",\"d_load_date\":\" \",\"v_family_name\":\"HERNANDEZ
AMAYA\",\"n_riskscore\":\" \",\"v_wl_sub_type\":\"SAN\",\"v_postal_code\":\" \",\"v_residence\":\"
\",\"d_lastupdateddate\":\" \",\"v_entity_type\":\"I\",\"v_entity_sub_type\":\"SAN\",\"v_occupation\":\"
\",\"v_entity_registration_country_code\":\" \",\"v_passports_country\":\" \",\"v_country\":\"
\"}",
"eventMatches": [
{
"matchScore": 100,
"searchString": "Ena Elizabeth",
"matchedColLogicalName": "Given Names",
"overallScore": 95,
"ruleName": "First Name, Last Name, Date Of Birth, City,
Country",
"matchedValue": "ENA ELIZABETH",
"matchedColumn": "v_given_name"
},
{
"matchScore": 100,
"searchString": "HERNANDEZ AMAYA",
"matchedColLogicalName": "Family Name",
"overallScore": 95,
"ruleName": "First Name, Last Name, Date Of Birth, City,
Country",
"matchedValue": "HERNANDEZ AMAYA",
"matchedColumn": "v_family_name"
},
{
"matchScore": 100,
"searchString": "1978-09-03",
"matchedColLogicalName": "Date Of Birth",
"overallScore": 95,
"ruleName": "First Name, Last Name, Date Of Birth, City,
Country",
"matchedValue": "1978-09-03;1978-01-01;",
"matchedColumn": "v_date_of_births"
}
]
},
{
"eventScore": 95,
"busDomain": "GEN",
"jurisdiction": "AMEA",
"watchlistSkey": 1883,
"watchlistJson": "{\"v_title\":\"-0- \",\"v_alt_remarks\":\"
\",\"v_full_name\":\"HERNANDEZ AMAYA Ena Elizabeth\",\"v_remarks\":\"DOB 03 Sep 1978;
nationality Honduras; National ID No. 0501-1978-08173 (Honduras); Linked To: J &
E S. DE R.L. DE C.V.\",\"v_city_state_postalcode\":\"San Pedro Sula, Cortes\",\"v_vess_type\":\"-0-
\",\"v_grt\":\"-0- \",\"v_aliases_family_name\":\"DE HANDAL\",\"v_add_remarks\":\"-0-
\",\"v_sdn_name\":\"HERNANDEZ AMAYA, Ena Elizabeth\",\"n_add_num\":\"21357\",\"n_alt_num\":\"
\",\"v_program\":\"SDNTK\",\"v_identification_numbers\":\" \",\"v_alt_name\":\"DE
HANDAL, Ena\",\"f_sdn_fl\":\"Y\",\"v_max_yob\":\"1978\",\"v_address\":\"-0- \",\"v_call_sign\":\"-0-
\",\"v_nationality\":\" \",\"v_alt_type\":\"aka\",\"v_entity_name\":\" \",\"v_aliases\":\"DE
HANDAL, Ena\",\"d_load_date\":\"2021-05-21 12:42:45.0\",\"v_original_script_name\":\"
\",\"v_vess_owner\":\"-0- \",\"v_wl_sub_type\":\"SAN\",\"v_residence\":\" \",\"v_entity_name_bus_strip\":\"
\",\"v_occupation\":\" \",\"v_tonnage\":\"-0- \",\"n_uid\":13371,\"v_wl_type\":\"OFAC\",\"v_aliases_given_name\":\"Ena\",\"v_place_of_birth\":\"
\",\"v_city\":\" \",\"v_given_name\":\"Ena Elizabeth\",\"v_min_yob\":\"1978\",\"n_wl_skey\":1883,\"v_sdn_type\":\"individual\",\"v_date_of_births\":\"1978-09-03\",\"v_yob\":\"1978\",\"n_run_skey\":273,\"v_gender\":\"
\",\"v_passports\":\" \",\"v_ssn\":\" \",\"v_family_name\":\"HERNANDEZ AMAYA\",\"v_vess_flag\":\"-0-
\",\"v_entity_type\":\"I\",\"v_country\":\"Honduras\"}",
"eventMatches": [
{
"matchScore": 100,
"searchString": "HERNANDEZ AMAYA Ena Elizabeth",
"matchedColLogicalName": "Full Name",
"overallScore": 95,
"ruleName": "Full Name, Date Of Birth, City, Country",
"matchedValue": "HERNANDEZ AMAYA Ena Elizabeth",
"matchedColumn": "v_full_name"
},
{
"matchScore": 100,
"searchString": "1978-09-03",
"matchedColLogicalName": "Date Of Birth",
"overallScore": 95,
"ruleName": "Full Name, Date Of Birth, City, Country",
"matchedValue": "1978-09-03",
"matchedColumn": "v_date_of_births"
}
]
}
],
"CaseId": 418828
}
]
]