Skip to end of metadata
Go to start of metadata

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

Compare with Current View Version History

« Previous Version 65 Next »

Table of Contents


ℹī¸ Introduction

This API’s main goal is to screen persons and businesses on an ongoing basis through our AML database.


🛂 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

Prod

https://amlmonitoring.ondato.com/swagger/index.html

https://amlmonitoring.ondato.com

aml_monitoring_api


đŸ˜ļ‍đŸŒĢī¸ Endpoints

This API has the following endpoints:

1ī¸âƒŖ Worklist endpoints

 Click here to expand...

Endpoint

Description

1

POST /v1/worklists

Create a new worklist

2

DELETE /v1/worklists/{worklistId}

Delete a specific worklist

3

PUT /v1/worklists/{worklistId}

Update an existing worklist

4

GET /v1/worklists/{worklistId}

Retrieve a specific worklist

5

POST /v1/worklists/search

Search for worklists based on certain criteria

2ī¸âƒŖ Person monitoring endpoints

 Click here to expand...

Endpoint

Description

1

Monitoring

2

POST /v1/worklists/{worklistId}/natural-entity-records/search

Get all person records in the monitoring worklist

3

POST /v1/worklists/{worklistId}/natural-entity-records/batch

Add multiple person records in the monitoring worklist

4

PUT /v1/worklists/{worklistId}/natural-entity-records/batch

Update multiple person records in the monitoring worklist

5

DELETE /v1/worklists/{worklistId}/natural-entity-records/batch

Delete multiple person records from the monitoring worklist

6

GET /v1/worklists/{worklistId}/natural-entity-records/{recordId}

Get a specific person record from the monitoring worklist

7

PUT /v1/worklists/{worklistId}/natural-entity-records/{recordId}

Update a specific person record in the monitoring worklist

8

DELETE /v1/worklists/{worklistId}/natural-entity-records/{recordId}

Delete a specific person record from the monitoring worklist

9

POST /v1/worklists/{worklistId}/natural-entity-records/{recordId}

Add a specific person record to the monitoring worklist

10

Retrieve matches

11

POST /v1/worklists/{worklistId}/natural-entity-records/{recordId}/search

Search for all matches of the specific person record in the monitoring worklist

12

GET /v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId}

Search for a particular match of the specific person record in the monitoring worklist

13

Get record details

14

GET /v1/natural-entity-details/{resourceId}

Get detailed response of the monitored person

3ī¸âƒŖ Business monitoring endpoints

 Click here to expand...

Endpoint

Description

1

Monitoring

2

POST /v1/worklists/{worklistId}/legal-entity-records/search

Get all business records in the monitoring worklist

3

POST /v1/worklists/{worklistId}/legal-entity-records/batch

Add multiple business records to the monitoring worklist

4

PUT /v1/worklists/{worklistId}/legal-entity-records/batch

Update multiple business records in the monitoring worklist

5

DELETE /v1/worklists/{worklistId}/legal-entity-records/batch

Delete multiple business records from the monitoring worklist

6

GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}

Get a specific business record from the monitoring worklist

7

PUT /v1/worklists/{worklistId}/legal-entity-records/{recordId}

Update a specific business record in the monitoring worklist

8

DELETE /v1/worklists/{worklistId}/legal-entity-records/{recordId}

Delete a specific business record from the monitoring worklist

9

POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}

Add a specific business record to the monitoring worklist

10

Retrieve matches

11

POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}/search

Search for all matches of a specific business record in the monitoring worklist

12

GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}

Search for a particular match of a specific business record in the monitoring worklist

13

Get record details

14

GET /v1/legal-entity-details/{resourceId}

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: Setup and manage worklist


🧑‍đŸĻ° 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: Person AML Monitoring


đŸĸ 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: Business AML Monitoring


📁 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.


  • No labels