Candid Health V3 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 v3. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
39 operations
across 28 paths,
and defines 127 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.
The identity and technical contract details declared by the specification.
type_commons_EncounterId
string
type_contracts_v3_ContractProviderCredentialingPage
object
3 properties
1 required
type_contracts_v2_AuthorizedSignatoryUpdate
type_contracts_v3_ContractCreateUnion
type_commons_UnprocessableEntityErrorMessage
object
1 property
type_fee-schedules_v3_DimensionName
string
The name of a dimension.
type_contracts_v3_ContractServiceFacility
object
4 properties
4 required
type_organization-service-facilities_v2_OrganizationServiceFacilityId
string
type_fee-schedules_v3_OptionalDimensions
object
A dimensions object where all properties are optional.
10 properties
7 required
type_contracts_v3_ContractServiceFacilityBase
object
2 properties
2 required
type_fee-schedules_v3_MatchTestResult
object
2 properties
2 required
type_fee-schedules_v3_PayerThresholdsPage
object
3 properties
1 required
type_fee-schedules_v3_MatchLicenseType
object
Match information for rendering provider license type
3 properties
2 required
type_identifiers_IdentifierCreate
object
3 properties
2 required
type_contracts_v3_RenderingProviderid
string
type_credentialing_v2_ProviderCredentialingSpan
object
13 properties
8 required
type_contracts_v2_ContractStatus
string
type_contracts_v2_InsuranceTypes
type_commons_RemovableDateRangeOptionalEnd
type_contracts_v2_ContractIsLinkedToFeeScheduleError
object
1 property
1 required
type_commons_NetworkType
string
type_identifiers_IdentifierId
string
type_commons_Date
string
ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
type_identifiers_UpdatableIdentifier
type_organization-providers_v3_OrganizationProviderCreateV2
object
14 properties
6 required
type_contracts_v3_ContractUnion
type_fee-schedules_v3_MatchResult
object
2 properties
2 required
type_commons_UnauthorizedErrorMessage
object
1 property
type_fee-schedules_v3_MatchFacilityTypeCode
object
Match information for facility type code
3 properties
2 required
type_commons_SortDirection
string
type_contracts_v3_ContractServiceFacilityId
string
type_pipeline-commons_ConfigurableRuleId
string
type_fee-schedules_v3_MatchDate
object
Match information for date of service
3 properties
2 required
type_fee-schedules_v3_PayerThreshold
object
Rate thresholds that determine fee schedule rate matching behavior. When a service line is adjudicated by a payer Candid determines if the payer's allowed amou…
3 properties
1 required
type_tasks_v3_TaskPage
object
3 properties
1 required
type_tasks_v3_TaskNote
object
5 properties
5 required
type_organization-providers_v3_ProviderAttachmentId
string
type_commons_ProcedureModifier
string
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_identifiers_IdentifierCode
string
type_contracts_v3_ContractProviderCount
object
1 property
1 required
type_exports_v3_GetExportsResponse
object
4 properties
4 required
type_commons_DateRangeOptionalEnd
object
2 properties
1 required
type_organization-providers_v2_EmploymentStatus
string
type_organization-providers_v3_ProviderAttachment
object
4 properties
4 required
type_contracts_v2_ContractInvalidExpirationDateError
object
1 property
1 required
type_contracts_v3_ContractingProviderId
string
type_identifiers_IdentifierValue
type_credentialing_v2_ProviderCredentialingSpanId
string
type_contracts_v2_AuthorizedSignatory
object
6 properties
type_fee-schedules_v3_MatchPayerPlanGroups
object
Match information for a payer plan
3 properties
3 required
type_fee-schedules_v3_MatchGeo
object
Match information for state or zip code
4 properties
2 required
type_commons_ServiceLineId
string
type_fee-schedules_v3_DimensionMatch
object
Dimension matching for a service line
10 properties
10 required
type_organization-providers_v2_OrganizationProviderAddress
object
2 properties
2 required
type_fee-schedules_v3_MatchProvider
object
Match information for a billing provider
3 properties
2 required
type_tasks_commons_TaskStatus
string
type_organization-providers_v2_ProviderType
string
type_fee-schedules_v3_RateEntry
object
A rate value in cents for a specific time range. Rate entries can be deactivated, which is set by using the deleterate endpoint. Deactivated rate entries are n…
4 properties
3 required
type_organization-providers_v2_AddressType
string
type_fee-schedules_v3_ThresholdMatch
object
Threshold and dollar amount matching for a service line
4 properties
4 required
type_credentialing_v2_CredentialingSpanStatus
string
Stage of a credentialing span in the credentialing workflow.
type_tasks_v3_TaskActionType
string
type_pipeline-commons_RuleId
string
type_fee-schedules_v3_RateUploadWithPossibleErrors
object
3 properties
2 required
type_fee-schedules_v3_ValidationError
type_organization-providers_v2_OrganizationProviderSortOptions
string
type_tasks_v3_TaskSortOptions
string
type_fee-schedules_v3_Dimensions
object
Dimension values that qualify a rate. For the optional dimensions, a null value signifies "all apply". For set-type dimensions, an empty set signifies "all app…
10 properties
10 required
type_organization-providers_v2_OrganizationProvider
object
17 properties
7 required
type_contracts_v3_ContractId
string
type_tasks_v3_TaskUpdateV3
object
3 properties
type_contracts_v3_ContractWithProvidersUnion
type_commons_ErrorMessage
string
type_contracts_v2_RegionsUpdate
type_organization-providers_v3_ProviderAttachmentResponse
object
1 property
1 required
type_contracts_v3_ContractUpdateUnion
type_contracts_v3_ContractProvidersPage
object
3 properties
1 required
type_fee-schedules_v3_RatesPage
object
3 properties
1 required
type_contracts_v3_AddContractProvidersResponse
object
3 properties
3 required
type_commons_PageToken
string
type_contracts_v3_ContractsPage
object
3 properties
1 required
type_commons_UserId
string
type_commons_PayerPlanGroupId
string
type_tasks_v3_TaskActions
object
1 property
1 required
type_fee-schedules_v3_MatchModifiers
object
Match information for procedure modifiers
3 properties
3 required
type_commons_OrganizationId
string
type_fee-schedules_v3_MatchNetworkTypes
object
Match information for network types
3 properties
3 required
type_contracts_v3_ContractType
string
type_tasks_v3_TaskCreateV3
object
7 properties
4 required
type_fee-schedules_v3_Rate
object
A comprehensive rate including the current rate value and all values for historic time ranges. The time ranges specified by each RateEntry are disjoint. A rate…
6 properties
6 required
type_organization-providers_v3_OrganizationProviderUpdateV2
object
14 properties
type_commons_StreetAddressLongZip
object
6 properties
5 required
type_commons_UpdatesDisabledDueToExternalSystemIntegrationErrorMessage
object
1 property
type_contracts_v3_ContractProviderCredentialing
object
A rendering provider with their credentialing spans scoped to the contract's contracting provider and payer.
2 properties
2 required
type_commons_TaskId
string
type_contracts_v2_ContractSortField
string
type_tasks_v3_TaskActionExecutionMethod
type_identifiers_Identifier
object
4 properties
3 required
type_commons_EntityConflictErrorMessage
object
1 property
1 required
type_fee-schedules_v3_MatchCptCode
object
Match information for a CPT code
3 properties
3 required
type_payers_v3_Payer
object
8 properties
3 required
type_fee-schedules_v3_DimensionsPage
object
3 properties
1 required
type_commons_EntityNotFoundErrorMessage
object
1 property
1 required
type_tasks_v3_TaskAction
object
3 properties
3 required
type_contracts_v2_DateUpdate
type_commons_InsuranceTypeCode
string
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
type_organization-providers_v2_OrganizationProviderId
string
type_commons_State
string
type_tasks_v3_TaskAssignment
object
2 properties
1 required
type_commons_WorkQueueId
string
type_fee-schedules_v3_RateUpload
type_fee-schedules_v3_MatchPayer
object
Match information for a payer
3 properties
3 required
type_tasks_v3_TaskUpdatedToDeprecatedStatusErrorType
object
1 property
type_organization-providers_v3_OrganizationProviderPageV2
object
3 properties
1 required
type_payers_v3_PayerUuid
string
type_organization-providers_v3_ProviderAttachmentFileType
string
type_commons_TaskAssignmentId
string
type_tasks_v3_Task
object
20 properties
15 required
type_tasks_commons_TaskCategory
string
type_payers_v3_PayerPage
object
3 properties
1 required
type_commons_TaskNoteId
string
type_tasks_commons_TaskType
string
type_organization-providers_v2_LicenseType
string
type_organization-providers_v3_OrganizationProviderV2
object
15 properties
7 required
type_commons_RateId
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Candid Health publishes across the network.
