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

# Verify Biometric Auth

> Completes the authentication with the PID block from the RD-service scanner. Send the user_token with auth_type biometric on Submit Pre-auth or Submit Claim. For cyclic procedures send purpose cycle and procedure_code on every treatment visit.



## OpenAPI

````yaml post /abdm/nhcx/v1/claims/{claimId}/biometric-auth/verify
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/verify:
    post:
      summary: Verify Biometric Auth
      description: >-
        Completes the authentication with the PID block from the RD-service
        scanner. Send the user_token with auth_type biometric on Submit Pre-auth
        or Submit Claim. For cyclic procedures send purpose cycle and
        procedure_code on every treatment visit.
      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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                auth_mode:
                  type: string
                finger_print_auth_pid:
                  type: string
                iris_auth_pid:
                  type: string
                procedure_code:
                  description: >-
                    Scopes a "cycle" capture to one billed procedure. Required
                    in practice when the case has more than one cyclic line (an
                    enhancement can add a second): the payer wants a separate
                    capture per procedure, and without this two same-day
                    captures collide.
                  type: string
                process:
                  enum:
                    - Preauth
                    - Claim
                    - Discharge
                  type: string
                purpose:
                  description: >-
                    Distinguishes the captures a cyclic course needs: "cycle"
                    for a per-treatment-visit capture, "discharge" for the final
                    one that authenticates the claim, "preauth" for the one on
                    the pre-auth. Optional — defaults to "preauth" on the
                    Preauth stage and "discharge" otherwise, so a non-cyclic
                    flow needs no change. **Send "cycle" for every treatment
                    visit**: only those rows carry the 24h re-capture gap, and
                    only they become the claim's cycle_dates.
                  enum:
                    - preauth
                    - cycle
                    - discharge
                  type: string
                txn_id:
                  type: string
              required:
                - process
                - auth_mode
                - txn_id
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsBiometricAuthVerifyResponse'
          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:
    ModelsBiometricAuthVerifyResponse:
      properties:
        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.