1. Using Customer Screening API
  2. Real Time Customer Screening JSON Service (Entity)
  3. Using Customer Screening GET RT Events Request

4.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 Using Customer Screening GET RT Events Request.

Request JSON Parameters

Parameter Value Type Description
Request ID Integer Request ID generated for an Entity.

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

Response Sample:

[
  [
    {
      "EventList": [
        {
          "eventScore": 80,
          "busDomain": "a",
          "jurisdiction": "AMEA",
          "watchlistSkey": 6771419,
          "watchlistJson": "{\"v_title\":\" \",\"v_vessel_tonnage\":\" \",\"v_full_name\":\" \",\"v_citi_country\":\" \",\"v_deceased_date\":\" \",\"v_vessel_owner\":\" \",\"v_description2\":\"Sanctions Control and Ownership\",\"v_id_type\":\"Related EU Consolidated Electronic List ID;Related HM Treasury Group ID;Related OFAC Unique ID;Related DFAT Reference Number;Related Australian Regulation;Related EU Sanctions Programme Indicator;Related OFAC Program ID;Related UN Permanent Reference No.;Related HM Treasury Regime;Related Japanese Regulation;Related UN Sanctions Committee\",\"v_aliases_family_name\":\" \",\"v_url\":\"https://www.newtechno-ye.com/\",\"v_date\":\" \",\"watchlist_name_type\":\" \",\"v_identification_numbers\":\" \",\"v_registration_date\":\" \",\"v_max_yob\":\"1111\",\"v_address\":\"Ring Line, Infront of Saudi Embassy, Next to the General Authority for Insurance,Sanaa;Sanaa,Yemen;\",\"v_suffix\":\" \",\"v_id_value\":\"131805;14141;31192;6266;Consolidated List;YEM;YEMEN;YEi.007;Yemen;Yemen;Yemen;\",\"v_source_name\":\"https://almushahid.net/73207/;https://bawabatii.net/news283290.html;https://moit.gov.ye/moit/tn_search/index.php;https://www.newtechno-ye.com/;\",\"v_vessel_flag\":\" \",\"v_nationality\":\" \",\"v_deceased\":\" \",\"v_inactive_date\":\" \",\"v_entity_name\":\"New Technology for Communications and Information Technology Services Company Limited\",\"v_aliases\":\" \",\"v_id_notes\":\";;;;;;;;;;;\",\"v_cessation_date\":\" \",\"v_occupation_category\":\";\",\"v_original_script_name\":\" \",\"v_profile_notes\":\"DOW JONES NOTES:  12-Nov-2021 This company is to an unknown percentage owned by UK Sanctioned Saleh Mesfer Saleh Al Shaer.  PROFILE UPDATED: 23-Nov-2021 This company is to an unknown percentage owned by OFAC, EU and UK Sanctioned Saleh Mesfer Saleh Al Shaer.  PROFILE UPDATED: 13-Jul-2024 As of 13-Jul-2024 the Sanctions Control & Ownership (SCO) content has been expanded to include additional jurisdictions. As a result, this profile's SCO descriptions have been updated accordingly.  PROFILE UPDATED: 07-Aug-2024 This company is to an unknown stake owned by OFAC SDN and EU and UK and UN and Japan and Australia Sanctioned Saleh Mesfer Saleh Al Shaer.\",\"v_description3\":\"Australia Related - Ownership Unknown;EU Related - Ownership Unknown;Japan Related - Ownership Unknown;OFAC Related - Ownership Unknown;UK Related - Ownership Unknown;UN Related - Ownership Unknown\",\"v_other_party_name\":\" \",\"v_wl_sub_type\":\"EDD\",\"v_residence\":\" \",\"v_entity_name_bus_strip\":\"NEW TECHNOLOGY FOR COMMUNICATIONS AND INFORMATION TECHNOLOGY SERVICES COMPANY LIMITED\",\"v_occupation\":\" \",\"v_date_notes\":\" \",\"n_uid\":12636649,\"v_country_type\":\"Country of Registration\",\"v_wl_type\":\"DJW\",\"v_addition_date\":\"2021-11-12\",\"v_aliases_given_name\":\" \",\"v_to_date1\":\" \",\"v_citizenship\":\" \",\"v_to_date2\":\" \",\"v_place_of_birth\":\" \",\"v_city\":\"Sana'a;Sana'a\",\"v_name_type\":\"Primary Name\",\"v_vessel_call_sign\":\" \",\"v_given_name\":\" \",\"v_addressline\":\"Ring Line, Infront of Saudi Embassy, Next to the General Authority for Insurance\",\"v_name_sub_type\":\"OSN\",\"v_min_yob\":\"9999\",\"n_wl_skey\":6771419,\"v_relationship\":\"Shareholder/Owner;\",\"v_date_of_births\":\" \",\"v_street\":\" \",\"v_image\":\";\",\"v_is_ex\":\"No;\",\"v_country_type_country_name\":\"Yemen\",\"v_yob\":\" \",\"n_run_skey\":862,\"v_role_type\":\" \",\"v_gender\":\" \",\"v_active_status\":\"Active\",\"v_record_action\":\"chg\",\"v_passports\":\" \",\"v_ssn\":\" \",\"v_vessel_grt\":\" \",\"v_family_name\":\" \",\"v_town_of_birth\":\" \",\"v_last_reviewed_date\":\"2024-08-07\",\"v_related_person_entity_id\":\"12635742;\",\"v_date_type\":\" \",\"v_vessel_type\":\" \",\"v_sanction_list_reference\":\" \",\"v_entity_type\":\"E\",\"v_since_date1\":\" \",\"v_alias_city_of_birth\":\" \",\"v_since_date2\":\" \",\"v_country\":\"Yemen\"}",
          "eventMatches": [
            {
              "matchScore": 100,
              "searchString": "New Technology for Communications and Information ",
              "matchedColLogicalName": "Entity Name",
              "overallScore": 80,
              "ruleName": "Entity Name, City, Country Match",
              "matchedValue": "New Technology for Communications and Information Technology Services Company Limited",
              "matchedColumn": "v_entity_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": 8201
    }
  ]
]

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": 80,
          "busDomain": "a",
          "jurisdiction": "AMEA",
          "watchlistSkey": 15135,
          "watchlistJson": "{\"v_title\":\"-0- \",\"v_alt_remarks\":\" \",\"v_full_name\":\" \",\"v_citi_country\":\" \",\"v_remarks\":\"Organization Established Date 19 Jan 2017; Organization Type: Postal activities; alt. Organization Type: Other financial service activities, except insurance and pension funding activities, n.e.c.; Only locations in Syria; Linked To: BIN ALI, Khodr Taher.\",\"v_city_state_postalcode\":\"Damascus\",\"v_vess_type\":\"-0- \",\"v_grt\":\"-0- \",\"v_aliases_family_name\":\" \",\"v_add_remarks\":\"-0- \",\"v_sdn_name\":\"EMMA LLC\",\"n_add_num\":\"45008\",\"n_alt_num\":\" \",\"v_program\":\"SYRIA\",\"watchlist_name_type\":\" \",\"v_identification_numbers\":\" \",\"v_alt_name\":\" \",\"f_sdn_fl\":\"Y\",\"v_max_yob\":\"1111\",\"v_address\":\" 0 \",\"v_call_sign\":\"-0- \",\"v_nationality\":\" \",\"v_alt_type\":\" \",\"v_entity_name\":\"EMMA LLC\",\"v_aliases\":\" \",\"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\":\"EMMA LLC\",\"v_occupation\":\" \",\"v_tonnage\":\"-0- \",\"n_uid\":29857,\"v_wl_type\":\"OFAC\",\"v_aliases_given_name\":\" \",\"v_place_of_birth\":\" \",\"v_city\":\"Damascus\",\"v_given_name\":\" \",\"v_min_yob\":\"9999\",\"n_wl_skey\":15135,\"v_sdn_type\":\"-0- \",\"v_date_of_births\":\" \",\"v_street\":\" \",\"v_yob\":\" \",\"n_run_skey\":110,\"v_gender\":\" \",\"v_passports\":\" \",\"v_ssn\":\" \",\"v_family_name\":\"EMMA LLC\",\"v_town_of_birth\":\" \",\"v_vess_flag\":\"-0- \",\"v_entity_type\":\"E\",\"v_alias_city_of_birth\":\" \",\"v_country\":\"Syria\"}",
          "eventMatches": [
            {
              "matchScore": 100,
              "searchString": "Emma LLC",
              "matchedColLogicalName": "Entity Name",
              "overallScore": 80,
              "ruleName": "Entity Name, City, Country Match",
              "matchedValue": "EMMA LLC",
              "matchedColumn": "v_entity_name"
            }
          ],
          "searchHyperlink": "http://www.google.co.uk/search?hl=en&q=$FULL_NAME$",
          "indProfileHyperlink": "",
          "entProfileHyperlink": ""
        }
      ],
      "CaseId": 8231
    },
    {
      "Candidate": [
        {
          "Identification Document": [
            {
              "Document Number": "",
              "Document Type": "",
              "Issuing Country": ""
            }
          ],
          "Organization Name": "Emma LLC",
          "Address": [
            {
              "Postal Code": "",
              "Street Line 1": "",
              "State": "",
              "Country": "",
              "City": ""
            }
          ],
          "Candidate ID": 584,
          "Source Request ID": "",
          "Applicant ID": "CSRT_584",
          "Business Domain": "a",
          "searchWithCase": true,
          "SSN/TIN": "",
          "Country Of Incorporation": "",
          "Candidate Type": "ENT",
          "Country Of Taxation": "",
          "Existing Internal ID": "",
          "Candidate Jurisdiction": "AMEA"
        }
      ]
    }
  ]
]