Table of Contents

1 Introduction
2 Manage Person Records
3 Retrieve Person Matches
- 3.1 Retrieve all matches of the person
- 3.2 Retrieve a specific match of the person
4 Get Monitored Person Match Details
5 Code Examples

Introduction

Once monitoring rules in the worklist are set up, you can do the following actions with persons:

Manage person records:
- Add a person to monitoring
- Remove person from monitoring
- Update person record
- Get person records
Retrieve person matches
Get monitored person’s details

Manage Person Records

Start monitoring a person

To start monitoring a person, add it to the monitoring worklist.
To do this, call the following endpoint:
- POST /v1/worklists/{worklistId}/natural-entity-records

This endpoint only capable to add 1 person at a time. To add multiple persons in one request, please check out the next section.

Headers

Parameter	Type	Required	Description

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

Field	Type	Required	Description
`name`	string	YES	The name of the person.
`dateOfBirth`	string	NO	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
`gender`	string	NO	Gender of the person.
`referenceId`	string	NO	A unique identifier for the person’es reference in the system.
`referenceType`	string	NO	User created reference for the person in the system, for example "My Reference".

Response

Field	Type	Description

Field	Type	Description
`id`	string	The `recordId` of the person for subsequent calls.

Bulk add persons to the monitoring

Headers

Parameter	Type	Required	Description

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

Field	Type	Required	Description
`naturalEntityRecords`	array<object>	-	An array of objects representing the person records.
naturalEntityRecords.`name`	string	YES	The name of the person.
naturalEntityRecords.`dateOfBirth`	string	NO	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
naturalEntityRecords.`gender`	string	NO	Gender of the person.
naturalEntityRecords.`referenceId`	string	NO	A unique identifier for the person’es reference in the system.
naturalEntityRecords.`referenceType`	string	NO	User created reference for the person in the system, for example "My Reference".

Response

Field	Type	Description

Field	Type	Description
`hasErrors`	boolean	A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects.
`records`	array	An array of objects representing the records in the response.
records.`id`	string	The unique identifier for the record in the system.
records.`createdAt`	string	The date and time when the record was created in ISO 8601 format.
records.`name`	string	The name of the person.
records.`dateOfBirth`	string	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
records.`gender`	string	Gender of the person.
records.`referenceId`	string	A unique identifier for the person’es reference in the system.
records.`referenceType`	string	User created reference for the person in the system, for example "My Reference".
records.`error`	object	An optional object containing information about any errors associated with the record.
records.error.`code`	string	A string code identifying the type of error that occurred.
records.error.`message`	string	A human-readable message describing the error that occurred.

Stop monitoring a person

Headers

Parameter	Type	Required	Description

Parameter	Type	Required	Description
worklistId	string	YES	The unique Id of the worklist.
recordId	string	YES	The unique Id of the person to update.
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

Bulk remove persons from monitoring

Headers

Parameter	Type	Required	Description

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

Field	Type	Required	Description
`naturalEntityRecords`	array<object>	-	An array of objects representing id’s of person records.
naturalEntityRecords.`id`	string		The `recordId` of the person to be removed.

Response

Field	Type	Description

Field	Type	Description
`hasErrors`	boolean	A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects.
`deletedRecords`	array	An array of objects representing the records in the response.
deletedRecords.`id`	string	The `recordId` of the removed person.
deletedRecords.`error`	object	An optional object containing information about any errors associated with the record.
deletedRecords.error.`code`	string	A string code identifying the type of error that occurred.
deletedRecords.error.`message`	string	A human-readable message describing the error that occurred.

Update person monitoring record

Headers

Parameter	Type	Required	Description

Parameter	Type	Required	Description
worklistId	string	YES	The unique Id of the worklist.
recordId	string	YES	The unique Id of the person to update.
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

Field	Type	Required	Description
`name`	string	YES	The updated name of the person.
records.`dateOfBirth`	string	NO	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
records.`gender`	string	NO	Gender of the person.
`referenceId`	string	NO	An updated identifier for the person’es reference in the system.
`referenceType`	string	NO	An updated reference for the person in the system.

Response

Bulk update person monitoring records

Headers

Parameter	Type	Required	Description

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

