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

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
3 1 5 7

Correct way to determine resolved matches

hi,

i'm just getting started with the api so apologies in advance.

i'm currently trying to emulate the totals that you have in the World-Check One Case Summary screen - the results of a case are broken down into Resolved Matches / Positive / Possible / False / Unspecified

is there a simple way to determine these totals? i'm currently having to check each Resolution for specific Resolution Remarks such as "No match due to weak Match Strength" which is messy. is there an easier way?

also, i'm finding that the data that i'm retrieving via the api doesn't match the data that i'm seeing on the front-end - is there something that i can do to see a refreshed copy of the data?

thanks in advance,

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

10 Answers

Upvotes
Accepted
3.1k 18 7 7

Hi @stephen.davidson,

The GET resolutionToolkit endpoint returns all the resolution IDs for a given group.

Below the resolution array has all the resolution fields returned from the toolkit.

Hope this helps,

Brian

statusId": "75ee5dec-cae6-421a-ba38-2ad5a5c98ace" is "POSITIVE"

"riskId": "0c14e442-b860-43e0-82b7-93b884fccbf9" is "HIGH"

"reasonId": "84595c00-6528-4fc8-9dad-38223d53e134" is "Full Match"

SEQ-5b

    "resultId": "0a3687d0-5a47-1e47-9693-6c1200001710",
    "referenceId": "e_tr_wci_891256",
    "matchStrength": "EXACT",
    "matchedTerm": "Nadia Patricia ESPARRAGOZA GASTELUM",
    "submittedTerm": "Nadia Patricia Esparragoza Gastélum",
    "matchedNameType": "PRIMARY",
    "secondaryFieldResults": [],
    "resolution": {
      "statusId": "75ee5dec-cae6-421a-ba38-2ad5a5c98ace",
      "riskId": "0c14e442-b860-43e0-82b7-93b884fccbf9",
      "reasonId": "84595c00-6528-4fc8-9dad-38223d53e134",
      "resolutionRemark": "note on resolve",
      "resolutionDate": "2017-03-22T10:22:44.085Z"
    },
    "resultReview": {
      "reviewRequired": false,
      "reviewRequiredDate": "2015-06-17T00:00:00.000Z",
      "reviewRemark": "review note",
      "reviewDate": "2017-03-22T10:23:05.580Z"
    },


Here is the resolution toolkit - SEQ-1f

{
  "groupId": "418f28a7-b9c9-4ae4-8530-819c61b1ca6c",
  "providerType": "WATCHLIST",
  "resolutionFields": {
    "statuses": [
      {
        "id": "75ee5dec-cae6-421a-ba38-2ad5a5c98ace",
        "label": "POSITIVE",
        "type": "POSITIVE"
      },
      {
        "id": "37371e33-9b64-427c-9f0f-284e2e8c4d27",
        "label": "POSSIBLE",
        "type": "POSSIBLE"
      },
      {
        "id": "36604ead-d000-4111-ae10-e23d2bcfc7db",
        "label": "FALSE",
        "type": "FALSE"
      },
      {
        "id": "a3e41773-23fb-4a03-84d6-e485126e071b",
        "label": "UNSPECIFIED",
        "type": "UNSPECIFIED"
      }
    ],
    "risks": [
      {
        "id": "d7784825-91ec-4b96-8327-60a5463bb877",
        "label": "UNKNOWN",
        "type": null
      },
      {
        "id": "a50188e8-5a62-406d-86d7-b542020aa820",
        "label": "MEDIUM",
        "type": null
      },
      {
        "id": "11ea8449-d365-475e-9a7b-532fc38cab7e",
        "label": "LOW",
        "type": null
      },
      {
        "id": "0c14e442-b860-43e0-82b7-93b884fccbf9",
        "label": "HIGH",
        "type": null
      }
    ],
    "reasons": [
      {
        "id": "fd84450b-5a90-4b41-b37e-ff013f387411",
        "label": "No Match",
        "type": null
      },
      {
        "id": "84595c00-6528-4fc8-9dad-38223d53e134",
        "label": "Full Match",
        "type": null
      },
      {
        "id": "e44c1055-e6ef-43f9-8f27-fc9d7826d0a5",
        "label": "Possible Match",
        "type": null
      },
      {
        "id": "fdeea5c4-fe58-423b-a890-8cb67386813d",
        "label": "n/a",
        "type": null
      }
    ]
  },
  "resolutionRules": {
    "75ee5dec-cae6-421a-ba38-2ad5a5c98ace": {
      "reasons": [
        "84595c00-6528-4fc8-9dad-38223d53e134"
      ],
      "remarkRequired": false,
      "reasonRequired": true,
      "risks": [
        "a50188e8-5a62-406d-86d7-b542020aa820",
        "0c14e442-b860-43e0-82b7-93b884fccbf9",
        "11ea8449-d365-475e-9a7b-532fc38cab7e"
      ]
    },
    "a3e41773-23fb-4a03-84d6-e485126e071b": {
      "reasons": [
        "fdeea5c4-fe58-423b-a890-8cb67386813d"
      ],
      "remarkRequired": false,
      "reasonRequired": true,
      "risks": [
        "d7784825-91ec-4b96-8327-60a5463bb877"
      ]
    },
    "36604ead-d000-4111-ae10-e23d2bcfc7db": {
      "reasons": [
        "fd84450b-5a90-4b41-b37e-ff013f387411"
      ],
      "remarkRequired": false,
      "reasonRequired": true,
      "risks": [
        "d7784825-91ec-4b96-8327-60a5463bb877"
      ]
    },
    "37371e33-9b64-427c-9f0f-284e2e8c4d27": {
      "reasons": [
        "e44c1055-e6ef-43f9-8f27-fc9d7826d0a5"
      ],
      "remarkRequired": false,
      "reasonRequired": true,
      "risks": [
        "a50188e8-5a62-406d-86d7-b542020aa820",
        "d7784825-91ec-4b96-8327-60a5463bb877",
        "0c14e442-b860-43e0-82b7-93b884fccbf9",
        "11ea8449-d365-475e-9a7b-532fc38cab7e"
      ]
    }
  }
}
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
3 1 5 7

