Contact Sales
Search...
/
Introduction
Getting Started
Candid Environments
Payer Information
API Principles
Design Principles
Development Lifecycle
Breaking Changes
Conventions
Additional Resources
Postman
OpenAPI
Legacy Documentation
Support
API Reference
Auth
V2
POST
Get token
Billing Notes
V2
POST
Create billing note
Contracts
V2
GET
Get contract
GET
Get all contracts
POST
Create contract
DEL
Delete contract
PATCH
Update contract
Eligibility
V2
POST
Submit encounter eligibility check
GET
Submit encounter eligibility check (Availity)
POST
Submit encounter eligibility check (Availity Post)
Encounters
V4
GET
Get all encounters
GET
Get encounter
POST
Create encounter
PATCH
Update encounter
Expected Network Status
V1
POST
Compute network status
V2
POST
Compute for rendering provider
POST
Compute for all in-network providers
Exports
V3
GET
Get exports
External Payment Account Config
V1
GET
Get Multi
Fee Schedules
V3
GET
Get Match
GET
Test Match
GET
Get Multi
GET
Get Unique Values For Dimension
GET
Get Rate History
POST
Upload a fee schedule (a collection of rates)
DEL
Delete a rate
GET
Get Payer Thresholds Default
GET
Get Payer Thresholds
PUT
Set Payer Threshold
Guarantor
V1
POST
Create guarantor
GET
Get guarantor
PATCH
Update guarantor
Import Invoice
V1
POST
Import Invoice
GET
Get Multi
GET
Get
PATCH
Update
Insurance Adjudications
V1
GET
Get insurance adjudication
POST
Create insurance adjudication
DEL
Delete insurance adjudication
Insurance Payments
V1
GET
Get insurance payments
GET
Get insurance payment
POST
Create insurance payment
PATCH
Update
DEL
Delete insurance payment
Insurance Refunds
V1
GET
Get insurance refunds
GET
Get insurance refund
POST
Create insurance refund
PATCH
Update
DEL
Delete insurance refund
Organization Service Facilities
V2
GET
Get organization service facility
GET
Get all organization service facilities
POST
Create organization service facility
PATCH
Update organization service facility
DEL
Delete organization service facility
Organization Providers
V3
GET
Get organization provider
GET
Get all organization providers
POST
Create organization provider
PATCH
Update organization provider
Patient Payments
V4
GET
Get patient payments
GET
Get patient payment
POST
Create patient payment
PATCH
Update
DEL
Delete patient payment
Patient Refunds
V1
GET
Get patient refunds
GET
Get patient refund
POST
Create patient refund
PATCH
Update
DEL
Delete patient refund
Payers
V3
GET
Get payer
GET
Get all payers
Tasks
V3
GET
Get task actions
GET
Get all tasks
GET
Get task
POST
Create task
PATCH
Update task
Write Offs
V1
GET
Get all write-offs
GET
Get write-off
POST
Create write-off
POST
Revert write-off
Service Facility
PATCH
Update
Pre Encounter
Coverages
V1
Coverages
POST
Create
PUT
Update
GET
Get
GET
Get History
GET
Get Multi
GET
Scan
Patients
V1
Patients
POST
Create
GET
Get
GET
Get History
PUT
Update
DEL
Deactivate
GET
Search
GET
Scan
Contact Sales
Expected Network Status
V1
Compute network status
Beta
POST
https://
api.joincandidhealth.com
/
api
/
expected-network-status
/
v1
Computes the expected network status given the provided information.
Request
This endpoint expects an object.
subscriber_payer_id
string
Required
subscriber_payer_name
string
Required
billing_provider_npi
string
Required
The National Provider Identifier (NPI) of the healthcare provider responsible for billing. A unique 10-digit identification number.
billing_provider_tin
string
Required
Follow the 9-digit format of the Taxpayer Identification Number (TIN).
rendering_provider_npi
string
Required
The National Provider Identifier (NPI) of the healthcare provider who delivered the services. A unique 10-digit identification number.
contracted_state
enum
Required
The state in which the healthcare provider has a contractual agreement with the insurance payer.
Show 62 enum values
date_of_service
string
Required
Date formatted as YYYY-MM-DD; eg: 2019-08-25.
external_patient_id
string
Optional
subscriber_insurance_type
enum
Optional
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
Show 70 enum values
subscriber_plan_name
string
Optional
The descriptive name of the insurance plan selected by the subscriber, often indicating coverage specifics or tier.
Response
This endpoint returns an object
expected_network_status
enum
The anticipated classification of a healthcare provider within the insurance plan's network.
Allowed values:
in_network
out_of_network
unknown
explanation
string
contract_id
UUID
Optional
Built with