Discover Refinitiv
MyRefinitiv Refinitiv Perspectives Careers
Created with Sketch.
All APIs Questions & Answers  Register |  Login
Ask a question
  • Questions
  • Tags
  • Badges
  • Unanswered
Search:
  • Home /
  • Screening /
  • World-Check One /

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

Overview |  Quickstart |  Documentation |  Downloads

avatar image
REFINITIV
Question by Vanessa Lucisano · Aug 31, 2018 at 10:23 AM · world-checkworld-check-onescreening-api

Screening results : what defines a no match result?

Hi Team,

question for a client's implementation.

When I get screening results via - SEQ-case-investigate-results: Get screening results

What happens when there are no matches?

Do I get a response like "no match found" or a specific STATUS code, or else?

Many thanks

Vanessa

People who like this

0 Show 0
Comment
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

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

1 Reply

  • Sort: 
avatar image
REFINITIV
Best Answer
Answer by Irfan.Khan · Sep 03, 2018 at 01:53 AM

@Vanessa Lucisano,

Kindly note we return an empty array as response for the API "SEQ-case-investigate-results: Get screening results" in two scenarios.

1. If the case has no match

2. If the case has not been screened.

So the answer to your question is that we return an empty array as a response if the case has no matches.

That being said, there is another way to identify if the case has no matches.

1. Send a request to save a case.

2. Send a request to screen a case.

3. Call the API call "SEQ-case-audit: Retrieve the audit log for a case" to know if the case has been screened or not. The JSON response would look something like this for a case that has been screened but has no matches.

 "results": [
        {
            "id": "0a3687cf-6542-1989-9967-708500270442",
            "objectId": "0a3687d0-6542-1569-9967-70840000cbd8",
            "eventDate": "2018-09-03T04:47:47.286Z",
            "actionedByUserId": "0a3687cf-611f-145c-9866-5974000011c2",
            "actionedByUserName": "Irfan Khan",
            "note": null,
            "entityType": "CASE",
            "actionType": "SCREENED_CASE",
            "auditEventToDate": null,
            "details": {
                "detailsType": "ScreenCaseAuditDetails",
                "userId": null,
                "statusCode": "COMPLETED",
                "screeningState": "INITIAL",
                "noOfNewResults": 0,
                "noOfReviewRequiredResults": 0,
                "noOfExcludedResults": 0,
                "noOfAutoResolvedResults": 0,
                "providerTypes": [
                    "CLIENT_WATCHLIST",
                    "WATCHLIST"
                ],
                "caseScreenRequestor": null,
                "caseSystemId": "0a3687d0-6542-1569-9967-70840000cbd8"
            }
        }
    ]
}

Check for the attribute "actionType" and its value. If the value of the attribute "actionType" is SCREENED_CASE and the value of the key "noOfNewResults" (under the attribute "details")is 0. Then it can be ascertained that the case has been screened and there are no matches.

Lets have a look at another JSON response of the audit API of a case that has been screened but has matches.

 "results": [
        {
            "id": "0a3687d0-6542-190f-9967-78e3009594d6",
            "objectId": "0a3687d0-6542-1038-9967-70fc000993ff",
            "eventDate": "2018-09-03T05:24:20.587Z",
            "actionedByUserId": "0a3687cf-611f-145c-9866-5974000011c2",
            "actionedByUserName": "Irfan Khan",
            "note": null,
            "entityType": "CASE",
            "actionType": "SCREENED_CASE",
            "auditEventToDate": null,
            "details": {
                "detailsType": "ScreenCaseAuditDetails",
                "userId": null,
                "statusCode": "COMPLETED",
                "screeningState": "INITIAL",
                "noOfNewResults": 14,
                "noOfReviewRequiredResults": 0,
                "noOfExcludedResults": 0,
                "noOfAutoResolvedResults": 0,
                "providerTypes": [
                    "WATCHLIST"
                ],
                "caseScreenRequestor": null,
                "caseSystemId": "0a3687d0-6542-1038-9967-70fc000993ff"
            }
        }
    ]

For the above JSON, the value of "actionType" is SCREENED_CASE and the value of the "noOfNewResults" is 14 as there are 14 matches.

Another way to check if the case has no matches, the client can follow the below steps:

1. Save a case API

2. Screen a case API

3. Call the API call "SEQ-case-audit: Retrieve the audit log for a case" to know if the case has been screened or not. The client needs to check only the attribute "actionType" and its value as "SCREENED_CASE" to confirm if the case has been screened.

4. Call the API "SEQ-case-investigate-results: Get screening results" and if the API call returns an empty array then the case has no matches as step 4 has returned that the case has been screened.

Kindly let me know if you need further clarification on this.

Comment
Vanessa Lucisano

People who like this

1 Show 0 · Share
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

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

Watch this question

Add to watch list
Add to your watch list to receive emailed updates for this question. Too many emails? Change your settings >
10 People are following this question.

Related Questions

Re-screeening uses different sources

401 authorized response code when sync screening/saving a case with a entity name with special characters.

What does `originalScript` mean in `Entity.Name`?

What is the time between calling the API (submitting the case) and getting the case matches?

Secodary Fields return a duplicate for one fields.

  • Copyright
  • Cookie Policy
  • Privacy Statement
  • Terms of Use
  • Anonymous
  • Sign in
  • Create
  • Ask a question
  • Spaces
  • Alpha
  • App Studio
  • Block Chain
  • Bot Platform
  • Connected Risk APIs
  • DSS
  • Data Fusion
  • Data Model Discovery
  • Datastream
  • Eikon COM
  • Eikon Data APIs
  • Electronic Trading
    • Generic FIX
    • Local Bank Node API
    • Trading API
  • Elektron
    • EMA
    • ETA
    • WebSocket API
  • Intelligent Tagging
  • Legal One
  • Messenger Bot
  • Messenger Side by Side
  • ONESOURCE
    • Indirect Tax
  • Open Calais
  • Open PermID
    • Entity Search
  • Org ID
  • PAM
    • PAM - Logging
  • ProView
  • ProView Internal
  • Product Insight
  • Project Tracking
  • RDMS
  • Refinitiv Data Platform
    • Refinitiv Data Platform Libraries
  • Rose's Space
  • Screening
    • Qual-ID API
    • Screening Deployed
    • Screening Online
    • World-Check One
    • World-Check One Zero Footprint
  • Side by Side Integration API
  • TR Knowledge Graph
  • TREP APIs
    • CAT
    • DACS Station
    • Open DACS
    • RFA
    • UPA
  • TREP Infrastructure
  • TRKD
  • TRTH
  • Thomson One Smart
  • Transactions
    • REDI API
  • Velocity Analytics
  • Wealth Management Web Services
  • Workspace SDK
    • Element Framework
    • Grid
  • World-Check Data File
  • 中文论坛
  • Explore
  • Tags
  • Questions
  • Badges