Docuflex › E-signature › API › Envelopes

API reference: Envelopes

Create, send, void, edit and inspect envelopes; manage recipients, tabs and documents; download the combined PDF and the Certificate of Completion; read the audit trail; mint sender and embedded-signing views.

Create a Docuflex account Read the API reference Connect your AI agent

Method	Path	What it does
`POST`	`/v1/accounts/{accountId}/envelopes`	Create an envelope (draft or send immediately) Creates the envelope with documents (staged uploadId or inline base64), recipients, and tabs. status:"sent" sends in the same call. Response mirrors DocuSign: { envelopeId, status, uri }.
`GET`	`/v1/accounts/{accountId}/envelopes`	List envelopes (filter by status/search/date/recipientEmail) Offset mode (default): ?page=&pageSize=, returns { items, page, pageSize, totalCount }. Cursor mode (opt-in): pass ?cursor=<lastId>&limit= for keyset pagination, returns { items, nextCursor, hasMore }. ?order=asc\|desc flips the sort direction.
`GET`	`/v1/accounts/{accountId}/envelopes/{envelopeId}`	Envelope detail (documents, recipients, tabs, certificate ref)
`PUT`	`/v1/accounts/{accountId}/envelopes/{envelopeId}`	Envelope actions: send ({status:"sent"}), void ({status:"voided", voidedReason}), or draft edits
`GET`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/recipients`	List envelope recipients
`POST`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/recipients`	Add a recipient (draft only)
`PUT`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}`	Update a recipient (draft only)
`DELETE`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}`	Remove a recipient and their tabs (draft only)
`POST`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/resend`	Re-notify a current-tier recipient with a fresh signing link
`GET`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/tabs`	List envelope tabs
`POST`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/tabs`	Add a tab (draft only)
`PUT`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/tabs/{tabId}`	Update a tab (draft only)
`DELETE`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/tabs/{tabId}`	Delete a tab (draft only)
`GET`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/documents`	List envelope documents with hashes
`GET`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/documents/combined`	Presigned URLs for every document (sealed versions once completed)
`GET`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/documents/certificate`	Presigned certificate-of-completion URL (404 until sealed)
`GET`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}`	Presigned download URL (original, or sealed when completed)
`GET`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/audit_events`	Hash-chained audit trail (+ chainVerified flag) Supports offset (?page=&pageSize=) and cursor (?cursor=&limit=) pagination; events are always returned oldest-first (chain order).
`POST`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient`	Embedded-signing URL for a current-tier recipient (short TTL)
`POST`	`/v1/accounts/{accountId}/envelopes/{envelopeId}/views/sender`	Sender prepare-view URL

Conventions

Base URL: https://api.docuflex.net; tenant routes are /v1/accounts/{accountId}/....
Auth: x-api-key: dfx_live_..., or Authorization: Bearer <OAuth2 access token>.
Errors: always {"error":{"code","message","details","requestId"}}; the requestId is also in the x-request-id header.
Pagination: offset (?page=&pageSize=, max 100) or cursor (?cursor=&limit=, follow nextCursor until hasMore is false).
Idempotency: any POST or PUT accepts Idempotency-Key; same key + different body is 409 IDEMPOTENCY_KEY_REUSED.
Rate limits: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset on every response; 429 RATE_LIMITED with Retry-After.
Tabs: coordinates are fractions of the page (origin top-left); documentIndex and recipientIndex refer to positions in the same request.
Spec: /openapi.json (OpenAPI 3). TypeScript client @docuflex/sdk; Postman and Bruno collections ship with the repo.