Note
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
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
`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
`id`	string	The `recordId` of the person for subsequent calls.

...

Bulk add persons to the monitoring

...

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

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

Note
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
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
`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
`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.

...

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

...

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

Headers

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
`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
`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

...

Note
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
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
`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.

...

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

Headers

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
`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
`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

...

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

Headers

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

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

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

...

POST /v1/worklists/{worklistId}/natural-entity-records/search

Headers

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

Note
All request fields are optional. They can be passed to narrow the search.

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

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

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.

...

2. RETRIEVE PERSON MATCHES

...

POST /v1/worklists/{worklistId}/natural-entity-records/{recordId}/search

Headers

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

After successfully retrieving the person matches you’ll get a response with success code 201: Created with fields:

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

...

GET /v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId}

Headers

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

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

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.

...

3. GET MONITORED PERSON MATCH DETAILS

...

GET /v1/natural-entity-details/{resourceId}

Headers

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

After successfully retrieving details of the matched person profile, you’ll get a response with success code 200: Success and the response.

...

Version	Old Version 21	New Version 22
Changes made by	Svajunas	Svajunas
Saved on	Jul 12, 2023	Oct 24, 2023

Versions Compared

Key

Headers

Request body

Response

Bulk add persons to the monitoring

Headers

Request body

Response

Stop monitoring a person

Headers

Response

Headers

Request body

Response

Update person monitoring record

Headers

Request body

Response

Headers

Request body

Response

Retrieve a specific person monitoring record

Headers

Response

Retrieve all person monitoring records

Headers

Request body

Response

2. RETRIEVE PERSON MATCHES

Headers

Response

Retrieve a specific match of the person

Headers

Response

3. GET MONITORED PERSON MATCH DETAILS

Headers

Response

Content Comparison

Versions Compared

Key

Headers

Request body

Response

Bulk add persons to the monitoring

Headers

Request body

Response

Stop monitoring a person

Headers

Response

Headers

Request body

Response

Update person monitoring record

Headers

Request body

Response

Headers

Request body

Response

Retrieve a specific person monitoring record

Headers

Response

Retrieve all person monitoring records

Headers

Request body

Response

2. RETRIEVE PERSON MATCHES

Headers

Response

Retrieve a specific match of the person

Headers

Response

3. GET MONITORED PERSON MATCH DETAILS

Headers

Response