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
Organization Providers
V3
Create organization provider
POST
https://
api.joincandidhealth.com
/
api
/
organization-providers
/
v3
Request
Expand all
Collapse all
This endpoint expects an object.
npi
string
Required
The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long.
is_rendering
boolean
Required
Whether the provider can be used to render services.
is_billing
boolean
Required
Whether the provider can be used to bill services.
provider_type
enum
Required
Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.
Allowed values:
INDIVIDUAL
ORGANIZATION
license_type
enum
Required
The type of license that the provider holds.
Show 68 enum values
qualifications
list of objects
Required
A provider's qualifications such as PTAN, Medicaid Provider Id, etc.
Show 3 properties
first_name
string
Optional
The first name of the provider, if the provider is an individual.
last_name
string
Optional
The last name of the provider, if the provider is an individual.
organization_name
string
Optional
The name of the provider, if the provider is an organization.
tax_id
string
Optional
If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting.
taxonomy_code
string
Optional
A code designating classification and specialization.
addresses
list of objects
Optional
The addresses associated with this provider.
Show 2 properties
employment_start_date
date
Optional
The employment start date for the provider.
employment_termination_date
date
Optional
The employment termination date for the provider.
Response
Expand all
Collapse all
This endpoint returns an object
npi
string
The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long.
is_rendering
boolean
Whether the provider can be used to render services.
is_billing
boolean
Whether the provider can be used to bill services.
provider_type
enum
Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.
Allowed values:
INDIVIDUAL
ORGANIZATION
license_type
enum
The type of license that the provider holds.
Show 68 enum values
organization_provider_id
UUID
Auto-generated ID set on creation.
qualifications
list of objects
Qualification given to a provider (PTAN, Medicaid Provider Id etc.).
Show 4 properties
first_name
string
Optional
The first name of the provider, if the provider is an individual.
last_name
string
Optional
The last name of the provider, if the provider is an individual.
organization_name
string
Optional
The name of the provider, if the provider is an organization.
tax_id
string
Optional
If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting.
taxonomy_code
string
Optional
A code designating classification and specialization.
addresses
list of objects
Optional
The addresses associated with this provider.
Show 2 properties
employment_start_date
date
Optional
The employment start date for the provider.
employment_termination_date
date
Optional
The employment termination date for the provider.
Errors
422
HTTP Request Validation Error
422
Updates Disabled Due to External System Integration Error
Built with