Hi Brian,

Many thanks for that - I discovered the resolution toolkit this morning and it all makes more sense now!

Unfortunately, when I examine a Positive match in my results, the resolution StatusId does not match any of the Ids in ResolutionFields - Statuses - can you assist?

Also, when I try to resolve some results, I'm getting the following error:

"{""error"":""RESOLVE_RESULTS_FAILED"",""cause"":""Resolution of results request has failed, please check that all required fields are supplied and valid.""}"

I'm passing in the following:

A case system id of "0a3687d0-5a7f-1b6c-96ad-f7680000055e"

and a resultsResolutionAction of

(0): {[reasonId, 0a3687d0-5a7f-10b1-96a1-40e80000000e]}
(1): {[resolutionRemark, Test]}
(2): {[resultIds, System.String[]]}
(3): {[riskId, 0a3687d0-5a7f-10b1-96a1-40e800000012]}
(4): {[statusId, 0a3687d0-5a7f-10b1-96a1-40e800000016]}

where the results to be resolved is an array containing a single value:

(0): "0a3687d0-5ab3-1a16-96ad-f7690000139e"

Any ideas? I've checked the Ids and they are valid as far as I can see.

Many thanks again


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
3.1k 18 7 7

Hi @stephen.davidson,

You need to be sure you point your group-id to the group you're using.

In Postman, if you set the group-id to the group you are using, then run the GET resolutionkit, you'll get the IDs for that group. Every group with have it's own resolution IDs.

I posted "groupId": "418f28a7-b9c9-4ae4-8530-819c61b1ca6c", which returns the IDs for the default group out-of-the-box.

Hope that helps,

Brian

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.

Hi Brian

I'm hoping that's fixed it but unfortunately I now get an error on your front-end everytime I try and access the Case Manager - would you be able to take a look?

Many thanks

Upvotes
3 1 5 7

Hi Brian,

Hopefully that has fixed it.

Unfortunately, I get an error everytime I try and access the Case Manager from your web front-end - would you be able to take a look?

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
3.1k 18 7 7

Hi @stephen.davidson,

The Case Manager issue is being address, sorry for the inconvenience.

I'll let you know when it's working again.

Brian

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
3.1k 18 7 7

Hi @stephen.davidson,

The Pilot system is working properly again...please try again

Thanks,

Brian

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
3 1 5 7

Hi Brian,

Thanks for the update.

Hopefully you can help with the current issue - I can retrieve a list of results with a caseSystemId but am still having issue with resolving them:

it looks like we have multiple groups attached to our account. I have to specify a group id when I call the ResolutionToolkit method - is there any way to tell which group a caseSystemId is associated with?

do I have to do anything after I've called the Resolution method? I notice that I can update a case using the Cases2 method - do I need to call that?

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
3.1k 18 7 7

Hi @stephen.davidson,

Use SEQ-5a Fetch Full Case Details...it has the group in which the case is located.

There's nothing to do after you call the resolve results SEQ-5e (other than to check it in WC1 app, if you like)

Brian

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
3 1 5 7

Hi Brian,

Sorry for all the questions - hitting a brick wall here.

I've re-checked the Ids that I'm retrieving from the ResolutionToolkit and the correct values appear to be being passed into the Resolution method - any ideas?

My caseSystemId is "0a3687cf-5ac7-198c-96be-d9e70000048a"

and I'm passing in the following values:

(0): {[resultIds, System.String[]]}
(1): {[riskId, 0a3687d0-5a7f-10b1-96a1-40e800000012]}
(2): {[statusId, 0a3687d0-5a7f-10b1-96a1-40e800000016]}

The resultId is a single value of "0a3687d0-5afb-1318-96be-d9e700000cc5"

Thanks again

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
3 1 5 7

Hi Brian,

Just to let you know that my issues with resolving seem to be fixed. I still have some queries regarding saving cases that I'd like to discuss with you.

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.