Batch

GA
Sends a batch of eligibility checks to payers through Stedi.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

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
get_existing_check_initiated_afterdatetimeOptional

If not provided, this endpoint will run a fresh eligibility check. If provided, it will return an existing successful eligibility check if one exists that was initiated after provided date with the same parameters (Date of Service, Payer ID, Provider, Subscriber, Dependent, and Encounter).

sourcestringOptional
portal_passwordstringOptional
The password that the provider uses to log in to the payer's portal. This is not commonly used.
portal_usernamestringOptional
The username that the provider uses to log in to the payer's portal. This is not commonly used.

Response

This endpoint returns an object.
batch_idstring
submitted_atdatetime