Table of Contents

Create worklist

Before starting the monitoring you have to set up monitoring rules. This can be done by setting up a monitoring worklist.
To do this, call the following endpoint:
- POST /v1/worklists

Headers

Parameter	Type	Description
Correlation-Id	string	A unique identifier assigned to the request.
Application-Id	string	Your application Id. Please contact support@ondato.com you don’t have one.
Access token	string	Described in the Authentication part

Request body

Field

Type

Required

Description

name

string

The name of the business.

referenceId

string

A unique identifier for the person's reference in the system.

Format: UUID

referenceType

string

User created reference for the person in the system, for example "My Reference".

Response

note

After successfully creating a worklist, you will receive a response with the success code 201: Created and the Id of the record for subsequent calls.

Field	Type	Description
`id`	string	The `recordId` of the business to use in subsequent requests.

Delete worklist

To delete a worklist, call the endpoint:
- DELETE /v1/worklists/{worklistId}

Headers

Parameter	Type	Description
worklistId	string	The unique Id of the worklist.
Correlation-Id	string	A unique identifier assigned to the request.
Application-Id	string	Your application Id. Please contact support@ondato.com you don’t have one.
Access token	string	Described in the Authentication part

Response

note

After successfully deleting a worklist, you will receive a response with the success code 204: No Content.

Update worklist

To update a worklist, call the endpoint:
- PUT /v1/worklists/{worklistId}

Headers

Parameter	Type	Description
worklistId	string	The unique Id of the worklist.
Correlation-Id	string	A unique identifier assigned to the request.
Application-Id	string	Your application Id. Please contact support@ondato.com you don’t have one.
Access token	string	Described in the Authentication part

Request body

Field

Type

Required

Description

name

string

Name of the worklist.

threshold

integer

Minimum matching score.

Results with lower score than the entered threshold will not be returned in the response.

Default value: 85.

frequency

string

Monitoring frequency.

Possible enum values:

Daily
Weekly
Monthly
HalfAYear
Annual

scheduleDayOfTheWeek

string

It is required and allowed only when the frequency is set to weekly.

A day of the week on which screening should be done.

Possible enum values:

Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

scheduleDayOfTheMonth

integer

It is required and allowed only when the frequency is set to monthly, HalfAYear or Annual.

A day of the month on which screening should be done.

A value between 1 and 31.

scheduleMonth

string

It is required and allowed only when the frequency is set to halfAYear or annual.

A month on which screening should be done.

Possible enum values:

January
February
March
April
May
June
July
August
September
October
November
December

Response

note

After successfully deleting a worklist, you will receive a response with the success code 204: No Content.

Get worklist

After creating a worklist, you can get its info.
To retrieve a specific worklist, call the endpoint:
- GET /v1/worklists/{worklistId}

Headers

Parameter	Type	Description
worklistId	string	The unique Id of the worklist.
Correlation-Id	string	A unique identifier assigned to the request.
Application-Id	string	Your application Id. Please contact support@ondato.com you don’t have one.
Access token	string	Described in the Authentication part.

Response

