How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Candid Health Coverages API

The Coverages API from Candid Health — 9 operation(s) for coverages.

Candid Health Coverages API is one of 53 APIs that Candid Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Coverages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 9 paths, and defines 64 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 10 base URLs: https://pre-api.joincandidhealth.com, https://pre-api-staging.joincandidhealth.com, https://sandbox-pre-api.joincandidhealth.com, https://staging-pre-api.joincandidhealth.com, http://localhost:4000, https://api.joincandidhealth.com, https://api-staging.joincandidhealth.com, https://sandbox-api.joincandidhealth.com, https://staging-api.joincandidhealth.com, http://localhost:5050.

10 operations 9 paths 64 schemas 6 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.joincandidhealth.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Candid Health Coverages API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 6 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Coverages 10
POST
/coverages/v1/
Create
create 1 param body → 200
GET
/coverages/v1/
Get Multi
get_multi 2 params → 200
PUT
/coverages/v1//{id}/{version}
Update
update 3 params body → 200404409
GET
/coverages/v1//get-multi-paginated
Get Multi Paginated
get_multi_paginated 5 params → 200400
GET
/coverages/v1//{id}
Get
get 2 params → 200
GET
/coverages/v1//{id}/history
Get History
get_history 7 params → 200400404
GET
/coverages/v1//updates/scan
Scan
scan 2 params → 200
POST
/coverages/v1//batch-update-ppg/{ppg_id}
Batch Update Ppg
batch_update_ppg 2 params body → 200
POST
/coverages/v1//{id}/eligibility
Check Eligibility
check_eligibility 2 params body → 200
GET
/coverages/v1//{id}/eligibility/{check_id}
Get Eligibility
get_eligibility 3 params → 200

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are type_pre-encounter_coverages_v1_Coverage (18 properties), type_pre-encounter_coverages_v1_InsurancePlan (13 properties), type_pre-encounter_coverages_v1_MutableCoverage (12 properties), type_pre-encounter_coverages_v1_PlanMetadata (11 properties). Each schema is shown below with its type and property counts.

