Batch | Candid | API Reference

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.

Supported payer ID values can be found [here](https://www.stedi.com/healthcare/network).

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.

The primary policyholder for the insurance plan or a dependent with a unique member ID. <Note>If a dependent has a unique member ID, include their information here and leave dependent undefined.</Note>

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.

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

encounterobjectOptional

Response

This endpoint returns an object.

batch_idstring

submitted_atdatetime

1	curl -X POST https://pre-api.joincandidhealth.com/eligibility-checks/v1/batch \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"payer_id": "payer_id",
7	"provider": {
8	"npi": "npi"
9	},
10	"subscriber": {
11	"first_name": "first_name",
12	"last_name": "last_name"
13	}
14	},
15	{
16	"payer_id": "payer_id",
17	"provider": {
18	"npi": "npi"
19	},
20	"subscriber": {
21	"first_name": "first_name",
22	"last_name": "last_name"
23	}
24	}
25	]'

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