Table of Contents

1 Create worklist
- 1.1 Headers
- 1.2 Request body
- 1.3 Response
2 Delete worklist
- 2.1 Headers
- 2.2 Response
3 Update worklist
- 3.1 Headers
- 3.2 Request body
- 3.3 Response
4 Get worklist
- 4.1 Headers
- 4.2 Response
5 Search worklists
- 5.1 Headers
- 5.2 Request body
- 5.3 Response
6 Code Examples
- 6.1 Create worklist
- 6.2 Delete worklist
- 6.3 Update worklist
- 6.4 Get worklist
- 6.5 Search worklists

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	Required	Description

Parameter	Type	Required	Description
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

Field

Type

Required

Description

name

string

YES

The name of the business.

referenceId

string

NO

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

Format: UUID

referenceType

string

NO

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

Response

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

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	Required	Description

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

Response

Update worklist

Headers

Parameter	Type	Required	Description

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

Field	Type	Required	Description
`name`	string	YES	Name of the worklist.
`threshold`	integer	YES	Minimum matching `score`. Results with lower `score` than the entered `threshold` will not be returned in the response. Default value: 85.
`frequency`	string	YES	Monitoring frequency. Possible enum values: `Daily` `Weekly` `Monthly` `HalfAYear` `Annual`
`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`

Response

Get worklist

Headers

Parameter	Type	Required	Description

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.

Response

Field	Type	Description

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

Headers

Parameter	Type	Required	Description

Parameter	Type	Required	Description
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

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

Response

Field	Type	Description

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

Ondato

Setup and manage worklist

Create worklist

Headers

Request body

Response

Delete worklist

Headers

Response

Update worklist

Headers

Request body

Response

Get worklist

Headers

Response

Search worklists

Headers

Request body

Response

Code Examples

Create worklist

Example request

Example response

Delete worklist

Example request

Update worklist

Example request

Get worklist

Example response

Search worklists

Example request

Example response