v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-245141342.0 KB
Batch eligibility check

Retrieve batch eligibility check results

get/eligibility-manager/polling/batch-eligibility

Query parameters

pageSizeinteger

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.

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.
pageTokenstring

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

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

batchIdstring

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.

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.

startDateTimestring 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.

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

BatchEligibilityPolling 200 response

nextPageTokenstring

A Stedi-generated token that you can submit in the pageToken query parameter to retrieve the next page of results. If there are no more results, this property is not included in the response.