Documentation

Base URL: https://api.signclad.com/api/v1. Authenticate with X-Api-Key. Sandbox keys are prefixed sk_test_ and never bill. Test emails are delivered to the recipients.

The API reference is generated from openapi/signclad.v1.yaml, the same document that validates requests, generates the SDKs, and defines the MCP tool schemas. It cannot drift from the API.

Give your AI assistant the docs

Download the complete integration pack and attach it to your AI assistant. It includes authentication, working examples, templates, webhooks, test mode, MCP, and the OpenAPI schema.

• Download the guides pack (.txt)Every prose guide in one file, without the OpenAPI schema. The size most assistants can hold.
• Download full integration guide (.txt)All integration guides and the API schema in one file. Large.
• Download llms.txtA compact index with links to individual Markdown guides.
• How to integrate with an AI assistantChoose a file, use the starter prompt, and build with a sandbox key.

Generated from the spec

• API reference Every operation, parameter, and schema as static HTML, one page per endpoint group. No JavaScript, and every endpoint has its own URL.
• Interactive reference The same document in Scalar: try a call and browse the schemas in the browser.
• Webhook events The event catalog with cadence, payload object, and compatibility class per event. The build fails if it drifts from the spec.

Guides

• LLMs.txt: integrate with AI Download the Signclad integration docs and API schema as plain text for your AI assistant.
• Getting started Create a key, send your first document in test mode, and watch the events arrive. About ten minutes end to end.
• Authentication and keys API keys, OAuth for applications acting on a workspace, signer sessions, and how each one is scoped, rotated, and revoked.
• Sandbox and test mode Send test emails and sign watermarked documents without billing.
• Creating a document Every option on POST /documents — files, recipients, fields, settings, drafts, and the transient status that catches everyone once.
• Templates and create-from-template Building a template, filling its roles, prefilling fields, excluding placeholders, composing several templates, and replacing the file without redrawing fields.
• Text tags Put the fields in the document. Tag syntax, sizing, validation, and how to check a file before you send it.
• Embedded signing Put the signer view inside your own product — URLs, the iframe, the message protocol, expiry, branding, and branding options.
• Embedded builders and the compatibility shim The document and template builders inside your product: the embed script, every message in both directions, the origin rules, and the message protocol.
• Webhooks Both signature schemes, the full event catalog, health states, retry schedule, the delivery log, and replay.
• Errors and rate limits The exact error bodies for every status, the rate-limit buckets, the headers on every response, and how idempotency interacts with both.
• MCP Connect an MCP client to Signclad: the endpoint, the OAuth sign-in, the tool list, the guardrails, and what shows up in the audit trail.
• Migrating to Signclad Move a DocuSign, Dropbox Sign, or PandaDoc integration to the Signclad eSignature API: what maps to what, when a base-URL swap is enough, and the order to do it in.
• Compatibility reference Measured wire behaviour Signclad reproduces on purpose: status casing, transient create statuses, the "t" checkbox literal, the 0.75 pt coordinate unit, and the error envelopes — with the quirks it deliberately does not reproduce.

Where to start

• Sending from your own system: Getting started → Creating a document → Webhooks.
• Putting signing inside your product: Embedded signing → Embedded builders.
• High-volume, repeatable documents: Templates → Text tags.
• Moving an existing integration: Migrating to Signclad.
• Connecting an AI assistant: MCP.

Conventions

• Every response carries X-Request-Id. Log it.
• A create answers the transient status Created, and a send answers Draft. Read the record back for the settled value.
• Unknown request properties are dropped silently, never rejected and never echoed back.
• 404 is authoritative — except on completed_pdf, which returns 404 until every signer has finished.
• x-ratelimit-reset is an ISO 8601 timestamp. The additive RateLimit-Reset is in seconds.
• Put an Idempotency-Key on every create.