Screening
Plan a company screening
Who a company screening would include, with their positions and, for beneficial owners, the extent and kind of control, and what it costs. Nothing is sent or billed. Screen a selection by sending the subjectKeys in subjects to POST /screening/companies/{companyId}.
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. Prices and reuse are those of the default engine; add engine=tic for the tic engine’s, see Engines. See Choosing who to screen.
Authorization
x-api-keystringheaderrequiredYour API key, sent in the x-api-key header.
Path parameters
companyIdintegerrequiredInternal company ID
Query parameters
testModebooleanPrice and reuse as in the supplier's test environment
enginestringThe engine to price: trapets or tic (our own lists); empty for the default
Responses
The plan · application/json
companyIdintegersubjectsCompanyScreeningPlanSubject_Dto[] | nullHide child attributes
subjectKeystring | nulltypestringpersonIdinteger | nullcompanyIdinteger | nullnamestring | nullidentityNumberstring | nullbirthDatestring | nullcitizenshipCountryCodestring | nullisTargetbooleannotScreenedReasonstringselectedbooleanselectablebooleanrolesTeamScreeningRole_Dto[] | nullShow child attributes
groupstringcodestring | nulldescriptionstring | nullextentCodestring | nullextentDescriptionstring | nullpositionStartstring | nullunitPricenumbercompanyOnlyPricenumbercurrencystring | nullbeneficialOwnerStatusstring | nullbeneficialOwnerStatusDescriptionstring | nullreusableScreeningReference_DtoHide child attributes
screeningIdstringscreenedAtUtcstringdocumentOrderGuidstringCompany not found or not accessible