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:
PUT /worklists/{worklistId}
- create/update a worklist.
Request data.
Name | Description | Mandatory/Optional | |
---|---|---|---|
1 | worklistId | Unique worklist Id, which will be used for later calls to API referring to the worklist. Example: Worklist-1. | MANDATORY |
2 | name | Name of the worklist. | MANDATORY |
3 | threshold | Minimum matching | MANDATORY |
4 | frequency | Screening frequency. Possible enum values:
| MANDATORY |
5 | datasets | Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here. | MANDATORY |
6 | scheduleDayOfTheWeek | 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:
|
|
7 | scheduleDayOfTheMonth | 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. What happens if day set to 31, but month has 30 days? |
|
8 | scheduleMonth | 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:
| |
9 | dobMatching | Accuracy of date of birth matching. Default value is | OPTIONAL |
🗒️ Example
Response data
After successfully creating a worklist you’ll get a response with success code 201: Created
.
Update worklist
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. |
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
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. | Same as in specific worklist section. |
3 | worklists. | Same as in specific worklist section. |
4 | worklists. | Same as in specific worklist section. |
5 | worklists. | Same as in specific worklist section. |
6 | worklists. | Same as in specific worklist section. |
7 | worklists. | Same as in specific worklist section. |
8 | worklists. | Same as in specific worklist section. |
9 | worklists. | Same as in specific worklist section. |
10 | worklists. | Same as in specific worklist section. |
11 | worklists. | Same as in specific worklist section. |
12 | worklists. | Same as in specific worklist section. |
13 | worklists. | Same as in specific worklist section. |
14 | worklists. | Same as in specific worklist section. |
15 | worklists. | Same as in specific worklist section. |
16 | worklists. | Same as in specific worklist section. |
17 | worklists. | Same as in specific worklist section. |
18 | worklists. | Same as in specific worklist section. |
19 | worklists. | Same as in specific worklist section. |
20 | worklists. | 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
Delete worklist
To delete a worklist, call the endpoint:
DELETE /worklists/{worklistId}
- delete worklist.
Request data
In query parameter {worklistId}
pass Id of the worklist you want to delete.
Response data
After successfully deleting a worklist you’ll get a response with success code 200: Ok
.
Add Comment