Candid Health V2 API

The v2 API from Candid Health — 25 operation(s) for v2.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 43 operations across 25 paths, and defines 120 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.

43 operations 25 paths 120 schemas 10 DELETE10 GET11 PATCH12 POST

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

Authentication & Security 1

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

OAuthScheme — OAuth 2.0 authentication

Paths & Operations 43

Across 25 paths, the API surfaces 43 operations — 10 DELETE, 10 GET, 11 PATCH, 12 POST. Each is listed below with its method, path, parameters, and response codes.

v2 43

POST

/api/billing_notes/v2

Create billing note

create 1 param body → 200

DELETE

/api/billing_notes/v2/{billing_note_id}

Delete billing note

delete 2 params → 200400403404

PATCH

/api/billing_notes/v2/{billing_note_id}

Update

update 2 params body → 200400403404422

GET

/api/contracts/v2/{contract_id}

Get contract

get 3 params → 200404

DELETE

/api/contracts/v2/{contract_id}

Delete contract

delete 2 params → 200422

PATCH

/api/contracts/v2/{contract_id}

Update contract

update 2 params body → 200422

GET

/api/contracts/v2

Get all contracts

get_multi 10 params → 200

POST

/api/contracts/v2

Create contract

create 1 param body → 200

POST

/api/provider-credentialing-span/v2/facility

Create facility credentialing span

createFacility 1 param body → 200403422

GET

/api/provider-credentialing-span/v2/facility

Get all facility credentialing spans

getAllFacilities 6 params → 200403422

GET

/api/provider-credentialing-span/v2/facility/{facility_credentialing_id}

Get facility credentialing span

getFacility 2 params → 200403404

DELETE

/api/provider-credentialing-span/v2/facility/{facility_credentialing_id}

Delete facility credentialing span

deleteFacility 2 params → 200403404

PATCH

/api/provider-credentialing-span/v2/facility/{facility_credentialing_id}

Update facility credentialing span

updateFacility 2 params body → 200403404422

POST

/api/provider-credentialing-span/v2

Create provider credentialing span

create 1 param body → 200403422

GET

/api/provider-credentialing-span/v2

Get all provider credentialing spans

getAll 7 params → 200403422

GET

/api/provider-credentialing-span/v2/{provider_credentialing_id}

Get provider credentialing span

get 2 params → 200403404

DELETE

/api/provider-credentialing-span/v2/{provider_credentialing_id}

Delete provider credentialing span

delete 2 params → 200403404

PATCH

/api/provider-credentialing-span/v2/{provider_credentialing_id}

Update provider credentialing span

update 2 params body → 200403404422

GET

/api/eligibility/v2/availity

Submit encounter eligibility check (Availity)

submit_eligibility_check_availity 1 param → 200422

POST

/api/eligibility/v2/availity

Submit encounter eligibility check (Availity Post)

submit_eligibility_check_availity_post 1 param body → 200422

PATCH

/api/encounter-providers/v2/{encounter_id}

Update Referring Provider

update_referring_provider 2 params body → 200404422

PATCH

/api/encounter-providers/v2/{encounter_id}/initial-referring-provider

Update Initial Referring Provider

update_initial_referring_provider 2 params body → 200404422

DELETE

/api/encounter-providers/v2/{encounter_id}/initial-referring-provider

Delete Initial Referring Provider

delete_initial_referring_provider 2 params → 200404

PATCH

/api/encounter-providers/v2/{encounter_id}/supervising-provider

Update Supervising Provider

update_supervising_provider 2 params body → 200404422

DELETE

/api/encounter-providers/v2/{encounter_id}/supervising-provider

Delete Supervising Provider

delete_supervising_provider 2 params → 200404

PATCH

/api/encounter-providers/v2/{service_line_id}/ordering-provider

Update Ordering Provider

update_ordering_provider 2 params body → 200404422

DELETE

/api/encounter-providers/v2/{service_line_id}/ordering-provider

Delete Ordering Provider

delete_ordering_provider 2 params → 200404

POST

/api/encounter-providers/v2/{encounter_id}/create-referring-provider

Create Referring Provider

create_referring_provider 2 params body → 200404409422

POST

/api/encounter-providers/v2/{encounter_id}/create-initial-referring-provider

Create Initial Referring Provider

create_initial_referring_provider 2 params body → 200404409422

POST

/api/encounter-providers/v2/{encounter_id}/create-supervising-provider

Create Supervising Provider

create_supervising_provider 2 params body → 200404409422

POST

/api/encounter-providers/v2/{service_line_id}/create-ordering-provider

Create Ordering Provider

create_ordering_provider 2 params body → 200404409422

DELETE

/api/encounter-providers/v2/{encounter_id}/referring-provider

Delete Referring Provider

delete_referring_provider 2 params → 200404409

GET

/api/organization-service-facilities/v2/{organization_service_facility_id}

Get organization service facility

get 2 params → 200404

PATCH

/api/organization-service-facilities/v2/{organization_service_facility_id}

Update organization service facility

update 2 params body → 200404409422

DELETE

/api/organization-service-facilities/v2/{organization_service_facility_id}

