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

# Submit Pre-auth

> Submits a pre-auth for the claim. request_type picks the workflow: InitialRequest, QueryResponse to answer a payer query, FollowUp to resubmit a rejected pre-auth, Enhancement to raise the approved scope. Everything the claim already knows (payer, policy, facility, patient) is filled in for you. The payer answers asynchronously: a 2xx means the request was sent, not approved. Track it with the returned request_id on Get Claim Request.



## OpenAPI

````yaml post /abdm/nhcx/v1/claims/{claimId}/preauth
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}/preauth:
    post:
      summary: Submit Pre-auth
      description: >-
        Submits a pre-auth for the claim. request_type picks the workflow:
        InitialRequest, QueryResponse to answer a payer query, FollowUp to
        resubmit a rejected pre-auth, Enhancement to raise the approved scope.
        Everything the claim already knows (payer, policy, facility, patient) is
        filled in for you. The payer answers asynchronously: a 2xx means the
        request was sent, not approved. Track it with the returned request_id on
        Get Claim Request.
      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_type:
                  type: string
                clinical_notes:
                  type: string
                consent:
                  $ref: '#/components/schemas/ModelsPreAuthConsent'
                  description: >-
                    Beneficiary authentication. AuthType "consent" (default)
                    sends the Authentication Consent Questionnaire response
                    (Consent) and OMITS the biometric X-Token; "biometric" sends
                    UserToken as the X-Token.
                diagnosis:
                  items:
                    $ref: '#/components/schemas/ModelsDiagnosisCoding'
                  type:
                    - array
                    - 'null'
                items:
                  description: >-
                    Carries the client-supplied deltas per procedure line:
                    speciality code, procedure code, claim amount, optional
                    stratification code, supporting docs, and questionnaire
                    answers. Names/costs/mandatory-docs are enriched server-side
                    from the case's catalog (catalog_md5).
                  items:
                    $ref: '#/components/schemas/ModelsNHCXPreAuthItem'
                  type: array
                planned_end_date:
                  format: date-time
                  type:
                    - 'null'
                    - string
                planned_start_date:
                  format: date-time
                  type:
                    - 'null'
                    - string
                request_type:
                  type: string
                treating_doctor:
                  $ref: '#/components/schemas/ModelsTreatingDoctor'
                  description: >-
                    NOT case-derivable — supplied by the caller (HMIS) per
                    submission.
                user_token:
                  type: string
              required:
                - request_type
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsRequestIdModel'
          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:
    ModelsPreAuthConsent:
      properties:
        answers:
          items:
            $ref: '#/components/schemas/ModelsPreAuthQuestionnaireAnswer'
          type:
            - array
            - 'null'
        questionnaire_url:
          type: string
      type: object
    ModelsDiagnosisCoding:
      properties:
        code:
          type: string
        display:
          type: string
        system:
          description: defaults to ICD-10 if empty
          type: string
      required:
        - code
        - display
      type: object
    ModelsNHCXPreAuthItem:
      properties:
        claim_amount:
          type: number
        procedure_code:
          type: string
        procedure_name:
          type: string
        quantity:
          type: integer
        questionnaire_answers:
          description: >-
            Carries STG form answers for this procedure. Each answer maps to one
            Claim.supportingInfo entry with valueString.
          items:
            $ref: '#/components/schemas/ModelsPreAuthQuestionnaireAnswer'
          type: array
        speciality_code:
          type: string
        speciality_name:
          type: string
        strat_code:
          type: string
        strat_display:
          type: string
        supporting_docs:
          description: >-
            Provides actual document content keyed by MandCode. Each entry maps
            to one Claim.supportingInfo entry with valueAttachment.
          items:
            $ref: '#/components/schemas/ModelsPreAuthDocInput'
          type: array
      type: object
    ModelsTreatingDoctor:
      properties:
        hpr_id:
          description: ABDM Health Professional Registry ID (e.g. 12-1212-1212-1212)
          type: string
        name:
          type: string
        qualification:
          type: string
        registration_id:
          description: NMC / council registration no.
          type: string
        specialty:
          description: SNOMED specialty label or free text
          type: string
      required:
        - name
      type: object
    ModelsRequestIdModel:
      properties:
        estimated_response_time:
          description: e.g., "4-6 hours"
          type: string
        message:
          type: string
        request_id:
          type: string
        status:
          type: string
        workflow_id:
          description: Current workflow state
          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
    ModelsPreAuthQuestionnaireAnswer:
      properties:
        answer: {}
        link_id:
          type: string
        question:
          type: string
        questionnaire_url:
          description: STG questionnaire URL
          type: string
      type: object
    ModelsPreAuthDocInput:
      properties:
        content:
          description: base64 inline payload
          type: string
        content_type:
          description: '"application/pdf"'
          type: string
        creation:
          description: '"YYYY-MM-DD"'
          type: string
        doc_id:
          description: >-
            DocID — see ClaimSupportingDoc.DocID: a reference to a stored draft
            attachment, hydrated server-side when Content is empty.
          type: string
        mand_code:
          description: e.g. "MAND0006" — matches the plan's mandatory doc
          type: string
        title:
          type: string
        url:
          description: presigned S3 URL (preferred)
          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.