Field	Type	Required	Description
`naturalEntityRecords`	array<object>	-	An array of objects representing the person records.
naturalEntityRecords.`name`	string	YES	The updated name of the person.
naturalEntityRecords.`dateOfBirth`	string	NO	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
naturalEntityRecords.`gender`	string	NO	Gender of the person.
naturalEntityRecords.`referenceId`	string	NO	An updated identifier for the person’es reference in the system.
naturalEntityRecords.`referenceType`	string	NO	Updated reference for the person in the system.
naturalEntityRecords.`id`	string	YES	The unique Id of the person which will be updated.

Response

Field	Type	Description

Field	Type	Description
`hasErrors`	boolean	A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects.
`records`	array	An array of objects representing the records in the response.
records.`id`	string	The unique identifier for the record in the system.
records.`createdAt`	string	The date and time when the record was created in ISO 8601 format.
records.`name`	string	The name of the person.
records.`dateOfBirth`	string	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
records.`gender`	string	Gender of the person.
records.`referenceId`	string	A unique identifier for the person’es reference in the system.
records.`referenceType`	string	User created reference for the person in the system, for example "My Reference".
records.`error`	object	An optional object containing information about any errors associated with the record.
records.error.`code`	string	A string code identifying the type of error that occurred.
records.error.`message`	string	A human-readable message describing the error that occurred.

Retrieve a specific person monitoring record

Headers

Parameter	Type	Required	Description

Parameter	Type	Required	Description
worklistId	string	YES	The unique Id of the worklist.
recordId	string	YES	The unique Id of the person to retrieve.
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

Field	Type	Description
`id`	string	The unique identifier for the record in the system.
`createdAt`	string	Date and time when the response was created.
`name`	string	The name of the person associated with the response.
`dateOfBirth`	string	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
`gender`	string	Gender of the person.
`referenceId`	string	A unique identifier for the person’es reference in the system.
`referenceType`	string	User created reference for the person in the system, for example "My Reference".
`openCount`	integer	The number of open matches for the monitor record
`falsePositiveCount`	integer	The number of matches already closed as false positive
`truePositiveCount`	integer	The number of matches already closed as true positive.
`discardedCount`	integer	The number of matches already discarded.
`createdDateTimeIso`	string	Date and time when the person record was first created.
`lastUpdatedDateTimeIso`	string	Date and time when the person record was last updated.

Retrieve all person monitoring records

Headers

Parameter	Type	Required	Description

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

Field	Type	Required	Description
`id`	string	NO	The unique identifier for the record in the system.
`dateOfBirth`	string	NO	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
`gender`	string	NO	Gender of the person.
`name`	string	NO	The name of the person.
`referenceId`	string	NO	A unique identifier for the person’es reference in the system.
`referenceType`	string	NO	User created reference for the person in the system, for example "My Reference".
`from`	string	NO	Date FROM when person record was added to worklist. Response will return person records added after this date.
`to`	string	NO	Date TO when person record was added to worklist. Response will return person records added before this date.

Response

Field	Type	Description

Field	Type	Description
`hasErrors`	boolean	A boolean value indicating whether there are any errors in the response. If there are errors, the records array may contain error objects.
`records`	array	An array of objects representing the records in the response.
records.`id`	string	The unique identifier for the record in the system.
records.`createdAt`	string	The date and time when the record was created in ISO 8601 format.
records.`name`	string	The name of the person.
records.`dateOfBirth`	string	Date of birth of the person. Format: YYYY-MM-DD or YYYY.
records.`gender`	string	Gender of the person.
records.`referenceId`	string	A unique identifier for the person’es reference in the system.
records.`referenceType`	string	User created reference for the person in the system, for example "My Reference".
records.`error`	object	An optional object containing information about any errors associated with the record.
records.error.`code`	string	A string code identifying the type of error that occurred.
records.error.`message`	string	A human-readable message describing the error that occurred.

Retrieve Person Matches

If any of your monitored person records gets a match in our AML datasets, you can retrieve it.

Retrieve all matches of the person

Headers

Parameter	Type	Required	Description

Parameter	Type	Required	Description
worklistId	string	YES	The unique Id of the worklist.
recordId	string	YES	The unique Id of the person record to retrieve.
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

