Skip to main content
POST
Screen a person
Enterprise+ tier Screens one person on every personal identity number they have had, their family names and their birth date. Requires the pep scope on the API key. See Company and person screening for how a person is matched, and Reviewing hits for decisions and history. A person with a protected identity cannot be screened (422, code not_screenable).
The same screening asked again within 24 hours returns the stored result with reused true, without a new order. Add refresh=true to screen again (billed).

Authorizations

x-api-key
string
header
required

Path Parameters

personId
integer<int32>
required

Internal person ID

Query Parameters

includeQueries
boolean
default:false

Include the queries sent

refresh
boolean
default:false

Screen again even when the same screening ran in the last 24 hours (billed)

Body

serviceScope
null | string
nameMatching
null | string
minimumNameMatchScore
null | number<double>
fuzzyBirthDateMatching
null | boolean
updatedAfter
null | string<date-time>
minExpires
null | string<date-time>
testMode
boolean

Response

The stored screening

screeningId
string<uuid>
type
null | string
companyId
null | integer<int32>
personId
null | integer<int32>
screenedAtUtc
string<date-time>
testMode
boolean
reused
boolean
order
object
summary
object
beneficialOwnerStatus
null | string
beneficialOwnerStatusDescription
null | string
subjects
null | object[]
warnings
null | string[]
errors
null | string[]