TIC
Pro+ tier
GEThttps://lens-api.tic.io/screening/companies/{companyId}/plan

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-keystringheaderrequired

Your API key, sent in the x-api-key header.

Path parameters

companyIdintegerrequired

Internal company ID

format: int32

Query parameters

testModeboolean

Price and reuse as in the supplier's test environment

enginestring

The engine to price: trapets or tic (our own lists); empty for the default

Responses

The plan · application/json

companyIdinteger

format: int32

subjectsCompanyScreeningPlanSubject_Dto[] | null
Hide child attributes
subjectKeystring | null
typestring

One of: person company

personIdinteger | null

format: int32

companyIdinteger | null

format: int32

namestring | null
identityNumberstring | null
birthDatestring | null
citizenshipCountryCodestring | null
isTargetboolean
notScreenedReasonstring

One of: protectedIdentity notIdentifiable screeningError

selectedboolean
selectableboolean
rolesTeamScreeningRole_Dto[] | null
Show child attributes
groupstring

One of: target board management signatory liquidator partner beneficialOwner beneficialOwnerRepresentative ownershipChain auditor supplied

codestring | null
descriptionstring | null
extentCodestring | null
extentDescriptionstring | null
positionStartstring | null

format: date-time

unitPricenumber

format: double

companyOnlyPricenumber

format: double

currencystring | null
beneficialOwnerStatusstring | null
beneficialOwnerStatusDescriptionstring | null
reusableScreeningReference_Dto
Hide child attributes
screeningIdstring

format: uuid

screenedAtUtcstring

format: date-time

documentOrderGuidstring

format: uuid