Data Portal » API Data Feeds » KYC6 Monitor API 3.0 » Documentation

KYC6 Monitor API 3.0

Table of contents

Table of contents

Documentation
Overview and quick start
Monitor Datasets
Technical Details
Authentication
Example usage
Worklist Setup
Managing Your Records
Fetching Matches
Pagination
Closing Matches
Match Reopening Logic
Changelog
Changelog

Getting the Match Summary

Once the monitoring has run, you can query the worklist endpoint to get a summary of the number of open matches pending review. Here’s an example of the call:

curl --silent --location --request GET 'https://api.acuris.com/compliance-monitor/worklists/WL-1/individuals?status=open' \
--header 'x-api-key: xxx'

The response would look like this:

{
    "monitorRecords": [
		{
		  "name": "Boyko Borissov",
		  "countries": [
			"BG"
		  ],
		  "dob": "1994-08-22",
		  "gender": "male",
		  "id": "MR-1",
		  "openCount": 1,
		  "falsePositiveCount": 0,
		  "truePositiveCount": 0,
		  "createdDateTimeISO": "2021-10-05T10:10:08.270Z",
		  "lastUpdatedDateTimeISO": "2021-10-05T10:10:08.270Z"
    	}
	],
    "monitorRecordsCount": 2,
    "openMonitorRecordsCount": 1,
    "openMatchesCount": 1,
    "falsePositiveMatchesCount": 0,
    "truePositiveMatchesCount": 0
}
  • “monitorRecordsCount”: 2  – This indicates there are 2 individual monitor records in the requested worklist.
  • “openMonitorRecordsCount”: 1  – This indicates that, in the worklist specified, there is 1 monitor record that has at least 1 open match associated with it.
  • “openMatchesCount”: 1 – In the worklist specified, there is a total of 1 open match across all the monitor records to be reviewed.
  • “falsePositiveMatchesCount”: 0, “truePositiveMatchesCount”: 0 – This summarizes how many existing matches, in the worklist specified, have been closed as either false positive or true positive.

Matches per Monitor Record

In order to review the matches for a monitor record you need to call the API endpoint that will fetch the matches. Note that the API will return all matches for a given monitor record, not just the open ones. The below example shows how to retrieve the matches for a monitor record with Id “MR-1” in worklist “WL-1”.

curl --silent --location --request GET 'https://api.acuris.com/compliance-monitor/worklists/WL-1/individuals/MR-1/matches' \
--header 'x-api-key: xxx'

The list of matches will look something like this:

{
  "matches": [
    {
      "currentStatus": "open",
      "qrCode": 432523,
      "version": 15346444345,
      "profileUri": "/individuals/1f5a940e6a16d390bfe75055c3176f64c5b397880ff08e04b61ad7325af76cc4",
      "resourceId": "1f5a940e6a16d390bfe75055c3176f64c5b397880ff08e04b61ad7325af76cc4",
      "score": 99,
      "match": "Boyko Borissov",
      "name": "Boyko Metodiev Borisov",
      "countries": [
        "BG"
      ],
      "datesOfBirth": [
        "1994",
        "1994-08-22"
      ],
      "gender": "male",
	  "profileImage": "https://www.acurisriskintelligence.com/cdn/content/0024300000/0024297990.jpg",
      "datasets": [
        "PEP-FORMER",
        "INS"
      ]
    }
  ]
}

The list shows the summaries of the matches much like you would see if you were looking at a list of matches from a search. You can fetch the full ARI profile using the resourceId.