Table of Contents
| Table of Contents | |||
|---|---|---|---|
|
...
1. Create worklist
|
...
1️⃣ Create worklist
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
...
🔠 Headers
Parameter | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
Correlation-Id | string |
| A unique identifier assigned to the request. | ||||||
Application-Id | string |
| Your application Id. Please contact support@ondato.com you don’t have one. | ||||||
Access token | string |
| Described in the Authentication part |
...
🎯 Request body
Field | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| string |
| The name of the business. | ||||||
| string |
| A unique identifier for the person's reference in the system. Format: UUID | ||||||
| string |
| 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 |
|---|---|---|
| string | The |
...
2️⃣ Delete worklist
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
...
🔠 Headers
Parameter | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
worklistId | string |
| The unique Id of the worklist. | ||||||
Correlation-Id | string |
| A unique identifier assigned to the request. | ||||||
Application-Id | string |
| Your application Id. Please contact support@ondato.com you don’t have one. | ||||||
Access token | string |
| Described in the Authentication part |
...
🥫 Response
After successfully deleting a worklist, you will receive a response with the success code 204: No Content.
...
3️⃣ Update worklist
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
...
🔠 Headers
Parameter | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
worklistId | string |
| The unique Id of the worklist. | ||||||
Correlation-Id | string |
| A unique identifier assigned to the request. | ||||||
Application-Id | string |
| Your application Id. Please contact support@ondato.com you don’t have one. | ||||||
Access token | string |
| Described in the Authentication part |
...
🎯 Request body
Field | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| string |
| Name of the worklist. | ||||||
| integer |
| Minimum matching Results with lower Default value: 85. | ||||||
| string |
|
...
Monitoring frequency. Possible enum values:
|
...
datasets
...
array
...
YES
Datasets to monitor against.
...
| 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
...
deleting a worklist
...
Field
...
Type
...
Description
...
id
...
string
...
The unique Id of the worklist to use in subsequent requests.
Code Examples
Example request
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Example response
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
2. Update worklist
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
| Code Block | ||
|---|---|---|
| ||
{
"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:
| Panel | ||
|---|---|---|
| ||
GET |
Request data
{worklistId} - Id of the worklist you want to retrieve.
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.
...
name
...
Name of the worklist.
...
threshold
...
Minimum matching score. Matches below this score will not be shown.
...
frequency
...
Screening frequency.
...
, you will receive a response with the success code
...
204: No Content.
...
4️⃣ Get worklist
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
...
🔠 Headers
Parameter | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
worklistId | string |
| The unique Id of the worklist. | ||||||
Correlation-Id | string |
| A unique identifier assigned to the request. | ||||||
Application-Id | string |
| Your application Id. Please contact support@ondato.com you don’t have one. | ||||||
Access token | string |
| Described in the Authentication part. |
...
🥫 Response
Field | Type | Description |
|---|---|---|
| string | Worklist Id. |
| string | Name of the worklist. |
| integer | Minimum matching Results with lower |
| 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. 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. |
🗒️ Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
All worklists
To retrieve all worklists, call the 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.
...
5️⃣ Search worklists
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
...
🔠 Headers
Parameter | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
Correlation-Id | string |
| A unique identifier assigned to the request. | ||||||
Application-Id | string |
| Your application Id. Please contact support@ondato.com you don’t have one. | ||||||
Access token | string |
| Described in the Authentication part |
...
🎯 Request body
Field | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| string |
| Name of the worklist. | ||||||
| string |
|
...
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
...
| Date FROM when worklist was created. Response will return worklists created after this date. | ||||||||
| string |
| Dato TO when woklist was created. Response will return worklists created before this date. |
...
🥫 Response
The response will return a list of worklists that were created within the submitted date interval or 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
1️⃣ Create worklist
🗒️ Example request
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
🗒️ Example response
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
2️⃣ Delete worklist
🗒️ Example request
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
3️⃣ Update worklist
🗒️ Example request
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
4️⃣ Get worklist
🗒️ 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
...
5️⃣ Search worklists
🗒️ Example request
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
🗒️ Example response
| Expand | ||
|---|---|---|
|
...
| ||||
|
...
|
...