---
title: "Batch"
method: POST
path: "/eligibility-checks/v1/batch"
tags: ["v1"]
---

# Batch

`POST /eligibility-checks/v1/batch`

Sends a batch of eligibility checks to payers through Stedi.

## Request body

- PreEncounterEligibilityChecksV1EligibilityRequest[]
  - `submitter_transaction_identifier` string — 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.
  - `payer_id` string, required — Supported payer ID values can be found [here](https://www.stedi.com/healthcare/network).
  - `provider` union, required
    - PreEncounterEligibilityChecksV1IndividualProvider
      - `first_name` string
      - `last_name` string
      - `npi` string, required
    - PreEncounterEligibilityChecksV1OrganizationProvider
      - `organization_name` string
      - `npi` string, required
  - `subscriber` PreEncounterCoveragesV1MemberInfo, required
    - `member_id` string — Stedi requires that you supply at least one of these fields in the request: memberId, dateOfBirth, or lastName. However, each payer has different requirements, so you should supply as many of the fields necessary for each payer to identify the subscriber/dependent in their system.
    - `first_name` string, required
    - `last_name` string, required
    - `date_of_birth` string, date — Stedi requires that you supply at least one of these fields in the request: memberId, dateOfBirth, or lastName. However, each payer has different requirements, so you should supply as many of the fields necessary for each payer to identify the subscriber/dependent in their system.
  - `dependent` PreEncounterCoveragesV1MemberInfo
    - `member_id` string — Stedi requires that you supply at least one of these fields in the request: memberId, dateOfBirth, or lastName. However, each payer has different requirements, so you should supply as many of the fields necessary for each payer to identify the subscriber/dependent in their system.
    - `first_name` string, required
    - `last_name` string, required
    - `date_of_birth` string, date — Stedi requires that you supply at least one of these fields in the request: memberId, dateOfBirth, or lastName. However, each payer has different requirements, so you should supply as many of the fields necessary for each payer to identify the subscriber/dependent in their system.
  - `encounter` PreEncounterEligibilityChecksV1Encounter
    - `date_of_service` string, date — Defaults to the current date if not provided.
    - `service_type_codes` string[] — Defaults to HealthBenefitPlanCoverage (30) if not provided. <Note>Not all payers support multiple service type codes, so it is recommended to only include a single code per request.</Note>
  - `get_existing_check_initiated_after` string, date-time — 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).
  - `source` string
  - `portal_password` string — The password that the provider uses to log in to the payer's portal. This is not commonly used.
  - `portal_username` string — The username that the provider uses to log in to the payer's portal. This is not commonly used.

## Response `200`

Response with status 200

- PreEncounterEligibilityChecksV1BatchEligibilityResponse — An object representing the data for a batch eligibility response.
  - `batch_id` string, required
  - `submitted_at` string, date-time, required

## Changes

- **2026-09-17** `24b2d80d577a` — 5 breaking, 1 warning, 10 info
  - added the new required request property `items/payer_id`
  - added the new required request property `items/provider`
  - added the new required request property `items/subscriber`
  - the `items/` request property type changed from no type to `object`
  - …12 more
- **2026-09-12** `3a81ee81d4ed` — 1 info
  - api operation id `batch` removed and replaced with `v1_batch`

[Change history](https://skmtc.dev/joincandidhealth/apis/api-reference/changes/eligibility-checks/v1/batch/post.md)

---

[API](https://skmtc.dev/joincandidhealth/apis/api-reference.md) · [All operations](https://skmtc.dev/joincandidhealth/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc.dev/joincandidhealth/apis/api-reference/revisions/4074901c170f?raw)