Delete organization service facility

delete 2 params → 200404

GET

/api/organization-service-facilities/v2

Get all organization service facilities

get_multi 8 params → 200

POST

/api/organization-service-facilities/v2

Create organization service facility

create 1 param body → 200409422

GET

/api/organization-service-facilities/v2/external-id/{external_id}

Get organization service facility by externalid

get_by_external_id 2 params → 200404

POST

/api/service-lines/v2

Create Service Line

create 1 param body → 200409422

POST

/api/service-lines/v2/universal

Create Professional or Institutional Service Line

create-universal 1 param body → 200409422

PATCH

/api/service-lines/v2/{service_line_id}/universal

Update service line for encounter that may be institutional or professional.

update-universal 2 params body → 200403404422

PATCH

/api/service-lines/v2/{service_line_id}

Update Service Line

update 2 params body → 200403404422

DELETE

/api/service-lines/v2/{service_line_id}

Delete Service Line

delete 2 params → 200403404409

Schemas 120

The contract defines 120 schemas that model the data the API accepts and returns. The most detailed are type_service-lines_v2_ServiceLine (43 properties), type_service-lines_v2_UniversalServiceLineCreateStandalone (24 properties), type_service-lines_v2_UniversalServiceLineUpdate (23 properties), type_service-lines_v2_ServiceLineCreateStandalone (23 properties). Each schema is shown below with its type and property counts.

type_encounter-providers_v2_ReferringProviderSecondaryIdentificationQualifier

string

type_commons_EncounterId

string

type_contracts_v2_AuthorizedSignatoryUpdate

type_commons_UnprocessableEntityErrorMessage

object

1 property

type_contracts_v2_ContractId

string

type_service-lines_v2_ServiceLine

object

43 properties 8 required

type_service-lines_v2_ServiceLineUpdate

object

22 properties

type_organization-service-facilities_v2_OrganizationServiceFacilityId

string

type_encounter-providers_v2_ReferringProvider

object

7 properties 1 required

type_credentialing_v2_FacilityCredentialingSpanId

string

type_credentialing_v2_ProviderCredentialingSpan

object

13 properties 8 required

type_contracts_v2_ContractStatus

string

type_contracts_v2_InsuranceTypes

type_organization-service-facilities_v2_ServiceFacilityPhysicalType

string

type_contracts_v2_ContractIsLinkedToFeeScheduleError

object

1 property 1 required

type_commons_ProviderCredentialingSpanId

string

type_identifiers_IdentifierId

string

type_commons_Decimal

string

String representation of a Decimal that can be parsed by most libraries.

type_commons_Date

string

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

type_service-lines_v2_ServiceIdQualifier

string

type_encounter-providers_v2_ProviderSecondaryIdentification

object

2 properties 1 required

type_encounter-providers_v2_EncounterProvider

object

11 properties 3 required

type_commons_InvoiceId

string

type_commons_UnauthorizedErrorMessage

object

1 property

type_encounter-providers_v2_ProviderId

string

type_organization-service-facilities_v2_OrganizationServiceFacility

object

16 properties 5 required

type_invoices_v2_ClaimInvoiceItemInfo

object

2 properties 1 required

type_commons_SortDirection

string

type_contracts_v2_ContractingProviderId

string

type_billing-notes_v2_BillingNoteMetadata

type_contracts_v2_ContractsPage

object

3 properties 1 required

type_service-lines_v2_DenialReasonContent

string

type_service-lines_v2_ServiceLineERAData

object

2 properties 2 required

type_contracts_v2_RenderingProviderid

string

type_organization-service-facilities_v2_ServiceFacilityStatus

string

type_billing-notes_v2_BillingNote

object

8 properties 4 required

type_commons_ProcedureModifier

string

type_encounter-providers_v2_ReferringProviderUpdate

object

7 properties

type_commons_FacilityTypeCode

string

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.…

type_identifiers_IdentifierCode

string

type_organization-service-facilities_v2_OrganizationServiceFacilityPage

object

3 properties 1 required

type_commons_Regions

type_service-lines_v2_TestResult

object

2 properties 2 required

type_billing-notes_v2_BillingNoteId

string

type_commons_DateRangeOptionalEnd

object

2 properties 1 required

type_organization-providers_v2_EmploymentStatus

string

type_organization-service-facilities_v2_ServiceFacilityOperationalStatus

string

type_contracts_v2_ContractInvalidExpirationDateError

object

1 property 1 required

type_invoices_v2_InvoiceStatus

string

type_invoices_v2_UnattributedInvoiceItem

object

1 property 1 required

type_commons_OrganizationNotAuthorizedErrorMessage

object

1 property 1 required

type_identifiers_IdentifierValue

type_credentialing_v2_ProviderCredentialingSpanId

string

type_organization-service-facilities_v2_ServiceFacilityType

string

type_contracts_v2_AuthorizedSignatory

object

6 properties

type_invoices_v2_InvoiceDestination

string

type_organization-service-facilities_v2_OrganizationServiceFacilityCreate

object

15 properties 4 required

type_commons_ServiceLineId

string

type_encounter-providers_v2_InitialReferringProviderUpdate

