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

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
42 11 16 18

Mandatory fields in resolving (Remediating) Cases through WC1 API

Hello,

Which fields are mandatory for resolving cases with WC1 API ? In the Web solution we have the following fields : Status, Risk Level, Reason (Exact Match, ...), see attachment, which one are mandatory through the API?

Best Regardsresolution.jpg

world-checkworld-check-one
resolution.jpg (43.1 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
4.5k 4 8 8

@nabil.hassoumi,

It is the same as UI - status, risk and reason is must for resolving a case via the API. Apart from that, you can resolve multiple result Ids with the same status, risk and reason. example below -

{  "resultIds":[ "{
                {result-id1}}", “{
                {result-id2}}” ],  "statusId": "{
                {status-ID}}",  "riskId": "{
                {risk-ID}}",  "reasonId": "{
                {reason-ID}}",  "resolutionRemark":"Enter remarks here!"}

resolutionRemark is another field which can be used to enter a remark for resolving a particular match. There is no other field used via API while resolving a match as of now.

Can you please explain a bit more on what exaclty do you mean by customizing a field?

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
4.5k 4 8 8

@nabil.hassoumi,

Thank you for the query.

For resolving a case via API, the manditory fields are resultId, statusId, riskId and reasonId.

resultId can be retreived from the the API call - 'Get screening results'.

statusId, riskId and reasonId can be retreived from the API call - 'Get the resolution toolkit for a group'

The statusId which you use would have specific riskId and reasonId associate with it and only after you use the associated Ids will the match be resolved using the API, else you would receive Error 400 Bad request.

You can use the statusId value from the 'Get the resolution toolkit for a group' and check the associated risk and reason Ids.

Hope this helps.

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
42 11 16 18

Hello, My question was more about the workflow, about the mandatory and customised fields. When you do a remediation through WC1 Web access you must fill these fields (Status, Risk Level, Reason ...). So which ones are mandatory through the API ? also what fields can be customised through the API ?

Best Regards

Nabil

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.