Stedi Batch Eligibility Check API
The Batch Eligibility Check API from Stedi — 4 operation(s) for submitting and polling asynchronous batches of X12 270 eligibility checks.
Stedi Batch Eligibility Check API is one of 25 APIs that Stedi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Batch eligibility check and Eligibility. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 operations across 4 paths, and defines 138 schemas. It is described by OpenAPI 3.2.0, at version 2024-04-01.
Requests are made against a single base URL, https://manager.us.stedi.com/2024-04-01.
4 operations
4 paths
138 schemas
3 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Stedi Batch Eligibility Check API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (httpApiKeyAuth).
By default, every request must be authenticated.
httpApiKeyAuth— A [Stedi API Key](https://portal.stedi.com/app/settings/api-keys) for authentication.
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Batch eligibility check 4
POST
/eligibility-manager/batch-eligibility
Submit multiple eligibility checks for Stedi to process asynchronously
GET
/eligibility-manager/batch/{batchId}
Retrieve the status of an eligibility check batch submitted through the API or CSV upload
GET
/eligibility-manager/batch/{batchId}/items
Retrieve status information for all eligibility checks within a batch, regardless of processing status
GET
/eligibility-manager/polling/batch-eligibility
Retrieve batch eligibility check results
Schemas 138
The contract defines 138 schemas that model the data the API accepts and returns. The most detailed are PlanInformation (41 properties), ResponseDependent (36 properties), ResponseSubscriber (36 properties), BenefitsDateInformation (34 properties). Each schema is shown below with its type and property counts.
BatchStatus
string
The status of the batch.
BenefitsRelatedEntity
object
Identify another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer. This array is…
12 properties
DeliveryOrCalendarPatternQualifierCode
string
Code that specifies the routine shipments, deliveries, or calendar pattern. For example 9 - Last Working Day of Period. Visit [Eligibility code lists](https://…
ProviderType
string
Identify the type of provider.
ApplicationModes
string
The type of data in the request. This is either production when you send a request with a standard API key or test when you send a request in test mode with a…
Contacts
object
Contacts
2 properties
Gender
string
InformationStatusCode
string
Payers may sometimes return other non-compliant values.
BatchType
string
The type of batch.
CodeListQualifierCode
string
Payers may sometimes return other non-compliant values.
InsuranceTypeCode
string
Code identifying the type of insurance policy. Payers may sometimes return other non-compliant values.
BenefitsDateInformation
object
Dates associated with the benefits. - This is where you can find benefit-specific eligibility dates, if provided. These dates override dates provided in planDa…
34 properties
EligibilityCheckErrorCode
string
This is a superset of all the possible codes in the sub-loops, as all errors are bubbled up to the top level of the response Payers may sometimes return other…
BenefitRelatedEntityIdentification
string
Code identifying the type of value provided in entityIdentificationValue. For example, FI - Federal Taxpayer's Identification Number. Payers may sometimes retu…
EncounterProductOrServiceIDQualifier
string
Code identifying the type/source of the procedureCode. You can set this to AD - American Dental Association Codes, CJ - Current Procedural Terminology (CPT) Co…
RequestDependentAddress
object
Address information for the dependent. When providing address information, we recommend including state for member identification in addition to the required a…
7 properties
2 required
EligibilityCheckDependentError
object
When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow…
6 properties
ContactInformation
object
2 properties
BatchItemState
string
The current state of a batch item, which represents an eligibility check within a batch.
InPlanNetworkIndicatorCode
string
Code indicating whether the benefit is in-network or out-of-network. Can be Y - Yes, N - No, U - Unknown, or W - Not Applicable Code U indicates that it is unk…
GenderWithUnknown
string
EligibilityCheckProviderErrorCode
string
Payers may sometimes return other non-compliant values.
EntityTypeQualifier
string
The type of entity. Payers may sometimes return other non-compliant values.
RequestSubscriberReferenceIdentificationQualifier
string
Use this for providers that are not requesting the eligibility check. This is the type of providerIdentifier you are providing. - Set to HPI when the National…
PlanDateInformation
object
Contains the dates associated with the subscriber and dependents' (if applicable) insurance plan. This information is used to determine their eligibility for b…
32 properties
RequestSubscriberAddress
object
Address information for the subscriber. When providing address information: - The address1 and city properties are required for standard eligibility checks and…
7 properties
GetBatchResponseContent
object
15 properties
6 required
BenefitsAdditionalInformation
object
Identifying information specific to this type of benefit.
19 properties
CommunicationMode
string
Payers may sometimes return other non-compliant values.
EligibilityMetaDataJSON
object
Metadata about the response. Stedi uses this data for tracking and troubleshooting.
6 properties
DependentInsuredIndicator
string
Indicates the status of the insured. For the dependent, this is always N.
ResponseProvider
object
Information about the entity that submitted the original eligibility check request. This may be an individual practitioner, a medical group, a hospital, or ano…
19 properties
ResourceNotFoundExceptionResponseContent
object
The server response when the specified resource cannot be found after an API request passes authentication and authorization.
2 properties
1 required
RequestProviderAddress
object
Address information for the provider. - Only include when specifically instructed by a payer, such as when the provider has multiple locations and you need to…
7 properties
2 required
Warning
object
2 properties
InPlanNetworkIndicatorName
string
The name of the in-plan network indicator code. Payers may sometimes return other non-compliant values.
DeliveryPatternTimeQualifierCode
string
A code specifying the time for routine shipments or deliveries. Payers may sometimes return other non-compliant values.
DiagnosisTypeCode
string
The type of diagnosis code you are providing. You can set to BK - International Classification of Diseases Clinical Modification (ICD-9-CM) Principal Diagnosis…
EligibilityCheckFollowupAction
string
Payers may sometimes return other non-compliant values.
EligibilityCheckDependentErrorCode
string
Payers may sometimes return other non-compliant values.
ResponseSubscriberEntityIdentifier
string
The entity identifier for the subscriber.
BenefitsInformation
object
30 properties
QuantityQualifierCode
string
Code indicating the type of quantity for the benefit. Payers may sometimes return other non-compliant values.
AdditionalIdentificationDependent
object
Use this object when you need to provide an additional identification number for the dependent. This is rarely required for standard eligibility checks.
11 properties
MaintenanceReasonCode
string
Code identifying the reason for the changes to subscriber identifying information, such as name, date of birth, or address. This is always 25 Payers may someti…
RequestDependentReferenceIdentificationQualifier
string
The type of providerIdentifier you are using. Use for providers that are not requesting the eligibility check, such as the referring provider. - Set to HPI whe…
EligibilityCheckProviderAndMemberFollowupAction
string
Payers may sometimes return other non-compliant values.
BenefitsRelatedEntityRelationshipCode
string
Code specifying the relationship between the entity and the patient. Payers may sometimes return other non-compliant values.
BatchItem
object
A batch item representing an individual record in a batch.
8 properties
4 required
InternalFailureExceptionResponseContent
object
The server response when an unexpected error occurred while processing request.
2 properties
1 required
InsuranceTypeName
string
The full name of the insurance type code. Payers may sometimes return other non-compliant values.
RequestStateOrProvinceCode
string
The US state or Canadian province code. For example, TN for Tennessee or NB for New Brunswick.
AdditionalIdentificationSubscriber
object
Use this object when you need to provide an identification number other than or in addition to the subscriber's member ID. For example, you may provide the pat…
11 properties
DtpDate
object
3 properties
ResponseDependentEntityIdentifier
string
The entity identifier for the dependent.
HealthCareInformation
object
2 properties
2 required
IndividualRelationshipCode
string
The dependent's relationship to the subscriber. You can set this to 01 - Spouse, 19 - Child, 34 - Other Adult.
ResponseProviderCode
string
A code indicating the type of provider. Visit [Eligibility code lists](https://www.stedi.com/docs/healthcare/eligibility-code-listsprovider-codes) for a comple…
ValidationExceptionField
object
Describes one specific validation failure for an input member.
2 properties
2 required
RequestProviderCode
string
ResponseSubscriber
object
Information about the primary policyholder for the insurance plan listed in the original eligibility check request. The response will always include either the…
36 properties
BatchItemAdditionalInfo
Additional information about the batch item, based on the batch type.
RequestDependentProviderCode
string
Use this for providers that are not requesting the eligibility check - the requestor is specified in the provider object. For example, if you are a hospital ma…
DeliveryOrCalendarPatternQualifier
string
The name of the deliveryOrCalendarPatternCode. For example, Last Working Day of Period. Payers may sometimes return other non-compliant values.
BatchEligibilityResultItem
object
24 properties
DeliveryPatternTimeQualifier
string
The name of the deliveryPatternTimeCode. Payers may sometimes return other non-compliant values.
RequestEligibilityServiceTypeCode
string
Payer
object
Information about the payer providing the benefits information. The response will always include the payer's business name and an identifier, such as the payer…
16 properties
DependentRelationshipCode
string
For the dependent, this can be 01 - Spouse, 19 - Child, 20 Employee, 21 - Unknown, 39 - Organ Donor, 40 - Cadaver Donor, 53 - Life Partner, or G8 - Other Relat…
TimeQualifierCode
string
Code indicating the time period for the benefit information. Payers may sometimes return other non-compliant values.
PlanInformation
object
Additional identification for the subscriber's healthcare plan.
41 properties
BenefitsInformationCoverageLevelName
string
The full name of the coverage level code. Payers may sometimes return other non-compliant values.
BenefitsInformationName
string
The full name of the benefits information code. Payers may sometimes return other non-compliant values.
BenefitsServiceDeliveryQuantityQualifierCode
string
Code specifying the type of quantity. Payers may sometimes return other non-compliant values.
SubscriberRelationship
string
The name of the relationToSubscriberCode. For the subscriber, this is always Self.
DateTimePeriodFormatQualifier
string
Payers may sometimes return other non-compliant values.
TimePeriodQualifierCode
string
Code specifying the time period for the benefit information. Payers may sometimes return other non-compliant values.
UnauthorizedExceptionResponseContent
object
The server response when the authorizer failed to authenticate the caller.
2 properties
1 required
TimePeriodQualifier
string
The name of the timePeriodQualifierCode. For example, Calendar Year. Payers may sometimes return other non-compliant values.
CompositeMedicalProcedureIdentifier
object
Identifies relevant medical procedures by their standard codes and modifiers (if applicable).
6 properties
Encounter
object
Details about the eligibility or benefit information you are requesting for the patient. - If you don't specify either serviceTypeCodes or a procedureCode and…
12 properties
RequestSubscriber
object
The primary policyholder for the insurance plan or a dependent with a unique member ID. If a dependent has a unique member ID, include their information here a…
28 properties
MaintenanceTypeCode
string
The maintenance type code. Used to acknowledge a change in the identifying elements for the subscriber from those submitted in the original eligibility check r…
HealthCareDiagnosisCode
object
Information about the patient's healthcare diagnosis.
2 properties
EligibilityCheckSubscriberError
object
When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow…
6 properties
SubscriberInsuredIndicator
string
Indicates the status of the insured. For the subscriber, this is always Y.
BatchEligibilityChecksItem
object
13 properties
4 required
EligibilityCheckError
object
When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow…
6 properties
Provider
object
Information about the entity requesting the eligibility check. This may be an individual practitioner, a medical group, a hospital, or another type of healthca…
27 properties
GetBatchItemsResponseContent
object
Common output structure for list operations with pagination support.
2 properties
IndustryCode
string
The type of facility where the service was provided. You can set this to one of the [place of service codes](https://www.cms.gov/medicare/coding-billing/place-…
EligibilityCheckProviderError
object
When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow…
6 properties
MedicalProcedureProductOrServiceIDQualifier
string
Code identifying the type/source of the procedureCode. You can set this to AD - American Dental Association Codes, CJ - Current Procedural Terminology (CPT) Co…
PayerEntityIdentifier
string
The entity identifier code for the payer. Payers may sometimes return other non-compliant values.
BenefitsServiceDeliveryQuantityQualifier
string
The name of the quantityQualifierCode. For example, Days. Payers may sometimes return other non-compliant values.
TimeQualifierName
string
The name of the time period qualifier code. Note that for the patient's deductible, Calendar Year indicates the patient's total deductible amount for the year,…
Address
object
7 properties
EligibilityBatchItemInfo
object
Additional information specific to eligibility batch items.
12 properties
EligibilityCheckResult
string
PlanStatus
object
4 properties
RelatedEntityIdentifierName
string
Code identifying an organizational entity, a physical location, property or an individual. - PPO is used to identify a PPO by name or identification number, an…
ResourceConflictExceptionResponseContent
object
The server could not process the request because of conflict in the current state of the resource.
2 properties
1 required
BenefitsServiceDelivery
object
The delivery or usage pattern for the benefits.
16 properties
MedicalProcedure
object
4 properties
2 required
EmploymentStatusCode
string
Payers may sometimes return other non-compliant values.
ResponseEligibilityServiceType
string
The name of a Service Type Code listed in the serviceTypeCodes array. Visit [Service Type Codes](https://www.stedi.com/docs/healthcare/send-eligibility-checkss…
EligibilityCheckSubscriberErrorCode
string
Payers may sometimes return other non-compliant values.
ProviderInformation
object
2 properties
AccessDeniedExceptionResponseContent
object
The server response for authorization failure.
2 properties
1 required
SubscriberTraceNumber
object
5 properties
BenefitsInformationCode
string
The code indicating the type of benefits information. Visit [Eligibility and benefit codes](https://www.stedi.com/docs/healthcare/eligibility-active-coverage-b…
QuantityQualifierName
string
The name of the quantity qualifier code. Payers may sometimes return other non-compliant values.
EligibilityCheckPayerErrorCode
string
Payers may sometimes return other non-compliant values.
AdditionalInformation
object
1 property
BatchEligibilityChecksRequestContent
object
3 properties
1 required
AuthOrCertIndicator
string
Code indicating whether the benefit is subject to prior authorization or certification. Payers may sometimes return other non-compliant values.
BatchSource
string
BatchEligibilityChecksResponseContent
object
2 properties
2 required
ResponseProviderEntityIdentifier
string
A code identifying the type of provider. Payers may sometimes return other non-compliant values.
UnitForMeasurementCode
string
Code specifying the unit of measurement for the quantity. Payers may sometimes return other non-compliant values.
ValidationExceptionResponseContent
object
A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or document…
2 properties
1 required
EligibilityAdditionalInformation
object
6 properties
RequestSubscriberProviderCode
string
Use this for providers that are not requesting the eligibility check - the requestor is specified in the provider object. For example, if you are a hospital ma…
DependentRelationship
string
The name of the relationToSubscriberCode. For example, Child when the code is 19.
RequestDependent
object
26 properties
EncounterReferenceIdentificationQualifier
string
The type of information you provided in the priorAuthorizationOrReferralNumber property. You can set this to 9F - Referral Number or G1 - Prior Authorization N…
ResponseEligibilityServiceTypeCode
string
A code identifying a type of service. Visit [Service Type Codes](https://www.stedi.com/docs/healthcare/send-eligibility-checksservice-type-codes) for a complet…
MilitaryServiceRankCode
string
Payers may sometimes return other non-compliant values.
UnitForMeasurement
string
The name of the unitForMeasurementQualifierCode. For example, Days. Payers may sometimes return other non-compliant values.
ResponseStateOrProvinceCode
string
The US state or Canadian province code with unknown option. For example, TN for Tennessee or NB for New Brunswick. Payers may sometimes return other non-compli…
GovernmentServiceAffiliationCode
string
Payers may sometimes return other non-compliant values.
BatchEligibilityPollingResponseContent
object
Common output structure for list operations with pagination support.
2 properties
1 required
InjuryCodeCategory
string
Payers may sometimes return other non-compliant values.
BenefitsInformationCoverageLevelCode
string
Code indicating the level of coverage for the patient. This will either be CHD - Children Only, DEP - Dependents Only, ECH - Employee and Children, EMP - Emplo…
SubscriberRelationshipCode
string
For the subscriber, this is always 18 for Self.
InformationReceiverName
object
16 properties
ResponseDependent
object
Information about the dependent listed in the original eligibility check request. Note that a dependent submitted in the request may be returned in the subscri…
36 properties
EligibilityCheckPayerError
object
When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow…
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Stedi 12
Other APIs Stedi publishes across the network.
Stedi Claim acknowledgments API
Stedi Claim Attachments API
Stedi Claim submission API
Stedi Coordination of benefits API
Stedi Documents API
Stedi Enrollments API
Stedi Events API
Stedi Executions API
Stedi Fragments API
Stedi Insurance discovery API
Stedi Partnerships API
Stedi Payer API
#Batch eligibility check#Eligibility
Where this information came from
This is an independent, third-party profile of Stedi Batch Eligibility Check API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.