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

# Search PEP, sanctions and adverse media lists

> Screens one or more people or organisations by name and/or identity number, without requiring them to exist as a person or company record. Several subjects can be screened in one call and each is returned separately. Every call places a billable order and returns its DocumentOrderGuid, so the screening can be retrieved again later through the orders API.

<Badge color="yellow" size="sm">Enterprise+ tier</Badge>

Screens people and organisations against PEP, sanctions and adverse media lists. Unlike the
screening endpoints on [companies](/api-lens/companies/order-a-pepsanction-and-adverse-media-screening)
and [persons](/api-lens/persons/order-a-pepsanction-and-adverse-media-screening), the subject does
not need to exist as a record in the platform - you supply the name and/or identity number yourself.

### Subjects

Up to **50 subjects** can be screened in one call. Each is returned separately, in the order it was
submitted, and each needs a name, an identity number, or both.

* `identityNumber` - personnummer or samordningsnummer (10 or 12 digits), or organisationsnummer
  (10 digits). Matched exactly, and a match here outweighs the name.
* `name` - a subject carrying both a name and an identity number matches on **either one**, not both.
* `birthDate` - `yyyy-MM-dd`, `yyyy-MM` or `yyyy`. List entries with no known birth date always
  match, whatever you supply.
* `countries` - ISO 3166-1 alpha-3 codes, e.g. `["SWE", "NOR"]`. Narrowing by country cuts false
  positives, but can also drop true hits where the list entry has poor country data.
* `reference` - your own reference, echoed back on the matching result so you can pair them up.
  Generated for you if omitted.

### Matching

`nameMatching` defaults to `Regular`, which matches exact aliases. `Phonetic` also matches
similar-sounding names - it finds more true hits and considerably more false ones. Use
`minimumNameMatchScore` (0 to 1) to trim the tail; it applies only to phonetic matching, and the
supplier recommends 0.75 to 0.9.

`serviceScope` selects which lists to screen against, for example `SANCTION` or `PEP_Edge`, or a
comma-separated combination. Leave it empty to use every service enabled for your account.

<Warning>
  **Every call places a billable order**, including calls that return no hits. The response carries
  `order.documentOrderGuid`, which you can use to retrieve the same screening later through the
  [orders API](/api-lens/orders/get-metadata-for-a-single-document-order).

  Results are not reused between calls - each request screens the lists fresh, so repeating a
  search bills again rather than replaying a recent result.
</Warning>

### Partial failures

A screening can succeed overall while individual subjects fail. `warnings` reports subjects the
supplier ignored, and `errors` reports per-subject failures; the rest of the screening still runs.
Check both before treating a subject as clear.


## OpenAPI

````yaml post /screening/search
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: 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: Transportstyrelsen
  - name: Vehicles
  - name: WatchList
