Delete Enrollment Document

Deletes the specified PDF document associated with a transaction enrollment.

DELETE /documents/{documentId}

This endpoint deletes the specified PDF document associated with a transaction enrollment.

1. Call this endpoint with the document ID for the PDF document you want to delete. The document ID is returned in the responses for the Retrieve Enrollment and List Enrollments endpoints.
2. The endpoint returns an empty response to indicate that the document has been successfully deleted.

You can also delete 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 delete. The document ID is returned in the responses for the Retrieve Enrollment and List Enrollments endpoints.

Response

DeleteEnrollmentDocument 200 response

Request

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

Response

Empty