Introduction
Envelope Signing (eSign) provides a complete set of electronic signing APIs, supporting the full workflow from file upload to signing completion.
What is an Envelope?
In Tencent eSign, an Envelope is the core container for a signing workflow. An envelope contains:
- Documents — Files to be signed (PDF, Word, etc.)
- Recipients — Signers or Carbon Copy recipients
- Tabs — Signing fields such as signature, date, text box, etc., positioned on documents
- Signing Settings — Parallel/sequential signing, whether decline is allowed, etc.
Envelope Lifecycle
draft → sending → sent → completed
↘ declined
↘ voided
↘ sent_failed| Status | Description |
|---|---|
draft | Draft, not yet sent |
sending | Being sent (large document envelopes only), async anchor position resolution in progress |
sent | Sent, signing workflow in progress |
sent_failed | Send failed (large document envelopes only), anchor resolution failed or timed out; retry with the same OutEnvelopeId |
completed | All signers have signed |
declined | A signer declined to sign |
voided | Sender recalled the envelope, or auto-voided when the signing deadline is reached |
ℹ️
Envelopes created via the Open API are sent immediately. If the envelope contains documents >60MB, it enters sending state (async anchor resolution) and transitions to sent upon success, or sent_failed upon failure. Small document envelopes enter sent directly.
API Reference
POSTPOSTPOSTPOSTPOSTPOST
Upload Files
/openapi/v1/files/upload
Upload document files and obtain FileIds
Create File Conversion Task
/openapi/v1/files/convert-tasks
Asynchronously convert a non-PDF file to PDF and obtain TaskId
Query File Conversion Tasks
/openapi/v1/files/convert-tasks/query
Poll conversion task status and obtain ConvertedFileId
Create and Send Envelope
/openapi/v1/envelopes/quick-create
Create and send an envelope in a single call
Get Envelope Detail
/openapi/v1/envelopes/detail
Query envelope status and signing progress
Get Signing/Viewing Link
/openapi/v1/envelopes/signing-view
Generate a one-time signing or viewing link