ℹ️ 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
`name`	string	YES	The name of the business.
`referenceId`	string	NO	A unique identifier for the business’es reference in the system.
`referenceType`	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
`id`	string	The `recordId` of the business for subsequent calls.

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
`legalEntityRecords`	array<object>	-	An array of objects representing the business records.
legalEntityRecords.`name`	string	YES	The name of the business.
legalEntityRecords.`referenceId`	string	NO	A unique identifier for the business’es reference in the system.
legalEntityRecords.`referenceType`	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
`hasErrors`	boolean	A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects.
`records`	array	An array of objects representing the records in the response.
records.`id`	string	The unique identifier for the record in the system.
records.`createdAt`	string	The date and time when the record was created in ISO 8601 format.
records.`name`	string	The name of the business.
records.`referenceId`	string	A unique identifier for the business’es reference in the system.
records.`referenceType`	string	User created reference for the business in the system, for example "My Reference".
records.`error`	object	An optional object containing information about any errors associated with the record.
records.error.`code`	string	A string code identifying the type of error that occurred.
records.error.`message`	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
`legalEntityRecords`	array<object>	-	An array of objects representing id’s of business records.
legalEntityRecords.`id`	string		The `recordId` of the business to be removed.

🥫 Response

After successfully deleting business records from monitoring, you’ll get a response with success code 200: Success with fields:

Field	Type	Description
`hasErrors`	boolean	A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects.
`deletedRecords`	array	An array of objects representing the records in the response.
deletedRecords.`id`	string	The `recordId` of the removed business.
deletedRecords.`error`	object	An optional object containing information about any errors associated with the record.
deletedRecords.error.`code`	string	A string code identifying the type of error that occurred.
deletedRecords.error.`message`	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
`name`	string	YES	The updated name of the business.
`referenceId`	string	NO	An updated identifier for the business’es reference in the system.
`referenceType`	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
`legalEntityRecords`	array<object>	-	An array of objects representing the business records.
legalEntityRecords.`name`	string	YES	The updated name of the business.
legalEntityRecords.`referenceId`	string	NO	An updated identifier for the business’es reference in the system.
legalEntityRecords.`referenceType`	string	NO	Updated reference for the business in the system.
legalEntityRecords.`id`	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
`hasErrors`	boolean	A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects.
`records`	array	An array of objects representing the records in the response.
records.`id`	string	The unique identifier for the record in the system.
records.`createdAt`	string	The date and time when the record was created in ISO 8601 format.
records.`name`	string	The name of the business.
records.`referenceId`	string	A unique identifier for the business’es reference in the system.
records.`referenceType`	string	User created reference for the business in the system, for example "My Reference".
records.`error`	object	An optional object containing information about any errors associated with the record.
records.error.`code`	string	A string code identifying the type of error that occurred.
records.error.`message`	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
`id`	string	The unique identifier for the record in the system.
`createdAt`	string	Date and time when the response was created.
`name`	string	The name of the business associated with the response.
`referenceId`	string	A unique identifier for the business’es reference in the system.
`referenceType`	string	User created reference for the business in the system, for example "My Reference".
`openCount`	integer	The number of open matches for the monitor record
`falsePositiveCount`	integer	The number of matches already closed as false positive
`truePositiveCount`	integer	The number of matches already closed as true positive.
`discardedCount`	integer	The number of matches already discarded.
`createdDateTimeIso`	string	Date and time when the business record was first created.
`lastUpdatedDateTimeIso`	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
`id`	string	NO	The unique identifier for the record in the system.
`name`	string	NO	The name of the business.
`referenceId`	string	NO	A unique identifier for the business’es reference in the system.
`referenceType`	string	NO	User created reference for the business in the system, for example "My Reference".
`from`	string	NO	Date FROM when business record was added to worklist. Response will return business records added after this date.
`to`	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
`hasErrors`	boolean	A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects.
`records`	array	An array of objects representing the records in the response.
records.`id`	string	The unique identifier for the record in the system.
records.`createdAt`	string	The date and time when the record was created in ISO 8601 format.
records.`name`	string	The name of the business.
records.`referenceId`	string	A unique identifier for the business’es reference in the system.
records.`referenceType`	string	User created reference for the business in the system, for example "My Reference".
records.`error`	object	An optional object containing information about any errors associated with the record.
records.error.`code`	string	A string code identifying the type of error that occurred.
records.error.`message`	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
`totalCount`	integer	Total number of matches.
`matches`	array<object>	An array of objects representing the match information.
matches.`currentStatus`	string	Current status of the business match. Possible enum values: `Open` - match requires review. `TruePositive` - match closed as true positive `FalsePositive` - match closed as false positive `Discarded` - match was discarded
matches.`matchId`	string	The unique Id of the business match.
matches.`version`	integer	Can be used to detect when the profile has changed.
matches.`resourceId`	string	The unique id that can be used to retrieve the detailed information about business profile via `GET /v1/legal-entity-details/{resourceId}` endpoint.
matches.`score`	integer	The match score. This means how accurate the found business match the monitored business. E.g. `"score": 100` means that the found business is the exact match to the provided in the monitoring. Possible values from `75` to `100`
matches.`match`	string	The business name that has been matched in the monitoring.
matches.`name`	string	The name of the found business.
matches.`countries`	string	The list of countries from the addresses and nationalities of the profile.
matches.`dataSets`	string	Active datasets where business is tagged in. Possible enum values are any of the described datasets here.
matches.`matchVersion`	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
`currentStatus`	string	Current status of the business match. Possible enum values: `Open` - match requires review. `TruePositive` - match closed as true positive `FalsePositive` - match closed as false positive `Discarded` - match was discarded
`matchId`	string	The unique Id of the business match.
`version`	string	Can be used to detect when the profile has changed.
`resourceId`	string	The unique id that can be used to retrieve the detailed information about business profile via `GET /v1/legal-entity-details/{resourceId}` endpoint.
`score`	string	The match score. This means how accurate the found business match the monitored business. E.g. `"score": 100` means that the found business is the exact match to the provided in the monitoring. Possible values from `75` to `100`
`match`	integer	The business name that has been matched in the monitoring.
`name`	integer	The name of the found business.
`countries`	integer	The list of countries from the addresses and nationalities of the profile.
`dataSets`	integer	Active datasets where business is tagged in. Possible enum values are any of the described datasets here.
`matchVersion`	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

