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

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
24 2 1 7

The step of implement World-check one API

Hi Experts,

I am new in World check one API so i have some questions need your help to clarify.

1. If we use the Check Type = "World-Check" in UI to screen data, but in API method, the Items Enum of providerTypes do not contain the "World-Check" type. Which providerTypes should we use?

*refer below picture, please ignore the rectangle marked as red.
1659926399055.png

2. If we enable the "Auto resolve mismatch cases as false" in World check one UI, when we start using API to send data, Do we need to set it again?

3. According to my understanding, the steps for the initial case will as below, could you kindly help to check is it correct?

Step 1: create a new case
Step 2: Perform synchronous screening for a new case
Step 3: Enable ongoing screening for a case
Step 4: Get screening results
4. Regarding the Step1 in question 3 - create a new case, when launching this step,

1) Will it process screening automatically?
2) I saw below description in "Create a new case" section, it shows "Creates a new Case for asynchronous screening". Is it only for asynchronous screening? If we want to do synchronous screening?

1659697915637.png

5. If we want to get the result "No matched found" or "Unresolved match", can you kindly advise the API name so that we can get those information?


Many thanks!

world-check-oneworldcheck-one-api
1659697915637.png (33.8 KiB)
1659926399055.png (271.4 KiB)
icon clock
10 |1500

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

Upvotes
Accepted
1k 2 2 3

Hi @rebecca.hsieh, thanks for reaching out to us!
I will try to answer your questions to the best of my ability:

1. The "providerTypes" you should use is "WATCHLIST" in the API, as it is equivalent to the "World-Check" under "Check Types"

2. The settings you have in the World-Check WebUI apply to your API, so no.

3. Yes - this is everything that happens behind the scenes when you are sending the API endpoint: https://api-worldcheck.refinitiv.com/v2/cases/screeningRequest

4. If you want to do synchronous screening, please see the provided endpoint above. All of the steps you listed in the previous point happen synchronously when you call on that endpoint (cases/screeningRequest) that is mentioned.

5. You can call on endpoint https://api-worldcheck.refinitiv.com/v2/cases/{caseSystemId}/results and search for "resolution". If the value is null, then that means the match is yet unresolved.

If you have any more questions, please do not hesitate to reach out!

Thanks,
Judith

icon clock
10 |1500

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

Upvotes
24 2 1 7

Hi @Judith.Pillado,

Thanks for your answers. According to your answer, I still have some questions that need your assistance. Thanks a lot.

  1. If our use case is that the ongoing screening feature will be enabled for the active case, and then is any difference between doing synchronous screening or asynchronous screening after creating the case? I saw the document (found in Q&A forum) mentions that “The Sync Screening API does not provide the resolution status of the matches”. Does this mean we should not use synchronous screening if we need the resolution status to check whether cases are "Unresolved match” or not?
  2. After we enable the ongoing screening, how do we monitor and deal with the result?
    Does it use https://api-worldcheck.refinitiv.com/v2/cases/ongoingScreeningUpdates ?
  3. How to define the case screening result as “No matches found”? Can it also check by calling on endpoint https://api-worldcheck.refinitiv.com/v2/cases/{caseSystemId}/results and search for "resolution"?
  4. When calling the PUT /cases/{caseSystemId} to update an existing case, does it need to calling POST /cases/screeningRequest or it can just wait for the daily ongoing screening result ?
icon clock
10 |1500

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

Upvotes
1k 2 2 3

Hi @rebecca.hsieh, thank you for reaching out again! I apologize for the late response - I will get back to you as soon as I can with some answers for you!

icon clock
10 |1500

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

Upvotes
1k 2 2 3

Hi @rebecca.hsieh, thank you for your patience. Below are the answers to your question:


1. As you stated in the very first question you posted, the synchronous screening endpoint does the following:
Step 1: create a new case
Step 2: Perform synchronous screening for a new case
Step 3: Enable ongoing screening for a case
Step 4: Get screening results
The asynchronous screening endpoint simply screens for an existing case. If you need to find the resolution status of a case, then you need to call on the endpoint https://api-worldcheck.refinitiv.com/v2/cases/{caseSystemId}/results as I suggested in step 5 in my previous answer.

2. The endpoint https://api-worldcheck.refinitiv.com/v2/cases/ongoingScreeningUpdates allows you to gest screening updates for all case objects that are visible to the current user and are flagged for ongoing screening. So yes, use that endpoint when you want to view and monitor any updates on OGS cases.

3. If there are no matches found and you call on the endpoint https://api-worldcheck.refinitiv.com/v2/cases/%7bcaseSystemId%7d/results then you will get an empty array.

4. I don't think I understand your question. You are talking about 2 different endpoints, where you use the first one to update an existing case and the latter creates a new case.

Please let me know if you have any further questions. Thanks!

Judith

icon clock
10 |1500

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

Upvotes
24 2 1 7

Hi @Judith.Pillado ,

Thanks for your response. This is helpful for me.

1.Ohh, I understand your meaning. It means I can call on the endpoint https://api-worldcheck.refinitiv.com/v2/cases/screeningRequest to complete following four steps in this one API.

Step 1: create a new case

Step 2: Perform synchronous screening for a new case

Step 3: Enable ongoing screening for a case

Step 4: Get screening results

For step3, does it set the “caseScreeningState” as "WATCHLIST": " ONGOING " to enable the ongoing screening feature? Then the case will switch on the daily screening.

For Step4, Is the “results” array of response from the endpoint https://api-worldcheck.refinitiv.com/v2/cases/screeningRequest same as the response from calling endpoint https://api-worldcheck.refinitiv.com/v2/cases/{caseSystemId}/results ?

2. As I know, cases flagged for ongoing screening are re-screened by World-Check One periodically. Is there has specified DateTime when will WC1 run screening for the flagged case by daily? Because we want to know when we should launch our API job to query the change.


Many thanks.

icon clock
10 |1500

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

Upvotes
1k 2 2 3

Hi @rebecca.hsieh

1. Yes, you would have to set "WATCHLIST": "ONGOING" under "providerTypes"
The results array is not the same as calling on the results endpoint. The results endpoint will have much more detail than that of the response provided.

2. You can change these settings by logging into the WebUI:
1. Click on ADMIN tab
2. Click on Groups on the left panel. Choose the appropriate group you want to change the settings to.
3. Click on Group details on the right (next to Group Administrators)
4. Under the World-Check header, click on Edit next to Settings
5. Edit the Ongoing Screening Settings to send you the email notifications at your preferred time, time zones, and how often you would like to have the cases screened.

I hope that makes sense!

Best,

Judith

icon clock
10 |1500

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

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

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