For a deeper look into our World Check One API, look into:

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
1 1 2 5

How to get CLIENT WATCHLIST result in WorldCheck?

world-checkworld-check-onewatchlist
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 5.0 MiB each and 10.0 MiB total.

Upvotes
Accepted
1.1k 3 1 2

@casim

I suspect the endpoint details you have copied are incomplete.

I am pasting a sample request and response below for your reference wherein I have screened against my watchlist and for you to identify the matches of the watchlist from the screening results look for the attribute "referenceId" wherein the value will have a prefix "e_clwl_*****" whereas the matches against the World-Check data will have a "referenceId" value with a prefix "e_tr_wci_******"

Even the sources value will have a prefix "b_clwl_****" whereas the sources for hits from World-Check data will have a value with the prefix "b_trwc_****"

You can see both of these in the sample response below:

REQUEST:


    POST / v2 / cases / screeningRequest HTTP / 1.1
Date: Wed, 18 Aug 2021 17: 01: 35 GMT
Content - Type: application / json
Authorization: Signature keyId = "f05506b3-dcd7-4bbf-a*************", algorithm = "hmac-sha256", headers = "(request-target) host date content-type content-length", signature = "6z7gd0s07+AIHxVifPYdoG0qmYwWmrM9roak+gZtDkk="
Content - Length: 675
User - Agent: PostmanRuntime / 7.28 .3
Accept: *
/*
Cache-Control: no-cache
Postman-Token: bb15c999-ae2f-415b-ab3c-36fe88e117df
Host: api-worldcheck.refinitiv.com
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
 
{
"groupId": "5l8v5wy0e5**********",
"entityType": "INDIVIDUAL",
"caseId": "TESTWC",
"providerTypes": [
"WATCHLIST","CLIENT_WATCHLIST"
],
"name": "John Smith",
"nameTransposition": true,
"secondaryFields": [
{
"typeId": "SFCT_1",
"value": "MALE"
},
{
"typeId": "SFCT_2",
"dateTimeValue": "1986-08-23"
},
{
"typeId": "SFCT_3",
"value": "AFG"
},
{
"typeId": "SFCT_4",
"value": "AFG"
},
{
"typeId": "SFCT_5",
"value": "AFG"
}
]
}
 
 RESPONSE:
 
HTTP/1.1 200 OK
Date: Wed, 18 Aug 2021 17:01:37 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Strict-Transport-Security: max-age=15552000, includeSubdomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-XSS-Protection: 1; mode=block
X-Frame-Options: DENY
X-Content-Type-Options: nosniff


{
    "caseId": "TESTWC",
    "name": "John Smith",
    "providerTypes": [
        "WATCHLIST",
        "CLIENT_WATCHLIST"
    ],
    "customFields": [],
    "secondaryFields": [
        {
            "typeId": "SFCT_1",
            "value": "MALE",
            "dateTimeValue": null
        },
        {
            "typeId": "SFCT_2",
            "value": null,
            "dateTimeValue": "1986-08-23"
        },
        {
            "typeId": "SFCT_3",
            "value": "AFG",
            "dateTimeValue": null
        },
        {
            "typeId": "SFCT_4",
            "value": "AFG",
            "dateTimeValue": null
        },
        {
            "typeId": "SFCT_5",
            "value": "AFG",
            "dateTimeValue": null
        }
    ],
    "groupId": "5l8v5wy0e52t************",
    "entityType": "INDIVIDUAL",
    "caseSystemId": "5jb6l8s4xl961fx4dpx1s142b",
    "caseScreeningState": {
        "WATCHLIST": "INITIAL"
    },
    "lifecycleState": "UNARCHIVED",
    "creator": {
        "userId": "5l8v5wy0e52t1ezbblpujl8cv",
        "firstName": "Mehran",
        "lastName": "Khan",
        "fullName": "Mehran Khan",
        "email": "Mehran.AhmedKhan@refinitiv.com",
        "status": "ACTIVE"
    },
    "modifier": {
        "userId": "5l8v5wy0e52t1ezbblpujl8cv",
        "firstName": "Mehran",
        "lastName": "Khan",
        "fullName": "Mehran Khan",
        "email": "Mehran.AhmedKhan@refinitiv.com",
        "status": "ACTIVE"
    },
    "assignee": null,
    "creationDate": "2021-08-18T17:01:35.496Z",
    "modificationDate": "2021-08-18T17:01:37.043Z",
    "nameTransposition": true,
    "outstandingActions": true,
    "results": [
        {
            "resultId": "5jb6d6qldiyr1fx4dq0zzq135",
            "referenceId": "e_clwl_indivId1",
            "matchStrength": "EXACT",
            "matchedTerm": "John Smith",
            "submittedTerm": "John Smith",
            "matchedNameType": "PRIMARY",
            "secondaryFieldResults": [
                {
                    "field": {
                        "typeId": "SFCT_1",
                        "value": null,
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_1",
                    "submittedValue": "MALE",
                    "submittedDateTimeValue": null,
                    "matchedValue": null,
                    "matchedDateTimeValue": null,
                    "fieldResult": "UNKNOWN"
                },
                {
                    "field": {
                        "typeId": "SFCT_2",
                        "value": null,
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_2",
                    "submittedValue": null,
                    "submittedDateTimeValue": "1986-08-23",
                    "matchedValue": null,
                    "matchedDateTimeValue": null,
                    "fieldResult": "UNKNOWN"
                },
                {
                    "field": {
                        "typeId": "SFCT_3",
                        "value": null,
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_3",
                    "submittedValue": "AFG",
                    "submittedDateTimeValue": null,
                    "matchedValue": null,
                    "matchedDateTimeValue": null,
                    "fieldResult": "UNKNOWN"
                },
                {
                    "field": {
                        "typeId": "SFCT_4",
                        "value": null,
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_4",
                    "submittedValue": "AFG",
                    "submittedDateTimeValue": null,
                    "matchedValue": null,
                    "matchedDateTimeValue": null,
                    "fieldResult": "UNKNOWN"
                },
                {
                    "field": {
                        "typeId": "SFCT_5",
                        "value": null,
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_5",
                    "submittedValue": "AFG",
                    "submittedDateTimeValue": null,
                    "matchedValue": null,
                    "matchedDateTimeValue": null,
                    "fieldResult": "UNKNOWN"
                }
            ],
            "sources": [
                "b_clwl_12345"
            ],
            "categories": [],
            "creationDate": "2021-08-18T17:01:37.041Z",
            "modificationDate": "2021-08-18T17:01:37.041Z",
            "resolution": null,
            "resultReview": {
                "reviewRequired": false,
                "reviewRequiredDate": "2020-11-27T06:17:12.363Z",
                "reviewRemark": null,
                "reviewDate": null
            },
            "primaryName": "John Smith",
            "events": [],
            "countryLinks": [],
            "identityDocuments": [],
            "category": null,
            "providerType": "CLIENT_WATCHLIST",
            "gender": "UNKNOWN"
        },
        {
            "resultId": "5jb6d6qldiyr1fx4dq0zzpyf5",
            "referenceId": "e_tr_wci_256767",
            "matchStrength": "EXACT",
            "matchedTerm": "SMITH,John",
            "submittedTerm": "John Smith",
            "matchedNameType": "AKA",
            "secondaryFieldResults": [
                {
                    "field": {
                        "typeId": "SFCT_1",
                        "value": "MALE",
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_1",
                    "submittedValue": "MALE",
                    "submittedDateTimeValue": null,
                    "matchedValue": "MALE",
                    "matchedDateTimeValue": null,
                    "fieldResult": "MATCHED"
                },
                {
                    "field": {
                        "typeId": "SFCT_2",
                        "value": null,
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_2",
                    "submittedValue": null,
                    "submittedDateTimeValue": "1986-08-23",
                    "matchedValue": null,
                    "matchedDateTimeValue": null,
                    "fieldResult": "UNKNOWN"
                },
                {
                    "field": {
                        "typeId": "SFCT_3",
                        "value": "USA",
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_3",
                    "submittedValue": "AFG",
                    "submittedDateTimeValue": null,
                    "matchedValue": "USA",
                    "matchedDateTimeValue": null,
                    "fieldResult": "NOT_MATCHED"
                },
                {
                    "field": {
                        "typeId": "SFCT_4",
                        "value": null,
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_4",
                    "submittedValue": "AFG",
                    "submittedDateTimeValue": null,
                    "matchedValue": null,
                    "matchedDateTimeValue": null,
                    "fieldResult": "UNKNOWN"
                },
                {
                    "field": {
                        "typeId": "SFCT_5",
                        "value": "USA",
                        "dateTimeValue": null
                    },
                    "typeId": "SFCT_5",
                    "submittedValue": "AFG",
                    "submittedDateTimeValue": null,
                    "matchedValue": "USA",
                    "matchedDateTimeValue": null,
                    "fieldResult": "NOT_MATCHED"
                }
            ],
            "sources": [
                "b_trwc_419",
                "b_trwc_SIC-PENDING"
            ],
            "categories": [
                "Law Enforcement",
                "Special Interest Categories"
            ],
            "creationDate": "2021-08-18T17:01:36.888Z",
            "modificationDate": "2021-08-18T17:01:36.888Z",
            "resolution": null,
            "resultReview": {
                "reviewRequired": false,
                "reviewRequiredDate": "2010-11-25T00:00:00.000Z",
                "reviewRemark": null,
                "reviewDate": null
            },
            "primaryName": "John S SMITH",
            "events": [],
            "countryLinks": [
                {
                    "country": {
                        "code": "USA",
                        "name": "UNITED STATES"
                    },
                    "countryText": "USA",
                    "type": "NATIONALITY"
                },
                {
                    "country": {
                        "code": "USA",
                        "name": "UNITED STATES"
                    },
                    "countryText": "USA",
                    "type": "LOCATION"
                }
            ],
            "identityDocuments": [],
            "category": "CRIME - NARCOTICS",
            "providerType": "WATCHLIST",
            "gender": "MALE"
        }
     ]
    }

Let me know if you have any questions.

icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 5.0 MiB each and 10.0 MiB total.

Upvotes
1 1 2 5

I am using the following API detail, please tell me how to find client watchlist result from it. In this result we have find both results, please tell me how we find only client watchlist result?

cURL : https://api-worldcheck.refinitiv.com/v1/cases/{case_system_id}

Request

{
  "groupId": "5jb84zdmrpt41fh5nzo17fc4h",
  "entityType": "INDIVIDUAL",
  "providerTypes": [
    "WATCHLIST",
    "CLIENT_WATCHLIST"
  ],
  "name": "LUTFIEH NIZAR SALEM ALNABULSI",
  "caseId": "10000000759",
  "secondaryFields": [
    {
      "typeId": "SFCT_2",
      "dateTimeValue": "1964-05-09"
    },
    {
      "typeId": "SFCT_5",
      "value": "JOR"
    },
    {
      "typeId": "SFCT_3",
      "value": "JOR"
    },
    {
      "typeId": "SFCT_4",
      "value": "JOR"
    }
  ],
  "customFields": []
}

Response

{
  "caseId": "10000000759",
  "name": "LUTFIEH NIZAR SALEM ALNABULSI",
  "providerTypes": [
    "WATCHLIST",
    "CLIENT_WATCHLIST"
  ],
  "customFields": [],
  "secondaryFields": [
    {
      "typeId": "SFCT_2",
      "value": null,
      "dateTimeValue": "1964-05-09"
    },
    {
      "typeId": "SFCT_5",
      "value": "JOR",
      "dateTimeValue": null
    },
    {
      "typeId": "SFCT_3",
      "value": "JOR",
      "dateTimeValue": null
    },
    {
      "typeId": "SFCT_4",
      "value": "JOR",
      "dateTimeValue": null
    }
  ],
  "groupId": "5jb84zdmrpt41fh5nzo17fc4h",
  "entityType": "INDIVIDUAL",
  "caseSystemId": "5jb6w3g4quu61fvefpz5h63mb",
  "caseScreeningState": "INITIAL",
  "lifecycleState": "UNARCHIVED",
  "creator": {
    "id": "5jb8i0yzkrxw1fh5nucn7i1hn",
    "userId": "5jb8i0yzkrxw1fh5nucn7i1hn",
    "firstName": "Abul Casim",
    "lastName": "Maricar",
    "fullName": "Abul Casim Maricar",
    "email": "casim@alfaexchange.com",
    "status": "ACTIVE",
    "registrationKey": "7267c7de-148e-42aa-916f-1d08b5d8d01c:7267c7de-148e-42aa-916f-1d08b5d8d01c"
  },
  "modifier": {
    "id": "5jb8i0yzkrxw1fh5nucn7i1hn",
    "userId": "5jb8i0yzkrxw1fh5nucn7i1hn",
    "firstName": "Abul Casim",
    "lastName": "Maricar",
    "fullName": "Abul Casim Maricar",
    "email": "casim@alfaexchange.com",
    "status": "ACTIVE"
  },
  "assignee": null,
  "creationDate": "2021-08-01T08:23:07.055Z",
  "modificationDate": "2021-08-09T05:42:05.163Z",
  "outstandingActions": true
}
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 5.0 MiB each and 10.0 MiB total.

Click below to post an Idea Post Idea