canonical: https://jentic.com/apis/clicksign.com/clicksign

# Clicksign Envelope API

Jentic publishes the only available OpenAPI specification for Clicksign Envelope API, keeping it validated and agent-ready. Clicksign is a Brazilian electronic document signing platform; the v3 Envelope API exposes 44 endpoints for assembling envelopes, attaching one or more PDF documents, adding signatories with authentication requirements, sending notifications, and tracking signature progress through webhooks. Endpoints cover envelope CRUD, document upload, signatory and observer management, configurable signing requirements (email, SMS, selfie, ID document), templates, folders for organisation, and a WhatsApp-based acceptance flow popular in the Brazilian market. A sandbox base URL is provided for testing.

## For AI agents

Assemble e-signature envelopes, attach documents, configure signatory requirements, and trigger notifications so agents can run document signing flows end to end.

## Scope

Does not handle document drafting, contract negotiation, or invoicing - use for e-signature envelope orchestration only.

## Capabilities

- Create an envelope, attach PDF documents, and activate it for signing via POST /envelopes and POST /envelopes/{envelopeId}/activate
- Add signatories to an envelope with configurable authentication requirements (email link, SMS token, selfie, ID upload)
- Trigger reminder notifications to one or all signatories through /envelopes/{id}/notifications endpoints
- Build reusable templates and organise envelopes into folders for high-volume signing operations
- Subscribe to webhooks that fire on envelope and signatory state changes for downstream automation
- Run signing flows in the sandbox environment before promoting to production
- Manage observer access so non-signing stakeholders can view envelope progress without signing

## Use cases

### Sales Contract Signing

Sales teams trigger envelope creation from CRM deal-closed events. The agent uploads the proposal PDF, adds signatories with email plus SMS authentication, and activates the envelope. Clicksign handles signer routing and audit trail. End-to-end automation closes the gap between deal and signed contract from days to under an hour.

Example prompt: Create an envelope, upload contract.pdf via POST /envelopes/{envelopeId}/documents, add a signatory with email authentication, and activate the envelope

### High-Volume HR Onboarding

HR teams onboarding many new hires per week build a Clicksign template via POST /templates with offer letter and policy acknowledgements pre-mapped. Each new hire triggers an envelope from the template, stored in a per-quarter folder. Templates plus folders cut envelope assembly time from minutes per hire to seconds.

Example prompt: List templates with GET /templates, create an envelope from the offer-letter template, add the new hire as a signatory, and place it in folder ID 'q2-hires'

### WhatsApp Acceptance Flow

For consumer-facing flows in Brazil, Clicksign supports a WhatsApp acceptance path so signatories accept terms through a WhatsApp message rather than email. This drives higher completion rates for short consumer contracts. The API configures the WhatsApp acceptance requirement on the envelope and notifications dispatch through Clicksign's WhatsApp integration.

Example prompt: Create a signatory with the WhatsApp acceptance requirement on an active envelope and trigger a notification

### Agent-Driven Signature Orchestration

An AI agent assembles a custom contract on demand, requests signature, and reports progress back to a CRM. Through Jentic, the agent searches for 'send a document for signature', loads the envelope creation operation, and executes against credentials in your Jentic One instance. The agent then polls envelope status or waits for a webhook callback before reporting completion.

Example prompt: Send NDA.pdf to legal@example.com for signature with email authentication, and return the envelope ID and signing URL

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /envelopes | Create an envelope |
| POST | /envelopes/{envelopeId}/documents | Upload a document into an envelope |
| POST | /envelopes/{envelopeId}/signers | Add a signatory to an envelope |
| POST | /envelopes/{envelopeId}/activate | Activate an envelope to start signing |
| POST | /envelopes/{envelopeId}/notifications | Notify all signatories of an envelope |
| POST | /templates | Create a reusable template |

## Key resources

- **Envelopes** — Container for one or more documents and their signatories - create, activate, edit, delete
- **Documents** — PDF files attached to envelopes
- **Signatories** — People required to sign, with configurable authentication requirements
- **Requirements** — Authentication checks (email, SMS, selfie, ID document) applied per signatory
- **Notifications** — Trigger reminder messages to one or all signatories on an envelope
- **Templates** — Reusable envelope structures for high-volume signing
- **Folders** — Organise envelopes for navigation and reporting
- **Webhooks** — Subscribe to envelope and signatory lifecycle events

## Why Jentic

- **Setup:** Wiring the Clicksign Envelope API by hand means setting the Authorization key header, choosing the app or sandbox clicksign.com/api/v3 host, and chaining envelope, document, signer, and activation calls yourself. Through Jentic you install once, import the Clicksign Envelope API from the API Directory, store the access token once, and your agent calls it.
- **Permission scoping:** Clicksign puts the envelope id in the URL path (/envelopes/{envelopeId}/documents, /envelopes/{envelopeId}/signers, /envelopes/{envelopeId}/activate), so a rule can pin your agent to one envelope and its documents and signers. You choose the operations it may call, so activation is not included unless you add it.
- **Credential handling:** Your Clicksign access token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a document for signature' or 'add a signatory to an envelope', and Jentic returns the matching Clicksign operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Clicksign (developer docs)** — Companion specification published from Clicksign's developer docs for the same e-signature platform.
- **ClickSend** — ClickSend dispatches SMS or email reminders pointing recipients at Clicksign signing URLs.
- **Clientary** — Clientary issues invoices that can be paired with a Clicksign-signed agreement.

## FAQ

### Why is there no official OpenAPI spec for Clicksign Envelope API?

Clicksign does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Clicksign Envelope API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Clicksign Envelope API use?

The Clicksign Envelope API uses an access token sent in the Authorization header. Tokens are generated by the account administrator in the Clicksign dashboard. Through Jentic, the token is stored encrypted in the vault and injected at execution time so agents never see the raw value.

### Can I add multiple documents to a single envelope with the Clicksign API?

Yes. POST /envelopes/{envelopeId}/documents uploads a PDF into an existing envelope; you can call it repeatedly to attach as many documents as required before activating the envelope with POST /envelopes/{envelopeId}/activate.

### What are the rate limits for the Clicksign Envelope API?

Rate limits are not declared in the OpenAPI spec. Clicksign applies plan-tier limits visible in your account settings - confirm them before issuing high-volume envelope creation. Through Jentic, rate-limit responses surface as standard error objects an agent can retry against.

### How do I send a contract for signature through the Clicksign API via Jentic?

Run pip install jentic, then search Jentic for 'send a document for signature' to find POST /envelopes. Load the operation schema, supply the envelope payload, then upload documents via POST /envelopes/{envelopeId}/documents, add signers, and activate. Jentic injects the Authorization token from the vault.

### Is there a sandbox environment for testing Clicksign envelopes?

Yes. The spec lists https://sandbox.clicksign.com/api/v3 as the sandbox server alongside the production base URL. Use the sandbox while wiring up envelope creation, signatory rules, and webhook handling before switching to production credentials.

### Can I limit what my agent is allowed to do with the Clicksign Envelope API?

Yes. Because you run Jentic One yourself, your own rules decide which Clicksign operations and credentials the agent may use. Since the envelope id sits in the URL path for calls like POST /envelopes/{envelopeId}/documents and POST /envelopes/{envelopeId}/signers, you can pin the agent to a single envelope and only its documents and signatories. You also pick which operations it may call, so it can add documents and signers without ever activating an envelope unless you grant POST /envelopes/{envelopeId}/activate.