Field	Type	Description
`id`	string	Worklist Id.
`name`	string	Name of the worklist.
`threshold`	integer	Minimum matching `score`. Results with lower `score` than the entered `threshold` will not be returned in the response.
`frequency`	string	Monitoring frequency. Possible enum values: `Daily` `Weekly` `Monthly` `HalfAYear` `Annual`
`datasets`	array	Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here.
`scheduleDayOfTheWeek`	string	A day of the week on which screening should be done. Possible enum values: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`
`scheduleDayOfTheMonth`	integer	A day of the month on which screening should be done. A value between 1 and 31.
`scheduleMonth`	string	A month on which screening should be done. Possible enum values: `January` `February` `March` `April` `May` `June` `July` `August` `September` `October` `November` `December`
`lastScreenedDate`	string	Date of the last completed screening.
`businessMonitorRecordsCount`	integer	Number of businesses in the worklist.
`businessTruePositiveMatchesCount`	integer	Number of true-positive business matches in the worklist.
`businessFalsePositiveMatchesCount`	integer	Number of false-positive business matches in the worklist.
`businessDiscardedMatchesCount`	integer	Number of discarded by the user business matches in the worklist.
`businessOpenMonitorRecordsCount`	integer	Number of business monitor records, waiting for review.
`businessOpenMatchesCount`	integer	Number of business monitor matches, waiting for review.
`individualMonitorRecordsCount`	integer	Number of persons in the worklist.
`individualTruePositiveMatchesCount`	integer	Number of true-positive person matches in the worklist.
`individualFalsePositiveMatchesCount`	integer	Number of true-positive person matches in the worklist.
`individualDiscardedMatchesCount`	integer	Number of discarded by the user person matches in the worklist.
`individualOpenMonitorRecordsCount`	integer	Number of person monitor records, waiting for review.
`individualOpenMatchesCount`	integer	Number of person monitor matches, waiting for review.

Search worklists

To do this, call the following endpoint:
- POST /v1/worklists

Headers

Parameter	Type	Description
Correlation-Id	string	A unique identifier assigned to the request.
Application-Id	string	Your application Id. Please contact support@ondato.com you don’t have one.
Access token	string	Described in the Authentication part

Request body

Field	Type	Description
`name`	string	Name of the worklist.
`from`	string	Date FROM when worklist was created. Response will return worklists created after this date.
`to`	string	Dato TO when woklist was created. Response will return worklists created before this date.

Response

note

The response will return a list of worklists that were created within the submitted date interval or have submitted names.

Field	Type	Description
`workLists`	array	An array containing worklists
workLists[].`id`	string	The unique identifier for the worklist.
workLists[].`name`	string	The name of the worklist.
workLists[].`threshold`	integer	Minimum matching `score`. Results with lower `score` than the entered `threshold` will not be returned in the response.
workLists[].`frequency`	string	Monitoring frequency. Possible enum values: `Daily` `Weekly` `Monthly` `HalfAYear` `Annual`
workLists[].`dataSets`	array	Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here: AML Datasets.
workLists[].`scheduleDayOfTheWeek`	string	A day of the week on which screening should be done. Possible enum values: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`
workLists[].`scheduleDayOfTheMonth`	integer	A day of the month on which screening should be done. A value between 1 and 31.
workLists[].`scheduleMonth`	string	A month on which screening should be done. Possible enum values: `January` `February` `March` `April` `May` `June` `July` `August` `September` `October` `November` `December`
`totalCount`	integer	The total number of worklists that match the requested query parameters.

Code Examples

Create worklist

Example request

{
  "name": "HighRiskProfile",
  "threshold": 85,
  "frequency": "Daily",
  "dataSets": [
    "ExternalPep",
    "ExternalSanctions"
  ],
  "scheduleDayOfTheWeek": "Monday",
  "scheduleDayOfTheMonth": 5,
  "scheduleMonth": "January"
}

Example response

{
  "id": "d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29"
}

Delete worklist

Example request

DELETE /v1/worklists/d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29

Update worklist

Example request

{
  "name": "HighRiskProfileUpdated",
  "threshold": 75,
  "frequency": "Weekly",
  "dataSets": [
    "ExternalPep",
    "ExternalSanctions",
    "OndatoPep"
  ],
  "scheduleDayOfTheWeek": "Monday",
  "scheduleDayOfTheMonth": 5,
  "scheduleMonth": "January"
}

Get worklist

Example response

{
  "id": "8506b0a7dee248fd866ce1bb1db6031b8906ec808a1b45e4b3c335a53a4ed16a",
  "name": "HighRiskProfile",
  "threshold": 85,
  "frequency": "Daily",
  "dataSets": [
    "All"
  ],
  "scheduleDayOfTheWeek": "Monday",
  "scheduleDayOfTheMonth": 2,
  "scheduleMonth": "January",
  "lastScreenedDate": "2022-06-11",
  "individualMonitorRecordsCount": 2,
  "individualOpenMonitorRecordsCount": 2,
  "individualOpenMatchesCount": 2,
  "individualFalsePositiveMatchesCount": 2,
  "individualTruePositiveMatchesCount": 2,
  "individualDiscardedMatchesCount": 2,
  "businessMonitorRecordsCount": 20,
  "businessOpenMonitorRecordsCount": 2,
  "businessOpenMatchesCount": 2,
  "businessFalsePositiveMatchesCount": 2,
  "businessTruePositiveMatchesCount": 2,
  "businessDiscardedMatchesCount": 2
}

Search worklists

Example request

{
  "name": "string",
  "from": "2023-03-16T12:33:22.004Z",
  "to": "2023-03-16T12:33:22.004Z"
}

Example response

{
  "workLists": [
    {
      "id": "8506b0a7dee248fd866ce1bb1db6031b8906ec808a1b45e4b3c335a53a4ed16a",
      "name": "HighRiskProfile",
      "threshold": 85,
      "frequency": "Daily",
      "dataSets": [
        "All"
      ],
      "scheduleDayOfTheWeek": "Monday",
      "scheduleDayOfTheMonth": 2,
      "scheduleMonth": "January"
    }
  ],
  "totalCount": 10
}