---
title: "View insurance coverage (beta)"
method: GET
path: "/insurance_coverages/{id}"
tags: ["Insurance"]
---

# View insurance coverage (beta)

`GET /insurance_coverages/{id}`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/insurance_coverages/{id}`
- Auth: API key in header `Authorization`

> 🚧 Beta
>
> Send `Nex-Api-Version: v3.1.0` to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

> **Changed from v3.0.0:** Adds response fields `data.benefits_remaining`, `data.benefits_remaining.amount`, `data.benefits_remaining.currency`, `data.subscriber.postal_code`; changes response field `data.subscription_relation`.

## Path parameters

- `id` integer, required

## Query parameters

- `subdomain` string, required

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesInsurancePatientCoverageResponse: API_V31_Entities_Insurance_PatientCoverage_Response model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesInsurancePatientCoverage
    - `id` integer: Coverage ID
    - `subscription_relation` string: The relationship of this patient to the subscriber
    - `patient_id` integer: The ID of the covered patient
    - `priority` integer: The relative priority of this insurance coverage where the lowest value is the patient's primary insurance and higher values represent secondary and tertiary policies
    - `plan_id` integer: Plan ID
    - `subscriber_num` string: Subscriber number
    - `effective_date` string, date: Effective date
    - `expiration_date` string, date: Expiration date
    - `insurance_type` 'dental' | 'medical' | 'vision': The type of the insurance plan
    - `updated_at` string, date-time: Insurance Coverage update date in UTC
    - `active` boolean: Whether the insurance coverage is currently active
    - `subscriber` APIV31EntitiesInsuranceSubscriber
      - `id` integer: The subscriber's ID
      - `name` string: The subscriber's full name
      - `date_of_birth` string, nullable: The subscriber's date of birth in YYYY-MM-DD format
      - `postal_code` string, nullable: The subscriber's postal code
    - `benefits_remaining` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
  - `count` integer: Number of total objects, in case of collection.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)