> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tic.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Screen a person
> Screens a person against PEP and sanctions lists, on every personal identity number they have had, and stores the result.
Enterprise+ tier
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](/api-lens/screening/company-screening) for how a person is matched, and [Reviewing hits](/api-lens/screening/reviewing-hits) for decisions and history. A person with a protected identity cannot be screened (`422`, code `not_screenable`).
The same screening asked again within 24 hours returns the stored result with `reused` `true`, without a new order. Add `refresh=true` to screen again (billed).
## OpenAPI
````yaml post /screening/persons/{personId}
openapi: 3.1.1
info:
title: TIC Lens API
description: "The TIC Lens API provides programmatic access to company, person, property, vehicle, and order data.\r\n\r\n## Authentication\r\n\r\nAll requests require an API key passed via the `x-api-key` header:\r\n\r\n```bash\r\ncurl -H \"x-api-key: YOUR_API_KEY\" https://lens-api.tic.io/companies/123\r\n```\r\n\r\nAPI keys are managed through the TIC Lens web application under **Settings → API Keys**.\r\n\r\n## Base URL\r\n\r\n| Environment | URL |\r\n|-------------|-----|\r\n| Production | `https://lens-api.tic.io` |\r\n\r\n## Feature Access\r\n\r\nEndpoints are gated by your subscription plan. If your plan does not include a feature, the endpoint will return `403 Forbidden`.\r\n\r\n## Rate Limits\r\n\r\nRate limits are applied per API key. If you exceed the limit, requests will return `429 Too Many Requests`.\r\n\r\n## Response Format\r\n\r\nAll responses are JSON. Null values are omitted from responses.\r\n"
version: v1
servers:
- url: https://lens-api.tic.io
security:
- ApiKey: []
tags:
- name: Addresses
- name: Bolagsverket
- name: Brf
- name: Companies
- name: CompanyReports
- name: Documents
- name: FlightImages
- name: Free
- name: Orders
- name: OrdersExports
- name: PaymentControl
- name: PaymentControlImport
- name: Persons
- name: Properties
- name: PublicSearch
- name: Screening
- name: SearchAutocomplete
- name: Sentinel
- name: ServingPermits
- name: Team
- name: Teams
- name: Vehicles
- name: WatchList
paths:
/screening/persons/{personId}:
post:
tags:
- Screening
summary: Screen a person
description: >-
Screens a person against PEP and sanctions lists, on every personal
identity number they have had, and stores the result.
operationId: ScreenPerson
parameters:
- name: personId
in: path
description: Internal person ID
required: true
schema:
type: integer
format: int32
- name: includeQueries
in: query
description: Include the queries sent
schema:
type: boolean
default: false
- name: refresh
in: query
description: >-
Screen again even when the same screening ran in the last 24 hours
(billed)
schema:
type: boolean
default: false
requestBody:
content:
application/json-patch+json:
schema:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_PersonScreeningRequest_Dto
application/json:
schema:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_PersonScreeningRequest_Dto
text/json:
schema:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_PersonScreeningRequest_Dto
application/*+json:
schema:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_PersonScreeningRequest_Dto
responses:
'200':
description: The stored screening
content:
application/json:
schema:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_TeamScreening_Dto
'404':
description: Person not found
'422':
description: Protected identity, or nothing to screen on
components:
schemas:
Ormeo_Web_Lens_Models_Screening_PersonScreeningRequest_Dto:
type: object
properties:
serviceScope:
type:
- 'null'
- string
nameMatching:
type:
- 'null'
- string
minimumNameMatchScore:
type:
- 'null'
- number
format: double
fuzzyBirthDateMatching:
type:
- 'null'
- boolean
updatedAfter:
type:
- 'null'
- string
format: date-time
minExpires:
type:
- 'null'
- string
format: date-time
testMode:
type: boolean
additionalProperties: false
Ormeo_Web_Lens_Models_Screening_TeamScreening_Dto:
type: object
properties:
screeningId:
type: string
format: uuid
type:
type:
- 'null'
- string
companyId:
type:
- 'null'
- integer
format: int32
personId:
type:
- 'null'
- integer
format: int32
screenedAtUtc:
type: string
format: date-time
testMode:
type: boolean
reused:
type: boolean
order:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningOrder_Dto
summary:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_TeamScreeningSummary_Dto
beneficialOwnerStatus:
type:
- 'null'
- string
beneficialOwnerStatusDescription:
type:
- 'null'
- string
subjects:
type:
- 'null'
- array
items:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_TeamScreeningSubject_Dto
warnings:
type:
- 'null'
- array
items:
type: string
errors:
type:
- 'null'
- array
items:
type: string
additionalProperties: false
Ormeo_Web_Lens_Models_Screening_ScreeningOrder_Dto:
type: object
properties:
documentOrderGuid:
type: string
format: uuid
orderedAtUtc:
type: string
format: date-time
price:
type:
- 'null'
- number
format: double
currency:
type:
- 'null'
- string
additionalProperties: false
Ormeo_Web_Lens_Models_Screening_TeamScreeningSummary_Dto:
type: object
properties:
subjectCount:
type: integer
format: int32
screenedSubjectCount:
type: integer
format: int32
notScreenedCount:
type: integer
format: int32
queryCount:
type: integer
format: int32
subjectsWithHits:
type: integer
format: int32
hitCount:
type: integer
format: int32
newHitCount:
type: integer
format: int32
pendingHitCount:
type: integer
format: int32
hitCountByCategory:
type:
- 'null'
- object
additionalProperties:
type: integer
format: int32
additionalProperties: false
Ormeo_Web_Lens_Models_Screening_TeamScreeningSubject_Dto:
type: object
properties:
subjectId:
type: integer
format: int32
type:
$ref: '#/components/schemas/Ormeo_Library_Entities_TeamScreeningSubjectType'
personId:
type:
- 'null'
- integer
format: int32
companyId:
type:
- 'null'
- integer
format: int32
reference:
type:
- 'null'
- string
name:
type:
- 'null'
- string
identityNumber:
type:
- 'null'
- string
birthDate:
type:
- 'null'
- string
citizenshipCountryCode:
type:
- 'null'
- string
screenedOn:
type:
- 'null'
- string
notScreenedReason:
$ref: >-
#/components/schemas/Ormeo_Library_Entities_TeamScreeningNotScreenedReasonType
roles:
type:
- 'null'
- array
items:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_TeamScreeningRole_Dto
queryCount:
type: integer
format: int32
queries:
type:
- 'null'
- array
items:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_TeamScreeningQuery_Dto
hitCount:
type: integer
format: int32
newHitCount:
type: integer
format: int32
maxHitRating:
type:
- 'null'
- integer
format: int32
hits:
type:
- 'null'
- array
items:
$ref: >-
#/components/schemas/Ormeo_Web_Lens_Models_Screening_TeamScreeningHitSummary_Dto
additionalProperties: false
Ormeo_Library_Entities_TeamScreeningSubjectType:
enum:
- person
- company
type: string
Ormeo_Library_Entities_TeamScreeningNotScreenedReasonType:
enum:
- protectedIdentity
- notIdentifiable
type: string
Ormeo_Web_Lens_Models_Screening_TeamScreeningRole_Dto:
type: object
properties:
group:
$ref: >-
#/components/schemas/Ormeo_Library_Entities_TeamScreeningRoleGroupType
code:
type:
- 'null'
- string
description:
type:
- 'null'
- string
extentCode:
type:
- 'null'
- string
extentDescription:
type:
- 'null'
- string
positionStart:
type:
- 'null'
- string
format: date-time
additionalProperties: false
Ormeo_Web_Lens_Models_Screening_TeamScreeningQuery_Dto:
type: object
properties:
reason:
$ref: >-
#/components/schemas/Ormeo_Library_Entities_TeamScreeningQueryReasonType
name:
type:
- 'null'
- string
itemNumber:
type:
- 'null'
- string
itemDate:
type:
- 'null'
- string
rawHitCount:
type: integer
format: int32
additionalProperties: false
Ormeo_Web_Lens_Models_Screening_TeamScreeningHitSummary_Dto:
type: object
properties:
hitId:
type: integer
format: int32
category:
$ref: >-
#/components/schemas/Ormeo_Library_Entities_TeamScreeningHitCategoryType
name:
type:
- 'null'
- string
birthDate:
type:
- 'null'
- string
isEntity:
type: boolean
sourceName:
type:
- 'null'
- string
listType:
type:
- 'null'
- string
externalId:
type:
- 'null'
- string
hitRating:
type: integer
format: int32
nameMatchScore:
type:
- 'null'
- number
format: double
tier:
type:
- 'null'
- integer
format: int32
matchedVia:
$ref: >-
#/components/schemas/Ormeo_Library_Entities_TeamScreeningQueryReasonType
isNew:
type: boolean
resolution:
$ref: '#/components/schemas/Ormeo_Library_Entities_AmlScreeningResolution'
resolvedAtUtc:
type:
- 'null'
- string
format: date-time
resolutionComment:
type:
- 'null'
- string
listEntryUpdatedAtUtc:
type:
- 'null'
- string
format: date-time
additionalProperties: false
Ormeo_Library_Entities_TeamScreeningRoleGroupType:
enum:
- target
- board
- management
- signatory
- liquidator
- partner
- beneficialOwner
- beneficialOwnerRepresentative
- ownershipChain
- auditor
- supplied
type: string
Ormeo_Library_Entities_TeamScreeningQueryReasonType:
enum:
- primary
- otherIdentityNumber
- otherFamilyName
- previousName
- givenNameVariant
- alternativeBirthDate
- otherCompanyName
- supplied
type: string
Ormeo_Library_Entities_TeamScreeningHitCategoryType:
enum:
- other
- pep
- sanction
- adverseMedia
- regulatoryWarning
type: string
Ormeo_Library_Entities_AmlScreeningResolution:
enum:
- pending
- truePositive
- falsePositive
- escalated
- noMatch
type: string
securitySchemes:
ApiKey:
type: apiKey
name: x-api-key
in: header
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.