Stedi OpenAPI

https://github.com/stedi/openapi
Admin
Stedi OpenAPI provides public OpenAPI specifications for Stedi's APIs, enabling developers to...
Tokens:32,280
Snippets:435
Trust Score:7.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /enrollments

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Retrieves a list of enrollments with optional filtering and pagination.

```APIDOC
## GET /enrollments

### Description
Lists provider enrollments, supporting filtering by status, NPI, tax ID, and provider name, as well as pagination.

### Method
GET

### Endpoint
/enrollments

### Parameters
#### Query Parameters
- **pageSize** (number) - Optional - The maximum number of elements to return in a page.
- **pageToken** (string) - Optional - The nextPageToken value from a previous response.
- **filter** (string) - Optional - Filter for enrollments with properties matching a query string (provider name, NPI, tax ID, or Stedi payer ID).
- **status** (array) - Optional - Filter for enrollments with specific statuses.
- **providerNpis** (array) - Optional - Filter for enrollments associated with specific provider NPIs.
- **providerTaxIds** (array) - Optional - Filter for enrollments associated with specific provider tax IDs.
- **providerNames** (array) - Optional - Filter for enrollments associated with specific provider names.
```

--------------------------------

### GET /destinations

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Retrieves a list of all configured webhook destinations.

```APIDOC
## GET /destinations

### Description
Lists all webhook destinations.

### Method
GET

### Endpoint
/destinations
```

--------------------------------

### GET /events

Source: https://github.com/stedi/openapi/blob/main/_autodocs/event-destinations-api-reference.md

Retrieves a list of events.

```APIDOC
## GET /events

### Description
Retrieves a list of events.

### Method
GET

### Endpoint
/events

### Response
#### Success Response (200)
- **EventDestinationsListEvents** - 200 response

#### Error Responses
- **400** - ValidationException
- **401** - UnauthorizedException
- **403** - AccessDeniedException
- **500** - InternalFailureException
```

--------------------------------

### GET /documents/{documentId}/download

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Initiates a download for a specific enrollment document.

```APIDOC
## GET /documents/{documentId}/download

### Description
Creates a download link or process for a specific enrollment document identified by its ID.

### Method
GET

### Endpoint
/documents/{documentId}/download

### Parameters
#### Path Parameters
- **documentId** (string) - Required - The document ID for the PDF document you want to download.
```

--------------------------------

### GET /providers

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Retrieves a list of providers with optional filtering and pagination.

```APIDOC
## GET /providers

### Description
Lists providers based on optional filters such as name, NPI, or tax ID.

### Method
GET

### Endpoint
/providers

### Parameters
#### Query Parameters
- **pageSize** (number) - Optional - The maximum number of elements to return.
- **pageToken** (string) - Optional - The nextPageToken value from a previous response.
- **filter** (string) - Optional - Filter for providers matching a query string.
- **providerNpis** (array) - Optional - Filter for providers with specific NPIs.
- **providerTaxIds** (array) - Optional - Filter for providers with specific tax IDs.

### Response
#### Success Response (200)
- **200** - ListProviders 200 response
```

--------------------------------

### GET /enrollments/{enrollmentId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Retrieves details for a specific enrollment record.

```APIDOC
## GET /enrollments/{enrollmentId}

### Description
Retrieves details for a specific enrollment record.

### Method
GET

### Endpoint
/enrollments/{enrollmentId}

### Parameters
#### Path Parameters
- **enrollmentId** (string) - Required - The Stedi-assigned identifier for the enrollment you want to retrieve.

### Response
#### Success Response (200)
- **GetEnrollment** (object) - 200 response
```

--------------------------------

### GET /executions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Fetch a list of executions, sorted by the date they were created from newest to oldest.

```APIDOC
## GET /executions

### Description
Fetch a list of executions, sorted by the date they were created from newest to oldest.

### Method
GET

### Endpoint
/executions

### Parameters
#### Query Parameters
- **pageSize** (number) - Optional - The maximum number of elements to return in a page.
- **pageToken** (string) - Optional - An opaque token returned by a previous call to this operation.
- **direction** (string) - Optional - The direction of the transaction (Inbound or Outbound).
- **faultCode** (string) - Optional - A code specifying the reason for the fault.
- **partnershipId** (string) - Optional - The unique identifier for the partnership.
- **status** (string) - Optional - The status of the execution.
- **from** (string) - Optional - The start of the time range to filter file executions.
- **to** (string) - Optional - The end of the time range to filter file executions.
- **displayName** (string) - Optional - Filter executions by the source of the file.

### Response
#### Success Response (200)
- **200** - ListExecutions 200 response
```

--------------------------------

### GET /eligibility-manager/batch/{batchId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/manager-api-complete.md

Retrieves details for a specific batch by its ID.

```APIDOC
## GET /eligibility-manager/batch/{batchId}

### Description
Retrieves details for a specific batch by its ID.

### Parameters
#### Path Parameters
- **batchId** (string) - Required - The unique identifier of the batch.
```

--------------------------------

### GET /payers

Source: https://github.com/stedi/openapi/blob/main/_autodocs/payers-api-reference.md

Lists all available payer records.

```APIDOC
## GET /payers

### Description
Lists all available payer records.

### Method
GET

### Endpoint
/payers
```

--------------------------------

