Skip to main content
GET
/
eligibility
cURL
curl --request GET \
  --url https://api.clarionhealth.com/v1/eligibility \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "status": "completed",
    "outcome": "success",
    "coverage": {
      "is_active_today": true,
      "checked_date": "2023-12-25",
      "plan_name": "Freedom Network",
      "payer_name": "United Healthcare",
      "patient_costs": [
        {
          "type": "deductible",
          "network": "in_network",
          "description": "$1500 deductible (individual) in-network per plan year",
          "amount": "1500",
          "coverage_level": "individual",
          "time_period": "plan_year"
        }
      ],
      "group_number": "1234567890",
      "member_id": "X12345678"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "customer_patient_id": "1234567890"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customer_patient_id
string

Filter eligibility checks by the customer-provided patient identifier

​
status
enum<string>

Filter eligibility checks by status

Available options:
in-progress,
completed,
queued
​
limit
integer<int32>
default:100

Maximum number of results to return. Defaults to 100, maximum is 1000.

Required range: 1 <= x <= 1000

Response

List of eligibility checks

​
id
integer
required
​
status
enum<string>
required
Available options:
completed
​
outcome
enum<string>
required
Available options:
success,
not-supported
​
coverage
object
required
​
created_at
string<date-time>
​
customer_patient_id
string | null
Example:

"1234567890"