AML Monitoring API
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 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 |
---|---|---|---|
Prod |
| aml_monitoring_api |
Endpoints
This API has the following endpoints:
Worklist endpoints
Person monitoring endpoints
Business monitoring endpoints
Service status
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.
You can find the description of all our datasets here.