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
Billing Notes
Contracts
Custom Schemas
Eligibility
Encounters
Expected Network Status
Exports
External Payment Account Config
Fee Schedules
Guarantor
Import Invoice
Insurance Adjudications
Insurance Payments
Insurance Refunds
Non Insurance Payer Payments
Non Insurance Payer Refunds
Non Insurance Payers
Organization Service Facilities
Organization Providers
V3
GET
Get organization provider
GET
Get all organization providers
POST
Create organization provider
PATCH
Update organization provider
Patient Payments
Patient Refunds
Payers
Service Lines
Tasks
Third Party Payer Payments
Third Party Payer Refunds
Third Party Payers
Write Offs
Pre Encounter
Service Facility
Contact Sales
API Reference
Organization Providers
V3
Create organization provider
POST
https://
api.joincandidhealth.com
/
api
/
organization-providers
/
v3
Request
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
"INDIVIDUAL" or "ORGANIZATION"
Required
Allowed values:
INDIVIDUAL
ORGANIZATION
Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.
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
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
"INDIVIDUAL" or "ORGANIZATION"
Allowed values:
INDIVIDUAL
ORGANIZATION
Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.
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