List monitored subjects
GET /api/v1/aml/monitor
GET https://api.trustverify.co.uk/api/v1/aml/monitor
Returns this account's monitors, newest first. lastScreenedAt and consecutiveFailures let you verify monitoring is actually running rather than taking it on trust.
Parameters#
| Field | Type | Description |
|---|---|---|
| status (query) | active | suspended | cancelled | |
| entityId (query) | string | |
| limit (query) | number | |
| offset (query) | number |
Example request#
curl -sS -X GET 'https://api.trustverify.co.uk/api/v1/aml/monitor' \
-H "Authorization: Bearer $TRUSTVERIFY_API_KEY"Responses#
200 Monitors
| Field | Type | Description |
|---|---|---|
| monitorsrequired | array of object | |
| monitors[].monitorIdrequired | string | |
| monitors[].entityIdrequired | string | Your own reference for the subject |
| monitors[].entityTyperequired | string: "individual" | "business" | What the subject was screened as. "business" means it was matched against organisations. |
| monitors[].namerequired | string | |
| monitors[].dateOfBirthrequired | string,null | |
| monitors[].countryrequired | string,null | |
| monitors[].statusrequired | string: "active" | "suspended" | "cancelled" | |
| monitors[].suspensionReasonrequired | string,null | plan_lapsed or over_plan_limit when status is suspended |
| monitors[].checkFrequencyrequired | string | |
| monitors[].lastScreenedAtrequired | string,null | The last screen that actually COMPLETED. Never advanced by a failed attempt, so it bounds the window in which a new match could have appeared unnoticed. |
| monitors[].lastRiskLevelrequired | string,null | |
| monitors[].lastHitCountrequired | number,null | |
| monitors[].consecutiveFailuresrequired | number | Consecutive failed screens. Non-zero means monitoring is currently degraded for this subject. |
| monitors[].nextCheckAtrequired | string,null | |
| monitors[].cancelledAtrequired | string,null | |
| monitors[].createdAtrequired | string,null | |
| monitors[].metadatarequired | object | |
| monitors[].environmentrequired | string | |
| totalrequired | number | |
| limitrequired | number | |
| offsetrequired | number | |
| quotarequired | object | |
| quota.limitrequired | number,null | |
| quota.activerequired | number | |
| quota.remainingrequired | number,null |