...
This API’s main goal is to screen persons and businesses on an ongoing basis through our AML database.
Authorization
To access our AML monitoring API you need to provide:
OAuth2 Access Tokens in each request. (Learn how to get an access token here);
Your Application-Id*.
| Info |
|---|
*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:
| Panel |
|---|
|
PUT /worklists/{worklistId}/individuals/{monitorRecordId} - add/update single person, providing it’s Id. |
| Panel |
|---|
|
PUT /worklists/{worklistId}/businesses/{monitorRecordId}- add/update single business, providing it's Id. |
| Panel |
|---|
|
PUT /worklists/{worklistId}/individuals - add/update multiple persons, up to 25. |
| Panel |
|---|
|
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.
| Info |
|---|
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.
Setup and manage worklist
Add to monitoring and manage monitoring records
Retrieve and review matches
Subscribe to updates
Check monitoring status
Please visit these pages for detailed descriptions.
Flow
| Drawio |
|---|
| zoom | 1 |
|---|
| simple | 0 |
|---|
| inComment | 0 |
|---|
| pageId | 2355462193 |
|---|
| custContentId | 2354970667 |
|---|
| lbox | 1 |
|---|
| diagramDisplayName | Untitled Diagram.drawio |
|---|
| contentVer | 8 |
|---|
| revision | 8 |
|---|
| baseUrl | https://ondato.atlassian.net/wiki |
|---|
| diagramName | Untitled Diagram.drawio |
|---|
| pCenter | 0 |
|---|
| width | 1651 |
|---|
| links | |
|---|
| tbstyle | |
|---|
| height | 521 |
|---|
|
...
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
Endpoints
This API has the following endpoints:
...
Add to monitoring and manage monitoring records
Person monitoring:
| Expand |
|---|
| title | Manage person monitoring |
|---|
|
| Panel |
|---|
| PUT /worklists/{worklistId}/individuals - add/update multiple persons, up to 25 000. |
| Panel |
|---|
| PUT /worklists/{worklistId}/individuals/{monitorRecordId} - add/update single person, providing it’s Id. |
| Panel |
|---|
| GET /worklists/{worklistId}/individuals/{monitorRecordId} - get a person by Id. |
| Panel |
|---|
| GET /worklists/{worklistId}/individuals - get all persons. |
| Panel |
|---|
| DELETE /worklists/{worklistId}/individuals/{monitorRecordId} - delete person from monitoring. |
|
Business monitoring:
| Expand |
|---|
| title | Manage business monitoring |
|---|
|
| Panel |
|---|
| PUT /worklists/{worklistId}/businesses - add/update multiple businesses, up to 25 000. |
| Panel |
|---|
| PUT /worklists/{worklistId}/businesses/{monitorRecordId}- add/update single business, providing it's Id. |
| Panel |
|---|
| GET /worklists/{worklistId}/businesses/{monitorRecordId} - get a business by Id. |
| Panel |
|---|
| GET /worklists/{worklistId}/businesses - get all businesses. |
| Panel |
|---|
| DELETE /worklists/{worklistId}/businesses/{monitorRecordId} - delete business from monitoring. |
|
Retrieve and review matches
Person matches:
| Expand |
|---|
| title | Retrieve and review person matches |
|---|
|
| Panel |
|---|
| GET /worklists/{worklistId}/individuals/{monitorRecordId}/matches - get person matches. |
| Panel |
|---|
| PUT /worklists/{worklistId}/individuals/{monitorRecordId}/matches/reviews - change status and add comment. |
| Panel |
|---|
| GET /worklists/{worklistId}/individuals/{monitorRecordId}/matches/{qrCode}/reviews - get reviews of the person match. |
| Panel |
|---|
| GET /individuals/{resourceId} - get detailed person info. |
|
Business matches:
| Expand |
|---|
| title | Retrieve and review business matches |
|---|
|
| Panel |
|---|
| GET /worklists/{worklistId}/businesses/{monitorRecordId}/matches - get business matches. |
| Panel |
|---|
| PUT /worklists/{worklistId}/businesses/{monitorRecordId}/matches/reviews - change status and add comment. |
| Panel |
|---|
| GET /worklists/{worklistId}/businesses/{monitorRecordId}/matches/{qrCode}/reviews - get reviews of the business match. |
| Panel |
|---|
| GET /businesses/{resourceId} - get detailed business info. |
|
Billing (internal use only)
There are some endpoints, which calls are charged by external provider. These endpoints are:
| Panel |
|---|
|
PUT /worklists/{worklistId}/individuals/{monitorRecordId} - add/update single person, providing it’s Id. |
| Panel |
|---|
|
PUT /worklists/{worklistId}/businesses/{monitorRecordId}- add/update single business, providing it's Id. |
| Panel |
|---|
|
PUT /worklists/{worklistId}/individuals - add/update multiple persons, up to 25. |
| Panel |
|---|
|
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.
| Info |
|---|
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.
Setup and manage worklist
Add to monitoring and manage monitoring records
Retrieve and review matches
Subscribe to updates
Check monitoring status
Please visit these pages for detailed descriptions.