> ## Documentation Index
> Fetch the complete documentation index at: https://docs.txcloud.thetekcircle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Screen individual or entity



## OpenAPI

````yaml openapi/watchlist.yaml post /watchlist/screen
openapi: 3.0.3
info:
  title: TXCloud Watchlist API
  version: 1.0.0
  description: >
    AML/CFT screening against global sanctions lists, PEP databases, and adverse
    media.
servers:
  - url: https://api.txcloud.io/v1
  - url: https://sandbox.api.txcloud.io/v1
security:
  - BearerAuth: []
tags:
  - name: Screening
    description: Entity screening
  - name: Matches
    description: Match management
  - name: Monitoring
    description: Ongoing monitoring
  - name: Lists
    description: Watchlist management
  - name: Analytics
    description: Screening analytics
paths:
  /watchlist/screen:
    post:
      tags:
        - Screening
      summary: Screen individual or entity
      operationId: screenEntity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenRequest'
      responses:
        '200':
          description: Screening result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenResult'
components:
  schemas:
    ScreenRequest:
      type: object
      required:
        - entity
      properties:
        entity:
          type: object
          required:
            - type
            - name
          properties:
            type:
              type: string
              enum:
                - individual
                - entity
                - organization
            name:
              type: string
            date_of_birth:
              type: string
              format: date
            nationality:
              type: string
            country_of_residence:
              type: string
            document_number:
              type: string
            registration_number:
              type: string
        lists:
          type: array
          items:
            type: string
            enum:
              - sanctions
              - pep
              - adverse_media
        threshold:
          type: number
          default: 0.85
        include_aliases:
          type: boolean
        fuzziness:
          type: string
          enum:
            - exact
            - moderate
            - fuzzy
    ScreenResult:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        status:
          type: string
          enum:
            - clear
            - potential_match
            - confirmed_hit
        hits:
          type: integer
        entity:
          type: object
        matches:
          type: array
          items:
            $ref: '#/components/schemas/ScreenMatch'
        screened_against:
          type: array
          items:
            type: object
        risk_level:
          type: string
        processing_time_ms:
          type: integer
    ScreenMatch:
      type: object
      properties:
        id:
          type: string
        list:
          type: string
        score:
          type: number
        status:
          type: string
        matched_entity:
          type: object
        match_details:
          type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````