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

# Check liveness

> Detects if a selfie image is of a live person or a spoof attempt.

**Detection Modes:**
- `passive` - Single image analysis (default)
- `active` - Multiple frames with movement

**Spoof Types Detected:**
- Printed photos
- Screen displays
- Masks
- Deepfakes




## OpenAPI

````yaml openapi/identity.yaml post /identity/liveness
openapi: 3.0.3
info:
  title: TXCloud Identity API
  version: 1.0.0
  description: >
    The TXCloud Identity API enables identity verification through document
    OCR, 

    face matching, liveness detection, and fraud checks.


    ## Base URL

    ```

    https://api.txcloud.io/v1

    ```


    ## Authentication

    All requests require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer txc_live_your_api_key

    ```


    ## Rate Limits

    | Plan | Requests/min |

    |------|--------------|

    | Starter | 60 |

    | Growth | 300 |

    | Scale | 1,000 |

    | Enterprise | Custom |
  termsOfService: https://txcloud.io/terms
  contact:
    name: TXCloud API Support
    email: support@txcloud.io
    url: https://docs.txcloud.io
  license:
    name: Proprietary
    url: https://txcloud.io/license
  x-logo:
    url: https://txcloud.io/logo.png
servers:
  - url: https://api.txcloud.io/v1
    description: Production
  - url: https://sandbox.api.txcloud.io/v1
    description: Sandbox (test environment)
security:
  - BearerAuth: []
tags:
  - name: Verification
    description: Core identity verification endpoints
  - name: Management
    description: Manage and retrieve verifications
  - name: Sessions
    description: Multi-step verification sessions
  - name: Documents
    description: Document management
  - name: Configuration
    description: Supported documents and countries
paths:
  /identity/liveness:
    post:
      tags:
        - Verification
      summary: Check liveness
      description: |
        Detects if a selfie image is of a live person or a spoof attempt.

        **Detection Modes:**
        - `passive` - Single image analysis (default)
        - `active` - Multiple frames with movement

        **Spoof Types Detected:**
        - Printed photos
        - Screen displays
        - Masks
        - Deepfakes
      operationId: checkLiveness
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LivenessRequest'
      responses:
        '200':
          description: Liveness check result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LivenessResponse'
components:
  schemas:
    LivenessRequest:
      type: object
      required:
        - image
      properties:
        image:
          type: string
          format: byte
        mode:
          type: string
          enum:
            - passive
            - active
          default: passive
        frames:
          type: array
          items:
            type: string
            format: byte
          description: Additional frames for active mode
    LivenessResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
          enum:
            - identity.liveness
        is_live:
          type: boolean
        confidence:
          type: number
        spoof_probability:
          type: number
        spoof_type:
          type: string
          enum:
            - none
            - photo
            - screen
            - mask
            - deepfake
        signals:
          type: array
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key as Bearer token

````