Clicksign Envelope API
65
AI ReadinessAI-Aware (B)65/100
Agent-ready OpenAPI document · curated by JenticProductivityCollaborationapiKey44 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Assemble e-signature envelopes, attach documents, configure signatory requirements, and trigger notifications so agents can run document signing flows end to end.
Use for: I need to create an envelope and add a PDF for signing, I want to send a contract for signature to a customer by email and SMS, Add a signatory to an existing envelope with selfie verification, Notify all signatories that a contract is awaiting signature
Not supported: Does not handle document drafting, contract negotiation, or invoicing - use for e-signature envelope orchestration only.
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.
Install Jentic One Beta
Connect the Clicksign Envelope API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Clicksign Envelope API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fclicksign.com%2Fclicksign" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fclicksign.com%2Fclicksign" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Clicksign Envelope API.
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
Patterns agents use Clicksign Envelope API for, with concrete tasks.
★ 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.
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.
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.
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.
Send NDA.pdf to legal@example.com for signature with email authentication, and return the envelope ID and signing URL
Key Endpoints
44 endpoints — jentic publishes the only available openapi specification for clicksign envelope api, keeping it validated and agent-ready.
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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
C
Clicksign Envelope API
- AI-Aware (B)65/100
75
Foundational Compliance63
Developer Experience & Jentic Compatibility50
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
75
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
5%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
50
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
36%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
66%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Clicksign Envelope API through Jentic.
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.
GET STARTED