Introducing eligibility check IDs

Stedi now generates and returns a universally unique ID (UUID) for every eligibility check.

The check ID is returned in the id field of the following API responses:

• JSON Real-Time Eligibility Check

• X12 Real-Time Eligibility Check

• Retrieve Batch Check Statuses

• Poll Batch Checks

The check ID is a string that always starts with ec_. For example:

{
  "id": "ec_550e8400-e29b-41d4-a716-446655440000", // Unique check ID, generated by Stedi
  "eligibilitySearchId": "01922a35-a177-7171-b868-cd4974dd54df",
  "benefitsInformation": [
    ...
  ],
  ...
}

For SOAP Real-Time Eligibility Check API responses, the check ID is returned in the stedi-id HTTP response header:

The check ID gives you a stable handle for a single eligibility check. You can use it to:

• Track eligibility checks for debugging and troubleshooting in your application

• Search for specific checks in the Stedi portal

• Construct deep links to eligibility checks in the Stedi portal

• Share a reference to a specific eligibility check with Stedi support

Search by check ID in the Stedi portal

You can now search for eligibility checks by check ID in the Stedi portal:

Construct deep links to eligibility checks in the Stedi portal

URLs for eligibility checks in the Stedi portal now follow this pattern:

You can use the convention to construct your own deep links to eligibility checks in the portal. For example, if an eligibility check has:

• An eligibility search ID of 06956c88-a177-5252-b868-ju4974dd54gh

• A check ID of ec_550e8400-e29b-41d4-a716-446655440000

Then the URL for the eligibility check in the Stedi portal will be:

https://portal.stedi.com/app/healthcare/eligibility/06956c88-a177-5252-b868-ju4974dd54gh/inspect/ec_550e8400-e29b-41d4-a716-446655440000

When the URL resolves, the Stedi portal will automatically append ?account=<STEDI_ACCOUNT_ID> . This scopes the URL to your Stedi account.

Older eligibility check links

If you have existing bookmarks or saved links to eligibility checks in the Stedi portal, you’ll need to update them to use this new URL format.

Older links may no longer resolve correctly. In most cases, you can prepend ec_ to the URL’s final path segment (the check ID).

Differences with eligibility search IDs

Stedi returns an eligibilitySearchId for eligibility check responses in the Stedi portal and Stedi’s Eligibility APIs (excluding the SOAP API endpoint).

When you run an eligibility check in the Stedi portal’s Eligibility Manager, Stedi groups related checks – such as retries, re-runs, and follow-up checks – for the same patient into a single eligibility search. The eligibilitySearchId identifies that search.

We now return a check id anywhere you’d get an eligibilitySearchId.

The check id identifies the individual eligibility check. The eligibilitySearchId identifies the search, which can include multiple checks.

Differences with outbound trace IDs

An outbound trace ID identifies a specific real-time eligibility check for tracing and debugging.

Both outbound trace IDs and check IDs let you track real-time checks, but there are some major differences:

Use check IDs going forward

We’re not deprecating or removing outbound trace IDs with this change. However, we recommend using check IDs instead of outbound trace IDs to track eligibility checks going forward.

Check IDs are the only ID for eligibility checks that are guaranteed to be universally unique and returned across JSON, X12, and SOAP.

Differences with submitter transaction IDs in batch checks

A batch eligibility check lets you run multiple eligibility checks asynchronously using a single request.

You can specify a submitterTransactionIdentifier for each check in the batch. Stedi returns the submitterTransactionIdentifier in Poll Batch Checks and Retrieve Batch Check Statuses responses so you can match results to the check. For example, in the Poll Batch Checks response:

{
  "items": [
    {
      "batchId": "01932c61-2d4f-7d22-85fa-c7db2e13e771",
      "id": "ec_550e8400-e29b-41d4-a716-446655440000",            // Unique check ID, generated by Stedi
      "submitterTransactionIdentifier": "ABC123456789",           // User-generated Transaction identifier, submitted in the batch request
      "eligibilitySearchId": "06956c88-a177-5252-b868-ju4974dd54gh",
      ...
    },
    ...
  ],
  ...
}

Both the submitter transaction ID and check ID let you track checks in a batch, but there are some major differences:

Try it today

If you’re new to Stedi, you can sign up for our free Basic plan in under two minutes. It includes 100 free eligibility checks each month and access to mock eligibility API requests.