canonical: https://jentic.com/apis/clicksign.github.io/clicksign-github-io # Clicksign API Jentic publishes the only available OpenAPI specification for Clicksign API, keeping it validated and agent-ready. This is the v1 surface of Clicksign's electronic document signing platform - the lighter, document-centric predecessor of the v3 envelope model. The 12 endpoints cover document creation, signer registration, signature list assembly that connects signers to documents, manual notification dispatch, and webhook subscription. Authentication uses an access_token query parameter, and a sandbox base URL is provided for testing before promoting to production. ## For AI agents Create signing documents, add signers, link them via signature lists, and dispatch notifications so agents can run lightweight document signing flows. ## Scope Does not handle contract drafting, identity verification beyond email, or document templates - use for lightweight document signing orchestration only. ## Capabilities - Create a document for signature via POST /documents and pull its signing status with GET /documents/{key} - Register a signer with POST /signers and link them to a document by creating a signature list entry - Cancel a pending document with DELETE /documents/{key} when an agreement is no longer needed - Trigger a manual notification to a signer through POST /notifications - Subscribe to webhooks for signing lifecycle events with POST /webhooks and update or remove subscriptions later - Use the sandbox base URL for end-to-end testing before switching to production credentials ## Use cases ### Lightweight Document Signing Teams that only need a single document signed by one or two parties use the v1 API to upload the document, register signers via POST /signers, attach them through POST /lists, and watch for completion via webhook. The minimal endpoint surface keeps the integration small for use cases that do not need v3's envelope grouping. Example prompt: Create a document with a PDF attachment, add a signer with email auth via POST /lists, and return the signing URL ### Webhook-Driven Status Tracking Rather than poll, applications register webhooks via POST /webhooks for signing lifecycle events and react when documents are signed, refused, or cancelled. The agent or downstream system updates its own state from the webhook payload - no scheduled GET /documents/{key} polling required. Example prompt: Create a webhook subscribed to document signed events pointing at https://example.com/clicksign/hook and verify it appears in GET /webhooks ### Reminder Notifications When a signer has not opened the signing link, the agent triggers a manual reminder via POST /notifications. This is paired with cancellation logic - if no signature within an SLA window, DELETE /documents/{key} closes the document. The combination keeps signing flows from leaving documents indefinitely pending. Example prompt: Send a notification to the signer linked to a specific document and confirm the response indicates the notification was queued ### Agent-Driven Signing Loop An AI agent in a contracts platform creates a document, attaches signers, monitors webhooks, and reports signed status to the calling system. Through Jentic, the agent searches for 'create a document for signature', loads the operation, and executes against credentials in your Jentic One instance. End-to-end integration time is under an hour. Example prompt: Create a document, add signer alice@example.com to its signature list, send a notification, and return the document key for tracking ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /documents | Create a signing document | | POST | /signers | Register a signer | | POST | /lists | Link a signer to a document | | POST | /notifications | Send a manual notification to a signer | | POST | /webhooks | Subscribe to signing events | | DELETE | /documents/{key} | Cancel a pending document | ## Key resources - **Documents** — Create, list, fetch, and cancel signing documents - **Signers** — Register parties who will sign documents - **Signature Lists** — Link signers to documents and remove the link if needed - **Notifications** — Trigger reminder messages to a signer on demand - **Webhooks** — Subscribe to signing lifecycle events for downstream automation ## Why Jentic - **Setup:** Wiring the Clicksign v1 API by hand means passing the access_token query parameter on every call, choosing the app or sandbox clicksign.com/api/v1 host, and chaining document, signer, and list operations yourself. Through Jentic you install once, import the Clicksign API from the API Directory, store the access token once, and your agent calls it. - **Permission scoping:** Clicksign v1 puts the document key in the URL path (/documents/{key}), so a rule can pin your agent to a specific document. You choose the operations it may call, so document deletion 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 'create a document for signature' or 'send a signing reminder', and Jentic returns the matching Clicksign v1 operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Clicksign Envelope API (v3)** — Newer envelope-based API from the same vendor with 44 endpoints, richer auth requirements, and template support. - **ClickSend** — ClickSend dispatches SMS or email reminders containing the Clicksign signing URL. - **Clientary** — Clientary issues invoices that can be paired with a Clicksign-signed agreement. ## FAQ ### Why is there no official OpenAPI spec for Clicksign API? Clicksign does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Clicksign 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 v1 API use? The Clicksign v1 API uses an access token sent as the access_token query parameter on every request. The token is generated in the Clicksign dashboard. Through Jentic, the token is stored encrypted in the vault and appended to requests at execution time so agents never see the raw value. ### Can I link a signer to a specific document with the Clicksign API? Yes. POST /signers registers the person, and POST /lists creates the relationship between a signer and a document. To remove the link, call DELETE /lists/{list_key}. This two-step pattern lets you reuse a signer record across multiple documents. ### What are the rate limits for the Clicksign API? Rate limits are not declared in the OpenAPI spec. Clicksign applies plan-tier limits visible in your account dashboard - confirm them before high-volume document creation. Through Jentic, throttle responses surface as standard error objects an agent can retry against. ### How do I subscribe to signature completion events through Jentic? Run pip install jentic, then search Jentic for 'subscribe to signature completion events' to find POST /webhooks. Load the operation, supply the callback URL and event types, and execute. Jentic injects the access_token query parameter from the vault. ### Should I use the v1 Clicksign API or the v3 Envelope API? The v1 API is document-centric and minimal - 12 endpoints suited to single-document flows. The v3 Envelope API groups documents and signatories into envelopes with richer authentication requirements (selfie, ID upload, WhatsApp acceptance). Choose v1 for lightweight single-document automations and v3 for multi-document, high-assurance signing. ### Can I limit what my agent is allowed to do with the Clicksign API? Yes. Because you run Jentic One yourself, your own rules decide which Clicksign operations and credentials the agent may use. The v1 API puts the document key in the URL path (/documents/{key}), so you can pin the agent to a specific document, and you choose the operations it may call, so DELETE /documents/{key} is excluded unless you add it. You could allow it to create documents, register signers via POST /signers, and send reminders through POST /notifications while blocking cancellation entirely.