Table of Contents

Add a person to monitoring

Once monitoring rules are set up, you can add a person(-s) to the monitoring worklist.

🧑‍🦱 🧑 🧑‍🦱 Add multiple persons to the monitoring worklist

If you want to add several persons to monitoring, call the following endpoint:

Panel

bgColor	#FFBDAD

PUT /worklists/{worklistId}/individuals - add/update multiple persons, up to 25 000.

Request data

{worklistId} - worklist Id, into which persons will be added.

Name

Description

Mandatory/Optional

1

id

The unique Id of monitored person set by the user.

Status

colour	Red
title	MANDATORY

2

name

The full name of the person to be monitored.

Status

colour	Red
title	MANDATORY

3

countries

The list of countries related to person in ISO2 format.

Status

colour	Red
title	MANDATORY

4

dob

Person’s date of birth in ISO format YYYY-MM-DD.

Status

colour	Green
title	OPTIONAL

5

gender

Possible enum values:

male
female

Status

colour	Green
title	OPTIONAL

🗒️ Example

Expand

title	Example

Code Block

language	json

{
  "monitorRecords": [
    {
      "id": "HighRiskProfile300",
      "name": "Boyko Borissov",
      "countries": [
        "US"
      ],
      "dob": "1994-08-22",
      "gender": "male"
    }
  ]
}

Response data

In the response, you’ll get the results array with status codes:

	Name	Description
1	hasErrors	Indicates if any of processed records has erros.
2	results	The array with status codes of added records.
3	results.`statusCode`	The status code of record.
4	results.`error`	Object with information about errors.
5	results.error.`code`	Error identifier.
6	results.error.`message`	Error description.

🗒️ Example

Expand

title	Example

Code Block

language	json

{
  "hasErrors": true,
  "results": [
    {
      "statusCode": 200
    },
    {
      "statusCode": 201
    },
    {
      "statusCode": 400,
      "error": {
        "code": "MAPI-005",
        "message": "Invalid type of attribute countries."
      }
    },
    {
      "statusCode": 409,
      "error": {
        "code": "MAPI-011",
        "message": "ID is temporarily blocked or ID is temporarily invalid"
      }
    }
  ]
}

🧑‍🦱Add a single person to the monitoring worklist

If you want to add a single person to monitoring, call the following endpoint:

Panel

bgColor	#FFBDAD

PUT /worklists/{worklistId}/individuals/{monitorRecordId} - add/update single person, providing it’s Id.

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

1

name

The full name of the person to be monitored.

Status

colour	Red
title	MANDATORY

2

countries

The list of countries related to person in ISO2 format.

Status

colour	Red
title	MANDATORY

3

dob

Person’s date of birth in ISO format YYYY-MM-DD.

Status

colour	Green
title	OPTIONAL

4

gender

Possible enum values:

male
female

Status

colour	Green
title	OPTIONAL

🗒️ Example

Expand

title	Example

Code Block

language	json

{
  "name": "Boyko Borissov",
  "countries": [
    "US"
  ],
  "dob": "1994-08-22",
  "gender": "male"
}

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

bgColor	#FFBDAD

PUT /worklists/{worklistId}/individuals - to update multiple persons, up to 25 000.

or

Panel

bgColor	#FFBDAD

PUT /worklists/{worklistId}/individuals/{monitorRecordId} - to update a single person, providing it’s Id.

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

language	json

{
  "monitorRecords": [
    {
      "id": "HighRiskProfile300",
      "name": "Boyko Borissov",
      "countries": [
        "US"
      ],
      "dob": "1994-08-22",
      "gender": "male"
    }
  ]
}

Updated

Code Block

language	json