### GET /enrollments

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Retrieves a list of enrollments based on optional query parameters for filtering.

```APIDOC
## GET /enrollments

### Description
Retrieves a list of enrollments. You can filter the results using various query parameters.

### Method
GET

### Endpoint
/enrollments

### Parameters
#### Query Parameters
- **providerNames** (array) - Optional - Filter for enrollments associated with specific provider names.
- **providerIds** (array) - Optional - Filter for enrollments associated with specific provider IDs (UUIDs).
- **payerIds** (array) - Optional - Filter for enrollments associated with specific Stedi payer IDs.
- **sources** (array) - Optional - Filter for enrollments submitted through specific sources (e.g., API, UI).
- **transactions** (array) - Optional - Filter for enrollments for specific transaction types.
- **createdFrom** (string) - Optional - Filter for enrollments created on or after this date (ISO 8601).
- **createdTo** (string) - Optional - Filter for enrollments created before this date (ISO 8601).
- **statusUpdatedFrom** (string) - Optional - Filter for enrollments whose status was last updated on or after this date (ISO 8601).
- **statusUpdatedTo** (string) - Optional - Filter for enrollments whose status was last updated before this date (ISO 8601).
- **importId** (string) - Optional - Filter by the import ID associated with a CSV bulk import.
- **requestedEffectiveDateFrom** (string) - Optional - Filter for enrollments with a requested effective date on or after this date (YYYYMMDD).
- **requestedEffectiveDateTo** (string) - Optional - Filter for enrollments with a requested effective date on or before this date (YYYYMMDD).
- **lastEraReceivedFrom** (string) - Optional - Filter for enrollments with a lastEraReceivedAt timestamp on or after this value (ISO 8601).
- **lastEraReceivedTo** (string) - Optional - Filter for enrollments with a lastEraReceivedAt timestamp on or before this value (ISO 8601).
```

--------------------------------

### GET /transactions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Fetch a list of transactions, sorted by the date they were created from newest to oldest.

```APIDOC
## GET /transactions

### Description
Fetch a list of transactions, sorted by the date they were created from newest to oldest.

### Method
GET

### Endpoint
/transactions

### Parameters
#### Query Parameters
- **pageSize** (number) - Optional - 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.
- **pageToken** (string) - Optional - A token returned by a previous call to this operation in the nextPageToken. If not specified, Stedi returns the first page of results.
- **businessIdentifier** (string) - Optional - List only transactions containing a business identifier with the given value.
- **transactionSetId** (string) - Optional - List only a given type of transaction. Accepts any valid 3-digit X12 Transaction Set Identifier Code.
- **sender** (string) - Optional - List only transactions sent by the given profile. This is the profile ID of the sender.
- **receiver** (string) - Optional - List only transactions sent to the given profile. This is the profile ID of the receiver.
- **direction** (string) - Optional - The direction of the transaction. Inbound or Outbound.
- **mode** (string) - Optional - Indicates whether the transaction contains test or production data.
- **status** (string) - Optional - A status indicating whether Stedi was able to successfully process the transaction.
- **from** (string) - Optional - The start of the time range to filter transactions.
- **to** (string) - Optional - The end of the time range to filter transactions.
- **elementId** (string) - Optional - List only transactions containing a business identifier with the given element ID.
- **partnershipId** (string) - Optional - List only transactions that were sent or received on the given partnership.

### Response
#### Success Response (200)
- **ListTransactions** (object) - 200 response
```

--------------------------------

### GET /eligibility-manager/polling/batch-eligibility

Source: https://github.com/stedi/openapi/blob/main/_autodocs/manager-api-complete.md

Polls for the status of batch eligibility checks.

```APIDOC
## GET /eligibility-manager/polling/batch-eligibility

### Description
Polls for the status of batch eligibility checks.
```

--------------------------------

### GET /payers/search

Source: https://github.com/stedi/openapi/blob/main/_autodocs/healthcare-api-complete.md

Searches for payers within the system.

```APIDOC
## GET /payers/search

### Description
Searches for payers based on provided criteria.

### Method
GET

### Endpoint
/payers/search
```

--------------------------------

### GET /executions/{executionId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Retrieve details for a specific execution.

```APIDOC
## GET /executions/{executionId}

### Description
Get execution details.

### Method
GET

### Endpoint
/executions/{executionId}

### Parameters
#### Path Parameters
- **executionId** (string) - Required - The unique identifier of the execution.
```

--------------------------------

### GET /executions/{executionId}/output-url

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve an execution's output document download URL.

```APIDOC
## GET /executions/{executionId}/output-url

### Description
This endpoint is used to retrieve an execution's output document. This endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.

### Method
GET

### Endpoint
/executions/{executionId}/output-url

### Parameters
#### Path Parameters
- **executionId** (string) - Required

### Response
#### Success Response (200)
- GetExecutionOutputDocumentUrl 200 response
```

--------------------------------

### GET /eligibility-manager/batch/{batchId}/items

Source: https://github.com/stedi/openapi/blob/main/_autodocs/manager-api-complete.md

Retrieves the items associated with a specific batch.

```APIDOC
## GET /eligibility-manager/batch/{batchId}/items

### Description
Retrieves the items associated with a specific batch.

### Parameters
#### Path Parameters
- **batchId** (string) - Required - The unique identifier of the batch.
```

