WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-17 21:25:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
b149cfabaf9486d531eea4cfbc3eb1b442dce6ca
OpenSign/docs/API-docs/v1.2/opensign-api-v-1-2/index.html
T

69 lines
34 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-API-docs/v1.2/opensign-api-v-1-2" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">OpenSign API v1.2 | OpenSign™</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" name="twitter:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" property="og:url" content="https://docs.opensignlabs.com/docs/API-docs/v1.2/opensign-api-v-1-2"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="OpenSign API v1.2 | OpenSign™"><meta data-rh="true" name="description" content="# OpenSign™ API v1.2"><meta data-rh="true" property="og:description" content="# OpenSign™ API v1.2"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/API-docs/v1.2/opensign-api-v-1-2"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.2/opensign-api-v-1-2" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.2/opensign-api-v-1-2" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"v1.2","item":"https://docs.opensignlabs.com/docs/API-docs/v1.2"},{"@type":"ListItem","position":2,"name":"Introduction","item":"https://docs.opensignlabs.com/docs/API-docs/v1.2/opensign-api-v-1-2"}]}</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="OpenSign™ RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="OpenSign™ Atom Feed"><link rel="stylesheet" href="/assets/css/styles.03fa8acf.css">
<script src="/assets/js/runtime~main.2140ef3e.js" defer="defer"></script>
<script src="/assets/js/main.80b0cc6d.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
</defs></svg>
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const a=new URLSearchParams(window.location.search).entries();for(var[t,e]of a)if(t.startsWith("docusaurus-data-")){var n=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(n,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_mb4j" style="background-color:#cae4fa;color:#091E42" role="banner"><div class="content_knG7 announcementBarContent_xLdY">Help use spread the word - ⭐ OpenSign on <a target="_blank" rel="noopener" href="https://github.com/opensignlabs/opensign">GitHub</a></div></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.png" alt="OpenSign™ Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo.png" alt="OpenSign™ Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">OpenSign™</b></a><a class="navbar__item navbar__link" href="/docs/help/intro">Help</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/API-docs/v1.2">APIs</a><a class="navbar__item navbar__link" href="/docs/contribute/CODE_OF_CONDUCT">Contribute</a><a href="https://www.opensignlabs.com/plans-pricing" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Cloud Pricing<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><a class="navbar__item navbar__link" href="/docs/self-host/intro">Self-host</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--active" href="/docs/API-docs/v1.2"><span title="v1.2" class="categoryLinkLabel_W154">v1.2</span></a><button aria-label="Collapse sidebar category &#x27;v1.2&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/API-docs/v1.2/opensign-api-v-1-2"><span title="Introduction" class="linkLabel_WmDU">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/get-user"><span title="User" class="categoryLinkLabel_W154">User</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/createcontact"><span title="Contacts" class="categoryLinkLabel_W154">Contacts</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/selfsign"><span title="Documents" class="categoryLinkLabel_W154">Documents</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/drafttemplate"><span title="Templates" class="categoryLinkLabel_W154">Templates</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/get-webhook"><span title="Webhook" class="categoryLinkLabel_W154">Webhook</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/createfolder"><span title="Folder" class="categoryLinkLabel_W154">Folder</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/update-contact"><span title="Contact" class="categoryLinkLabel_W154">Contact</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/API-docs/v1.1"><span title="v1.1" class="categoryLinkLabel_W154">v1.1</span></a><button aria-label="Collapse sidebar category &#x27;v1.1&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.1/opensign-api-v-1-1"><span title="Introduction" class="linkLabel_WmDU">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/get-user"><span title="User" class="categoryLinkLabel_W154">User</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/createcontact"><span title="Contacts" class="categoryLinkLabel_W154">Contacts</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/selfsign"><span title="Documents" class="categoryLinkLabel_W154">Documents</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/drafttemplate"><span title="Templates" class="categoryLinkLabel_W154">Templates</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/get-webhook"><span title="Webhook" class="categoryLinkLabel_W154">Webhook</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/createfolder"><span title="Folder" class="categoryLinkLabel_W154">Folder</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/API-docs/v1"><span title="v1" class="categoryLinkLabel_W154">v1</span></a><button aria-label="Expand sidebar category &#x27;v1&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_xLCN"><div class="docItemContainer_jfFK"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/docs/API-docs/v1.2"><span>v1.2</span></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Introduction</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><div class="row"><div class="col col--12 markdown"><span class="theme-doc-version-badge badge badge--secondary">Version: 1.0.0</span>
<h1 class="openapi__heading">OpenSign API v1.2</h1>
<header><h1>OpenSign™ API v1.2</h1></header>
<blockquote>
<p><strong>The open-source DocuSign alternative — built for developers, trusted by enterprises.</strong></p>
</blockquote>
<p>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.</p>
<hr>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="getting-started">Getting Started<a href="#getting-started" class="hash-link" aria-label="Direct link to Getting Started" title="Direct link to Getting Started" translate="no">​</a></h2>
<p>Every request must carry your API token in the <code>x-api-token</code> header.</p>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">x-api-token: &lt;your-api-token&gt;</span><br></span></code></pre></div></div>
<p><strong>→ <a href="https://docs.opensignlabs.com/docs/help/Settings/APIToken" target="_blank" rel="noopener noreferrer" class="">How to generate your API token</a></strong></p>
<p>Not sure where to begin? Use the <strong>sandbox environment</strong> (<code>https://sandbox.opensignlabs.com/api/v1.2</code>) to prototype without affecting live data.</p>
<hr>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="core-capabilities">Core Capabilities<a href="#core-capabilities" class="hash-link" aria-label="Direct link to Core Capabilities" title="Direct link to Core Capabilities" translate="no">​</a></h2>
<table><thead><tr><th>Category</th><th>What you can do</th></tr></thead><tbody><tr><td><strong>Documents</strong></td><td>Create, send, update, revoke, and delete signature-request documents</td></tr><tr><td><strong>Templates</strong></td><td>Build reusable templates with pre-placed widgets; send to one or many signers</td></tr><tr><td><strong>Self-Sign</strong></td><td>Generate self-signed documents without a signer invitation flow</td></tr><tr><td><strong>Public Templates</strong></td><td>Share a public signing link — no signer list required</td></tr><tr><td><strong>Draft Workflow</strong></td><td>Save documents or templates as drafts and finalise them later</td></tr><tr><td><strong>Contacts</strong></td><td>Manage your signer contact book programmatically</td></tr><tr><td><strong>Folders</strong></td><td>Organise documents inside OpenSign Drive folders</td></tr><tr><td><strong>Webhooks</strong></td><td>Receive real-time event notifications at your own endpoint</td></tr><tr><td><strong>Users</strong></td><td>Retrieve account and credit information</td></tr></tbody></table>
<hr>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="whats-new-in-v12">What’s New in v1.2<a href="#whats-new-in-v12" class="hash-link" aria-label="Direct link to What’s New in v1.2" title="Direct link to What’s New in v1.2" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="attachment-widget-support">Attachment Widget Support<a href="#attachment-widget-support" class="hash-link" aria-label="Direct link to Attachment Widget Support" title="Direct link to Attachment Widget Support" translate="no">​</a></h3>
<p>The <code>attachments</code> widget is now supported on draft document, create document, draft template, create template, and public template APIs.</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="hide-signer-signing-links">Hide Signer Signing Links<a href="#hide-signer-signing-links" class="hash-link" aria-label="Direct link to Hide Signer Signing Links" title="Direct link to Hide Signer Signing Links" translate="no">​</a></h3>
<p>Set <code>&quot;hide_signer_signing_links&quot;: true | false</code> on <code>POST /draftdocument</code> to hide signer signing links in the draft document response.</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="cleaner-template-retrieval">Cleaner Template Retrieval<a href="#cleaner-template-retrieval" class="hash-link" aria-label="Direct link to Cleaner Template Retrieval" title="Direct link to Cleaner Template Retrieval" translate="no">​</a></h3>
<p><code>GET /template/:id</code> and <code>GET /templatelist</code> have been streamlined — redundant parameters are removed and <strong>prefill data is now returned separately from signer parameters</strong>, making responses easier to consume.</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="password-protected-pdf-support">Password-Protected PDF Support<a href="#password-protected-pdf-support" class="hash-link" aria-label="Direct link to Password-Protected PDF Support" title="Direct link to Password-Protected PDF Support" translate="no">​</a></h3>
<p>Pass <code>&quot;file_password&quot;</code> in the request body when working with encrypted PDFs. Supported on:
<code>POST /createtemplate</code> · <code>PUT /template/:id</code> · <code>POST /createdocument/:template_id</code> · <code>POST /draftdocument</code> · <code>POST /drafttemplate</code> · <code>POST /selfsign</code></p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="offline-signing-control">Offline Signing Control<a href="#offline-signing-control" class="hash-link" aria-label="Direct link to Offline Signing Control" title="Direct link to Offline Signing Control" translate="no">​</a></h3>
<p>Set <code>&quot;allow_offline_sign&quot;: true | false</code> on <code>POST /createtemplate</code> and <code>PUT /template/:id</code> to explicitly enable or disable offline signing for each template.</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="signer-roles">Signer Roles<a href="#signer-roles" class="hash-link" aria-label="Direct link to Signer Roles" title="Direct link to Signer Roles" translate="no">​</a></h3>
<p>The <code>signers</code> object now accepts a <code>&quot;signer_role&quot;</code> field across all creation routes. Three roles are supported:</p>
<table><thead><tr><th>Role</th><th>Behaviour</th></tr></thead><tbody><tr><td><code>signer</code> <em>(default)</em></td><td>Must complete at least one signature widget</td></tr><tr><td><code>viewer</code></td><td>Receives the document for review only — no widgets allowed</td></tr><tr><td><code>approver</code></td><td>Can have any widgets except a signature requirement</td></tr></tbody></table>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="carbon-copy-cc-recipients">Carbon Copy (CC) Recipients<a href="#carbon-copy-cc-recipients" class="hash-link" aria-label="Direct link to Carbon Copy (CC) Recipients" title="Direct link to Carbon Copy (CC) Recipients" translate="no">​</a></h3>
<p>A new <code>&quot;cc&quot;</code> field is now supported alongside the existing <code>&quot;bcc&quot;</code> field on document, template, draft and self-sign creation/update routes. Email addresses listed in <code>&quot;cc&quot;</code> receive a carbon-copy notification email once the document is completed. Like <code>&quot;bcc&quot;</code>, on update routes (such as <code>PUT /document/:id</code>) providing <code>&quot;cc&quot;</code> overrides the template value, even when supplied as an empty array (<code>[]</code>); omit the field to inherit the template value.</p>
<hr>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="available-environments">Available Environments<a href="#available-environments" class="hash-link" aria-label="Direct link to Available Environments" title="Direct link to Available Environments" translate="no">​</a></h2>
<table><thead><tr><th>Environment</th><th>Base URL</th></tr></thead><tbody><tr><td><strong>Sandbox</strong></td><td><code>https://sandbox.opensignlabs.com/api/v1.2</code></td></tr><tr><td><strong>Production</strong></td><td><code>https://app.opensignlabs.com/api/v1.2</code></td></tr><tr><td><strong>EU Region</strong></td><td><code>https://eu-app.opensignlabs.com/api/v1.2</code></td></tr></tbody></table>
<hr>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="versioning--backwards-compatibility">Versioning &amp; Backwards Compatibility<a href="#versioning--backwards-compatibility" class="hash-link" aria-label="Direct link to Versioning &amp; Backwards Compatibility" title="Direct link to Versioning &amp; Backwards Compatibility" translate="no">​</a></h2>
<p>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.</p>
<hr>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="useful-links">Useful Links<a href="#useful-links" class="hash-link" aria-label="Direct link to Useful Links" title="Direct link to Useful Links" translate="no">​</a></h2>
<ul>
<li class=""><a href="https://www.opensignlabs.com" target="_blank" rel="noopener noreferrer" class="">OpenSign Website</a></li>
<li class=""><a href="https://docs.opensignlabs.com" target="_blank" rel="noopener noreferrer" class="">Full Documentation</a></li>
<li class=""><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="">GitHub Repository</a></li>
<li class=""><a href="https://docs.opensignlabs.com/docs/help/Settings/APIToken" target="_blank" rel="noopener noreferrer" class="">Generate API Token</a></li>
<li class=""><a href="https://www.opensignlabs.com/terms/" target="_blank" rel="noopener noreferrer" class="">Terms of Service</a></li>
</ul>
<div style="margin-bottom:2rem"><h2 class="anchor anchorTargetStickyNavbar_Vzrq openapi-tabs__heading" id="authentication">Authentication<a href="#authentication" class="hash-link" aria-label="Direct link to Authentication" title="Direct link to Authentication" translate="no">​</a></h2><div class="openapi-tabs__schema-container"><div class="openapi-tabs__schema-tabs-container" style="margin-bottom:1rem"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__schema-list-container tabs openapi-tabs__security-schemes"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__schema-item active"><span class="openapi-tabs__schema-label">API Key: x-api-token</span></li></ul></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div><table><tbody><tr><th><p>Security Scheme Type:</p></th><td><p>apiKey</p></td></tr><tr><th><p>Header parameter name:</p></th><td><p>x-api-token</p></td></tr></tbody></table></div></div></div></div></div>
<div style="display:flex;flex-direction:column;margin-bottom:var(--ifm-paragraph-margin-bottom)"><h3 style="margin-bottom:0.25rem"><p>Contact</p></h3><span><p><a href="mailto:api@opensignlabs.com" target="_blank" rel="noopener noreferrer" class="">api@opensignlabs.com</a></p></span></div>
<div style="margin-bottom:var(--ifm-paragraph-margin-bottom)"><h3 style="margin-bottom:0.25rem"><p>Terms of Service</p></h3><a href="http://www.opensignlabs.com/terms/">http://www.opensignlabs.com/terms/</a></div>
<div style="margin-bottom:var(--ifm-paragraph-margin-bottom)"><h3 style="margin-bottom:0.25rem"><p>License</p></h3><a href="http://github.com/opensignlabs/opensign/LICENSE"><p>AGPL v3.0</p></a></div></div></div></div><div class="row"><div class="col col--12"></div></div></article><div class="row"><div class="col col--12"><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/API-docs/v1.2"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">v1.2</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/API-docs/v1.2/get-user"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Get your account details</div></a></nav></div></div></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#getting-started" class="table-of-contents__link toc-highlight">Getting Started</a></li><li><a href="#core-capabilities" class="table-of-contents__link toc-highlight">Core Capabilities</a></li><li><a href="#whats-new-in-v12" class="table-of-contents__link toc-highlight">What’s New in v1.2</a><ul><li><a href="#attachment-widget-support" class="table-of-contents__link toc-highlight">Attachment Widget Support</a></li><li><a href="#hide-signer-signing-links" class="table-of-contents__link toc-highlight">Hide Signer Signing Links</a></li><li><a href="#cleaner-template-retrieval" class="table-of-contents__link toc-highlight">Cleaner Template Retrieval</a></li><li><a href="#password-protected-pdf-support" class="table-of-contents__link toc-highlight">Password-Protected PDF Support</a></li><li><a href="#offline-signing-control" class="table-of-contents__link toc-highlight">Offline Signing Control</a></li><li><a href="#signer-roles" class="table-of-contents__link toc-highlight">Signer Roles</a></li><li><a href="#carbon-copy-cc-recipients" class="table-of-contents__link toc-highlight">Carbon Copy (CC) Recipients</a></li></ul></li><li><a href="#available-environments" class="table-of-contents__link toc-highlight">Available Environments</a></li><li><a href="#versioning--backwards-compatibility" class="table-of-contents__link toc-highlight">Versioning &amp; Backwards Compatibility</a></li><li><a href="#useful-links" class="table-of-contents__link toc-highlight">Useful Links</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/help/intro">Help</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/API-docs/v1.1">APIs</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contribute/intro">Contribute</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/self-host/intro">Self-host</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.com/invite/xe9TDuyAyj" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.linkedin.com/company/opensign%E2%84%A2/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.twitter.com/opensignhq" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.facebook.com/profile.php?id=61551030403669" target="_blank" rel="noopener noreferrer" class="footer__link-item">Facebook<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.opensignlabs.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Official Website<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 OpenSign™. <br>The best Open Source DocuSign alternative.</div></div></div></footer></div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink