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

# List Biometric Sessions

> Every biometric verify recorded on the claim. Cyclic claims take their cycle_dates from the cycle rows; next_capture_allowed_at is set while the 24 hour gap runs.



## OpenAPI

````yaml get /abdm/nhcx/v1/claims/{claimId}/biometric-auth/sessions
openapi: 3.1.0
info:
  description: ABHA Registration and login APIs
  title: Registration
  version: 1.0.0
servers:
  - description: Production
    url: https://api.eka.care
  - description: Stage/Sandbox
    url: https://api.dev.eka.care
security: []
paths:
  /abdm/nhcx/v1/claims/{claimId}/biometric-auth/sessions:
    get:
      summary: List Biometric Sessions
      description: >-
        Every biometric verify recorded on the claim. Cyclic claims take their
        cycle_dates from the cycle rows; next_capture_allowed_at is set while
        the 24 hour gap runs.
      parameters:
        - description: Eka User ID (OID)
          in: header
          name: X-Pt-Id
          schema:
            type: string
        - description: Partner User ID
          in: header
          name: X-Partner-Pt-Id
          schema:
            type: string
        - description: Partner HIP ID
          in: header
          name: X-Hip-Id
          schema:
            type: string
        - description: claim_id returned by Create Claim
          in: path
          name: claimId
          required: true
          schema:
            description: claim_id returned by Create Claim
            minimum: 0
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsBiometricSessionList'
          description: OK
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NhcxError'
          description: ''
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NhcxError'
          description: ''
      security:
        - authApiKey: []
components:
  schemas:
    ModelsBiometricSessionList:
      properties:
        sessions:
          items:
            $ref: '#/components/schemas/ModelsBiometricSession'
          type:
            - array
            - 'null'
      type: object
    NhcxError:
      properties:
        error:
          type: string
        issues:
          description: >-
            Every validation problem found, when the backend rejects a submit
            before it reaches the payer
          items:
            type: string
          type: array
        updated_at:
          description: 'Only on a 409 from the draft save: the stored draft''s version'
          type: string
      type: object
    ModelsBiometricSession:
      properties:
        auth_mode:
          type: string
        captured_at:
          description: >-
            The instant the verify succeeded (IST, RFC3339). The claim's cycle
            window is validated against it payer-side, and the next cycle
            unlocks 24h after it — a calendar date alone cannot express either,
            so the FE needs the timestamp.
          type: string
        date:
          description: YYYY-MM-DD (IST)
          type: string
        next_capture_allowed_at:
          description: >-
            CapturedAt + the 24h re-capture gap: when this stage's capture
            button may be re-enabled. Empty once the window has already elapsed.
          type: string
        procedure_code:
          description: The billed line this capture belongs to (empty on older rows).
          type: string
        purpose:
          description: >-
            "preauth" / "cycle" / "discharge" — only "cycle" rows are treatment
            visits, and only they belong in the claim's cycle_dates.
          type: string
        stage:
          type: string
      type: object
  securitySchemes:
    authApiKey:
      description: The API requires a Bearer token (JWT) for authentication.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.