latestOpenAPI 3.0.32026-08-12367267.0 KB
cda4b2b11372
Search for a person in screening databases
Use this endpoint to search for individuals in global screening databases including sanctions, PEPs (Politically Exposed Persons), regulatory actions, and more.
Parameters:
- companyKey (string, required) - The company's secret key.
- query (object, required) – The parameters for querying the database.
- fullName (string, required) – Full name of the individual.
- birthdayTimeFrom (string, optional) – The start date and time of the birthday range in ISO 8601 format.
- scoreThreshold (integer, required) – The minimum score required for the query results.
- offset (integer, optional) – The number of items to skip from the beginning of the results.
- limit (integer, optional) – The maximum number of items to return in the query results.
Entities glossary:
- **Sanctioned Entity**: Companies, individuals, or other entities that have been designated by a government to prohibit specific interactions with them.
- **Sanction-linked Entity**: Entities, including companies and individuals, that have a direct relationship with a sanctioned entity. This also includes companies that are indirect subsidiaries of sanctioned entities, regardless of the percentage ownership held by the sanctioned entity.
- **Counter-sanctioned Entity**: Entities listed on sanctions lists from non-democratic countries, often targeting pro-democracy activists, journalists, and human rights advocates.
- **Debarred Entity**: Companies or individuals that have been excluded from public procurement, typically due to committing fraud in the execution of a government contract.
- **Politician (Politically Exposed Persons)**: Individuals who currently or previously held a position of political influence.
- **Close Associate**: Family members and key business associates of politically exposed persons (PEPs). These individuals are often used as nominees or front-people to hide illicit financial gains.
- **Person of Interest**: Individuals under scrutiny due to public interest, who do not meet the common definitions of politically-exposed persons and are not sanctioned.
- **Regulator Action**: Companies that have been subject to enforcement action by an industry regulatory body.
- **Regulator Warning**: Companies that have been placed on a warning or alert list by an industry regulatory body.
post/search-screening-person
Request body
Example request
{
"companyKey": "your-company-secret-key",
"query": {
"birthdayTimeFrom": "1980-11-07T13:07:59.790Z",
"fullName": "John Doe",
"scoreThreshold": 80
},
"offset": 0,
"limit": 100
}Response
Success
Example response
{
"result": [
{
"personId": "666010a771e39d01b5023d0f",
"entityType": "person",
"name": "John Doe",
"score": 100,
"topics": [
"Sanctioned entity",
"Wanted person",
"Person of interest",
"Politician"
]
}
]
}