Get Signing Report Download URL
POST/openapi/v1/envelopes/report-url
Get the download URL for the envelope signing report.
Only envelopes with status completed support report download.
The report is generated in PDF format and supports multiple languages.
Request Parameters
Header Parameters
AuthorizationRequiredstring
Bearer <access_token>
X-Operator-User-IdRequiredstring
Operator user ID (required, used for permission check)
languageOptionalstring
Report language (optional, default: en. Supported: zh / zh-Hant / en)
Request Body
application/jsonEnvelopeIdRequiredstring
Envelope ID (required)
Response Parameters
Response.Data
EnvelopeIdOptionalstring
Envelope ID
StatusOptionalstring
Envelope status
ReportFileOptionalobject
Report file info (null when envelope status is not completed)
FileNameOptionalstring
File name
DownloadUrlOptionalstring
Download URL
Error Codes
| Error Code | Description |
|---|---|
OPENAPI.OPERATOR_USER_ID_REQUIRED | Missing X-Operator-User-Id header |
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 |
INTERNAL_ERROR | Internal service error (failed to generate report) |