| Table of Contents | ||||
|---|---|---|---|---|
|
...
Introduction
This API’s main goal is to screen persons and businesses on an ongoing basis through our AML database.
| Drawio | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Authentication
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 | Scopes |
|---|---|---|---|
Sandbox
|
| registries_naturalentityvalidation_api | |
Prod |
| registries_naturalentityvalidation_api |
Endpoints
This API has the following endpoints:
Setup and manage worklist
Endpoint | Description | Link to details | |
|---|---|---|---|
| 1 |
| Create a new worklist | |
| 2 |
| Delete a specific worklist | |
| 3 |
| Update an existing worklist | |
| 4 |
| Retrieve a specific worklist | |
| 5 |
| Search for worklists based on certain criteria |
Person monitoring endpoints
Endpoint | Description | Link to details | |
|---|---|---|---|
| 1 | Monitoring | ||
| 2 | POST | Get all person records in the monitoring worklist | |
| 3 | POST | Add multiple person records in the monitoring worklist | |
| 4 | PUT | Update multiple person records in the monitoring worklist | |
| 5 | DELETE | Delete multiple person records from the monitoring worklist | |
| 6 | GET | Get a specific person record from the monitoring worklist | |
| 7 | PUT | Update a specific person record in the monitoring worklist | |
| 8 | DELETE | Delete a specific person record from the monitoring worklist | |
| 9 | POST | Add a specific person record to the monitoring worklist | |
| 10 | Retrieve matches | ||
| 11 | POST | Search for all matches of the specific person record in the monitoring worklist | |
| 12 | GET | Search for a particular match of the specific person record in the monitoring worklist | |
| 13 | Get record details | ||
| 14 | GET | Get detailed response of the monitored person | |
Business monitoring endpoints
Endpoint | Description | Link to details | |
|---|---|---|---|
| 1 | Monitoring | ||
| 2 |
| Get all business records in the monitoring worklist | |
| 3 |
| Add multiple business records to the monitoring worklist | |
| 4 |
| Update multiple business records in the monitoring worklist | |
| 5 |
| Delete multiple business records from the monitoring worklist | |
| 6 |
| Get a specific business record from the monitoring worklist | |
| 7 |
| Update a specific business record in the monitoring worklist | |
| 8 |
| Delete a specific business record from the monitoring worklist | |
| 9 |
| Add a specific business record to the monitoring worklist | |
| 10 | Retrieve matches | ||
| 11 |
| Search for all matches of a specific business record in the monitoring worklist | |
| 12 |
| Search for a particular match of a specific business record in the monitoring worklist | |
| 13 | Get record details | ||
| 14 |
| 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:
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
TBD later.
Billing (internal use only)
There are some endpoints, which calls are charged by external provider. These endpoints are:
...
| Info |
|---|
If you exceed the limit, you will not get the error. The request call will be moved to the next second. |
Monitoring
Monitoring consists of several parts which are described on the pages, listed below.
...
. |