create_envelope
Create and send a document envelope for electronic signatures, specifying signers, documents or template, and security level.
Instructions
Create and send a new envelope for signing. Requires a name, at least one signer, and at least one document (pass document IDs from upload_document, or pass a templateId to create from a template). Signers are notified via their chosen delivery method. Use securityLevel to match the legal weight required: STANDARD for routine/internal approvals; VERIFIED (adds SMS/email OTP) for employment, vendor, or healthcare consent; CERTIFIED (adds WebAuthn biometric + device binding) for real estate, high-value, or regulatory signings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Envelope name/title shown to signers (max 256 chars) | |
| securityLevel | No | Signing ceremony tier. STANDARD = bearer-token only (default, legally weakest — vulnerable to link-forwarding disputes). VERIFIED = STANDARD + SMS/email OTP (defeats link forwarding; suitable for employment contracts, vendor agreements, healthcare consent). CERTIFIED = VERIFIED + WebAuthn biometric on a device-bound credential (near-unrepudiable; suitable for real estate, high-value transactions, regulated industries). All tiers are included on every plan. | |
| signers | Yes | List of signers for this envelope | |
| documentIds | No | IDs of documents to include. Use upload_document to create a document first. Either documentIds or templateId is required. | |
| templateId | No | Template ID to create the envelope from. When set, the backend copies the template's document server-side — you do not need to supply documentIds. Either documentIds or templateId is required. | |
| message | No | Optional message included in the signing notification |