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

# Plan a company screening

> Who a company screening would include, with their positions and, for beneficial owners, the extent and kind of control, and what it costs. Nothing is sent or billed. Screen a selection by sending the subjectKeys in `subjects` to `POST /screening/companies/{companyId}`.

Pro+ tier

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](/api-lens/screening/screen-a-company-with-its-board-and-beneficial-owners.md). 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. See [Choosing who to screen](/api-lens/screening/company-screening.md#choosing-who-to-screen).


## OpenAPI

````yaml get /screening/companies/{companyId}/plan
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: RegistrationCertificate
  - name: Screening
  - name: SearchAutocomplete
  - name: Sentinel
  - name: ServingPermits
  - name: Team
  - name: Teams
  - name: Vehicles
  - name: WatchList
paths:
  /screening/companies/{companyId}/plan:
    get:
      tags:
        - Screening
      summary: Plan a company screening
      description: >-
        Who a company screening would include, with their positions and, for
        beneficial owners, the extent and kind of control, and what it costs.
        Nothing is sent or billed. Screen a selection by sending the subjectKeys
        in `subjects` to `POST /screening/companies/{companyId}`.
      operationId: PlanCompanyScreening
      parameters:
        - name: companyId
          in: path
          description: Internal company ID
          required: true
          schema:
            type: integer
            format: int32
        - name: testMode
          in: query
          description: Price and reuse as in the supplier's test environment
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: The plan
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Ormeo_Web_Lens_Models_Screening_CompanyScreeningPlan_Dto
        '404':
          description: Company not found or not accessible
components:
  schemas:
    Ormeo_Web_Lens_Models_Screening_CompanyScreeningPlan_Dto:
      type: object
      properties:
        companyId:
          type: integer
          format: int32
        subjects:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Screening_CompanyScreeningPlanSubject_Dto
        unitPrice:
          type: number
          format: double
        companyOnlyPrice:
          type: number
          format: double
        currency:
          type:
            - 'null'
            - string
        beneficialOwnerStatus:
          type:
            - 'null'
            - string
        beneficialOwnerStatusDescription:
          type:
            - 'null'
            - string
        reusable:
          $ref: >-
            #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningReference_Dto
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_CompanyScreeningPlanSubject_Dto:
      type: object
      properties:
        subjectKey:
          type:
            - 'null'
            - string
        type:
          $ref: '#/components/schemas/Ormeo_Library_Entities_TeamScreeningSubjectType'
        personId:
          type:
            - 'null'
            - integer
          format: int32
        companyId:
          type:
            - 'null'
            - integer
          format: int32
        name:
          type:
            - 'null'
            - string
        identityNumber:
          type:
            - 'null'
            - string
        birthDate:
          type:
            - 'null'
            - string
        citizenshipCountryCode:
          type:
            - 'null'
            - string
        isTarget:
          type: boolean
        notScreenedReason:
          $ref: >-
            #/components/schemas/Ormeo_Library_Entities_TeamScreeningNotScreenedReasonType
        selected:
          type: boolean
        selectable:
          type: boolean
        roles:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Screening_TeamScreeningRole_Dto
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_ScreeningReference_Dto:
      type: object
      properties:
        screeningId:
          type: string
          format: uuid
        screenedAtUtc:
          type: string
          format: date-time
        documentOrderGuid:
          type: string
          format: uuid
      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_Library_Entities_TeamScreeningRoleGroupType:
      enum:
        - target
        - board
        - management
        - signatory
        - liquidator
        - partner
        - beneficialOwner
        - beneficialOwnerRepresentative
        - ownershipChain
        - auditor
        - supplied
      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.