Acuris Risk Intelligence Monitor API 3.0

Table of contents

Managing Monitor Records

Once your worklists have been created you can now start adding monitor records to the worklists to begin screening. Monitor records are added to worklists using the worklistId and a uniqueId of your choice to uniquely identify the record within the worklist.

Here’s an example of adding a record to a worklist for monitoring:

curl --silent --location --request PUT 'https://api.acuris.com/compliance-monitor/worklists/WL-1/individuals/MR-1' \
--header 'content-type: application/json' \
--header 'x-api-key: xxx' \
--data-raw '{
  "name": "donald trump",
  "countries": [
    "US"
  ],
  "gender": "male"
}'

Note that in our old API, the unique Id of records had to be globally unique across all worklists. In this version of the API they just need to be unique within the worklist.

Any record that is updated will be re-screened in the next scheduled screening determined by the worklist.

 

Adding/Updating Many Records

If you want to push more than one record at a time to the monitor API, this can be achieved using the API endpoint accepting an array of monitor records. The maximum number is 25 in a single call and the operation is synchronous.

 

Auto Reviews

When you add a record into the monitor you are able to provide a list of QR codes of ARI profiles that you want to automatically close. This is great if you have already reviewed the results of a realtime search and you don’t want to re-review the matches in the monitor. The matches are still created for audit purposes, but they will automatically be closed.

To use the auto review feature, first create the monitor record as normal, then call the endpoint for /auto-reviews. Below is an example:

curl --silent --location --request PUT 'https://api.acuris.com/compliance-monitor/worklists/WL-1/individuals/MR-1/reviews/auto-reviews' \
--header 'content-type: application/json' \
--header 'x-api-key: xxx' \
--data-raw '{
  "autoReviews": [
    {
      "qrCode": "107164",
      "status": "true-positive",
      "clientRiskRating": "High-Risk",
      "clientComment": "Reviewed as true positive, no risk to the business.",
      "clientUserId": "benjamin.zwahlen"
    },
    {
      "qrCode": "43562",
      "status": "false-positive"
    },
    {
      "qrCode": "854244",
      "clientComment": "Pending review."
    }
  ]
}'