> ## 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.

# 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.

<Badge color="green" size="sm">Pro+ tier</Badge>

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](/api-lens/screening/company-screening#the-response).


## OpenAPI

````yaml get /screening/{screeningId}
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/{screeningId}:
    get:
      tags:
        - Screening
      summary: Get a screening
      description: >-
        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.
      operationId: GetScreening
      parameters:
        - name: screeningId
          in: path
          description: The screening's id
          required: true
          schema:
            type: string
            format: uuid
        - name: onlyWithHits
          in: query
          schema:
            type: boolean
            default: false
        - name: includeQueries
          in: query
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: The stored screening
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Ormeo_Web_Lens_Models_Screening_TeamScreening_Dto
        '404':
          description: Screening not found
components:
  schemas:
    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.