Resource Overview
The API is organised around the following resources. Each resource has list and show endpoints (where applicable), and write endpoints where the resource can be created, updated or deleted via the API. The full request and response schemas, including filters, sort fields and worked examples, live in the API Reference.
| Resource | Key endpoints | Purpose |
|---|---|---|
| Account | GET /v1/account |
Confirm credentials, environment, balance and product entitlements |
| Users | GET /v1/users, GET/PATCH /v1/users/{uuid} |
Read and update portal users on the calling account |
| Programs | GET/POST /v1/programs, GET/PATCH/DELETE /v1/programs/{uuid} |
Logical containers for entities and monitors |
| Entities | GET/POST /v1/programs/{uuid}/entities, GET/PATCH/DELETE /v1/entities/{uuid}, POST /v1/entities/{uuid}/archive, POST /v1/entities/{uuid}/unarchive |
The people, businesses and vessels being monitored |
| Checks (screening) | GET /v1/checks, GET /v1/checks/{uuid}, GET /v1/checks/{uuid}/pdf, POST /v1/entities/{uuid}/checks |
Asynchronous PEP, sanction, business, court, adverse media and similar screening tied to an entity |
| Adhoc checks | GET/POST /v1/adhoc-checks, GET/DELETE /v1/adhoc-checks/{uuid}, GET /v1/adhoc-checks/{uuid}/pdf |
One-off screening against a freeform subject with no entity record |
| ID Checks | GET /v1/id-checks, GET /v1/id-checks/{uuid}, GET /v1/id-checks/{uuid}/pdf, POST /v1/entities/{uuid}/id-checks |
Synchronous identity document verification tied to an entity |
| Adhoc ID Checks | GET/POST /v1/adhoc-id-checks, GET/DELETE /v1/adhoc-id-checks/{uuid}, GET /v1/adhoc-id-checks/{uuid}/pdf |
Synchronous identity verification with no entity record |
| IDPasses | GET /v1/idpasses, GET /v1/idpasses/{uuid}, POST /v1/entities/{uuid}/idpasses, POST /v1/adhoc-idpasses, GET /v1/idpasses/{uuid}/pdf, GET /v1/idpasses/{uuid}/images/{type} |
Asynchronous remote identity verification completed by the individual via a hosted link |
| Monitors | GET/POST /v1/programs/{uuid}/monitors, GET/PATCH/DELETE /v1/monitors/{uuid}, POST /v1/monitors/{uuid}/run |
Scheduled or on-demand screening jobs |
| Events | GET /v1/events, GET/PATCH /v1/events/{uuid} |
The triage queue produced by screening checks |
| Notes | GET /v1/notes, POST /v1/entities/{uuid}/notes, GET/PATCH/DELETE /v1/notes/{uuid} |
Free-text annotations on entities and events |
| Audits | GET /v1/audits, GET /v1/audits/{uuid} |
Full account audit log, including a row for every API call |