> ## 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 Claim Request

> One exchange in full: what was sent (request_meta, documents), the parsed payer answer (response_meta, empty while pending) and the per-item verdicts (items).



## OpenAPI

````yaml get /abdm/nhcx/v1/claims/{claimId}/requests/{correlationId}
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}/requests/{correlationId}:
    get:
      summary: Get Claim Request
      description: >-
        One exchange in full: what was sent (request_meta, documents), the
        parsed payer answer (response_meta, empty while pending) and the
        per-item verdicts (items).
      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
        - description: request_id from a submit, or correlation_id from Get Claim Requests
          in: path
          name: correlationId
          required: true
          schema:
            description: >-
              request_id from a submit, or correlation_id from Get Claim
              Requests
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsClaimRequestDetail'
          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:
    ModelsClaimRequestDetail:
      properties:
        approved_amount:
          type:
            - 'null'
            - number
        correlation_id:
          type: string
        created_at:
          format: date-time
          type: string
        documents:
          items:
            $ref: '#/components/schemas/ModelsClaimRequestDocSummary'
          type: array
        error_code:
          description: >-
            ErrorCode / ErrorMessage carry a gateway/payer ProtocolResponse
            error so the UI can show WHY a request failed, not just that it did.
          type: string
        error_message:
          type: string
        items:
          items:
            $ref: '#/components/schemas/ModelsClaimRequestItem'
          type: array
        outcome:
          type: string
        request_id:
          minimum: 0
          type: integer
        request_meta: {}
        request_subtype:
          description: >-
            Distinguishes a variant within RequestType that workflow_id cannot
            (e.g. "cancel"/"enhancement"/"reprocess" within request_type
            "preauth"/"claim") — and, for request_type "communication", carries
            the payer's Task.reasonCode (tatquery/grievance/
            walletupdate/policychange/additionalinfo), which has no workflow_id
            at all. Previously unexposed on this summary; see
            nhcx_api_contract_changes.md.
          type: string
        request_type:
          type: string
        response_meta: {}
        status:
          type: string
        submitted_amount:
          type:
            - 'null'
            - number
        updated_at:
          format: date-time
          type: string
        workflow_id:
          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
    ModelsClaimRequestDocSummary:
      properties:
        category:
          type: string
        content_type:
          type: string
        doc_id:
          type: string
        title:
          type: string
      type: object
    ModelsClaimRequestItem:
      properties:
        approved_amount:
          description: >-
            What the payer allowed for this item (its "eligible" adjudication,
            which is already net of any deduction). Set only once the item is
            approved.
          type: number
        claim_amount:
          type: number
        copay_amount:
          type: number
        deducted_amount:
          description: The amount the payer disallowed off this item's claimed amount.
          type: number
        procedure_code:
          type: string
        quantity:
          type: number
        reason_code:
          description: >-
            The payer's machine code for a deduction/rejection (e.g.
            "DEDUCT/01"); Reasons carries the human-readable text the provider
            must act on (query text, deduction explanation).
          type: string
        reasons:
          items:
            type: string
          type: array
        sequence:
          type: integer
        speciality_code:
          type: string
        state:
          description: >-
            The item's adjudication state: pending until the payer responds,
            then approved | queried | rejected.
          type: string
        strat_code:
          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.