latestOpenAPI 3.0.32026-08-12367267.0 KB
cda4b2b11372
Get person details from screening databases
Retrieve extended profile data, positions, aliases, sanctions, and other metadata for a specific individual listed in screening databases.
Parameters:
- companyKey (string, required) - The company's secret key.
- personId (string, required) – The unique identifier for the person.
post/get-screening-person-details
Request body
Example request
{
"personId": "example-person-id-12345",
"companyKey": "your-company-secret-key"
}Response
Success
Example response
{
"result": {
"entityType": "person",
"firstName": "John",
"middleName": "Doe",
"lastName": "Smith",
"gender": "male",
"birthdayTime": "1952-10-07",
"nationality": "US",
"extraDetails": [
{
"groupName": "Profile",
"details": [
{
"detailName": "John Doe Smith",
"properties": [
{
"propertyName": "Position",
"value": [
"President of US (2012-)",
"chairperson",
"party leader"
],
"type": "list"
},
{
"propertyName": "Name",
"value": [
"John Doe Smith",
"约翰·多·史密斯",
"Джон Доу Сміт"
],
"type": "list"
},
{
"propertyName": "Alias",
"value": [
"John Smith"
],
"type": "list"
}
]
}
]
},
{
"groupName": "Position occupied",
"details": [
{
"detailName": "President",
"properties": [
{
"propertyName": "Name",
"value": [
"President of US",
"President"
],
"type": "string"
},
{
"propertyName": "Start Date",
"value": [
"1999-08-16"
],
"type": "date"
},
{
"propertyName": "End Date",
"value": [
"2000-05-07"
],
"type": "date"
},
{
"propertyName": "Status",
"value": [
"active"
],
"type": "string"
}
]
}
]
},
{
"groupName": "Sanctions",
"details": [
{
"detailName": "Department of Foreign Affairs and Trade",
"properties": [
{
"propertyName": "Start Date",
"value": [
"2022-02-28"
],
"type": "date"
},
{
"propertyName": "Authority",
"value": [
"Department of Foreign Affairs and Trade"
],
"type": "string"
},
{
"propertyName": "Program",
"value": [
""
],
"type": "string"
},
{
"propertyName": "Entity",
"value": [
"Q772247"
],
"type": "string"
},
{
"propertyName": "Summary",
"value": [
"Instrument of first designation and declaration: Autonomous Sanctions ....."
],
"type": "string"
},
{
"propertyName": "Source Url",
"value": [
"https://www.dfat.gov.au/international-relations/security/sanctions/Pages3/"
],
"type": "url"
}
]
}
]
}
]
}
}