type_pre-encounter_common_Period
object
2 properties
type_pre-encounter_common_PayerId
string
The unique identifier for a Payer in the database
type_pre-encounter_coverages_v1_CoveragesPage
object
4 properties 2 required
type_pre-encounter_coverages_v1_Coverage
object
A coverage object with immutable server-owned properties.
18 properties 12 required
type_pre-encounter_coverages_v1_CoverageStatus
string
enum to represent the statuses defined at https://build.fhir.org/valueset-fm-status.html
type_pre-encounter_coverages_v1_LatestEligibilityCheck
object
A type to represent the latest eligibility check status of a coverage.
4 properties 3 required
type_pre-encounter_coverages_v1_CoverageEligibilityCheckResponse
object
2 properties 1 required
type_pre-encounter_common_Relationship
string
type_pre-encounter_coverages_v1_CoverageValueUnit
string
type_pre-encounter_common_SortDirection
string
type_pre-encounter_coverages_v1_RelatedEntityContact
object
2 properties
type_pre-encounter_eligibilityChecks_v1_ParsedResponse
object
3 properties 1 required
type_pre-encounter_coverages_v1_CoverageBenefits
object
6 properties
type_pre-encounter_common_HumanName
object
5 properties 3 required
type_pre-encounter_eligibilityChecks_v1_RequestCorrection
object
3 properties 3 required
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails
object
This object is our fern representation of Stedi's EligbilityCheckError object from their API.
6 properties
type_pre-encounter_eligibilityChecks_v1_IndividualProvider
object
3 properties 1 required
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckStatus
string
enum to represent the status of an eligibility checks
type_pre-encounter_coverages_v1_CoverageValue
object
4 properties
type_pre-encounter_common_AddressUse
string
type_pre-encounter_eligibilityChecks_v1_Encounter
object
2 properties
type_pre-encounter_coverages_v1_PlanCoverage
object
4 properties
type_pre-encounter_coverages_v1_ExpandedMemberInfo
object
8 properties
type_pre-encounter_common_NameUse
string
type_pre-encounter_coverages_v1_InsurancePlan
object
13 properties 3 required
type_pre-encounter_eligibilityChecks_v1_Provider
type_pre-encounter_coverages_v1_PlanCoverageDetails
object
9 properties
type_pre-encounter_common_UserId
string
The unique identifier for a User in the database
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckMetadata
object
5 properties 5 required
type_pre-encounter_coverages_v1_CoverageCarveOut
object
8 properties 4 required
type_pre-encounter_common_PageToken
string
A token that can be used to retrieve the next or previous page of results
type_pre-encounter_coverages_v1_NetworkType
string
type_pre-encounter_coverages_v1_PayerPlanGroupFields
object
4 properties 4 required
type_pre-encounter_coverages_v1_NonCoveredDetail
object
6 properties 4 required
type_pre-encounter_coverages_v1_InsuranceTypeCode
string
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
type_pre-encounter_coverages_v1_ServiceCoverage
object
5 properties 1 required
type_pre-encounter_coverages_v1_BenefitsRelatedEntity
object
5 properties
type_pre-encounter_coverages_v1_MemberInfo
object
4 properties 2 required
type_pre-encounter_eligibilityChecks_v1_EligibilityCheck
object
6 properties 1 required
type_pre-encounter_coverages_v1_Address
object
7 properties
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckError
object
2 properties 2 required
type_pre-encounter_coverages_v1_MutableCoverage
object
12 properties 6 required
type_pre-encounter_coverages_v1_PlanMetadata
object
11 properties
type_pre-encounter_coverages_v1_BenefitType
string
type_pre-encounter_eligibilityChecks_v1_OrganizationProvider
object
2 properties 1 required
type_pre-encounter_coverages_v1_ServiceTypeCode
string
Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)
type_pre-encounter_common_AdditionalPayerInformation
object
4 properties
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorSource
string
enum to represent the source of an error in an eligibility check
type_pre-encounter_common_VersionConflictErrorBody
object
3 properties 1 required
type_pre-encounter_common_PayerPlanGroupId
string
The unique identifier for a PayerPlanGroup in the database
type_pre-encounter_common_CoverageId
string
The unique identifier for a Coverage in the database
type_pre-encounter_coverages_v1_PlanDate
object
3 properties 2 required
type_pre-encounter_common_Address
object
8 properties 6 required
type_pre-encounter_common_ErrorBase4xx
object
2 properties 1 required
type_pre-encounter_coverages_v1_CoverageDetails
object
5 properties 4 required
type_pre-encounter_eligibilityChecks_v1_EligibilityStatus
string
enum to represent the status of a patient's coverage
type_pre-encounter_coverages_v1_Subscriber
object
5 properties 2 required
type_pre-encounter_common_Sex
string
type_pre-encounter_common_PatientId
string
The unique identifier for a Patient
type_pre-encounter_coverages_v1_CarveOutType
string
type_pre-encounter_common_OrganizationId
string
The unique identifier for an Organization in the database
type_pre-encounter_eligibilityChecks_v1_EligibilityRequest
object
An object representing the data for an eligibility request.
10 properties 3 required
type_pre-encounter_coverages_v1_ServiceCoverageDetails
object
5 properties
type_pre-encounter_coverages_v1_CoverageLevel
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-coverages-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API
Candid Health Charge Capture API
Candid Health Exports API
Candid Health Patients API
Candid Health Credentialing API
Candid Health Auth API
Candid Health Default API
Candid Health Diagnoses API
Candid Health Appointments API
Candid Health Billing Notes API
Candid Health Charge Capture Claim Creation API
Candid Health Charge Captures API
Where this information came from

This is an independent, third-party profile of Candid Health Coverages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.