--------------------------------

### GET /polling/executions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Poll for new file executions that Stedi has recently processed.

```APIDOC
## GET /polling/executions

### Description
Poll for new file executions that Stedi has recently processed.

### Method
GET

### Endpoint
/polling/executions

### Parameters
#### Query Parameters
- **pageSize** (number) - Optional - The maximum number of elements to return in a page.
- **pageToken** (string) - Optional - A token returned by a previous call to this operation in the nextPageToken.
- **startDateTime** (string) - Optional - An ISO 8601 formatted string. Stedi returns executions processed after this time.

### Response
#### Success Response (200)
- **200** - ListPollingExecutions 200 response
```

--------------------------------

### GET /executions/{executionId}/output

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-endpoints-complete.md

Retrieves the output document for a specific execution.

```APIDOC
## GET /executions/{executionId}/output

### Description
Get execution output for a specific execution ID.

### Method
GET

### Endpoint
/executions/{executionId}/output

### Parameters
#### Path Parameters
- **executionId** (string) - Required - The unique identifier for the execution.
```

--------------------------------

### GET /events/{eventId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/event-destinations-api-reference.md

Retrieves details for a specific event by its ID.

```APIDOC
## GET /events/{eventId}

### Description
Retrieves details for a specific event by its ID.

### Method
GET

### Endpoint
/events/{eventId}

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The unique identifier of the event.

### Response
#### Success Response (200)
- **EventDestinationsGetEvent** - 200 response

#### Error Responses
- **400** - ValidationException
- **401** - UnauthorizedException
- **403** - AccessDeniedException
- **404** - ResourceNotFoundException
- **500** - InternalFailureException
```

--------------------------------

### GET /claims/{claimId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Retrieve the details and processing status of a specific claim.

```APIDOC
## GET /claims/{claimId}

### Description
Get claim details and status tracking information.

### Method
GET

### Endpoint
/claims/{claimId}

### Parameters
#### Path Parameters
- **claimId** (string) - Required - The unique identifier of the claim.
```

--------------------------------

### GET /executions/{executionId}/faults

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Fetch a list of faults for a given file execution, sorted by the date they were created from newest to oldest.

```APIDOC
## GET /executions/{executionId}/faults

### Description
Fetch a list of faults for a given file execution, sorted by the date they were created from newest to oldest.

### Method
GET

### Endpoint
/executions/{executionId}/faults

### Parameters
#### Path Parameters
- **executionId** (string) - Required - A unique identifier for the file execution within Stedi.

#### Query Parameters
- **pageSize** (number) - Optional - The maximum number of elements to return in a page.
- **pageToken** (string) - Optional - An opaque token returned by a previous call to this operation.
```

--------------------------------

### GET /transactions/{transactionId}/output

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve a transaction's output document.

```APIDOC
## GET /transactions/{transactionId}/output

### Description
Retrieve a transaction's output document.

### Method
GET

### Endpoint
/transactions/{transactionId}/output

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.

### Response
#### Success Response (302)
- **302** - GetTransactionOutputDocument 302 response
```

--------------------------------

### GET /executions/{executionId}/output

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Fetch a file execution's output document, available for outbound files.

```APIDOC
## GET /executions/{executionId}/output

### Description
Fetch a file execution's output document. Only available for outbound files.

### Method
GET

### Endpoint
/executions/{executionId}/output

### Parameters
#### Path Parameters
- **executionId** (string) - Required - A unique identifier for the file execution within Stedi. This ID is included in the file delivered event, or you can retrieve it manually from the file's details page within the Stedi portal.

### Response
#### Success Response (302)
- GetExecutionOutputDocument 302 response
```

--------------------------------

### GET /eligibility-manager/eligibility-checks/{eligibilityCheckId}/pdf

Source: https://github.com/stedi/openapi/blob/main/_autodocs/manager-api-complete.md

Retrieves the PDF report for a specific eligibility check.

```APIDOC
## GET /eligibility-manager/eligibility-checks/{eligibilityCheckId}/pdf

### Description
Retrieves the PDF report for a specific eligibility check.

### Parameters
#### Path Parameters
- **eligibilityCheckId** (string) - Required - The unique identifier of the eligibility check.
```

--------------------------------

### GET /executions/{executionId}/metadata

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Fetch a file execution's metadata document.

```APIDOC
## GET /executions/{executionId}/metadata

### Description
Fetch a file execution's metadata document.

### Method
GET

### Endpoint
/executions/{executionId}/metadata

### Parameters
#### Path Parameters
- **executionId** (string) - Required - A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.

### Response
#### Success Response (302)
- GetExecutionMetadataDocument 302 response
```

--------------------------------

### GET /destinations/{destinationId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Retrieves the details of a specific webhook destination by its ID.

```APIDOC
## GET /destinations/{destinationId}

### Description
Get destination details.

### Method
GET

### Endpoint
/destinations/{destinationId}

### Parameters
#### Path Parameters
- **destinationId** (string) - Required - The unique identifier of the destination.
```

--------------------------------

### GET /payers/csv

Source: https://github.com/stedi/openapi/blob/main/_autodocs/endpoints.md

Retrieves a list of Stedi's supported payers in CSV format.

