Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 103 Next »

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:

  • aml_screening_natural_api: Provides access to the natural person screening endpoint.

  • aml_screening_legal_api: Provides access to the legal person screening endpoint.

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

https://sandbox-amlscreening.ondato.com

  • aml_screening_natural_api

  • aml_screening_legal_api

Prod

https://amlscreening.ondato.com/swagger/index.html?urls.primaryName=v2

https://amlscreening.ondato.com

  • aml_screening_natural_api

  • aml_screening_legal_api


There are the following AML screening API endpoints:

For Persons:

 Person endpoints

POST /v2/natural-entities/search - search for person.

GET /v2/natural-entities/{resourceId} - get person’s details.

GET /v2/natural-entities/search/{resourceId} - get saved person’s search response.

For Businesses:

 Business endpoints

POST /v2/legal-entities/search - search for business.

GET /v2/legal-entities/{resourceId} - get business’es details.

GET /v2/legal-entities/search/{resourceId} - get saved business’es search response.


đŸšĻ 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.


  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.