object

8 properties

type_encounter-providers_v2_ProviderSecondaryIdentificationQualifier

string

type_organization-providers_v2_OrganizationProviderAddress

object

2 properties 2 required

type_invoices_v2_Invoice

object

12 properties 9 required

type_encounter-providers_v2_OrderingProvider

object

6 properties 1 required

type_organization-providers_v2_ProviderType

string

type_organization-providers_v2_AddressType

string

type_credentialing_v2_CredentialingSpanStatus

string

Stage of a credentialing span in the credentialing workflow.

type_credentialing_v2_FacilityCredentialingSpanPage

object

3 properties 1 required

type_service-lines_v2_TestResultType

string

type_commons_RequestValidationError

object

2 properties 1 required

type_organization-providers_v2_OrganizationProvider

object

17 properties 7 required

type_encounter-providers_v2_SupervisingProvider

object

7 properties 1 required

type_encounter-providers_v2_SupervisingProviderUpdate

object

7 properties

type_contracts_v2_RegionsUpdate

type_contracts_v2_ContractWithProviders

object

13 properties 10 required

type_organization-service-facilities_v2_OrganizationServiceFacilityUpdate

object

15 properties

type_credentialing_v2_FacilityCredentialingSpan

object

10 properties 6 required

type_encounter-providers_v2_ReferringProviderSecondaryIdentification

object

2 properties 2 required

type_commons_PageToken

string

type_billing-notes_v2_BillingNoteType

string

type_commons_QualifierCode

string

type_commons_OrganizationId

string

type_service-lines_v2_UniversalServiceLineUpdate

object

23 properties

type_invoices_v2_InvoiceInfo

object

3 properties 3 required

type_encounter-providers_v2_InitialReferringProvider

object

8 properties 1 required

type_invoices_InvoiceItem

object

2 properties 2 required

type_commons_StreetAddressLongZip

object

6 properties 5 required

type_service-lines_v2_UniversalServiceLineCreateStandalone

object

24 properties 3 required

type_contracts_v2_ContractSortField

string

type_encounter-providers_v2_SupervisingProviderSecondaryIdentification

object

2 properties 2 required

type_invoices_Invoice

object

13 properties 10 required

type_identifiers_Identifier

object

4 properties 3 required

type_invoices_v2_ClaimInvoiceItem

object

2 properties 2 required

type_commons_EntityConflictErrorMessage

object

1 property 1 required

type_invoices_v2_InvoiceItemInfo

object

2 properties 2 required

type_payers_v3_Payer

object

8 properties 3 required

type_commons_EntityNotFoundErrorMessage

object

1 property 1 required

type_contracts_v2_DateUpdate

type_commons_InsuranceTypeCode

string

Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)

type_organization-providers_v2_OrganizationProviderId

string

type_commons_State

string

type_service-lines_v2_ServiceLineCreateStandalone

object

23 properties 4 required

type_organization-service-facilities_v2_ServiceFacilityMode

string

type_diagnoses_DiagnosisId

string

type_payers_v3_PayerUuid

string

type_invoices_InvoiceStatus

string

type_invoices_v2_InvoiceDestinationMetadata

object

4 properties 3 required

type_credentialing_v2_ProviderCredentialingSpanPage

object

3 properties 1 required

type_invoices_v2_ServiceLineInvoiceItem

object

2 properties 2 required

type_commons_ServiceLineUnits

string

type_service-lines_v2_ServiceLineAdjustment

object

5 properties 1 required

type_encounter-providers_v2_OrderingProviderUpdate

object

6 properties

type_commons_PatientExternalId

string

type_service-lines_v2_MeasurementUnitCode

string

type_service-lines_v2_ServiceLineDenialReason

object

The reason a given service line was denied within a given time range. A service line may be denied for different reasons over time, but only one reason at a ti…

1 property

type_contracts_v2_Contract

object

12 properties 9 required

type_organization-providers_v2_LicenseType

string

type_commons_ClaimId

string

type_organization-providers_v3_OrganizationProviderV2

object

15 properties 7 required

type_service-lines_v2_DrugIdentification

object

8 properties 4 required

type_commons_BillingProviderCommercialLicenseType

string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API

AE Profile APIs.io

Candid Health Charge Capture API

AE Profile APIs.io

Candid Health Exports API

AE Profile APIs.io

Candid Health Patients API

AE Profile APIs.io

Candid Health Credentialing API

AE Profile APIs.io

Candid Health Auth API

AE Profile APIs.io

Candid Health Default API

AE Profile APIs.io

Candid Health Diagnoses API

AE Profile APIs.io

Candid Health V1 API

AE Profile APIs.io

Candid Health V3 API

AE Profile APIs.io

Candid Health V4 API

AE Profile APIs.io

#v2

← Back to C APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=candid-health-v2-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/candid-health-v2-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of Candid Health V2 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.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Candid Health V2 API

Metadata

Authentication & Security 1

Paths & Operations 43

Schemas 120

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Candid Health V2 API

Metadata

Authentication & Security 1

Paths & Operations 43

Schemas 120

Specification

Source

More from Candid Health 11

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key