Table of Contents
| Table of Contents | ||||
|---|---|---|---|---|
|
...
ℹ️ Getting started
AML screening API’s main goal is to search for people and businesses in our datasets. This will give the information if a particular person or business exists in any of our datasets like PEP, Sanctions, Adverse media, etc.
...
🔑 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).
...
🎯 Scopes
When requesting an access token, you can specify one or more authorization scopes to indicate the level of access you require. The available scopes for the AML screening API are:
...
You can request access to one or both of these scopes when obtaining an access token, depending on the type of screening you need to perform.
...
☁️ Endpoints and Environments:
Environment | Swagger URL | Base URL | Scopes |
|---|---|---|---|
Sandbox | https://sandbox-amlscreening.ondato.com/swagger/index.html?urls.primaryName=v2 |
|
|
Prod | https://amlscreening.ondato.com/swagger/index.html?urls.primaryName=v2 |
|
|
There are the following AML screening API endpoints:
...
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
|
...
🚦 Request limit
The request limit for this API is 5 requests per second.
...
📁 Datasets
In the request, you have to provide the dataset in which to perform the search. Which dataset to provide in the request depends on the entity type, you are searching. Some datasets are only for person search, others for businesses.
You can find the description of all our datasets here.
...
🧑🦰 Person AML Screening
You can find detailed instructions on how to use our API for person AML screening here.
...
🏢 Business AML Screening
You can find detailed instructions on how to use our API for business AML screening here.
...