> ## 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 Claims > Lists claims with their beneficiary. ## OpenAPI ````yaml get /abdm/nhcx/v1/claims 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: get: summary: List Claims description: Lists claims with their beneficiary. 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: facility (default) lists every claim of the calling facility in: query name: scope schema: description: facility (default) lists every claim of the calling facility enum: - facility - beneficiary type: string - description: Lists one beneficiary's claims. Implies scope=beneficiary in: query name: beneficiary_id schema: description: Lists one beneficiary's claims. Implies scope=beneficiary minimum: 0 type: integer - in: query name: limit schema: type: integer - in: query name: offset schema: type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ModelsClaimListItem' type: - 'null' - array 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: ModelsClaimListItem: properties: admission_date: format: date-time type: - 'null' - string admission_type: type: string archived_at: description: >- Set when the provider archived (set aside) this claim; nil = active. Archived claims still appear in the list/detail APIs (for analytics) but are excluded from reuse. format: date-time type: - 'null' - string beneficiary: $ref: '#/components/schemas/ModelsBeneficiarySummary' case_number: type: string catalog_md5: type: string claim_id: minimum: 0 type: integer claim_ref: type: string copay_amount: description: >- The payer-declared patient-liable amount (ClaimResponse.total[copayment]). type: number copay_required: description: >- True when the payer has declared a patient-liable amount on this claim's latest adjudication — the signal to enable the co-payment collection flow (and its mandatory beneficiary consent form) in the UI. Derived from the payer's own response, NOT from a wallet-vs-claim comparison: the payer is authoritative on what the beneficiary owes, and its figure already accounts for scheme rules a naive balance subtraction would miss. type: boolean created_at: format: date-time type: string deduction_pct: description: >- The payer's deduction on the final claim as a percentage of the submitted amount ((submitted − approved) / submitted × 100). Nil until an adjudicated final-claim request with both amounts exists. type: - 'null' - number discharge_date: format: date-time type: - 'null' - string discharge_type: type: string drafts: description: >- Lists the stages that have a saved (unsubmitted) draft — "Preauth" and/or "Claim". Present so the resume path can go straight to GET .../requests/draft: instead of issuing speculative reads for ids that may not exist. items: type: string type: array max_queries_reached: type: boolean payer_code: type: string policy_id: description: >- The policy this case was created against. Serialized so a client resuming the case can key the procedure catalogue (GET /policies/:policyId/...) off it directly, instead of re-deriving it from a redundant, failure-prone POST /policies/search on every resume. minimum: 0 type: integer preauth_case_no: type: string preauth_due_by: description: >- CreatedAt + 48h — the deadline to initiate a pre-auth after registration. Nil once a pre-auth has ever been submitted (the deadline no longer applies) or once the claim is archived. format: date-time type: - 'null' - string preauth_overdue: description: >- True when PreAuthDueBy has passed and no pre-auth has been submitted — the claim is a candidate for the next ArchiveOverdueRegistrations sweep. type: boolean preauth_ref: type: string product_id: type: string provider_hfr: type: string query_count: description: >- How many times the payer has queried this claim's pre-auth. MaxQueriesReached mirrors the UAT's stated cap of 2 — informational: NHCX controls when it stops querying, this is not a limit we enforce on submission. type: integer registration_details: description: >- The stored TC-04 registration enrichment (attendant, emergency and child document references) as captured at case creation — see models.StoredRegistration. Omitted when none was supplied. Document bytes are not inlined; the refs point to S3. review_path: description: >- Tells the FE which post-adjudication action to offer: "crc" — rejected, or deduction strictly > 20%: the one-shot CRC appeal (POST /claims/:claimId/claim/reprocess). "cpd_review" — deduction ≤ 20% (including exactly 20%): "erroneous claim"; CPD review, NOT appealable — the reprocess endpoint will refuse it. "" — no adjudicated deduction/rejection to act on, or the one-shot appeal is already used (see the claim's reprocess request row / claim_reprocess_* status for its outcome). type: string status: type: string updated_at: format: date-time 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 ModelsBeneficiarySummary: properties: abha_number: type: string beneficiary_id: minimum: 0 type: integer date_of_birth: type: string gender: type: string mobile: type: string name: type: string patient_id: type: string pmjay_id: 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.