> ## Documentation Index
> Fetch the complete documentation index at: https://doc.youverify.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Liveness History

> Retrieve a paginated log of liveness-check sessions run through the SDK, optionally filtered by session ID.



## OpenAPI

````yaml /api-reference/specs/sdk.json get /v2/api/identity/liveness
openapi: 3.0.3
info:
  title: Youverify SDK Utilities API
  version: 2.0.0
  description: >-
    Server-side helper endpoints used by Youverify's mobile/web Liveness SDKs:
    configuring liveness behavior, minting SDK session tokens, and reviewing
    liveness-check history. Assembled from
    doc.youverify.co/api-reference-sdk/sdk, kept in the exact order they appear
    in the GitBook navigation (SDK Settings → Generate SDK Liveness Token →
    Generate SDK Session ID → Liveness History). 401/429/500 are account-wide
    errors sourced verbatim from Youverify's "Youverify OS Error Codes" page and
    attached to every operation; 402 is attached to POST operations; any error a
    specific page actually showed (e.g. the 404 on SDK Settings and Liveness
    History) is kept exactly as documented there.
  contact:
    name: Youverify Support
    email: support@youverify.co
servers:
  - url: https://api.youverify.co
    description: Production (live, billed)
  - url: https://api.sandbox.youverify.co
    description: Sandbox (test data, not billed)
security:
  - ApiKeyAuth: []
tags:
  - name: SDK Utilities
    description: Server-side helper endpoints used by the mobile/web SDKs.
paths:
  /v2/api/identity/liveness:
    get:
      tags:
        - SDK Utilities
      summary: Liveness History
      description: >-
        Retrieve a paginated log of liveness-check sessions run through the SDK,
        optionally filtered by session ID.
      operationId: getLivenessHistory
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
          description: API secret token
        - name: page
          in: query
          required: false
          schema:
            type: string
          description: 'Page number of the requested page. Default: 1.'
        - name: limit
          in: query
          required: false
          schema:
            type: string
          description: 'Number of logs to return. Default: 20.'
        - name: sessionId
          in: query
          required: false
          schema:
            type: string
          description: Filter by session ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                success: true
                statusCode: 200
                message: All liveness data retrieved successfully!
                data:
                  docs:
                    - method: liveness
                      faceImage: >-
                        https://cdn.youverify.co/1758189745918-OjZKC2OsiuoQKQkqCR73m.jpg
                      livenessClip: >-
                        https://cdn.youverify.co/1758189745919-ipJqWMP5qQ2jnZo-w9NEi.mp4
                      passed: true
                      country: null
                      sessionId: 8053d9aff1f50518b3d6e23972bcc2a7
                      createdAt: '2025-09-18T10:02:27.216Z'
                      id: 68cbd8b20f3dc9d9bd19f9fd
                  pagination:
                    totalDocs: 630
                    perPage: 20
                    totalPages: 32
                    currentPage: 1
                    serialNo: 1
                    hasPrevPage: false
                    hasNextPage: true
                    prevPage: null
                    nextPage: 2
                links: []
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '404':
          description: Not Found — the resource you attempted to fetch does not exist.
          content:
            application/json:
              example:
                success: false
                statusCode: 404
                message: You have attempted to get a resource that does not exist.
                name: ResourceNotFoundError
                data: {}
        '429':
          $ref: '#/components/responses/Error429TooManyRequests'
        '500':
          $ref: '#/components/responses/Error500ServerError'
components:
  responses:
    Error401Unauthorized:
      description: Unauthorized — the token header is missing or invalid.
      content:
        application/json:
          example:
            success: false
            statusCode: 401
            message: Permission denied
            name: UnauthorizedError
            data: {}
    Error429TooManyRequests:
      description: Too Many Requests — you have exceeded the rate limit; wait and retry.
      content:
        application/json:
          example:
            success: false
            statusCode: 429
            message: Too many requests
            name: RateLimitError
            data: {}
    Error500ServerError:
      description: >-
        Internal Server Error — a rare, unexpected failure on Youverify's side.
        Contact support@youverify.co if it persists.
      content:
        application/json:
          example:
            success: false
            statusCode: 500
            message: Internal Server Error
            name: Error
            data: {}
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: token
      description: Your Youverify API secret key. Never expose client-side.

````