1. 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
Correlation-Id	string	NO	A unique identifier assigned to the request.
Application-Id	string	YES	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	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	Screening frequency. Possible enum values: `Daily` `Weekly` `Monthly` `HalfAYear` `Annual`
`datasets`	array	YES	Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here.
`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

After successfully creating a worklist you’ll get a response with success code 201: Created and Id of the worklist to use in subsequent requests.

Field	Type	Description
`id`	string	The unique Id of the worklist to use in subsequent requests.

Code Examples

Example request

Expand to see the example request

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

Example response

Expand to see the example response

{
  "id": "d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29"
}

2. Delete worklist

To delete a worklist, call the endpoint:

DELETE /v1/worklists/{worklistId}

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

Response

After successfully deleting a worklist you’ll get a response with success code 204: No Content.

Code Examples

Example request

Expand to see the example request

DELETE /v1/worklists/d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29

3. Update worklist

To update a worklist, call the endpoint:

PUT /v1/worklists/{worklistId}

Headers

Parameter	Type	Required	Description
Correlation-Id	string	NO	A unique identifier assigned to the request.
Application-Id	string	YES	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	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	Screening frequency. Possible enum values: `Daily` `Weekly` `Monthly` `HalfAYear` `Annual`
`datasets`	array	YES	Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here.
`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

After successfully creating a worklist you’ll get a response with success code 201: Created and Id of the worklist to use in subsequent requests.

Field	Type	Description
`id`	string	The unique Id of the worklist to use in subsequent requests.

Code Examples

Example request

Expand to see the example request

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

Example response

Expand to see the example response

{
  "id": "d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29"
}

The worklist can be updated by calling the same endpoint as for worklist creation:

PUT /worklists/{worklistId} - create/update a worklist.

Request data

In query parameter {worklistId} pass Id of the worklist you want to update.

The request structure is the same as for worklist creation. You can change the current values of a particular field by providing new ones:

Current

{
  "dobMatching": "sameYear",
  "name": "Same Worklist - 1",
  "threshold": 85,
  "frequency": "daily",
  "datasets": [
    "OndatoSanctions",
    "ExternalPep"
  ]
}

Updated

{
  "dobMatching": "sameYear",
  "name": "New worklist name",
  "threshold": 70,
  "frequency": "monthly",
  "scheduleDayOfTheMonth": "5"
  "datasets": [
    "All"
  ]
}

Response data

After successfully updating a worklist you’ll get a response with success code 200: Ok.

Retrieve worklist

After creating a worklist, you can retrieve it. You can retrieve a specific worklist by it’s Id, or all worklists.

Specific worklist by Id

To retrieve a specific worklist, call the endpoint:

GET /worklists/{worklistId} - get worklist by Id.

Request data

{worklistId} - Id of the worklist you want to retrieve.

Response data

	Name	Description
1	id	Worklist Id.
2	lastScreenedDateIso	Date of the last completed screening
3	dobMatching	Accuracy of date of birth matching. The only possible value is `sameYear`.
4	name	Name of the worklist.
5	threshold	Minimum matching score. Matches below this score will not be shown.
6	frequency	Screening frequency.
7	datasets	Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here.
8	businessMonitorRecordsCount	Number of businesses in the worklist.
9	businessTruePositiveMatchesCount	Number of true-positive business matches in the worklist.
10	businessFalsePositiveMatchesCount	Number of false-positive business matches in the worklist.
11	businessDiscardedMatchesCount	Number of discarded by the user business matches in the worklist.
12	businessOpenMonitorRecordsCount	Number of business monitor records, waiting for review.
13	businessOpenMatchesCount	Number of business monitor matches, waiting for review.
14	individualMonitorRecordsCount	Number of persons in the worklist.
15	individualTruePositiveMatchesCount	Number of true-positive person matches in the worklist.
16	individualFalsePositiveMatchesCount	Number of true-positive person matches in the worklist.
17	individualDiscardedMatchesCount	Number of discarded by the user person matches in the worklist.
18	individualOpenMonitorRecordsCount	Number of person monitor records, waiting for review.
19	individualOpenMatchesCount	Number of person monitor matches, waiting for review.

🗒️ Example

Example

