Skip to main content
GET
Plan a company screening
Pro+ tier Lists everyone a company screening can include, without screening anyone or placing an order: the company, its board, management, signatories, liquidators, partners, beneficial owners, the companies in the ownership chain and the auditors. Requires the pep scope on the API key. Each subject has a subjectKey, its roles (the registered position, or for a beneficial owner the extent and kind of control) and selected, which says whether a screening includes it by default (everyone but auditors). The company itself has isTarget true and is always screened. Subjects that cannot be screened (a protected identity, or no name or identity number) have notScreenedReason and cost nothing. To screen a selection, send the chosen subjectKey values in subjects to Screen a company. The price is unitPrice per screened person or company, or companyOnlyPrice when only the company is screened. reusable is set when the default selection was screened in the last 24 hours: sending that selection returns the earlier result at no cost. See Choosing who to screen.

Authorizations

x-api-key
string
header
required

Path Parameters

companyId
integer<int32>
required

Internal company ID

Query Parameters

testMode
boolean
default:false

Price and reuse as in the supplier's test environment

Response

The plan

companyId
integer<int32>
subjects
null | object[]
unitPrice
number<double>
companyOnlyPrice
number<double>
currency
null | string
beneficialOwnerStatus
null | string
beneficialOwnerStatusDescription
null | string
reusable
object