Field	Type	Description
`totalCount`	integer	Total number of matches.
`matches`	array<object>	An array of objects representing the match information.
matches.`currentStatus`	string	Current status of the person match. Possible enum values: `Open` - match requires review. `TruePositive` - match closed as true positive `FalsePositive` - match closed as false positive `Discarded` - match was discarded
matches.`matchId`	string	The unique Id of the person match.
matches.`version`	integer	Can be used to detect when the profile has changed.
matches.`resourceId`	string	The unique id that can be used to retrieve the detailed information about person profile via `GET /v1/natural-entity-details/{resourceId}` endpoint.
matches.`score`	integer	The match score. This means how accurate the found person match the monitored person. E.g. `"score": 100` means that the found person is the exact match to the provided in the monitoring. Possible values from `75` to `100`
matches.`match`	string	The person name that has been matched in the monitoring.
matches.`name`	string	The name of the found person.
matches.`countries`	string	The list of countries from the addresses and nationalities of the profile.
matches.`datesOfBirth`	array<string>	An array of strings representing the person dates of birth. Format: YYYY-MM-DD or YYYY.
matches.`gender`	string	Gender of the person.
matches.`profileImage`	string	The URL to person’s profile image.
matches.`dataSets`	string	Active datasets where person is tagged in. Possible enum values are any of the described datasets here.
matches.`matchVersion`	integer	This value can be used for version control.

Retrieve a specific match of the person

Headers

Parameter	Type	Required	Description

Parameter	Type	Required	Description
worklistId	string	YES	The unique Id of the worklist.
recordId	string	YES	The unique Id of the person record to retrieve.
matchId	string	YES	The unique Id of the person match to retrieve.
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

Field	Type	Description
`currentStatus`	string	Current status of the person match. Possible enum values: `Open` - match requires review. `TruePositive` - match closed as true positive `FalsePositive` - match closed as false positive `Discarded` - match was discarded
`matchId`	string	The unique Id of the person match.
`version`	string	Can be used to detect when the profile has changed.
`resourceId`	string	The unique id that can be used to retrieve the detailed information about person profile via `GET /v1/natural-entity-details/{resourceId}` endpoint.
`score`	string	The match score. This means how accurate the found person match the monitored person. E.g. `"score": 100` means that the found person is the exact match to the provided in the monitoring. Possible values from `75` to `100`
`match`	integer	The person name that has been matched in the monitoring.
`name`	integer	The name of the found person.
`countries`	integer	The list of countries from the addresses and nationalities of the profile.
`datesOfBirth`	array<string>	An array of strings representing the person dates of birth. Format: YYYY-MM-DD or YYYY.
`gender`	string	Gender of the person.
`profileImage`	string	The URL to person’s profile image.
`dataSets`	integer	Active datasets where person is tagged in. Possible enum values are any of the described datasets here.
`matchVersion`	string	This value can be used for version control.

Get Monitored Person Match Details

Headers

Parameter	Type	Required	Description

Parameter	Type	Required	Description
resourceId	string	YES	The unique Id of the matched person profile to retrieve the detailed information.
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

Code Examples

Start monitoring a person

Example request

{
  "name": "Boyko Borissov",
  "dateOfBirth": "1994-08-22",
  "gender": "Male",
  "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
  "referenceType": "My Reference"
}

Example response

{
  "id": "54d0e87303644a599651f7d0bab9e952"
}

Bulk add multiple persons to the monitoring

Example request

{
  "naturalEntityRecords": [
    {
      "name": "Boyko Borissov",
      "dateOfBirth": "1994-08-22",
      "gender": "Male",
      "referenceId": "02241D31-2058-45AD-8D03-6AACF97863B8",
      "referenceType": "My Reference"
    }
  ]
}

Person AML Monitoring

Introduction

Manage Person Records

Start monitoring a person

Headers

Request body

Response

Bulk add persons to the monitoring

Headers

Request body

Response

Stop monitoring a person

Headers

Response

Bulk remove persons from monitoring

Headers

Request body

Response

Update person monitoring record

Headers

Request body

Response

Bulk update person monitoring records

Headers

Request body

Response

Retrieve a specific person monitoring record

Headers

Response

Retrieve all person monitoring records

Headers

Request body

Response

Retrieve Person Matches

Retrieve all matches of the person

Headers

Response

Retrieve a specific match of the person

Headers

Response

Get Monitored Person Match Details

Headers

Response

Code Examples

Start monitoring a person

Example request

Example response

Bulk add multiple persons to the monitoring

Example request

Example response

Bulk remove persons from monitoring

Example request

Example response

Update person monitoring record

Example request

Bulk update person monitoring records

Example request

Example response

Retrieve a specific person monitoring record

Example response

Retrieve all person monitoring records

Example request

Example response

Retrieve all matches of the person

Example response

Retrieve a specific match of the person

Example response

Get monitored person match details

Related content