paths:
  /screening/search:
    post:
      tags:
        - Screening
      summary: Search PEP, sanctions and adverse media lists
      description: >-
        Screens one or more people or organisations by name and/or identity
        number, without requiring them to exist as a person or company record.
        Several subjects can be screened in one call and each is returned
        separately. Every call places a billable order and returns its
        DocumentOrderGuid, so the screening can be retrieved again later through
        the orders API.
      operationId: SearchScreening
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningSearchRequest_Dto
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningSearchRequest_Dto
          text/json:
            schema:
              $ref: >-
                #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningSearchRequest_Dto
          application/*+json:
            schema:
              $ref: >-
                #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningSearchRequest_Dto
      responses:
        '200':
          description: Screening result, including the order it was billed as
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningSearchResult_Dto
        '400':
          description: >-
            No subjects supplied, too many subjects, or a subject with neither a
            name nor an identity number
components:
  schemas:
    Ormeo_Web_Lens_Models_Screening_ScreeningSearchRequest_Dto:
      type: object
      properties:
        subjects:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningSubject_Dto
        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
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_ScreeningSearchResult_Dto:
      type: object
      properties:
        requestedAtUtc:
          type: string
          format: date-time
        source:
          type:
            - 'null'
            - string
        order:
          $ref: >-
            #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningOrder_Dto
        summary:
          $ref: >-
            #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningSummary_Dto
        results:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningSubjectResult_Dto
        warnings:
          type:
            - 'null'
            - array
          items:
            type: string
        errors:
          type:
            - 'null'
            - array
          items:
            type: string
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_ScreeningSubject_Dto:
      type: object
      properties:
        reference:
          type:
            - 'null'
            - string
        name:
          type:
            - 'null'
            - string
        identityNumber:
          type:
            - 'null'
            - string
        birthDate:
          type:
            - 'null'
            - string
        countries:
          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_ScreeningSummary_Dto:
      type: object
      properties:
        subjectCount:
          type: integer
          format: int32
        individualHitCount:
          type: integer
          format: int32
        entityHitCount:
          type: integer
          format: int32
        totalHitCount:
          type: integer
          format: int32
        servicesQueried:
          type:
            - 'null'
            - array
          items:
            type: string
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_ScreeningSubjectResult_Dto:
      type: object
      properties:
        reference:
          type:
            - 'null'
            - string
        name:
          type:
            - 'null'
            - string
        identityNumber:
          type:
            - 'null'
            - string
        hitCount:
          type: integer
          format: int32
        hits:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningHit_Dto
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_ScreeningHit_Dto:
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
        name:
          type:
            - 'null'
            - string
        identityNumber:
          type:
            - 'null'
            - string
        birthDate:
          type:
            - 'null'
            - string
        hitRating:
          type: integer
          format: int32
        hitRatingDescription:
          type:
            - 'null'
            - string
        nameMatchScore:
          type:
            - 'null'
            - number
          format: double
        listType:
          type:
            - 'null'
            - string
        listItemDataType:
          type:
            - 'null'
            - string
        sourceName:
          type:
            - 'null'
            - string
        externalId:
          type:
            - 'null'
            - string
        lastUpdatedUtc:
          type:
            - 'null'
            - string
          format: date-time
        tier:
          type:
            - 'null'
            - integer
          format: int32
        isProtectedIdentity:
          type:
            - 'null'
            - boolean
        isMale:
          type:
            - 'null'
            - boolean
        title:
          type:
            - 'null'
            - string
        comment:
          type:
            - 'null'
            - string
        legalForm:
          type:
            - 'null'
            - string
        operationalStatus:
          type:
            - 'null'
            - string
        countries:
          type:
            - 'null'
            - array
          items:
            type: string
        citizenships:
          type:
            - 'null'
            - array
          items:
            type: string
        aliases:
          type:
            - 'null'
            - array
          items:
            type: string
        externalUrls:
          type:
            - 'null'
            - array
          items:
            type: string
        roles:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningRole_Dto
        engagements:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningEngagement_Dto
        relationships:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Screening_ScreeningRelationship_Dto
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_ScreeningRole_Dto:
      type: object
      properties:
        roleType:
          type:
            - 'null'
            - string
        roleTypeDescription:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        organization:
          type:
            - 'null'
            - string
        countryCode:
          type:
            - 'null'
            - string
        from:
          type:
            - 'null'
            - string
        to:
          type:
            - 'null'
            - string
        comment:
          type:
            - 'null'
            - string
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_ScreeningEngagement_Dto:
      type: object
      properties:
        engagementType:
          type:
            - 'null'
            - string
        name:
          type:
            - 'null'
            - string
        corporateId:
          type:
            - 'null'
            - string
        ownershipStake:
          type:
            - 'null'
            - number
          format: double
        from:
          type:
            - 'null'
            - string
        to:
          type:
            - 'null'
            - string
      additionalProperties: false
    Ormeo_Web_Lens_Models_Screening_ScreeningRelationship_Dto:
      type: object
      properties:
        name:
          type:
            - 'null'
            - string
        relationshipType:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        comment:
          type:
            - 'null'
            - string
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header

````