Table of Contents
...
| Expand |
|---|
| Endpoint | Description |
|---|
| 1 | POST /v1/worklists
| Create a new worklist | | 2 | DELETE GET /v1/worklists/{worklistId}
| Delete Retrieve a specific worklist | | 3 | PUT /v1/worklists/{worklistId}
| Update an existing worklist | | 4 | GET DELETE /v1/worklists/{worklistId}
| Retrieve Delete a specific worklist | | 5 | POST /v1/worklists/search
| Search for worklists based on certain criteriaGet a list of created worklists |
|
2️⃣ Person monitoring endpoints
| Expand |
|---|
| Endpoint | Description |
|---|
| 1 | Monitoring | | 2 | POST /v1/worklists/{worklistId}/natural-entity-records/search | Get all person records in the monitoring worklist | | 3 | POST /v1/worklists/{worklistId}/natural-entity-records/batch-async | Add multiple person records in the monitoring worklist with asynchronous operation (limit 10k records) | | 4 | POST /v1/worklists/{worklistId}/natural-entity-records/batch | Add multiple person records in the monitoring worklist
(limit 25 records) | | 5 | PUT /v1/worklists/{worklistId}/natural-entity-records/batch | Update multiple person records in the monitoring worklist (limit 25 records) | | 56 | DELETE /v1/worklists/{worklistId}/natural-entity-records/batch | Delete multiple person records from the monitoring worklist (limit 25 records) | | 67 | GET /v1/worklists/{worklistId}/natural-entity-records/{recordId} | Get a specific person record from the monitoring worklist | | 78 | PUT /v1/worklists/{worklistId}/natural-entity-records/{recordId} | Update a specific person record in the monitoring worklist | | 89 | DELETE /v1/worklists/{worklistId}/natural-entity-records/{recordId} | Delete a specific person record from the monitoring worklist | | 910 | POST /v1/worklists/{worklistId}/natural-entity-records/{recordId} | Add Create a specific person record to in the monitoring worklist | 10 | | 11 | GET /v1/worklists/{worklistId}/natural-entity-records/batch/{id} | Get batch-async operation results | | 12 | GET /v1/worklists/{worklistId}/natural-entity-records/batch/{id}/records | Get batch-async operation individual records and their status | | 13 | Retrieve matches | | 1114 | POST /v1/worklists/{worklistId}/natural-entity-records/{recordId}/search | Search for all matches of the specific person record in the monitoring worklist | | 1215 | GET /v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId} | Search for a particular match of the specific person record in the monitoring worklist | | 16 | GET /v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId}/reviews | Get reviews of the match of the specific person record in the monitoring worklist | | 1317 | POST /v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId}/reviews | Create a review for a specified match | | 18 | POST /v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/reviews | Create reviews for multiple matches | | 19 | Get record details | | | 1420 | GET /v1/natural-entity-details/{resourceId} | Get detailed response the profile data of the monitored person that was matched with a record |
|
3️⃣ Business monitoring endpoints
| Expand |
|---|
| Endpoint | Description |
|---|
| 1 | Monitoring | | 2 | POST /v1/worklists/{worklistId}/legal-entity-records/search
| Get all business records in the monitoring worklist | | 3 | POST /v1/worklists/{worklistId}/legal-entity-records/batch-async
| Add multiple business records to the monitoring worklist with asynchronous operation (limit 10k records) | | 4 | POST /v1/worklists/{worklistId}/legal-entity-records/batch
| Add multiple business records to the monitoring worklist (limit 25 records) | | 5 | PUT /v1/worklists/{worklistId}/legal-entity-records/batch
| Update multiple business records in the monitoring worklist (limit 25 records) | | 56 | DELETE /v1/worklists/{worklistId}/legal-entity-records/batch
| Delete multiple business records from the monitoring worklist (limit 25 records) | | 67 | GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}
| Get a specific business record from the monitoring worklist | | 78 | PUT /v1/worklists/{worklistId}/legal-entity-records/{recordId}
| Update a specific business record in the monitoring worklist | | 89 | DELETE /v1/worklists/{worklistId}/legal-entity-records/{recordId}
| Delete a specific business record from the monitoring worklist | | 910 | POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}
| Add Create a specific business record to in the monitoring worklist | 10 | | 11 | GET /v1/worklists/{worklistId}/legal-entity-records/batch/{id} | Get batch-async operation results | | 12 | GET /v1/worklists/{worklistId}/legal-entity-records/batch/{id}/records | Get batch-async operation individual records and their status | | 13 | Retrieve matches | | 1114 | POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}/search
| Search for all matches of a specific business record in the monitoring worklist | | 1215 | GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}
| Search for a particular match of a specific business record in the monitoring worklist | | 1316 | GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}/reviews | Get reviews of the match of the specific business record in the monitoring worklist | | 17 | POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}/reviews | Create a review for a specified match | | 18 | POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/reviews | Create reviews for multiple matches | | 19 | Get record details | | | 1420 | GET /v1/legal-entity-details/{resourceId}
| Get detailed response the profile data of the monitored businessbusiness that was matched with a record |
|
Monitoring screening status
| Expand |
|---|
| Endpoint | Description |
|---|
| 1 | GET /v1/information/screening-status
| Get the global status of the AML service (screening frequency still depends on individual worklist configuration). |
|
...
⚙️ Worklists
To start monitoring persons or businesses, you need to set up a worklist. To learn how to create, update, and manage your worklists, please visit this page: Setup and manage worklist
...