Get the details of a single claim

GET 
https://api.health.curacel.co/api/v1/claims/:id

Get the details of a claim for an Insurer or provider/hospital.

Request

Path Parameters

id numberrequired

The id of the claim you want to get

Query Parameters

with_fields string

When present, value should be comma seperated names of field the user would like returned with the response.

Responses

200

Success

application/json

Schema

Schema

id integer
ref string

This is the hmo_erp_id when user is an Insurer, and provider_ref when user is a provider.

pile_id integer
insurer object
Present only when user is a provider/hospital.
id integer
code string
name string
provider object
Present only when user is an Insurer
id integer
code string
name string
enrollee object
id integer
This is absent if is_floating is truthy.
insurance_no string
firstname string
lastname string
is_floating boolean
encounter_date date
created_at date
submitted_at date
vetted_at date
diagnoses object[]
Array [
id integer
icd_code string
name string
]
amount_billed double
amount_approved double
status string

Status includes: PENDING, APPROVED, PARTIALLY_APPROVED, REJECTED.

PARTIALLY_APPROVED represents when total amount is not equal to the amount approved but not equal to zero(0).

attachments object[]
Array [
id integer
title string
file_type string
filename string
This is the uploaded filename.
file_url string
The file URL on Storage.
thumbnail_url string
Images Only Auto-generated URL that utilizes Cloudinary transformations to give a thumbnail of the image attachment, 150px by 150px dimensions.
preview_url string
Images Only Similar to thumbnail URL, but no width specified, only a reduced height to produce a smaller-sized image that can be suitable for previewing the attachment in a modal before the full file is downloaded.
]
items object[]
Array [
ref string
This is the hmo_erp_id of the Insurer the claim and claim item belongs.
description string
unit_price_billed double
unit_price_approved double
qty_billed integer
qty_approved integer
sub_total_billed double
sub_total_approved double
comments string[]
status string
Status includes: PENDING, APPROVED, PARTIALLY_APPROVED, REJECTED.
]

Example (from schema)

{
  "id": 0,
  "ref": "string",
  "pile_id": 0,
  "insurer": {
    "id": 0,
    "code": "string",
    "name": "string"
  },
  "provider": {
    "id": 0,
    "code": "string",
    "name": "string"
  },
  "enrollee": {
    "id": 0,
    "insurance_no": "string",
    "firstname": "string",
    "lastname": "string",
    "is_floating": true
  },
  "encounter_date": "2025-03-16",
  "created_at": "2025-03-16",
  "submitted_at": "2025-03-16",
  "vetted_at": "2025-03-16",
  "diagnoses": [
    {
      "id": 0,
      "icd_code": "string",
      "name": "string"
    }
  ],
  "amount_billed": 0,
  "amount_approved": 0,
  "status": "string",
  "attachments": [
    {
      "id": 0,
      "title": "string",
      "file_type": "string",
      "filename": "string",
      "file_url": "string",
      "thumbnail_url": "string",
      "preview_url": "string"
    }
  ],
  "items": [
    {
      "ref": "string",
      "description": "string",
      "unit_price_billed": 0,
      "unit_price_approved": 0,
      "qty_billed": 0,
      "qty_approved": 0,
      "sub_total_billed": 0,
      "sub_total_approved": 0,
      "comments": [
        "string"
      ],
      "status": "string"
    }
  ]
}

401

Unauthenticated

403

Forbidden

422

Unprocessable Entity

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: API KEY from your account dashboard

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api.health.curacel.co/api/v1/claims/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://api.health.curacel.co/api

Auth

Bearer Token

Parameters

id — pathrequired

with_fields — query

ResponseClear

Click the Send API Request button above and see the response here!