The Polling API from Stedi — 2 operation(s) for polling.
components:
schemas:
AccessDeniedExceptionResponseContent:
description: The server response for authorization failure.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
Artifact:
properties:
artifactType:
$ref: '#/components/schemas/ArtifactType'
model:
$ref: '#/components/schemas/ArtifactModel'
sizeBytes:
description: The size of the artifact in bytes.
type: number
url:
description: A URL to download the artifact.
type: string
usage:
$ref: '#/components/schemas/ArtifactUsage'
required:
- artifactType
- model
- sizeBytes
- url
- usage
type: object
ArtifactModel:
description: The model of the artifact, which indicates the type of process or operation it represents. For
example, an execution artifact represents a file that was processed, a fragment artifact represents a part
of a larger transaction, and a fault artifact represents an error that occurred during processing.
enum:
- execution
- fragment
- transaction
- fault
type: string
ArtifactType:
description: The format of the artifact.
enum:
- text/csv
- application/edifact
- application/filepart
- application/json
- application/pdf
- text/psv
- text/tsv
- application/edi-x12
- application/xml
- application/zip
- image/jpeg
- image/png
- image/tiff
- text/plain
- unknown
type: string
ArtifactUsage:
description: 'The type of data the artifact contains. For example, an input artifact represents the original
data Stedi received before processing, while an output artifact represents the processed data.
For example, for an inbound 835 ERA from a payer, the input artifact would be the original X12 EDI, and
the output artifact would be the JSON representation of the ERA.'
enum:
- attachment
- input
- metadata
- output
type: string
BadRequestExceptionResponseContent:
description: The server cannot process the request due to an apparent client error.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
BusinessIdentifier:
properties:
element:
description: The element where the business identifier was found. For example, `BHT03` for 837 claims.
type: string
elementId:
description: The identifier of the element containing the business identifier in the EDI specification.
type: string
name:
description: The friendly name of the business identifier. For example, `Originator Application Transaction
Identifier`.
type: string
value:
description: The value of the business identifier.
type: string
required:
- element
- elementId
- name
- value
type: object
CoreConnectionType:
description: The type of connection used for file delivery.
enum:
- BUCKET
- AS2
- STEDI_FTP
- REMOTE_FTP
- STEDI_ACCOUNT_FTP
type: string
Direction:
description: The direction of the transaction. Inbound transactions are those you receive from a payer, provider,
or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading
partner.
enum:
- INBOUND
- OUTBOUND
- UNKNOWN
type: string
ExceptionCause:
properties:
message:
type: string
name:
type: string
stack:
type: string
type: object
ExecutionFaultCode:
description: A code specifying the reason for the fault. This code appears in the `code` property of the HTTP
error response.
enum:
- DELIVERY_FAILURE
- FAILED_TO_EXTRACT_BUSINESS_IDENTIFIERS
- FAILED_TO_FIND_GUIDE
- FAILED_TO_FIND_LOCAL_PROFILE
- FAILED_TO_FIND_PARTNER_PROFILE
- FAILED_TO_FIND_PARTNERSHIP
- FAILED_TO_FIND_PROFILES
- FAILED_TO_FIND_RECEIVER_PROFILE
- FAILED_TO_FIND_SENDER_PROFILE
- FAILED_TO_FIND_CONNECTION
- FAILED_TO_GENERATE_CONTROL_NUMBERS
- FAILED_TO_PARSE
- FAILED_TO_PARSE_METADATA
- FAILED_TO_TRANSLATE
- FAILED_TO_ACK
- FAILED_TO_ACK_INTERCHANGE
- FILE_NOT_FOUND
- INVALID_EVENT
- INVALID_CONFIGURATION
- MISMATCHED_PARTNERSHIP_CONNECTION
- MISSING_FUNCTIONAL_GROUP_CONTROL_NUMBER
- MISSING_FUNCTIONAL_GROUP_RELEASE
- MISSING_INTERCHANGE_CONTROL_NUMBER
- MISSING_TRANSACTION_SET_CONTROL_NUMBER
- MISSING_RECEIVER_ID
- MISSING_RECEIVER_QUALIFIER
- MISSING_SENDER_ID
- MISSING_SENDER_QUALIFIER
- MULTIPLE_MATCHING_GUIDES
- MULTIPLE_MATCHING_TRANSACTION_SETTINGS
- MULTIPLE_PARTNERSHIPS
- NO_TRANSLATION_OUTPUT
- NO_TRANSACTION_SETS
- NOT_SUPPORTED
- NO_FUNCTIONAL_GROUPS
- NO_USAGE_INDICATOR_CODE
- PREVIOUSLY_RETRIED
- TRANSLATION_ERROR
- UNKNOWN_ERROR
type: string
ExecutionSource:
description: The source of the file, including the directory where Stedi received it and the file name.
properties:
dirname:
description: The directory where Stedi received the file for processing.
type: string
name:
description: The name of the file.
type: string
required:
- dirname
- name
type: object
ExecutionStatus:
description: "The status of the execution.\n - You can only retry executions with a `FAILED` or `IGNORED`\
\ status.\n - An execution is `COMPLETED` when Stedi has finished processing the file with no errors. If\
\ the file is an outbound file, a `COMPLETED` status also means that Stedi successfully delivered it to\
\ the configured connection."
enum:
- COMPLETED
- PARTIALLY_COMPLETED
- FAILED
- IGNORED
- IN_PROGRESS
- RETRYING
- RETRIED
- STARTED
type: string
ExecutionSummary:
description: The processed executions that match the request criteria. The `items` array is empty if there
are no matching executions.
properties:
childExecutionId:
description: The ID of this execution's child execution, if it is part of a retry chain. When you retry
a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution.
type: string
connectionId:
description: An autogenerated identifier for the connection within the Stedi platform.
pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
type: string
connectionType:
$ref: '#/components/schemas/CoreConnectionType'
createdAt:
description: The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
direction:
$ref: '#/components/schemas/Direction'
executionId:
description: A unique identifier for the processed file within Stedi. This ID is included in the transaction
processed event. You can also retrieve it manually from the file's details page in the Stedi portal.
type: string
faultCode:
$ref: '#/components/schemas/ExecutionFaultCode'
faultCount:
description: The number of errors that occurred during processing. If the file was successfully processed
completely, this value is `0`.
type: number
faultMessage:
description: A message providing more information about the fault. Note that if there are multiple faults,
Stedi sets the first fault as the code and corresponding message.
type: string
fileType:
$ref: '#/components/schemas/FileType'
parentExecutionId:
description: The ID of this execution's parent execution, if it is part of a retry chain. When you retry
a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution.
type: string
partnershipId:
description: 'The unique identifier for the partnership within the Stedi platform.
A partnership describes all aspects of the EDI relationship between two profiles in your Stedi account,
such as which transaction sets they will exchange and other important information for processing EDI
files.'
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
retryable:
description: If `true`, you can retry the file in the Stedi portal.
type: boolean
source:
$ref: '#/components/schemas/ExecutionSource'
status:
$ref: '#/components/schemas/ExecutionStatus'
transactionCount:
description: The number of individual transactions included in the file.
type: number
updatedAt:
description: The date and time when the resource was last updated, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
required:
- createdAt
- direction
- executionId
- status
- updatedAt
type: object
FileType:
description: The file format. For example, `EDI/EDIFACT` for an EDIFACT file or `EDI/X12` for an X12 EDI file.
enum:
- CSV
- EDI/EDIFACT
- FILEPART
- JSON
- PSV
- JSON/STEDI-GUIDE
- TSV
- UNKNOWN
- EDI/X12
- XML
- ZIP
type: string
GatewayTimeoutExceptionResponseContent:
description: The server was acting as a gateway or proxy and did not receive a timely response from the upstream
server.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
Index:
properties:
column:
description: The column number in the document where the problem occurred.
type: number
line:
description: The line number in the document where the problem occurred.
type: number
required:
- column
- line
type: object
ListPollingExecutionsResponseContent:
description: Common output structure for list operations with pagination support.
properties:
items:
items:
$ref: '#/components/schemas/ExecutionSummary'
type: array
nextPageToken:
description: Token that you can supply in subsequent requests to retrieve the next page of results. If
not returned, there are no more results.
maxLength: 1024
minLength: 1
type: string
required:
- items
type: object
ListPollingTransactionsResponseContent:
description: Common output structure for list operations with pagination support.
properties:
items:
items:
$ref: '#/components/schemas/TransactionSummary'
type: array
nextPageToken:
description: Token that you can supply in subsequent requests to retrieve the next page of results. If
not returned, there are no more results.
maxLength: 1024
minLength: 1
type: string
required:
- items
type: object
Mark:
description: The location in the document where the problem occurred. May be a single index or a range.
properties:
end:
$ref: '#/components/schemas/Index'
start:
$ref: '#/components/schemas/Index'
required:
- start
type: object
Mode:
description: Indicates whether the transaction contains test or production data. Stedi determines this from
the value in [`ISA15` Usage Indicator Code](https://www.stedi.com/edi/x12/segment/ISA#ISA-15).
enum:
- test
- production
- other
type: string
Partnership:
description: 'Information about the associated partnership.
A partnership describes all aspects of the EDI relationship between two profiles in your Stedi account,
such as which transaction sets they will exchange and other important information for processing EDI files.
If you''re sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary
partnership for you automatically when you set up your account.'
properties:
partnershipId:
description: 'The unique identifier for the partnership within the Stedi platform.
A partnership describes all aspects of the EDI relationship between two profiles in your Stedi account,
such as which transaction sets they will exchange and other important information for processing EDI
files. If you''re sending or receiving transactions through the Stedi clearinghouse, Stedi configures
the necessary partnerships for you automatically when you set up your account.'
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
partnershipType:
$ref: '#/components/schemas/PartnershipType'
receiver:
$ref: '#/components/schemas/PartnershipReceiver'
sender:
$ref: '#/components/schemas/PartnershipSender'
required:
- partnershipId
- partnershipType
- receiver
- sender
type: object
PartnershipReceiver:
description: The entity that is receiving the transaction.
properties:
profileId:
description: A unique identifier for the profile within the Stedi platform.
maxLength: 40
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
required:
- profileId
type: object
PartnershipSender:
description: The entity that initiated the transaction.
properties:
profileId:
description: A unique identifier for the profile within the Stedi platform.
maxLength: 40
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
required:
- profileId
type: object
PartnershipType:
description: The type of partnership, which determines the EDI standard used for exchanging transactions.
enum:
- x12
- edifact
type: string
ResourceNotFoundExceptionResponseContent:
description: The server response when the specified resource cannot be found after an API request passes authentication
and authorization.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
ResourceUnderChangeExceptionResponseContent:
properties:
message:
type: string
required:
- message
type: object
ServiceExceptionResponseContent:
properties:
exceptionCause:
$ref: '#/components/schemas/ExceptionCause'
message:
type: string
required:
- message
type: object
ServiceUnavailableExceptionResponseContent:
description: The server cannot handle the request due to technical reasons.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
ThrottlingExceptionResponseContent:
description: The server response when usage plan or account-level throttling limits exceeded.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
TransactionFragmentsSummary:
description: Details about fragments included in the transaction, if applicable. Fragments break large transactions
into smaller parts for easier processing and management.
properties:
batchSize:
description: The maximum size of each fragment in kilobytes (KB). Stedi uses this to automatically split
large inbound transactions into fragments.
type: number
fragmentCount:
description: The total number of fragments in the transaction.
type: number
keyName:
description: The JSON schema key name for the segment in the Stedi guide used to split the transaction
into fragments. For example, in an 834 Health Care Benefit Enrollment and Maintenance, this would be
`member_level_detail_INS_loop`.
type: string
required:
- batchSize
- fragmentCount
- keyName
type: object
TransactionStatus:
description: A status indicating whether Stedi was able to successfully process the transaction.
enum:
- failed
- succeeded
type: string
TransactionSummary:
description: The processed transactions that match the request criteria. The `items` array is empty if there
are no matching transactions.
properties:
artifacts:
description: A list of artifacts related to the transaction.
items:
$ref: '#/components/schemas/Artifact'
type: array
businessIdentifiers:
description: Any business identifiers extracted from the transaction.
items:
$ref: '#/components/schemas/BusinessIdentifier'
type: array
direction:
$ref: '#/components/schemas/Direction'
fileExecutionId:
description: A unique identifier for the processed file within Stedi. This ID is included in the transaction
processed event. You can also retrieve it manually from the file's details page in the Stedi portal.
type: string
fragments:
$ref: '#/components/schemas/TransactionFragmentsSummary'
mode:
$ref: '#/components/schemas/Mode'
partnership:
$ref: '#/components/schemas/Partnership'
processedAt:
description: The date and time when Stedi processed the transaction, in ISO 8601 format. For example,
`2023-08-28T00:00:00Z`.
format: date-time
type: string
status:
$ref: '#/components/schemas/TransactionStatus'
transactionId:
description: A unique identifier for the processed transaction within Stedi. This ID is included in the
transaction processed event. You can also retrieve it manually from the transaction's details page within
the Stedi portal.
type: string
translationErrors:
description: Details about errors that prevented Stedi from processing the transaction.
items:
$ref: '#/components/schemas/TranslationError'
type: array
x12:
$ref: '#/components/schemas/X12TransactionSummary'
required:
- artifacts
- direction
- fileExecutionId
- mode
- partnership
- processedAt
- status
- transactionId
type: object
TranslationError:
properties:
context:
$ref: '#/components/schemas/TranslationErrorContext'
mark:
$ref: '#/components/schemas/Mark'
message:
description: A message describing the error that occurred during translation.
type: string
required:
- message
type: object
TranslationErrorContext:
properties:
code:
description: The error code.
type: string
schemaPath:
description: The name of the JSON property where the error occurred.
type: string
type: object
UnauthorizedExceptionResponseContent:
description: The server response when the authorizer failed to authenticate the caller.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
UnprocessableEntityExceptionResponseContent:
description: The request parameters do not match a previous request with the same idempotency key.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
X12TransactionMetadata:
description: Metadata about the X12 EDI transaction, including information from the interchange, functional
group, and transaction headers as well as the sender and receiver IDs.
properties:
functionalGroup:
$ref: '#/components/schemas/X12TransactionMetadataFunctionalGroup'
interchange:
$ref: '#/components/schemas/X12TransactionMetadataInterchange'
receiver:
$ref: '#/components/schemas/X12TransactionMetadataProfile'
sender:
$ref: '#/components/schemas/X12TransactionMetadataProfile'
transaction:
$ref: '#/components/schemas/X12TransactionMetadataTransaction'
required:
- functionalGroup
- interchange
- receiver
- sender
- transaction
type: object
X12TransactionMetadataFunctionalGroup:
description: Data from the Functional Group Header of the X12 EDI file.
properties:
controlNumber:
description: The Group Control Number ([`GS06`](https://www.stedi.com/edi/x12/segment/GS#GS-06)).
maximum: 999999999
minimum: 0
type: number
date:
description: The date in the Functional Group Header ([`GS04`](https://www.stedi.com/edi/x12/segment/GS#GS-04)),
formatted as `YYYY-MM-DD`. For example, `2023-08-28`.
type: string
functionalIdentifierCode:
description: The Functional Identifier Code ([`GS01`](https://www.stedi.com/edi/x12/segment/GS#GS-01)),
which indicates the type of transaction. For example, `HC` for an 837 Healthcare Claim.
type: string
release:
description: The Version/Release/Industry Identifier Code ([`GS08`](https://www.stedi.com/edi/x12/segment/GS#GS-08)),
which indicates the version of the X12 standard used. For example, `005010X222A1`.
type: string
time:
description: The Time ([`GS05`](https://www.stedi.com/edi/x12/segment/GS#GS-05)), formatted as `HH:MM:SS`.
For example, `21:29:57`.
type: string
required:
- controlNumber
- date
- functionalIdentifierCode
- release
- time
type: object
X12TransactionMetadataInterchange:
description: Data from the Interchange Control Header of the X12 EDI file.
properties:
acknowledgmentRequestedCode:
description: The value of [`ISA14`](https://www.stedi.com/edi/x12/segment/ISA#ISA-14) in the Interchange
Control Header, which indicates whether the sender is requesting a [`TA1` Interchange Acknowledgment](https://www.stedi.com/edi/x12/segment/TA1).
type: string
controlNumber:
description: The control number in the Interchange Control Header.
maximum: 999999999
minimum: 0
type: number
required:
- acknowledgmentRequestedCode
- controlNumber
type: object
X12TransactionMetadataProfile:
description: The Application Code and ISA ID for the profile.
properties:
applicationCode:
description: The Application Code for the profile, which is used to identify the entity in the `GS` header
of an EDI file.
type: string
isa:
$ref: '#/components/schemas/X12TransactionMetadataProfileISA'
required:
- applicationCode
- isa
type: object
X12TransactionMetadataProfileISA:
description: The Interchange ID and qualifier.
properties:
id:
description: The Interchange ID, which is the unique identifier for the entity in the EDI file.
type: string
qualifier:
description: The Interchange Sender ID Qualifier, which indicates the type of identifier. For example,
`ZZ` for a mutually defined identifier.
type: string
required:
- id
- qualifier
type: object
X12TransactionMetadataTransaction:
description: Data from the Transaction Set Header of the X12 EDI file.
properties:
controlNumber:
description: The Transaction Set Control Number ([`ST02`](https://www.stedi.com/edi/x12/segment/ST#ST-02)).
type: string
transactionSetIdentifier:
description: The Transaction Set Identifier Code ([`ST01`](https://www.stedi.com/edi/x12/segment/ST#ST-01)),
which indicates the type of transaction. For example, `837` for an 837 Healthcare Claim.
type: string
required:
- controlNumber
- transactionSetIdentifier
type: object
X12TransactionSetting:
description: The IDs for the guide and transaction setting Stedi used to process the transaction.
properties:
guideId:
description: 'The unique identifier for the Stedi guide used to process the transaction.
Stedi guides are machine-readable specifications for X12 EDI transactions. They describe how to structure
and validate EDI files for each transaction type.'
type: string
transactionSettingId:
description: 'The unique identifier for the transaction setting Stedi used to process the transaction.
Transaction settings configure how Stedi processes specific transaction types, such as which Stedi guide
to use and other processing options. If you''re using the Stedi clearinghouse, Stedi automatically configures
the required transaction settings for you when you set up your account.'
type: string
type: object
X12TransactionSummary:
description: Details about the X12 EDI transaction.
properties:
metadata:
$ref: '#/components/schemas/X12TransactionMetadata'
transactionSetting:
$ref: '#/components/schemas/X12TransactionSetting'
required:
- metadata
type: object
securitySchemes:
httpApiKeyAuth:
description: A [Stedi API Key](https://www.stedi.com/app/settings/api-keys) for authentication.
in: header
name: Authorization
type: apiKey
info:
contact:
email: healthcare@stedi.com
license:
name: Proprietary
url: https://stedi.com
title: Stedi Healthcare Claims Claim acknowledgments Polling API
version: '2025-03-07'
openapi: 3.0.3
paths:
/polling/executions:
get:
description: Poll for new file executions that Stedi has recently processed.
operationId: ListPollingExecutions
parameters:
- description: The maximum number of elements to return in a page. You can set this to a maximum of 500 elements.
If not specified, the default is 100.
examples:
ListPollingExecutions_example1:
description: ''
summary: List executions
value: 200
in: query
name: pageSize
schema:
description: The maximum number of elements to return in a page. You can set this to a maximum of 500
elements. If not specified, the default is 100.
minimum: 1
type: number
- description: 'A token returned by a previous call to this operation in the `nextPageToken`. If not specified,
Stedi returns the first page of results.
You must supply either this property or `startDateTime` in every request.'
in: query
name: pageToken
schema:
description: 'A token returned by a previous call to this operation in the `nextPageToken`. If not specified,
Stedi returns the first page of results.
You must supply either this property or `startDateTime` in every request.'
maxLength: 1024
minLength: 1
type: string
- description: 'An ISO 8601 formatted string. For example `2023-08-28T00:00:00Z`. Stedi returns executions
processed after this time.
You must supply either this property or `pageToken` in every request. The `startDateTime` must be at least
one minute in the past.'
in: query
name: startDateTime
schema:
description: 'An ISO 8601 formatted string. For example `2023-08-28T00:00:00Z`. Stedi returns executions
processed after this time.
You must supply either this property or `pageToken` in every request. The `startDateTime` must be at
least one minute in the past.'
format: date-time
type: string
responses:
'200':
content:
application/json:
examples:
ListPollingExecutions_example1:
description: ''
summary: List executions
value:
items:
- createdAt: '2025-04-04T17:14:35.481Z'
direction: INBOUND
executionId: 55907f88-999e-4912-9e9b-78326f8bade8
faultCount: 0
partnershipId: local-clearinghouse-test
retryable: true
source:
dirname: .
name: test-inbound-ingest-30848232-fa0c-4151-8217-d03205e806f9.edi
status: COMPLETED
transactionCount: 1
updatedAt: '2025-04-04T17:14:42.854Z'
- createdAt: '2025-04-02T21:30:08.387Z'
direction: INBOUND
executionId: 95236a56-a020-4522-8fef-bcffcec0ec1d
faultCount: 0
partnershipId: local-clearinghouse-test
retryable: true
source:
dirname: .
name: test-inbound-ingest-3f2efd94-2a81-4b57-b4de-9b970a50db60.edi
status: COMPLETED
transactionCount: 1
updatedAt: '2025-04-02T21:30:16.185Z'
- createdAt: '2025-02-28T19:16:26.041Z'
direction: OUTBOUND
executionId: 06bdccdc-4ab9-4add-b1dc-a76a0183f299
faultCount: 0
partnershipId: local-clearinghouse-test
retryable: true
source:
dirname: .
name: 837-clearinghouse_outbound.edi
status: COMPLETED
transactionCount: 1
updatedAt: '2025-02-28T19:16:27.706Z'
nextPageToken: eyJwYWdlIjoxLCJwYWdlU2l6ZSI6MTAsInBhZ2VUb3RhbCI6MzE0fQ==
schema:
$ref: '#/components/schemas/ListPollingExecutionsResponseContent'
description: ListPollingExecutions 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestExceptionResponseContent'
description: BadRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
description: UnauthorizedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
description: AccessDeniedException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
description: ResourceNotFoundException 404 response
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUn
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/openapi/stedi-polling-api-openapi.yml