Table of Contents
ℹ️ Introduction
Once monitoring rules in the worklist are set up, you can do the following actions with businesses:
Manage business records:
Add a business to monitoring
Remove business from monitoring
Update business record
Get business records
Retrieve business matches
Get monitored business match details
⚙️ Manage Business Records
1️⃣ Start monitoring a business
To start monitoring business, add it to the monitoring worklist.
To do this, call the following endpoint:
POST /v1/worklists/{worklistId}/legal-entity-records
This endpoint only capable to add 1 business at a time. To add multiple businesses in one request, please check out the next section.
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🎯 Request body
Field | Type | Required | Description |
---|---|---|---|
| string | YES | The name of the business. |
| string | NO | A unique identifier for the business’es reference in the system. |
| string | NO | User created reference for the business in the system, for example "My Reference". |
🥫 Response
After successfully creating a business record you’ll get a response with success code 201: Created
and recordId
of the business for subsequent calls
Field | Type | Description |
---|---|---|
| string | The |
2️⃣ Bulk add businesses to the monitoring
You can add multiple businesses to the monitoring with one call.
To do this, call the following endpoint:
POST /v1/worklists/{worklistId}/legal-entity-records/batch
This endpoint capable to add up to 25 records with one call.
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🎯 Request body
Field | Type | Required | Description |
---|---|---|---|
| array<object> | - | An array of objects representing the business records. |
legalEntityRecords. | string | YES | The name of the business. |
legalEntityRecords. | string | NO | A unique identifier for the business’es reference in the system. |
legalEntityRecords. | string | NO | User created reference for the business in the system, for example "My Reference". |
🥫 Response
After successfully creating a business records you’ll get a response with success code 200: Success
with fields:
Field | Type | Description |
---|---|---|
| boolean | A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects. |
| array | An array of objects representing the records in the response. |
records. | string | The unique identifier for the record in the system. |
records. | string | The date and time when the record was created in ISO 8601 format. |
records. | string | The name of the business. |
records. | string | A unique identifier for the business’es reference in the system. |
records. | string | User created reference for the business in the system, for example "My Reference". |
records. | object | An optional object containing information about any errors associated with the record. |
records.error. | string | A string code identifying the type of error that occurred. |
records.error. | string | A human-readable message describing the error that occurred. |
3️⃣ Stop monitoring a business
To stop monitoring the business, remove it from the monitoring worklist.
To do this, call the following endpoint:
DELETE /v1/worklists/{worklistId}/legal-entity-records/{recordId}
This endpoint only capable to remove 1 business at a time. To remove multiple businesses in one request, please check out the section below.
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
recordId | string | YES | The unique Id of the business to update. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🥫 Response
After successfully deleting the business record from monitoring, you’ll get a response with success code 204: No Content
.
4️⃣ Bulk remove businesses from monitoring
You can remove multiple businesses from the monitoring with one call.
To do this, call the following endpoint:
DELETE /v1/worklists/{worklistId}/legal-entity-records/batch
This endpoint capable to remove up to 25 records with one call.
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🎯 Request body
Field | Type | Required | Description |
---|---|---|---|
| array<object> | - | An array of objects representing id’s of business records. |
legalEntityRecords. | string | The |
🥫 Response
After successfully deleting business records from monitoring, you’ll get a response with success code 200: Success
with fields:
Field | Type | Description |
---|---|---|
| boolean | A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects. |
| array | An array of objects representing the records in the response. |
deletedRecords. | string | The |
deletedRecords. | object | An optional object containing information about any errors associated with the record. |
deletedRecords.error. | string | A string code identifying the type of error that occurred. |
deletedRecords.error. | string | A human-readable message describing the error that occurred. |
5️⃣ Update business monitoring record
You can update existing business record.
To do this, call the following endpoint:
PUT /v1/worklists/{worklistId}/legal-entity-records/{recordId}
This endpoint only capable to update 1 business at a time. To update multiple businesses in one request, please see the next section.
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
recordId | string | YES | The unique Id of the business to update. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🎯 Request body
Field | Type | Required | Description |
---|---|---|---|
| string | YES | The updated name of the business. |
| string | NO | An updated identifier for the business’es reference in the system. |
| string | NO | An updated reference for the business in the system. |
🥫 Response
After successfully updating a business record, you’ll get a response with success code 204: No Content
.
6️⃣ Bulk update business monitoring records
You can update multiple businesses with one call.
To do this, call the following endpoint:
PUT /v1/worklists/{worklistId}/legal-entity-records/batch
This endpoint capable to update up to 25 records with one call.
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🎯 Request body
Field | Type | Required | Description |
---|---|---|---|
| array<object> | - | An array of objects representing the business records. |
legalEntityRecords. | string | YES | The updated name of the business. |
legalEntityRecords. | string | NO | An updated identifier for the business’es reference in the system. |
legalEntityRecords. | string | NO | Updated reference for the business in the system. |
legalEntityRecords. | string | YES | The unique Id of the business which will be updated. |
🥫 Response
After successfully updating business records, you’ll get a response with success code 200: Success
with fields:
Field | Type | Description |
---|---|---|
| boolean | A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects. |
| array | An array of objects representing the records in the response. |
records. | string | The unique identifier for the record in the system. |
records. | string | The date and time when the record was created in ISO 8601 format. |
records. | string | The name of the business. |
records. | string | A unique identifier for the business’es reference in the system. |
records. | string | User created reference for the business in the system, for example "My Reference". |
records. | object | An optional object containing information about any errors associated with the record. |
records.error. | string | A string code identifying the type of error that occurred. |
records.error. | string | A human-readable message describing the error that occurred. |
7️⃣ Retrieve a specific business monitoring record
You can retrieve information about a specific business record.
To do this, call the following endpoint:
GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}
This endpoint only capable to retrieve 1 business at a time. To retrive multiple businesses in one request, please see the next section.
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
recordId | string | YES | The unique Id of the business to retrieve. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🥫 Response
After successfully retrieving a business record you’ll get a response with success code 200: Success
with fields:
Field | Type | Description |
---|---|---|
| string | The unique identifier for the record in the system. |
| string | Date and time when the response was created. |
| string | The name of the business associated with the response. |
| string | A unique identifier for the business’es reference in the system. |
| string | User created reference for the business in the system, for example "My Reference". |
| integer | The number of open matches for the monitor record |
| integer | The number of matches already closed as false positive |
| integer | The number of matches already closed as true positive. |
| integer | The number of matches already discarded. |
| string | Date and time when the business record was first created. |
| string | Date and time when the business record was last updated. |
8️⃣ Retrieve all business monitoring records
You can retrieve information about all business records in the worklist.
To do this, call the following endpoint:
POST /v1/worklists/{worklistId}/legal-entity-records/search
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🎯 Request body
All request fields are optional. They can be passed to narrow the search.
Field | Type | Required | Description |
---|---|---|---|
| string | NO | The unique identifier for the record in the system. |
| string | NO | The name of the business. |
| string | NO | A unique identifier for the business’es reference in the system. |
| string | NO | User created reference for the business in the system, for example "My Reference". |
| string | NO | Date FROM when business record was added to worklist. Response will return business records added after this date. |
| string | NO | Date TO when business record was added to worklist. Response will return business records added before this date. |
🥫 Response
After successfully retrieving a business records, you’ll get a response with success code 200: Success
with fields:
Field | Type | Description |
---|---|---|
| boolean | A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects. |
| array | An array of objects representing the records in the response. |
records. | string | The unique identifier for the record in the system. |
records. | string | The date and time when the record was created in ISO 8601 format. |
records. | string | The name of the business. |
records. | string | A unique identifier for the business’es reference in the system. |
records. | string | User created reference for the business in the system, for example "My Reference". |
records. | object | An optional object containing information about any errors associated with the record. |
records.error. | string | A string code identifying the type of error that occurred. |
records.error. | string | A human-readable message describing the error that occurred. |
🛒 Retrieve Business Matches
If any of your monitored business records gets a match in our AML datasets, you can retrieve it.
1️⃣ Retrieve all matches of the business
You can retrieve all matches of the business.
To do this, call the following endpoint:
POST /v1/worklists/{worklistId}/legal-entity-records/{recordId}/search
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
recordId | string | YES | The unique Id of the business record to retrieve. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🥫 Response
After successfully retrieving the business matches you’ll get a response with success code 201: Created
with fields:
Field | Type | Description |
---|---|---|
| integer | Total number of matches. |
| array<object> | An array of objects representing the match information. |
matches. | string | Current status of the business match. Possible enum values:
|
matches. | string | The unique Id of the business match. |
matches. | integer | Can be used to detect when the profile has changed. |
matches. | string | The unique id that can be used to retrieve the detailed information about business profile via |
matches. | integer | The match score. This means how accurate the found business match the monitored business. E.g. Possible values from |
matches. | string | The business name that has been matched in the monitoring. |
matches. | string | The name of the found business. |
matches. | string | The list of countries from the addresses and nationalities of the profile. |
matches. | string | Active datasets where business is tagged in. Possible enum values are any of the described datasets here. |
matches. | integer | This value can be used for version control. |
2️⃣ Retrieve a specific match of the business
You can retrieve a specific business' match.
To do this, call the following endpoint:
GET /v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
worklistId | string | YES | The unique Id of the worklist. |
recordId | string | YES | The unique Id of the business record to retrieve. |
matchId | string | YES | The unique Id of the business match to retrieve. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🥫 Response
After successfully retrieving a business match you’ll get a response with success code 200: Success
with fields:
Field | Type | Description |
---|---|---|
| string | Current status of the business match. Possible enum values:
|
| string | The unique Id of the business match. |
| string | Can be used to detect when the profile has changed. |
| string | The unique id that can be used to retrieve the detailed information about business profile via |
| string | The match score. This means how accurate the found business match the monitored business. E.g. Possible values from |
| integer | The business name that has been matched in the monitoring. |
| integer | The name of the found business. |
| integer | The list of countries from the addresses and nationalities of the profile. |
| integer | Active datasets where business is tagged in. Possible enum values are any of the described datasets here. |
| string | This value can be used for version control. |
📥 Get Monitored Business Match Details
After retrieving the business match, you can get detailed information about a matched business.
To do this, call the following endpoint:
GET /v1/legal-entity-details/{resourceId}
🔠 Headers
Parameter | Type | Required | Description |
---|---|---|---|
resourceId | string | YES | The unique Id of the matched business profile to retrieve the detailed information. |
Correlation-Id | string | NO | A unique identifier assigned to the request. |
Application-Id | string | NO | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
🥫 Response
After successfully retrieving details of the matched business profile, you’ll get a response with success code 200: Success
and the response.
The response structure is the same as for our AML Screening response. You can check it out here: https://ondato.atlassian.net/wiki/spaces/PUB/pages/2379743233/Business+AML+Screening#2%EF%B8%8F%E2%83%A3-Response-data.1
0 Comments