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
End Point Details - Version II
- HTTP Link - http://<hostname>:<port>/csxe-real-time/RTEvents/v2/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:
Sample API:
http://<hostname>:<port>/csxe-real-time/RTEvents/getForRequestId/117
[
[
{
"EventList": [
{
"eventScore": 90,
"busDomain": "GEN",
"jurisdiction": "AMEA",
"watchlistSkey": 4025902,
"watchlistJson": "{\"v_title\":\" \",\"v_vessel_tonnage\":\" \",\"v_full_name\":\"George Beattie\",\"v_deceased_date\":\" \",\"v_vessel_owner\":\" \",\"v_description2\":\"Other Official Lists\",\"v_id_type\":\"Others\",\"v_aliases_family_name\":\" \",\"v_url\":\" \",\"v_date\":\"1961-03-14;1984-07-14\",\"v_identification_numbers\":\" \",\"v_registration_date\":\" \",\"v_max_yob\":\"1961\",\"v_address\":\"21 Ladeside Drive,Kilsyth, Glasgow;Scotland;G65 0JW,United Kingdom;Woodburn House Auchenreoch,Milton of Campsie, Glasgow;Scotland;G66 8AN,United Kingdom;\",\"v_suffix\":\" \",\"v_id_value\":\"001244030002;233828250001;\",\"v_source_name\":\"http://wck2.companieshouse.gov.uk//dirsec;\",\"v_vessel_flag\":\" \",\"v_nationality\":\" \",\"v_deceased\":\"No\",\"v_inactive_date\":\" \",\"v_entity_name\":\" \",\"v_aliases\":\"Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;Abdelhamid Khamis ABDULLAH;Abdulhamid Khamis Abdullah;Hamid Khamis;Abdelhamid Khamis Ahmad Adballa;\",\"v_id_notes\":\"Personal number;Personal Number;\",\"v_cessation_date\":\" \",\"v_occupation_category\":\";\",\"v_original_script_name\":\"George Beattie\",\"v_profile_notes\":\"Watchlist ProfileNotes: Last Reviewed Date: 06-May-2024 Record Status: Active Comments: COMPANIES HOUSE NOTES: Disqualification start date: 20170621 Disqualification end date: 20240620 Reason/Section of the Act: CDDA 1986 S6 Disqualification start date: 20170504 Disqualification end date: 20240503 Reason/Section of the Act: CDDA 1986 S7 \",\"v_description3\":\" \",\"v_wl_sub_type\":\"EDD\",\"v_residence\":\"United Kingdom\",\"v_entity_name_bus_strip\":\" \",\"v_occupation\":\" \",\"v_date_notes\":\" \",\"n_uid\":11065235,\"v_country_type\":\"Citizenship;Resident of\",\"v_wl_type\":\"DJW\",\"v_addition_date\":\"2017-05-08\",\"v_aliases_given_name\":\" \",\"v_to_date1\":\" \",\"v_to_date2\":\"2024-05-03\",\"v_place_of_birth\":\" \",\"v_city\":\"Kilsyth, Glasgow;Scotland;G65 0JW;Milton of Campsie, Glasgow;Scotland;G66 8AN\",\"v_name_type\":\"Primary Name\",\"v_vessel_call_sign\":\" \",\"v_given_name\":\"George\",\"v_addressline\":\"21 Ladeside Drive;Woodburn House Auchenreoch\",\"v_name_sub_type\":\" \",\"v_min_yob\":\"1961\",\"n_wl_skey\":4025902,\"v_relationship\":\"Associate;\",\"v_date_of_births\":\"1961-03-14\",\"v_image\":\";\",\"v_is_ex\":\"No;\",\"v_country_type_country_name\":\"United Kingdom;United Kingdom\",\"v_yob\":\"1961\",\"n_run_skey\":457,\"v_role_type\":\" \",\"v_gender\":\"M\",\"v_active_status\":\"Active\",\"v_record_action\":\"chg\",\"v_passports\":\" \",\"v_ssn\":\" \",\"v_vessel_grt\":\" \",\"v_family_name\":\"Beattie\",\"v_last_reviewed_date\":\"2024-05-06\",\"v_related_person_entity_id\":\"11065238;\",\"v_date_type\":\"Date of Birth\",\"v_vessel_type\":\" \",\"v_sanction_list_reference\":\"Companies House (UK) Disqualified Directors;\",\"v_entity_type\":\"I\",\"v_since_date1\":\" \",\"v_since_date2\":\"2017-05-04;2017-06-21\",\"v_country\":\"United Kingdom;United Kingdom\"}",
"eventMatches": [
{
"matchScore": 100,
"searchString": "George",
"matchedColLogicalName": "Given Names",
"overallScore": 90,
"ruleName": "First Name, Last Name, Date Of Birth, City, Country",
"matchedValue": "George",
"matchedColumn": "v_given_name"
},
{
"matchScore": 100,
"searchString": "beattie",
"matchedColLogicalName": "Family Name",
"overallScore": 90,
"ruleName": "First Name, Last Name, Date Of Birth, City, Country",
"matchedValue": "Beattie",
"matchedColumn": "v_family_name"
}
],
"searchHyperlink": "http://www.google.co.uk/search?hl=en&q=$FULL_NAME$",
"indProfileHyperlink": "https://riskcenter.dowjones.com/profile?id=$N_UID$",
"entProfileHyperlink": "https://riskcenter.dowjones.com/profile?id=$N_UID$"
}
],
"CaseId": 5510
}
]
]Request and Response JSON Samples - Version II
Request Sample - Version II:
Sample API:
http://<hostname>:<port>/csxe-real-time/RTEvents/v2/getForRequestId/594
Response Sample - Version
II:
[
{
"EventList": [
{
"eventScore": 88.4,
"busDomain": "a",
"jurisdiction": "AMEA",
"watchlistSkey": 27856,
"watchlistJson": "{\"v_title\":\"-0- \",\"v_alt_remarks\":\" \",\"v_full_name\":\"BIN LADIN Usama bin Muhammad bin Awad\",\"v_citi_country\":\" \",\"v_remarks\":\"DOB 30 Jul 1957; alt. DOB 1958; POB Jeddah, Saudi Arabia; alt. POB Yemen.\",\"v_city_state_postalcode\":\"-0- \",\"v_vess_type\":\"-0- \",\"v_grt\":\"-0- \",\"v_aliases_family_name\":\"BIN LADIN;BIN LADEN;BIN LADEN;BIN LADIN;BIN LADIN\",\"v_add_remarks\":\"-0- \",\"v_sdn_name\":\"BIN LADIN, Usama bin Muhammad bin Awad\",\"n_add_num\":\"3872\",\"n_alt_num\":\" \",\"v_program\":\"SDGT\",\"watchlist_name_type\":\" \",\"v_identification_numbers\":\" \",\"v_alt_name\":\"BIN LADIN, Usama;BIN LADEN, Usama;BIN LADEN, Osama;BIN LADIN, Osama;BIN LADIN, Osama bin Muhammad bin Awad\",\"f_sdn_fl\":\"Y\",\"v_max_yob\":\"1958\",\"v_address\":\" 0 \",\"v_call_sign\":\"-0- \",\"v_nationality\":\" \",\"v_alt_type\":\"aka;aka;aka;aka;aka\",\"v_entity_name\":\" \",\"v_aliases\":\"BIN LADIN, Usama;BIN LADEN, Usama;BIN LADEN, Osama;BIN LADIN, Osama;BIN LADIN, Osama bin Muhammad bin Awad\",\"d_load_date\":\"2024-06-13 05:22:29.0\",\"v_original_script_name\":\" \",\"v_vess_owner\":\"-0- \",\"v_other_party_name\":\" \",\"v_wl_sub_type\":\"SAN\",\"v_residence\":\" \",\"v_entity_name_bus_strip\":\" \",\"v_occupation\":\" \",\"v_tonnage\":\"-0- \",\"n_uid\":6365,\"v_wl_type\":\"OFAC\",\"v_aliases_given_name\":\"Usama;Usama;Osama;Osama;Osama bin Muhammad bin Awad\",\"v_place_of_birth\":\" Yemen.\",\"v_city\":\"-- \",\"v_given_name\":\"Usama bin Muhammad bin Awad\",\"v_min_yob\":\"1957\",\"n_wl_skey\":27856,\"v_sdn_type\":\"individual\",\"v_date_of_births\":\"1957-07-30\",\"v_street\":\" \",\"v_yob\":\"1958;1957\",\"n_run_skey\":110,\"v_gender\":\" \",\"v_passports\":\" \",\"v_ssn\":\" \",\"v_family_name\":\"BIN LADIN\",\"v_town_of_birth\":\" \",\"v_vess_flag\":\"-0- \",\"v_entity_type\":\"I\",\"v_alias_city_of_birth\":\" \",\"v_country\":\" 0 \"}",
"eventMatches": [
{
"matchScore": 98,
"searchString": "Obama Laden",
"matchedColLogicalName": "Aliases",
"overallScore": 88.4,
"ruleName": "Full Name, Date Of Birth, City, Country",
"matchedValue": "BIN LADIN, Usama;BIN LADEN, Usama;BIN LADEN, Osama;BIN LADIN, Osama;BIN LADIN, Osama bin Muhammad bin Awad",
"matchedColumn": "v_aliases"
}
],
"searchHyperlink": "http://www.google.co.uk/search?hl=en&q=$FULL_NAME$",
"indProfileHyperlink": "",
"entProfileHyperlink": ""
}
],
"CaseId": 8230
},
{
"Candidate": [
{
"Identification Document": [
{
"Document Number": "",
"Document Type": "",
"Issuing Country": ""
}
],
"Date Of Birth": "",
"Address": [
{
"Postal Code": "",
"Street Line 1": "",
"State": "",
"Country": "",
"City": ""
}
],
"First Name": "Obama",
"Full Name": "Obama Laden",
"Title": "",
"Candidate ID": 583,
"Middle Name": "",
"Gender": "",
"Source Request ID": "",
"Year Of Birth": 0,
"Applicant ID": "CSRT_583",
"Business Domain": "a",
"searchWithCase": true,
"SSN/TIN": "",
"Primary Citizenship": [],
"Country Of Residence": [],
"Alias": [],
"Candidate Type": "IND",
"Existing Internal ID": "",
"Candidate Jurisdiction": "AMEA",
"Last Name": "Laden",
"Country Of Birth": "",
"Secondary Citizenship": []
}
]
}
]
]