Table of Contents
...
ℹ️ Introduction
This API’s main goal is to screen persons and businesses on an ongoing basis through our AML database.
Authorization
To access our AML screening API you need to provide:
OAuth2 Access Tokens in each request. (Learn how to get an access token here);
Your Application-Id*.
| Info |
|---|
*If you don’t have Application ID, please contact support@ondato.com. |
Request limit
The request limit for this API is 5 requests per second.
...
If you exceed the limit, you will not get the error.
...
.
Monitoring
Monitoring consists of several parts which are described on the pages, listed below.
Setup and manage worklist
Add to monitoring and manage monitoring records
Retrieve and review matches
Subscribe to updates
Check monitoring status
Please visit these pages for detailed descriptions.
Flow
| Drawio |
|---|
| zoom | 1 |
|---|
| simple | 0 |
|---|
| inComment | 0 |
|---|
| pageId | 2355462193 |
|---|
| custContentId | 2354970667 |
|---|
| lbox | 1 |
|---|
| diagramDisplayName | Untitled Diagram.drawio |
|---|
| contentVer | 79 |
|---|
| revision | 79 |
|---|
| baseUrl | https://ondato.atlassian.net/wiki |
|---|
| diagramName | Untitled Diagram.drawio |
|---|
| pCenter | 0 |
|---|
| width | 16511500.9999999999995 |
|---|
| links | |
|---|
| tbstyle | |
|---|
| height | 521 |
|---|
|
...
...
🛂 Authorization
To access our AML screening API you need to provide an access token in each request.
Learn how to get an access token here.
The API has one scope: aml_monitoring_api, which provides access to all endpoints of this API.
...
☁️ Environments
Environment | Swagger URL | Base URL |
|---|
Sandboxadd laterapiacuriscompliance-monitorProd | add later | add later...
📍 Endpoints
This API has the following endpoints:
Setup and manage worklist:
...
| title | Setup and manage worklist: |
|---|
...
...
1️⃣ Worklist endpoints
| Expand |
|---|
|
| Endpoint | Description |
|---|
| 1 | /v1/worklists | Create a new worklist | | 2 | /v1/worklists/{worklistId} |
| Panel |
|---|
|
|
GET | Retrieve a specific worklist |
| 3 | /v1/worklists/{worklistId} | Update an existing worklist |
| 4 | /v1/worklists/{worklistId} |
| Panel |
|---|
|
GET /worklists/ - get all worklists. |
| Panel |
|---|
|
DELETE | Delete a specific worklist |
| 5 | /v1/worklists/search | Get a list of created worklists |
2️⃣ Person monitoring endpoints
| Expand |
|---|
|
| Endpoint | Description |
|---|
| 1 | Monitoring | | 2 | /v1/worklists/{worklistId}/natural-entity-records/search | Get all person records in the monitoring worklist | | 3 | /v1/worklists/{worklistId} |
|
Add to monitoring and manage monitoring records:
| Expand |
|---|
| title | Manage person monitoring |
|---|
|
| Panel |
|---|
|
|
PUT /natural-entity-records/batch-async
| Add multiple person records in the monitoring worklist with asynchronous operation (limit 10k records) |
| 4 | /v1/worklists/{worklistId}/natural-entity-records/batch | Add multiple person records in the monitoring worklist
(limit 25 records) |
| 5 | /v1/worklists/{worklistId}/ |
| Panel |
|---|
|
PUT batch
| Update multiple person records in the monitoring worklist (limit 25 records) |
| 6 | /v1/worklists/{worklistId}/ |
| Panel |
|---|
|
GET natural-entity-records/batch
| Delete multiple person records from the monitoring worklist (limit 25 records) |
| 7 | /v1/worklists/{worklistId}/ |
| Panel |
|---|
|
GET specific person record from the monitoring worklist |
| 8 | /v1/worklists/{worklistId}/ |
| Panel |
|---|
|
DELETE natural-entity-records/{recordId}
| Update a specific person record in the monitoring worklist |
| 9 | /v1/worklists/{worklistId}/ |
| Expand |
|---|
| title | Manage business monitoring |
|---|
|
| Panel |
|---|
|
|
PUT recordId}
| Delete a specific person record from the monitoring worklist |
| 10 | /v1/worklists/{worklistId}/ |
| Panel |
|---|
|
PUT natural-entity-records
| Create a person record in the monitoring worklist |
| 11 | /v1/worklists/{worklistId}/ |
natural-entity-records/batch/{
|
| Panel |
|---|
|
GET | Get batch-async operation results |
| 12 | /v1/worklists/{worklistId}/ |
natural-entity-records/batch/{
|
| Panel |
|---|
|
GET /records
| Get batch-async operation individual records and their status |
| 13 | Retrieve matches |
| 14 | /v1/worklists/{worklistId}/ |
| Panel |
|---|
|
DELETE natural-entity-records/{recordId}/search
| Search for all matches of the specific person record in the monitoring worklist |
| 15 | /v1/worklists/{worklistId}/ |
natural-entity-records/{recordId}/matches/{
|
Retrieve and review matches:
| Expand |
|---|
| title | Retrieve and review person matches |
|---|
|
| Panel |
|---|
|
|
GET matchId}
| Search for a particular match of the specific person record in the monitoring worklist |
| 16 | /v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId}/reviews | Get reviews of the match of the specific person record in the monitoring worklist |
| 17 | /v1/worklists/{worklistId}/ |
| Panel |
|---|
|
PUT /{matchId}/reviews
| Create a review for a specified match |
| 18 | /v1/worklists/{worklistId}/ |
recordId}/matches/reviews
|
| Panel |
|---|
|
GET | Create reviews for multiple matches |
| 19 | Get record details |
| 20 | /v1/natural-entity-details/{resourceId} | Get the profile data of the person that was matched with a record |
3️⃣ Business monitoring endpoints
| Expand |
|---|
|
| Endpoint | Description |
|---|
| 1 | Monitoring | | 2 | /v1/worklists/{worklistId}/legal-entity-records/search | Get all business records in the monitoring worklist | | 3 | /v1/worklists/{worklistId}/ |
| Panel |
|---|
| GET /individuals/{resourceId} - get detailed person info. |
|
| Expand |
|---|
| title | Retrieve and review business matches |
|---|
|
| Panel |
|---|
|
GET /worklists/{worklistId}/businesses/{monitorRecordId}/matches - get business matches. |
| Panel |
|---|
|
PUT /worklists/{worklistId}/businesses/{monitorRecordId}/matches/reviews - change status and add comment. |
| Panel |
|---|
|
GET /worklists/{worklistId}/businesses/{monitorRecordId}/matches/{qrCode}/reviews - get reviews of the business match. |
| Panel |
|---|
|
GET /businesses/{resourceId} - get detailed business info. |
Subscribe to updates:
| Expand |
|---|
| title | Subscribe to updates |
|---|
|
| Panel |
|---|
| PATCH /worklists/{worklistId}/subscriptions - add email subscription to worklist. |
| Panel |
|---|
| GET /worklists/{worklistId}/subscriptions - get emails subscribed to worklist. |
| Panel |
|---|
| DELETE /worklists/{worklistId}/subscriptions - add email subscription to worklist. |
|
Check monitoring status:
| Expand |
|---|
| title | Check monitoring status |
|---|
|
| Panel |
|---|
|
|
GET /screening-status - get status of monitoring processlegal-entity-records/batch-async
| Add multiple business records to the monitoring worklist with asynchronous operation (limit 10k records) |
| 4 | /v1/worklists/{worklistId}/legal-entity-records/batch | Add multiple business records to the monitoring worklist (limit 25 records) |
| 5 | /v1/worklists/{worklistId}/legal-entity-records/batch | Update multiple business records in the monitoring worklist (limit 25 records) |
| 6 | /v1/worklists/{worklistId}/legal-entity-records/batch | Delete multiple business records from the monitoring worklist (limit 25 records) |
| 7 | /v1/worklists/{worklistId}/legal-entity-records/{recordId} | Get a specific business record from the monitoring worklist |
| 8 | /v1/worklists/{worklistId}/legal-entity-records/{recordId} | Update a specific business record in the monitoring worklist |
| 9 | /v1/worklists/{worklistId}/legal-entity-records/{recordId} | Delete a specific business record from the monitoring worklist |
| 10 | /v1/worklists/{worklistId}/legal-entity-records | Create a business record in the monitoring worklist |
| 11 | /v1/worklists/{worklistId}/legal-entity-records/batch/{id} | Get batch-async operation results |
| 12 | /v1/worklists/{worklistId}/legal-entity-records/batch/{id}/records | Get batch-async operation individual records and their status |
| 13 | Retrieve matches |
| 14 | /v1/worklists/{worklistId}/legal-entity-records/{recordId}/search | Search for all matches of a specific business record in the monitoring worklist |
| 15 | /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId} | Search for a particular match of a specific business record in the monitoring worklist |
| 16 | /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 | /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}/reviews | Create a review for a specified match |
| 18 | /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/reviews | Create reviews for multiple matches |
| 19 | Get record details | |
| 20 | /v1/legal-entity-details/{resourceId} | Get the profile data of the business that was matched with a record |
Service status
| Expand |
|---|
|
| Endpoint | Description |
|---|
| 1 | /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:
...
🧑🦰 Person monitoring
To monitor persons, you can use the person monitoring endpoints.
To learn how to add, update, and delete person records in your worklists, as well as how to search for matches and retrieve detailed information, please visit this page:
...
🏢 Business monitoring
To monitor businesses, you can use the business monitoring endpoints.
To learn how to add, update, and delete business records in your worklists, as well as how to search for matches and retrieve detailed information, please visit this page:
...
📁 Datasets
When setting up a worklist, you have to provide the datasets where monitoring records will be screened. Which dataset to provide in the worklist depends on the entity type, you are monitoring. Some datasets are only for person monitoring, others for businesses.
| Info |
|---|
You can find the description of all our datasets here. |
...