Expected Network StatusV1

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
subscriber_payer_name
string
billing_provider_npi
string
The National Provider Identifier (NPI) of the healthcare provider responsible for billing. A unique 10-digit identification number.
billing_provider_tin
string
Follow the 9-digit format of the Taxpayer Identification Number (TIN).
rendering_provider_npi
string
The National Provider Identifier (NPI) of the healthcare provider who delivered the services. A unique 10-digit identification number.
contracted_state
enum
The state in which the healthcare provider has a contractual agreement with the insurance payer.
date_of_service
string
Date formatted as YYYY-MM-DD; eg: 2019-08-25.
external_patient_id
optional string
subscriber_insurance_type
optional enum
subscriber_plan_name
optional string
The descriptive name of the insurance plan selected by the subscriber, often indicating coverage specifics or tier.

Response

This endpoint return an object.
expected_network_status
enum
The anticipated classification of a healthcare provider within the insurance plan's network.
Allowed values: in_networkout_of_networkunknown
explanation
string
contract_id
optional UUID
POST
/api/expected-network-status/v1
curl -X POST https://api.joincandidhealth.com/api/expected-network-status/v1 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"subscriber_payer_id": "string",
"subscriber_payer_name": "string",
"billing_provider_npi": "string",
"billing_provider_tin": "string",
"rendering_provider_npi": "string",
"contracted_state": "AA",
"date_of_service": "string"
}'
Response
{
"expected_network_status": "in_network",
"explanation": "string",
"contract_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}