```APIDOC
## GET /payers/csv

### Description
List Stedi's supported payers in CSV format.

### Method
GET

### Endpoint
/payers/csv

### Response
#### Success Response (200)
- **Content-Type** (text/plain) - ListPayerRecordsCsv 200 response

#### Error Responses
- **400** - ValidationException
- **403** - AccessDeniedException
- **404** - ResourceNotFoundException
- **429** - ThrottlingException
- **500** - InternalFailureException
- **503** - ServiceUnavailableException
- **504** - GatewayTimeoutException
```

--------------------------------

### GET /executions/{executionId}/transactions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Fetch a list of transactions for a file execution, including the full transaction details.

```APIDOC
## GET /executions/{executionId}/transactions

### Description
Fetch a list of transactions for a file execution, including the full transaction details.

### Method
GET

### Endpoint
/executions/{executionId}/transactions

### Parameters
#### Path Parameters
- **executionId** (string) - Required - A unique identifier for the file execution within Stedi.

#### Query Parameters
- **pageSize** (number) - Optional - The maximum number of elements to return in a page (max 500, default 100).
- **pageToken** (string) - Optional - A token returned by a previous call to this operation in the nextPageToken.

### Response
#### Success Response (200)
- **200** - ListExecutionTransactions 200 response
```

--------------------------------

### GET /executions/{executionId}/input-url

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve an execution's input document download URL before it passes through any translation and mappings.

```APIDOC
## GET /executions/{executionId}/input-url

### Description
This endpoint is used to retrieve an execution's input document before it passes through any translation and mappings. This endpoint returns the document download URL.

### Method
GET

### Endpoint
/executions/{executionId}/input-url

### Parameters
#### Path Parameters
- **executionId** (string) - Required - A unique identifier for the file execution within Stedi.
```

--------------------------------

### GET /executions/{executionId}/input

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Fetch a file execution's input document before any translation and mappings.

```APIDOC
## GET /executions/{executionId}/input

### Description
Fetch a file execution's input document before any translation and mappings.

### Method
GET

### Endpoint
/executions/{executionId}/input

### Parameters
#### Path Parameters
- **executionId** (string) - Required - A unique identifier for the file execution within Stedi.
```

--------------------------------

### GET /transactions/{transactionId}/output-url

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-endpoints-complete.md

Retrieve a transaction's output document URL.

```APIDOC
## GET /transactions/{transactionId}/output-url

### Description
This endpoint is used to retrieve a transaction's output document url after it has been translated via Core. This endpoint returns the document download URL, which must then be fetched for the actual document content.

### Method
GET

### Endpoint
/transactions/{transactionId}/output-url

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi.

### Response
#### Success Response (200)
- **GetTransactionOutputDocumentUrlResponseContent** (object) - Contains the document download URL.
```

--------------------------------

### GET /executions/{executionId}/metadata-url

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve a file execution's metadata document download URL, limited to inbound/outbound x12 files.

```APIDOC
## GET /executions/{executionId}/metadata-url

### Description
This endpoint is used to retrieve a file execution's metadata document, limited to inbound/outbound x12 files. This endpoint returns the metadata document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.

### Method
GET

### Endpoint
/executions/{executionId}/metadata-url

### Parameters
#### Path Parameters
- **executionId** (string) - Required

### Response
#### Success Response (200)
- GetExecutionMetadataDocumentUrl 200 response
```

--------------------------------

### GET /transactions/{transactionId}/fragments/{fragmentIndex}/output

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve a transaction fragment's output document after it has been translated.

```APIDOC
## GET /transactions/{transactionId}/fragments/{fragmentIndex}/output

### Description
Retrieve a transaction fragment's output document after it has been translated.

### Method
GET

### Endpoint
/transactions/{transactionId}/fragments/{fragmentIndex}/output

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi.
- **fragmentIndex** (number) - Required - The identifier for a specific fragment within a processed transaction.

### Response
#### Success Response (302)
- **302** - GetTransactionFragmentOutputDocument 302 response
```

--------------------------------

### GET /transactions/{transactionId}/attachment/{artifactId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve a transaction's output document directly.

```APIDOC
## GET /transactions/{transactionId}/attachment/{artifactId}

### Description
Retrieve a transaction's output document.

### Method
GET

### Endpoint
/transactions/{transactionId}/attachment/{artifactId}

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi.
- **artifactId** (string) - Required - A unique identifier for the artifact within Stedi.

### Response
#### Success Response (302)
- **GetTransactionAttachmentDocument** (redirect) - 302 response
```

--------------------------------

### GET /electronic-remittance-advice/{transactionId}/pdf

Source: https://github.com/stedi/openapi/blob/main/_autodocs/healthcare-api-reference.md

Retrieve the generated PDF of an 835 Electronic Remittance Advice (ERA).

```APIDOC
## GET /electronic-remittance-advice/{transactionId}/pdf

### Description
Retrieve the generated PDF of an 835 Electronic Remittance Advice (ERA).

### Method
GET

### Endpoint
/electronic-remittance-advice/{transactionId}/pdf

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the Electronic Remittance Advice (ERA) within Stedi.

#### Query Parameters
- **logo** (boolean) - Optional - If false, the generated PDF will not include the Stedi logo in the footer. The default is true.

### Response
#### Success Response (200)
- **GetElectronicRemittanceAdvicePdf** (object) - 200 response
```

--------------------------------

