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

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