{
  "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

language	json

{
  "name": "Boyko Borissov",
  "countries": [
    "US"
  ],
  "dob": "1994-08-22",
  "gender": "male"
}

Updated

Code Block

language	json

{
  "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

bgColor	#DEEBFF

GET /worklists/{worklistId}/individuals/{monitorRecordId} - get a person by Id.

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
1	name	The full name of the retrieved person.
2	countries	The list of countries related to person in ISO2 format.
3	dob	Person’s date of birth in ISO format YYYY-MM-DD.
4	gender	Possible enum values: male female
5	id	the unique Id of the retrieved person.
6	openCount	The number of open matches for the retrieved person.
7	falsePositiveCount	The number of matches already closed as false positive.
8	truePositiveCount	The number of matches already closed as true positive.
9	discardedCount	The number of matches already discarded.
10	createdDateTimeISO	The timestamp when the person was firstly added to monitoring.
11	lastUpdatedDateTimeISO	The last time the person record was updated by the user.

🗒️ Example

Expand

title	Example

Code Block

language	json

{
  "name": "Boyko Borissov",
  "countries": [
    "US"
  ],
  "dob": "1994-08-22",
  "gender": "male",
  "id": "ABC4043",
  "openCount": 1,
  "falsePositiveCount": 0,
  "truePositiveCount": 0,
  "discardedCount": 0,
  "createdDateTimeISO": "2021-10-05T10:10:08.270Z",
  "lastUpdatedDateTimeISO": "2021-10-05T10:10:08.270Z"
}

All persons

To retrieve all persons, call the endpoint:

Panel

bgColor	#DEEBFF

GET /worklists/{worklistId}/individuals - get all persons.

Request data

{worklistId} - Id of the worklist from which persons will be retrieved.

Query param nameName

Description

Mandatory/Optional

1

nextToken

Token of the next page.

Leaving this blank will return the first page.

Status

colour	Green
title	OPTIONAL

2

pageSize

Number of worklists per page.

Leaving blank will return up to 1 MB data.

Status

colour	Green
title	OPTIONAL

3

status

Filters monitor records by status.

Possible enum values:

open
closed

If not selected, all persons will be returned.

Status

colour	Green
title	OPTIONAL

Response data

Same as in specific worklist section.

	Name	Description	Name
1	worklistsmonitorRecords	List of worklistsmonitorRecords.
2	worklistsmonitorRecords.`idname`	Same as in specific worklist person by id section.
3	worklists.`lastScreenedDateIso`	Same as in specific worklist section.monitorRecords.`countries`
4	worklists.`dobMatching`	monitorRecords.`dob`
5	worklists.`name`	Same as in specific worklist section.monitorRecords.`gender`
6	worklists.`threshold`	Same as in specific worklist section.monitorRecords.`id`
7	worklistsmonitorRecords.`frequency`	Same as in specific worklist section.	`openCount`
8	worklists.`datasets`	Same as in specific worklist section.monitorRecords.`falsePositiveCount`
9	worklistsmonitorRecords.`businessMonitorRecordsCount`	Same as in specific worklist section.	`truePositiveCount`
10	worklists.`businessTruePositiveMatchesCount`	Same as in specific worklist section.monitorRecords.`discardedCount`
11	worklists.`businessFalsePositiveMatchesCount`	Same as in specific worklist section.monitorRecords.`createdDateTimeISO`
12	worklistsmonitorRecords.`businessDiscardedMatchesCount`	Same as in specific worklist section.
13	worklists.`businessOpenMonitorRecordsCount`	Same as in specific worklist section.
14	worklists.`businessOpenMatchesCount`	Same as in specific worklist section.
15	worklists.`individualMonitorRecordsCount`	Same as in specific worklist section.
16	worklists.`individualTruePositiveMatchesCount`	Same as in specific worklist section.
17	worklists.`individualFalsePositiveMatchesCount`	Same as in specific worklist section.
18	worklists.`individualDiscardedMatchesCount`	Same as in specific worklist section.
19	worklists.`individualOpenMonitorRecordsCount`	Same as in specific worklist section.
20	worklists.`individualOpenMatchesCount`	Same as in specific worklist section.
21	nextToken	Token to iterate over pages. If this field is not returned, there are no further pages`lastUpdatedDateTimeISO`
13
14
15
16
17
18
19
20

🗒️ Example

Expand

title	Example

Code Block

Delete monitoring record

Business

Add a record to monitoring worklist

Once monitoring rules are set up, you can add business(-es) to the monitoring worklist.

🏛️ 🏢 🏘️ Add multiple businesses to the monitoring worklist

If you want to add several businesses to monitoring, call the following endpoint:

Panel

bgColor	#FFBDAD

PUT /worklists/{worklistId}/businesses - add/update multiple businesses, up to 25.

{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.

Status

colour	Red
title	MANDATORY

2

name

The full name of the business to be monitored.

Status

colour	Red
title	MANDATORY

3

countries

The list of countries related to the business in ISO2 format.

Status

colour	Red
title	MANDATORY

🗒️ Example

Expand

title	Example

Code Block

language	json

{
  "monitorRecords": [
    {
      "id": "HighRiskProfile300",
      "name": "IBM Corporation",
      "countries": [
        "US"
      ]
    }
  ]
}

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

bgColor	#FFBDAD

PUT /worklists/{worklistId}/businesses/{monitorRecordId} - add/update single business, providing it's Id.

{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.

Status

colour	Red
title	MANDATORY

2

countries

The list of countries related to business in ISO2 format.

Status

colour	Red
title	MANDATORY

🗒️ Example

Expand

title	Example

Code Block

language	json

{
  "name": "IBM Corporation",
  "countries": [
    "US"
  ]
}

Response data

After successfully adding a business to the monitoring worklist you’ll get a response with success code 201: Created.

Version	Old Version 6	New Version 7
Changes made by	Pavelas Bulatovas (Deactivated)	Pavelas Bulatovas (Deactivated)
Saved on	Dec 07, 2022	Dec 07, 2022

Content Comparison

Versions Compared

Key

Add a person to monitoring

🧑‍🦱 🧑 🧑‍🦱 Add multiple persons to the monitoring worklist

Request data

🗒️ Example

Response data

🗒️ Example

🧑‍🦱Add a single person to the monitoring worklist

Request data

🗒️ Example

Response data

Update monitoring record

Update multiple persons record

Request data

Response data

Update a single person record

Request data

Response data

Retrieve monitoring record

Specific person by Id

Request data

Response data

🗒️ Example

All persons

Request data

Response data

🗒️ Example

Delete monitoring record

Business

Add a record to monitoring worklist

🏛️ 🏢 🏘️ Add multiple businesses to the monitoring worklist

Request data

🗒️ Example

Response data

🏢 Add a single business to the monitoring worklist

Request data

🗒️ Example

Response data

Update monitoring record

Retrieve monitoring record

Delete monitoring record