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

Code Examples

Example request

Expand

title	Expand to see the example request

Code Block

language	json

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

Example response

Expand

title	Expand to see the example response

Code Block

language	json

{
  "id": "d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29"
}

...

2. Delete worklist

To delete a worklist, call the endpoint:

...

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

Code Examples

Example request

...

title	Expand to see the example request

...

language	json

...

3. Update worklist

To update a worklist, call the endpoint:

...

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

Code Examples

Example request

...

title	Expand to see the example request

...

language	json

...

4. Get worklist

After creating a worklist, you can get its info.

...

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.

Code Examples

Example response

...

title	Expand to see the example response

...

language	json

...

5. Search worklists

To do this, call the following endpoint:

...

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

Expand

title	Expand to see the example request

Code Block

language	json

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

Example response

Expand

title	Expand to see the example response

Code Block

language	json

{
  "id": "d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29"
}

...

Delete worklist

Example request

Expand

title	Expand to see the example request

Code Block

language	json

DELETE /v1/worklists/d130c94865404447933dcc324fe8599d0e767722b8824ac78e03e54e01f0fa29

...

Update worklist

Example request

Expand

title	Expand to see the example request

Code Block

language	json

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

...

Get worklist

Example response

Expand

title	Expand to see the example response

Code Block

language	json

{
  "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

Expand

title	Expand to see the example request

Code Block

language	json

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

Example response

Expand

title	Expand to see the example response

Code Block

language	json

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

...

Versions Compared

Old Version 18

New Version 19

Key

Code Examples

Example request

Example response

2. Delete worklist

Code Examples

Example request

3. Update worklist

Code Examples

Example request

4. Get worklist

Code Examples

Example response

5. Search worklists

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

Page Comparison

Versions Compared

Old Version 18

New Version 19

Key

Code Examples

Example request

Example response

2. Delete worklist

Code Examples

Example request

3. Update worklist

Code Examples

Example request

4. Get worklist

Code Examples

Example response

5. Search worklists

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