How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Stedi Partnerships API

The Partnerships API from Stedi — 3 operation(s) for partnerships.

Stedi Partnerships API is one of 25 APIs that Stedi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Partnerships. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 2023-08-01.

Requests are made against a single base URL, https://core.us.stedi.com/2023-08-01.

3 operations 3 paths 28 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-08-01
Base URL
https://core.us.stedi.com/2023-08-01
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Stedi Partnerships 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://www.stedi.com/app/settings/api-keys) for authentication.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Partnerships 3
POST
/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/generate-edi
This endpoint generates and delivers a fully-formed EDI file containing the staged transactions in the specified transaction group.
GenerateTransactionGroupEdi 3 params body → 200400401403404409422429
POST
/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/transactions/{transactionSettingId}
This endpoint stages a transaction for outbound delivery.
CreateTransactionGroup 4 params body → 201400401403404409422429
POST
/partnerships/{partnershipId}/transactions/{transactionSettingId}
This endpoint generates and delivers fully-formed EDI files containing a single transaction. It is the simplest way to generate EDI with Stedi.
CreatePartnershipOutboundTransaction 3 params body → 200400401403404409422429

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are CreatePartnershipOutboundTransactionRequestContent (7 properties), RepairOptions (7 properties), GenerateTransactionGroupEdiRequestContent (6 properties), CreateTransactionGroupRequestContent (4 properties). Each schema is shown below with its type and property counts.

X12AuthorizationInformationQualifier
string
Identifies the type of information in the Authorization Information (ISA-01). Default is 00 - No Authorization Information Present.
TransactionOrdering
string
Specify the order of the transactions in the generated X12 EDI file. By default, Stedi doesn't guarantee any particular order. Set to CONTROLNUMBER to order tr…
GenerateTransactionGroupEdiResponseContent
object
2 properties 2 required
UnauthorizedExceptionResponseContent
object
The server response when the authorizer failed to authenticate the caller.
2 properties 1 required
ServiceExceptionResponseContent
object
2 properties 1 required
X12AcknowledgmentRequestedCode
string
Set [ISA-14](https://www.stedi.com/edi/x12/segment/ISAISA-14) to a different value. If not set, the default value is 0 (No Interchange Acknowledgment Requested…
X12Delimiters
object
4 properties 4 required
GenerateTransactionGroupEdiRequestContent
object
6 properties
ResourceUnderChangeExceptionResponseContent
object
1 property 1 required
CreateTransactionGroupRequestContent
object
4 properties
BadRequestExceptionResponseContent
object
The server cannot process the request due to an apparent client error.
2 properties 1 required
CreateTransactionGroupResponseContent
object
4 properties 3 required
InterchangeOverrides
object
4 properties
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
ServiceUnavailableExceptionResponseContent
object
The server cannot handle the request due to technical reasons.
2 properties 1 required
X12InterchangeAuthorization
object
Set values for [ISA header](https://www.stedi.com/edi/x12/segment/ISA) elements (ISA-01 to ISA-04).
4 properties
UnprocessableEntityExceptionResponseContent
object
The request parameters do not match a previous request with the same idempotency key.
2 properties 1 required
X12UsageIndicator
string
Set [ISA-15](https://www.stedi.com/edi/x12/segment/ISAISA-15) to a different value. If not set, the default value is P (Production Data).
ThrottlingExceptionResponseContent
object
The server response when usage plan or account-level throttling limits exceeded.
2 properties 1 required
CoreCharacterSet
string
When generating EDI, the character set determines the set of characters allowed in the EDI message. Characters outside of the specified set (after applying any…
CreatePartnershipOutboundTransactionRequestContent
object
7 properties 1 required
RepairOptions
object
Options for repairing EDI data during generation to ensure it meets X12 requirements
7 properties
ExceptionCause
object
3 properties
CreatePartnershipOutboundTransactionResponseContent
object
2 properties
TransactionGroupOverrides
object
Customize the Application IDs for you or your trading partner.
2 properties
X12SecurityInformationQualifier
string
Identifies the type of information in the Security Information (ISA-03). Default is 00 - No Security Information Present.
ResourceNotFoundExceptionResponseContent
object
The server response when the specified resource cannot be found after an API request passes authentication and authorization.
2 properties 1 required
AccessDeniedExceptionResponseContent
object
The server response for authorization failure.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stedi-partnerships-api-openapi.yml Raw ↑

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 Payer API
Stedi Payers API
Where this information came from

This is an independent, third-party profile of Stedi Partnerships 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.