Get Monitor Records in the Worklist

This endpoint will fetch all individual monitor records in the worklist.

Version 1

GEThttps://okaydbdemo.innov8tif.com/ekyc/api/aml/v3/worklists/{worklistId}/individuals?nextToken={nextToken}&apiKey={apiKey}&status={status}&createdDateFrom {createdDateFrom}&createdDateTo={createdDateTo}&pageSize={pageSize}

URL Parameters

Field	Remark
worklistId *	worklistId will be provided
apiKey *	apiKey is used for authentication.
status	Filters monitor records by status. If not present, monitor records having open status are returned. (Optional field)
createdDateFrom	(format: YYYY-MM-DD) Specify the minimum Monitor Record Creation date to filter out all records created before the given date. The parameter only works with conjunction with order by creation date (Ascending or Descending). The creation date is specified in the UTC time zone (Optional field)
createdDateTo	(format: YYYY-MM-DD) Specify the maximum Monitor Record Creation date to filter out all records created after the given date. The parameter only works with conjunction with order by creation date (Ascending or Descending). The creation date is specified in the UTC time zone (Optional field)
nextToken	Leaving this blank will return the first page. Otherwise you can provide the nextToken from a previous lookup to iterate to the next page (Optional field)
pageSize	Defines the number of items to be displayed on one page. If not provided, up to 1MB of data is returned (Optional field)

Sample Request Body

curl --silent --location --request GET 'https://api.acuris.com/compliance-monitor/worklists/WL-1/individuals’

Response Body

Field	Remark
status	Indicate API status. Values can be success, error.
messageCode	Provide error details if status is "error". Values can be: INVALID_API_KEY – invalid api key. MAPI-001– Resource not found (workflowId is not found)
monitorRecords	detail result
monitorRecordsCount	Total number of monitor records
openMonitorRecordsCount	Total number of monitor records with open status
openMatchesCount	No of open matches
truePositiveMatchesCount	No of false true matches
falsePositiveMatchesCount	No of false positive matches
nextToken	Use this value to iterate to the next page

Sample Response Body

Success

{
  "status": "success",
  "messageCode": null,
  "message": null,
  "monitorRecords": [
    {
      "name": "Ahmad Hussain",
      "addresses": [
        {
          "geography": "SY",
          "city": "SY"
        }
      ],
      "dob": "1970-08-22",
      "gender": "male",
      "openDatasets": [
        "DD",
        "INS",
        "PEP-CURRENT",
        "PEP-FORMER",
        "PEP-LINKED",
        "POI",
        "REL",
        "RRE",
        "SAN-CURRENT",
        "SAN-FORMER",
        "GRI"
      ],
      "id": "1",
      "status": "open",
      "openCount": 1,
      "falsePositiveCount": 0,
      "truePositiveCount": 0,
      "discardedCount": 0,
      "createdDateTimeISO": "2021-10-05T10:10:08.270Z",
      "lastUpdatedDateTimeISO": "2021-10-05T10:10:08.270Z",
      "lastNotificationDateISO": "2021-10-05"
    }
  ],
  "monitorRecordsCount": 1,
  "openMonitorRecordsCount": 1,
  "openMatchesCount": 1,
  "falsePositiveMatchesCount": 0,
  "truePositiveMatchesCount": 0,
  "discardedMatchesCount": 0,
  "nextToken": null
}