{
  "id": "HighRiskProfiles1",
  "lastScreenedDateIso": "2022-06-11",
  "dobMatching": "withinThreeYears",
  "name": "High Risk Profiles - 1",
  "threshold": 85,
  "frequency": "daily",
  "datasets": [
    "PEP"
  ],
  "businessTruePositiveMatchesCount": 0,
  "businessDiscardedMatchesCount": 0,
  "businessOpenMonitorRecordsCount": 0,
  "businessOpenMatchesCount": 0,
  "individualFalsePositiveMatchesCount": 0,
  "individualOpenMatchesCount": 0,
  "individualTruePositiveMatchesCount": 0,
  "individualDiscardedMatchesCount": 0,
  "businessFalsePositiveMatchesCount": 0,
  "businessMonitorRecordsCount": 0,
  "individualOpenMonitorRecordsCount": 0,
  "individualMonitorRecordsCount": 0
}

All worklists

To retrieve all worklists, call the endpoint:

GET /worklists/ - get all worklists.

Request data

Name

Description

Mandatory/Optional

1

nextToken

Token of the next page.

Leaving this blank will return the first page.

OPTIONAL

2

pageSize

Number of worklists per page.

Leaving blank will return up to 1 MB data.

OPTIONAL

Response data

	Name	Description
1	worklists	List of worklists.
2	worklists.`id`	Same as in specific worklist section.
3	worklists.`lastScreenedDateIso`	Same as in specific worklist section.
4	worklists.`dobMatching`	Same as in specific worklist section.
5	worklists.`name`	Same as in specific worklist section.
6	worklists.`threshold`	Same as in specific worklist section.
7	worklists.`frequency`	Same as in specific worklist section.
8	worklists.`datasets`	Same as in specific worklist section.
9	worklists.`businessMonitorRecordsCount`	Same as in specific worklist section.
10	worklists.`businessTruePositiveMatchesCount`	Same as in specific worklist section.
11	worklists.`businessFalsePositiveMatchesCount`	Same as in specific worklist section.
12	worklists.`businessDiscardedMatchesCount`	Same as in specific worklist section.
13	worklists.`businessOpenMonitorRecordsCount`	Same as in specific worklist section.
14	worklists.`businessOpenMatchesCount`	Same as in specific worklist section.
15	worklists.`individualMonitorRecordsCount`	Same as in specific worklist section.
16	worklists.`individualTruePositiveMatchesCount`	Same as in specific worklist section.
17	worklists.`individualFalsePositiveMatchesCount`	Same as in specific worklist section.
18	worklists.`individualDiscardedMatchesCount`	Same as in specific worklist section.
19	worklists.`individualOpenMonitorRecordsCount`	Same as in specific worklist section.
20	worklists.`individualOpenMatchesCount`	Same as in specific worklist section.
21	nextToken	Token to iterate over pages. If this field is not returned, there are no further pages

🗒️ Example

Example

{
  "worklists": {
    "id": "HighRiskProfiles1",
    "lastScreenedDateIso": "2022-06-11",
    "dobMatching": "withinThreeYears",
    "name": "High Risk Profiles - 1",
    "threshold": 85,
    "frequency": "daily",
    "datasets": [
      "PEP"
    ],
    "businessTruePositiveMatchesCount": 0,
    "businessDiscardedMatchesCount": 0,
    "businessOpenMonitorRecordsCount": 0,
    "businessOpenMatchesCount": 0,
    "individualFalsePositiveMatchesCount": 0,
    "individualOpenMatchesCount": 0,
    "individualTruePositiveMatchesCount": 0,
    "individualDiscardedMatchesCount": 0,
    "businessFalsePositiveMatchesCount": 0,
    "businessMonitorRecordsCount": 0,
    "individualOpenMonitorRecordsCount": 0,
    "individualMonitorRecordsCount": 0
  },
  "nextToken": "ZGggZiBkZ2hqIDQ1IDU0eSBleSBlciBlcnQgZXlyIHJldA=="
}

2. Delete worklist

To delete a worklist, call the endpoint:

DELETE /v1/worklists/{worklistId}

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

Response

After successfully deleting a worklist you’ll get a response with success code 204: No Content.

Code Examples

Example request

Expand to see the example request

DELETE /v1/worklists/d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29

Setup and manage worklist

1. Create worklist

Headers

Request body

Response

Code Examples

Example request

Example response

2. Delete worklist

Headers

Response

Code Examples

Example request

3. Update worklist

Headers

Request body

Response

Code Examples

Example request

Example response

Request data

Response data

Retrieve worklist

Specific worklist by Id

Request data

Response data

🗒️ Example

All worklists

Request data

Response data

🗒️ Example

2. Delete worklist

Headers

Response

Code Examples

Example request

0 Comments