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

# Get Biometric Consent

> Says whether a captured biometric consent for the stage is still valid, so you can reuse its user_token instead of capturing again.



## OpenAPI

````yaml get /abdm/nhcx/v1/claims/{claimId}/biometric-auth/consent
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/consent:
    get:
      summary: Get Biometric Consent
      description: >-
        Says whether a captured biometric consent for the stage is still valid,
        so you can reuse its user_token instead of capturing again.
      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
        - in: query
          name: stage
          required: true
          schema:
            enum:
              - Preauth
              - Claim
            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/ModelsBiometricConsentStatus'
          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:
    ModelsBiometricConsentStatus:
      properties:
        expires_at:
          format: date-time
          type:
            - 'null'
            - string
        stage:
          type: string
        status:
          description: '"valid" | "none" (an expired consent is evicted, so it reads "none")'
          type: string
        user_token:
          type: string
      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
  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.