OpenSign API v1.2
OpenSign™ API v1.2
The open-source DocuSign alternative — built for developers, trusted by enterprises.
OpenSign™ gives you a complete, production-ready e-signature platform through a single, RESTful API. Send documents for signature, manage templates, track signing status in real time, and automate your entire document lifecycle — all without vendor lock-in.
Getting Started
Every request must carry your API token in the x-api-token header.
x-api-token: <your-api-token>
→ How to generate your API token
Not sure where to begin? Use the sandbox environment (https://sandbox.opensignlabs.com/api/v1.2) to prototype without affecting live data.
Core Capabilities
| Category | What you can do |
|---|---|
| Documents | Create, send, update, revoke, and delete signature-request documents |
| Templates | Build reusable templates with pre-placed widgets; send to one or many signers |
| Self-Sign | Generate self-signed documents without a signer invitation flow |
| Public Templates | Share a public signing link — no signer list required |
| Draft Workflow | Save documents or templates as drafts and finalise them later |
| Contacts | Manage your signer contact book programmatically |
| Folders | Organise documents inside OpenSign Drive folders |
| Webhooks | Receive real-time event notifications at your own endpoint |
| Users | Retrieve account and credit information |
What’s New in v1.2
Attachment Widget Support
The attachments widget is now supported on draft document, create document, draft template, create template, and public template APIs.
Hide Signer Signing Links
Set "hide_signer_signing_links": true | false on POST /draftdocument to hide signer signing links in the draft document response.
Cleaner Template Retrieval
GET /template/:id and GET /templatelist have been streamlined — redundant parameters are removed and prefill data is now returned separately from signer parameters, making responses easier to consume.
Password-Protected PDF Support
Pass "file_password" in the request body when working with encrypted PDFs. Supported on:
POST /createtemplate · PUT /template/:id · POST /createdocument/:template_id · POST /draftdocument · POST /drafttemplate · POST /selfsign
Offline Signing Control
Set "allow_offline_sign": true | false on POST /createtemplate and PUT /template/:id to explicitly enable or disable offline signing for each template.
Signer Roles
The signers object now accepts a "signer_role" field across all creation routes. Three roles are supported:
| Role | Behaviour |
|---|---|
signer (default) | Must complete at least one signature widget |
viewer | Receives the document for review only — no widgets allowed |
approver | Can have any widgets except a signature requirement |
Carbon Copy (CC) Recipients
A new "cc" field is now supported alongside the existing "bcc" field on document, template, draft and self-sign creation/update routes. Email addresses listed in "cc" receive a carbon-copy notification email once the document is completed. Like "bcc", on update routes (such as PUT /document/:id) providing "cc" overrides the template value, even when supplied as an empty array ([]); omit the field to inherit the template value.
Available Environments
| Environment | Base URL |
|---|---|
| Sandbox | https://sandbox.opensignlabs.com/api/v1.2 |
| Production | https://app.opensignlabs.com/api/v1.2 |
| EU Region | https://eu-app.opensignlabs.com/api/v1.2 |
Versioning & Backwards Compatibility
v1.2 is fully backwards-compatible with v1 and v1.1 — all endpoints from those versions are available on this base URL with no breaking changes. New parameters introduced in v1.2 are optional unless otherwise noted.
Useful Links
Authentication
- API Key: x-api-token
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | x-api-token |
Contact
Terms of Service
http://www.opensignlabs.com/terms/License
AGPL v3.0