Candid Health V4 API
The v4 API from Candid Health — 10 operation(s) for v4.
Candid Health V4 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 V4. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 15 operations across 10 paths, and defines 293 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.
15 operations
10 paths
293 schemas
1 DELETE6 GET3 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Candid Health V4 API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuthScheme).
OAuthScheme— OAuth 2.0 authentication
Paths & Operations 15
Across 10 paths, the API surfaces 15 operations — 1 DELETE, 6 GET, 3 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
v4 15
GET
/api/patient-payments/v4
Get patient payments
POST
/api/patient-payments/v4
Create patient payment
GET
/api/patient-payments/v4/{patient_payment_id}
Get patient payment
PATCH
/api/patient-payments/v4/{patient_payment_id}
Update
DELETE
/api/patient-payments/v4/{patient_payment_id}
Delete patient payment
GET
/api/encounters/v4
Get all encounters
POST
/api/encounters/v4
Create professional encounter
GET
/api/encounters/v4/{encounter_id}
Get encounter
PATCH
/api/encounters/v4/{encounter_id}
Update professional encounter
POST
/api/encounters/v4/universal
Create institutional or professional encounter
POST
/api/encounters/v4/create-from-pre-encounter/universal
Create institutional or professional encounter from pre-encounter patient and appointment
POST
/api/encounters/v4/create-from-pre-encounter
Create professional encounter from pre-encounter patient and appointment
PATCH
/api/encounters/v4/{encounter_id}/universal
Update institutional or professional encounter
GET
/api/payers/v4/{payer_uuid}
Get payer
GET
/api/payers/v4
Get all payers
Schemas 293
The contract defines 293 schemas that model the data the API accepts and returns. The most detailed are type_encounters_v4_Encounter (76 properties), type_encounters-universal_UniversalEncounterCreate (63 properties), type_encounters-universal_UniversalEncounterUpdate (57 properties), type_encounters_v4_EncounterCreate (52 properties). Each schema is shown below with its type and property counts.
type_encounter-providers_v2_ReferringProviderSecondaryIdentificationQualifier
string
type_commons_EncounterId
string
type_commons_UnprocessableEntityErrorMessage
object
1 property
type_encounters_v4_EPSDTReferral
object
3 properties
1 required
type_guarantor_v1_GuarantorCreate
object
10 properties
4 required
type_commons_EPSDTReferralConditionIndicatorCode
string
type_health-care-code-information_v1_TreatmentCodeInformationNew
object
This corresponds to the TC code qualifier value.
2 properties
2 required
type_encounter-providers_v2_EncounterAdditionalProvider
object
A lighter-weight provider type with optional NPI. Used for treating providers and other additional provider roles that may not have full NPI credentials.
8 properties
3 required
type_service-lines_v2_ServiceLine
object
43 properties
8 required
type_financials_AllocationTarget
Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.
type_organization-service-facilities_v2_OrganizationServiceFacilityId
string
type_diagnoses_DiagnosisTypeCode
string
type_health-care-code-information_v1_ValueInformationNew
object
This corresponds to the BE code qualifier value.
3 properties
3 required
type_x12_v1_TypeOfBillCompositeUpdate
A type of bill can either be seen as a composition of structured parts, or as a literal string. This union represents the potential to express a type of bill e…
type_financials_InvoiceUpdate
type_encounter-providers_v2_ReferringProvider
object
7 properties
1 required
type_non-insurance-payers_v1_NonInsurancePayer
object
7 properties
4 required
type_health-care-code-information_v1_RD8Date
object
2 properties
2 required
type_guarantor_v1_GuarantorId
string
type_health-care-code-information_v1_OtherDiagnosisInformationCodeQualifier
string
type_commons_StreetAddressShortZip
object
6 properties
4 required
type_service-lines_v2_ServiceLineCreate
object
18 properties
4 required
type_commons_Email
string
type_x12_v1_PatientDischargeStatusCode
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_encounter-providers_v2_BillingProviderUpdate
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_x12_v1_TypeOfBillComposite
object
4 properties
4 required
type_service-lines_v2_ServiceIdQualifier
string
type_encounter-providers_v2_ProviderSecondaryIdentification
object
2 properties
1 required
type_claim-submission_v1_ExternalClaimSubmissionCreate
object
3 properties
3 required
type_health-care-code-information_v1_SetOrClearPrincipalDiagnosis
object
1 property
type_encounter-providers_v2_EncounterProvider
object
11 properties
3 required
type_commons_InvoiceId
string
type_health-care-code-information_v1_PrincipalDiagnosis
object
This corresponds to BK or ABK code qualifier values.
5 properties
2 required
type_financials_BalanceEarmark
object
Represents an active balance earmarking record that holds allocated funds for future auto-allocation. Earmarks are created when funds are allocated but should…
4 properties
2 required
type_encounters_v4_IntakeResponseAndFollowUps
object
2 properties
type_encounter-providers_v2_ProviderId
string
type_encounters_v4_Vitals
object
7 properties
type_encounters_v4_EncounterSubmissionOriginType
string
type_commons_UnauthorizedErrorMessage
object
1 property
type_tags_Tag
object
4 properties
4 required
type_individual_PatientCreate
object
13 properties
6 required
type_invoices_v2_ClaimInvoiceItemInfo
object
2 properties
1 required
type_health-care-code-information_v1_ConditionInformation
object
This corresponds to the BG code qualifier value.
4 properties
2 required
type_encounters_v4_LabCodeType
string
type_commons_SortDirection
string
type_health-care-code-information_v1_ConditionCode
string
FL 18-28 - Condition Codes Source: UB-04 Manual 2025, Pages 64-81 (FL18-28, Pages 1-18) Excludes codes designated as "Payer Codes" or "FOR PUBLIC HEALTH DATA R…
type_patient-payments_v3_PatientPaymentStatus
string
type_billing-notes_v2_BillingNoteMetadata
type_encounters_v4_NoteCategory
string
type_x12_v1_TypeOfFacilityCode
string
type_health-care-code-information_v1_OtherProcedureInformationNew
object
This corresponds to the BBQ or BQ code qualifier values.
3 properties
3 required
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifier
object
2 properties
2 required
type_patient-payments_v4_PaymentMethodDetailCreate
object
4 properties
1 required
type_health-care-code-information_v1_OccurrenceInformation
object
This corresponds to the BH code qualifier value.
5 properties
3 required
type_health-care-code-information_v1_TreatmentCode
string
type_service-lines_v2_DenialReasonContent
string
type_service-lines_v2_ServiceLineERAData
object
2 properties
2 required
type_health-care-code-information_v1_HealthCareCodeInformationCreate
object
13 properties
type_encounters_v4_SynchronicityType
string
type_patient-payments_v4_PatientPaymentSortField
string
type_commons_AppointmentId
string
type_encounters_v4_ClaimSupplementalInformation
object
3 properties
2 required
type_commons_Npi
string
type_health-care-code-information_v1_ValueCodeQualifier
string
type_encounters_v4_Lab
object
3 properties
1 required
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierUpdate
object
2 properties
2 required
type_encounters_v4_PriorAuthorizationNumber
string
type_service-facility_ServiceFacilityId
string
type_health-care-code-information_v1_TreatmentCodeQualifier
string
type_billing-notes_v2_BillingNote
object
8 properties
4 required
type_encounters_v4_ClinicalNoteCategory
object
3 properties
2 required
type_commons_ProcedureModifier
string
type_health-care-code-information_v1_SetOrClearDiagnosisRelatedGroup
object
1 property
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_health-care-code-information_v1_ICDCode
string
type_health-care-code-information_v1_ExternalCauseOfInjuryCodeQualifier
string
type_service-lines_v2_TestResult
object
2 properties
2 required
type_health-care-code-information_v1_PrincipalProcedureInformationNew
object
This correspond to BBR, BR, and CAH code qualifier values.
3 properties
3 required
type_billing-notes_v2_BillingNoteId
string
type_health-care-code-information_v1_PatientReasonForVisitCodeQualifier
string
type_financials_AllocationEarmarkType
If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation. Earmarks hold the allocation unti…
type_x12_v1_TypeOfBillFrequencyCode
string
type_encounters_v4_EncounterSubmissionExpectation
string
Used to describe the currently expected target form for this encounter. This affects what validations and queues the form is processed under. Before submission…
type_encounters_v4_CodingAttributionType
string
type_commons_PhoneNumber
object
2 properties
2 required
type_health-care-code-information_v1_ExternalCauseOfInjuryNew
object
This corresponds to BN or ABN code qualifier values.
3 properties
2 required
type_commons_EncounterExternalId
string
type_encounter-providers_v2_BillingProviderSecondaryIdentification
object
2 properties
1 required
type_service-facility_EncounterServiceFacility
object
6 properties
3 required
type_commons_NextResponsibleParty
string
type_health-care-code-information_v1_PrincipalDiagnosisNew
object
This corresponds to BK or ABK code qualifier values.
3 properties
2 required
type_commons_EmrPayerCrosswalk
string
type_individual_PatientClinicalTrialInfoCreate
object
2 properties
1 required
type_encounters_v4_ClinicalNote
object
4 properties
3 required
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_encounters_v4_BillableStatusType
string
type_health-care-code-information_v1_AdmittingDiagnosisNew
object
This corresponds to BJ or ABJ code qualifier values.
2 properties
2 required
type_invoices_v2_InvoiceStatus
string
type_invoices_v2_UnattributedInvoiceItem
object
1 property
1 required
type_health-care-code-information_v1_OtherDiagnosisInformation
object
This corresponds to BF and ABF code qualifier values.
5 properties
2 required
type_x12_v1_PointOfOriginForAdmissionOrVisitCode
string
type_related-causes_v1_RelatedCausesCode
string
type_patient-payments_v4_PatientPayment
object
11 properties
6 required
type_encounters_v4_IntakeFollowUpId
string
type_individual_PatientNonInsurancePayerInfoCreate
object
3 properties
1 required
type_health-care-code-information_v1_OtherProcedureInformationCodeQualifier
string
type_invoices_v2_InvoiceDestination
string
type_health-care-code-information_v1_SetOrClearPrincipalProcedureInformation
object
1 property
type_encounters_v4_EncounterCreateFromPreEncounter
object
41 properties
11 required
type_commons_PatientRelationshipToInsuredCodeAll
string
type_related-causes_v1_RelatedCausesInformation
object
3 properties
1 required
type_commons_ServiceLineId
string
type_health-care-code-information_v1_PrincipalProcedureInformationCodeQualifier
string
type_encounters_v4_PatientHistoryCategory
object
2 properties
2 required
type_commons_ReportTypeCode
string
type_encounter-providers_v2_InitialReferringProviderUpdate
object
8 properties
type_encounter-providers_v2_ProviderSecondaryIdentificationQualifier
string
type_financials_AllocationRestrictionCreate
object
Constrains which claims a payment's credit can be auto-allocated to. Restrictions of the same restrictiontype are OR'd together (any value may match); differen…
2 properties
2 required
type_encounters-universal_UniversalEncounterCreate
object
63 properties
9 required
type_health-care-code-information_v1_HealthCareCodeInformationUpdate
object
13 properties
type_invoices_v2_Invoice
object
12 properties
9 required
type_insurance-cards_v2_InsuranceCard
object
15 properties
4 required
type_individual_PatientUpdate
object
13 properties
type_encounter-providers_v2_OrderingProvider
object
6 properties
1 required
type_billing-notes_v2_BillingNoteBase
object
1 property
1 required
type_health-care-code-information_v1_PresentOnAdmissionIndicatorCode
string
type_commons_InternalErrorMessage
object
1 property
type_commons_SourceOfPaymentCode
string
type_health-care-code-information_v1_SetOrClearAdmittingDiagnosis
object
1 property
type_health-care-code-information_v1_TreatmentCodeInformation
object
This corresponds to the TC code qualifier value.
4 properties
2 required
type_health-care-code-information_v1_OccurrenceSpanCode
string
type_custom-schemas_v1_SchemaInstance
object
2 properties
2 required
type_financials_PatientPaymentCreateSource
string
Allowed payment sources when creating a patient payment via the API.
type_commons_DateRangeOptionalEnd
object
2 properties
1 required
type_patient-payments_v4_PatientPaymentsPage
object
3 properties
1 required
type_health-care-code-information_v1_DiagnosisRelatedGroupNew
object
This corresponds to DR code qualifier values.
2 properties
2 required
type_individual_PatientClinicalTrialInfo
object
2 properties
1 required
type_service-lines_v2_TestResultType
string
type_insurance-cards_v2_InsuranceCardId
string
type_health-care-code-information_v1_OccurrenceCode
string
type_commons_RequestValidationError
object
2 properties
1 required
type_health-care-code-information_v1_DiagnosisRelatedGroup
object
This corresponds to DR code qualifier values.
4 properties
2 required
type_encounters_v4_IntakeQuestionId
string
type_health-care-code-information_v1_ExternalCauseOfInjury
object
This corresponds to BN or ABN code qualifier values.
5 properties
2 required
type_financials_Allocation
object
5 properties
2 required
type_individual_Gender
string
type_commons_LinkUrl
string
type_commons_DelayReasonCode
string
Code indicating the reason why a request was delayed
type_encounters_v4_IntakeFollowUp
object
3 properties
2 required
type_encounter-providers_v2_SupervisingProvider
object
7 properties
1 required
type_health-care-code-information_v1_AdmittingDiagnosisCodeQualifier
string
type_health-care-code-information_v1_OccurrenceInformationNew
object
This corresponds to the BH code qualifier value.
3 properties
3 required
type_health-care-code-information_v1_PrincipalDiagnosisCodeQualifier
string
type_encounter-providers_v2_SupervisingProviderUpdate
object
7 properties
type_encounters_v4_Intervention
object
5 properties
2 required
type_commons_PhoneNumberType
string
type_patient-payments_v3_PatientPayment
object
12 properties
5 required
type_individual_IndividualId
string
type_health-care-code-information_v1_DiagnosisRelatedGroupCodeQualifier
string
type_encounter-providers_v2_RenderingProvider
object
7 properties
1 required
type_patient-payments_v4_PaymentMethod
type_encounter-providers_v2_RenderingProviderUpdate
object
7 properties
type_encounter-providers_v2_ReferringProviderSecondaryIdentification
object
2 properties
2 required
type_service-lines_v2_UniversalServiceLineCreate
object
19 properties
2 required
type_health-care-code-information_v1_OccurrenceSpanInformation
object
This corresponds to the BI code qualifier value.
5 properties
3 required
type_commons_ClaimSubmissionPayerResponsibilityType
string
type_commons_PageToken
string
type_billing-notes_v2_BillingNoteType
string
type_encounter-providers_v2_TreatingProviderUpdate
object
Update type for the treating provider. All fields are optional.
6 properties
type_commons_QualifierCode
string
type_tags_TagColorEnum
string
type_encounters_v4_IntakeQuestion
object
3 properties
2 required
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierQualifier
string
type_encounter-providers_v2_TreatingProvider
object
The treating provider for professional encounters. Unlike other provider types, the treating provider has an optional NPI and no organizationname field.
6 properties
2 required
type_diagnoses_Diagnosis
object
8 properties
6 required
type_encounters_v4_EncounterUpdate
object
47 properties
type_commons_PayerPlanGroupId
string
type_commons_PreEncounterAppointmentId
string
type_commons_OrganizationId
string
type_patient-payments_v4_PatientPaymentId
string
type_health-care-code-information_v1_MSDRGCode
string
type_encounters_v4_ClinicalNoteCategoryCreate
object
2 properties
2 required
type_encounters_v4_EncounterPage
object
3 properties
1 required
type_individual_PatientNonInsurancePayerInfo
object
3 properties
2 required
type_payers_v4_Payer
object
8 properties
6 required
type_diagnoses_DiagnosisCreate
object
4 properties
2 required
type_payers_v4_PrimaryPayerIds
object
3 properties
1 required
type_encounters_v4_InterventionCategory
string
type_encounter-providers_v2_InitialReferringProvider
object
8 properties
1 required
type_encounter-providers_v2_BillingProvider
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
3 required
type_individual_Subscriber
object
8 properties
6 required
type_patient-payments_v3_PatientPaymentId
string
type_invoices_InvoiceItem
object
2 properties
2 required
type_invoices_v2_InvoiceInfo
object
3 properties
3 required
type_encounters-universal_UniversalEncounterCreateFromPreEncounter
object
52 properties
9 required
type_health-care-code-information_v1_OtherDiagnosisInformationNew
object
This corresponds to BF and ABF code qualifier values.
3 properties
2 required
type_commons_AllocationId
string
type_commons_StreetAddressLongZip
object
6 properties
5 required
type_insurance-cards_v2_InsuranceCardCreate
object
15 properties
3 required
type_patient-payments_v4_PaymentMethodProviderInfo
object
3 properties
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierCreate
object
2 properties
2 required
type_payers_v4_PayerUuid
string
type_patient-payments_v4_PaymentMethodDetail
object
3 properties
1 required
type_financials_NoteUpdate
type_payers_v4_PayerCategory
string
type_encounters_v4_Medication
object
6 properties
1 required
type_eras_ERA
object
3 properties
3 required
type_encounters_v4_EncounterCreate
object
52 properties
11 required
type_encounters_v4_RxCui
string
type_encounter-providers_v2_SupervisingProviderSecondaryIdentification
object
2 properties
2 required
type_encounters-universal_UniversalEncounterUpdate
object
57 properties
type_invoices_Invoice
object
13 properties
10 required
type_claims_Claim
object
8 properties
4 required
type_health-care-code-information_v1_OccurrenceSpanInformationNew
object
This corresponds to the BI code qualifier value.
3 properties
3 required
type_invoices_v2_ClaimInvoiceItem
object
2 properties
2 required
type_financials_AllocationCreate
object
Allocations are portions of payments that are applied to specific resources, known as targets. Each allocation has and amount, defined in cents, and a target.
3 properties
2 required
type_commons_ClinicalTrialId
string
type_invoices_v2_InvoiceItemInfo
object
2 properties
2 required
type_encounters_v4_PayerPlanGroupPayerDoesNotMatchInsuranceCardError
object
2 properties
1 required
type_encounters_v4_EncounterSortOptions
string
type_commons_EntityNotFoundErrorMessage
object
1 property
1 required
type_health-care-code-information_v1_D8Date
string
type_commons_InsuranceTypeCode
string
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
type_eras_EraId
string
type_health-care-code-information_v1_OccurrenceSpanCodeQualifier
string
type_encounters_v4_ResponsiblePartyType
string
type_related-causes_v1_RelatedCausesInformationCreate
object
3 properties
1 required
type_commons_ChargeCaptureClaimCreationId
string
type_commons_State
string
type_individual_SubscriberCreate
object
7 properties
5 required
type_encounters_v4_PatientHistoryCategoryEnum
string
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_commons_PreEncounterPatientId
string
type_commons_WorkQueueId
string
type_x12_v1_TypeOfCareCode
string
type_x12_v1_TypeOfAdmissionOrVisitCode
string
type_clinical-trials_v1_ClinicalTrial
object
6 properties
5 required
type_guarantor_v1_Guarantor
object
11 properties
9 required
type_health-care-code-information_v1_ValueInformation
object
This corresponds to the BE code qualifier value.
5 properties
3 required
type_commons_SchemaId
string
type_guarantor_v1_GuarantorUpdate
object
10 properties
type_health-care-code-information_v1_PatientReasonForVisitNew
object
This corresponds to PR or APR code qualifier values.
2 properties
2 required
type_health-care-code-information_v1_PatientReasonForVisit
object
This corresponds to PR or APR code qualifier values.
4 properties
2 required
type_financials_AllocationRestrictionType
string
The dimension along which a payment's auto-allocation can be restricted.
type_payers_v4_PayerIds
object
3 properties
type_encounters_v4_EncounterOwnerOfNextActionType
string
type_health-care-code-information_v1_ConditionInformationCodeQualifier
string
type_encounters_v4_Encounter
object
76 properties
22 required
type_health-care-code-information_v1_ValueCode
string
type_encounter-providers_v2_BillingProviderSecondaryIdentificationQualifier
string
type_payers_v4_SupportState
string
type_diagnoses_DiagnosisId
string
type_payers_v3_PayerUuid
string
type_invoices_InvoiceStatus
string
type_commons_ReportTransmissionCode
string
type_non-insurance-payers_v1_NonInsurancePayerId
string
type_patient-payments_v3_PatientPaymentSource
string
type_invoices_v2_InvoiceDestinationMetadata
object
4 properties
3 required
type_invoices_v2_ServiceLineInvoiceItem
object
2 properties
2 required
type_health-care-code-information_v1_OtherProcedureInformation
object
This corresponds to the BBQ or BQ code qualifier values.
5 properties
3 required
type_commons_ServiceLineUnits
string
type_patient-payments_v4_PaymentMethodCreate
type_service-lines_v2_ServiceLineAdjustment
object
5 properties
1 required
type_health-care-code-information_v1_AdmittingDiagnosis
object
This corresponds to BJ or ABJ code qualifier values.
4 properties
2 required
type_clinical-trials_v1_ClinicalTrialPhase
string
type_commons_PatientExternalId
string
type_financials_PatientTransactionSource
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_yes-no-indicator_YesNoIndicator
string
type_health-care-code-information_v1_OccurrenceInformationCodeQualifier
string
type_related-causes_v1_RelatedCausesInformationUpdate
object
3 properties
1 required
type_service-facility_EncounterServiceFacilityUpdate
object
5 properties
type_financials_AllocationTargetCreate
Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.
type_encounters_v4_VitalsUpdate
object
7 properties
type_health-care-code-information_v1_ConditionInformationNew
object
This corresponds to the BG code qualifier value.
2 properties
2 required
type_tags_TagId
string
type_encounters_v4_EncounterRenderingOrAttendingProviderRequiredError
object
type_payers_v4_PayerPage
object
3 properties
1 required
type_claims_ClaimStatus
string
type_service-facility_EncounterServiceFacilityBase
object
Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility ca…
5 properties
2 required
type_commons_ClaimId
string
type_commons_ProviderId
string
type_organization-providers_v2_LicenseType
string
type_claim-submission_v1_ClaimSubmissionRecordCreate
object
Data about each external submission.
4 properties
1 required
type_payers_v4_ClearinghousePayerInfo
object
8 properties
8 required
type_individual_Patient
object
14 properties
13 required
type_service-lines_v2_DrugIdentification
object
8 properties
4 required
type_health-care-code-information_v1_PrincipalProcedureInformation
object
This correspond to BBR, BR, and CAH code qualifier values.
5 properties
3 required
type_commons_BillingProviderCommercialLicenseType
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Candid Health 11
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 V1 API
Candid Health V2 API
Candid Health V3 API
#V4
Where this information came from
This is an independent, third-party profile of Candid Health V4 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.