Screening
Get a screening
Returns a stored screening (company, person or search) in the same compact form as when it ran, with the current decisions on its hits. onlyWithHits=true leaves out subjects without hits, includeQueries=true adds the queries sent, includeHits=false returns the subjects with their hit counts only (page the hits with POST /screening/{screeningId}/subjects/{subjectId}/hits).
Pro+ tier
GEThttps://lens-api.tic.io/screening/{screeningId}
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.
Authorization
x-api-keystringheaderrequiredYour API key, sent in the x-api-key header.
Path parameters
screeningIdstringrequiredThe screening's id
Query parameters
onlyWithHitsbooleanincludeQueriesbooleanincludeHitsbooleanResponses
The stored screening · application/json
screeningIdstringtypestring | nullcompanyIdinteger | nullpersonIdinteger | nullscreenedAtUtcstringtestModebooleanreusedbooleanorderScreeningOrder_DtoHide child attributes
documentOrderGuidstringorderedAtUtcstringpricenumber | nullcurrencystring | nullsummaryTeamScreeningSummary_DtoHide child attributes
subjectCountintegerscreenedSubjectCountintegernotScreenedCountintegerqueryCountintegersubjectsWithHitsintegerhitCountintegernewHitCountintegerpendingHitCountintegerhitCountByCategoryobject | nullShow child attributes
beneficialOwnerStatusstring | nullbeneficialOwnerStatusDescriptionstring | nullsubjectsTeamScreeningSubject_Dto[] | nullHide child attributes
subjectIdintegertypestringpersonIdinteger | nullcompanyIdinteger | nullreferencestring | nullnamestring | nullidentityNumberstring | nullbirthDatestring | nullcitizenshipCountryCodestring | nullscreenedOnstring | nullnotScreenedReasonstringrolesTeamScreeningRole_Dto[] | nullShow child attributes
groupstringcodestring | nulldescriptionstring | nullextentCodestring | nullextentDescriptionstring | nullpositionStartstring | nullqueryCountintegerqueriesTeamScreeningQuery_Dto[] | nullShow child attributes
reasonstringnamestring | nullitemNumberstring | nullitemDatestring | nullrawHitCountintegerhitCountintegernewHitCountintegerpendingHitCountintegermaxHitRatinginteger | nullhitCountByRatingobject | nullShow child attributes
screenedBeforebooleanhitsTeamScreeningHitSummary_Dto[] | nullShow child attributes
hitIdintegercategorystringnamestring | nullbirthDatestring | nullisEntitybooleansourceNamestring | nulllistTypestring | nullexternalIdstring | nullhitRatingintegernameMatchScorenumber | nulltierinteger | nullmatchedViastringisNewbooleanresolutionstringresolvedAtUtcstring | nullresolutionCommentstring | nulllistEntryUpdatedAtUtcstring | nullwarningsstring[] | nullerrorsstring[] | nullScreening not found