Envelopes

Envelopes — 9 endpoints

Initiate and manage signing envelopes and document packages

• POST /api/v1/envelopes/initiate — Initiate Envelope

  Initiate a signature envelope by uploading document files as multipart/form-data. Returns an envelope and Docuemnt ID that can be used in subsequent signing invitation steps.

• POST /api/v1/envelopes/initiate-base64 — Initiate Envelope Base64

  Initiate a signature envelope by providing the document content as a Base64-encoded string. The system creates an envelope and returns its ID for subsequent signing invitation steps.

• POST /api/v1/envelopes/initiate-by-template — Initiate Envelope by Template

  Initiate a signature envelope using a predefined template. The template defines the document structure, signing fields, and signer roles. Returns an envelope ID.

• POST /api/v1/envelopes/bulk/initiate-base64 — Bulk Initiate Envelope Base64

  Initiate multiple signature envelopes in a single request by providing documents as Base64-encoded strings. Returns an array of envelope IDs.

• GET /api/v1/envelopes/{envelopeId}/files — Download Envelope Files

  Download all files associated with an envelope. Returns file content as binary or base64 depending on the Accept header.

• POST /api/v1/envelopes/{envelopeId}/cancel — Cancel Envelope

  Cancel an active envelope, preventing any further signing actions. Cancellation is irreversible. All pending signers will be notified.

• GET /api/v1/envelopes/{envelopeId}/status — Get Envelope Status

  Retrieve the current status of an envelope including signer completion details and overall progress.

• GET /api/v1/envelopes/{envelopeId}/files/completed — Download Completed Envelope Files

  Download the signed and completed files from an envelope. Only available after all signers have completed signing.

• POST /api/v1/envelopes/bulk/initiate-and-invite — Envelope Creation & Signing Invitation Process

  The API provides a complete end-to-end digital document signing workflow in a single operation. It initiates a signature envelope by accepting the document content as a Base64-encoded string, and immediately creates the envelope while generating a unique envelope ID. In the same process, the API also handles sending signing invitations to recipients. Each recipient receives a secure link via email or SMS, allowing them to review and sign the document electronically without requiring any additional API calls.