### GET /transactions/{transactionId}/fragments/{fragmentIndex}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve metadata for a specific fragment within a processed transaction.

```APIDOC
## GET /transactions/{transactionId}/fragments/{fragmentIndex}

### Description
Retrieve metadata for a fragment.

### Method
GET

### Endpoint
/transactions/{transactionId}/fragments/{fragmentIndex}

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi.
- **fragmentIndex** (number) - Required - The identifier for a specific fragment within a processed transaction.

### Response
#### Success Response (200)
- **200** - GetTransactionFragment 200 response
```

--------------------------------

### GET /export/pdf

Source: https://github.com/stedi/openapi/blob/main/_autodocs/healthcare-api-reference.md

Retrieve a Stedi generated CMS-1500 Claim Form PDF for a submitted 837P (professional) claim by business identifier.

```APIDOC
## GET /export/pdf

### Description
Retrieve a Stedi generated CMS-1500 Claim Form PDF for a submitted 837P (professional) claim by business identifier.

### Method
GET

### Endpoint
/export/pdf

### Parameters
#### Query Parameters
- **businessId** (string) - Required - The business identifier for the claim PDF you want to retrieve.
- **background** (boolean) - Optional - If false, the generated PDF will only contain the form data on a white background. The default is true.

### Response
#### Success Response (200)
- **ExportPDF** (object) - 200 response
```

--------------------------------

### GET /polling/transactions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-endpoints-complete.md

Polls for the status of transactions.

```APIDOC
## GET /polling/transactions

### Description
Poll for transaction status.

### Method
GET

### Endpoint
/polling/transactions
```

--------------------------------

### View Documentation File Structure

Source: https://github.com/stedi/openapi/blob/main/_autodocs/README.md

Displays the directory tree for the documentation workspace.

```text
/workspace/home/output/
├── INDEX.md                              # Master index
├── README.md                             # This file
├── api-overview.md                       # API services overview
├── quick-reference.md                    # Quick lookup
├── api-service-details.md                # Service details
│
├── [API References]
├── core-api-reference.md
├── core-api.md
├── core-endpoints-complete.md
├── healthcare-api-reference.md
├── healthcare-api-complete.md
├── enrollment-api-reference.md
├── enrollment-api-complete.md
├── claims-api-reference.md
├── manager-api-reference.md
├── payers-api-reference.md
├── event-destinations-api-reference.md
│
├── [Comprehensive Guides]
├── endpoints.md
├── parameters-and-requests.md
├── response-types-and-status-codes.md
├── data-types-and-fields.md
├── types.md
├── integration-patterns.md
├── security-and-authentication.md
│
└── [Schema References]
    ├── core-schemas.md
    └── healthcare-schemas.md
```

--------------------------------

### GET /transactions/{transactionId}/fragments/{fragmentIndex}/output-url

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve a transaction fragment's output document URL after it has been translated.

```APIDOC
## GET /transactions/{transactionId}/fragments/{fragmentIndex}/output-url

### Description
This endpoint is used to retrieve a transaction fragment's output document URL after it has been translated via Core. This endpoint returns the document download URL, it must be then fetched for the actual document content.

### Method
GET

### Endpoint
/transactions/{transactionId}/fragments/{fragmentIndex}/output-url

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi.
- **fragmentIndex** (number) - Required - The identifier for a specific fragment within a processed transaction.

### Response
#### Success Response (200)
- **200** - GetTransactionFragmentOutputDocumentUrl 200 response
```

--------------------------------

### GET /polling/executions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-endpoints-complete.md

Polls for the status of executions.

```APIDOC
## GET /polling/executions

### Description
Poll for execution status.

### Method
GET

### Endpoint
/polling/executions
```

--------------------------------

### POST /executions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Create a new execution.

```APIDOC
## POST /executions

### Description
Create a new execution.

### Method
POST

### Endpoint
/executions
```

--------------------------------

### GET /providers/{providerId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-reference.md

Retrieves a provider record by its ID. This operation returns the complete provider details including contact information.

```APIDOC
## GET /providers/{providerId}

### Description
Retrieves a provider record by its ID. This operation returns the complete provider details including contact information.

### Method
GET

### Endpoint
/providers/{providerId}

### Parameters
#### Path Parameters
- **providerId** (string) - Required - The unique ID Stedi assigned to the provider when it was created in the system.

### Response
#### Success Response (200)
- **GetProvider** (object) - 200 response
```

--------------------------------

### POST /enrollments

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Creates a new enrollment record.

```APIDOC
## POST /enrollments

### Description
Creates a new enrollment record.

### Method
POST

### Endpoint
/enrollments

### Request Body
- **Content-Type** (string) - Required - application/json

### Response
#### Success Response (200)
- **CreateEnrollment** (object) - 200 response
```

--------------------------------

### GET /transactions/{transactionId}/attachment/{artifactId}/url

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve a download URL for a transaction's attachment document.

```APIDOC
## GET /transactions/{transactionId}/attachment/{artifactId}/url

### Description
This endpoint is used to retrieve a transaction's attachment document url. This endpoint returns the document download URL, it must be then fetched for the actual document content.

### Method
GET

### Endpoint
/transactions/{transactionId}/attachment/{artifactId}/url

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi.
- **artifactId** (string) - Required - A unique identifier for the artifact within Stedi.

### Response
#### Success Response (200)
- **GetTransactionAttachmentDocumentUrl** (object) - 200 response
```

