# Get Monitor Records in the Worklist

## Version 1

<mark style="color:yellow;">`GET`</mark>`https://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 <mark style="color:red;">\*</mark> | worklistId will be provided                                                                                                                                                                                                                                                                                                           |
| apiKey <mark style="color:red;">\*</mark>     | apiKey is used for authentication.                                                                                                                                                                                                                                                                                                    |
| status                                        | Filters monitor records by status. If not present, monitor records having open status are returned. (Optional field)                                                                                                                                                                                                                  |
| <p>createdDateFrom<br></p>                    | <p>(format: YYYY-MM-DD)</p><p><br>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). </p><p></p><p>The creation date is specified in the UTC time zone (Optional field)</p>   |
| createdDateTo                                 | <p>(format: YYYY-MM-DD)</p><p></p><p>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). </p><p></p><p>The creation date is specified in the UTC time zone (Optional field)</p> |
| 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               | <p>Provide error details if status is "error". </p><p></p><p>Values can be: </p><ul><li>INVALID\_API\_KEY – invalid api key.</li><li>MAPI-001– Resource not found (workflowId is not found)</li></ul> |
| 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

{% tabs %}
{% tab title="Success" %}

```json
{
  "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
}
```

{% endtab %}
{% endtabs %}