STstedi

POST /enrollments/{enrollmentId}/documents

Changed on

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

Request

  • Base URL
    https://enrollments.us.stedi.com/2024-09-01
  • URL
    https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}/documents
  • Auth
    API key in header Authorization

Path parameters

enrollmentIdstring required

The enrollment ID for the transaction enrollment where you want to upload the PDF document. The enrollment ID is returned in the responses for the Create Enrollment and List Enrollments endpoints. It's also listed at the top of the enrollment's details page in the Stedi portal.

Request body

namestring required

The file name of the PDF document you want to upload. The name should include the file extension, such as provider-license.pdf. This name will be displayed in the Stedi portal.

taskIdstring required

The ID for the task associated with this document upload.

Response

CreateEnrollmentDocumentUpload 200 response

documentIdstring required

A unique identifier for the document record within Stedi.

enrollmentIdstring required

The enrollment ID for the transaction enrollment request associated with the PDF document.

uploadUrlstring required

The pre-signed URL you can use to upload the PDF document. This URL expires after 24 hours.

Changes

  • bce82ce83b27Revision changes
    • breaking

      the request property became required

  • 9f17ab96c910Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status