Poll Batch Eligibility Checks

Retrieve batch eligibility check results

This endpoint retrieves the results of asynchronous eligibility checks you submitted through the asynchronous Batch Eligibility Checks endpoint or through CSV upload in the Stedi portal. It doesn’t return results for real-time eligibility checks.

1. Call this endpoint. You can optionally add one or more query parameters to filter the results you want to retrieve.
2. The endpoint returns completed checks matching the criteria. Stedi retries checks that fail due to payer connectivity issues for up to 8 hours. Therefore, it can take up to 8 hours for all checks in a batch to return results.

Each item in the response contains the benefits information for a completed eligibility check. Note that our documentation lists all enums officially allowed in the eligibility response. Some payers return non-compliant values, which Stedi passes through as is.

Visit Retrieve batch results for a complete how-to guide.

Pagination

By default, the response includes the results for up to 10 eligibility checks within a single page - each eligibility response is represented as one item in the items array. You can control the number of results returned per page using the pageSize query parameter, which accepts a value between 1 and 200.

When there are additional pages of results, the response includes the nextPageToken property. To retrieve the next page of results, call the endpoint with the same batchId and other query parameters, and set the pageToken query parameter to the nextPageToken value. Repeat this process until the response doesn’t include a nextPageToken property.

If you set the page size to a value > 20, Stedi returns the requested batch check results in gzip format to reduce the size. Many common HTTP clients accept gzip by default, but if not, you must add the Accept-Encoding: gzip header to your request and resubmit.

Authorizations

Authorization · string · header · required

A Stedi API Key for authentication.

Query Parameters

pageSize · number

The maximum number of check results to return in a page - each check is represented as one item in the items array. If not specified, the default is 10.

• If you set the page size to a value > 20, Stedi returns the requested batch check results in gzip format to reduce the size. Many common HTTP clients accept gzip by default, but if not, you must add the Accept-Encoding: gzip header to your request and resubmit.
• When check results are especially large, Stedi may return fewer than the requested number per page. In these cases, you can use the nextPageToken property to retrieve the rest of the requested results.

Required range: 1 <= x <= 200

pageToken · string

A token returned by a previous call to this operation in the nextPageToken property. If not specified, Stedi returns the first page of results.

Required string length: 1 - 1024

batchId · string

An identifier for a batch of eligibility checks submitted through the Batch Eligibility Check endpoint. Use this to retrieve results for eligibility checks in the batch.

startDateTime · string<date-time>

An ISO 8601 formatted string. For example 2023-08-28T00:00:00Z. Stedi returns asynchronous eligibility checks that have completed processing after this time. Completed means that the payer has successfully returned a benefits response, the check has failed due to errors in the request, or that the payer has been unavailable for 8 hours and Stedi will no longer attempt to retry.

Response

200

application/json

BatchEligibilityPolling 200 response

Common output structure for list operations with pagination support.