Create envelope
create_envelopeInitiates a legally-binding e-signature envelope for a shared PDF, supporting parallel or sequential signing. Add signers afterward to complete the request.
Instructions
⚠️ This performs a consequential, possibly irreversible action (legally-binding signature request and/or quota consumption). Confirm with the human before calling. Create a multi-signer envelope around one PDF. After creating, add each signer with add_session_to_envelope. Consumes quota.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner | No | The requester (distinct from the signer). When set and signer.email differs, SignDocs auto-emails the signer an invite and notifies the owner on completion. Omit to deliver links yourself via webhooks. | |
| locale | No | UI/email language. Default pt-BR. | |
| metadata | No | Free-form key/value tags (keys ≤256, values ≤1024 chars). | |
| cancelUrl | No | ||
| returnUrl | No | ||
| documentUrl | No | Direct, public HTTPS link to the shared PDF (≤10MB) — server fetches it (not a Google Drive /view or private link). | |
| signingMode | Yes | PARALLEL: anyone signs in any order. SEQUENTIAL: ordered. | |
| uploadToken | No | Token from request_document_upload after the user uploaded the PDF. Provide one of documentBase64 / documentUrl / uploadToken. | |
| totalSigners | Yes | How many signers will be added to this envelope. | |
| documentBase64 | No | Base64-encoded PDF (≤10MB) shared by all signers. | |
| idempotencyKey | No | Idempotency key for safe retries; a UUID is generated if omitted. | |
| documentFilename | No | ||
| expiresInMinutes | No |