Getting started
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 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 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 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 | |
Billing (internal use only)
There are some endpoints, which calls are charged by external provider. These endpoints are:
PUT /worklists/{worklistId}/individuals/{monitorRecordId} - add/update single person, providing it’s Id.
PUT /worklists/{worklistId}/businesses/{monitorRecordId}- add/update single business, providing it's Id.
PUT /worklists/{worklistId}/individuals - add/update multiple persons, up to 25.
PUT /worklists/{worklistId}/businesses - add/update multiple businesses, up to 25.
Other AML Monitoring endpoints are free of charge.
Request limit
The request limit for this API is 5 requests per second.
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.
Please visit these pages for detailed descriptions.
Add Comment