Screen a person

Enterprise+ tier

POSThttps://lens-api.tic.io/screening/persons/{personId}

Screens one person on every personal identity number they have had, their family names and their birth date. Requires the pep scope on the API key.

See Company and person screening for how a person is matched, and Reviewing hits for decisions and history. A person with a protected identity cannot be screened (422, code not_screenable).

Authorization

x-api-keystringheaderrequired

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

Path parameters

personIdintegerrequired

Internal person ID

format: int32

Query parameters

includeQueriesboolean

Include the queries sent

refreshboolean

Screen again even when the same screening ran in the last 24 hours (billed)

Bodyapplication/json

serviceScopestring | null

nameMatchingstring | null

minimumNameMatchScorenumber | null

format: double

fuzzyBirthDateMatchingboolean | null

updatedAfterstring | null

format: date-time

minExpiresstring | null

format: date-time

testModeboolean

Responses

The stored screening · application/json

screeningIdstring

format: uuid

typestring | null

companyIdinteger | null

format: int32

personIdinteger | null

format: int32

screenedAtUtcstring

format: date-time

testModeboolean

reusedboolean

orderScreeningOrder_Dto

Hide child attributes

documentOrderGuidstring

format: uuid

orderedAtUtcstring

format: date-time

pricenumber | null

format: double

currencystring | null

summaryTeamScreeningSummary_Dto

Hide child attributes

subjectCountinteger

format: int32

screenedSubjectCountinteger

format: int32

notScreenedCountinteger

format: int32

queryCountinteger

format: int32

subjectsWithHitsinteger

format: int32

hitCountinteger

format: int32

newHitCountinteger

format: int32

pendingHitCountinteger

format: int32

hitCountByCategoryobject | null

Show child attributes

Additional properties: integer

beneficialOwnerStatusstring | null

beneficialOwnerStatusDescriptionstring | null

subjectsTeamScreeningSubject_Dto[] | null

Hide child attributes

subjectIdinteger

format: int32

typestring

One of: person company

personIdinteger | null

format: int32

companyIdinteger | null

format: int32

referencestring | null

namestring | null

identityNumberstring | null

birthDatestring | null

citizenshipCountryCodestring | null

screenedOnstring | null

notScreenedReasonstring

One of: protectedIdentity notIdentifiable screeningError

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

queryCountinteger

format: int32

queriesTeamScreeningQuery_Dto[] | null

Show child attributes

reasonstring

One of: primary otherIdentityNumber otherFamilyName previousName givenNameVariant alternativeBirthDate otherCompanyName supplied

namestring | null

itemNumberstring | null

itemDatestring | null

rawHitCountinteger

format: int32

hitCountinteger

format: int32

newHitCountinteger

format: int32

pendingHitCountinteger

format: int32

maxHitRatinginteger | null

format: int32

hitCountByRatingobject | null

Show child attributes

Additional properties: integer

screenedBeforeboolean

hitsTeamScreeningHitSummary_Dto[] | null

Show child attributes

hitIdinteger

format: int32

categorystring

One of: other pep sanction adverseMedia regulatoryWarning

namestring | null

birthDatestring | null

isEntityboolean

sourceNamestring | null

listTypestring | null

externalIdstring | null

hitRatinginteger

format: int32

nameMatchScorenumber | null

format: double

tierinteger | null

format: int32

matchedViastring

One of: primary otherIdentityNumber otherFamilyName previousName givenNameVariant alternativeBirthDate otherCompanyName supplied

isNewboolean

resolutionstring

One of: pending truePositive falsePositive escalated noMatch

resolvedAtUtcstring | null

format: date-time

resolutionCommentstring | null

listEntryUpdatedAtUtcstring | null

format: date-time

warningsstring[] | null

errorsstring[] | null

curl -X POST "https://lens-api.tic.io/screening/persons/{personId}" \ -H "x-api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "serviceScope": "<string>", "nameMatching": "<string>", "minimumNameMatchScore": 123.45, "fuzzyBirthDateMatching": true, "updatedAfter": "2026-01-15T10:30:00Z", "minExpires": "2026-01-15T10:30:00Z", "testMode": true }'

{ "screeningId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "<string>", "companyId": 123, "personId": 123, "screenedAtUtc": "2026-01-15T10:30:00Z", "testMode": true, "reused": true, "order": { "documentOrderGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "orderedAtUtc": "2026-01-15T10:30:00Z", "price": 123.45, "currency": "<string>" }, "summary": { "subjectCount": 123, "screenedSubjectCount": 123, "notScreenedCount": 123, "queryCount": 123, "subjectsWithHits": 123, "hitCount": 123, "newHitCount": 123, "pendingHitCount": 123, "hitCountByCategory": {} }, "beneficialOwnerStatus": "<string>", "beneficialOwnerStatusDescription": "<string>", "subjects": [ { "subjectId": 123, "type": "person", "personId": 123, "companyId": 123, "reference": "<string>", "name": "<string>", "identityNumber": "<string>", "birthDate": "<string>", "citizenshipCountryCode": "<string>", "screenedOn": "<string>", "notScreenedReason": "protectedIdentity", "roles": [ { "group": "target", "code": "<string>", "description": "<string>", "extentCode": "<string>", "extentDescription": "<string>", "positionStart": "2026-01-15T10:30:00Z" } ], "queryCount": 123, "queries": [ { "reason": "primary", "name": "<string>", "itemNumber": "<string>", "itemDate": "<string>", "rawHitCount": 123 } ], "hitCount": 123, "newHitCount": 123, "pendingHitCount": 123, "maxHitRating": 123, "hitCountByRating": {}, "screenedBefore": true, "hits": [ { "hitId": 123, "category": "other", "name": "<string>", "birthDate": "<string>", "isEntity": true, "sourceName": "<string>", "listType": "<string>", "externalId": "<string>", "hitRating": 123, "nameMatchScore": 123.45, "tier": 123, "matchedVia": "primary", "isNew": true, "resolution": "pending", "resolvedAtUtc": "2026-01-15T10:30:00Z", "resolutionComment": "<string>", "listEntryUpdatedAtUtc": "2026-01-15T10:30:00Z" } ] } ], "warnings": [ "<string>" ], "errors": [ "<string>" ] }