Cancel monitoring for a subject
DELETE /api/v1/aml/monitor/{monitorId}
DELETE https://api.trustverify.co.uk/api/v1/aml/monitor/{monitorId}
Stops re-screening and frees the subject slot immediately. Returns 200 rather than 204 because the record is kept as evidence of what was monitored and when — it moves to status "cancelled" rather than being deleted. Idempotent. The cancelled record, and the sanctions matches recorded against it, are retained for the statutory period (5 years from cancellation under MLR 2017 reg. 40) and are then permanently deleted; after that the monitor id returns 404.
Parameters#
| Field | Type | Description |
|---|---|---|
| monitorId (path)required | string |
Example request#
curl -sS -X DELETE 'https://api.trustverify.co.uk/api/v1/aml/monitor/mon_123' \
-H "Authorization: Bearer $TRUSTVERIFY_API_KEY"Responses#
200 Cancelled
| Field | Type | Description |
|---|---|---|
| monitorIdrequired | string | |
| entityIdrequired | string | Your own reference for the subject |
| entityTyperequired | string: "individual" | "business" | What the subject was screened as. "business" means it was matched against organisations. |
| namerequired | string | |
| dateOfBirthrequired | string,null | |
| countryrequired | string,null | |
| statusrequired | string: "active" | "suspended" | "cancelled" | |
| suspensionReasonrequired | string,null | plan_lapsed or over_plan_limit when status is suspended |
| checkFrequencyrequired | string | |
| 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. |
| lastRiskLevelrequired | string,null | |
| lastHitCountrequired | number,null | |
| consecutiveFailuresrequired | number | Consecutive failed screens. Non-zero means monitoring is currently degraded for this subject. |
| nextCheckAtrequired | string,null | |
| cancelledAtrequired | string,null | |
| createdAtrequired | string,null | |
| metadatarequired | object | |
| environmentrequired | string |