> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server. # Check Insurance Discovery Passthrough POST https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough Content-Type: application/json Initiates an insurance discovery check. Returns the metadata of the check if successfully initiated. We recommend using this API over the eligibilityChecks insurance-discovery API, as it allows long-running discovery requests to complete. Reference: https://docs.joincandidhealth.com/api-reference/pre-encounter/coverages/v-1/check-insurance-discovery-passthrough ## Authentication - OAuth2 — send the obtained token as `Authorization: Bearer ` ## Servers - `https://pre-api.joincandidhealth.com` (Production, default) - `https://pre-api-staging.joincandidhealth.com` (Staging) - `https://sandbox-pre-api.joincandidhealth.com` (CandidSandbox) - `https://staging-pre-api.joincandidhealth.com` (CandidStaging) - `http://localhost:4000` (Local) ## Request ### Body (application/json) This endpoint expects an InsuranceDiscoveryRequest. - `provider` (InsuranceDiscoveryProvider, required) — Information about the provider requesting the insurance discovery check. - `subscriber` (InsuranceDiscoverySubscriber, required) — Demographic information for the patient when they are the health plan subscriber. Providing as much information as possible improves the probability of finding matching coverage. SSN and address (especially zip code) are strongly recommended. - `dependent` (InsuranceDiscoveryDependent, optional) — Demographic information for the patient when they are a dependent on a health plan. If you only have the dependent's information, identify them in the subscriber object instead and leave this empty. - `encounter` (InsuranceDiscoveryEncounter, optional) — The date range for the service. If not specified, Stedi defaults to the current date. You can specify either a single date_of_service or a beginning_date_of_service and end_date_of_service. ## Response ### 200 - `check_id` (string, required) - `status` (enum, required) — The status of the insurance discovery check. - Allowed values: `PENDING`, `COMPLETE`, `ERROR`, `UNKNOWN` - `initiated_by` (string, required) — The unique identifier for a User in the database - `initiated_at` (datetime, required) ## Types ### InsuranceDiscoveryProvider Information about the provider requesting the insurance discovery check. - `npi` (string, required) — The provider's National Provider Identifier (NPI). ### InsuranceDiscoverySubscriber Demographic information for the patient when they are the health plan subscriber. Providing as much information as possible improves the probability of finding matching coverage. SSN and address (especially zip code) are strongly recommended. - `first_name` (string, required) — The subscriber's first name. - `last_name` (string, required) — The subscriber's last name. - `middle_name` (string, optional) — The subscriber's middle name or initial. - `date_of_birth` (string, optional) — The subscriber's date of birth, formatted as YYYYMMDD. - `ssn` (string, optional) — The subscriber's Social Security Number (SSN). Full SSN is preferred, but even the last 4 digits can help. - `gender` (enum, optional) - Allowed values: `M`, `F` - `address` (InsuranceDiscoveryAddress, optional) — The patient's address. Providing a zip code improves the probability of finding matching coverage. ### InsuranceDiscoveryDependent Demographic information for the patient when they are a dependent on a health plan. If you only have the dependent's information, identify them in the subscriber object instead and leave this empty. - `first_name` (string, required) — The dependent's first name. - `last_name` (string, required) — The dependent's last name. - `middle_name` (string, optional) — The dependent's middle name or initial. - `date_of_birth` (string, optional) — The dependent's date of birth, formatted as YYYYMMDD. - `ssn` (string, optional) — The dependent's Social Security Number (SSN). - `gender` (enum, optional) - Allowed values: `M`, `F` - `address` (InsuranceDiscoveryAddress, optional) — The patient's address. Providing a zip code improves the probability of finding matching coverage. ### InsuranceDiscoveryEncounter The date range for the service. If not specified, Stedi defaults to the current date. You can specify either a single date_of_service or a beginning_date_of_service and end_date_of_service. - `date_of_service` (string, optional) — A single date of service, formatted as YYYYMMDD. - `beginning_date_of_service` (string, optional) — The beginning date of service, formatted as YYYYMMDD. - `end_date_of_service` (string, optional) — The end date of service, formatted as YYYYMMDD. ### InsuranceDiscoveryAddress The patient's address. Providing a zip code improves the probability of finding matching coverage. - `address_1` (string, optional) - `address_2` (string, optional) - `city` (string, optional) - `state` (string, optional) - `postal_code` (string, optional) - `country_code` (string, optional) ## Examples **Request** ```json { "provider": { "npi": "npi" }, "subscriber": { "first_name": "first_name", "last_name": "last_name" } } ``` **Response** ```json { "check_id": "check_id", "status": "PENDING", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" } ``` **SDK Code** ```python import requests url = "https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough" payload = { "provider": { "npi": "npi" }, "subscriber": { "first_name": "first_name", "last_name": "last_name" } } headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough'; const options = { method: 'POST', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{"provider":{"npi":"npi"},"subscriber":{"first_name":"first_name","last_name":"last_name"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough" payload := strings.NewReader("{\n \"provider\": {\n \"npi\": \"npi\"\n },\n \"subscriber\": {\n \"first_name\": \"first_name\",\n \"last_name\": \"last_name\"\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{\n \"provider\": {\n \"npi\": \"npi\"\n },\n \"subscriber\": {\n \"first_name\": \"first_name\",\n \"last_name\": \"last_name\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{\n \"provider\": {\n \"npi\": \"npi\"\n },\n \"subscriber\": {\n \"first_name\": \"first_name\",\n \"last_name\": \"last_name\"\n }\n}") .asString(); ``` ```php request('POST', 'https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough', [ 'body' => '{ "provider": { "npi": "npi" }, "subscriber": { "first_name": "first_name", "last_name": "last_name" } }', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"provider\": {\n \"npi\": \"npi\"\n },\n \"subscriber\": {\n \"first_name\": \"first_name\",\n \"last_name\": \"last_name\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [ "provider": ["npi": "npi"], "subscriber": [ "first_name": "first_name", "last_name": "last_name" ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://pre-api.joincandidhealth.com/coverages/v1//insurance-discovery-passthrough")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```