Get Envelope Download Info
POST/openapi/v1/envelopes/download-url
Get the download URLs for envelope files.
Only envelopes with status completed support download.
The file is generated in PDF format.
Request Parameters
Header Parameters
AuthorizationRequiredstring
Bearer <access_token>
X-Operator-User-IdOptionalstring
Operator user ID. Not required in authorization_code mode (uses authorized user automatically); optional in client_credentials mode, falls back to system user ID if omitted.
Request Body
application/jsonEnvelopeIdRequiredstring
Envelope ID (required)
Response Parameters
Response.Data
EnvelopeIdOptionalstring
Envelope ID
StatusOptionalstring
Envelope status
FilesOptionalarray<object>
File info array
FileTypeOptionalstring
File type (CONTRACT / ATTACHMENT)
CONTRACTATTACHMENT
FileNameOptionalstring
File name
DownloadUrlOptionalstring
Download URL
Error Codes
| Error Code | Description |
|---|---|
OPENAPI.OPERATOR_USER_NOT_FOUND | Operator is not a member of this space |
INVALID_REQUEST | Invalid parameters (e.g. EnvelopeId is empty) |
NOT_FOUND | Envelope does not exist |
FORBIDDEN | Operator does not have permission to access the envelope |
ENVELOPE.DOWNLOAD_NOT_ALLOWED | Envelope status does not allow download (e.g., draft status) |
ENVELOPE.DOWNLOAD_SIGNED_PDF_GENERATING | Envelope completed but signed PDF is still being generated asynchronously; please retry later |
INTERNAL_ERROR | Internal service error |