Get Multi

Beta

GET

/eligibility-checks/v1/get-multi/

GET

/eligibility-checks/v1/get-multi/

1 import requests
2 
3 url = "https://pre-api.joincandidhealth.com/eligibility-checks/v1/get-multi/"
4 
5 headers = {"Authorization": "<token>."}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

200Retrieved

1 {
2   "items": [
3     {
4       "response": {
5         "key": "value"
6       },
7       "batch_id": "batch_id",
8       "errors": [
9         {
10           "source": "CANDID",
11           "errorDetails": {
12             "field?": "field?",
13             "description?": "description?",
14             "location?": "location?",
15             "possibleResolutions?": "possibleResolutions?",
16             "code?": "code?",
17             "followupAction?": "followupAction?"
18           }
19         },
20         {
21           "source": "CANDID",
22           "errorDetails": {
23             "field?": "field?",
24             "description?": "description?",
25             "location?": "location?",
26             "possibleResolutions?": "possibleResolutions?",
27             "code?": "code?",
28             "followupAction?": "followupAction?"
29           }
30         }
31       ],
32       "request": {
33         "payer_id": "payer_id",
34         "provider": {
35           "first_name": "first_name",
36           "last_name": "last_name",
37           "npi": "npi"
38         },
39         "subscriber": {
40           "first_name": "first_name",
41           "last_name": "last_name",
42           "member_id": "member_id",
43           "date_of_birth": "2023-01-15"
44         },
45         "submitter_transaction_identifier": "submitter_transaction_identifier",
46         "dependent": {
47           "first_name": "first_name",
48           "last_name": "last_name",
49           "member_id": "member_id",
50           "date_of_birth": "2023-01-15"
51         },
52         "encounter": {
53           "date_of_service": "2023-01-15",
54           "service_type_codes": [
55             "service_type_codes",
56             "service_type_codes"
57           ]
58         },
59         "get_existing_check_initiated_after": "2024-01-15T09:30:00Z",
60         "source": "source"
61       },
62       "parsed_response": {
63         "eligibility_status": "ACTIVE",
64         "plan_metadata": {
65           "payer_name": "payer_name",
66           "insurance_type": "insurance_type",
67           "insurance_type_code": "insurance_type_code",
68           "plan_name": "plan_name",
69           "member_id": "member_id",
70           "group_number": "group_number",
71           "start_date": "2023-01-15",
72           "end_date": "2023-01-15",
73           "plan_dates": [
74             {
75               "start_date": "2023-01-15",
76               "field_name": "field_name"
77             },
78             {
79               "start_date": "2023-01-15",
80               "field_name": "field_name"
81             }
82           ],
83           "subscriber": {
84             "member_id": "member_id",
85             "group_number": "group_number",
86             "first_name": "first_name",
87             "middle_name": "middle_name",
88             "last_name": "last_name",
89             "date_of_birth": "date_of_birth",
90             "gender": "gender",
91             "address": {}
92           },
93           "dependent": {
94             "member_id": "member_id",
95             "group_number": "group_number",
96             "first_name": "first_name",
97             "middle_name": "middle_name",
98             "last_name": "last_name",
99             "date_of_birth": "date_of_birth",
100             "gender": "gender",
101             "address": {}
102           }
103         },
104         "benefits": {
105           "plan_coverage": {
106             "in_network": {},
107             "in_network_flat": [],
108             "out_of_network": {},
109             "out_of_network_flat": []
110           },
111           "service_specific_coverage": [
112             {
113               "service_code": "1"
114             },
115             {
116               "service_code": "1"
117             }
118           ],
119           "benefits_related_entities": [
120             {},
121             {}
122           ],
123           "notes": "notes",
124           "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId"
125         }
126       },
127       "request_corrections": [
128         {
129           "property": "property",
130           "request_value": "request_value",
131           "corrected_value": "corrected_value"
132         },
133         {
134           "property": "property",
135           "request_value": "request_value",
136           "corrected_value": "corrected_value"
137         }
138       ]
139     },
140     {
141       "response": {
142         "key": "value"
143       },
144       "batch_id": "batch_id",
145       "errors": [
146         {
147           "source": "CANDID",
148           "errorDetails": {
149             "field?": "field?",
150             "description?": "description?",
151             "location?": "location?",
152             "possibleResolutions?": "possibleResolutions?",
153             "code?": "code?",
154             "followupAction?": "followupAction?"
155           }
156         },
157         {
158           "source": "CANDID",
159           "errorDetails": {
160             "field?": "field?",
161             "description?": "description?",
162             "location?": "location?",
163             "possibleResolutions?": "possibleResolutions?",
164             "code?": "code?",
165             "followupAction?": "followupAction?"
166           }
167         }
168       ],
169       "request": {
170         "payer_id": "payer_id",
171         "provider": {
172           "first_name": "first_name",
173           "last_name": "last_name",
174           "npi": "npi"
175         },
176         "subscriber": {
177           "first_name": "first_name",
178           "last_name": "last_name",
179           "member_id": "member_id",
180           "date_of_birth": "2023-01-15"
181         },
182         "submitter_transaction_identifier": "submitter_transaction_identifier",
183         "dependent": {
184           "first_name": "first_name",
185           "last_name": "last_name",
186           "member_id": "member_id",
187           "date_of_birth": "2023-01-15"
188         },
189         "encounter": {
190           "date_of_service": "2023-01-15",
191           "service_type_codes": [
192             "service_type_codes",
193             "service_type_codes"
194           ]
195         },
196         "get_existing_check_initiated_after": "2024-01-15T09:30:00Z",
197         "source": "source"
198       },
199       "parsed_response": {
200         "eligibility_status": "ACTIVE",
201         "plan_metadata": {
202           "payer_name": "payer_name",
203           "insurance_type": "insurance_type",
204           "insurance_type_code": "insurance_type_code",
205           "plan_name": "plan_name",
206           "member_id": "member_id",
207           "group_number": "group_number",
208           "start_date": "2023-01-15",
209           "end_date": "2023-01-15",
210           "plan_dates": [
211             {
212               "start_date": "2023-01-15",
213               "field_name": "field_name"
214             },
215             {
216               "start_date": "2023-01-15",
217               "field_name": "field_name"
218             }
219           ],
220           "subscriber": {
221             "member_id": "member_id",
222             "group_number": "group_number",
223             "first_name": "first_name",
224             "middle_name": "middle_name",
225             "last_name": "last_name",
226             "date_of_birth": "date_of_birth",
227             "gender": "gender",
228             "address": {}
229           },
230           "dependent": {
231             "member_id": "member_id",
232             "group_number": "group_number",
233             "first_name": "first_name",
234             "middle_name": "middle_name",
235             "last_name": "last_name",
236             "date_of_birth": "date_of_birth",
237             "gender": "gender",
238             "address": {}
239           }
240         },
241         "benefits": {
242           "plan_coverage": {
243             "in_network": {},
244             "in_network_flat": [],
245             "out_of_network": {},
246             "out_of_network_flat": []
247           },
248           "service_specific_coverage": [
249             {
250               "service_code": "1"
251             },
252             {
253               "service_code": "1"
254             }
255           ],
256           "benefits_related_entities": [
257             {},
258             {}
259           ],
260           "notes": "notes",
261           "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId"
262         }
263       },
264       "request_corrections": [
265         {
266           "property": "property",
267           "request_value": "request_value",
268           "corrected_value": "corrected_value"
269         },
270         {
271           "property": "property",
272           "request_value": "request_value",
273           "corrected_value": "corrected_value"
274         }
275       ]
276     }
277   ],
278   "total": 1,
279   "next_page_token": "next_page_token",
280   "prev_page_token": "prev_page_token"
281 }

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

limitintegerOptional

subscriber_member_idstringOptional

payer_idstringOptional

provider_npistringOptional

date_of_servicestringOptional

initiated_at_mindatetimeOptional

initiated_at_maxdatetimeOptional

Response

This endpoint returns an object.

itemslist of objects

totalinteger

next_page_tokenstring or null

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstring or null

A token that can be used to retrieve the next or previous page of results