Welcome Quickstart

Concepts

Envelope lifecycle Idempotency

Reference

Health

Auth

Login Register Refresh Logout Me Update me Delete me Upload avatar Delete avatar Update signature Change password List sessions Revoke other sessions Revoke session Setup two factor Verify two factor Disable two factor Forgot password Reset password Verify email Resend verification

Tenant

List Create Find by slug Update Delete List api keys Create api key Revoke api key Erase data

Workspace

List Create Find one Update Delete Get settings Update settings List members Add member Invite member Resend invite Update member role Remove member List workspace api keys Create workspace api key Revoke workspace api key

Invites

Validate Accept

Iframe

Create Validate Revoke List envelopes Get envelope Issue recipient link List templates Get template Update template fields Stream template pdf

Envelopes

List envelopes Create Get envelope analytics Get envelope detail Update Delete Preview links Reopen for edit Send Void Generate view token Issue recipient link Get envelope audit trail Get envelope download url Resend

Webhook

List Create Get Update Delete Test Get deliveries Regenerate secret

Template

List Create Get by id Update Delete Analyze Update fields Activate Archive Duplicate

Upload

Upload a pdf or docx document for template/envelope creation Get a presigned download url for a document Stream a document file Delete an uploaded document from storage

External Api

Create file Analyze smart tags Get smart tag schema Create envelope Get envelope Send envelope Void envelope Expire envelope Get envelope audit Get final document List events Get event List webhook endpoints Create webhook endpoint Update webhook endpoint Delete webhook endpoint Rotate webhook secret List webhook deliveries

Public Session

Load session Stream pdf Record view Save draft Complete Decline

View

Load view session Stream view document

Audit

Query Export csv

Billing

Get plan Get usage Get invoices Get plans Create checkout session Create customer portal session

Stripe Webhook

Organisations

List Create Switch organisation Leave

Api reference

Send envelope

POST/envelopes/{envelopeId}/send

Response Body

curl -X POST "https://loading/envelopes/{envelopeId}/send"

Empty

Get envelope

Previous Page

Void envelope

Next Page