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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Candid Health

Candid Health Charge Captures API

The Charge Captures API from Candid Health — 5 operation(s) for charge captures.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health Charge Captures 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 Charge Captures. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 5 paths, and defines 118 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.

7 operations 5 paths 118 schemas 2 GET2 PATCH3 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
1

Authentication & Security 1

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

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 7

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

Charge Captures 7
POST
/api/charge_captures/v1
Create a Charge Capture
create 1 param body → 200403404409422
GET
/api/charge_captures/v1
Get all Charge Captures
getAll 46 params → 200
POST
/api/charge_captures/v1/create-from-pre-encounter
Create a Charge Capture from pre-encounter patient and appointment
create-from-pre-encounter-patient 1 param body → 200403404409422
PATCH
/api/charge_captures/v1/changes
Update a ChargeCapturePostBilledChange
updatePostBilledChanges 1 param body → 200403404
PATCH
/api/charge_captures/v1/{charge_capture_id}
Update Charge Capture
update 2 params body → 200403404422
GET
/api/charge_captures/v1/{charge_capture_id}
Get Charge Capture
get 2 params → 200
POST
/api/charge_captures/v1/find-by-metadata
Find Charge Captures by Metadata
findByMetadata 1 param body → 200

Schemas 118

The contract defines 118 schemas that model the data the API accepts and returns. The most detailed are type_charge-capture_v1_ChargeCaptureData (52 properties), type_service-lines_v2_ServiceLineCreateOptional (19 properties), type_insurance-cards_v2_InsuranceCardCreateOptional (15 properties), type_charge-capture_v1_ChargeCapture (13 properties). Each schema is shown below with its type and property counts.

