Envelope Signing (eSign)Introduction

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
StatusDescription
draftDraft, not yet sent
sendingBeing sent (large document envelopes only), async anchor position resolution in progress
sentSent, signing workflow in progress
sent_failedSend failed (large document envelopes only), anchor resolution failed or timed out; retry with the same OutEnvelopeId
completedAll signers have signed
declinedA signer declined to sign
voidedSender 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