mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-20 06:35:54 +02:00
105 lines
68 KiB
HTML
105 lines
68 KiB
HTML
<!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/selfsign" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.0.1">
|
||
<title data-rh="true">Self Sign | 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/selfsign"><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="Self Sign | OpenSign™"><meta data-rh="true" name="description" content="The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the “Sign Yourself” flow in the OpenSign app."><meta data-rh="true" property="og:description" content="The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the “Sign Yourself” flow in the OpenSign app."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/API-docs/selfsign"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/selfsign" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/selfsign" hreflang="x-default"><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.f10211b2.css">
|
||
<script src="/assets/js/runtime~main.b47f0de3.js" defer="defer"></script>
|
||
<script src="/assets/js/main.6ed58c0f.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"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="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="navbar navbar--fixed-top"><div class="navbar__inner"><div class="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/opensign-api-v-1">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-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a><a class="navbar__item navbar__link" href="/docs/self-host/intro">Self-host</a></div><div class="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-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="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" class="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></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="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-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/API-docs/opensign-api-v-1">Introduction</a></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="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/API-docs/get-user">User</a></div></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="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/API-docs/createcontact">Contacts</a></div></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="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/API-docs/selfsign">Documents</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method post"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/API-docs/selfsign">Self Sign</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method post"><a class="menu__link" tabindex="0" href="/docs/API-docs/createdocument">Create Document</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method post"><a class="menu__link" tabindex="0" href="/docs/API-docs/createdocumentwithtemplateid">Create Document from Template</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/docs/API-docs/getdocument">Get Document</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method put"><a class="menu__link" tabindex="0" href="/docs/API-docs/update-document">Update Document</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method delete"><a class="menu__link" tabindex="0" href="/docs/API-docs/deletedocument">Delete Document</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/docs/API-docs/getdocumentlist">Get Document list from status</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method post"><a class="menu__link" tabindex="0" href="/docs/API-docs/resendrequestmail">Resend request mail</a></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="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/API-docs/drafttemplate">Templates</a></div></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="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/API-docs/get-webhook">Webhook</a></div></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="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/API-docs/createfolder">Folder</a></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"><div class="docItemContainer_jfFK"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><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"><span class="breadcrumbs__link">Documents</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Self Sign</span><meta itemprop="position" content="2"></li></ul></nav><div class="theme-doc-markdown markdown"><div class="row theme-api-markdown"><div class="col col--7 openapi-left-panel__container"><h1 class="openapi__heading"><p>Self Sign</p></h1>
|
||
<pre class="openapi__method-endpoint"><span class="badge badge--success">POST</span> <h2 class="openapi__method-endpoint-path">/selfsign</h2></pre><div class="openapi__divider"></div>
|
||
<p>The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the “Sign Yourself” flow in the OpenSign app.</p>
|
||
<p>Tip: Upload your PDF document to our <a href="https://app.opensignlabs.com/debugpdf" target="_blank" rel="noopener noreferrer"><strong>Debug UI</strong></a>, where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API.</p>
|
||
<p><strong>Supported Widgets:</strong></p>
|
||
<p>Below are the common parameters that are required with all widgets:</p>
|
||
<ul>
|
||
<li><strong>type:</strong> Indicates the type of widget.</li>
|
||
<li><strong>page:</strong> Specifies the page number on which you want to place the respective widget.</li>
|
||
<li><strong>x, y:</strong> Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.</li>
|
||
<li><strong>w, h:</strong> Represents the width and height of the widget. You can adjust these values using the debug UI.</li>
|
||
<li><strong>required:</strong> Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.</li>
|
||
<li><strong>name:</strong> Provides a different name for widgets if you are providing more than one widget.</li>
|
||
<li><strong>color:</strong> Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox.</li>
|
||
<li><strong>fontsize:</strong> Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox.</li>
|
||
</ul>
|
||
<p><strong>List of all supported widgets:</strong></p>
|
||
<ol>
|
||
<li><strong>signature:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"signature", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ol start="2">
|
||
<li><strong>stamp:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"stamp", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "stamp"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ol start="3">
|
||
<li><strong>initials:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"initials", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "initials"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ol start="4">
|
||
<li><strong>email:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"email", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "email",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ol start="5">
|
||
<li><strong>name:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"name", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "name",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ol start="6">
|
||
<li><strong>job title:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"job title", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "job title",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ol start="7">
|
||
<li><strong>company:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"company", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "company",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ol start="8">
|
||
<li><strong>date:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"date", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "date",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "default": "04-15-2024",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "format": "mm-dd-yyyy",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ul>
|
||
<li><strong>default:</strong> Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.</li>
|
||
<li><strong>format:</strong> Specify the date format of your choice from the options below.<!-- -->
|
||
<ul>
|
||
<li>"dd/MM/yyyy",</li>
|
||
<li>"dd-mm-yyyy",</li>
|
||
<li>"yyyy-mm-dd",</li>
|
||
<li>"mm.dd.yyyy",</li>
|
||
<li>"mm-dd-yyyy",</li>
|
||
<li>"mmm dd, yyyy",</li>
|
||
<li>"mmmm dd, yyyy",</li>
|
||
<li>"dd mmm, yyyy",</li>
|
||
<li>"dd mmmm, yyy"</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ol start="9">
|
||
<li><strong>textbox:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"textbox", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "textbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "default": "name",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "provide name",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "regularexpression":"",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ul>
|
||
<li><strong>default:</strong> Provide a default value for the textbox (Optional).</li>
|
||
<li><strong>hint:</strong> Provide a hint for the textbox (Optional).</li>
|
||
<li><strong>regularexpression:</strong> Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).</li>
|
||
<li><strong>readonly:</strong> Set to true if you want to set the textbox as readonly. By default, it's false.</li>
|
||
</ul>
|
||
<ol start="10">
|
||
<li><strong>checkbox:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"checkbox", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "checkbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "values": ["male", "female", "other"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "selectedvalues": [ "male", "female" ],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hidelabel": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<ul>
|
||
<li><strong>values:</strong> Provide options for the checkbox list.</li>
|
||
<li><strong>selectedvalues:</strong> Provide values that need to be selected by default (Optional).</li>
|
||
<li><strong>readonly:</strong> Set to true if you want to set the checkbox as readonly. By default, it's false.</li>
|
||
<li><strong>hidelabel:</strong> Set to true if you want to hide labels of the checkbox. By default, it's false.</li>
|
||
</ul>
|
||
<ol start="11">
|
||
<li><strong>image:</strong></li>
|
||
</ol>
|
||
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type":"image", </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page":1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "image"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="request">Request<a href="#request" class="hash-link" aria-label="Direct link to Request" title="Direct link to Request"></a></h2>
|
||
<div class="tabs-container"><div class="tabs__container"><div class="openapi-tabs__mime-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__mime-list-container tabs openapi-tabs__mime"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__mime-item active">application/json</li></ul></div></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><details class="details_lb9f alert alert--info details_b_Ee openapi-markdown__details mime" data-collapsed="false" open=""><summary class="openapi-markdown__details-summary-mime"><h3 class="openapi-markdown__details-summary-header-body"><p>Body</p></h3><strong class="openapi-schema__required"><p>required</p></strong></summary><div><div class="collapsibleContent_i85q"><div style="text-align:left;margin-left:1rem"></div><ul style="margin-left:1rem"><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">file</strong><span class="openapi-schema__name"> <!-- -->base64</span><span class="openapi-schema__divider"></span><span class="openapi-schema__required">required</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">title</strong><span class="openapi-schema__name"> <!-- -->string</span><span class="openapi-schema__divider"></span><span class="openapi-schema__required">required</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">description</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">note</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">timeToCompleteDays</strong><span class="openapi-schema__name"> <!-- -->number</span></span><div><p>time to complete days is used to calculate expiry date of your document</p></div></div></div><div class="openapi-schema__list-item"><details class="details_lb9f alert alert--info details_b_Ee openapi-markdown__details" data-collapsed="true"><summary><span class="openapi-schema__container"><strong class="openapi-schema__property"><p>signer</p></strong><span class="openapi-schema__name"><p>object</p></span></span></summary><div><div class="collapsibleContent_i85q"><div style="margin-left:1rem"><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">role</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">email</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">name</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">phone</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div><div class="openapi-schema__list-item"><details class="details_lb9f alert alert--info details_b_Ee openapi-markdown__details" data-collapsed="true"><summary><span class="openapi-schema__container"><strong class="openapi-schema__property"><p>widgets</p></strong><span class="openapi-schema__name"><p>object[]</p></span></span></summary><div><div class="collapsibleContent_i85q"><div style="margin-left:1rem"><li><div style="font-size:var(--ifm-code-font-size);opacity:0.6;margin-left:-.5rem;padding-bottom:.5rem"><p>Array [</p></div></li><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">type</strong><span class="openapi-schema__name"> <!-- -->string</span></span><div><p>Allowed values - signature, stamp.</p></div></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">page</strong><span class="openapi-schema__name"> <!-- -->number</span></span><div><p>The page number on which the widget should appear. use our <a href="https://app.opensignlabs.com/debugpdf"><strong>Debug UI</strong></a> to calculate the value.</p></div></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">x</strong><span class="openapi-schema__name"> <!-- -->number</span></span><div><p>x co-ordinate (left upper corner) from which widget should appear. use our <a href="https://app.opensignlabs.com/debugpdf"><strong>Debug UI</strong></a> to calculate the value.</p></div></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">y</strong><span class="openapi-schema__name"> <!-- -->number</span></span><div><p>y co-ordinate (left upper corner) from which widget should appear. use our <a href="https://app.opensignlabs.com/debugpdf"><strong>Debug UI</strong></a> to calculate the value.</p></div></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">w</strong><span class="openapi-schema__name"> <!-- -->number</span></span><div><p>Width of widget. use our <a href="https://app.opensignlabs.com/debugpdf"><strong>Debug UI</strong></a> to calculate the value.</p></div></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">h</strong><span class="openapi-schema__name"> <!-- -->number</span></span><div><p>Height of widget. use our <a href="https://app.opensignlabs.com/debugpdf"><strong>Debug UI</strong></a> to calculate the value.</p></div></div></div><li><div style="font-size:var(--ifm-code-font-size);opacity:0.6;margin-left:-.5rem"><p>]</p></div></li></div></div></div></details></div></div></div></div></details></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">folderId</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">send_email</strong><span class="openapi-schema__name"> <!-- -->boolean</span></span><div><p>This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.</p></div></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">email_subject</strong><span class="openapi-schema__name"> <!-- -->string</span></span><div><p>Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.</p></div></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">email_body</strong><span class="openapi-schema__name"> <!-- -->string</span></span><div><p>Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.</p></div></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">enableTour</strong><span class="openapi-schema__name"> <!-- -->boolean</span></span><div><p>true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.</p></div></div></div></ul></div></div></details></div></div></div>
|
||
<div><div><div class="openapi-tabs__container"><div class="openapi-tabs__response-header-section"><h2 class="anchor anchorWithStickyNavbar_LWe7 openapi-tabs__response-header" id="responses">Responses<a href="#responses" class="hash-link" aria-label="Direct link to Responses" title="Direct link to Responses"></a></h2><div class="openapi-tabs__response-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__response-list-container tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__response-code-item success active">200</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__response-code-item danger">400</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__response-code-item danger">405</li></ul></div></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div><p>Document created successfully!</p></div><div><div class="tabs-container"><div class="tabs__container"><div class="openapi-tabs__mime-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__mime-list-container tabs openapi-tabs__mime"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__mime-item active">application/json</li></ul></div></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="openapi-tabs__schema-container"><div class="openapi-tabs__schema-tabs-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__schema-list-container tabs openapi-tabs__schema"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__schema-item active"><span class="openapi-tabs__schema-label">Schema</span></li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__schema-item"><span class="openapi-tabs__schema-label">Example (from schema)</span></li></ul></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><details class="details_lb9f alert alert--info details_b_Ee openapi-markdown__details response" data-collapsed="false" open=""><summary class="openapi-markdown__details-summary-response"><strong><p>Schema</p></strong></summary><div><div class="collapsibleContent_i85q"><div style="text-align:left;margin-left:1rem"></div><ul style="margin-left:1rem"><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">objectId</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">url</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div></ul></div></div></details></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="openapi-code__response-samples-container"><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json 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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "objectId": "hji2zxcv2P",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "url": "https://url-to-sign-document.com"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div></div></div></div></div></div></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div><p>Something went wrong, please try again later!</p></div><div><div class="tabs-container"><div class="tabs__container"><div class="openapi-tabs__mime-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__mime-list-container tabs openapi-tabs__mime"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__mime-item active">application/json</li></ul></div></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="openapi-tabs__schema-container"><div class="openapi-tabs__schema-tabs-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__schema-list-container tabs openapi-tabs__schema"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__schema-item active"><span class="openapi-tabs__schema-label">Schema</span></li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__schema-item"><span class="openapi-tabs__schema-label">Example (from schema)</span></li></ul></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><details class="details_lb9f alert alert--info details_b_Ee openapi-markdown__details response" data-collapsed="false" open=""><summary class="openapi-markdown__details-summary-response"><strong><p>Schema</p></strong></summary><div><div class="collapsibleContent_i85q"><div style="text-align:left;margin-left:1rem"></div><ul style="margin-left:1rem"><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">error</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div></ul></div></div></details></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="openapi-code__response-samples-container"><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json 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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "error": "Something went wrong, please try again later!"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div></div></div></div></div></div></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div><p>Invalid API Token!</p></div><div><div class="tabs-container"><div class="tabs__container"><div class="openapi-tabs__mime-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__mime-list-container tabs openapi-tabs__mime"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__mime-item active">application/json</li></ul></div></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="openapi-tabs__schema-container"><div class="openapi-tabs__schema-tabs-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__schema-list-container tabs openapi-tabs__schema"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__schema-item active"><span class="openapi-tabs__schema-label">Schema</span></li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__schema-item"><span class="openapi-tabs__schema-label">Example (from schema)</span></li></ul></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><details class="details_lb9f alert alert--info details_b_Ee openapi-markdown__details response" data-collapsed="false" open=""><summary class="openapi-markdown__details-summary-response"><strong><p>Schema</p></strong></summary><div><div class="collapsibleContent_i85q"><div style="text-align:left;margin-left:1rem"></div><ul style="margin-left:1rem"><div class="openapi-schema__list-item"><div><span class="openapi-schema__container"><strong class="openapi-schema__property">error</strong><span class="openapi-schema__name"> <!-- -->string</span></span></div></div></ul></div></div></details></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="openapi-code__response-samples-container"><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json 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">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "error": "Invalid API token!"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div class="col col--5 openapi-right-panel__container"><div>Loading...</div></div></div></div><div class="col col--7"></div></article><div class="col col--7"><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/API-docs/contactlist"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Get Contact list</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/API-docs/createdocument"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Create Document</div></a></nav></div></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="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/opensign-api-v-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="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-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></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-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></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-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></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-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li></ul></div><div class="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-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></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-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenSign™. <br>The best Open Source DocuSign alternative.</div></div></div></footer></div>
|
||
</body>
|
||
</html> |