Sign in
Batch eligibility check

Submit multiple eligibility checks for Stedi to process asynchronously

post/eligibility-manager/batch-eligibility

Headers

X-Forwarded-Forstring

(CMS requests only): Starting November 8, 2025, the Centers for Medicare & Medicaid Services (CMS) requires submitters to include network IP addresses from an eligibility request's point of origin through receipt by the HETS system. To comply with this requirement, you may need to include this header in requests to CMS.

When present, this header should contain a comma-separated list of upstream IP addresses, starting with the originating system and continuing through every intermediary. You can exclude your IP address from the list. Note that Stedi blocks eligibility requests to CMS when any IP address in the chain – the originating IP address or any in the X-Forwarded-For header – is located outside the United States.

Visit CMS traceability requirements for details and examples.

Request body

maxRetryHoursinteger

The maximum number of hours that Stedi will retry eligibility checks in this batch that fail due to payer connectivity issues. Must be an integer between 8 and 24 hours. If not specified, the default is 8 hours.

namestring

The name that Stedi will use when displaying this batch on the Eligibility check batches page. It must be unique within your Stedi account. If you don't specify a name, Stedi sets this property to the autogenerated batchId returned in the response.

Response

BatchEligibilityChecks 200 response

batchIdstring required

An identifier for this batch of eligibility checks. You can use this identifier to retrieve the results of this batch using the Poll Batch Eligibility Checks endpoint.

submittedAtstring date-time required

The date and time that the batch of eligibility checks was submitted to Stedi for processing.

Changes

Changed in 10 of the 52 revisions of this API.231

  • a886e8edbfb31See the full diff
    • ○

      api tag Batch eligibility check added

      api-tag-added

  • 92ebe16b1b3e1See the full diff
    • ▲

      the items/items/tradingPartnerName request property's maxLength was decreased to 60

      request-property-max-length-decreased

  • 70f9c483e47c12See the full diff
    • ○

      added the new AA enum value to the request property items/items/dependents/items/address/state

      request-property-enum-value-added

    • ○

      added the new AA enum value to the request property items/items/informationReceiverName/address/state

      request-property-enum-value-added

    • ○

      added the new AA enum value to the request property items/items/provider/address/state

      request-property-enum-value-added

    • ○

      added the new AA enum value to the request property items/items/subscriber/address/state

      request-property-enum-value-added

    • ○

      added the new AE enum value to the request property items/items/dependents/items/address/state

      request-property-enum-value-added

    • ○

      added the new AE enum value to the request property items/items/informationReceiverName/address/state

      request-property-enum-value-added

    • ○

      added the new AE enum value to the request property items/items/provider/address/state

      request-property-enum-value-added

    • ○

      added the new AE enum value to the request property items/items/subscriber/address/state

      request-property-enum-value-added

    • ○

      added the new AP enum value to the request property items/items/dependents/items/address/state

      request-property-enum-value-added

    • ○

      added the new AP enum value to the request property items/items/informationReceiverName/address/state

      request-property-enum-value-added

    • ○

      added the new AP enum value to the request property items/items/provider/address/state

      request-property-enum-value-added

    • ○

      added the new AP enum value to the request property items/items/subscriber/address/state

      request-property-enum-value-added

  • 60c438b9554f2See the full diff
    • ○

      the request property items/items/subscriber/address/address1 became optional

      request-property-became-optional

    • ○

      the request property items/items/subscriber/address/city became optional

      request-property-became-optional

  • 28c9346977411See the full diff
    • ▲

      the maxRetryHours request property type/format changed from number/ to integer/

      request-property-type-changed

  • da18dac281871See the full diff
    • ○

      added the new optional request property maxRetryHours

      new-optional-request-property

  • 8910d2a121fb1See the full diff
    • ○

      added the new optional header request parameter X-Forwarded-For

      new-optional-request-parameter

  • 6719936827889See the full diff
    • ○

      request property items/items/dependents/items/beginningCardIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/dependents/items/beginningPlanIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/dependents/items/endCardIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/dependents/items/endPlanIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/dependents/items/idCardIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/dependents/items/planIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/subscriber/beginningPlanIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/subscriber/endPlanIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/subscriber/planIssueDate reactivated

      request-property-reactivated

  • c7fb26924adf3See the full diff
    • ○

      request property items/items/subscriber/beginningCardIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/subscriber/endCardIssueDate reactivated

      request-property-reactivated

    • ○

      request property items/items/subscriber/idCardIssueDate reactivated

      request-property-reactivated

  • 16fd1ab726542See the full diff
    • ○

      the request property items/items/controlNumber became optional

      request-property-became-optional

    • ○

      request property items/items/controlNumber deprecated

      request-property-deprecated

Of the 52 revisions, 2 have no diff computed.