Read one monitored subject and its match history
GET /api/v1/aml/monitor/{monitorId}
GET https://api.trustverify.co.uk/api/v1/aml/monitor/{monitorId}
Parameters#
| Field | Type | Description |
|---|---|---|
| monitorId (path)required | string |
Example request#
curl -sS -X GET 'https://api.trustverify.co.uk/api/v1/aml/monitor/mon_123' \
-H "Authorization: Bearer $TRUSTVERIFY_API_KEY"Responses#
200 Monitor with every match recorded for it
| 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 | |
| hitsrequired | array of object | |
| hits[].idrequired | string | sanctions and PEP list entity id — the key new matches are diffed on |
| hits[].captionrequired | string | |
| hits[].scorerequired | number,null | |
| hits[].schemarequired | string,null | |
| hits[].datasetsrequired | array of string | |
| hits[].topicsrequired | array of string | |
| hits[].propertiesrequired | object | |
| hits[].isBaselinerequired | boolean | Present at enrolment, so never alerted on |
| hits[].detectedAtrequired | string,null | |
| hits[].alertedAtrequired | string,null | |
| pendingAlertsrequired | number | New matches detected but not yet delivered |