GET
/
export
/
pdf
curl --request GET \
  --url https://healthcare.us.stedi.com/2024-04-01/export/pdf \
  --header 'Authorization: <api-key>'
{
  "pdfs": [
    {
      "transactionId": "a10b1111-7233-484c-8dee-b240c590c767",
      "data": "JVBERi0xLjcKJYGBgYEKCjcgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMAo ..."
    }
  ],
  "errors": [
    {
      "transactionId": "a10b3344-7288-484j-8dbb-b240c123c767",
      "error": "No artifacts found for transaction"
    }
  ]
}

This endpoint uses a business identifier to retrieve autogenerated CMS-1500 Claim Form PDFs for submitted 837 professional claims.

  1. Call the endpoint with the business identifier as a query parameter for the claim form PDFs you want to retrieve. The business identifier should be the claim’s correlation ID. You can find this value in the claimReference.correlationId property in the synchronous responses from the Professional Claims and Professional Claims Raw X12 endpoints.
  2. Stedi returns an array of PDFs for all claims with the specified business identifier value. PDFs are returned as a base64 encoded string.
  3. Decode the base64 string and save it to a file with a .pdf extension.

You can also review and download claim form PDFs from each claim’s transaction details page in Stedi.

​
Setting a claim’s correlation ID

A claim’s correlation ID is a business identifier that you can use to retrieve claim form PDFs.

  • When you submit claims through the JSON endpoint, Stedi generates the correlation ID for you, and this value will be unique for each claim.
  • When you submit claims in X12 EDI through the API or an SFTP connection, you can specify your own correlation ID in the BHT03 field. This allows you to use the same value for multiple claims if desired.

​
Send PDFs to payers

Payers have strict requirements for submitted CMS-1500 claim forms.

If you plan to send these PDFs to payers or retain them for your records, we strongly recommend visiting CMS-1500 Claim Form PDF for information about how to structure claim submissions for optimal generation, the correct printer settings for generated PDFs, and general best practices.

Authorizations

​
Authorization
string
header
required

A Stedi API Key for authentication.

Query Parameters

​
businessId
string
required

The business identifier for the claim PDF you want to retrieve. This value is returned as the claimReference.correlationId in the synchronous response Stedi returns when you submit a professional claim.

​
background
boolean

If false, the generated PDF will only contain the form data on a white background, suitable for printing on pre-printed forms. The default is true.

Response

200
application/json
ExportPDF 200 response
​
errors
object[]

Errors that prevented Stedi from returning one or more PDFs for the specified businessId. This array may be empty if there were no errors.

​
pdfs
object[]

Data for PDF files Stedi generated for the specified businessId. This array may be empty if there are no PDFs available for the specified businessId. It may also contain multiple PDFs if there is more than one claim with the same businessId value.

Was this page helpful?