type_encounter-providers_v2_ProviderSecondaryIdentificationOptional
object
2 properties
type_organization-providers_v2_LicenseType
string
type_commons_PreEncounterAppointmentId
string
type_service-facility_EncounterServiceFacilityUpdateWithOptionalAddress
object
5 properties
type_encounters_v4_IntakeFollowUpOptional
object
3 properties
type_commons_UnprocessableEntityErrorMessage
object
1 property
type_diagnoses_DiagnosisCreateOptional
object
4 properties
type_commons_SchemaId
string
type_encounters_v4_PatientHistoryCategoryEnum
string
type_encounters_v4_SynchronicityType
string
type_encounters_v4_InterventionCategory
string
type_encounter-providers_v2_OrderingProviderOptional
object
6 properties
type_related-causes_v1_RelatedCausesCode
string
type_encounters_v4_EPSDTReferralOptional
object
3 properties
type_service-lines_v2_ServiceLineCreateOptional
object
19 properties
type_individual_PatientNonInsurancePayerInfoCreateOptional
object
3 properties
type_commons_IntendedSubmissionMedium
string
The medium (paper or electronic) via which we intended to submit the claim. The clearinghouse to which we sent the claim may use a different medium in certain…
type_encounter-providers_v2_ReferringProviderUpdateWithOptionalAddress
object
7 properties
type_commons_ReportTransmissionCode
string
type_commons_ChargeCapturePostBilledChangeId
string
type_encounters_v4_RxCui
string
type_non-insurance-payers_v1_NonInsurancePayerId
string
type_commons_ClaimSubmissionPayerResponsibilityType
string
type_encounters_v4_PriorAuthorizationNumber
string
type_custom-schemas_v1_SchemaInstanceOptional
object
2 properties
type_encounter-providers_v2_BillingProviderSecondaryIdentificationOptional
object
2 properties
type_commons_StreetAddressShortZipOptional
object
6 properties
type_commons_Email
string
type_encounter-providers_v2_InitialReferringProviderUpdateWithOptionalAddress
object
8 properties
type_commons_PatientExternalId
string
type_individual_PatientClinicalTrialInfoCreateOptional
object
2 properties
type_encounters_v4_IntakeResponseAndFollowUpsOptional
object
2 properties
type_encounters_v4_IntakeQuestionOptional
object
3 properties
type_commons_PreEncounterPatientId
string
type_charge-capture_v1_Hl7MessageType
string
HL7 message type that produced a charge-capture write. Values match the bare MSH-9-1 code emitted by HL7 producers (conduit). Constrains the hl7messagetype fie…
type_individual_Gender
string
type_commons_EncounterExternalId
string
type_commons_ClinicalTrialId
string
type_encounters_v4_MedicationOptional
object
6 properties
type_encounter-providers_v2_ProviderSecondaryIdentificationQualifier
string
type_yes-no-indicator_YesNoIndicator
string
type_claim-submission_v1_ExternalClaimSubmissionCreateOptional
object
3 properties
type_service-lines_v2_TestResultOptional
object
2 properties
type_commons_Decimal
string
String representation of a Decimal that can be parsed by most libraries.
type_charge-capture_v1_ChargeCapture
object
13 properties 6 required
type_x12_v1_TypeOfBillFrequencyCode
string
type_commons_SortDirection
string
type_encounters_v4_ClaimSupplementalInformationOptional
object
3 properties
type_charge-capture_v1_ChargeCapturePage
object
4 properties 2 required
type_claim-submission_v1_ClaimSubmissionRecordCreateOptional
object
Data about each external submission.
4 properties
type_encounter-providers_v2_BillingProviderUpdateWithOptionalAddress
object
The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rende…
9 properties
type_encounters_v4_ClinicalNoteOptional
object
4 properties
type_commons_PhoneNumberType
string
type_commons_PageToken
string
type_claims_ClaimStatus
string
type_encounter-providers_v2_SupervisingProviderSecondaryIdentificationOptional
object
2 properties
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierQualifier
string
type_billing-notes_v2_BillingNoteBaseOptional
object
1 property
type_charge-capture_v1_ChargeCaptureStatus
string
type_encounters_v4_IntakeFollowUpId
string
type_charge-capture_v1_ChargeCapturePostBilledChange
object
ChargeCapturePostBilledChange represents a change to a ChargeCapture that occurred after the ChargeCapture's status moved to BILLED. Action must be taken to re…
3 properties 3 required
type_commons_EPSDTReferralConditionIndicatorCode
string
type_commons_PatientRelationshipToInsuredCodeAll
string
type_commons_QualifierCode
string
type_commons_SourceOfPaymentCode
string
type_guarantor_v1_GuarantorOptional
object
10 properties
type_charge-capture_v1_ChargeExternalIdConflictErrorMessage
object
1 property
type_encounter-providers_v2_ReferringProviderSecondaryIdentificationOptional
object
2 properties
type_encounters_v4_VitalsUpdate
object
7 properties
type_related-causes_v1_RelatedCausesInformationCreateOptional
object
3 properties
type_encounters_v4_LabOptional
object
3 properties
type_commons_ChargeCaptureClaimCreationId
string
type_encounters_v4_BillableStatusType
string
type_individual_PatientUpdateWithOptionalAddress
object
13 properties
type_commons_State
string
type_commons_ChargeCaptureId
string
type_individual_SubscriberCreateOptional
object
7 properties
type_encounter-providers_v2_ReferringProviderSecondaryIdentificationQualifier
string
type_encounters_v4_PatientHistoryCategoryOptional
object
2 properties
type_encounters_v4_ServiceAuthorizationExceptionCode
string
Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the reasons listed in one of the enum values, t…
type_organization-service-facilities_v2_OrganizationServiceFacilityId
string
type_encounters_v4_NoteCategory
string
type_encounter-providers_v2_BillingProviderSecondaryIdentificationQualifier
string
type_service-lines_v2_ServiceIdQualifier
string
type_encounter-providers_v2_RenderingProviderUpdateWithOptionalAddress
object
7 properties
type_diagnoses_DiagnosisTypeCode
string
type_encounters_v4_ClinicalNoteCategoryCreateOptional
object
2 properties
type_commons_Npi
string
type_encounters_v4_ResponsiblePartyType
string
type_encounters_v4_LabCodeType
string
type_encounters_v4_IntakeQuestionId
string
type_tags_TagId
string
type_encounter-providers_v2_TreatingProviderUpdateWithOptionalAddress
object
Update type for the treating provider with optional address fields. Used in contexts where address fields may be partially provided.
6 properties
type_commons_EntityNotFoundErrorMessage
object
1 property 1 required
type_custom-schemas_v1_SchemaInstance
object
2 properties 2 required
type_charge-capture_v1_ChargeCaptureData
object
52 properties
type_commons_ServiceLineUnits
string
type_commons_EncounterId
string
type_encounters_v4_InterventionOptional
object
5 properties
type_commons_ProcedureModifier
string
type_commons_PhoneNumberOptional
object
2 properties
type_commons_EmrPayerCrosswalk
string
type_commons_BillingProviderCommercialLicenseType
string
type_commons_PayerPlanGroupId
string
type_service-lines_v2_DrugIdentificationOptional
object
8 properties
type_commons_ReportTypeCode
string
type_commons_StreetAddressLongZipOptional
object
6 properties
type_insurance-cards_v2_InsuranceCardCreateOptional
object
15 properties
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierCreateOptional
object
2 properties
type_commons_DelayReasonCode
string
Code indicating the reason why a request was delayed
type_charge-capture_v1_ChargeCaptureSortField
string
type_commons_UnauthorizedErrorMessage
object
1 property
type_commons_InsuranceTypeCode
string
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
type_service-lines_v2_MeasurementUnitCode
string
type_charge-capture_v1_ChargeCaptureError
object
8 properties 3 required
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_service-lines_v2_TestResultType
string
type_encounter-providers_v2_SupervisingProviderUpdateWithOptionalAddress
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-charge-captures-api-openapi.yml Raw ↑

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 Appointments API
AE Profile APIs.io
Candid Health Billing Notes API
AE Profile APIs.io
Candid Health Charge Capture Claim Creation API
AE Profile APIs.io
Candid Health Contracts API
AE Profile APIs.io
#Charge Captures
← Back to C APIs
API Details
ID
candid-health:candid-health-charge-captures-api
Base URL
https://api.joincandidhealth.com
Docs
https://docs.joincandidhealth.com/api-reference/patient-collections
Provider
Candid Health
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=candid-health-charge-captures-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/candid-health-charge-captures-api"

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

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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