v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-24226771.6 MB
Real-time eligibility check

Submit a real-time 270/271 eligibility check in JSON format

post/change/medicalnetwork/eligibility/v3

Headers

X-Forwarded-Forstring

(CMS requests only): Starting November 8, 2025, the Centers for Medicare & Medicaid Services (CMS) requires submitters to include network IP addresses from an eligibility request's point of origin through receipt by the HETS system. To comply with this requirement, you may need to include this header in requests to CMS.

When present, this header should contain a comma-separated list of upstream IP addresses, starting with the originating system and continuing through every intermediary. You can exclude your IP address from the list. Note that Stedi blocks eligibility requests to CMS when any IP address in the chain – the originating IP address or any in the X-Forwarded-For header – is located outside the United States.

Visit CMS traceability requirements for details and examples.

Request body

controlNumberstring

Stedi generates a control number for each eligibility check, so you don’t need to include this property in your request.

eligibilitySearchIdstring

An identifier that allows Stedi to group eligibility checks for the same patient into a unified record in the Stedi portal called an eligibility search.

This property is for use by Stedi tools only, such as Stedi's MCP server.

externalPatientIdstring

A unique identifier for the patient that Stedi uses to identify and correlate historical eligibility checks for the same individual. We recommend including this value in all requests.

portalPasswordstring

The password that the provider uses to log in to the payer's portal. For payers Medicaid California, AltaMed, and Kern Family Health Care, this property is required and should be the provider's PIN. Otherwise, this is not commonly used.

portalUsernamestring

The username that the provider uses to log in to the payer's portal. This is not commonly used.

submitterTransactionIdentifierstring

This property is only relevant for asynchronous batch eligibility checks.

tradingPartnerNamestring

The payer's name, such as Cigna or Aetna.

tradingPartnerServiceIdstring required

The payer ID. Visit the Payer Network for a complete list.

  • You can send requests using the primary payer ID, the Stedi payer ID, or any alias listed in the payer record.
  • You must include leading 0 characters - payer IDs are alphanumeric strings and must be treated as complete strings, not integers. For example, use 00540 for SISCO, not 540.

Response

EligibilityCheck 200 response

controlNumberstring

An identifier for the payer's response.

eligibilitySearchIdstring

An identifier that allows Stedi to group eligibility checks for the same patient into a unified record in the Stedi portal called an eligibility search.

This property is for use by Stedi tools only, such as Stedi's MCP server.

idstring

A globally unique identifier for this eligibility check across all Stedi accounts. It's formatted as ec_<uuid>. For example: ec_550e8400-e29b-41d4-a716-446655440000. You can use this ID to track this eligibility check and to construct deep links to eligibility checks in the Stedi portal.

implementationTransactionSetSyntaxErrorstring

The implementation transaction set error code provided in IK502 of the 999 transaction.

reassociationKeystring
statusstring

Errors Stedi encountered when generating or sending the final X12 EDI transaction to the payer. These can include validation errors and payer unavailable errors that prevent delivery.

tradingPartnerServiceIdstring

An ID for the payer you identified in the original eligibility check request. This value may differ from the tradingPartnerServiceId you submitted in the original request because it reflects the payer's internal concept of their ID, not necessarily the ID Stedi uses to route requests to this payer.

transactionSetAcknowledgementstring

The transaction set acknowledgment code provided in in the X12 EDI 999 response.

x12string

Typically this property contains the raw X12 EDI 271 Eligibility Benefit Response from the payer.

In some circumstances, this property may contain a 999 Implementation Acknowledgment instead of a 271. A 999 indicates validation errors in the X12 EDI transaction, such as improper formatting or missing or invalid values.

If the 999 is returned in this property, many of the other response properties will be empty, as they are mapped to information in the 271.