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

After successfully creating a person record you’ll get a response with success code 201: Created and recordId of the person for subsequent calls.

Field	Type	Description

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

Bulk add persons to the monitoring

You can add multiple persons to the monitoring with one call.
To do this, call the following endpoint:
- POST /v1/worklists/{worklistId}/natural-entity-records/batch

This endpoint capable to add up to 25 records with one call.

POST /v1/worklists/{worklistId}/natural-entity-records/batch-async

This endpoint capable to add up to 10.000 records with one call. Records added through this endpoint will take longer to be processed and appear in the worklist.

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

After successfully creating a person records you’ll get a response with success code 200: Success with fields:

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

To stop monitoring the person, remove it from the monitoring worklist.
To do this, call the following endpoint:
- DELETE /v1/worklists/{worklistId}/natural-entity-records/{recordId}

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

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

After successfully deleting the person record from monitoring, you’ll get a response with success code 204: No Content.

Bulk remove persons from monitoring

You can remove multiple persons from the monitoring with one call.
To do this, call the following endpoint:
- DELETE /v1/worklists/{worklistId}/natural-entity-records/batch

This endpoint capable to remove up to 25 records with one call.

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

After successfully deleting person records from monitoring, you’ll get a response with success code 200: Success with fields:

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

You can update existing person record.
To do this, call the following endpoint:
- PUT /v1/worklists/{worklistId}/natural-entity-records/{recordId}

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

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

After successfully updating a person record, you’ll get a response with success code 204: No Content.

Bulk update person monitoring records

You can update multiple persons with one call.
To do this, call the following endpoint:
- PUT /v1/worklists/{worklistId}/natural-entity-records/batch

This endpoint capable to update up to 25 records with one call.

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

After successfully updating person records, you’ll get a response with success code 200: Success with fields:

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

Ondato

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