Retrieve Batch Status

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

GET /eligibility-manager/batch/{batchId}

This endpoint retrieves the processing status of an eligibility check batch you submitted through the asynchronous Batch Eligibility Checks endpoint or through CSV upload in the Stedi portal.

You can use this endpoint to determine when to start polling for the results of the eligibility checks within the batch. For example, you shouldn't start polling until the successCount is greater than zero. You can also use this endpoint to monitor the progress of large batches and confirm that all checks have been completed.

1. Call this endpoint with the batch ID for the eligibility check batch. This is the batchId Stedi returned in the Batch Eligibility Checks endpoint response. It's also available on the batch's details page in the Stedi portal.
2. Stedi returns a summary of the batch's processing status, including the number of completed checks, the error count, and the overall batch status.

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

Authorizations

Authorization · string · required · header

A Stedi API Key for authentication.

Path Parameters

batchId · string

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

application/json

GetBatch 200 response

batchType · string · required

The type of batch. Currently only supports eligibility.

Possible values

ELIGIBILITY

createdAt · string · required

The date and time when the batch was created.

• Format: date-time

errorCount · number

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.

id · string · 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.

importUrl · string

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

inProgressCount · number

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

name · string · 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.

• Pattern: ^[a-zA-Z0-9-_]{1,100}$

source · string

How the batch was submitted. Can be:

• API: The batch was submitted through the Batch Eligibility Check endpoint.
• CSV_IMPORT: The batch was submitted through CSV upload in the Stedi portal.

Possible values

CSV_IMPORT

API

status · string · required

The status of the batch. Can be:

• PENDING: Stedi created the batch and is waiting for the CSV file to finish uploading.
• VALIDATED: Stedi finished validating the batch and is ready to start executing it.
• VALIDATION_FAILED: Stedi found errors in the batch submission that you need to fix before processing can continue. This is usually due to malformed CSV data.
• IN_PROGRESS: Stedi is processing the batch. Some eligibility checks in the batch may be complete while others are still in progress.
• COMPLETED: Stedi finished processing all items in the batch successfully. This doesn't mean that all eligibility checks successfully returned benefits information, only that Stedi successfully sent them to the payers and received responses.
• COMPLETED_WITH_ERRORS: Stedi finished processing all eligibility checks in the batch, but some failed. A common reason for failure is payer connectivity issues.

Possible values

PENDING

VALIDATED

VALIDATION_FAILED

IN_PROGRESS

COMPLETED

successCount · number

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.

totalCount · number

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.

updatedAt · string · required

The date and time when the batch was last updated.

• Format: date-time

validatedCount · number

The number of eligibility checks that Stedi has validated.

validationFailedCount · number

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.

cURL

curl --request GET \
  --url "https://manager.us.stedi.com/2024-04-01/eligibility-manager/batch/{batchId}" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://manager.us.stedi.com/2024-04-01/eligibility-manager/batch/{batchId}", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://manager.us.stedi.com/2024-04-01/eligibility-manager/batch/{batchId}"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "<api_key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

Python

import requests

url = "https://manager.us.stedi.com/2024-04-01/eligibility-manager/batch/{batchId}"

response = requests.request("GET", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://manager.us.stedi.com/2024-04-01/eligibility-manager/batch/{batchId}"))
  .header("Authorization", "<api_key>")
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

200

{
  "batchType": "ELIGIBILITY",
  "createdAt": "2025-06-13T21:00:52.496Z",
  "errorCount": 5,
  "id": "01976b18-6d90-71d1-b27b-2556a9fbf837",
  "importUrl": "https://s3.amazonaws.com/bucket/key",
  "inProgressCount": 0,
  "name": "test_CSV_upload",
  "source": "CSV_IMPORT",
  "status": "COMPLETED_WITH_ERRORS",
  "successCount": 245,
  "totalCount": 250,
  "updatedAt": "2025-06-16T15:59:20.312Z"
}

400

{
  "fieldList": [
    {
      "message": "string",
      "path": "string"
    }
  ],
  "message": "string"
}

401

{
  "code": "string",
  "message": "string"
}

403

{
  "code": "string",
  "message": "string"
}

404

{
  "code": "string",
  "message": "string"
}

500

{
  "code": "string",
  "message": "string"
}