🗂️ Code Examples

1️⃣ Start monitoring a business

🗒️ Example request

Expand to see the example request

{
  "name": "Business Name",
  "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
  "referenceType": "My Reference"
}

🗒️ Example response

Expand to see the example response

{
  "id": "54d0e87303644a599651f7d0bab9e952"
}

2️⃣ Bulk add multiple businesses to the monitoring

🗒️ Example request

Expand to see the example request

{
  "legalEntityRecords": [
    {
      "name": "Business name",
      "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
      "referenceType": "My Reference"
    }
  ]
}

🗒️ Example response

Expand to see the example response

{
  "hasErrors": false,
  "records": [
    {
      "id": "b078226e94d844c99a681dad7f61dce8",
      "createdAt": "2023-03-20T09:45:38.768Z",
      "name": "Business name",
      "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
      "referenceType": "My Reference",
      "error": {
        "code": "MS101",
        "message": "Error message"
      }
    }
  ]
}

3️⃣ Bulk remove businesses from monitoring

🗒️ Example request

Expand to see the example request

{
  "legalEntityRecords": [
    {
      "id": "b078226e94d844c99a681dad7f61dce8"
    }
  ]
}

🗒️ Example response

Expand to see the example response

{
  "hasErrors": true,
  "deletedRecords": [
    {
      "id": "b078226e94d844c99a681dad7f61dce8",
      "error": {
        "code": "MS101",
        "message": "Error message"
      }
    }
  ]
}

4️⃣ Update business monitoring record

🗒️ Example request

Expand to see the example request

{
  "name": "Business Name",
  "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
  "referenceType": "My Reference"
}

5️⃣ Bulk update business monitoring records

🗒️ Example request

Expand to see the example request

{
  "legalEntityRecords": [
    {
      "name": "Business name",
      "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
      "referenceType": "My Reference",
      "id": "b078226e94d844c99a681dad7f61dce8"
    }
  ]
}

🗒️ Example response

Expand to see the example response

{
  "hasErrors": false,
  "records": [
    {
      "id": "b078226e94d844c99a681dad7f61dce8",
      "createdAt": "2023-03-20T09:45:38.768Z",
      "name": "Business name",
      "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
      "referenceType": "My Reference",
      "error": {
        "code": "MS101",
        "message": "Error message"
      }
    }
  ]
}

6️⃣ Retrieve a specific business monitoring record

🗒️ Example response

Expand to see the example response

