Download Enrollment Document

Returns a pre-signed URL to download the specified enrollment document.

GET /documents/{documentId}/download

This endpoint returns a pre-signed URL that you can use to download a PDF document related to the specified transaction enrollment.

1. Call this endpoint with the document ID for the PDF document you want to download. The document ID is returned in the responses for the Retrieve Enrollment and List Enrollments endpoints.

2. The endpoint returns a pre-signed URL that you can use to download the specified PDF document.

3. Use a GET request to download the PDF document from the pre-signed URL.

   curl --request GET \
   --url "<downloadUrl>" \
   --output /path/to/file.pdf

You can also download enrollment documents manually from the enrollment's details page in the Stedi portal.

Authorizations

Authorization · Required Header

A Stedi API Key for authentication.

Path Parameters

documentId · String

The document ID for the PDF document you want to download. The document ID is returned in the responses for the Retrieve Enrollment and List Enrollments endpoints.

Response

application/json

CreateEnrollmentDocumentDownload 200 response

documentId · String Required

The document ID for the PDF document associated with the downloadUrl.

downloadUrl · String Required

The pre-signed URL to download the document.

Request

curl --request GET \
  --url "https://enrollments.us.stedi.com/2024-09-01/documents/{documentId}/download" \
  --header "Authorization: <api_key>"

Response

{
  "documentId": "doc-123e4567-e89b-12d3-a456-426614174000",
  "downloadUrl": "https://s3.amazonaws.com/enrollment-documents/doc-123e4567-e89b-12d3-a456-426614174000/provider-license.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
}