v50

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

Retrieve the status of an eligibility check batch submitted through the API or CSV upload

get/eligibility-manager/batch/{batchId}

Path parameters

batchIdstring required

The unique identifier for the batch. This is the batchId returned in the Batch Eligibility Check endpoint response. It's also listed as the Batch ID in the Stedi portal.

The unique identifier for the batch. This is the batchId returned in the Batch Eligibility Check endpoint response. It's also listed as the Batch ID in the Stedi portal.

Response

GetBatch 200 response

batchType'ELIGIBILITY' required

The type of batch.

createdAtstring date-time required

The date and time when the batch was created.

errorCountinteger

The number of eligibility checks that failed during processing. A failure means that Stedi successfully processed the check but didn't receive a response from the payer, even after retrying. A common reason for failure is payer connectivity issues.

idstring required

The unique identifier for the batch. This is the batchId returned in the Batch Eligibility Check endpoint response. It's also listed as the Batch ID in the Stedi portal.

importUrlstring

The URL to download the original CSV file. Only relevant for batches submitted through CSV upload in the Stedi portal.

inProgressCountinteger

The number of eligibility checks that are currently in progress (started or retrying).

maxRetryHoursinteger

The maximum number of hours that Stedi will retry eligibility checks in this batch that fail due to payer connectivity issues. This is the value that was set when the batch was created. Only applicable to batches submitted through the API.

namestring required

The name assigned to the batch upon creation. For CSV uploads, this is the name you provided when uploading the file. For API submissions, this is the same as the batchId.

source'CSV_IMPORT' | 'API'
status'PENDING' | 'VALIDATED' | 'VALIDATION_FAILED' | 'IN_PROGRESS' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' required

The status of the batch.

successCountinteger

The number of eligibility checks that were successfully completed. This means that Stedi successfully sent the check to the payer and received a response, but doesn't indicate whether the payer returned benefits information.

totalCountinteger

The total number of eligibility checks in the batch. In the case of CSV uploads, one row in the CSV file corresponds to one eligibility check.

updatedAtstring date-time required

The date and time when the batch was last updated.

validatedCountinteger

The number of eligibility checks that Stedi has validated.

validationFailedCountinteger

The number of eligibility checks that failed validation. This is relevant to CSV uploads, where Stedi validates each row in the CSV file before processing it.