Skip to main content
GET
Get a coverage

Authorizations

Authorization
string
header
required

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

Path Parameters

clinic_id
string<uuid>
required
coverage_id
string<uuid>
required

Response

OK.

data
object
required

A patient's insurance coverage — the exposed-field allow-list, field by field. A coverage that came in through the API is saved straight away and visible here, but it is unconfirmed and coverage_active is false until clinic staff confirm the payer match; the clinic's own coverages are confirmed. Eligibility figures, the clinic's notes and the policy holder's address are never exposed.