--------------------------------

### GET /polling/transactions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Poll for new transactions that Stedi has processed.

```APIDOC
## GET /polling/transactions

### Description
Poll for new transactions that Stedi has processed.

### Method
GET

### Endpoint
/polling/transactions

### Parameters
#### Query Parameters
- **pageSize** (number) - Optional - 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.
- **pageToken** (string) - Optional - 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.
- **startDateTime** (string) - Optional - An ISO 8601 formatted string. For example 2023-08-28T00:00:00Z. It must be at least one minute in the past. Stedi returns transactions processed after this time. You must supply either this property or pageToken in every request.

### Response
#### Success Response (200)
- **ListPollingTransactions** (object) - 200 response
```

--------------------------------

### POST /enrollments/{enrollmentId}/documents

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-reference.md

Generates a pre-signed URL for uploading a PDF document to an enrollment.

```APIDOC
## POST /enrollments/{enrollmentId}/documents

### Description
Returns a pre-signed URL to upload a PDF document for the specified transaction enrollment.

### Method
POST

### Endpoint
/enrollments/{enrollmentId}/documents

### Parameters
#### Path Parameters
- **enrollmentId** (string) - Required - The enrollment ID for the transaction enrollment where you want to upload the PDF document.

### Response
#### Success Response (200)
- **200** - CreateEnrollmentDocumentUpload 200 response
```

--------------------------------

### POST /eligibility-manager/batch-eligibility

Source: https://github.com/stedi/openapi/blob/main/_autodocs/manager-api-complete.md

Initiates a batch eligibility check process.

```APIDOC
## POST /eligibility-manager/batch-eligibility

### Description
Initiates a batch eligibility check process.
```

--------------------------------

### POST /providers

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Creates a new provider record.

```APIDOC
## POST /providers

### Description
Creates a new provider in the system.

### Method
POST

### Endpoint
/providers

### Response
#### Success Response (200)
- **200** - CreateProvider 200 response
```

--------------------------------

### Pagination Pattern

Source: https://github.com/stedi/openapi/blob/main/_autodocs/integration-patterns.md

Use limit and offset parameters to retrieve paginated lists. Some endpoints may require a next_token instead of an offset.

```http
GET /endpoint?limit=50&offset=0
```

--------------------------------

### POST /partnerships/{partnershipId}/transactions/{transactionSettingId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Generates and delivers fully-formed EDI files containing a single transaction.

```APIDOC
## POST /partnerships/{partnershipId}/transactions/{transactionSettingId}

### Description
This endpoint generates and delivers fully-formed EDI files containing a single transaction. It is the simplest way to generate EDI with Stedi.

### Method
POST

### Endpoint
/partnerships/{partnershipId}/transactions/{transactionSettingId}

### Parameters
#### Path Parameters
- **partnershipId** (string) - Required - A unique ID for this partnership within Stedi.
- **transactionSettingId** (string) - Required - A unique ID for the outbound transaction setting Stedi should use to determine the correct guide for validation and generation.

#### Header Parameters
- **Idempotency-Key** (string) - Optional - A unique string to identify this request to the server.

### Response
#### Success Response (200)
- **200** - CreatePartnershipOutboundTransaction 200 response
```

--------------------------------

### POST /events

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Creates and publishes a new event.

```APIDOC
## POST /events

### Description
Create and publish events.

### Method
POST

### Endpoint
/events
```

--------------------------------

### Enrollment Query Parameters

Source: https://github.com/stedi/openapi/blob/main/_autodocs/parameters-and-requests.md

Filtering options for retrieving enrollment lists.

```APIDOC
## Query Parameters for Enrollments

### Parameters
#### Query Parameters
- **statusUpdatedFrom** (string) - Optional - Filter for enrollments with statusLastUpdatedAt on or after this date.
- **statusUpdatedTo** (string) - Optional - Filter for enrollments with statusLastUpdatedAt before this date.
- **transactions** (array) - Optional - Filter for enrollments for specific transaction types (e.g., eligibilityCheck, claimStatus).
- **userEmails** (array) - Optional - Filter for enrollments associated with specific submitter emails.
```

--------------------------------

### GET /payers/csv

Source: https://github.com/stedi/openapi/blob/main/_autodocs/payers-api-reference.md

Retrieves a list of payer records in CSV format.

```APIDOC
## GET /payers/csv

### Description
Retrieves a list of payer records in CSV format.

### Method
GET

### Endpoint
/payers/csv
```

--------------------------------

### POST /claim-attachments/file

Source: https://github.com/stedi/openapi/blob/main/_autodocs/claims-api-reference.md

Generates a pre-signed URL to upload a 275 claim attachment file.

```APIDOC
## POST /claim-attachments/file

### Description
Generate a pre-signed URL to upload a 275 claim attachment file.

### Method
POST

### Endpoint
/claim-attachments/file

### Request Body
- **Content-Type**: application/json
- **Schema**: CreateClaimAttachmentFileRequestContent

### Response
#### Success Response (201)
- CreateClaimAttachmentFile 201 response

#### Error Responses
- 400: ValidationException
- 403: AccessDeniedException
- 404: ResourceNotFoundException
- 429: ThrottlingException
- 500: InternalFailureException
```

