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:

OAuth2 Access Tokens in each request. (Learn how to get an access token here);
Your Application-Id*.

*If you don’t have Application ID, please contact support@ondato.com.

Billing

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.

Flow

Endpoints and Environments:

Environment	Swagger URL	Base URL
Sandbox	add later	`https://api.acuris.com/compliance-monitor`
Prod	add later	`add later`

This API has the following endpoints:

Setup and manage worklist:

Setup and manage worklist:

PUT /worklists/{worklistId} - create/update a worklist.

GET /worklists/{worklistId} - get worklist by Id.

GET /worklists/ - get all worklists.

DELETE /worklists/{worklistId} - delete worklist.

Add to monitoring and manage monitoring records:

Manage person monitoring

PUT /worklists/{worklistId}/individuals - add/update multiple persons, up to 25 000.

PUT /worklists/{worklistId}/individuals/{monitorRecordId} - add/update single person, providing it’s Id.

GET /worklists/{worklistId}/individuals/{monitorRecordId} - get a person by Id.

GET /worklists/{worklistId}/individuals - get all persons.

DELETE /worklists/{worklistId}/individuals/{monitorRecordId} - delete person from monitoring.

Manage business monitoring

PUT /worklists/{worklistId}/businesses - add/update multiple businesses, up to 25 000.

PUT /worklists/{worklistId}/businesses/{monitorRecordId}- add/update single business, providing it's Id.

GET /worklists/{worklistId}/businesses/{monitorRecordId} - get a business by Id.

GET /worklists/{worklistId}/businesses - get all businesses.

DELETE /worklists/{worklistId}/businesses/{monitorRecordId} - delete business from monitoring.

Retrieve and review matches:

Retrieve and review person matches

GET /worklists/{worklistId}/individuals/{monitorRecordId}/matches - get person matches.

PUT /worklists/{worklistId}/individuals/{monitorRecordId}/matches/reviews - change status and add comment.

GET /worklists/{worklistId}/individuals/{monitorRecordId}/matches/{qrCode}/reviews - get reviews of the person match.

GET /individuals/{resourceId} - get detailed person info.

Retrieve and review business matches

GET /worklists/{worklistId}/businesses/{monitorRecordId}/matches - get business matches.

PUT /worklists/{worklistId}/businesses/{monitorRecordId}/matches/reviews - change status and add comment.

GET /worklists/{worklistId}/businesses/{monitorRecordId}/matches/{qrCode}/reviews - get reviews of the business match.

GET /businesses/{resourceId} - get detailed business info.

Subscribe to updates:

Subscribe to updates

PATCH /worklists/{worklistId}/subscriptions - add email subscription to worklist.

GET /worklists/{worklistId}/subscriptions - get emails subscribed to worklist.

DELETE /worklists/{worklistId}/subscriptions - add email subscription to worklist.

Check monitoring status:

Check monitoring status

GET /screening-status - get status of monitoring process.

AML Monitoring API Documentation