Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Candid Health Charge Capture API

Capture charges and service lines ahead of claim assembly.

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

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

This API exposes 3 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.joincandidhealth.com/api.

3 operations 2 paths 10 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.joincandidhealth.com/api
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Candid Health Charge Capture API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth bearer token obtained from POST /auth/v2/token. Send as Authorization: Bearer .

Paths & Operations 3

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

Charge Capture 3

Capture charges and service lines ahead of claim assembly.

POST
/charge_captures/v1
Create a charge capture.
createChargeCapture body → 200
GET
/charge_captures/v1
Get all charge captures.
getAllChargeCaptures 2 params → 200
GET
/charge_captures/v1/{charge_capture_id}
Get a charge capture.
getChargeCapture 1 param → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are EncounterCreate (13 properties), ServiceLine (6 properties), Patient (6 properties), Address (5 properties). Each schema is shown below with its type and property counts.

ChargeCapturePage
object
2 properties
ChargeCapture
object
4 properties
Address
object
5 properties
RenderingProvider
object
3 properties
BillingProvider
object
4 properties
Patient
object
6 properties
EncounterCreate
object
13 properties 10 required
Diagnosis
object
2 properties
ServiceLine
object
6 properties
ChargeCaptureCreate
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candidhealth-charge-capture-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Auth API
Candid Health Eligibility API
Candid Health Encounters API
Candid Health Events API
Candid Health Fee Schedules API
Candid Health Insurance Adjudications API
Candid Health Payers API