Poll Batch

GET

/eligibility-checks/v1/batch/:batch_id

GET

/eligibility-checks/v1/batch/:batch_id

1 from candid import CandidApiClient
2 
3 client = CandidApiClient(
4     client_id="YOUR_CLIENT_ID",
5     client_secret="YOUR_CLIENT_SECRET",
6 )
7 client.pre_encounter.eligibility_checks.v_1.poll_batch(
8     batch_id="batch_id",
9 )

Try it

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       },
60       "parsed_response": {
61         "eligibility_status": "ACTIVE",
62         "plan_metadata": {
63           "payer_name": "payer_name",
64           "insurance_type": "insurance_type",
65           "insurance_type_code": "insurance_type_code",
66           "plan_name": "plan_name",
67           "member_id": "member_id",
68           "group_number": "group_number",
69           "start_date": "2023-01-15",
70           "end_date": "2023-01-15",
71           "plan_dates": [
72             {
73               "start_date": "2023-01-15",
74               "field_name": "field_name"
75             },
76             {
77               "start_date": "2023-01-15",
78               "field_name": "field_name"
79             }
80           ],
81           "subscriber": {
82             "member_id": "member_id",
83             "group_number": "group_number",
84             "first_name": "first_name",
85             "middle_name": "middle_name",
86             "last_name": "last_name",
87             "date_of_birth": "date_of_birth",
88             "gender": "gender",
89             "address": {}
90           },
91           "dependent": {
92             "member_id": "member_id",
93             "group_number": "group_number",
94             "first_name": "first_name",
95             "middle_name": "middle_name",
96             "last_name": "last_name",
97             "date_of_birth": "date_of_birth",
98             "gender": "gender",
99             "address": {}
100           }
101         },
102         "benefits": {
103           "plan_coverage": {
104             "in_network": {},
105             "in_network_flat": [],
106             "out_of_network": {},
107             "out_of_network_flat": []
108           },
109           "service_specific_coverage": [
110             {
111               "service_code": "1"
112             },
113             {
114               "service_code": "1"
115             }
116           ],
117           "benefits_related_entities": [
118             {},
119             {}
120           ],
121           "notes": "notes"
122         }
123       },
124       "request_corrections": [
125         {
126           "property": "property",
127           "request_value": "request_value",
128           "corrected_value": "corrected_value"
129         },
130         {
131           "property": "property",
132           "request_value": "request_value",
133           "corrected_value": "corrected_value"
134         }
135       ]
136     },
137     {
138       "response": {
139         "key": "value"
140       },
141       "batch_id": "batch_id",
142       "errors": [
143         {
144           "source": "CANDID",
145           "errorDetails": {
146             "field?": "field?",
147             "description?": "description?",
148             "location?": "location?",
149             "possibleResolutions?": "possibleResolutions?",
150             "code?": "code?",
151             "followupAction?": "followupAction?"
152           }
153         },
154         {
155           "source": "CANDID",
156           "errorDetails": {
157             "field?": "field?",
158             "description?": "description?",
159             "location?": "location?",
160             "possibleResolutions?": "possibleResolutions?",
161             "code?": "code?",
162             "followupAction?": "followupAction?"
163           }
164         }
165       ],
166       "request": {
167         "payer_id": "payer_id",
168         "provider": {
169           "first_name": "first_name",
170           "last_name": "last_name",
171           "npi": "npi"
172         },
173         "subscriber": {
174           "first_name": "first_name",
175           "last_name": "last_name",
176           "member_id": "member_id",
177           "date_of_birth": "2023-01-15"
178         },
179         "submitter_transaction_identifier": "submitter_transaction_identifier",
180         "dependent": {
181           "first_name": "first_name",
182           "last_name": "last_name",
183           "member_id": "member_id",
184           "date_of_birth": "2023-01-15"
185         },
186         "encounter": {
187           "date_of_service": "2023-01-15",
188           "service_type_codes": [
189             "service_type_codes",
190             "service_type_codes"
191           ]
192         }
193       },
194       "parsed_response": {
195         "eligibility_status": "ACTIVE",
196         "plan_metadata": {
197           "payer_name": "payer_name",
198           "insurance_type": "insurance_type",
199           "insurance_type_code": "insurance_type_code",
200           "plan_name": "plan_name",
201           "member_id": "member_id",
202           "group_number": "group_number",
203           "start_date": "2023-01-15",
204           "end_date": "2023-01-15",
205           "plan_dates": [
206             {
207               "start_date": "2023-01-15",
208               "field_name": "field_name"
209             },
210             {
211               "start_date": "2023-01-15",
212               "field_name": "field_name"
213             }
214           ],
215           "subscriber": {
216             "member_id": "member_id",
217             "group_number": "group_number",
218             "first_name": "first_name",
219             "middle_name": "middle_name",
220             "last_name": "last_name",
221             "date_of_birth": "date_of_birth",
222             "gender": "gender",
223             "address": {}
224           },
225           "dependent": {
226             "member_id": "member_id",
227             "group_number": "group_number",
228             "first_name": "first_name",
229             "middle_name": "middle_name",
230             "last_name": "last_name",
231             "date_of_birth": "date_of_birth",
232             "gender": "gender",
233             "address": {}
234           }
235         },
236         "benefits": {
237           "plan_coverage": {
238             "in_network": {},
239             "in_network_flat": [],
240             "out_of_network": {},
241             "out_of_network_flat": []
242           },
243           "service_specific_coverage": [
244             {
245               "service_code": "1"
246             },
247             {
248               "service_code": "1"
249             }
250           ],
251           "benefits_related_entities": [
252             {},
253             {}
254           ],
255           "notes": "notes"
256         }
257       },
258       "request_corrections": [
259         {
260           "property": "property",
261           "request_value": "request_value",
262           "corrected_value": "corrected_value"
263         },
264         {
265           "property": "property",
266           "request_value": "request_value",
267           "corrected_value": "corrected_value"
268         }
269       ]
270     }
271   ],
272   "total": 1,
273   "next_page_token": "next_page_token",
274   "prev_page_token": "prev_page_token"
275 }

Polls the status of a batch eligibility check.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path Parameters

batch_idstringRequired

Query Parameters

page_tokenstringOptional

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

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