| Table of Contents | ||||
|---|---|---|---|---|
|
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 |
|---|---|---|---|
| string | YES | Name of the worklist. |
| integer | YES | Minimum matching Results with lower Default value: 85. |
| string | YES |
...
Monitoring frequency. Possible enum values:
| |||||
| array | YES | Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here. | ||
| string |
| A day of the week on which screening should be done. Possible enum values:
| ||
| integer |
| A day of the month on which screening should be done. A value between 1 and 31. | ||
| string |
| A month on which screening should be done. Possible enum values:
|
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 |
|---|---|---|
| string | The unique Id of the worklist to use in subsequent requests. |
Code Examples
Example request
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Example response
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
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 | |||||
|---|---|---|---|---|---|
| |||||
|
...
3. Update worklist
To update a worklist, call the endpoint:
PUT /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 |
Request body
Field | Type | Required | Description |
|---|---|---|---|
| string | YES | Name of the worklist. |
| integer | YES | Minimum matching Results with lower Default value: 85. |
| string | YES |
...
Monitoring frequency. Possible enum values:
| |||||
| array | YES | Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here. | ||
| string |
| A day of the week on which screening should be done. Possible enum values:
| ||
| integer |
| A day of the month on which screening should be done. A value between 1 and 31. | ||
| string |
| A month on which screening should be done. Possible enum values:
|
Response
After successfully
...
Field
...
Type
...
Description
...
id
...
string
...
deleting a worklist you’ll get a response with success code
...
204: No Content.
Code Examples
Example request
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
|
...
|
...
|
...
|
...
Example response
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
The worklist can be updated by calling the same endpoint as for worklist creation:
| Panel | ||
|---|---|---|
| ||
PUT |
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
| Code Block | ||
|---|---|---|
| ||
{
"dobMatching": "sameYear",
"name": "Same Worklist - 1",
"threshold": 85,
"frequency": "daily",
"datasets": [
"OndatoSanctions",
"ExternalPep"
]
} |
Updated
...
| language | json |
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Response data
After successfully updating a worklist you’ll get a response with success code 200: Ok.
...
4. Get worklist
After creating a worklist, you can
...
Specific worklist by Id
get its info.
To retrieve a specific worklist, call the endpoint:
...
GET /v1/worklists/{worklistId}
...
Request data
...
Headers
Parameter | Type | Required | Description |
|---|---|---|---|
worklistId | string | YES | The unique Id of the worklist |
...
Response data
...
Name
...
Description
...
id
...
Worklist Id.
...
lastScreenedDateIso
...
Date of the last completed screening
...
dobMatching
...
Accuracy of date of birth matching.
The only possible value is sameYear.
...
. | |||
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 |
|---|---|---|
| string | Worklist Id. |
| string | Name of the worklist. |
...
|
...
integer | Minimum matching |
...
Results with lower |
...
returned in the response. |
...
|
...
string |
...
Monitoring frequency. |
...
Possible enum values:
| ||
| array | Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here. |
| string | A day of the week on which screening should be done. |
...
businessMonitorRecordsCount
Possible enum values:
| ||
| integer | A day of the month on which screening should be done. A value between 1 and 31. |
| string | A month on which screening should be done. Possible enum values:
|
| string | Date of the last completed screening. |
| integer | Number of businesses in the worklist. |
...
|
...
integer | Number of true-positive business matches in the worklist. |
...
|
...
integer | Number of false-positive business matches in the worklist. |
...
|
...
integer | Number of discarded by the user business matches in the worklist. |
...
|
...
integer | Number of business monitor records, waiting for review. |
...
|
...
integer | Number of business monitor matches, waiting for review. |
...
|
...
integer | Number of persons in the worklist. |
...
|
...
integer | Number of true-positive person matches in the worklist. |
...
|
...
integer | Number of true-positive person matches in the worklist. |
...
|
...
integer | Number of discarded by the user person matches in the worklist. |
...
|
...
integer | Number of person monitor records, waiting for review. |
...
|
...
integer | Number of person monitor matches, waiting for review. |
Code Examples
...
Example response
| Expand | |
|---|---|
|
...
| |||||
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
5. Search worklists
To
...
do this, call the following endpoint:
| Panel | ||
|---|---|---|
| ||
GET |
Request data
...
Name
...
Description
...
Mandatory/Optional
...
nextToken
...
Token of the next page.
Leaving this blank will return the first page.
...
| Status | ||||
|---|---|---|---|---|
|
...
pageSize
...
Number of worklists per page.
Leaving blank will return up to 1 MB data.
...
| Status | ||||
|---|---|---|---|---|
|
Response data
...
Name
...
Description
...
worklists
...
List of worklists.
...
worklists.id
...
Same as in specific worklist section.
...
worklists.lastScreenedDateIso
...
Same as in specific worklist section.
...
worklists.dobMatching
...
Same as in specific worklist section.
...
worklists.name
...
Same as in specific worklist section.
...
worklists.threshold
...
Same as in specific worklist section.
...
worklists.frequency
...
Same as in specific worklist section.
...
worklists.datasets
...
Same as in specific worklist section.
...
worklists.businessMonitorRecordsCount
...
Same as in specific worklist section.
...
worklists.businessTruePositiveMatchesCount
...
Same as in specific worklist section.
...
worklists.businessFalsePositiveMatchesCount
...
Same as in specific worklist section.
...
worklists.businessDiscardedMatchesCount
...
Same as in specific worklist section.
...
worklists.businessOpenMonitorRecordsCount
...
Same as in specific worklist section.
...
worklists.businessOpenMatchesCount
...
Same as in specific worklist section.
...
worklists.individualMonitorRecordsCount
...
Same as in specific worklist section.
...
worklists.individualTruePositiveMatchesCount
...
Same as in specific worklist section.
...
worklists.individualFalsePositiveMatchesCount
...
Same as in specific worklist section.
...
worklists.individualDiscardedMatchesCount
...
Same as in specific worklist section.
...
worklists.individualOpenMonitorRecordsCount
...
Same as in specific worklist section.
...
worklists.individualOpenMatchesCount
...
Same as in specific worklist section.
...
nextToken
...
Token to iterate over pages.
If this field is not returned, there are no further pages
🗒️ Example
...
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 |
|---|---|---|---|
| string | NO | Name of the worklist. |
| string | NO | Date FROM when worklist was created. Response will return worklists created after this date. |
| string | NO | Dato TO when woklist was created. Response will return worklists created before this date. |
Response
The response will return a list of worklists created in the submitted date interval or which have submitted names.
Field | Type | Description |
|---|---|---|
| array | An array containing worklists |
workLists[]. | string | The unique identifier for the worklist. |
workLists[]. | string | The name of the worklist. |
workLists[]. | integer | Minimum matching Results with lower |
workLists[]. | string | Monitoring frequency. Possible enum values:
|
workLists[]. | array | Datasets to monitor against. Available datasets are the same as described in AML Search API. They can be found here: AML Datasets. |
workLists[]. | string | A day of the week on which screening should be done. Possible enum values:
|
workLists[]. | integer | A day of the month on which screening should be done. A value between 1 and 31. |
workLists[]. | string | A month on which screening should be done. Possible enum values:
|
| integer | The total number of worklists that match the requested query parameters. |
Code Examples
Example request
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Example response
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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
...
| title | Expand to see the example request |
|---|
...
| language | json |
|---|
...
|
...