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 Non Insurance Payer Payments API

The Non Insurance Payer Payments API from Candid Health — 2 operation(s) for non insurance payer payments.

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

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

5 operations 2 paths 34 schemas 1 DELETE2 GET1 PATCH1 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 Non Insurance Payer Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 5

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

Non Insurance Payer Payments 5
GET
/api/non-insurance-payer-payments/v1
Get non-insurance payer payments
get_multi 8 params → 200422
POST
/api/non-insurance-payer-payments/v1
Create non-insurance payer payment
create 1 param body → 200404422
GET
/api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}
Get non-insurance payer payment
get 2 params → 200404
PATCH
/api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}
Update
update 2 params body → 200404422
DELETE
/api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}
Delete non-insurance payer payment
delete 2 params → 200404422

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are type_non-insurance-payer-payments_v1_NonInsurancePayerPayment (8 properties), type_non-insurance-payers_v1_NonInsurancePayer (7 properties), type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentCreate (7 properties), type_clinical-trials_v1_ClinicalTrial (6 properties). Each schema is shown below with its type and property counts.

type_commons_PageToken
string
type_commons_ClaimId
string
type_commons_PatientExternalId
string
type_financials_InvoiceUpdate
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_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_non-insurance-payer-payments_v1_NonInsurancePayerPaymentCreate
object
7 properties 3 required
type_commons_EncounterExternalId
string
type_commons_UnprocessableEntityErrorMessage
object
1 property
type_commons_EntityNotFoundErrorMessage
object
1 property 1 required
type_commons_ClinicalTrialId
string
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_clinical-trials_v1_ClinicalTrialPhase
string
type_commons_EncounterId
string
type_financials_NoteUpdate
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_InvoiceId
string
type_commons_SortDirection
string
type_financials_Allocation
object
5 properties 2 required
type_commons_State
string
type_clinical-trials_v1_ClinicalTrial
object
6 properties 5 required
type_non-insurance-payers_v1_NonInsurancePayer
object
7 properties 4 required
type_commons_AppointmentId
string
type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentsPage
object
3 properties 1 required
type_commons_ServiceLineId
string
type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentId
string
type_commons_StreetAddressShortZip
object
6 properties 4 required
type_non-insurance-payers_v1_NonInsurancePayerId
string
type_commons_Date
string
ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
type_non-insurance-payer-payments_v1_NonInsurancePayerPayment
object
8 properties 4 required
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_non-insurance-payer-payments_v1_NonInsurancePayerPaymentSortField
string
type_commons_ProviderId
string
type_commons_AllocationId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-non-insurance-payer-payments-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 Non Insurance Payer Payments 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.