| Table of Contents |
|---|
Once monitoring rules in the worklist are set up, you can add a person(-s) or business (-es) to the monitoring worklist.
...
Add a person to monitoring
Add multiple persons to the monitoring worklist
If you want to add several persons to monitoring, call the following endpoint:
| Panel | ||
|---|---|---|
| ||
PUT |
Request data
{worklistId} - worklist Id, into which persons will be added.
Name
...
Description
...
Mandatory/Optional
...
id
...
The unique Id of monitored person set by the user.
...
| Status | ||||
|---|---|---|---|---|
|
...
name
...
The full name of the person to be monitored.
...
| Status | ||||
|---|---|---|---|---|
|
...
countries
...
The list of countries related to person in ISO2 format.
...
| Status | ||||
|---|---|---|---|---|
|
...
dob
...
Person’s date of birth in ISO format YYYY-MM-DD.
...
| Status | ||||
|---|---|---|---|---|
|
...
gender
...
Possible enum values:
male
female
...
| Status | ||||
|---|---|---|---|---|
|
🗒️ Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Response data
In the response, you’ll get the results array with status codes:
Name
...
Description
...
hasErrors
...
Indicates if any of processed records has erros.
...
results
...
The array with status codes of added records.
...
results.statusCode
...
The status code of record.
...
results.error
...
Object with information about errors.
...
results.error.code
...
Error identifier.
...
results.error.message
...
Error description.
🗒️ Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
If you want to add a single person to monitoring, call the following endpoint:
| Panel | ||
|---|---|---|
| ||
PUT |
Request data
{worklistId} - worklist Id, into which persons will be added.
{monitorRecordId} - the unique Id of the person, who will be monitored.
Name
...
Description
...
Mandatory/Optional
...
name
...
The full name of the person to be monitored.
...
| Status | ||||
|---|---|---|---|---|
|
...
countries
...
The list of countries related to person in ISO2 format.
...
| Status | ||||
|---|---|---|---|---|
|
...
dob
...
Person’s date of birth in ISO format YYYY-MM-DD.
...
| Status | ||||
|---|---|---|---|---|
|
...
gender
...
Possible enum values:
male
female
...
| Status | ||||
|---|---|---|---|---|
|
🗒️ Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Response data
After successfully adding a person(-s) to the monitoring worklist you’ll get a response with success code 201: Created.
Update monitoring record
The monitored person can be updated by calling the same endpoints as for adding a person to monitoring :
| Panel | ||
|---|---|---|
| ||
PUT |
or
| Panel | ||
|---|---|---|
| ||
PUT |
Update multiple persons record
Request data
In query parameter {worklistId} pass Id of the worklist inside which persons will be updated.
The request structure is the same as for adding to monitoring. You can change the current values of a particular field by providing new ones:
Current
| Code Block | ||
|---|---|---|
| ||
{
"monitorRecords": [
{
"id": "HighRiskProfile300",
"name": "Boyko Borissov",
"countries": [
"US"
],
"dob": "1994-08-22",
"gender": "male"
}
]
} |
Updated
| Code Block | ||
|---|---|---|
| ||
{
"monitorRecords": [
{
"id": "HighRiskProfile300",
"name": "Alan Alanavicius",
"countries": [
"US", "LT"
],
"dob": "1994-10-11"
}
]
} |
Response data
After successfully updating multiple persons monitoring records you’ll get the same response as for adding persons to monitoring, described here.
Update a single person record
Request data
In query parameter
{worklistId}pass Id of the worklist inside which persons will be updated.In query parameter
{monitorRecordId}pass Id of the person who will be updated.
The request structure is the same as for adding to monitoring. You can change the current values of a particular field by providing new ones:
Current
| Code Block | ||
|---|---|---|
| ||
{
"name": "Boyko Borissov",
"countries": [
"US"
],
"dob": "1994-08-22",
"gender": "male"
} |
Updated
| Code Block | ||
|---|---|---|
| ||
{
"name": "Alan Alanavicius",
"countries": [
"US", "LT"
],
"dob": "1991"
} |
Response data
After successfully updating a single person monitoring record you’ll get the response with success code 200: Ok.
Retrieve monitoring record
Specific person by Id
To retrieve a specific person, call the endpoint:
| Panel | ||
|---|---|---|
| ||
GET |
Request data
{worklistId} - Id of the worklist you want to retrieve.
{monitorRecordId} - the unique Id of the person, who will be retrieved.
Response data
...
Name
...
Description
...
name
...
The full name of the retrieved person.
...
countries
...
The list of countries related to person in ISO2 format.
...
dob
...
Person’s date of birth in ISO format YYYY-MM-DD.
...
gender
...
Possible enum values:
male
female
...
id
...
the unique Id of the retrieved person.
...
openCount
...
The number of open matches for the retrieved person.
...
falsePositiveCount
...
The number of matches already closed as false positive.
...
truePositiveCount
...
The number of matches already closed as true positive.
...
discardedCount
...
The number of matches already discarded.
...
createdDateTimeISO
...
The timestamp when the person was firstly added to monitoring.
...
lastUpdatedDateTimeISO
...
The last time the person record was updated by the user.
🗒️ Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
All persons
To retrieve all persons, call the endpoint:
| Panel | ||
|---|---|---|
| ||
GET |
Request data
{worklistId} - Id of the worklist from which persons will be retrieved.
...
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 | ||||
|---|---|---|---|---|
|
...
status
...
Filters monitor records by status.
Possible enum values:
open
closed
If not selected, all persons will be returned.
...
| Status | ||||
|---|---|---|---|---|
|
Response data
...
Name
...
Description
...
monitorRecords
...
List of person monitor records.
...
monitorRecords.name
...
Same as in specific person by id section.
...
monitorRecords.countries
...
Same as in specific person by id section.
...
monitorRecords.dob
...
Same as in specific person by id section.
...
monitorRecords.gender
...
Same as in specific person by id section.
...
monitorRecords.id
...
Same as in specific person by id section.
...
monitorRecords.openCount
...
Same as in specific person by id section.
...
monitorRecords.falsePositiveCount
...
Same as in specific person by id section.
...
monitorRecords.truePositiveCount
...
Same as in specific person by id section.
...
monitorRecords.discardedCount
...
Same as in specific person by id section.
...
monitorRecords.createdDateTimeISO
...
Same as in specific person by id section.
...
monitorRecords.lastUpdatedDateTimeISO
...
Same as in specific person by id section.
...
monitorRecordsCount
...
Number of persons in the worklist.
...
truePositiveMatchesCount
...
Number of true-positive person matches in the worklist.
...
falsePositiveMatchesCount
...
Number of true-positive person matches in the worklist.
...
discardedMatchesCount
...
Number of discarded by the user person matches in the worklist.
...
openMonitorRecordsCount
...
Number of person monitor records, waiting for review.
...
openMatchesCount
...
Number of person monitor matches, waiting for review.
...
nextToken
...
Token to iterate over pages.
If this field is not returned, there are no further pages
🗒️ Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Delete monitoring record
To delete a person from monitoring, call the endpoint:
| Panel | ||
|---|---|---|
| ||
DELETE |
Request data
In query parameter
{worklistId}pass Id of the worklist in which the person you want to delete is.In query parameter
{monitorRecordId}pass Id of the person you want to delete.
Response data
After successfully deleting a person you’ll get a response with success code 200: Ok.
...
🏛️ 🏢 🏘️ Add multiple businesses to the monitoring worklist
If you want to add several businesses to monitoring, call the following endpoint:
| Panel | ||
|---|---|---|
| ||
PUT |
{worklistId} - worklist Id, into which businesses will be added.
Request data
Name | Description | Mandatory/Optional | |||||||
|---|---|---|---|---|---|---|---|---|---|
| 1 | id | The unique Id of monitored business set by the user. |
| ||||||
| 2 | name | The full name of the business to be monitored. |
| ||||||
| 3 | countries | The list of countries related to the business in ISO2 format. |
|
🗒️ Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Response data
In the response, you’ll get the results array with status codes, the same as for persons.
🏢 Add a single business to the monitoring worklist
If you want to add a single business to monitoring, call the following endpoint:
| Panel | ||
|---|---|---|
| ||
PUT |
{worklistId} - worklist Id, into which persons will be added.
{monitorRecordId} - the unique Id of the business, who will be monitored.
Request data
Name | Description | Mandatory/Optional | |||||||
|---|---|---|---|---|---|---|---|---|---|
| 1 | name | The full name of the business to be monitored. |
| ||||||
| 2 | countries | The list of countries related to business in ISO2 format. |
|
🗒️ Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Response data
After successfully adding a business to the monitoring worklist you’ll get a response with success code 201: Created.