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 |
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
Monitoring 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
Note |
---|
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
Note |
---|
It is required and allowed only when the frequency is set to monthly, |
A day of the month on which screening should be done.
A value between 1 and 31.
scheduleMonth
string
Note |
---|
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
| 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 |
|
business to use in subsequent requests. |
...
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
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 deleting a worklist
...
, 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. |
...
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 |
| 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 | |||||
---|---|---|---|---|---|
| |||||
|
...
5️⃣ Search worklists
🗒️ Example request
Expand | |||||
---|---|---|---|---|---|
| |||||
|
...
🗒️ Example response
Expand | |||||
---|---|---|---|---|---|
| |||||
|
...