Submit Claim Attachment JSON

POST /claim-attachments/submission

This endpoint is in beta and is subject to change.

This endpoint submits a 275 claim attachment to a payer.

1. Call this endpoint with the required information to link the attachment to the correct claim.
2. Stedi generates the X12 EDI 275 transaction and sends it to the payer.
3. The endpoint returns summary information about the submission.

This endpoint is for 837 claims submitted in JSON format. If your system already generates X12 EDI, you can send attachments through the Submit Claim Attachment (275) Raw X12 endpoint instead.

This endpoint only supports unsolicited attachments.

Visit Claim attachments for a full how-to guide.

Authorizations

Authorization · string · required · header

A Stedi API Key for authentication.

Body

application/json

usageIndicator · string

Whether you want to send a test or production claim. This property also allows you to filter claims in the Stedi portal by production or test data. By default, this property is set to P for production data. Use T to designate a claim as test data.

Possible values

P

T

relatedTransactionId · string

The transaction ID of the claim related to this attachment. You can find this value in the transaction processed event for the claim or on the claim's transaction details page in the Stedi portal.

You must provide either the relatedTransactionId or relatedExecutionId property in the request.

• Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
• Required string length: 36

relatedExecutionId · string

The file execution ID of the claim related to this attachment. The referenced file must contain exactly one transaction, an 837 claim. You can find this value in the meta.traceId property of the claim submission API response or in the file delivered event Stedi generates when it delivers your claim to the payer.

You must provide either the relatedTransactionId or relatedExecutionId property in the request.

• Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
• Required string length: 36

claimInformation · object · required

Information about the associated 837 claim.

claimInformation. serviceLines · array<object> · required

A list of service lines in the claim.

claimInformation.serviceLines[]. attachmentDetails · object · required

Identify the attachment file you want to include in the generated 275 transaction.

claimInformation.serviceLines[].attachmentDetails. attachmentId · string · required

The unique identifier for the attachment file you previously uploaded to Stedi. This value is returned in the attachmentId property of the Create Claim Attachment (275) JSON response.

• Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
• Required string length: 36

claimInformation.serviceLines[]. providerAttachmentControlNumber · string · required

The value you submitted in the claim's attachmentControlNumber property. It will allow the payer to associate this attachment with the claim that's already in their system.

• Required string length: 1 - 50

claimInformation.serviceLines[]. providerControlNumber · string

The value you submitted in a specific service line's providerControlNumber property. Set this property to indicate that the attachment should be associated with a specific service line and not the entire claim.

This doesn't apply to dental claims, which can only identify attachments at the claim level.

• Required string length: 1 - 50

Response

application/json

SubmitClaimAttachment 200 response

tradingPartnerServiceId · string

An ID for the payer you identified in the related transaction. This value may differ from the tradingPartnerServiceId you submitted in the original claim request because it reflects the payer's internal concept of their ID, not necessarily the ID Stedi uses to route requests to this payer.

• Required string length: 2 - 80

claimAttachmentReference · object

Information about the claim attachment.

claimAttachmentReference. correlationId · string

An opaque string identifier Stedi assigns to the claim attachment. You can use it for tracking purposes and when contacting Stedi support.

• Required string length: 1 - 50

claimAttachmentReference. patientControlNumber · string

The patientControlNumber from the claim associated with this attachment, if supplied. This is a unique identifier that you assigned to the related claim so you can track the claim and correlate it with responses from the payer.

• Required string length: 1 - 50

claimAttachmentReference. timeOfResponse · string

A timestamp in RFC 3339 format for Stedi's response to the submission. For example: 2025-03-07T12:34:56Z.

• Format: date-time

meta · object

Metadata from Stedi about the request.

meta. traceId · string

A unique identifier assigned to the processed file within the Stedi platform. This is also known as the file execution ID.

• Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
• Required string length: 36

cURL

curl --request POST \
  --url "https://claims.us.stedi.com/2025-03-07/claim-attachments/submission" \
  --header "Authorization: <api_key>" \
  --header "Content-Type: application/json" \
  --data "'{
    "usageIndicator": "T",
    "relatedExecutionId": "9b491769-052e-4738-93d6-e0b5f6d83f53",
    "claimInformation": {
      "serviceLines": [
        {
          "providerAttachmentControlNumber": "ATTACH123",
          "attachmentDetails": {
            "attachmentId": "4a1b2c3d-4567-89ab-cdef-1234567890ab"
          }
        }
      ]
    }
  }'"

JavaScript

const body = JSON.stringify({
  "usageIndicator": "T",
  "relatedExecutionId": "9b491769-052e-4738-93d6-e0b5f6d83f53",
  "claimInformation": {
    "serviceLines": [
      {
        "providerAttachmentControlNumber": "ATTACH123",
        "attachmentDetails": {
          "attachmentId": "4a1b2c3d-4567-89ab-cdef-1234567890ab"
        }
      }
    ]
  }
})

fetch("https://claims.us.stedi.com/2025-03-07/claim-attachments/submission", {
  headers: {
    "Authorization": "<api_key>"
  },
  body
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://claims.us.stedi.com/2025-03-07/claim-attachments/submission"
  body := strings.NewReader(`{
    "usageIndicator": "T",
    "relatedExecutionId": "9b491769-052e-4738-93d6-e0b5f6d83f53",
    "claimInformation": {
      "serviceLines": [
        {
          "providerAttachmentControlNumber": "ATTACH123",
          "attachmentDetails": {
            "attachmentId": "4a1b2c3d-4567-89ab-cdef-1234567890ab"
          }
        }
      ]
    }
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Authorization", "<api_key>")
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

Python

import requests

url = "https://claims.us.stedi.com/2025-03-07/claim-attachments/submission"
body = {
  "usageIndicator": "T",
  "relatedExecutionId": "9b491769-052e-4738-93d6-e0b5f6d83f53",
  "claimInformation": {
    "serviceLines": [
      {
        "providerAttachmentControlNumber": "ATTACH123",
        "attachmentDetails": {
          "attachmentId": "4a1b2c3d-4567-89ab-cdef-1234567890ab"
        }
      }
    ]
  }
}
response = requests.request("POST", url, json = body, headers = {
  "Authorization": "<api_key>",
  "Content-Type": "application/json"
})

print(response.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
import java.net.http.HttpRequest.BodyPublishers;

var body = BodyPublishers.ofString("""{
  "usageIndicator": "T",
  "relatedExecutionId": "9b491769-052e-4738-93d6-e0b5f6d83f53",
  "claimInformation": {
    "serviceLines": [
      {
        "providerAttachmentControlNumber": "ATTACH123",
        "attachmentDetails": {
          "attachmentId": "4a1b2c3d-4567-89ab-cdef-1234567890ab"
        }
      }
    ]
  }
}""");
HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://claims.us.stedi.com/2025-03-07/claim-attachments/submission"))
  .header("Content-Type", "application/json")
  .header("Authorization", "<api_key>")
  .POST(body)
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

200

{
  "tradingPartnerServiceId": "PAYER123",
  "claimAttachmentReference": {
    "correlationId": "att-123456",
    "patientControlNumber": "PCN123456",
    "timeOfResponse": "2025-03-07T12:34:56Z"
  },
  "meta": {
    "traceId": "4a1b2c3d-4567-89ab-cdef-1234567890ab"
  }
}

400

{
  "message": "string",
  "fieldList": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

404

{
  "message": "string",
  "code": "string"
}

429

{
  "message": "string",
  "code": "string"
}

500

{
  "message": "string",
  "code": "string"
}