{
  "id": "b078226e94d844c99a681dad7f61dce8",
  "createdAt": "2023-03-20T10:04:13.335Z",
  "name": "Business name",
  "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
  "referenceType": "My Reference",
  "openCount": 0,
  "falsePositiveCount": 0,
  "truePositiveCount": 0,
  "discardedCount": 0,
  "createdDateTimeIso": "2021-10-05T10:10:08.270Z",
  "lastUpdatedDateTimeIso": "2021-10-05T10:10:08.270Z"
}

7️⃣ Retrieve all business monitoring records

🗒️ Example request

Expand to see the example request

{
  "id": "b078226e94d844c99a681dad7f61dce8",
  "name": "Business name",
  "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
  "referenceType": "My Reference",
  "from": "2023-01-01",
  "to": "2023-12-31"
}

🗒️ Example response

Expand to see the example response

{
  "hasErrors": false,
  "records": [
    {
      "id": "b078226e94d844c99a681dad7f61dce8",
      "createdAt": "2023-03-20T10:05:07.600Z",
      "name": "Business name",
      "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
      "referenceType": "My Reference",
      "error": {
        "code": "MS101",
        "message": "Error message"
      }
    }
  ]
}

8️⃣ Retrieve all matches of the business

🗒️ Example response

Expand to see the example response

{
  "totalCount": 15,
  "matches": [
    {
      "currentStatus": "Open",
      "matchId": "432523",
      "version": 15346444345,
      "resourceId": "1f5a940e6a16d390bfe75055c3176f64c5b397880ff08e04b61ad7325af76cc4",
      "score": 100,
      "match": "Business name",
      "name": "Found Business name",
      "countries": [
        "US"
      ],
      "dataSets": [
        "OndatoSanctions",
        "ExternalSanctionsCurrent"
      ],
      "matchVersion": 1
    }
  ]
}

9️⃣ Retrieve a specific match of the business

🗒️ Example response

Expand to see the example response

{
  "currentStatus": "Open",
  "matchId": "432523",
  "version": 15346444345,
  "resourceId": "1f5a940e6a16d390bfe75055c3176f64c5b397880ff08e04b61ad7325af76cc4",
  "score": 100,
  "match": "Business name",
  "name": "Found Business name",
  "countries": [
    "US"
  ],
  "dataSets": [
    "OndatoSanctions",
    "ExternalSanctionsCurrent"
  ],
  "matchVersion": 1
}

🔟 Get monitored business match details

Example can be found here:
- https://ondato.atlassian.net/wiki/spaces/PUB/pages/2379743233/Business+AML+Screening#%F0%9F%97%92%EF%B8%8F-Example.1

Business AML Monitoring

ℹ️ Introduction

⚙️ Manage Business Records

1️⃣ Start monitoring a business

🔠 Headers

🎯 Request body

🥫 Response

2️⃣ Bulk add businesses to the monitoring

🔠 Headers

🎯 Request body

🥫 Response

3️⃣ Stop monitoring a business

🔠 Headers

🥫 Response

4️⃣ Bulk remove businesses from monitoring

🔠 Headers

🎯 Request body

🥫 Response

5️⃣ Update business monitoring record

🔠 Headers

🎯 Request body

🥫 Response

6️⃣ Bulk update business monitoring records

🔠 Headers

🎯 Request body

🥫 Response

7️⃣ Retrieve a specific business monitoring record

🔠 Headers

🥫 Response

8️⃣ Retrieve all business monitoring records

🔠 Headers

🎯 Request body

🥫 Response

🛒 Retrieve Business Matches

🔠 Headers

🥫 Response

2️⃣ Retrieve a specific match of the business

🔠 Headers

🥫 Response

📥 Get Monitored Business Match Details

🔠 Headers

🥫 Response

🗂️ Code Examples

1️⃣ Start monitoring a business

🗒️ Example request

🗒️ Example response

2️⃣ Bulk add multiple businesses to the monitoring

🗒️ Example request

🗒️ Example response

3️⃣ Bulk remove businesses from monitoring

🗒️ Example request

🗒️ Example response

4️⃣ Update business monitoring record

🗒️ Example request

5️⃣ Bulk update business monitoring records

🗒️ Example request

🗒️ Example response

6️⃣ Retrieve a specific business monitoring record

🗒️ Example response

7️⃣ Retrieve all business monitoring records

🗒️ Example request

🗒️ Example response

8️⃣ Retrieve all matches of the business

🗒️ Example response

9️⃣ Retrieve a specific match of the business

🗒️ Example response

🔟 Get monitored business match details