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

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
7 0 1 1

WC1 API - Enable ongoing screening - is there any option for bulk cases enabling ongoing screening

Hi,

SEQ-case-ogs-enable: Enable ongoing screening for a case - using this api we can enable only one case at once.

Is there api for enable ongoing screening for bulk cases?


thank you



world-checkworld-check-onescreening
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
548 1 1 1

@Koshila,

Enabling multiple cases for Ongoing Screening is currently not available. Only one case can be enabled at once using API as of now.

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.

@Koshila,

You may use asynchronous screening approach in order to save and screen multiple names in 1 API call. Using this approach, you may be able to enable ongoing screening for the cases (up to 50 cases) in the same API call. Below is the snippet payload -

Endpoint - /cases/saveAndScreen

{
    "groupId": "{
                   {group-id}}",
    "providerTypes": [
        "WATCHLIST"
    ],
    "nameTransposition": false,
    "caseScreeningState": {
        "WATCHLIST": "ONGOING"
    },
    "cases": [
        {
            "entityType": "ORGANISATION",
            "name": "SmithCorporation"
        },
        {
            "entityType": "INDIVIDUAL",
            "name": "John Smith"
        }
    ]
}
Upvotes
7 0 1 1

@prabhjyot.mandla


SEQ-case-monitor-ogs: Monitor ongoing screening updates on cases - i can get updated result from this api like this,

  • {
  • "query": "updateDate>='2020-09-02T04:26:55.465Z'",
  • "sort": null,
  • "totalResultCount": 3,
  • "pagination": {
  • "currentPage": 1,
  • "itemsPerPage": 100,
  • "totalItems": 3
  • },
  • "results": [
  • {
  • "caseSystemId": "5nzbfkcwtwlw1exlrj5ove0kz",
  • "numberOfNewResults": 1,
  • "numberOfUpdatedResults": 0,
  • "updateDate": "2020-09-04T04:42:20.495Z"
  • },

now i want get updated values with fields it means new results, which api can i use for it

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.

Upvote
548 1 1 1

@Koshila,

In order to check the details due to ongoing screening, you will have to do the following -

1. Fetching screening results (/cases/caseSystemI/results): You would have to fetch the case results using the caseSystemId of the case and check the following -

  1. If the creationDate and the modificationDate in the results is the same as the updateDate in the Monitor ongoing screening updates API call, it means that the match in the case is a new profile which has been included to the case due to the ongoing screening updates.
  2. If the modificationDate in the case result for a match is same as the updateDate from the Monitor ongoing screening updates API call, and the creationDate is a different one, then it means that an existing match in the case has been updated due to the ongoing screening updates.

2. Fetch the specific profile (reference/profile/profile-Id): Once you have identified the match which has been update, you may fetch the profile information of the match to check for further details.

Please do let us know if you need further clarifications.

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
7 0 1 1

@prabhjyot.mandla

HI,

i have developed OGS. i have no data to test it. is there any test data to check this api SEQ-case-monitor-ogs: Monitor ongoing screening updates on cases?

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
548 1 1 1

@Koshila,

Below is the format of the response -

{
    "query": "updateDate>='2021-05-21T13:23:44.213Z'", // Query in request payload
    "sort": null,
    "totalResultCount": 6,
    "pagination": {
        "currentPage": 1,
        "itemsPerPage": 100,
        "totalItems": 6
    },
    "results": [
        {
            "caseSystemId": "5l8v60vvlfcm1evuoul5fv2rt",
            "updateDate": "2021-05-25T07:14:25.229Z", // Update as on date
            "numberOfNewResults": 1,   // New match in the case due to OGS
            "numberOfUpdatedResults": 0 
        },
        {
            "caseSystemId": "5jb6puhku6im1fbp8sin3t1c4",
            "updateDate": "2021-05-28T07:14:35.600Z",
            "numberOfNewResults": 0,
            "numberOfUpdatedResults": 1 // Update on an existing match due to OGS
        },
        {
            "caseSystemId": "5jb6vbtcst801fokmnrcif936",
            "updateDate": "2021-05-28T07:51:16.621Z",
            "numberOfNewResults": 0,
            "numberOfUpdatedResults": 1
        },
        {
            "caseSystemId": "5l8v64txti7j1evuomd6syrcj",
            "updateDate": "2021-05-25T09:41:43.806Z",
            "numberOfNewResults": 1,
            "numberOfUpdatedResults": 0
        },
        {
            "caseSystemId": "5jb7gz67ndsg1fj08vj3vxrnx",
            "updateDate": "2021-05-27T00:57:06.985Z",
            "numberOfNewResults": 1,
            "numberOfUpdatedResults": 0
        },
        {
            "caseSystemId": "5jb7gz67ndsg1fj08vj3vxrnx",
            "updateDate": "2021-05-25T22:31:36.059Z",
            "numberOfNewResults": 0,
            "numberOfUpdatedResults": 1
        }
    ]
}
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