Skip to main content
GET
Get a screening
Pro+ tier Returns a stored screening, of a company, a person or a search, in the same compact form as when it ran, with the current decisions on its hits. Requires the pep scope on the API key. The response is described in Company and person screening.

Authorizations

x-api-key
string
header
required

Path Parameters

screeningId
string<uuid>
required

The screening's id

Query Parameters

onlyWithHits
boolean
default:false
includeQueries
boolean
default:false

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[]