Batch | Candid | API Reference

1 from candid import CandidApiClient 2 from candid.resources.pre_encounter.resources.coverages.resources.v_1 import ( 3 MemberInfo, 4 ) 5 from candid.resources.pre_encounter.resources.eligibility_checks.resources.v_1 import ( 6 EligibilityRequest, 7 IndividualProvider, 8 ) 9 10 client = CandidApiClient( 11 client_id="YOUR_CLIENT_ID", 12 client_secret="YOUR_CLIENT_SECRET", 13 ) 14 client.pre_encounter.eligibility_checks.v_1.batch( 15 request=[ 16 EligibilityRequest( 17 payer_id="payer_id", 18 provider=IndividualProvider( 19 npi="npi", 20 ), 21 subscriber=MemberInfo( 22 first_name="first_name", 23 last_name="last_name", 24 ), 25 ), 26 EligibilityRequest( 27 payer_id="payer_id", 28 provider=IndividualProvider( 29 npi="npi", 30 ), 31 subscriber=MemberInfo( 32 first_name="first_name", 33 last_name="last_name", 34 ), 35 ), 36 ], 37 )

1 { 2 "batch_id": "batch_id", 3 "submitted_at": "2024-01-15T09:30:00Z" 4 }

Sends a batch of eligibility checks to payers through Stedi.

Request

This endpoint expects a list of objects.

payer_idstringRequired

Supported payer ID values can be found here.

providerobjectRequired

subscriberobjectRequired

The primary policyholder for the insurance plan or a dependent with a unique member ID.

If a dependent has a unique member ID, include their information here and leave dependent undefined.

submitter_transaction_identifierstringOptional

A unique identifier for the eligibility check within the batch. Candid returns this identifier in the response for the /batch/{batch_id} polling endpoint so you can correlate benefit responses with the original eligibility check.

dependentobjectOptional

If a dependent has a unique member ID, include their information as subscriber and leave this field undefined.

encounterobjectOptional

Response

This endpoint returns an object.

batch_idstring

submitted_atdatetime

Headers

Request

Response