Returns information objects about a person associated with the specific session ID = {id}
For matchTypes, please see the data provider's documentation [↗] for more detailed info.
It returns the first value that is true from the following values: name_exact, aka_exact, name_fuzzy, aka_fuzzy, phonetic_name, phonetic_aka, equivalent_name, equivalent_aka, unknown.
If appropriate, the secondary match type is returned: year_of_birth, removed_personal_title, removed_personal_suffix, removed_organisation_prefix, removed_organisation_suffix, removed_clerical_mark.
For matchTypeDetails, please see the data provider's documentation [↗] for more detailed info.
The matchTypeDetails field contains a detailed breakdown of why a hit occurred. For every name you matched on an entity, it will indicate how each term from your search matched it, as well other information about that name.
Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.
Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")
Session id signed with the shared secret key
Session id
Person data
API request status
List of objects identifying the person associated with the search term
The unique identifier of the person
Person's first name
Person's last name
Person's ID number
Person's date of birth
Person's gender
Person's nationality, as ISO 3166-1 Alpha-2 country code format
Person's birth place
Always returns empty array
Array of objects identifying the PEP and Sanction values associated with the person. The array is empty if there are no hits in the database
Name of the data provider that identified the PEP and Sanctions match
The total number of PEP and Sanctions matches found
The date when the PEP and Sanctions match was identified. As Combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z
Array listing the results that match the search term
The name of the person matched in the PEP and Sanctions list
The nationality of the person matched in the PEP and Sanctions list
The category of the PEP and Sanctions match, SIP or PEP
Array of objects listing results that match the search term
List of attributes identifying the info in the document of the person
Document number, [a-zA-Z0-9] characters only
In the format of combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z
In the format of combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z
Array of objects describing the document fields
Name of the document field
Source of the information in the document
Value in the document field
Tag related to the name object
Language
Array of match types names as defined by the data provider
Person's name on the document
Type of the entity
Array of objects listing the alternative names of the person
Person's alternative name
Array of objects identifying associates of the person
Type of association (relationship)
Associate's name
Info about the information sources
Always returns an empty array
Array of objects containing media about the person
In the format of combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z
Text about the person
Title of the text about the person
Web address to the text about the person
Array listing the info about media sources
Web address
Name of the source
File format
List of attributes identifying the information source
List of types as defined by the data provider
Country code, in ISO 1366-1 Alpha-2 country codes format
In the format of combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z
Name of the info source
Web address of the info source
Info about which data was matched
List of more detailed breakdown of why a match happened
More detailed info about why a hit occurred, for example: matching_name, sources, aml_types, name_matches, secondary_matches
Displays the type of the match_type that was matched
Status of the match
Indicates whether an entity has been whitelisted. Availability depends on the configuration
The request results match and ranking is computed via a score that is included as part of the metadata. It is not an absolute ranking of the document, only giving some relative indication of relevance. This decimal value comes from the data provider.
Bad request
Unauthorized
Session not found
Internal server error