--------------------------------

### POST /destinations

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Creates a new webhook destination for event delivery.

```APIDOC
## POST /destinations

### Description
Creates a new webhook destination configuration.

### Method
POST

### Endpoint
/destinations
```

--------------------------------

### GET /executions/{executionId}/faults

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-endpoints-complete.md

Retrieves any faults associated with a specific execution.

```APIDOC
## GET /executions/{executionId}/faults

### Description
Get execution faults for a specific execution ID.

### Method
GET

### Endpoint
/executions/{executionId}/faults

### Parameters
#### Path Parameters
- **executionId** (string) - Required - The unique identifier for the execution.
```

--------------------------------

### POST /eligibility-manager/batch-eligibility

Source: https://github.com/stedi/openapi/blob/main/_autodocs/manager-api-reference.md

Submit multiple eligibility checks for Stedi to process asynchronously.

```APIDOC
## POST /eligibility-manager/batch-eligibility

### Description
Submit multiple eligibility checks for Stedi to process asynchronously.

### Method
POST

### Endpoint
/eligibility-manager/batch-eligibility

### Parameters
#### Header Parameters
- **X-Forwarded-For** (string) - Optional - 

### Request Body
- **Content-Type** (application/json) - Required - Schema: BatchEligibilityChecksRequestContent

### Response
#### Success Response (200)
- **BatchEligibilityChecks** (object) - 200 response
```

--------------------------------

### GET /transactions/{transactionId}/input

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Retrieve a transaction's input document.

```APIDOC
## GET /transactions/{transactionId}/input

### Description
Retrieve a transaction's input document.

### Method
GET

### Endpoint
/transactions/{transactionId}/input

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.

### Response
#### Success Response (302)
- **302** - GetTransactionInputDocument 302 response
```

--------------------------------

### POST /executions/retry

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Queue file executions to be retried.

```APIDOC
## POST /executions/retry

### Description
Queue file executions to be retried.

### Method
POST

### Endpoint
/executions/retry

### Response
#### Success Response (200)
- **200** - RetryExecutions 200 response
```

--------------------------------

### GET /insurance-discovery/check/v1/{discoveryId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/healthcare-api-reference.md

Retrieve insurance discovery check results by discoveryId.

```APIDOC
## GET /insurance-discovery/check/v1/{discoveryId}

### Description
Retrieve insurance discovery check results by discoveryId.

### Method
GET

### Endpoint
/insurance-discovery/check/v1/{discoveryId}

### Parameters
#### Path Parameters
- **discoveryId** (string) - Required - The unique ID for the insurance discovery check.

### Response
#### Success Response (200)
- **200** - GetInsuranceDiscoveryCheck 200 response
```

--------------------------------

### POST /x12/partnerships/{partnershipId}/generate-edi

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Generate X12 EDI documents for a specific partnership.

```APIDOC
## POST /x12/partnerships/{partnershipId}/generate-edi

### Description
Generate X12 EDI.

### Method
POST

### Endpoint
/x12/partnerships/{partnershipId}/generate-edi

### Parameters
#### Path Parameters
- **partnershipId** (string) - Required - The unique identifier of the partnership.
```

--------------------------------

### POST /enrollments

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-reference.md

Creates a new transaction enrollment request to register a provider for exchanging transaction types with a payer.

```APIDOC
## POST /enrollments

### Description
Creates a new transaction enrollment request. Transaction enrollment registers a provider to exchange specific transaction types with a payer.

### Method
POST

### Endpoint
/enrollments

### Request Body
- **Content-Type** (string) - application/json
- **Schema** (object) - CreateEnrollmentRequestContent

### Response
#### Success Response (200)
- **Response** (object) - CreateEnrollment 200 response
```

--------------------------------

### GET /events/{eventId}/status

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Checks the delivery status of a specific event.

```APIDOC
## GET /events/{eventId}/status

### Description
Check delivery status of an event.

### Method
GET

### Endpoint
/events/{eventId}/status

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The unique identifier of the event.
```

--------------------------------

### Common API Parameters

Source: https://github.com/stedi/openapi/blob/main/_autodocs/parameters-and-requests.md

Overview of path and query parameters used across Stedi Manager API endpoints for batch and eligibility check operations.

```APIDOC
## Common API Parameters

### Path Parameters
- **batchId** (string) - Required - The unique identifier for the batch.
- **eligibilityCheckId** (string) - Required - The globally unique identifier for this eligibility check (formatted as ec_<uuid>).

### Query Parameters
- **batchId** (string) - Optional - An identifier for a batch of eligibility checks.
- **eligibilityCheckResult** (array) - Optional - Filter for batch items with specified results (ACTIVE, INACTIVE, INVESTIGATE, FAILED).
- **pageSize** (integer) - Optional - The maximum number of elements to return in a page (default 100).
- **pageToken** (string) - Optional - A token returned by a previous call to retrieve the next page.
- **startDateTime** (string) - Optional - ISO 8601 formatted string to filter completed checks after this time.
- **state** (array) - Optional - Filter for batch items in specified states (PENDING, VALIDATED, VALIDATION_FAILED, STARTED, RETRYING, COMPLETED, COMPLETED_WITH_ERRORS).

### Headers
- **X-Forwarded-For** (string) - Optional
```

--------------------------------

### POST /coordination-of-benefits

