...
This API has the following endpoints:
Worklist endpoints
| Expand |
|---|
| Endpoint | Description |
|---|
| 1 | POST /v1/worklists
| Create a new worklist | | 2 | DELETE /v1/worklists/{worklistId}
| Delete a specific worklist | | 3 | PUT /v1/worklists/{worklistId}
| Update an existing worklist | | 4 | GET /v1/worklists/{worklistId}
| Retrieve a specific worklist | | 5 | POST /v1/worklists/search
| Search for worklists based on certain criteria |
|
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 | Add multiple person records in the monitoring worklist | | 4 | PUT /v1/worklists/{worklistId}/natural-entity-records/batch | Update multiple person records in the monitoring worklist | | 5 | DELETE /v1/worklists/{worklistId}/natural-entity-records/batch | Delete multiple person records from the monitoring worklist | | 6 | GET /v1/worklists/{worklistId}/natural-entity-records/{recordId} | Get a specific person record from the monitoring worklist | | 7 | PUT /v1/worklists/{worklistId}/natural-entity-records/{recordId} | Update a specific person record in the monitoring worklist | | 8 | DELETE /v1/worklists/{worklistId}/natural-entity-records/{recordId} | Delete a specific person record from the monitoring worklist | | 9 | POST /v1/worklists/{worklistId}/natural-entity-records/{recordId} | Add a specific person record to the monitoring worklist | | 10 | Retrieve matches | | 11 | POST /v1/worklists/{worklistId}/natural-entity-records/{recordId}/search | Search for all matches of the specific person record in the monitoring worklist | | 12 | GET /v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId} | Search for a particular match of the specific person record in the monitoring worklist | | 13 | Get record details | | | 14 | GET /v1/natural-entity-details/{resourceId} | Get detailed response of the monitored person |
|
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
| Add multiple business records to the monitoring worklist | | 4 | PUT /v1/worklists/{worklistId}/legal-entity-records/batch
| Update multiple business records in the monitoring worklist | | 5 | DELETE /v1/worklists/{worklistId}/legal-entity-records/batch
| Delete multiple business records from the monitoring worklist | | 6 | GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}
| Get a specific business record from the monitoring worklist | | 7 | PUT /v1/worklists/{worklistId}/legal-entity-records/{recordId}
| Update a specific business record in the monitoring worklist | | 8 | DELETE /v1/worklists/{worklistId}/legal-entity-records/{recordId}
| Delete a specific business record from the monitoring worklist | | 9 | POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}
| Add a specific business record to the monitoring worklist | | 10 | Retrieve matches | | 11 | POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}/search
| Search for all matches of a specific business record in the monitoring worklist | | 12 | GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}
| Search for a particular match of a specific business record in the monitoring worklist | | 13 | Get record details | | | 14 | GET /v1/legal-entity-details/{resourceId}
| Get detailed response of the monitored business |
|
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
...