Stedi Enrollments API is one of 25 APIs that Stedi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Enrollments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
7 operations
across 4 paths,
and defines 46 schemas.
It is described by OpenAPI 3.2.0, at version 2024-09-01.
Requests are made against a single base URL, https://enrollments.us.stedi.com/2024-09-01.
The identity and technical contract details declared by the specification.
UsState
string
United States state and territory codes using standard two-letter abbreviations.
EnrolledProviderInput
object
The provider you want to enroll with the payer. This must be an existing provider record within Stedi.
1 property
1 required
CreateEnrollmentRequestContent
object
Input for CreateEnrollment.
11 properties
5 required
TaskResponseData
A discriminated union of task response data. Contains structured data collected when completing specific task types.
EnrollmentHistoryChangeType
string
The type of change recorded in the enrollment history.
EnrollmentHistoryEntry
object
An update to an enrollment, such as a change in the enrollment's status. This object is experimental and may change in the future.
5 properties
4 required
UnauthorizedExceptionResponseContent
object
The server response when the authorizer failed to authenticate the caller.
2 properties
1 required
EnrolledPayerInput
object
The payer you want to enroll with.
2 properties
CreateEnrollmentDocumentUploadResponseContent
object
Response containing the enrollment ID, document ID, and pre-signed URL.
3 properties
3 required
ExportEnrollmentsCsvRequestContent
object
Input for ExportEnrollmentsCsv operation. Supports the same filtering options as ListEnrollments (excluding pagination).
19 properties
UpdateEnrollmentRequestContent
object
Input for UpdateEnrollment.
11 properties
5 required
AggregationPreference
Preference for how the payer should group 835 Electronic Remittance Advice (ERA) transactions. Only set this property for 835 ERA enrollments. - If you include…
EnrollmentSummary
object
Summary of an enrollment with essential fields for list operations.
18 properties
9 required
PdfUploadResponse
object
Response data containing the uploaded PDF after completion.
2 properties
2 required
TransactionType
string
Types of healthcare transactions supported for enrollment.
AllEnrolledProviderFields
object
Complete provider information including both read-only and mutable fields.
5 properties
5 required
GatewayTimeoutExceptionResponseContent
object
The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
2 properties
1 required
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
GetEnrollmentResponseContent
object
Output containing the enrollment details.
20 properties
9 required
UpdateEnrollmentResponseContent
object
Output containing the updated enrollment details.
20 properties
9 required
ServiceUnavailableExceptionResponseContent
object
The server cannot handle the request due to technical reasons.
2 properties
1 required
QuotaExceededExceptionResponseContent
object
The server response for the usage plan quota exceeded error.
2 properties
1 required
EnrolledTransaction
object
Represents the enrollment status for a specific transaction type.
1 property
1 required
InternalFailureExceptionResponseContent
object
The server response when an unexpected error occurred while processing request.
2 properties
1 required
EnrollmentDocument
object
A collection of metadata about an enrollment document, including its name, status, last updated date, and the associated enrollment Id.
9 properties
6 required
DocumentStatus
string
Indicates whether the document file has been successfully uploaded to Stedi.
ResponsibleParty
string
The party responsible for completing a task.
CreateEnrollmentDocumentUploadRequestContent
object
Input for CreateDocumentUpload.
2 properties
2 required
ProvideInformationResponse
object
Response data for ProvideInformation task completion.
1 property
1 required
InitialEnrollmentStatus
string
The enrollment's status when it is first created. You can create enrollments in either DRAFT or STEDIACTIONREQUIRED status. The default status is DRAFT if not…
ProvideFilledPdfTask
object
A task that requires uploading a PDF document. Stedi will either provide an enrollment template PDF to download and complete, or provide instructions for uploa…
2 properties
1 required
ValidationExceptionField
object
Describes one specific validation failure for an input member.
2 properties
2 required
CreateEnrollmentResponseContent
object
Output containing the created enrollment details.
20 properties
9 required
ProviderContact
object
The contact information for the provider. These contacts appear as prepopulated options for contact information when creating enrollment requests for this prov…
10 properties
6 required
FollowInstructionsTask
object
Follow-instructions task data containing text instructions for a user to follow.
1 property
1 required
ProvideInformationTask
object
Task for collecting specific information from the provider.
1 property
1 required
Task
object
A task representing work that needs to be completed.
7 properties
5 required
EnrollmentStatus
string
The status of the enrollment. You can submit enrollments with either DRAFT or STEDIACTIONREQUIRED status - the default is DRAFT if not included. Set this to ST…
ExportEnrollmentsCsvResponseContent
object
Output containing export results. If no enrollments found, downloadUrl and filename will be undefined and recordCount will be 0.
3 properties
1 required
ListEnrollmentsResponseContent
object
Output containing a paginated list of enrollments.
3 properties
EnrollmentSource
string
The source of the enrollment.
TaskDefinition
A discriminated union of task definitions. Supports multiple task types with future extensibility.
ResourceNotFoundExceptionResponseContent
object
The requested resource could not be found.
2 properties
1 required
AccessDeniedExceptionResponseContent
object
The server response for authorization failure.
2 properties
1 required
EnrolledPayerOutput
object
Output structure containing payer information in enrollment responses.
3 properties
1 required
EnrolledTransactionsList
Specifies which transaction types are included in the enrollment.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Stedi publishes across the network.