Source: https://github.com/stedi/openapi/blob/main/_autodocs/healthcare-api-reference.md

Submit a coordination of benefits (COB) check in JSON format.

```APIDOC
## POST /coordination-of-benefits

### Description
Submit a coordination of benefits (COB) check in JSON format.

### Method
POST

### Endpoint
/coordination-of-benefits

### Request Body
- **Schema** - CoordinationOfBenefitsRequestContent

### Response
#### Success Response (200)
- **200** - CoordinationOfBenefits 200 response
```

--------------------------------

### GET /payer/{stediId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/payers-api-reference.md

Retrieves a specific payer record by its Stedi ID.

```APIDOC
## GET /payer/{stediId}

### Description
Retrieves a specific payer record by its Stedi ID.

### Method
GET

### Endpoint
/payer/{stediId}

### Parameters
#### Path Parameters
- **stediId** (string) - Required - The unique identifier for the payer.
```

--------------------------------

### GET /change/medicalnetwork/reports/v2/{transactionId}/277

Source: https://github.com/stedi/openapi/blob/main/_autodocs/healthcare-api-complete.md

Retrieves claim acknowledgments for a specific transaction.

```APIDOC
## GET /change/medicalnetwork/reports/v2/{transactionId}/277

### Description
Retrieves claim acknowledgments for a specific transaction.

### Method
GET

### Endpoint
/change/medicalnetwork/reports/v2/{transactionId}/277

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - The unique identifier for the transaction.
```

--------------------------------

### POST /enrollments/export

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Exports enrollment records to CSV format.

```APIDOC
## POST /enrollments/export

### Description
Exports enrollment records to CSV format.

### Method
POST

### Endpoint
/enrollments/export

### Request Body
- **Content-Type** (string) - Required - application/json

### Response
#### Success Response (200)
- **ExportEnrollmentsCsv** (object) - 200 response
```

--------------------------------

### Common Error Handling Pattern

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Recommended steps for processing API errors, including status code validation and retry logic.

```text
1. Check HTTP status code
2. Parse error JSON response
3. Extract error code and message
4. Implement retry logic for 5xx errors
5. Log for debugging
```

--------------------------------

### GET /transactions/{transactionId}

Source: https://github.com/stedi/openapi/blob/main/_autodocs/core-api-reference.md

Fetch details for a specific transaction using its unique identifier.

```APIDOC
## GET /transactions/{transactionId}

### Description
Fetch details for a specific transaction.

### Method
GET

### Endpoint
/transactions/{transactionId}

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - A unique identifier for the processed transaction within Stedi.

### Response
#### Success Response (200)
- **GetTransaction** (object) - 200 response
```

--------------------------------

### POST /claim-attachments/raw-x12-submission

Source: https://github.com/stedi/openapi/blob/main/_autodocs/claims-api-reference.md

Submits a 275 claim attachment in X12 EDI format.

```APIDOC
## POST /claim-attachments/raw-x12-submission

### Description
Submit a 275 claim attachment in X12 EDI format.

### Method
POST

### Endpoint
/claim-attachments/raw-x12-submission

### Request Body
- **Content-Type**: application/json
- **Schema**: SubmitClaimAttachmentRawX12RequestContent

### Response
#### Success Response (200)
- SubmitClaimAttachmentRawX12 200 response

#### Error Responses
- 400: ValidationException
- 403: SubmitClaimAttachmentRawX12403Error
- 404: ResourceNotFoundException
- 429: ThrottlingException
- 500: InternalFailureException
```

--------------------------------

### POST /enrollments/{enrollmentId}/documents

Source: https://github.com/stedi/openapi/blob/main/_autodocs/enrollment-api-complete.md

Uploads a PDF document to a specific transaction enrollment.

```APIDOC
## POST /enrollments/{enrollmentId}/documents

### Description
Uploads a PDF document for the specified transaction enrollment.

### Method
POST

### Endpoint
/enrollments/{enrollmentId}/documents

### Parameters
#### Path Parameters
- **enrollmentId** (string) - Required - The enrollment ID for the transaction enrollment.

### Response
#### Success Response (200)
- **200** - CreateEnrollmentDocumentUpload 200 response
```

--------------------------------

### POST /insurance-discovery/check/v1

Source: https://github.com/stedi/openapi/blob/main/_autodocs/healthcare-api-reference.md

Submit an insurance discovery check in JSON format.

```APIDOC
## POST /insurance-discovery/check/v1

### Description
Submit an insurance discovery check in JSON format.

### Method
POST

### Endpoint
/insurance-discovery/check/v1

### Request Body
- **InsuranceDiscoveryCheckRequestContent** (object) - Required - The request body schema for the insurance discovery check.

### Response
#### Success Response (200)
- **200** - InsuranceDiscoveryCheck 200 response
```

--------------------------------

### POST /transactions

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Submit a transaction for processing.

```APIDOC
## POST /transactions

### Description
Submit transaction for processing.

### Method
POST

### Endpoint
/transactions
```

--------------------------------

### POST /claims

Source: https://github.com/stedi/openapi/blob/main/_autodocs/api-service-details.md

Submit a new healthcare claim for processing.

```APIDOC
## POST /claims

### Description
Submit a healthcare claim for processing.

### Method
POST

### Endpoint
/claims
```
Tokens:
Raw