diff --git a/404.html b/404.html index c62fbadc0..7fd6ea7f2 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.53e80455.js b/assets/js/0028a090.53e80455.js deleted file mode 100644 index 8d4e730e1..000000000 --- a/assets/js/0028a090.53e80455.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/drafttemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/drafttemplate","permalink":"/docs/API-docs/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9122zjOr8LVTWd8ZCd200ybq820mY67zc826W+S06El2GIjkSpJxXFzfLdPso+2T7IHICnLdpxkfr7ZzPl8k1gkSAIgAIIgcB1ZPjLRzml0AkWZcwsmOo+jFEyiRWmFktFOdJIBC93sheZDK+SI7R71GUg+yMGwyoA2zCqWaECgpDJWFeIb9jIbZo6ZAX2JY7lhg7yCUgtpDRsqzUYgQXOaOFVJVQB2jIXNWKkhhaGQkDJjdZXYSoPpsLelksxUSQLGDKvcrSyUZGrIeL1mzGwGhKoGW2lpGGeVFF8rYK2WGnyBxPbTVot9l4IRI8ktpIhcGP5ZpN/HbJyJJGMJl2wASGqKlHqEoYHugGOfkrSmKSERQ4HAfrIO201TgTjyPJ/EjLNWq9J5q8WEYaVWlyKFNKymhkNkKSfWMiEt6CFPgHgFOIsc0TJhcsZlyoY8Ebmw82xkqTBWi0GFK3fO5Jk8EeUOe1vmiqdsoirNjl78NAO3imHbaav1AgbViL3tt1rn32XWlmZnY4OXZUeVIJFbOR+YTqKKjRQBy3RIvAINOCvxC7gR+YTxNGVjkY7AGtoQyRJVTliilE6FdKJR8hEwWRUD0CYmagqlgQnJONPA00nbqnZlgL06PjxANhTcdthRXpm4Xi4VGhKbT9z0yJ5A1SO3O9tbKENCjmJW8AvkkrDsayWSCyTbgKSt9SJDvGq13iO+NXeE8TKeMmYzYdgYBplSFwwusXss8pxZLUYj0K3Wmfzll1/O5PWZZOwsIoizaIedRX6Ksyh2XXZSgut5cfj87f7ewcnnk49He3V/kNQFmP6LGmIo8sUZ3r55XXdLXix2H+zuzxaQyvr+oxy4AabhUsCY9gG32tEauFAPa9gJN7ruwUGgDbaeYgtj1+7fPDbH/ZcHe2+auDgIKLjI50D29nf7r+dgykzJ+WmOfj48mJ+n0o1Z+gcvHVNc/xT/nXt8/Y7s+g066e/vHZ/s7h8h8NTvI0rDcVWWSuP2v3cCvYPbfCZ/hFyNGddA0pOoolCSlVzzAizZxoxb6tbwtRIaUmfceJ4Hzdg5k23WaqEo7LRarC9TkaBqODWflICWzcF2HCiqDIIee1PjQBuKhLbImRPUkDF32l3maEgQVANaKSsuYX7iq5hNcOIXgHLhps2UFt+UtDwnobgEbUXC86YSI4Jk+izXZIJKJaQNrX4F9tErK+oyqai3MohaiswqhKQeA+yS5xUYj9U4Zhli9QZKDYYsrp8XGSlTloEYZSvX4+mXyti5iVllgh0NWPi1wi4Re4HYNuS5ASaGc7ws+AU0VmOqdPa9w36csBSGvMptzATaH6sr6LADZRkvy1wkdDaiOXcHT6WhTbvsxcEjgqqCSBy58wFPhFTg2YDWBjtpCj8mYIdy5g4UJI/sqM24ZEoubHSicqWXRYia5/nIEiUtSNthu5dc5IS8I9YwIZO8SoENcp5cxHSyx0zjWYa7MoE8V+PYyTuB0AlLPCf+MAM5SqGSiL9UfnlhZmdoh52g/an1CTsDq2kRYZpc9TZ8qHBlZEFQMUZ2JSbGxeyLGjArbA4xKmzJ5SRmqXMa4MoO1FXMkgySC/qleSoUG1TWKukIS7UqUzWWnpdDJa0R327QyNDz6znai9lWzLZj9jRm3c2YdXsx627FrLsds+7TmPU2Y9brxay3FbPetkOr99TzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnx+J2dsTVIfVqhzcS+rv++wo/HvR/85wQ/t3tP/eeYQLtb/jPDz163eU70CBPLi/IWLLD7D8UgOAtOiLDNn7lnUbBn2IiGKA4ds6PY44Md0yYtj5EWIYUVPDeryQkQD4iiGUpLRG0hUSSuqynyPsiDIaeJD7ksaCZdF5nVRldQeMKit0T9k44/WVYT75Z9MLQ30Pl9pG8j6WiaTtA0raa/tl4PiAmLOP0+TvzQIQeALPNqPniAB8SFeYx+Hw+eIg/wUFrNAOx9QNQ30HEXMDrhXd/mVrv7pN3b7G3NcQBvyg6gKNpp2p5MJn8E99Dn8cujyxM8VOfZYURiqFVxw/WDbgczKO8T0e/gsu+joz6AOiiCUYD5mEq4/ze9bKtSPnlk3FRhaO2cIfzMNZs00KQuxINiIUmmROKRR5jgkg3wgtdBHrSR7+nG/v5Gg5OusV0U7YVG/GwT4xuNRdFJ084C5NLuuMaCpWnMlptvbE9TVhTFimbXfhaRS/UMRd97Yqul3wP8WQowk/P5hW9VDowOKZnT2nRJu1k7Fo6QTIRgjBcVtgCgYVTlXMMV3jbNYoTjD9ScoDgzf51up3SxcyE+YgX77tD75N97oUYS5ifAlrvHLVHWnETDCK5oDhfERWRESqHVGOOtGd7eeHD9ke+zqB19JbwUGCXIwVpqBZt0bkLC7Vrjho27unjBNmDniOGGhZE33LFp+0m8u5t0vPkLxi3nm4d4QCZ+ASXsdOEKF0yLCk4eAEoZzH4rm4E+i87rMe5WDekdY8/voUeZSCHnA8iXu+6tA01avDw1GIMdhZB1JIDw3WwE8gp+tdB5NgviLeiWo7gp1MGIB9UILGa5MCEWMs+v5mgfLKIQngQX/h8ACwPYoBbD3y3mNWL3k3NnBfzm3LEEwjECrAN1YbU7VpjbmCZjcI5CSFFURR1xHNazBpYV/jRv8gtH4stGWKG5u0sr8Ks7VvBPMysWOJNdigyEiMItvp6HeEDGYAGl2/X0t5iJuTPyDzrc7lbAQFZTAW84EhHUHYa18pnV2tdhh3gAYZTTDcK4VZJAaTHG9XtVs0b53kcQRYGaka3VkteEekDSdwNa/8cS6OH+HClskvcXksQ5tO8tjS6OV/DRLZdd6n5A8ufxWdjcKI5USdkCSvbTaCdKMSchvIRHMc0Mxv6o0km0cx35QDv+9GFsHLnxxWB2w3VkkgwKjr8CRpgPgQ+qURzeMaM4osgLJkcgu6Id/yYbxXh/KPE1DAzOQeN2rgOUe26OYn8Pj3Yi9w4dxRFc8aJEYN/EQCYKb7s0xTSseNtcdctsLkM/6rwAnAcf8X7jNDR0upAQ8ptmas4wnfF1NhnXmk+ixdyT8HoXLmluXP08kU+CkgiLqlA/KRFYFEfCQtFcZcWuafXrOZ2AQkooLPtrx9K28OJXr4nj6N37twz0ryU38PyeXHK9ywvPb9kuXg4hDW5ze/bAGTN6ZOjcJTEBnqjlo+aazglcWvNk1cN3473NZKrKU3zJAq479P78mxNdKNeJ50lFuTf14TBHWY1qTVl3GkdXdxNzxRLVDq/q7LschpZVZQmaJUpL0N83Q2sPhrje1tY0jiZ3kzf5S5L3A27e+G7q3lM6wixV43+B6+On0zjK7sb15zph4n+I7Nb2dHbW+TycOv9uoNLJ52C3pncBhkMF4TCZqy8PdQq6wYiBUjlwucSJ/tB5V4o9QlfkkY9l0Tu30CYcKC6/S0MCmDNDIelgq5h3OtwjOPNvj+iU7WEDOYumGhiEkmE+4yYcQMgZwyRHByFckiC95ANPMsxOsw4rPsRHesr1wTQtVZmAXsYNPbbngP6ozUC49BIhR/POYYM7lGjRpL3T3B1swUOOEj0PT47uwUtyXdsuY8yd045KNwc7PDnC7CEx9H5Yh701NScCa/kcCEO/iF0KHjIMats+cdEFkMQRFXLVZol/HZ+302bLCKXC3IhRPItv1omtSxPPkg1xi1RlMcvRZ3cyY6E0c3wkLGpGnqjqPlJ5Byc5G1X0PGJRZUMqEcVcZ9k/QrqsWbr4pJUOCU9eLBASU2hnfApcQaDG/DEDadxwzobcWNAxptIi53WFF5t6SrgqQQuQCdzIAg2OdZ8rfaPfNM+D+VSat29e+xTTQENQygFqoJsYUlaVJDWkCXWKV9i5RdKXHCXUDtCfVzloy64HJWL5oFoJ2mAasmZKj7gU33xaMnokygAbQMZzB+pNBT4uIT6o4fPIBFv7n3/9u4HXSo9zGTG3Ak9TjPTfgSFdbJ3Ao8etoUQLqOYxwvlA/33xEEDsSGk+FyqtFcncX8aPMO/PmtouWkVZw5CDy60OLw+1vTVxsLHGu5X4AKHpoYBysFWJ9MKVMLaRpBSeEpftwxtAPiYNHMgNQa1GmZeTpoLXePlkqNl0lEol5hPc6mNwQRduP87ceTe7k3pTjEmbShrnkfc2N/HfwsaHnPCQqTxLk88nf4vi+1+Ib78OhKzkm0RxJjE/Zr2fTSmLJEMhWaHzM/DbXY3mRX8DJq+ywctEHIpX/bff+t0D0Td9+eZJ8ry/3b8oP7x7/upZByavuknv3eRD7539+D43/S9KJD+/yj7Jd2bw/En18cMn/fFDX398/8by9092BzKTg5c/iWTy5MugtyleP3+1+el9dzx4+dPmp3fPyk80+U+bny4uNpPi4PlA7iJM+fHDP8Xhl73H+9/2vu2f7F3tf8ufdfjB1y/Pr5Jn+xd72+1Pfd3ePxz848tXW755kj4++CC2n8I+vJcnm6+TqCkNQuZCwuew1Z+J7s+42VMSiq2btv1YFWAzknVKRdcK89xLl89t9YTxEReSIev0HygFoLXSt+/pr8PsNkZsbW5+7tZMeLLMhL6k9yUq+ThRFyD/XEqby1u3PKJ6VZDUuwMlEg6I+qM5YpvtjkgDSaWFnUQ7p9fRVZuXou36d07Pp+dxhIxVGAMrlSGMuc2inWhjMSSGlTcUbzm9djpYK5rhMsU3oCVl46XYuOxG03hxxI2quRLaWD4SctS+ddT5jNJj3A3H8Dl6Z0GLUvwDMGrh2dmEiiOBUpABR78fGYib/GYWD9wLWxUidTcG32Z7shhOC9G0uQDZ4pl2Q8irEfE6DeEmiiDVAaRoRlFUB3nwZx22OZ1JXh0hCQGSLkUWeltbdAX/oUt31cdP6Rq4tT09dxxuXIko4tr0610gf85B9U3zDlsULThIc17KopOy0mFY4S8EJ1HIoaI99/twWII8Rh8cNeuyu3zthjxRRZ2cHMD/869/04hwPtMyf2OHlWalGoPGyjGqnMrhSqDXi8CEmKGoIkXdeZGDMRhqlBZGruhLjCjJIbiSCS/5AGuv0FEV0iqXTNSwNqbD3meAbx/Y9Ui7fI9LyNHCsFwpKkdCt6eyqmgWlrGx0hdDRAlrxgZYs4DOnAEIQ0BmXCb4EuFUiBwhLL9C57zUwgDjokBgKh8bDkUicGK0i5onlhVc8hF5NDFd/5ELZag40GqAdyyj8srdIrDuAcA6EuklpMNe4K2NCMfGFCxue+ouECZ2FzhvJn151wAvyyUuLxIws8ywHC5Bk8lw1+8qz1mprLsSo0vX3FucyGouDQYYHEJha2r2eTef1kj5pMPwOQSPJHR2UQByIS9c+c1pLWbvYWCEhVnoYzweL5mv7+fHvBQ2qwboOKvZuBE1krFrDq8/vkdjA7owh8NjrI5MghO0Ys0NAt7wpxpP6FQLysZLcaNrnosEpIHGGbT78ug1u2SPO5tR3DDY90B443X/+d7B8R7Oi0eK079uZ7OzSfFaZWzBZWMpqhitC0gXNbfxPLMuNF0Xmq4LTdeFputC03Wh6brQdF1oui40XReargtN14WmbF1oui40/ZNoXxeargtN14Wm60LTdaHputB0XWi6LjRdF5quC03XhabrQtN1oem60HRdaLouNF0Xmv7/KjT1CVfoFW6UOReykcTqcu1OF8pPz+Mow1y8ndPo+hrfgt/qfDrF5q8VaEzkO4+jS64FxrgpjS8O+WqY4XUBk2gneu5C9u0TXD520k75HQvZi5hu50bs0q7fCttMFzw6PD6J4mjgS2QLleIYzcdYPsvHLs3LM5MKJDnVPuVcjipKOIvcnJhixyubzefnXVB+nv/RyFvjctLAcD5xz5GBf5GoGwdcX7vcv+m0hnddK0d4xgZo3L7z6XT6X6V6v98=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9122zjOr8LVTWd8ZCd200ybq820mY67zc826W+S06El2GIjkSpJxXFzfLdPso+2T7IHICnLdpxkfr7ZzPl8k1gkSAIgAIIgcB1ZPjLRzml0AkWZcwsmOo+jFEyiRWmFktFOdJIBC93sheZDK+SI7R71GUg+yMGwyoA2zCqWaECgpDJWFeIb9jIbZo6ZAX2JY7lhg7yCUgtpDRsqzUYgQXOaOFVJVQB2jIXNWKkhhaGQkDJjdZXYSoPpsLelksxUSQLGDKvcrSyUZGrIeL1mzGwGhKoGW2lpGGeVFF8rYK2WGnyBxPbTVot9l4IRI8ktpIhcGP5ZpN/HbJyJJGMJl2wASGqKlHqEoYHugGOfkrSmKSERQ4HAfrIO201TgTjyPJ/EjLNWq9J5q8WEYaVWlyKFNKymhkNkKSfWMiEt6CFPgHgFOIsc0TJhcsZlyoY8Ebmw82xkqTBWi0GFK3fO5Jk8EeUOe1vmiqdsoirNjl78NAO3imHbaav1AgbViL3tt1rn32XWlmZnY4OXZUeVIJFbOR+YTqKKjRQBy3RIvAINOCvxC7gR+YTxNGVjkY7AGtoQyRJVTliilE6FdKJR8hEwWRUD0CYmagqlgQnJONPA00nbqnZlgL06PjxANhTcdthRXpm4Xi4VGhKbT9z0yJ5A1SO3O9tbKENCjmJW8AvkkrDsayWSCyTbgKSt9SJDvGq13iO+NXeE8TKeMmYzYdgYBplSFwwusXss8pxZLUYj0K3Wmfzll1/O5PWZZOwsIoizaIedRX6Ksyh2XXZSgut5cfj87f7ewcnnk49He3V/kNQFmP6LGmIo8sUZ3r55XXdLXix2H+zuzxaQyvr+oxy4AabhUsCY9gG32tEauFAPa9gJN7ruwUGgDbaeYgtj1+7fPDbH/ZcHe2+auDgIKLjI50D29nf7r+dgykzJ+WmOfj48mJ+n0o1Z+gcvHVNc/xT/nXt8/Y7s+g066e/vHZ/s7h8h8NTvI0rDcVWWSuP2v3cCvYPbfCZ/hFyNGddA0pOoolCSlVzzAizZxoxb6tbwtRIaUmfceJ4Hzdg5k23WaqEo7LRarC9TkaBqODWflICWzcF2HCiqDIIee1PjQBuKhLbImRPUkDF32l3maEgQVANaKSsuYX7iq5hNcOIXgHLhps2UFt+UtDwnobgEbUXC86YSI4Jk+izXZIJKJaQNrX4F9tErK+oyqai3MohaiswqhKQeA+yS5xUYj9U4Zhli9QZKDYYsrp8XGSlTloEYZSvX4+mXyti5iVllgh0NWPi1wi4Re4HYNuS5ASaGc7ws+AU0VmOqdPa9w36csBSGvMptzATaH6sr6LADZRkvy1wkdDaiOXcHT6WhTbvsxcEjgqqCSBy58wFPhFTg2YDWBjtpCj8mYIdy5g4UJI/sqM24ZEoubHSicqWXRYia5/nIEiUtSNthu5dc5IS8I9YwIZO8SoENcp5cxHSyx0zjWYa7MoE8V+PYyTuB0AlLPCf+MAM5SqGSiL9UfnlhZmdoh52g/an1CTsDq2kRYZpc9TZ8qHBlZEFQMUZ2JSbGxeyLGjArbA4xKmzJ5SRmqXMa4MoO1FXMkgySC/qleSoUG1TWKukIS7UqUzWWnpdDJa0R327QyNDz6znai9lWzLZj9jRm3c2YdXsx627FrLsds+7TmPU2Y9brxay3FbPetkOr99TzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnx+J2dsTVIfVqhzcS+rv++wo/HvR/85wQ/t3tP/eeYQLtb/jPDz163eU70CBPLi/IWLLD7D8UgOAtOiLDNn7lnUbBn2IiGKA4ds6PY44Md0yYtj5EWIYUVPDeryQkQD4iiGUpLRG0hUSSuqynyPsiDIaeJD7ksaCZdF5nVRldQeMKit0T9k44/WVYT75Z9MLQ30Pl9pG8j6WiaTtA0raa/tl4PiAmLOP0+TvzQIQeALPNqPniAB8SFeYx+Hw+eIg/wUFrNAOx9QNQ30HEXMDrhXd/mVrv7pN3b7G3NcQBvyg6gKNpp2p5MJn8E99Dn8cujyxM8VOfZYURiqFVxw/WDbgczKO8T0e/gsu+joz6AOiiCUYD5mEq4/ze9bKtSPnlk3FRhaO2cIfzMNZs00KQuxINiIUmmROKRR5jgkg3wgtdBHrSR7+nG/v5Gg5OusV0U7YVG/GwT4xuNRdFJ084C5NLuuMaCpWnMlptvbE9TVhTFimbXfhaRS/UMRd97Yqul3wP8WQowk/P5hW9VDowOKZnT2nRJu1k7Fo6QTIRgjBcVtgCgYVTlXMMV3jbNYoTjD9ScoDgzf51up3SxcyE+YgX77tD75N97oUYS5ifAlrvHLVHWnETDCK5oDhfERWRESqHVGOOtGd7eeHD9ke+zqB19JbwUGCXIwVpqBZt0bkLC7Vrjho27unjBNmDniOGGhZE33LFp+0m8u5t0vPkLxi3nm4d4QCZ+ASXsdOEKF0yLCk4eAEoZzH4rm4E+i87rMe5WDekdY8/voUeZSCHnA8iXu+6tA01avDw1GIMdhZB1JIDw3WwE8gp+tdB5NgviLeiWo7gp1MGIB9UILGa5MCEWMs+v5mgfLKIQngQX/h8ACwPYoBbD3y3mNWL3k3NnBfzm3LEEwjECrAN1YbU7VpjbmCZjcI5CSFFURR1xHNazBpYV/jRv8gtH4stGWKG5u0sr8Ks7VvBPMysWOJNdigyEiMItvp6HeEDGYAGl2/X0t5iJuTPyDzrc7lbAQFZTAW84EhHUHYa18pnV2tdhh3gAYZTTDcK4VZJAaTHG9XtVs0b53kcQRYGaka3VkteEekDSdwNa/8cS6OH+HClskvcXksQ5tO8tjS6OV/DRLZdd6n5A8ufxWdjcKI5USdkCSvbTaCdKMSchvIRHMc0Mxv6o0km0cx35QDv+9GFsHLnxxWB2w3VkkgwKjr8CRpgPgQ+qURzeMaM4osgLJkcgu6Id/yYbxXh/KPE1DAzOQeN2rgOUe26OYn8Pj3Yi9w4dxRFc8aJEYN/EQCYKb7s0xTSseNtcdctsLkM/6rwAnAcf8X7jNDR0upAQ8ptmas4wnfF1NhnXmk+ixdyT8HoXLmluXP08kU+CkgiLqlA/KRFYFEfCQtFcZcWuafXrOZ2AQkooLPtrx9K28OJXr4nj6N37twz0ryU38PyeXHK9ywvPb9kuXg4hDW5ze/bAGTN6ZOjcJTEBnqjlo+aazglcWvNk1cN3473NZKrKU3zJAq479P78mxNdKNeJ50lFuTf14TBHWY1qTVl3GkdXdxNzxRLVDq/q7LschpZVZQmaJUpL0N83Q2sPhrje1tY0jiZ3kzf5S5L3A27e+G7q3lM6wixV43+B6+On0zjK7sb15zph4n+I7Nb2dHbW+TycOv9uoNLJ52C3pncBhkMF4TCZqy8PdQq6wYiBUjlwucSJ/tB5V4o9QlfkkY9l0Tu30CYcKC6/S0MCmDNDIelgq5h3OtwjOPNvj+iU7WEDOYumGhiEkmE+4yYcQMgZwyRHByFckiC95ANPMsxOsw4rPsRHesr1wTQtVZmAXsYNPbbngP6ozUC49BIhR/POYYM7lGjRpL3T3B1swUOOEj0PT47uwUtyXdsuY8yd045KNwc7PDnC7CEx9H5Yh701NScCa/kcCEO/iF0KHjIMats+cdEFkMQRFXLVZol/HZ+302bLCKXC3IhRPItv1omtSxPPkg1xi1RlMcvRZ3cyY6E0c3wkLGpGnqjqPlJ5Byc5G1X0PGJRZUMqEcVcZ9k/QrqsWbr4pJUOCU9eLBASU2hnfApcQaDG/DEDadxwzobcWNAxptIi53WFF5t6SrgqQQuQCdzIAg2OdZ8rfaPfNM+D+VSat29e+xTTQENQygFqoJsYUlaVJDWkCXWKV9i5RdKXHCXUDtCfVzloy64HJWL5oFoJ2mAasmZKj7gU33xaMnokygAbQMZzB+pNBT4uIT6o4fPIBFv7n3/9u4HXSo9zGTG3Ak9TjPTfgSFdbJ3Ao8etoUQLqOYxwvlA/33xEEDsSGk+FyqtFcncX8aPMO/PmtouWkVZw5CDy60OLw+1vTVxsLHGu5X4AKHpoYBysFWJ9MKVMLaRpBSeEpftwxtAPiYNHMgNQa1GmZeTpoLXePlkqNl0lEol5hPc6mNwQRduP87ceTe7k3pTjEmbShrnkfc2N/HfwsaHnPCQqTxLk88nf4vi+1+Ib78OhKzkm0RxJjE/Zr2fTSmLJEMhWaHzM/DbXY3mRX8DJq+ywctEHIpX/bff+t0D0Td9+eZJ8ry/3b8oP7x7/upZByavuknv3eRD7539+D43/S9KJD+/yj7Jd2bw/En18cMn/fFDX398/8by9092BzKTg5c/iWTy5MugtyleP3+1+el9dzx4+dPmp3fPyk80+U+bny4uNpPi4PlA7iJM+fHDP8Xhl73H+9/2vu2f7F3tf8ufdfjB1y/Pr5Jn+xd72+1Pfd3ePxz848tXW755kj4++CC2n8I+vJcnm6+TqCkNQuZCwuew1Z+J7s+42VMSiq2btv1YFWAzknVKRdcK89xLl89t9YTxEReSIev0HygFoLXSt+/pr8PsNkZsbW5+7tZMeLLMhL6k9yUq+ThRFyD/XEqby1u3PKJ6VZDUuwMlEg6I+qM5YpvtjkgDSaWFnUQ7p9fRVZuXou36d07Pp+dxhIxVGAMrlSGMuc2inWhjMSSGlTcUbzm9djpYK5rhMsU3oCVl46XYuOxG03hxxI2quRLaWD4SctS+ddT5jNJj3A3H8Dl6Z0GLUvwDMGrh2dmEiiOBUpABR78fGYib/GYWD9wLWxUidTcG32Z7shhOC9G0uQDZ4pl2Q8irEfE6DeEmiiDVAaRoRlFUB3nwZx22OZ1JXh0hCQGSLkUWeltbdAX/oUt31cdP6Rq4tT09dxxuXIko4tr0610gf85B9U3zDlsULThIc17KopOy0mFY4S8EJ1HIoaI99/twWII8Rh8cNeuyu3zthjxRRZ2cHMD/869/04hwPtMyf2OHlWalGoPGyjGqnMrhSqDXi8CEmKGoIkXdeZGDMRhqlBZGruhLjCjJIbiSCS/5AGuv0FEV0iqXTNSwNqbD3meAbx/Y9Ui7fI9LyNHCsFwpKkdCt6eyqmgWlrGx0hdDRAlrxgZYs4DOnAEIQ0BmXCb4EuFUiBwhLL9C57zUwgDjokBgKh8bDkUicGK0i5onlhVc8hF5NDFd/5ELZag40GqAdyyj8srdIrDuAcA6EuklpMNe4K2NCMfGFCxue+ouECZ2FzhvJn151wAvyyUuLxIws8ywHC5Bk8lw1+8qz1mprLsSo0vX3FucyGouDQYYHEJha2r2eTef1kj5pMPwOQSPJHR2UQByIS9c+c1pLWbvYWCEhVnoYzweL5mv7+fHvBQ2qwboOKvZuBE1krFrDq8/vkdjA7owh8NjrI5MghO0Ys0NAt7wpxpP6FQLysZLcaNrnosEpIHGGbT78ug1u2SPO5tR3DDY90B443X/+d7B8R7Oi0eK079uZ7OzSfFaZWzBZWMpqhitC0gXNbfxPLMuNF0Xmq4LTdeFputC03Wh6brQdF1oui40XReargtN14WmbF1oui40/ZNoXxeargtN14Wm60LTdaHputB0XWi6LjRdF5quC03XhabrQtN1oem60HRdaLouNF0Xmv7/KjT1CVfoFW6UOReykcTqcu1OF8pPz+Mow1y8ndPo+hrfgt/qfDrF5q8VaEzkO4+jS64FxrgpjS8O+WqY4XUBk2gneu5C9u0TXD520k75HQvZi5hu50bs0q7fCttMFzw6PD6J4mjgS2QLleIYzcdYPsvHLs3LM5MKJDnVPuVcjipKOIvcnJhixyubzefnXVB+nv/RyFvjctLAcD5xz5GBf5GoGwdcX7vcv+m0hnddK0d4xgZo3L7z6XT6X6V6v98=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,y={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," 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, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," 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, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.cbfaf7cf.js b/assets/js/0028a090.cbfaf7cf.js new file mode 100644 index 000000000..2e4cf2eaf --- /dev/null +++ b/assets/js/0028a090.cbfaf7cf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/drafttemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/drafttemplate","permalink":"/docs/API-docs/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztG9t22zjuV7h66YyP7MRummnztJk203G3uWyTXpOcDi3BFhuJVEkqjpvjt/2S/bT9kj0ASVm24yRz2dnMOX5JLBIkARAAQRC4jiwfmWjnNDqBosy5BROdx1EKJtGitELJaCc6yYCFbvZC86EVcsR2j/oMJB/kYFhlQBtmFUs0IFBSGasK8Q17mQ0zx8yAvsSx3LBBXkGphbSGDZVmI5CgOU2cqqQqADvGwmas1JDCUEhImbG6SmylwXTY21JJZqokAWOGVe5WFkoyNWS8XjNmNgNCVYOttDSMs0qKrxWwVksNvkBi+2mrxb5LwYiR5BZSRC4M/yzS72M2zkSSsYRLNgAkNUVKPcLQQHfAsU9JWtOUkIihQGA/WYftpqlAHHmeT2LGWatV6bzVYsKwUqtLkUIaVlPDIbKUE2uZkBb0kCdAvAKcRY5omTA54zJlQ56IXNh5NrJUGKvFoMKVO2fyTJ6Icoe9LXPFUzZRlWZHL36agVvFsO201XoBg2rE3vZbrfPvMmtLs7Oxwcuyo0qQyK2cD0wnUcVGioBlOiRegQaclfgF3Ih8wniasrFIR2ANbYhkiSonLFFKp0I60Sj5CJisigFoExM1hdLAhGScaeDppG1VuzLAXh0fHiAbCm477CivTFwvlwoNic0nbnpkT6Dqkdud7S2UISFHMSv4BXJJWPa1EskFkm1A0tZ6kSFetVrvEd+aO8J4GU8Zs5kwbAyDTKkLBpfYPRZ5zqwWoxHoVutM/vLLL2fy+kwydhYRxFm0w84iP8VZFLsuOynB9bw4fP52f+/g5PPJx6O9uj9I6gJM/0UNMRT54gxv37yuuyUvFrsPdvdnC0hlff9RDtwA03ApYEz7gFvtaA1cqIc17IQbXffgINAGW0+xhbFr928em+P+y4O9N01cHAQUXORzIHv7u/3XczBlpuT8NEc/Hx7Mz1Ppxiz9g5eOKa5/iv/OPb5+R3b9Bp309/eOT3b3jxB46vcRpeG4KkulcfvfO4HewW0+kz9CrsaMayDpSVRRKMlKrnkBlmxjxi11a/haCQ2pM248z4Nm7JzJNmu1UBR2Wi3Wl6lIUDWcmk9KQMvmYDsOFFUGQY+9qXGgDUVCW+TMCWrImDvtLnM0JAiqAa2UFZcwP/FVzCY48QtAuXDTZkqLb0panpNQXIK2IuF5U4kRQTJ9lmsyQaUS0oZWvwL76JUVdZlU1FsZRC1FZhVCUo8BdsnzCozHahyzDLF6A6UGQxbXz4uMlCnLQIyylevx9Etl7NzErDLBjgYs/Fphl4i9QGwb8twAE8M5Xhb8AhqrMVU6+95hP05YCkNe5TZmAu2P1RV02IGyjJdlLhI6G9Gcu4On0tCmXfbi4BFBVUEkjtz5gCdCKvBsQGuDnTSFHxOwQzlzBwqSR3bUZlwyJRc2OlG50ssiRM3zfGSJkhak7bDdSy5yQt4Ra5iQSV6lwAY5Ty5iOtljpvEsw12ZQJ6rcezknUDohCWeE3+YgRylUEnEXyq/vDCzM7TDTtD+1PqEnYHVtIgwTa56Gz5UuDKyIKgYI7sSE+Ni9kUNmBU2hxgVtuRyErPUOQ1wZQfqKmZJBskF/dI8FYoNKmuVdISlWpWpGkvPy6GS1ohvN2hk6Pn1HO3FbCtm2zF7GrPuZsy6vZh1t2LW3Y5Z92nMepsx6/Vi1tuKWW/bodV76nnNawY3Eej2HJftX4e7aHdfC0OajQbT1DZ4PGeDux3WatXatHj8zs7YGqQ+rdBmYl/Xf1/hx+PeD/5zgp/bvaf+c0yg3S3/meFnr9s8J3qEieVFeQsW2P2HYhCcBSdE2ObP3LMo2DNsREMUh47ZUezxwY5pk5bHSIuQwgqem9XkBIgHRNEMpSWitpAoEtfVFHkf5MGQ08SHXBY0k66LzGqjKyg8YdFbov5Jx58sq4l3yz4Y2hvo/D7St5F0NE0naJpW019brwfEhEWcfh8nfuiQA0CWeTUfPMAD4sI8Rr+PB0+RB3gorWYA9j4g6hvouAsYnfCub3Or3X3S7m32tuY4gDdlB1AU7TRtTyaTP4J76PP45dHlCR6q8+wwIjHUqrjh+kG3gxmU94nod3DZ99FRH0AdFMEowHxMJdz/m162VSmfPDJuqjC0ds4QfuaaTRpoUhfiQbGQJFMi8cgjTHDJBnjB6yAP2sTJjTTdcJwMbWnaLoomd7ERP9vE90ZjUXTStLMAubQ5rrFgaRqz5eYb29OUFUWxotm1n0XkUT1DyfeO2Grh9wB/lvzPxHx+4Vt1A4NDSua0Nt3RblaOhRMkEyEW4yWFLQBoGFU513CFl02zGOD4AxUn6M3MXafLKd3rXISPWMG+O/Qu+fdeppGE+Qmw5e5xS5Q1J9Ewgiuaw8VwERmRUmQ1xnBrhpc3Hjx/5PssaEdfCS8FBglysJZawSadm5Bwu9a4YOOuLt6vDdg5YrhhYeQNV2zafhLv7iadbv5+ccvx5iEekIVfQAk7XbTCxdKigpMDgFIGs9/KZqDPovN6jLtUQ3rH2PN76FEmUsj5APLlrnvrQJMWL08NxmBHIWQdCCB8NxtxvIJfLXSezWJ4C7rlKG4KdbDhQTUCi1kuTAiFzPOrOdrHiiiCJ8FF/wfAwgA2qMXwd4t5jdj95NxZAb85dyyBcIwA6zhdWO2OFeY2pskYnKMQUhRVUQcch/WsgWWFP8yb/MKR+LARVmju7tIK/OqOFfzLzIoFzmSXAgMhoHCLq+chHpAxWEDpdj39LWZi7oz8gw63uxUwkNVUwBuORAR1h2GtfGa19nXYIR5AGOR0gzBslSRQWgxx/V7VrFG+9xFEQaBmYGu15DWhHpD03YDW/1gCPdyfI4VN8v5CkjiH9r2l0YXxCj665a5L3Q9I/jw+C5sbxZEqKVlAyX4a7UQppiSEh/AoppnB2B9VOol2riMfZ8efPoqNIze+GExuuI5MkkHB8VfACNMh8D01isMzZhRHFHjB3AhkV7Tjn2SjGO8PJT6GgcE5aNzOdYByr81R7K/h0U7knqGjOIIrXpQI7JsYyEThZZemmIYVb5urbpnNZehHnRaA8+Ab3m+choZOF/JBftNMzRmmM77OJuNa80m0mHoSHu/CJc2Nq18n8klQEmFRFeoXJQKL4khYKJqrrNg1rX49pxNQSAlFZX/tWNoWXvzqNXEcPXv/loH+seQGnt+TS653eeH5LdvFyyGkwW1uz943Y0ZvDJ27JCbAE7V81FzTOYFLa56sevduPLeZTFV5ig9ZwHWHnp9/c54LpTrxPKko9aY+HOYoq1GtKetO4+jqbmKuWKLa4VGdfZfD0LKqLEGzRGkJ+vtmZO3BENfb2prG0eRu8iZ/SfJ+wM0b303de8pGmGVq/D9wffx0GkfZ3bj+XOdL/B+R3dqezs46n4ZTp98NVDr5HOzW9C7AcKggHOZy9eWhTkE3GDFQKgculzjRHzrvSrFH6Io88rEseuYW2oQDxaV3aUgAU2YoIh1sFfNOh3sDZ/7pEZ2yPWwgZ9FUA4NQMsxn3IQDCCljmOPoIITLEaSHfOBJhslp1mHFh/hGT6k+mKWlKhPQy7iht/Yc0B+1GQiXXSLkaN45bHCH8iyatHeau4MteMhRnufhydE9eEmua9sljLlz2lHp5mCHJ0eYPCSG3g/rsLem5kRgLZ8DYegXsUvBQ4JBbdsnLroAkjiiQqraLO+v49N22mwZoVSYGzGKZ/HNOq91aeJZriFukaosJjn65E5mLJRmjo+ERc3IE1XdRyrv4CRno4peRyyqbMgkopjrLPlHSJc0SxeftNIh38mLBUJiBu2MT4ErCNSYP2YgjRvO2ZAbCzrGTFrkvK7wYlNPCVclaAEygRtZoMGx7nOlb/Sb5nkwn0nz9s1rn2EaaAhKOUANdBNDyqqSpIY0oc7wCju3SPqSo4TaAfrzKgdt2fWgPCwfVCtBG8xC1kzpEZfim89KRo9EGWADyHjuQL2pwLclxAc1fB6ZYGv/869/N/Ba6XEuI+ZW4GmKkf47MKSLrRN49Lg1lGgB1TxGOB/ovy8eAogdKc3nQqW1Ipn7y/gRpv1ZU9tFqyhpGHJwqdXh5aG2tyYONtZ4txIfIDQ9FFAKtiqRXrgSxjZylMJL4rJ9eAPIx6SBA7khqNUo83LSVPAaL58LNZuOMqnEfH5bfQwu6MLtx5k772Z3Um+KMWdTSeM88t7mJv5b2PiQEh4SlWdZ8vnkb1F8/wvx7deBkJR8kyjOJObHrPezKWWRZCgkK3R+Bn67q9G86G/A5FU2eJmIQ/Gq//Zbv3sg+qYv3zxJnve3+xflh3fPXz3rwORVN+m9m3zovbMf3+em/0WJ5OdX2Sf5zgyeP6k+fvikP37o64/v31j+/snuQGZy8PInkUyefBn0NsXr5682P73vjgcvf9r89O5Z+Ykm/2nz08XFZlIcPB/IXYQpP374pzj8svd4/9vet/2Tvav9b/mzDj/4+uX5VfJs/2Jvu/2pr9v7h4N/fPlqyzdP0scHH8T2U9iH9/Jk83USNaVByFxI+By2+jPR/Rk3e0pCsXXTth+rAmxGsk6Z6Fphmnvp0rmtnjA+4kIyZJ3+A6UAtFb69j39dZjdxoitzc3P3ZoJT5aZ0Jf0vkQVHyfqAuSfS2lzeeuWR1SvCpJ6d6BEwgFRfzRHbLPdEWkgqbSwk2jn9Dq6avNStF3/zun59DyOkLEKY2ClMoQxt1m0E20shsSw8IbiLafXTgdrRTNcpvgGtKRsvBQbl91oGi+OuFE1V0Iby0dCjtq3jjqfUXqMu+EYPkfvLGhRin8ARi08O5tQcSRQCjLg6PcjA3GT38zigXthq0Kk7sbg22xPFsNpIZo2FyBbPNNuCHk1Il6nIdxEEaQ6gBTNKIrqIA/+rMM2pzPJqyMkIUDSpchCb2uLruA/dOmu+vgpXQO3tqfnjsONKxFFXJt+vQvkzzmovmneYYuiBQdpzktZdFJWOgwr/IXgJAo5VLTnfh8OS5DH6IOjZl12l6/dkCeqqHOTA/h//vVvGhHOZ1rmb+yw0qxUY9BYOEaFUzlcCfR6EZgQMxRVpKg7L3IwBkON0sLI1XyJESU5BFcy4SUfYOkVOqpCWuVyiRrWxnTY+wzw7QO7HmmX73EJOVoYlitF1Ujo9lRWFc26MjZW+mKIKGHJ2ABLFtCZMwBhCMiMywRfIpwKkSOE1VfonJdaGGBcFAhM1WPDoUgETox2UfPEsoJLPiKPJqbrP3KhDAUHWg3wjmVUXrlbBJY9AFhHIr2EdNgLvLUR4diYgsVtT90FwsTuAufNpK/uGuBlucTlRQJmlhiWwyVoMhnu+l3lOSuVdVdidOmae4sTWc2lwQCDQyhsTc0+7+bTGimfdBg+h+CRhM4uCkAu5IWrvjmtxew9DIywMAt9jMfjJfP1/fyYl8Jm1QAdZzUbN6JGMnbN4fXH92hsQBfmcHiMxZFJcIJWrLlBwBv+VOMJnWpB2XgpbnTNc5GANNA4g3ZfHr1ml+xxZzOKGwb7HghvvO4/3zs43sN58Uhx+tftbHY2KV6rjC24bCxFBaN1/eii5jaeZ9Z1pus603Wd6brOdF1nuq4zXdeZrutM13Wm6zrTdZ3pus6UretM13WmfxLt6zrTdZ3pus50XWe6rjNd15mu60zXdabrOtN1nem6znRdZ7quM13Xma7rTP9X0reuM32IkriuMw35VugVbpQ5F7KRw+pS7U4Xqk/P4yjDVLyd0+j6Gp+C3+p8OsXmrxVozOM7j6NLrgWGuCmLLw7papjgdQGTaCd67iL27RNcPnbSTukdC8mLmG3nRuzSrt8K28wWPDo8PoniaOArZAuV4hjNx1g9y8cuy8szk+ojOZU+5VyOKso3i9ycmGHHK5vNp+ddUHqe/9FIW+Ny0sBwPm/PkYF/kagbB1xfu9S/6bSGd10rR3jGBmjcvvPpdPpfiqzABw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"}}');var s=t(74848),r=t(28453),o=t(33617),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztG9t22zjuV7h66YyP7MRummnztJk203G3uWyTXpOcDi3BFhuJVEkqjpvjt/2S/bT9kj0ASVm24yRz2dnMOX5JLBIkARAAQRC4jiwfmWjnNDqBosy5BROdx1EKJtGitELJaCc6yYCFbvZC86EVcsR2j/oMJB/kYFhlQBtmFUs0IFBSGasK8Q17mQ0zx8yAvsSx3LBBXkGphbSGDZVmI5CgOU2cqqQqADvGwmas1JDCUEhImbG6SmylwXTY21JJZqokAWOGVe5WFkoyNWS8XjNmNgNCVYOttDSMs0qKrxWwVksNvkBi+2mrxb5LwYiR5BZSRC4M/yzS72M2zkSSsYRLNgAkNUVKPcLQQHfAsU9JWtOUkIihQGA/WYftpqlAHHmeT2LGWatV6bzVYsKwUqtLkUIaVlPDIbKUE2uZkBb0kCdAvAKcRY5omTA54zJlQ56IXNh5NrJUGKvFoMKVO2fyTJ6Icoe9LXPFUzZRlWZHL36agVvFsO201XoBg2rE3vZbrfPvMmtLs7Oxwcuyo0qQyK2cD0wnUcVGioBlOiRegQaclfgF3Ih8wniasrFIR2ANbYhkiSonLFFKp0I60Sj5CJisigFoExM1hdLAhGScaeDppG1VuzLAXh0fHiAbCm477CivTFwvlwoNic0nbnpkT6Dqkdud7S2UISFHMSv4BXJJWPa1EskFkm1A0tZ6kSFetVrvEd+aO8J4GU8Zs5kwbAyDTKkLBpfYPRZ5zqwWoxHoVutM/vLLL2fy+kwydhYRxFm0w84iP8VZFLsuOynB9bw4fP52f+/g5PPJx6O9uj9I6gJM/0UNMRT54gxv37yuuyUvFrsPdvdnC0hlff9RDtwA03ApYEz7gFvtaA1cqIc17IQbXffgINAGW0+xhbFr928em+P+y4O9N01cHAQUXORzIHv7u/3XczBlpuT8NEc/Hx7Mz1Ppxiz9g5eOKa5/iv/OPb5+R3b9Bp309/eOT3b3jxB46vcRpeG4KkulcfvfO4HewW0+kz9CrsaMayDpSVRRKMlKrnkBlmxjxi11a/haCQ2pM248z4Nm7JzJNmu1UBR2Wi3Wl6lIUDWcmk9KQMvmYDsOFFUGQY+9qXGgDUVCW+TMCWrImDvtLnM0JAiqAa2UFZcwP/FVzCY48QtAuXDTZkqLb0panpNQXIK2IuF5U4kRQTJ9lmsyQaUS0oZWvwL76JUVdZlU1FsZRC1FZhVCUo8BdsnzCozHahyzDLF6A6UGQxbXz4uMlCnLQIyylevx9Etl7NzErDLBjgYs/Fphl4i9QGwb8twAE8M5Xhb8AhqrMVU6+95hP05YCkNe5TZmAu2P1RV02IGyjJdlLhI6G9Gcu4On0tCmXfbi4BFBVUEkjtz5gCdCKvBsQGuDnTSFHxOwQzlzBwqSR3bUZlwyJRc2OlG50ssiRM3zfGSJkhak7bDdSy5yQt4Ra5iQSV6lwAY5Ty5iOtljpvEsw12ZQJ6rcezknUDohCWeE3+YgRylUEnEXyq/vDCzM7TDTtD+1PqEnYHVtIgwTa56Gz5UuDKyIKgYI7sSE+Ni9kUNmBU2hxgVtuRyErPUOQ1wZQfqKmZJBskF/dI8FYoNKmuVdISlWpWpGkvPy6GS1ohvN2hk6Pn1HO3FbCtm2zF7GrPuZsy6vZh1t2LW3Y5Z92nMepsx6/Vi1tuKWW/bodV76nnNawY3Eej2HJftX4e7aHdfC0OajQbT1DZ4PGeDux3WatXatHj8zs7YGqQ+rdBmYl/Xf1/hx+PeD/5zgp/bvaf+c0yg3S3/meFnr9s8J3qEieVFeQsW2P2HYhCcBSdE2ObP3LMo2DNsREMUh47ZUezxwY5pk5bHSIuQwgqem9XkBIgHRNEMpSWitpAoEtfVFHkf5MGQ08SHXBY0k66LzGqjKyg8YdFbov5Jx58sq4l3yz4Y2hvo/D7St5F0NE0naJpW019brwfEhEWcfh8nfuiQA0CWeTUfPMAD4sI8Rr+PB0+RB3gorWYA9j4g6hvouAsYnfCub3Or3X3S7m32tuY4gDdlB1AU7TRtTyaTP4J76PP45dHlCR6q8+wwIjHUqrjh+kG3gxmU94nod3DZ99FRH0AdFMEowHxMJdz/m162VSmfPDJuqjC0ds4QfuaaTRpoUhfiQbGQJFMi8cgjTHDJBnjB6yAP2sTJjTTdcJwMbWnaLoomd7ERP9vE90ZjUXTStLMAubQ5rrFgaRqz5eYb29OUFUWxotm1n0XkUT1DyfeO2Grh9wB/lvzPxHx+4Vt1A4NDSua0Nt3RblaOhRMkEyEW4yWFLQBoGFU513CFl02zGOD4AxUn6M3MXafLKd3rXISPWMG+O/Qu+fdeppGE+Qmw5e5xS5Q1J9Ewgiuaw8VwERmRUmQ1xnBrhpc3Hjx/5PssaEdfCS8FBglysJZawSadm5Bwu9a4YOOuLt6vDdg5YrhhYeQNV2zafhLv7iadbv5+ccvx5iEekIVfQAk7XbTCxdKigpMDgFIGs9/KZqDPovN6jLtUQ3rH2PN76FEmUsj5APLlrnvrQJMWL08NxmBHIWQdCCB8NxtxvIJfLXSezWJ4C7rlKG4KdbDhQTUCi1kuTAiFzPOrOdrHiiiCJ8FF/wfAwgA2qMXwd4t5jdj95NxZAb85dyyBcIwA6zhdWO2OFeY2pskYnKMQUhRVUQcch/WsgWWFP8yb/MKR+LARVmju7tIK/OqOFfzLzIoFzmSXAgMhoHCLq+chHpAxWEDpdj39LWZi7oz8gw63uxUwkNVUwBuORAR1h2GtfGa19nXYIR5AGOR0gzBslSRQWgxx/V7VrFG+9xFEQaBmYGu15DWhHpD03YDW/1gCPdyfI4VN8v5CkjiH9r2l0YXxCj665a5L3Q9I/jw+C5sbxZEqKVlAyX4a7UQppiSEh/AoppnB2B9VOol2riMfZ8efPoqNIze+GExuuI5MkkHB8VfACNMh8D01isMzZhRHFHjB3AhkV7Tjn2SjGO8PJT6GgcE5aNzOdYByr81R7K/h0U7knqGjOIIrXpQI7JsYyEThZZemmIYVb5urbpnNZehHnRaA8+Ab3m+choZOF/JBftNMzRmmM77OJuNa80m0mHoSHu/CJc2Nq18n8klQEmFRFeoXJQKL4khYKJqrrNg1rX49pxNQSAlFZX/tWNoWXvzqNXEcPXv/loH+seQGnt+TS653eeH5LdvFyyGkwW1uz943Y0ZvDJ27JCbAE7V81FzTOYFLa56sevduPLeZTFV5ig9ZwHWHnp9/c54LpTrxPKko9aY+HOYoq1GtKetO4+jqbmKuWKLa4VGdfZfD0LKqLEGzRGkJ+vtmZO3BENfb2prG0eRu8iZ/SfJ+wM0b303de8pGmGVq/D9wffx0GkfZ3bj+XOdL/B+R3dqezs46n4ZTp98NVDr5HOzW9C7AcKggHOZy9eWhTkE3GDFQKgculzjRHzrvSrFH6Io88rEseuYW2oQDxaV3aUgAU2YoIh1sFfNOh3sDZ/7pEZ2yPWwgZ9FUA4NQMsxn3IQDCCljmOPoIITLEaSHfOBJhslp1mHFh/hGT6k+mKWlKhPQy7iht/Yc0B+1GQiXXSLkaN45bHCH8iyatHeau4MteMhRnufhydE9eEmua9sljLlz2lHp5mCHJ0eYPCSG3g/rsLem5kRgLZ8DYegXsUvBQ4JBbdsnLroAkjiiQqraLO+v49N22mwZoVSYGzGKZ/HNOq91aeJZriFukaosJjn65E5mLJRmjo+ERc3IE1XdRyrv4CRno4peRyyqbMgkopjrLPlHSJc0SxeftNIh38mLBUJiBu2MT4ErCNSYP2YgjRvO2ZAbCzrGTFrkvK7wYlNPCVclaAEygRtZoMGx7nOlb/Sb5nkwn0nz9s1rn2EaaAhKOUANdBNDyqqSpIY0oc7wCju3SPqSo4TaAfrzKgdt2fWgPCwfVCtBG8xC1kzpEZfim89KRo9EGWADyHjuQL2pwLclxAc1fB6ZYGv/869/N/Ba6XEuI+ZW4GmKkf47MKSLrRN49Lg1lGgB1TxGOB/ovy8eAogdKc3nQqW1Ipn7y/gRpv1ZU9tFqyhpGHJwqdXh5aG2tyYONtZ4txIfIDQ9FFAKtiqRXrgSxjZylMJL4rJ9eAPIx6SBA7khqNUo83LSVPAaL58LNZuOMqnEfH5bfQwu6MLtx5k772Z3Um+KMWdTSeM88t7mJv5b2PiQEh4SlWdZ8vnkb1F8/wvx7deBkJR8kyjOJObHrPezKWWRZCgkK3R+Bn67q9G86G/A5FU2eJmIQ/Gq//Zbv3sg+qYv3zxJnve3+xflh3fPXz3rwORVN+m9m3zovbMf3+em/0WJ5OdX2Sf5zgyeP6k+fvikP37o64/v31j+/snuQGZy8PInkUyefBn0NsXr5682P73vjgcvf9r89O5Z+Ykm/2nz08XFZlIcPB/IXYQpP374pzj8svd4/9vet/2Tvav9b/mzDj/4+uX5VfJs/2Jvu/2pr9v7h4N/fPlqyzdP0scHH8T2U9iH9/Jk83USNaVByFxI+By2+jPR/Rk3e0pCsXXTth+rAmxGsk6Z6Fphmnvp0rmtnjA+4kIyZJ3+A6UAtFb69j39dZjdxoitzc3P3ZoJT5aZ0Jf0vkQVHyfqAuSfS2lzeeuWR1SvCpJ6d6BEwgFRfzRHbLPdEWkgqbSwk2jn9Dq6avNStF3/zun59DyOkLEKY2ClMoQxt1m0E20shsSw8IbiLafXTgdrRTNcpvgGtKRsvBQbl91oGi+OuFE1V0Iby0dCjtq3jjqfUXqMu+EYPkfvLGhRin8ARi08O5tQcSRQCjLg6PcjA3GT38zigXthq0Kk7sbg22xPFsNpIZo2FyBbPNNuCHk1Il6nIdxEEaQ6gBTNKIrqIA/+rMM2pzPJqyMkIUDSpchCb2uLruA/dOmu+vgpXQO3tqfnjsONKxFFXJt+vQvkzzmovmneYYuiBQdpzktZdFJWOgwr/IXgJAo5VLTnfh8OS5DH6IOjZl12l6/dkCeqqHOTA/h//vVvGhHOZ1rmb+yw0qxUY9BYOEaFUzlcCfR6EZgQMxRVpKg7L3IwBkON0sLI1XyJESU5BFcy4SUfYOkVOqpCWuVyiRrWxnTY+wzw7QO7HmmX73EJOVoYlitF1Ujo9lRWFc26MjZW+mKIKGHJ2ABLFtCZMwBhCMiMywRfIpwKkSOE1VfonJdaGGBcFAhM1WPDoUgETox2UfPEsoJLPiKPJqbrP3KhDAUHWg3wjmVUXrlbBJY9AFhHIr2EdNgLvLUR4diYgsVtT90FwsTuAufNpK/uGuBlucTlRQJmlhiWwyVoMhnu+l3lOSuVdVdidOmae4sTWc2lwQCDQyhsTc0+7+bTGimfdBg+h+CRhM4uCkAu5IWrvjmtxew9DIywMAt9jMfjJfP1/fyYl8Jm1QAdZzUbN6JGMnbN4fXH92hsQBfmcHiMxZFJcIJWrLlBwBv+VOMJnWpB2XgpbnTNc5GANNA4g3ZfHr1ml+xxZzOKGwb7HghvvO4/3zs43sN58Uhx+tftbHY2KV6rjC24bCxFBaN1/eii5jaeZ9Z1pus603Wd6brOdF1nuq4zXdeZrutM13Wm6zrTdZ3pus6UretM13WmfxLt6zrTdZ3pus50XWe6rjNd15mu60zXdabrOtN1nem6znRdZ7quM13Xma7rTP9X0reuM32IkriuMw35VugVbpQ5F7KRw+pS7U4Xqk/P4yjDVLyd0+j6Gp+C3+p8OsXmrxVozOM7j6NLrgWGuCmLLw7papjgdQGTaCd67iL27RNcPnbSTukdC8mLmG3nRuzSrt8K28wWPDo8PoniaOArZAuV4hjNx1g9y8cuy8szk+ojOZU+5VyOKso3i9ycmGHHK5vNp+ddUHqe/9FIW+Ny0sBwPm/PkYF/kagbB1xfu9S/6bSGd10rR3jGBmjcvvPpdPpfiqzABw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,x={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," 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, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," 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, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy"'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.1eb0d033.js b/assets/js/2c586be5.1eb0d033.js new file mode 100644 index 000000000..bd3f2469d --- /dev/null +++ b/assets/js/2c586be5.1eb0d033.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9599],{60112:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>g,default:()=>b,frontMatter:()=>y,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/createdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocument","permalink":"/docs/API-docs/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyGzeyv4KdF8eqISXSsuPV0zp2dld7ciJVJFfqlKRSwJkmB9YMMAEwvETFt3zJftp+yVY3gLnwIsqXzcp16AeLAzSARqO70TfcR5ZPTHRyFb1TSVWAtCa6iaMUTKJFaYWS0Ul0mQF7q4FbYAGKvTk/ZTzP1cywyoA2zCo2AQkaoSTMWBrmY6MFK7WailTICUu55WwmbMZG3MCrYwYyUSmkbCxy6F/La3kpyhP2vswVT9lCVZqdv/trPRsug21XBwfvYFRN2PvTg4ObbzJrS3NyeMjLsq9KkEZMZM5Hpp+o4jBFwDIdP4/ZLAMNOCtLuGTAjcgXjKcpm4l0AtbEzGYgWaLKBUuU0qmQ3IKJWcknwGRVjECbmHGZskJpYEIyzjTwdNGzqlcZYP+4OPuRjZUuuO2z87wycb1cKjQkNl+46W0G9a6emUANY7WQk5gV/A6pJSz7tRLJHW7bgEzxLw58c35KtDo4uKjKUmkLKfvZbeHk4AB7voNczRjXQPCJKgolWck1L8DScWXcUreGXyuhIXWHwvM80OLkWvbYwYFdlHBycMBOZSoSJAZNiK1MjT1s34EikRD0ooREjIUHbZGOKclmmUgyosmMu/Msc544NDWYEhIrptCdeB6zBU78DqQKGGRKi9+UtDyn45iCtiLhefvYEEEENZZri+QslZA2tPoV2P/548HTo0PxfIWopUisQkjqMcCmPK/AeKxmMcsQq5+g1GCI1f28SEiZsgzEJNu6Hk8/VMZ2JmaVQTTbWPi1wikReYHINua5ASbGHVoW/A5aqzFFMszzPvtuwVIY8yq3MRPIcVZX0Gc/Kst4WeYi4aMckHMZCg+3lYYenbJnB4+I5AWd8TlJNBjGWSrGY9AonNhJU/gxATvks0YFkOTYjEum5MpBJypXep2FqLlLR5YoaUHaPnsz5SIn5N1mDRMyyasU2CjnyV3MRnkFMdOQOsFdAKqt2CshBGHceJoTfZiBHLlQScRfKr+8MMx4rNI+u8yEaeQJOwOpaRFh2lT1UjtWuDKSIIgYg4KLPCbCxeyDGjErbA4xCmzJ5SJGfQkxszC3IzWPWZJBcke/NE+FYqPKWiXdxlKtylTNpKflWElrxG8bJDL0fDxFhzE7jtmrmL2O2eAoZoNhzAbHMRu8itngdcyGRzEbDmM2PI7Z8JVDa/ja05rXBG4jMBg6Ktuvh7qod38QhiQbFaapdfCso4MHfXZwUEsTtv3yyy/X8v5aMnYdoXBdRyfsOqpBrqPY9aHOxL6B/57jx4vht/5zgZ+vhq/954xAB8f+M8PP4eBaLv2C13JImFhelA9ggd1fFAP/5ZkI22hRbAv6DBtREcWhA8+qgw92LNt7eYF7EVJYwXOzfTsB4gntqEFpbVPHuCli1+07ou4ntJ02PthDatJ1kVptdQWBJyyGa7t/2fc3y/bNu2WfzN5b6Hze1l/h1lE1XaJq2r7/Wns9ISKs4vR5lPi2TwYAaebtdPAAT4gKXYw+jwavkQZ4KW0nAPY+od230MEOf8O7vqPj3uBlb3g0PO5QAH0jB1AUvTTtLRaLL0E9tHn88mjyBAvVWXbolY61Kja4H+QdNFDeJqLfwWT/XzTUR8GGhRT9PnIsgsVSe3xtK9uqlC+eGTdVGFobZwjfmGaLFprUhXiQ95tkSiQeeYQJJtkIHbw+0qBHlDxM00NHydCWpr2iaFMXG/GzR3RvNRZFP037K5Brh+MaC5amMVtv3tiepqwoii3Nrv06Iovqz8j53hDbzvwe4I/i/4bNuws/KBsYDlAyp7XJR9ssHCs3SCak7/CcwlYANEyqnGuYo7NphJIO+ssLTpCbxlwn55T8OnL9HSnYN2feJH/ueRq30J0AW3aPW9tZexINE5jTHEllrCoQGZFynCFmpkoydN54sPyR7k2Yhr4SXgoMEuRgLbWCTfqbkHCn1nKw8VRX/WsDtrMZblgYucHFpuMn9h4c0e3m/YsHrjcP8YQ0/ApK2OmiFdh9dR0VnAwA5DJofiubgb6ObuoxzqmGdMfYm0fIUSZSyPkI8vWuR8tAey+en1qEwY5CyDoQQPgexa1OPl/pdH3LDbLldtxm6qDDg2gEErNcmBAK6dKrPdrHiiiCJwEoKDgCFgZgvDVI7ueyeY3Y4/jcaQF/ODuWQDhGgHWcLqy2Y4XOwbQJg3MUQoqiKuqA47ieNZCs8Jd5m144EsPYYYX26a6twOc7VsDo3vYFruWAAgMhoPCAqechnpAyWEHpYTn9FDXRuSO/0OW2WwDDttoCuOFKRFB3GdbCZ7ZLX5+d4QWEQU43CMNWSQKlxRDX54pmjfKjryAKArUDW9s5rw31hLhvA1r/YQ70cH8MF7a39xVxYgftR3OjC+MVfPKAr0vdT4j/PD4rhxvFkSox8SmUPE2jkyihXGlI7kUxTQ3GfqfSRXRyH/lAO/70YWwcevjBYLb1PjJJBgXHXwElzM9ifjSKKVYM2kRxRJEXTNYivaKTSI0+QIKrlRrRsQIMzkHjTu4DlEswRrH3w6OTyGUeoziCOS9KBI5WUrNlOo6WYcGHpqpbmqkM/agznTgP5vA+cZofcehyJT/9STO9a81AeyvgUr1V2GfhHV+Y1rzupo9W0+I4BuUg8aNYyhcGRasyzihLeJ5UOfr0MC+FXtQBBnLsW/xR41uvVOM7eLlsDr1BiWvNF1EcCQtFu30LE2j18SeXgELKUJT3Y8d+UDAC+ItvwCw8HTwvPhqLDwrYCOjQy0zJjx4/GL4YDAcvBkOcwadnPp2Orncdgy5jvEF3FNJgqPeajGrMKKvR38WjAZ62zSewmxkvt2XaWwk+k6kqTzF1Blz3KeH9ybUUXf6ur6P+Dm5extF892bmLFG9kMZn3+QwtqwqS9AsUVqCft6O5T2ZzQ2Pj5dxtNi9vcVXub1v8fBmu3f3M9U/NLUh/w1cX7xexlG2G9e/1xUa/0Vkj18tm9t1xXi4Hal0cRv01nIXYLgoEG6s8hQ0GiTr+qpRNahhsLLodlXPj5TKgcsNiqaTmvc1YGgXoknog9mzDNCsbsxFmr2xUL0B6bDFdD+sBBuFQUNQV3Ad9dnpuGXvUqxgtTogwFKmXir2jNa7NRWp8WeH/htp9KxdBYWFKU0QP6BAwMxCUeZURjQTeY54473eZ/U/svxqSiIC4boMC+++Kt66oCYt6Ad1a3CYtx377C2XdR1Gt96B3d/XbEDcsVyy+3s8VdC3eOkul3HTgGt1GuhedS0aEhDTzqi6CZqBdVtrqDNxbtHEcQ0+L9ZGQEykkJPbSufLZX+NDZszejTd1sjkzw4n+X9AMUTnVJ7pFPQjJPd07Fw2xZ4hsz7zAXKijNDGenl07O4RdmmuLVT29Qzo6X1fy7epRgahZJivkR+rxWQCWGvoIWiwrw4CnmROMxBWfIyiTfWDGqZCVSagl3FTm9wpQggnLkJOuh5nizpUvNXee3+T6EosJzq7PH8ELckf7jlN5JxJt0s3Bzu7PMeKRDH2vl2fvTc1JQJpeQeEoa/FpoKHqqXafFu4kCVIoohTm53y0b6vBeyxdYRSYTZiFDdJk7p+d23ipmQVj0hVFmtlhS/EMhZK06EjYVET8lJVj+HKHZTkbFJRytXirRxUIyVymopCIY3VlQvXsrTSoYjSswVCJmBMQ6dAFQRqzR8zkMYN52zMjQUds0oKpLyuMFpSTwnzErQAmcBGEmhwpEPJ3a3NuuV573/6wRcqhz0EoRyhBLqJIWVVSVxDklCXjYaTW936Rt3h1dZuBPGCpuJOH6kvQRslGRZl6gmX4jfHwuR0KIMeW8ZzB+pVBSasER+U8C4ywZz61+//bOG11e1cR8ytwNMU04c7MKRomWN4jNJrKFEDqi5GOB/ov6zaeYgdCc1todJakMzjefwca4mtqfWiVVR7Djm4QvmQzqz1rYmDjjXec8SspqbsIxLbqhL3C3NhbKvwMZQnrOuHnwDpmLRwIE8DpRp5Xi7aAl7j5Qssm+nIBhTdotna0l2RhYctVmfSNnEur4qxEFxJ45zu4dER/umStH6I4CdF4iGjj6s8X/wpih8fZHvY43fNm63oh1z47IMY/jZPpsPzyAdwuprgIwMPnxSFwTGrMZgt+ujBrXjfp9I5vnLAvfRqXqBpW2csZC4k3IYDvE1Vcht2j3AFGNMNaDwKh/q4yULonvWO5ZHFlnF0vImLLlQBNiPRwXlnWuHjizIHjo8B9ILxCReSoRugvyBTgdZKP+yXfRxmD5Hg+OjodlAT4eU6EU4l5cDpSc+lugP5x+60vbx1yyOq84IY1d1PkXBA1B91Nttud5s0kFRa2EV0cnUfzXu8FD3Xf3J1s7xBFrSZwjh9qQxhzG0WnUSHa2F7A3pKYdereyc3tSgYLlNMVK+FAngpDqeDaBmvjtgYONgKbSyfCDnpPTjqptnqBR6Ho3hnw426KcX/AOobT882VBwJZIMMOPoRSEE85Z+anMX34axCNmFTgqA5k9WQf4j4d4L4q1fkhrD85qj84GUrHn4VQtsUra6D1Zviz/XWQ0S5Dii3YsStEPFVw7N1NDYEYwcUxRweH1O479sBxcVevKaQ0/GrJXFZE36Jom6IhZJLq4GCKOo6wGFQ7d75UY2P4jKdHWPbN3WNzzBTbex1LK5Vg2ur8bPF9gkGr5BjRfzmmeCsBHmB/gSK9XSwHiWEPFFF/XgjgP/r93/SiMA8tMyf2FmlWalmoMeVewEyzmEu0IJvvUMMMSjgRQ7G5AuGhvuEXiSmYkJVYMEsTnjJRyIXqKcQTLmcTEvVmT77uYliPdOuIG4KOao3litFD/TQhKusKmiNcEfNlL4bI0ox42yEb7rQMDUAYQjIjMsEA2FOfMmowweJ6GiUWhhgXBQIjA4PjMciEWTrKGk1TywruOQTss5iilYiFcrwIkurEfqLRuWV84jwXRiAdVukVHGfvUMPlDZOuSiweOypc4ZM7JxRLz7+weMIHf8SlxcJmKZyNocpaFJXLpRQ5TkrlXXuPZqn7bPFiazm0uBl7/Ng/mhq8nmXhdZI+aLPMF+M9yEa7sgAuZB37nniVc1mP8PICAtNpHY2m62pzufdMX8TNqtG6ASoZtyEGknRtofXH89RL4EuzNn4AvRUJMFE2rLmIQEf+iuVu6BgEDZeio1uRi4SkAZaF+Cbv53/wKbsRf8oiluXxSMQPvzh9O33P158j/Pidebkb9A/6h9RekkZW3DZWmrlqe+q6Lby1/uXwfuXwfuXwfuXwfuXwV/N29X9y+D9y+D9y+D9y+D9y+D9y+D/HBH2L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4M/R03sXwbvXwbvXwbvXwZ/XS+DfQ0JWoWHZc6FbBXhucKjq9X3wjdxlGFl0slVdH+P2b/3WP2Pzb9WoLGs6SaOplwLjHFTUVMcinewauUOsHzkrQvZ9y5x/dixOyWcV2q5sPbIjXhDx/4gbLt46vzs4jKKo/Bco1ApjtF8hu+d+czVnXhq0hNUTm/Hci4nFRXRRG5OrDfilc26xUp3VKzkf7RqcbhctDDsVjG5beD/uKmNA+7vXSHUclnDu66tIzxhAzSe381yufw366da3Q==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),u=t(63723),h=t.n(u),m=(t(18766),t(79329),t(9303));const y={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzeyv4KdF8eqISXSsuPV0zp2dld7ciJVJFfqlKRSwJkmB9YMMAEwvETFt3zJftp+yVY3gLnwIsqXzcp16AeLAzSARqO70TfcR5ZPTHRyFb1TSVWAtCa6iaMUTKJFaYWS0Ul0mQF7q4FbYAGKvTk/ZTzP1cywyoA2zCo2AQkaoSTMWBrmY6MFK7WailTICUu55WwmbMZG3MCrYwYyUSmkbCxy6F/La3kpyhP2vswVT9lCVZqdv/trPRsug21XBwfvYFRN2PvTg4ObbzJrS3NyeMjLsq9KkEZMZM5Hpp+o4jBFwDIdP4/ZLAMNOCtLuGTAjcgXjKcpm4l0AtbEzGYgWaLKBUuU0qmQ3IKJWcknwGRVjECbmHGZskJpYEIyzjTwdNGzqlcZYP+4OPuRjZUuuO2z87wycb1cKjQkNl+46W0G9a6emUANY7WQk5gV/A6pJSz7tRLJHW7bgEzxLw58c35KtDo4uKjKUmkLKfvZbeHk4AB7voNczRjXQPCJKgolWck1L8DScWXcUreGXyuhIXWHwvM80OLkWvbYwYFdlHBycMBOZSoSJAZNiK1MjT1s34EikRD0ooREjIUHbZGOKclmmUgyosmMu/Msc544NDWYEhIrptCdeB6zBU78DqQKGGRKi9+UtDyn45iCtiLhefvYEEEENZZri+QslZA2tPoV2P/548HTo0PxfIWopUisQkjqMcCmPK/AeKxmMcsQq5+g1GCI1f28SEiZsgzEJNu6Hk8/VMZ2JmaVQTTbWPi1wikReYHINua5ASbGHVoW/A5aqzFFMszzPvtuwVIY8yq3MRPIcVZX0Gc/Kst4WeYi4aMckHMZCg+3lYYenbJnB4+I5AWd8TlJNBjGWSrGY9AonNhJU/gxATvks0YFkOTYjEum5MpBJypXep2FqLlLR5YoaUHaPnsz5SIn5N1mDRMyyasU2CjnyV3MRnkFMdOQOsFdAKqt2CshBGHceJoTfZiBHLlQScRfKr+8MMx4rNI+u8yEaeQJOwOpaRFh2lT1UjtWuDKSIIgYg4KLPCbCxeyDGjErbA4xCmzJ5SJGfQkxszC3IzWPWZJBcke/NE+FYqPKWiXdxlKtylTNpKflWElrxG8bJDL0fDxFhzE7jtmrmL2O2eAoZoNhzAbHMRu8itngdcyGRzEbDmM2PI7Z8JVDa/ja05rXBG4jMBg6Ktuvh7qod38QhiQbFaapdfCso4MHfXZwUEsTtv3yyy/X8v5aMnYdoXBdRyfsOqpBrqPY9aHOxL6B/57jx4vht/5zgZ+vhq/954xAB8f+M8PP4eBaLv2C13JImFhelA9ggd1fFAP/5ZkI22hRbAv6DBtREcWhA8+qgw92LNt7eYF7EVJYwXOzfTsB4gntqEFpbVPHuCli1+07ou4ntJ02PthDatJ1kVptdQWBJyyGa7t/2fc3y/bNu2WfzN5b6Hze1l/h1lE1XaJq2r7/Wns9ISKs4vR5lPi2TwYAaebtdPAAT4gKXYw+jwavkQZ4KW0nAPY+od230MEOf8O7vqPj3uBlb3g0PO5QAH0jB1AUvTTtLRaLL0E9tHn88mjyBAvVWXbolY61Kja4H+QdNFDeJqLfwWT/XzTUR8GGhRT9PnIsgsVSe3xtK9uqlC+eGTdVGFobZwjfmGaLFprUhXiQ95tkSiQeeYQJJtkIHbw+0qBHlDxM00NHydCWpr2iaFMXG/GzR3RvNRZFP037K5Brh+MaC5amMVtv3tiepqwoii3Nrv06Iovqz8j53hDbzvwe4I/i/4bNuws/KBsYDlAyp7XJR9ssHCs3SCak7/CcwlYANEyqnGuYo7NphJIO+ssLTpCbxlwn55T8OnL9HSnYN2feJH/ueRq30J0AW3aPW9tZexINE5jTHEllrCoQGZFynCFmpkoydN54sPyR7k2Yhr4SXgoMEuRgLbWCTfqbkHCn1nKw8VRX/WsDtrMZblgYucHFpuMn9h4c0e3m/YsHrjcP8YQ0/ApK2OmiFdh9dR0VnAwA5DJofiubgb6ObuoxzqmGdMfYm0fIUSZSyPkI8vWuR8tAey+en1qEwY5CyDoQQPgexa1OPl/pdH3LDbLldtxm6qDDg2gEErNcmBAK6dKrPdrHiiiCJwEoKDgCFgZgvDVI7ueyeY3Y4/jcaQF/ODuWQDhGgHWcLqy2Y4XOwbQJg3MUQoqiKuqA47ieNZCs8Jd5m144EsPYYYX26a6twOc7VsDo3vYFruWAAgMhoPCAqechnpAyWEHpYTn9FDXRuSO/0OW2WwDDttoCuOFKRFB3GdbCZ7ZLX5+d4QWEQU43CMNWSQKlxRDX54pmjfKjryAKArUDW9s5rw31hLhvA1r/YQ70cH8MF7a39xVxYgftR3OjC+MVfPKAr0vdT4j/PD4rhxvFkSox8SmUPE2jkyihXGlI7kUxTQ3GfqfSRXRyH/lAO/70YWwcevjBYLb1PjJJBgXHXwElzM9ifjSKKVYM2kRxRJEXTNYivaKTSI0+QIKrlRrRsQIMzkHjTu4DlEswRrH3w6OTyGUeoziCOS9KBI5WUrNlOo6WYcGHpqpbmqkM/agznTgP5vA+cZofcehyJT/9STO9a81AeyvgUr1V2GfhHV+Y1rzupo9W0+I4BuUg8aNYyhcGRasyzihLeJ5UOfr0MC+FXtQBBnLsW/xR41uvVOM7eLlsDr1BiWvNF1EcCQtFu30LE2j18SeXgELKUJT3Y8d+UDAC+ItvwCw8HTwvPhqLDwrYCOjQy0zJjx4/GL4YDAcvBkOcwadnPp2Orncdgy5jvEF3FNJgqPeajGrMKKvR38WjAZ62zSewmxkvt2XaWwk+k6kqTzF1Blz3KeH9ybUUXf6ur6P+Dm5extF892bmLFG9kMZn3+QwtqwqS9AsUVqCft6O5T2ZzQ2Pj5dxtNi9vcVXub1v8fBmu3f3M9U/NLUh/w1cX7xexlG2G9e/1xUa/0Vkj18tm9t1xXi4Hal0cRv01nIXYLgoEG6s8hQ0GiTr+qpRNahhsLLodlXPj5TKgcsNiqaTmvc1YGgXoknog9mzDNCsbsxFmr2xUL0B6bDFdD+sBBuFQUNQV3Ad9dnpuGXvUqxgtTogwFKmXir2jNa7NRWp8WeH/htp9KxdBYWFKU0QP6BAwMxCUeZURjQTeY54473eZ/U/svxqSiIC4boMC+++Kt66oCYt6Ad1a3CYtx377C2XdR1Gt96B3d/XbEDcsVyy+3s8VdC3eOkul3HTgGt1GuhedS0aEhDTzqi6CZqBdVtrqDNxbtHEcQ0+L9ZGQEykkJPbSufLZX+NDZszejTd1sjkzw4n+X9AMUTnVJ7pFPQjJPd07Fw2xZ4hsz7zAXKijNDGenl07O4RdmmuLVT29Qzo6X1fy7epRgahZJivkR+rxWQCWGvoIWiwrw4CnmROMxBWfIyiTfWDGqZCVSagl3FTm9wpQggnLkJOuh5nizpUvNXee3+T6EosJzq7PH8ELckf7jlN5JxJt0s3Bzu7PMeKRDH2vl2fvTc1JQJpeQeEoa/FpoKHqqXafFu4kCVIoohTm53y0b6vBeyxdYRSYTZiFDdJk7p+d23ipmQVj0hVFmtlhS/EMhZK06EjYVET8lJVj+HKHZTkbFJRytXirRxUIyVymopCIY3VlQvXsrTSoYjSswVCJmBMQ6dAFQRqzR8zkMYN52zMjQUds0oKpLyuMFpSTwnzErQAmcBGEmhwpEPJ3a3NuuV573/6wRcqhz0EoRyhBLqJIWVVSVxDklCXjYaTW936Rt3h1dZuBPGCpuJOH6kvQRslGRZl6gmX4jfHwuR0KIMeW8ZzB+pVBSasER+U8C4ywZz61+//bOG11e1cR8ytwNMU04c7MKRomWN4jNJrKFEDqi5GOB/ov6zaeYgdCc1todJakMzjefwca4mtqfWiVVR7Djm4QvmQzqz1rYmDjjXec8SspqbsIxLbqhL3C3NhbKvwMZQnrOuHnwDpmLRwIE8DpRp5Xi7aAl7j5Qssm+nIBhTdotna0l2RhYctVmfSNnEur4qxEFxJ45zu4dER/umStH6I4CdF4iGjj6s8X/wpih8fZHvY43fNm63oh1z47IMY/jZPpsPzyAdwuprgIwMPnxSFwTGrMZgt+ujBrXjfp9I5vnLAvfRqXqBpW2csZC4k3IYDvE1Vcht2j3AFGNMNaDwKh/q4yULonvWO5ZHFlnF0vImLLlQBNiPRwXlnWuHjizIHjo8B9ILxCReSoRugvyBTgdZKP+yXfRxmD5Hg+OjodlAT4eU6EU4l5cDpSc+lugP5x+60vbx1yyOq84IY1d1PkXBA1B91Nttud5s0kFRa2EV0cnUfzXu8FD3Xf3J1s7xBFrSZwjh9qQxhzG0WnUSHa2F7A3pKYdereyc3tSgYLlNMVK+FAngpDqeDaBmvjtgYONgKbSyfCDnpPTjqptnqBR6Ho3hnw426KcX/AOobT882VBwJZIMMOPoRSEE85Z+anMX34axCNmFTgqA5k9WQf4j4d4L4q1fkhrD85qj84GUrHn4VQtsUra6D1Zviz/XWQ0S5Dii3YsStEPFVw7N1NDYEYwcUxRweH1O479sBxcVevKaQ0/GrJXFZE36Jom6IhZJLq4GCKOo6wGFQ7d75UY2P4jKdHWPbN3WNzzBTbex1LK5Vg2ur8bPF9gkGr5BjRfzmmeCsBHmB/gSK9XSwHiWEPFFF/XgjgP/r93/SiMA8tMyf2FmlWalmoMeVewEyzmEu0IJvvUMMMSjgRQ7G5AuGhvuEXiSmYkJVYMEsTnjJRyIXqKcQTLmcTEvVmT77uYliPdOuIG4KOao3litFD/TQhKusKmiNcEfNlL4bI0ox42yEb7rQMDUAYQjIjMsEA2FOfMmowweJ6GiUWhhgXBQIjA4PjMciEWTrKGk1TywruOQTss5iilYiFcrwIkurEfqLRuWV84jwXRiAdVukVHGfvUMPlDZOuSiweOypc4ZM7JxRLz7+weMIHf8SlxcJmKZyNocpaFJXLpRQ5TkrlXXuPZqn7bPFiazm0uBl7/Ng/mhq8nmXhdZI+aLPMF+M9yEa7sgAuZB37nniVc1mP8PICAtNpHY2m62pzufdMX8TNqtG6ASoZtyEGknRtofXH89RL4EuzNn4AvRUJMFE2rLmIQEf+iuVu6BgEDZeio1uRi4SkAZaF+Cbv53/wKbsRf8oiluXxSMQPvzh9O33P158j/Pidebkb9A/6h9RekkZW3DZWmrlqe+q6Lby1/uXwfuXwfuXwfuXwfuXwV/N29X9y+D9y+D9y+D9y+D9y+D9y+D/HBH2L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4P3L4M/R03sXwbvXwbvXwbvXwZ/XS+DfQ0JWoWHZc6FbBXhucKjq9X3wjdxlGFl0slVdH+P2b/3WP2Pzb9WoLGs6SaOplwLjHFTUVMcinewauUOsHzkrQvZ9y5x/dixOyWcV2q5sPbIjXhDx/4gbLt46vzs4jKKo/Bco1ApjtF8hu+d+czVnXhq0hNUTm/Hci4nFRXRRG5OrDfilc26xUp3VKzkf7RqcbhctDDsVjG5beD/uKmNA+7vXSHUclnDu66tIzxhAzSe381yufw366da3Q==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," 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, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," 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, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy"'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"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. \n",example:!0},email_subject:{type:"string",description:"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}}.",example:""},email_body:{type:"string",description:"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}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.98316ca0.js b/assets/js/2c586be5.98316ca0.js deleted file mode 100644 index dbb3c013b..000000000 --- a/assets/js/2c586be5.98316ca0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9599],{60112:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/createdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocument","permalink":"/docs/API-docs/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztG9lyHLfxVzrzIos1u+SuKFnhU2TJSZjYJsukypUiWTR2pncH4gwwBjB7mLVv+ZJ8Wr4k1Tjm2INLHXHoyupB3AEaQKPR3egL95FhEx2dXEXvZFIVKIyObuIoRZ0oXhouRXQSXWYIbxUygxCg4M35KbA8lzMNlUalwUiYoEBFUAJnkIb5YLSAUskpT7mYQMoMgxk3GYyYxlfHgCKRKaYw5jn2r8W1uOTlCbwvc8lSWMhKwfm7P9ez0TLUdnVw8A5H1QTenx4c3HyVGVPqk8NDVpZ9WaLQfCJyNtL9RBaHKQGW6fh5DLMMFdKskDAByDTPF8DSFGY8naDRMZgMBSSyXEAipUq5YAZ1DCWbIIiqGKHSMTCRQiEVAhfAQCFLFz0je5VG+NvF2Q8wlqpgpg/neaXjermUK0xMvnDTmwzrXT3TgRraKC4mMRTsjqjFDfxS8eSOtq1RpPSXBr45P7W0Oji4qMpSKoMp/OS2cHJwQD3fYC5nwBRa+EQWhRRQMsUKNPa4MmZst8JfKq4wdYfC8jzQ4uRa9ODgwCxKPDk4gFOR8oSIYSekVpBjD9t3oEQkAr0oMeFj7kFbpAMpYJbxJLM0mTF3nmXOEoemQl1iYvgUuxPPY1jQxO9QyIBBJhX/VQrDcnscU1SGJyxvHxshSKDaMGWInKXkwoRWvwL8wx8PnZ49FM9XhFpKxCq4sD0aYcryCrXHahZDRlj9iKVCbVndz0uEFClkyCfZ1vVY+qHSpjMxVJrQbGPh1wqnZMmLlmxjlmsEPu7QsmB32FoNpJVhlvfhmwWkOGZVbmLgxHFGVdiHH6QBVpY5T9goR+JcIOFhplLYs6fs2cEjIlhhz/jcSjRqYJDy8RgVCSd12in8mIAd8VmjAqzkmIwJkGLloBOZS7XOQra5S0dIpDAoTB/eTBnPLfJusxq4SPIqRRjlLLmLYZRXGIPC1AnuAkltxV4JEQgw7Wlu6QMac+JCKQh/If3yXIP2WKV9uMy4buSJOgOp7SJct6nqpXYsaWUiQRAxwILxPLaEi+GDHIHhJseYBLZkYhGTvsQYDM7NSM5jSDJM7uwvxVIuYVQZI4XbWKpkmcqZ8LQcS2E0/3WDRIaej6foMIbjGF7F8DqGwVEMg2EMg+MYBq9iGLyOYXgUw3AYw/A4huErh9bwtac1qwncRmAwdFQ2vx/qkt79jmsr2aQwda2DZx0dPOjDwUEtTdT2888/X4v7awFwHZFwXUcncB3VINdR7PpIZ1LfwH/P6ePF8Gv/uaDPV8PX/nNmQQfH/jOjz+HgWiz9gtdiaDExrCgfwIK6vygG/sszEbXZRakt6DNqJEUUhw46qw4+1LFs7+UF7YULbjjL9fbtBIgntKMGpbVNHdOmLLtu35HtfkLbaeNDPVZNui6rVltdQeAtFsO13b/s+5tl++bdsk9m7y10Pm/rr2jrpJouSTVt33+tvZ4QEVZx+jxKfN23BoDVzNvp4AGeEBW6GH0eDV4TDehS2k4A6n1Cu2+hQx3+hnd9R8e9wcve8Gh43KEA+UYOoCh6adpbLBZfgnpk8/jlyeQJFqqz7MgrHStZbHA/rHfQQHmbyP4OJvv3ZKiPgg2LKfl91rEIFkvt8bWtbCNTtnim3VRhaG2cEXxjmi1aaNouwsN6v0kmeeKRJ5hgko3IwesTDXpE9/Tw++8PW5R0jb2i6K000mfPEr7VWBT9NO2vQK6djmssIE1jWG/e2J6mUBTFlmbXfh1Zk+qPxPreEtvO/R7gtxKAhs+7Cz8oHBQPkCK3a1snbbN0rFwhGRe+w7MKrAAonFQ5Uzgnb1NzKRz0l5ecIDiNvW69U+vYWd/fkQK+OvM2+XPP1LSF7gTUsnvc2s7akyic4NzOkVTayIKQ4SmjGWLQVZKR98aC6U90b+I09ithJacoQY7G2FY0SX8TEu7UWh42neqqg63RdDbDNISRG3xse/yWvQdH9nrzDsYD95uHeEIqfgUl6nThCuq+uo4KZi0A4jJsfkuTobqObuoxzqvGdMfYm0fIUcZTzNkI8/WuR8tAey+en1qEoY6CizoSYPE9iludbL7S6fqWG2TL7bjN1EGJB9EIJIac6xAL6dKrPdoHi2wITyDaqOAIIQyggGuQ3M9l8xqxx/G50wL+cHYsQXBgAetAXVhtxwqdg2kThuYouOBFVdQRx3E9ayBZ4W/zNr1oJMWxwwrt011bgc13rEDhve0LXIuBjQyEiMIDtp6HeELKYAWlh+X0U9RE5478QpfbbgEM22oL4IYrkUDdZVgLn94ufX04owuIopxuEMWtkgRLQzGuzxXNGuVHX0E2CtSObG3nvDbUE+K+DWj9lznQw/02XNje3u+IEztoP5obXRyvYJMHnF3b/YT4z+OzcrhRHMmSMp9citM0OokSmywN2b0otlOjNt/IdBGd3Ec+0k4/fRybhh5+0JRuvY90kmHB6FdAiRK0lCCNYhssRqWjOLKhF8rWEr2ik0iOPmBCq5WK0DEcNc1hx53cByiXYYxi74hHJ5FLPUZxhHNWlAQcreRmy3QcLcOCD01VtzRTafujTnXSPJTE+8RpfqChy5UE9SfN9K41g91bgZfyraQ+g+/YQrfmdTd9tJoXpzEkB4kfBSlbaBKtSjujLGF5UuXk1OO85GpRRxisZ9/ijxrfeqUa38HLZXPoDUpMKbaI4ogbLNrtW5hAyY8/uQQlUcaGeT927AeJI8Q/+QZKw9uDZ8VHY/FBIozQHnqZSfHR4wfDF4Ph4MVgSDP4/Myn09H1rmPQZYw35I5iGgz1XpNSjcGmNfq7eDTA222zCe5mxsttqfZWhk9nsspTyp0hU32b8f7kYoouf9fXUX8HNy/jaL57M3NIZC/k8eGrHMcGqrJEBYlUAtXzdjDvyWxueHy8jKPF7u0tfpfb+5oOb7Z7dz/ZAoimOOR/geuL18s4ynbj+te6RON/iOzxq2Vzu64YD7cjmS5ug95a7gIMFwXBjWWeoiKDZF1fNaqGNAyVFt2u6vmRlDkysUHRdHLzvgiM7EIyCX00e5YhmdWNuWhnbyxUb0A6bCnfjyvBRq7JEFQVXkd9OB237F0bK1gtDwiwNlUvJDyz693qyqrxZ4f+m2j0rF0GRZUpTRQ/oGCBwWBR5raOaMbznPCme70P9T9r+dWUJATCdRkW3n1VvHVBTbugH9QtwgFvO/bhLRN1IUa34AHu72s2sNyxXML9PZ0qqlu6dJfLuGmgtToN9l51LQoT5NPOqLoJm4F1W2uoM3FuycRxDT4x1kaATwQXk9tK5ctlf40NmzN6NN3WyOTPjib5P6AYoXMqzlSK6hGSezp2LpuEZ8Ssz3yA3FKGK228PDp29wi7PNcWKvuCBvL0vq3lW1cjTVAizNfIj1F8MkEqNvQQdrAvD0KWZE4zWKzYmETbFhAqnHJZ6YBexnRtcqcEwZ24cDHpepwt6tjqrfbe+5tEV1A90dnl+SNoaf3hntNEzpl0u3RzwNnlOZUk8rH37frwXteUCKRlHRAgXwumnIWypdp8W7iQJQpLEac2O/WjfV8M2IN1hFKuN2IUN0mTuoB3beKmZpWOSFaGimW5r8TSBkvdoaPFoibkpawew5U7KMlgUtmcq6FbOahGm8hpSgq50EZVLlwLaaVCFaVnC4JMUOuGToEqBNSaPwYU2g1nMGbaoIqhEpworyqKltRT4rxExVEkuJEECh3pSHJ3a7Nufd77H7/zlcphD0EoRySBbmJMoSot11hJqOtGw8mtbn2j7vBqazeCdEHb6k4fqS9RaSmAqjLVhAn+q2Nh63RITR5bxnIH6lUFZawJH5LwLjLBnPr3P//Vwmur27mOmFuBpSmlD3dgaKNljuEpSq+wJA0ouxjRfKj+tGrnEXZWaG4LmdaCpB/P4+dUTGx0rReNtMXnmKOrlA/pzFrf6jjoWO09R8pqKpt9JGIbWdJ+cc61aVU+hvqEdf3wIxIdkxYO1tMgqSaeF4u2gNd4+QrLZjprA/Ju1Wxt6a7IwsMWqzNpmziXV8VUCS6Fdk738OiI/nRJWr9E8JMS8YjRx1WeL/4QxY8Psj3s8bvmzVb0Qy589oEPf50n0+F55AM4XU3wkYGHT4rC0JjVGMwWffTgVrzvU6mcnjnQXno1L9hpW2fMRc4F3oYDvE1lcht2T3AFat0NaDwKh/q4rYXQPesdyxOLLePoeBMXXcgCTWZFh+adKUmvL8ocGb0GUAtgE8YFkBugviBToVJSPeyXfRxmD5Hg+OjodlAT4eU6EU6FzYHbNz2X8g7Fb7vT9vLGLU+ozgvLqO5+irgDsv1RZ7PtdrdJjUmluFlEJ1f30bzHSt5z/SdXN8sbYkGTSYrTl1JbjJnJopPocC1sr1FNbdj16t7JTS0KmomUEtVroQBW8sPpIFrGqyM2Bg62QmvDJlxMeg+Oumm2ekHH4Sje2XCjbkr+dyR94+nZhoojTmyQISM/gihIp/xjk7P4NpxVyCZsShA0Z7Ia8g8R/04Qf/WK3BCW3xyVH7xsxcOvQmjbRqvrYPWm+HO99RBRrgPKrRhxK0R81fBsHY0NwdiBjWIOj49tuO/rgY2LvXhtQ07Hr5aWy5rwSxR1Qyw2ubQaKIiirgMcBtXunR/V+Cgu09kxtn1T1/gMM9XGXsfiWjW4tho/W2yfYPByMZaW3zwTnJUoLsifILGeDtajhJgnsqhfbwTwf//zX3ZEYB67zB/grFJQyhmqceWegIxznHOy4FsPEUMMClmRo9b5Ashwn9gniSmf2CqwYBYnrGQjnnPSUwQmXU6mpep0H35qoljPlCuIm2JO6g1yKe0LPTLhKiMLu0a4o2ZS3Y0JpRgYjOhRFxmmGjEMQZExkVAgzImvNeroRSI5GqXiGoHxgoDJ4cHxmCfc2jpSGMUSAwUTbGKts9hGK4kKZXiSpeSI/EUt88p5RPQwDNG4LdpUcR/ekQdqN25zUWjo2FPnDOnYOaNefPyLxxE5/iUtzxPUTelsjlNUVl25UEKV51BK49x7Mk/bZ0sTGcWEpsve58H80dTk8y6LXSNliz5QvpjuQzLciQFyLu7c+8Srms1+wpHmBptI7Ww2W1Odz7tj/sJNVo3ICZDNuIlttIq2Pbz+eE56CVWhz8YXqKY8CSbSljUPLfChv1KZCwoGYWMl3+hm5DxBobF1Ab75y/l3MIUX/aMobl0Wj0D48LvTt9/+cPEtzUvXmZO/Qf+of2TTS1KbgonWUitvfVdFt5W/3j8N3j8N3j8N3j8N3j8N/t08Xt0/Dd4/Dd4/Dd4/Dd4/Dd4/Df7vEWH/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NPjLPczcPw3ePw3ePw1+6py4fxocikjIKjwsc8ZFqwrPVR5drT4YvomjjEqTTq6i+3tK/72n8n9q/qVCRXVNN3E0ZYpTkNtWNcWheofKVu6Q6kfeuph975LWjx2724zzSjEXFR+5EW/ssT8I266eOj+7uIziKLzXKGRKYxSb0YNnNnOFJ56a9g0qs4/HciYmla2iidycVHDEKpN1q5XubLWS/9EqxmFi0cKwW8bktkH/06Y2Dri/d5VQy2UN77q2jvCEDdB0fjfL5fI/XSlatQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"}}');var o=t(74848),s=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztG9lyHLfxVzrzIos1u+SuKFnhU2TJSZjYJsukypUiWTR2pncH4gwwBjB7mLVv+ZJ8Wr4k1Tjm2INLHXHoyupB3AEaQKPR3egL95FhEx2dXEXvZFIVKIyObuIoRZ0oXhouRXQSXWYIbxUygxCg4M35KbA8lzMNlUalwUiYoEBFUAJnkIb5YLSAUskpT7mYQMoMgxk3GYyYxlfHgCKRKaYw5jn2r8W1uOTlCbwvc8lSWMhKwfm7P9ez0TLUdnVw8A5H1QTenx4c3HyVGVPqk8NDVpZ9WaLQfCJyNtL9RBaHKQGW6fh5DLMMFdKskDAByDTPF8DSFGY8naDRMZgMBSSyXEAipUq5YAZ1DCWbIIiqGKHSMTCRQiEVAhfAQCFLFz0je5VG+NvF2Q8wlqpgpg/neaXjermUK0xMvnDTmwzrXT3TgRraKC4mMRTsjqjFDfxS8eSOtq1RpPSXBr45P7W0Oji4qMpSKoMp/OS2cHJwQD3fYC5nwBRa+EQWhRRQMsUKNPa4MmZst8JfKq4wdYfC8jzQ4uRa9ODgwCxKPDk4gFOR8oSIYSekVpBjD9t3oEQkAr0oMeFj7kFbpAMpYJbxJLM0mTF3nmXOEoemQl1iYvgUuxPPY1jQxO9QyIBBJhX/VQrDcnscU1SGJyxvHxshSKDaMGWInKXkwoRWvwL8wx8PnZ49FM9XhFpKxCq4sD0aYcryCrXHahZDRlj9iKVCbVndz0uEFClkyCfZ1vVY+qHSpjMxVJrQbGPh1wqnZMmLlmxjlmsEPu7QsmB32FoNpJVhlvfhmwWkOGZVbmLgxHFGVdiHH6QBVpY5T9goR+JcIOFhplLYs6fs2cEjIlhhz/jcSjRqYJDy8RgVCSd12in8mIAd8VmjAqzkmIwJkGLloBOZS7XOQra5S0dIpDAoTB/eTBnPLfJusxq4SPIqRRjlLLmLYZRXGIPC1AnuAkltxV4JEQgw7Wlu6QMac+JCKQh/If3yXIP2WKV9uMy4buSJOgOp7SJct6nqpXYsaWUiQRAxwILxPLaEi+GDHIHhJseYBLZkYhGTvsQYDM7NSM5jSDJM7uwvxVIuYVQZI4XbWKpkmcqZ8LQcS2E0/3WDRIaej6foMIbjGF7F8DqGwVEMg2EMg+MYBq9iGLyOYXgUw3AYw/A4huErh9bwtac1qwncRmAwdFQ2vx/qkt79jmsr2aQwda2DZx0dPOjDwUEtTdT2888/X4v7awFwHZFwXUcncB3VINdR7PpIZ1LfwH/P6ePF8Gv/uaDPV8PX/nNmQQfH/jOjz+HgWiz9gtdiaDExrCgfwIK6vygG/sszEbXZRakt6DNqJEUUhw46qw4+1LFs7+UF7YULbjjL9fbtBIgntKMGpbVNHdOmLLtu35HtfkLbaeNDPVZNui6rVltdQeAtFsO13b/s+5tl++bdsk9m7y10Pm/rr2jrpJouSTVt33+tvZ4QEVZx+jxKfN23BoDVzNvp4AGeEBW6GH0eDV4TDehS2k4A6n1Cu2+hQx3+hnd9R8e9wcve8Gh43KEA+UYOoCh6adpbLBZfgnpk8/jlyeQJFqqz7MgrHStZbHA/rHfQQHmbyP4OJvv3ZKiPgg2LKfl91rEIFkvt8bWtbCNTtnim3VRhaG2cEXxjmi1aaNouwsN6v0kmeeKRJ5hgko3IwesTDXpE9/Tw++8PW5R0jb2i6K000mfPEr7VWBT9NO2vQK6djmssIE1jWG/e2J6mUBTFlmbXfh1Zk+qPxPreEtvO/R7gtxKAhs+7Cz8oHBQPkCK3a1snbbN0rFwhGRe+w7MKrAAonFQ5Uzgnb1NzKRz0l5ecIDiNvW69U+vYWd/fkQK+OvM2+XPP1LSF7gTUsnvc2s7akyic4NzOkVTayIKQ4SmjGWLQVZKR98aC6U90b+I09ithJacoQY7G2FY0SX8TEu7UWh42neqqg63RdDbDNISRG3xse/yWvQdH9nrzDsYD95uHeEIqfgUl6nThCuq+uo4KZi0A4jJsfkuTobqObuoxzqvGdMfYm0fIUcZTzNkI8/WuR8tAey+en1qEoY6CizoSYPE9iludbL7S6fqWG2TL7bjN1EGJB9EIJIac6xAL6dKrPdoHi2wITyDaqOAIIQyggGuQ3M9l8xqxx/G50wL+cHYsQXBgAetAXVhtxwqdg2kThuYouOBFVdQRx3E9ayBZ4W/zNr1oJMWxwwrt011bgc13rEDhve0LXIuBjQyEiMIDtp6HeELKYAWlh+X0U9RE5478QpfbbgEM22oL4IYrkUDdZVgLn94ufX04owuIopxuEMWtkgRLQzGuzxXNGuVHX0E2CtSObG3nvDbUE+K+DWj9lznQw/02XNje3u+IEztoP5obXRyvYJMHnF3b/YT4z+OzcrhRHMmSMp9citM0OokSmywN2b0otlOjNt/IdBGd3Ec+0k4/fRybhh5+0JRuvY90kmHB6FdAiRK0lCCNYhssRqWjOLKhF8rWEr2ik0iOPmBCq5WK0DEcNc1hx53cByiXYYxi74hHJ5FLPUZxhHNWlAQcreRmy3QcLcOCD01VtzRTafujTnXSPJTE+8RpfqChy5UE9SfN9K41g91bgZfyraQ+g+/YQrfmdTd9tJoXpzEkB4kfBSlbaBKtSjujLGF5UuXk1OO85GpRRxisZ9/ijxrfeqUa38HLZXPoDUpMKbaI4ogbLNrtW5hAyY8/uQQlUcaGeT927AeJI8Q/+QZKw9uDZ8VHY/FBIozQHnqZSfHR4wfDF4Ph4MVgSDP4/Myn09H1rmPQZYw35I5iGgz1XpNSjcGmNfq7eDTA222zCe5mxsttqfZWhk9nsspTyp0hU32b8f7kYoouf9fXUX8HNy/jaL57M3NIZC/k8eGrHMcGqrJEBYlUAtXzdjDvyWxueHy8jKPF7u0tfpfb+5oOb7Z7dz/ZAoimOOR/geuL18s4ynbj+te6RON/iOzxq2Vzu64YD7cjmS5ug95a7gIMFwXBjWWeoiKDZF1fNaqGNAyVFt2u6vmRlDkysUHRdHLzvgiM7EIyCX00e5YhmdWNuWhnbyxUb0A6bCnfjyvBRq7JEFQVXkd9OB237F0bK1gtDwiwNlUvJDyz693qyqrxZ4f+m2j0rF0GRZUpTRQ/oGCBwWBR5raOaMbznPCme70P9T9r+dWUJATCdRkW3n1VvHVBTbugH9QtwgFvO/bhLRN1IUa34AHu72s2sNyxXML9PZ0qqlu6dJfLuGmgtToN9l51LQoT5NPOqLoJm4F1W2uoM3FuycRxDT4x1kaATwQXk9tK5ctlf40NmzN6NN3WyOTPjib5P6AYoXMqzlSK6hGSezp2LpuEZ8Ssz3yA3FKGK228PDp29wi7PNcWKvuCBvL0vq3lW1cjTVAizNfIj1F8MkEqNvQQdrAvD0KWZE4zWKzYmETbFhAqnHJZ6YBexnRtcqcEwZ24cDHpepwt6tjqrfbe+5tEV1A90dnl+SNoaf3hntNEzpl0u3RzwNnlOZUk8rH37frwXteUCKRlHRAgXwumnIWypdp8W7iQJQpLEac2O/WjfV8M2IN1hFKuN2IUN0mTuoB3beKmZpWOSFaGimW5r8TSBkvdoaPFoibkpawew5U7KMlgUtmcq6FbOahGm8hpSgq50EZVLlwLaaVCFaVnC4JMUOuGToEqBNSaPwYU2g1nMGbaoIqhEpworyqKltRT4rxExVEkuJEECh3pSHJ3a7Nufd77H7/zlcphD0EoRySBbmJMoSot11hJqOtGw8mtbn2j7vBqazeCdEHb6k4fqS9RaSmAqjLVhAn+q2Nh63RITR5bxnIH6lUFZawJH5LwLjLBnPr3P//Vwmur27mOmFuBpSmlD3dgaKNljuEpSq+wJA0ouxjRfKj+tGrnEXZWaG4LmdaCpB/P4+dUTGx0rReNtMXnmKOrlA/pzFrf6jjoWO09R8pqKpt9JGIbWdJ+cc61aVU+hvqEdf3wIxIdkxYO1tMgqSaeF4u2gNd4+QrLZjprA/Ju1Wxt6a7IwsMWqzNpmziXV8VUCS6Fdk738OiI/nRJWr9E8JMS8YjRx1WeL/4QxY8Psj3s8bvmzVb0Qy589oEPf50n0+F55AM4XU3wkYGHT4rC0JjVGMwWffTgVrzvU6mcnjnQXno1L9hpW2fMRc4F3oYDvE1lcht2T3AFat0NaDwKh/q4rYXQPesdyxOLLePoeBMXXcgCTWZFh+adKUmvL8ocGb0GUAtgE8YFkBugviBToVJSPeyXfRxmD5Hg+OjodlAT4eU6EU6FzYHbNz2X8g7Fb7vT9vLGLU+ozgvLqO5+irgDsv1RZ7PtdrdJjUmluFlEJ1f30bzHSt5z/SdXN8sbYkGTSYrTl1JbjJnJopPocC1sr1FNbdj16t7JTS0KmomUEtVroQBW8sPpIFrGqyM2Bg62QmvDJlxMeg+Oumm2ekHH4Sje2XCjbkr+dyR94+nZhoojTmyQISM/gihIp/xjk7P4NpxVyCZsShA0Z7Ia8g8R/04Qf/WK3BCW3xyVH7xsxcOvQmjbRqvrYPWm+HO99RBRrgPKrRhxK0R81fBsHY0NwdiBjWIOj49tuO/rgY2LvXhtQ07Hr5aWy5rwSxR1Qyw2ubQaKIiirgMcBtXunR/V+Cgu09kxtn1T1/gMM9XGXsfiWjW4tho/W2yfYPByMZaW3zwTnJUoLsifILGeDtajhJgnsqhfbwTwf//zX3ZEYB67zB/grFJQyhmqceWegIxznHOy4FsPEUMMClmRo9b5Ashwn9gniSmf2CqwYBYnrGQjnnPSUwQmXU6mpep0H35qoljPlCuIm2JO6g1yKe0LPTLhKiMLu0a4o2ZS3Y0JpRgYjOhRFxmmGjEMQZExkVAgzImvNeroRSI5GqXiGoHxgoDJ4cHxmCfc2jpSGMUSAwUTbGKts9hGK4kKZXiSpeSI/EUt88p5RPQwDNG4LdpUcR/ekQdqN25zUWjo2FPnDOnYOaNefPyLxxE5/iUtzxPUTelsjlNUVl25UEKV51BK49x7Mk/bZ0sTGcWEpsve58H80dTk8y6LXSNliz5QvpjuQzLciQFyLu7c+8Srms1+wpHmBptI7Ww2W1Odz7tj/sJNVo3ICZDNuIlttIq2Pbz+eE56CVWhz8YXqKY8CSbSljUPLfChv1KZCwoGYWMl3+hm5DxBobF1Ab75y/l3MIUX/aMobl0Wj0D48LvTt9/+cPEtzUvXmZO/Qf+of2TTS1KbgonWUitvfVdFt5W/3j8N3j8N3j8N3j8N3j8N/t08Xt0/Dd4/Dd4/Dd4/Dd4/Dd4/Df7vEWH/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NHj/NPjLPczcPw3ePw3ePw1+6py4fxocikjIKjwsc8ZFqwrPVR5drT4YvomjjEqTTq6i+3tK/72n8n9q/qVCRXVNN3E0ZYpTkNtWNcWheofKVu6Q6kfeuph975LWjx2724zzSjEXFR+5EW/ssT8I266eOj+7uIziKLzXKGRKYxSb0YNnNnOFJ56a9g0qs4/HciYmla2iidycVHDEKpN1q5XubLWS/9EqxmFi0cKwW8bktkH/06Y2Dri/d5VQy2UN77q2jvCEDdB0fjfL5fI/XSlatQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,g={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,o.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,o.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,o.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,o.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,o.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,o.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"color:"})," 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, radio button, and dropdown."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"fontsize:"})," 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, radio button, and dropdown."]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"2",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"3",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"4",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"5",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"6",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"7",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"8",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,o.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,o.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,o.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,o.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,o.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,o.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,o.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,o.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"9",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"10",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"11",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"12",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"13",children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,o.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(d(),{parameters:void 0}),"\n",(0,o.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"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. \n",example:!0},email_subject:{type:"string",description:"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}}.",example:""},email_body:{type:"string",description:"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}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_body"}}},required:!0}}),"\n",(0,o.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.49530215.js b/assets/js/a9f09360.49530215.js deleted file mode 100644 index 41b3ba23d..000000000 --- a/assets/js/a9f09360.49530215.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>y,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11zGzmOfwXbL5m4WrKlOJmcnzaTzO35bmbsmjg1dWW7PFQ3JDHuJntItmWNS2/7S/an7S+5Aki2uvVhOx8766lTHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/WczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvz3+5OfYKxNKVwfTovaps1yuTSYuWLup3dTbHb1zEZqWGekmqRQimuil3TwWy2za9q2RZXTXxr45vSYabW3976uKm0c5vCL38LR3h71fIeFnoEwyPCZLkutoBJGlOj4wKbCcbfB32ppMA/HUhSRFkcXqgd7e25e4dHeHhyrXGZEDJ6QWkGPA2zfgxKRCPR9hZkcywDaIh1oBbOpzKZMk5nw51kVIvNoGrQVZk7eYHfi2xTmNPE7VDpiMNVG/q6VEwUfxw0aJzNRtI+NECRQ64RxRM5KS+Via1gB/jccD50eH0rgK0ItJ2KVUnGPRbgRRY02YDVLYUpY/YyVQcvMHuYlQqocpign063rifxjbV1nYqgtodnGIqwVT4nJi0y2sSgsghx3aFmKa2ytBpqFWBR9+G4OOY5FXbgUJHGcMzX24SftQFRVITMxKpA4F0h4hKsN9viUAzsERJQo+YxPWabRgoBcjsdoSDipk6cIYyJ2xGdLJcCS46ZCgVYrB53pQpt1FuLmLh0h08qhcn14cyNkwcj7zVqQKivqHGFUiOw6hVFRYwoGcy+4cyTFlXp+ZxAQNtCc6QMWC+JCrQh/pcPy0oINWOV9OJtKu5Qn6oyk5kWkbVM1SO1Y08pEgihigKWQRcqES+GjHoGTrsCUBLYSap6SxsQUHN66kb5NIZtids2/jMilhlHtnFZ+Y7nRVa5nKtByrJWz8vcNEhl7Pp2iwxQOU3iVwusUBgcpDIYpDA5TGLxKYfA6heFBCsNhCsPDFIavPFrD12lU+ZHAbQQGQ09l9+ehLundH6RlySaFaRsdPOvo4EEf9vYaaaK2X3/99ULdXSiAi4SE6yI5goukAblIUt9HOpP6BuH7lj5eDL8Nn3P6fDV8HT5nDDo4DJ9T+hwOLtQiLHihhoyJE2V1DxbU/VUxCF+BiaiNF6W2qM+okRRRGjvorDr4UMeivZcXtBeppJOisNu3EyGe0I6WKK1t6pA2xey6fUfc/YS208aHelhN+i5Wq62uKPCMxXBt9y/74WbZvnm/7JPZewudL9v6K9o6qaYzUk3b999orydEhFWcvowS3/bZAGDNvJ0OAeAJUaGL0ZfR4DXRgC6l7QSg3ie0+xY61BFueN93cNgbvOwND4aHHQqQb+QByrKX5735fP41qEc2T1ieTJ5ooXrLjvzSsdHlBveDvYMlVLCJ+Hc02X8kQ30UbVjMye9jxyJaLI3H17aync7F/Jn1U8WhjXFG8EvTbN5Ck7sID/Z+s6mWWUCeYKJJNiIHr0806BHd8/0ff9xvUdI39sqyt9JInz0mfKuxLPt53l+BXDsd31hCnqew3ryxPc+hLMstzb79ImGT6j+I9YMltp37A8AfJQBLPu8ufK9wUDxAq4LXZidts3SsXCFTqUJHYBVYATA4qQth8Ja8TSu18tBfX3Ki4CztdfZO2bFj39+TAr45CTb588DUtIXuBNTy8Li1nbUnMTjBW54jq63TJSEjc0EzpGDrbErem4imP9F9Gafhr0xUkqIEBTrHreiy/iYk/Km1PGw61VUH26LrbEZYiCM3+Nh8/MzegwO+3oKDcc/9FiCekIpfQYk6fbiCus8vklKwBUBchsvf2k3RXCSXzRjvVWP+wNjLR8jRVOZYiBEW612PloH2XgI/tQhDHaVUTSSA8T1IW53idqXT9y02yJbfcZupoxKPohFJDIW0MRbSpVd7dAgWcQhPIXJUcIQQB1DINUrul7J5g9jj+NxrgXA4DyxBcMCATaAurvbACp2DaROG5iilkmVdNhHHcTNrJFkZbvM2vWgkRbLjCu3TXVtB3D6wAoX3ti9woQYcGYgRhXtsvQDxhJTBCkr3y+nnqInOHfmVLreHBTBuqy2AG65EAvWXYSN8drv09eGELiCKcvpBFLfKMqwcxbi+VDQblB99BXEUyEe2vuPI1nbOa8e/nhD3bUDrX8yBAe6P4cL29v5EnNhB+9Hc6ON4pZjc4+xy9xPiv4DPyuEmaaIrevuUWh3nyVGS02tpfNxLUp4ZrftO5/Pk6C4JgXb6GcLYNHL/o6Xn1rvEZlMsBf2KGNEDLb2PJmnC8RZ6oyUiJUeJHn3EjNaoDOHgJFoaydBHdxHKPysmafC+k6PEvzcmaYK3oqwIOFl5kK3ycbKIC943VdOynMryj+Z9k+ahl7vPnOYnGrpYeZb+rJnetWbgvZV4pt9q6nP4Tsxta15/vSerr+E0hpg/C6MgF3NL8lRbb4llosjqgjx5vK2kmTdhBXbnW1zR4Nus1OA7eLlI+VkATRslYYyYJ2kiHZbt9i1MYPSnn1yGmijDsd1PHftR4wjxr6GB3t754EX5yVh81Agj5EOvplp98vjB8MVgOHgxGNIM4VHm8+noe9cx6DLGG/JBMY/WeW/5jpoCv2X0H+LRCM/bFhN8mBnPtr2vt5717FTXRU4PZihMn5+5PzuDosvfzR3Uf4CbF2ly+/BmbiHTvfh4D98UOHZQVxUayLRRaJ63I3hPZnPDw8NFmswf3t78T7m9b+nwZg/v7hfOelhmhPw7cH3xepEm04dx/a8mL+PfiOzhq8Xydk0yg8JhvByuRjqfX0W9tXgIMF4UBDfWRY6GrJB1fbVUNaRhKJ/oalXPj7QuUKgNiqbzIB9yv8gYJDswhLBnUyRbemkj8uxLszRYjR5beuTHlQijtGT9mRovkj4cj1tGLgcIVnMCIiy/zysNz3i9K1uzGn+2H76JRs/auU+UjrIM3UcUGBgcllXByUMzWRSEN93rfWj+sbnXUJIQiNdlXPjhq+Ktj2TygmFQN/MGgsXYh7dCNdkX3SwHuLtr2IC5Y7GAuzs6VTRXdOkuFumygdbqNPC96lsMZihvOqOaJlwObNpaQ72Jc0Umjm8Ir2FtBORESTW5qk2xWPTX2HB5Ro+m2xqZwtnRJP8PKEboHKsTk6N5hOQej72fpuEZMeuzEBVnykhjXZBHz+4BYf+4tYXKIYuB3LvvG/m29cgSlIrzLeXHGTmZIGUYBggeHHKCUGRTrxkYKzEm0easQYM3Utc2ojcVtjG5c4KQXlykmnTdzBZ1OGWrvff+JtFVlER0cnb6CFqyE9zzmsh7kH6Xfg44OTulPEQ5Dh5dHz7YhhKRtKIDAuRrwY0UMVepMd/mPk6Jiini1WYnabQfMgB7sI5QLu1GjNLlS0mTt7s28TJRlY5I144yZGVIv7IOK9uhI2PREPJM14/hygcoKWBS80Oro1s5qkZ+vVnmEUplnal9jBby2sTUycAWBJmhtUs6RaoQUGv+FFBZP1zAWFiHJoVaSaK8qSlE0kyJtxUaiSrDjSQw6ElHkvuwNusm5X34+YeQnhz3EIVyRBLoJ8Yc6oq5hiWhSRaNJ7e69Y26I6ithxGkC5pTOkN4vkJjtQJKxTQToeTvnoXZ6dCWPLapKDxoUBX0TE34kIR3kYnm1D///o8WXlvdznXE/Aoiz+nN8AEMOUTmGZ5C8wYr0oC6ixHNh+avq3YeYcdCc1XqvBEk+3geP6UMYmcbveg0Z5xjgT5BPr5hNvrWplHH2uA50lOm4SdHIrbTFe0Xb6V1rXTHmJSwrh9+RqJj1sKBPQ2SauJ5NW8LeINXSKtcTsc2oOymyjaW7oostCzWTjDMX/Rs0S6DW0ETU/a3Vtb73MODA/rTpWhTfxCsYKId8fm4Lor5X5L08ZG1+x3+Blu50Y6+z4mffpTD32+zm+EpMc4WPXDvBMHnqE1BNQUkGL3mDJgfW7SVqpAKr5jEV7nOrgzaq+HBwdWAaLxIk8NNZHyvS3RTZh0i5sxoKjmoChSUAm/mICZCKiAz2HxFqqIx2tzvl3waZhsoEXno6rBDhJfrRDhW/PDLpSxn+hrVH7vT9vLOL0+o3pbMMF4/J9IDcX/S2Wy73W/SYlYb6ebJ0fldctsTlez5/qPzy8VlmhBhNQWnK20ZY+GmyVGyvxqrtmhuOOp4fufZt+FIK1ROj7NrnrCo5P7NIFmkqyM2+s1boa0TE6kmvXtHXS53+p5OwxO8s99lmK+S/4MU5wvkbEOliSQumKIgM5oISIf88zJQ/308qhhM3xQfXx7JasQ7Brw7MezVG2JDVHpzUHrwshUOPo+RXQ7WNrHaTeHXZusxoNrEU1sh0laE9HzJsk0wMsYiBxzEGx4ecrTr2wGHhV685ojL4asFM9ky+pAk3QgDP6is+slJ0vX/4qDGuwmjlia6f93r2JqhqWt7xZkaW6djcKzaG1vv/i1Xf7T3pBpr5rfABCcVqvdkTpNU3wzWg2RYZLpsKhYi+D///g8eEZmHl/kLnNQGKj1DM6592cO4wFtJBmyr/C6GYFCUBVpbzIHs1gkX4uVywplP0SrMRCVGspCkpghM+yeJlqazffhlGcR5ZnwS2A0WpN2g0Jqr0siCqZ0ueY14Jc+0uR4TSinV9lEhE9llFjEOQTUVKqM4kBdftmmoCo/s7MpIiyBkScBk7+N4LDPJd71WzojMQSmUmLBxknKwjqhQxTIko0fkLlld1N4hoGIoROe3yM+jfXhHDhhvnJ9i0NGx594XsKn3xYL4hCq/Efm9FS0vM7TLdNECb9CwuvKedF0UUGnnvVuyztpnSxM5I5Slez88A4WjacgXLHZeIxfzPtAbKV2HZLcSAxRSXfuavPOGzX7BkZUOl4HK2Wy2pjqfd8f8TbppPSIbWC/HTbiRFW17ePPxnPQSmtKejN+juZFZtFS2rLnPwPvhRhU+JhaFTVRyo5VdyAyVxdb99+Zvpz/ADbzoHyRp67J4BML7Pxy//f6n99/TvHSdefkb9A/6B/y6oq0rhWot1S1wXZXc1pvtrhx2Vw67K4fdlcPuymH/PAWbu3LYXTnsrhx2Vw67K4fdlcP+64iwK4fdlcPuymF35bC7cthdOeyuHHZXDrsrh92Vw+7KYXflsF+vGHFXDrsrh92Vwz51TtyVw8YkErIK96tCSNVKhvOJR+crRbKXaTKlxKSj8+Tujl7/PlDyOzX/VqOhrKbLNLkRRlKMm3Oa0pi8Q1kr10jpI299yL53Rsunntv5wXkllYtyj/yIN3zq98K2c6dOT96fJWkSqxVKndMYI2ZU5CtmPu8kEJMrMAWXThVCTWpOokn8nJRvJGo37SYrXXOyUvjRysURat7CsJvF5LdB/9OmNg64u/OJUItFA++7to4IhI3QdHyXi8Xi/wDJbfti","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const y={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzmOfwXbL5m4WrKlOJmcnzaTzO35bmbsmjg1dWW7PFQ3JDHuJntItmWNS2/7S/an7S+5Aki2uvVhOx8766lTHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/WczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvz3+5OfYKxNKVwfTovaps1yuTSYuWLup3dTbHb1zEZqWGekmqRQimuil3TwWy2za9q2RZXTXxr45vSYabW3976uKm0c5vCL38LR3h71fIeFnoEwyPCZLkutoBJGlOj4wKbCcbfB32ppMA/HUhSRFkcXqgd7e25e4dHeHhyrXGZEDJ6QWkGPA2zfgxKRCPR9hZkcywDaIh1oBbOpzKZMk5nw51kVIvNoGrQVZk7eYHfi2xTmNPE7VDpiMNVG/q6VEwUfxw0aJzNRtI+NECRQ64RxRM5KS+Via1gB/jccD50eH0rgK0ItJ2KVUnGPRbgRRY02YDVLYUpY/YyVQcvMHuYlQqocpign063rifxjbV1nYqgtodnGIqwVT4nJi0y2sSgsghx3aFmKa2ytBpqFWBR9+G4OOY5FXbgUJHGcMzX24SftQFRVITMxKpA4F0h4hKsN9viUAzsERJQo+YxPWabRgoBcjsdoSDipk6cIYyJ2xGdLJcCS46ZCgVYrB53pQpt1FuLmLh0h08qhcn14cyNkwcj7zVqQKivqHGFUiOw6hVFRYwoGcy+4cyTFlXp+ZxAQNtCc6QMWC+JCrQh/pcPy0oINWOV9OJtKu5Qn6oyk5kWkbVM1SO1Y08pEgihigKWQRcqES+GjHoGTrsCUBLYSap6SxsQUHN66kb5NIZtids2/jMilhlHtnFZ+Y7nRVa5nKtByrJWz8vcNEhl7Pp2iwxQOU3iVwusUBgcpDIYpDA5TGLxKYfA6heFBCsNhCsPDFIavPFrD12lU+ZHAbQQGQ09l9+ehLundH6RlySaFaRsdPOvo4EEf9vYaaaK2X3/99ULdXSiAi4SE6yI5goukAblIUt9HOpP6BuH7lj5eDL8Nn3P6fDV8HT5nDDo4DJ9T+hwOLtQiLHihhoyJE2V1DxbU/VUxCF+BiaiNF6W2qM+okRRRGjvorDr4UMeivZcXtBeppJOisNu3EyGe0I6WKK1t6pA2xey6fUfc/YS208aHelhN+i5Wq62uKPCMxXBt9y/74WbZvnm/7JPZewudL9v6K9o6qaYzUk3b999orydEhFWcvowS3/bZAGDNvJ0OAeAJUaGL0ZfR4DXRgC6l7QSg3ie0+xY61BFueN93cNgbvOwND4aHHQqQb+QByrKX5735fP41qEc2T1ieTJ5ooXrLjvzSsdHlBveDvYMlVLCJ+Hc02X8kQ30UbVjMye9jxyJaLI3H17aync7F/Jn1U8WhjXFG8EvTbN5Ck7sID/Z+s6mWWUCeYKJJNiIHr0806BHd8/0ff9xvUdI39sqyt9JInz0mfKuxLPt53l+BXDsd31hCnqew3ryxPc+hLMstzb79ImGT6j+I9YMltp37A8AfJQBLPu8ufK9wUDxAq4LXZidts3SsXCFTqUJHYBVYATA4qQth8Ja8TSu18tBfX3Ki4CztdfZO2bFj39+TAr45CTb588DUtIXuBNTy8Li1nbUnMTjBW54jq63TJSEjc0EzpGDrbErem4imP9F9Gafhr0xUkqIEBTrHreiy/iYk/Km1PGw61VUH26LrbEZYiCM3+Nh8/MzegwO+3oKDcc/9FiCekIpfQYk6fbiCus8vklKwBUBchsvf2k3RXCSXzRjvVWP+wNjLR8jRVOZYiBEW612PloH2XgI/tQhDHaVUTSSA8T1IW53idqXT9y02yJbfcZupoxKPohFJDIW0MRbSpVd7dAgWcQhPIXJUcIQQB1DINUrul7J5g9jj+NxrgXA4DyxBcMCATaAurvbACp2DaROG5iilkmVdNhHHcTNrJFkZbvM2vWgkRbLjCu3TXVtB3D6wAoX3ti9woQYcGYgRhXtsvQDxhJTBCkr3y+nnqInOHfmVLreHBTBuqy2AG65EAvWXYSN8drv09eGELiCKcvpBFLfKMqwcxbi+VDQblB99BXEUyEe2vuPI1nbOa8e/nhD3bUDrX8yBAe6P4cL29v5EnNhB+9Hc6ON4pZjc4+xy9xPiv4DPyuEmaaIrevuUWh3nyVGS02tpfNxLUp4ZrftO5/Pk6C4JgXb6GcLYNHL/o6Xn1rvEZlMsBf2KGNEDLb2PJmnC8RZ6oyUiJUeJHn3EjNaoDOHgJFoaydBHdxHKPysmafC+k6PEvzcmaYK3oqwIOFl5kK3ycbKIC943VdOynMryj+Z9k+ahl7vPnOYnGrpYeZb+rJnetWbgvZV4pt9q6nP4Tsxta15/vSerr+E0hpg/C6MgF3NL8lRbb4llosjqgjx5vK2kmTdhBXbnW1zR4Nus1OA7eLlI+VkATRslYYyYJ2kiHZbt9i1MYPSnn1yGmijDsd1PHftR4wjxr6GB3t754EX5yVh81Agj5EOvplp98vjB8MVgOHgxGNIM4VHm8+noe9cx6DLGG/JBMY/WeW/5jpoCv2X0H+LRCM/bFhN8mBnPtr2vt5717FTXRU4PZihMn5+5PzuDosvfzR3Uf4CbF2ly+/BmbiHTvfh4D98UOHZQVxUayLRRaJ63I3hPZnPDw8NFmswf3t78T7m9b+nwZg/v7hfOelhmhPw7cH3xepEm04dx/a8mL+PfiOzhq8Xydk0yg8JhvByuRjqfX0W9tXgIMF4UBDfWRY6GrJB1fbVUNaRhKJ/oalXPj7QuUKgNiqbzIB9yv8gYJDswhLBnUyRbemkj8uxLszRYjR5beuTHlQijtGT9mRovkj4cj1tGLgcIVnMCIiy/zysNz3i9K1uzGn+2H76JRs/auU+UjrIM3UcUGBgcllXByUMzWRSEN93rfWj+sbnXUJIQiNdlXPjhq+Ktj2TygmFQN/MGgsXYh7dCNdkX3SwHuLtr2IC5Y7GAuzs6VTRXdOkuFumygdbqNPC96lsMZihvOqOaJlwObNpaQ72Jc0Umjm8Ir2FtBORESTW5qk2xWPTX2HB5Ro+m2xqZwtnRJP8PKEboHKsTk6N5hOQej72fpuEZMeuzEBVnykhjXZBHz+4BYf+4tYXKIYuB3LvvG/m29cgSlIrzLeXHGTmZIGUYBggeHHKCUGRTrxkYKzEm0easQYM3Utc2ojcVtjG5c4KQXlykmnTdzBZ1OGWrvff+JtFVlER0cnb6CFqyE9zzmsh7kH6Xfg44OTulPEQ5Dh5dHz7YhhKRtKIDAuRrwY0UMVepMd/mPk6Jiini1WYnabQfMgB7sI5QLu1GjNLlS0mTt7s28TJRlY5I144yZGVIv7IOK9uhI2PREPJM14/hygcoKWBS80Oro1s5qkZ+vVnmEUplnal9jBby2sTUycAWBJmhtUs6RaoQUGv+FFBZP1zAWFiHJoVaSaK8qSlE0kyJtxUaiSrDjSQw6ElHkvuwNusm5X34+YeQnhz3EIVyRBLoJ8Yc6oq5hiWhSRaNJ7e69Y26I6ithxGkC5pTOkN4vkJjtQJKxTQToeTvnoXZ6dCWPLapKDxoUBX0TE34kIR3kYnm1D///o8WXlvdznXE/Aoiz+nN8AEMOUTmGZ5C8wYr0oC6ixHNh+avq3YeYcdCc1XqvBEk+3geP6UMYmcbveg0Z5xjgT5BPr5hNvrWplHH2uA50lOm4SdHIrbTFe0Xb6V1rXTHmJSwrh9+RqJj1sKBPQ2SauJ5NW8LeINXSKtcTsc2oOymyjaW7oostCzWTjDMX/Rs0S6DW0ETU/a3Vtb73MODA/rTpWhTfxCsYKId8fm4Lor5X5L08ZG1+x3+Blu50Y6+z4mffpTD32+zm+EpMc4WPXDvBMHnqE1BNQUkGL3mDJgfW7SVqpAKr5jEV7nOrgzaq+HBwdWAaLxIk8NNZHyvS3RTZh0i5sxoKjmoChSUAm/mICZCKiAz2HxFqqIx2tzvl3waZhsoEXno6rBDhJfrRDhW/PDLpSxn+hrVH7vT9vLOL0+o3pbMMF4/J9IDcX/S2Wy73W/SYlYb6ebJ0fldctsTlez5/qPzy8VlmhBhNQWnK20ZY+GmyVGyvxqrtmhuOOp4fufZt+FIK1ROj7NrnrCo5P7NIFmkqyM2+s1boa0TE6kmvXtHXS53+p5OwxO8s99lmK+S/4MU5wvkbEOliSQumKIgM5oISIf88zJQ/308qhhM3xQfXx7JasQ7Brw7MezVG2JDVHpzUHrwshUOPo+RXQ7WNrHaTeHXZusxoNrEU1sh0laE9HzJsk0wMsYiBxzEGx4ecrTr2wGHhV685ojL4asFM9ky+pAk3QgDP6is+slJ0vX/4qDGuwmjlia6f93r2JqhqWt7xZkaW6djcKzaG1vv/i1Xf7T3pBpr5rfABCcVqvdkTpNU3wzWg2RYZLpsKhYi+D///g8eEZmHl/kLnNQGKj1DM6592cO4wFtJBmyr/C6GYFCUBVpbzIHs1gkX4uVywplP0SrMRCVGspCkpghM+yeJlqazffhlGcR5ZnwS2A0WpN2g0Jqr0siCqZ0ueY14Jc+0uR4TSinV9lEhE9llFjEOQTUVKqM4kBdftmmoCo/s7MpIiyBkScBk7+N4LDPJd71WzojMQSmUmLBxknKwjqhQxTIko0fkLlld1N4hoGIoROe3yM+jfXhHDhhvnJ9i0NGx594XsKn3xYL4hCq/Efm9FS0vM7TLdNECb9CwuvKedF0UUGnnvVuyztpnSxM5I5Slez88A4WjacgXLHZeIxfzPtAbKV2HZLcSAxRSXfuavPOGzX7BkZUOl4HK2Wy2pjqfd8f8TbppPSIbWC/HTbiRFW17ePPxnPQSmtKejN+juZFZtFS2rLnPwPvhRhU+JhaFTVRyo5VdyAyVxdb99+Zvpz/ADbzoHyRp67J4BML7Pxy//f6n99/TvHSdefkb9A/6B/y6oq0rhWot1S1wXZXc1pvtrhx2Vw67K4fdlcPuymH/PAWbu3LYXTnsrhx2Vw67K4fdlcP+64iwK4fdlcPuymF35bC7cthdOeyuHHZXDrsrh92Vw+7KYXflsF+vGHFXDrsrh92Vwz51TtyVw8YkErIK96tCSNVKhvOJR+crRbKXaTKlxKSj8+Tujl7/PlDyOzX/VqOhrKbLNLkRRlKMm3Oa0pi8Q1kr10jpI299yL53Rsunntv5wXkllYtyj/yIN3zq98K2c6dOT96fJWkSqxVKndMYI2ZU5CtmPu8kEJMrMAWXThVCTWpOokn8nJRvJGo37SYrXXOyUvjRysURat7CsJvF5LdB/9OmNg64u/OJUItFA++7to4IhI3QdHyXi8Xi/wDJbfti",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},g=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," 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, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," 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, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"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. \n",example:!0},email_subject:{type:"string",description:"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}}.",example:""},email_body:{type:"string",description:"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}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.7d37e13c.js b/assets/js/a9f09360.7d37e13c.js new file mode 100644 index 000000000..f0a000d44 --- /dev/null +++ b/assets/js/a9f09360.7d37e13c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyGzmuv4Ltl0xcLdlSnEzWT5uZzNnjPXPGrolTU6dsl4fqhiTG3WQPybasceltv2Q/bb9kCyDZ6tbFdi4769RRHmI1CZIgCIAACNwlTkxscnSevNVZXaJyNrlMkxxtZmTlpFbJUXI2RXhrxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuB9VWiRw1zXBk7f/lczHy1Ebed7e29xVE/g/fHe3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvzt3clPMNamFK4Pp0Vt02a5XBrMXDH307spNrt6ZiM1rDNSTVIoxTXRSzr4rZbZNW3bosrpLw18c3rMtNrbe1dXlTYOc/jFb+Fob496vsNCz0AYZPhMl6VWUAkjSnR8YFPhuNvgb7U0mIdjKYpIi6ML1YO9PTev8GhvD45VLjMiBk9IraDHAbbvQYlIBPquwkyOZQBtkQ60gtlUZlOmyUz486wKkXk0DdoKMydvsDvxbQpzmvgtKh0xmGojf9fKiYKP4waNk5ko2sdGCBKodcI4ImelpXKxNawA/xeOh06PDyXwFaGWE7FKqbjHItyIokYbsJqlMCWsfsbKoGVmD/MSIVUOU5ST6db1RP6htq4zMdSW0GxjEdaKp8TkRSbbWBQWQY47tCzFNbZWA81CLIo+fDeHHMeiLlwKkjjOmRr78JN2IKqqkJkYFUicCyQ8wtUGe3zKgR0CIkqUfManLNNoQUAux2M0JJzUyVOEMRE74rOlEmDJcVOhQKuVg850oc06C3Fzl46QaeVQuT68uRGyYOT9Zi1IlRV1jjAqRHadwqioMQWDuRfcOZLiSj2/MwgIG2jO9AGLBXGhVoS/0mF5acEGrPI+nE2lXcoTdUZS8yLStqkapHasaWUiQRQxwFLIImXCpfBBj8BJV2BKAlsJNU9JY2IKDm/dSN+mkE0xu+ZfRuRSw6h2Tiu/sdzoKtczFWg51spZ+fsGiYw9H0/RYQqHKbxK4XUKg4MUBsMUBocpDF6lMHidwvAgheEwheFhCsNXHq3h6zSq/EjgNgKDoaey+3qoS3r3R2lZsklh2kYHzzo6eNCHvb1Gmqjt119/vVB3FwrgIiHhukiO4CJpQC6S1PeRzqS+Qfi+pY8Xw2/D55w+Xw1fh88Zgw4Ow+eUPoeDC7UIC16oIWPiRFndgwV1f1EMwldgImrjRakt6jNqJEWUxg46qw4+1LFo7+UF7UUq6aQo7PbtRIgntKMlSmubOqRNMbtu3xF3P6HttPGhHlaTvovVaqsrCjxjMVzb/ct+uFm2b94v+2T23kLn87b+irZOqumMVNP2/Tfa6wkRYRWnz6PEt302AFgzb6dDAHhCVOhi9Hk0eE00oEtpOwGo9wntvoUOdYQb3vcdHPYGL3vDg+FhhwLkG3mAsuzleW8+n38J6pHNE5YnkydaqN6yI790bHS5wf1g72AJFWwi/h1N9v8lQ30UbVjMye9jxyJaLI3H17aync7F/Jn1U8WhjXFG8EvTbN5Ck7sID/Z+s6mWWUCeYKJJNiIHr0806DEl9/N831MytuV5ryzb1KVG+uwx3VuNZdnP8/4K5Nrh+MYS8jyF9eaN7XkOZVluafbtFwlbVH8mzg+G2HbmDwB/FP8v2by78L2yQeEArQpem320zcKxcoNMpQodgVNgBcDgpC6EwVtyNq3UykN/ecGJcrM019k5Zb+OXX9PCvjmJJjkzwNP0xa6E1DLw+PWdtaexOAEb3mOrLZOl4SMzAXNkIKtsyk5byJa/kT3ZZiGvzJRSQoSFOgct6LL+puQ8KfWcrDpVFf9a4uusxlhIY7c4GLz8TN7Dw74dgv+xT3XW4B4Qhp+BSXq9NEK6j6/SErBBgBxGS5/azdFc5FcNmO8U435A2MvHyFHU5ljIUZYrHc9Wgbaewn81CIMdZRSNYEAxvcgbXWK25VO37fYIFt+x22mjjo8ikYkMRTSxlBIl17t0SFWxBE8hchBwRFCHEAR1yi5n8vmDWKP43OvBcLhPLAEwQEDNnG6uNoDK3QOpk0YmqOUSpZ12QQcx82skWRluMzb9KKRFMiOK7RPd20FcfvAChTd277AhRpwYCAGFO4x9QLEE1IGKyjdL6efoiY6d+QXutweFsC4rbYAbrgSCdRfho3w2e3S14cTuoAoyOkHUdgqy7ByFOL6XNFsUH70FcRBIB/Y+o4DW9s5rx3+ekLctwGtfzMHBrg/hgvb2/uKOLGD9qO50YfxSjG5x9fl7ifEfwGflcNN0kRX9PQptTrOk6Mkp8fS+LaXpDwzWvedzufJ0V0S4uz0M0SxaeT+B0uvrXeJzaZYCvoVMaL3WXoeTdKEwy30REtESo4SPfqAGa1RGcLBSbQ0kqGP7iKUf1VM0uB8J0eJf25M0gRvRVkRcLLyHlvl42QRF7xvqqZlOZXlH83zJs1DD3efOM1PNHSx8ir9STO9bc3AeyvxTH+vqc/hWzG3rXn99Z6sPobTGGL+LIyCXMwtyVNtvSWWiSKrC3Lk8baSZt5EFdibb3FFg2+zUoPv4OUi5VcBNG2UhDFinqSJdFi227cwgdEff3IZaqIMh3Y/duwHjSPEv4QGenrngxflR2PxQSOMkA+9mmr10eMHwxeD4eDFYEgzhDeZT6ej713HoMsYb8gHxTxa573lM2oK/JTRf4hHIzxvW0zwYWY82/a83nrVs1NdFzm9l6EwfX7l/uQEii5/N3dQ/wFuXqTJ7cObuYVM9+LbPXxT4NhBXVVoINNGoXneDuA9mc0NDw8XaTJ/eHvzr3J739LhzR7e3S+c9LBMCPlP4Pri9SJNpg/j+t9NWsZ/ENnDV4vl7ZpkBoXDeDlcjXQ+v4p6a/EQYLwoCG6sixwNWSHr+mqpakjDUDrR1aqeH2ldoFAbFE3nPT6kfpExSHZgiGDPpki29NJG5NmXZmmwGj229MaPKxFGacn6MzVeJH04HreMXA4QrKYERFh+nlcanvF6V7ZmNf5sP3wTjZ61U58oG2UZuY8oMDA4LKuCc4dmsigIb7rX+9D8Y3OvoSQhEK/LuPDDV8X3PpLJC4ZB3cQbCBZjH74Xqkm+6CY5wN1dwwbMHYsF3N3RqaK5okt3sUiXDbRWp4HvVd9iMEN50xnVNOFyYNPWGupNnCsycXxDeAxrIyAnSqrJVW2KxaK/xobLM3o03dbIFM6OJvl/QDFC51idmBzNIyT3eOz9NA3PiFmfhag4U0Ya64I8enYPCPu3rS1UDkkM5N790Mi3rUeWoFScbyk/zsjJBCnBMEDw4JAShCKbes3AWIkxiTYnDRq8kbq2Eb2psI3JnROE9OIi1aTrZraowxlb7b33N4muohyik7PTR9CSneCe10Teg/S79HPAydkppSHKcfDo+vDeNpSIpBUdECBfC26kiKlKjfk293FKVEwRrzY7OaP9kADYg3WEcmk3YpQuX0qatN21iZd5qnREunaUICtD9pV1WNkOHRmLhpBnun4MVz5ASQGTmt9ZHd3KUTXy680yjVAq60ztY7SQ1yZmTga2IMgMrV3SKVKFgFrzp4DK+uECxsI6NCnUShLlTU0hkmZKvK3QSFQZbiSBQU86ktyHtVk3J+/9zz+G7OS4hyiUI5JAPzHmUFfMNSwJTa5oPLnVrW/UHUFtPYwgXdCc0RnC8xUaqxVQJqaZCCV/9yzMToe25LFNReFBg6qgV2rChyS8i0w0p/7593+08Nrqdq4j5lcQeU5vhg9gyCEyz/AUmjdYkQbUXYxoPjR/WbXzCDsWmqtS540g2cfz+CklEDvb6EWnOeEcC/T58fENs9G3No061gbPkZ4yDT85ErGdrmi/eCuta2U7xpyEdf3wMxIdsxYO7GmQVBPPq3lbwBu8Qlblcjq2AWU3U7axdFdkoWWxdoJh/qJni3YZ3AqamJK/tbLe5x4eHNCfLkWb8oNgBRPtiM/HdVHM/5Skj4+s3e/wN9jKjXb0fU789IMc/n6b3QxPiXG26IF7Jwg+R20KKikgweg1Z8D82KKtVIVUeMUkvsp1dmXQXg0PDq4GRONFmhxuIuM7XaKbMusQMWdGU8VBVaCgDHgzBzERUgGZweYLUhWN0eZ+v+TjMNtAichDV4cdIrxcJ8Kx4odfrmQ509eo/tidtpd3fnlC9bZkhvH6OZEeiPuTzmbb7X6TFrPaSDdPjs7vktueqGTP9x+dXy4u04QIqyk4XWnLGAs3TY6S/dVYtUVzw1HH8zvPvg1HWqFyepxd84RFJfdvBskiXR2x0W/eCm2dmEg16d076nK503d0Gp7gnf0uw3yV/B+kOF8gZxsqTSRxwRQFmdFEQDrkn5eB+h/iUcVg+qb4+PJIViPeMeDdiWGv3hAbotKbg9KDl61w8HmM7HKwtonVbgq/NluPAdUmntoKkbYipOdLlm2CkTEWOeAg3vDwkKNd3w44LPTiNUdcDl8tmMmW0Yck6UYY+EFl1U9Okq7/Fwc13k0YtTTR/etex9YMTV3bK87U2Dodg2PV3th692+5+qO9J9VYM78FJjipUL0jc5qk+mawHiTDItNlU7AQwf/593/wiMg8vMyf4KQ2UOkZmnHtqx7GBd5KMmBb1XcxBIOiLNDaYg5kt064Di+XE858ilZhJioxkoUkNUVg2j9JtDSd7cMvyyDOM+OTwG6wIO0GhdZclEYWTO10yWvEK3mmzfWYUEqptI/qmMgus4hxCKqpUBnFgbz4sk1DRXhkZ1dGWgQhSwImex/HY5lJvuu1ckZkDkqhxISNk5SDdUSFKlYhGT0id8nqovYOAdVCITq/RX4e7cNbcsB44/wUg46OPfe+gE29LxbEJxT5jcjvrWh5maFdZosWeIOG1ZX3pOuigEo7792SddY+W5rIGaEs3fvhGSgcTUO+YLHzGrmY94HeSOk6JLuVGKCQ6tqX5J03bPYLjqx0uAxUzmazNdX5vDvmr9JN6xHZwHo5bsKNrGjbw5uP56SX0JT2ZPwOzY3MoqWyZc19Bt4PN6rwMbEobKKSG63sQmaoLLbuvzd/Pf0RbuBF/yBJW5fFIxDe//H4+x9+evcDzUvXmZe/Qf+gf8CvK9q6UqjWUt361lXJbb3Z7qphd9Wwu2rYXTXsrhr266nX3FXD7qphd9Wwu2rYXTXsrhr230eEXTXsrhp2Vw27q4bdVcPuqmF31bC7athdNeyuGnZXDburhv0cNbGrht1Vw+6qYXfVsF9XNWzIISGrcL8qhFStXDifd3S+UiN7mSZTyks6Ok/u7ujx7z3lvlPzbzUaSmq6TJMbYSSFuDmlKY25O5S0co2UPfK9j9j3zmj51HM7vzevZHJR6pEf8YZP/V7YdurU6cm7syRNYrFCqXMaY8SManzFzKedBGJyAabgyqlCqEnNOTSJn5PSjUTtpt1cpWvOVQo/Wqk4Qs1bGHaTmPw26H/a1MYBd3c+D2qxaOB919YRgbARmo7vcrFY/AuhhfuK","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzmuv4Ltl0xcLdlSnEzWT5uZzNnjPXPGrolTU6dsl4fqhiTG3WQPybasceltv2Q/bb9kCyDZ6tbFdi4769RRHmI1CZIgCIAACNwlTkxscnSevNVZXaJyNrlMkxxtZmTlpFbJUXI2RXhrxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuB9VWiRw1zXBk7f/lczHy1Ebed7e29xVE/g/fHe3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvzt3clPMNamFK4Pp0Vt02a5XBrMXDH307spNrt6ZiM1rDNSTVIoxTXRSzr4rZbZNW3bosrpLw18c3rMtNrbe1dXlTYOc/jFb+Fob496vsNCz0AYZPhMl6VWUAkjSnR8YFPhuNvgb7U0mIdjKYpIi6ML1YO9PTev8GhvD45VLjMiBk9IraDHAbbvQYlIBPquwkyOZQBtkQ60gtlUZlOmyUz486wKkXk0DdoKMydvsDvxbQpzmvgtKh0xmGojf9fKiYKP4waNk5ko2sdGCBKodcI4ImelpXKxNawA/xeOh06PDyXwFaGWE7FKqbjHItyIokYbsJqlMCWsfsbKoGVmD/MSIVUOU5ST6db1RP6htq4zMdSW0GxjEdaKp8TkRSbbWBQWQY47tCzFNbZWA81CLIo+fDeHHMeiLlwKkjjOmRr78JN2IKqqkJkYFUicCyQ8wtUGe3zKgR0CIkqUfManLNNoQUAux2M0JJzUyVOEMRE74rOlEmDJcVOhQKuVg850oc06C3Fzl46QaeVQuT68uRGyYOT9Zi1IlRV1jjAqRHadwqioMQWDuRfcOZLiSj2/MwgIG2jO9AGLBXGhVoS/0mF5acEGrPI+nE2lXcoTdUZS8yLStqkapHasaWUiQRQxwFLIImXCpfBBj8BJV2BKAlsJNU9JY2IKDm/dSN+mkE0xu+ZfRuRSw6h2Tiu/sdzoKtczFWg51spZ+fsGiYw9H0/RYQqHKbxK4XUKg4MUBsMUBocpDF6lMHidwvAgheEwheFhCsNXHq3h6zSq/EjgNgKDoaey+3qoS3r3R2lZsklh2kYHzzo6eNCHvb1Gmqjt119/vVB3FwrgIiHhukiO4CJpQC6S1PeRzqS+Qfi+pY8Xw2/D55w+Xw1fh88Zgw4Ow+eUPoeDC7UIC16oIWPiRFndgwV1f1EMwldgImrjRakt6jNqJEWUxg46qw4+1LFo7+UF7UUq6aQo7PbtRIgntKMlSmubOqRNMbtu3xF3P6HttPGhHlaTvovVaqsrCjxjMVzb/ct+uFm2b94v+2T23kLn87b+irZOqumMVNP2/Tfa6wkRYRWnz6PEt302AFgzb6dDAHhCVOhi9Hk0eE00oEtpOwGo9wntvoUOdYQb3vcdHPYGL3vDg+FhhwLkG3mAsuzleW8+n38J6pHNE5YnkydaqN6yI790bHS5wf1g72AJFWwi/h1N9v8lQ30UbVjMye9jxyJaLI3H17aync7F/Jn1U8WhjXFG8EvTbN5Ck7sID/Z+s6mWWUCeYKJJNiIHr0806DEl9/N831MytuV5ryzb1KVG+uwx3VuNZdnP8/4K5Nrh+MYS8jyF9eaN7XkOZVluafbtFwlbVH8mzg+G2HbmDwB/FP8v2by78L2yQeEArQpem320zcKxcoNMpQodgVNgBcDgpC6EwVtyNq3UykN/ecGJcrM019k5Zb+OXX9PCvjmJJjkzwNP0xa6E1DLw+PWdtaexOAEb3mOrLZOl4SMzAXNkIKtsyk5byJa/kT3ZZiGvzJRSQoSFOgct6LL+puQ8KfWcrDpVFf9a4uusxlhIY7c4GLz8TN7Dw74dgv+xT3XW4B4Qhp+BSXq9NEK6j6/SErBBgBxGS5/azdFc5FcNmO8U435A2MvHyFHU5ljIUZYrHc9Wgbaewn81CIMdZRSNYEAxvcgbXWK25VO37fYIFt+x22mjjo8ikYkMRTSxlBIl17t0SFWxBE8hchBwRFCHEAR1yi5n8vmDWKP43OvBcLhPLAEwQEDNnG6uNoDK3QOpk0YmqOUSpZ12QQcx82skWRluMzb9KKRFMiOK7RPd20FcfvAChTd277AhRpwYCAGFO4x9QLEE1IGKyjdL6efoiY6d+QXutweFsC4rbYAbrgSCdRfho3w2e3S14cTuoAoyOkHUdgqy7ByFOL6XNFsUH70FcRBIB/Y+o4DW9s5rx3+ekLctwGtfzMHBrg/hgvb2/uKOLGD9qO50YfxSjG5x9fl7ifEfwGflcNN0kRX9PQptTrOk6Mkp8fS+LaXpDwzWvedzufJ0V0S4uz0M0SxaeT+B0uvrXeJzaZYCvoVMaL3WXoeTdKEwy30REtESo4SPfqAGa1RGcLBSbQ0kqGP7iKUf1VM0uB8J0eJf25M0gRvRVkRcLLyHlvl42QRF7xvqqZlOZXlH83zJs1DD3efOM1PNHSx8ir9STO9bc3AeyvxTH+vqc/hWzG3rXn99Z6sPobTGGL+LIyCXMwtyVNtvSWWiSKrC3Lk8baSZt5EFdibb3FFg2+zUoPv4OUi5VcBNG2UhDFinqSJdFi227cwgdEff3IZaqIMh3Y/duwHjSPEv4QGenrngxflR2PxQSOMkA+9mmr10eMHwxeD4eDFYEgzhDeZT6ej713HoMsYb8gHxTxa573lM2oK/JTRf4hHIzxvW0zwYWY82/a83nrVs1NdFzm9l6EwfX7l/uQEii5/N3dQ/wFuXqTJ7cObuYVM9+LbPXxT4NhBXVVoINNGoXneDuA9mc0NDw8XaTJ/eHvzr3J739LhzR7e3S+c9LBMCPlP4Pri9SJNpg/j+t9NWsZ/ENnDV4vl7ZpkBoXDeDlcjXQ+v4p6a/EQYLwoCG6sixwNWSHr+mqpakjDUDrR1aqeH2ldoFAbFE3nPT6kfpExSHZgiGDPpki29NJG5NmXZmmwGj229MaPKxFGacn6MzVeJH04HreMXA4QrKYERFh+nlcanvF6V7ZmNf5sP3wTjZ61U58oG2UZuY8oMDA4LKuCc4dmsigIb7rX+9D8Y3OvoSQhEK/LuPDDV8X3PpLJC4ZB3cQbCBZjH74Xqkm+6CY5wN1dwwbMHYsF3N3RqaK5okt3sUiXDbRWp4HvVd9iMEN50xnVNOFyYNPWGupNnCsycXxDeAxrIyAnSqrJVW2KxaK/xobLM3o03dbIFM6OJvl/QDFC51idmBzNIyT3eOz9NA3PiFmfhag4U0Ya64I8enYPCPu3rS1UDkkM5N790Mi3rUeWoFScbyk/zsjJBCnBMEDw4JAShCKbes3AWIkxiTYnDRq8kbq2Eb2psI3JnROE9OIi1aTrZraowxlb7b33N4muohyik7PTR9CSneCe10Teg/S79HPAydkppSHKcfDo+vDeNpSIpBUdECBfC26kiKlKjfk293FKVEwRrzY7OaP9kADYg3WEcmk3YpQuX0qatN21iZd5qnREunaUICtD9pV1WNkOHRmLhpBnun4MVz5ASQGTmt9ZHd3KUTXy680yjVAq60ztY7SQ1yZmTga2IMgMrV3SKVKFgFrzp4DK+uECxsI6NCnUShLlTU0hkmZKvK3QSFQZbiSBQU86ktyHtVk3J+/9zz+G7OS4hyiUI5JAPzHmUFfMNSwJTa5oPLnVrW/UHUFtPYwgXdCc0RnC8xUaqxVQJqaZCCV/9yzMToe25LFNReFBg6qgV2rChyS8i0w0p/7593+08Nrqdq4j5lcQeU5vhg9gyCEyz/AUmjdYkQbUXYxoPjR/WbXzCDsWmqtS540g2cfz+CklEDvb6EWnOeEcC/T58fENs9G3No061gbPkZ4yDT85ErGdrmi/eCuta2U7xpyEdf3wMxIdsxYO7GmQVBPPq3lbwBu8Qlblcjq2AWU3U7axdFdkoWWxdoJh/qJni3YZ3AqamJK/tbLe5x4eHNCfLkWb8oNgBRPtiM/HdVHM/5Skj4+s3e/wN9jKjXb0fU789IMc/n6b3QxPiXG26IF7Jwg+R20KKikgweg1Z8D82KKtVIVUeMUkvsp1dmXQXg0PDq4GRONFmhxuIuM7XaKbMusQMWdGU8VBVaCgDHgzBzERUgGZweYLUhWN0eZ+v+TjMNtAichDV4cdIrxcJ8Kx4odfrmQ509eo/tidtpd3fnlC9bZkhvH6OZEeiPuTzmbb7X6TFrPaSDdPjs7vktueqGTP9x+dXy4u04QIqyk4XWnLGAs3TY6S/dVYtUVzw1HH8zvPvg1HWqFyepxd84RFJfdvBskiXR2x0W/eCm2dmEg16d076nK503d0Gp7gnf0uw3yV/B+kOF8gZxsqTSRxwRQFmdFEQDrkn5eB+h/iUcVg+qb4+PJIViPeMeDdiWGv3hAbotKbg9KDl61w8HmM7HKwtonVbgq/NluPAdUmntoKkbYipOdLlm2CkTEWOeAg3vDwkKNd3w44LPTiNUdcDl8tmMmW0Yck6UYY+EFl1U9Okq7/Fwc13k0YtTTR/etex9YMTV3bK87U2Dodg2PV3th692+5+qO9J9VYM78FJjipUL0jc5qk+mawHiTDItNlU7AQwf/593/wiMg8vMyf4KQ2UOkZmnHtqx7GBd5KMmBb1XcxBIOiLNDaYg5kt064Di+XE858ilZhJioxkoUkNUVg2j9JtDSd7cMvyyDOM+OTwG6wIO0GhdZclEYWTO10yWvEK3mmzfWYUEqptI/qmMgus4hxCKqpUBnFgbz4sk1DRXhkZ1dGWgQhSwImex/HY5lJvuu1ckZkDkqhxISNk5SDdUSFKlYhGT0id8nqovYOAdVCITq/RX4e7cNbcsB44/wUg46OPfe+gE29LxbEJxT5jcjvrWh5maFdZosWeIOG1ZX3pOuigEo7792SddY+W5rIGaEs3fvhGSgcTUO+YLHzGrmY94HeSOk6JLuVGKCQ6tqX5J03bPYLjqx0uAxUzmazNdX5vDvmr9JN6xHZwHo5bsKNrGjbw5uP56SX0JT2ZPwOzY3MoqWyZc19Bt4PN6rwMbEobKKSG63sQmaoLLbuvzd/Pf0RbuBF/yBJW5fFIxDe//H4+x9+evcDzUvXmZe/Qf+gf8CvK9q6UqjWUt361lXJbb3Z7qphd9Wwu2rYXTXsrhr266nX3FXD7qphd9Wwu2rYXTXsrhr230eEXTXsrhp2Vw27q4bdVcPuqmF31bC7athdNeyuGnZXDburhv0cNbGrht1Vw+6qYXfVsF9XNWzIISGrcL8qhFStXDifd3S+UiN7mSZTyks6Ok/u7ujx7z3lvlPzbzUaSmq6TJMbYSSFuDmlKY25O5S0co2UPfK9j9j3zmj51HM7vzevZHJR6pEf8YZP/V7YdurU6cm7syRNYrFCqXMaY8SManzFzKedBGJyAabgyqlCqEnNOTSJn5PSjUTtpt1cpWvOVQo/Wqk4Qs1bGHaTmPw26H/a1MYBd3c+D2qxaOB919YRgbARmo7vcrFY/AuhhfuK",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,b={},y=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," 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, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," 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, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy"'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"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. \n",example:!0},email_subject:{type:"string",description:"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}}.",example:""},email_body:{type:"string",description:"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}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.73bf45a2.js b/assets/js/ae010e44.73bf45a2.js new file mode 100644 index 000000000..c9838a02c --- /dev/null +++ b/assets/js/ae010e44.73bf45a2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6685],{73320:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/selfsign","title":"Self Sign","description":"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 \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/selfsign.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/selfsign","permalink":"/docs/API-docs/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"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 \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztG8tyGzfyVzpzcawaUiItO16e4tjZXe9mY1ekVColqRRwpsmBhQEmAEYko2JVDvmM3Us+LV+y1XgMZ/gQ7SSVaGvpg8wBGkB3o9HoF+4Sy6YmGV0kr1RWlyitSa7SJEeTaV5ZrmQySs4LBINiYvhUwou3r2GKEjWzaIDB1199AbZgFlCysUADE41o7EIgEDyXU1ATYJCH+fvwraohYxKYMAq4zESdIyi3GBNQaezlOOESc5jxfIrWpDAreFaALfycqN14zLkFpQHnFZM51JWSwAxIxBzzPpwX3ECl1S3PHaIRG5xXqDnKjCYruWAarHJz//Ljv8+IxG9VrYneX378D0yEmgGXrv9NhdIBsKrqX8pLec6rEXxdCcVyWKhaw9tXf20IpVmp7eLo6BWO6yl8/fro6OrjwtrKjI6PaQ5VoSS0BBubfqbK45wAq3zymEhGjTSrp5UZLhbA8hZTbIESMlUtIFNK51zSjqRQsSmCrMsxapMCcaZUGokGBhpZvuhZ1asNwj/O3nwJE6VLZvvwVtQmbZbLucbMioWfnmiPVD0yMGYGn52CsZrLaQoluyG2cgvf1zy7IbINyjwy9cXb145XR0dndVUpbTGHbzwJo6Mj6vkMicdMo4PPVFkqCRXTrESL2njpom6N39dcO7mwBTAhIi9Gl7IHR0d2UeHo6Ahey5xnTjxpQmolEfSwfQ9KTCLQswozPuEBtMU6UDJIHfFkxvx+VoJlHk2NpsLM8lvsTjxPYUETv0KpIgaF0vwHJS0TbjtuUVueMdHeNkLQibdl2hI7K8Wlja1hhebk0O65TQlyRajlxKySS9djEG6ZqNEErGYpFITVV1hpNHTK47zESJlDgXxa7FyP5e9qYzsTQ20IzTYWYa24S4696Ng2YcIg8EmHlyW7wdZqjQbow2cLyHHCamFT4CRxVtfYhy+VpZMneEaKhiTXnWlma409t8tBHAIikpVuj9+udEDOJxPUdDip000RxkTsSM680iDy3MmxBZOg5NpGZ0oovSlCrrnLR8iUtE7zvbhlXDjkPbGmUX9jwbKbFMaixhQ05v7gLlAINUu9vDsQUnCe544/pJZJCpUk/KUKy3MDJmDVKMJ4nqizUba0CDdtroZTO1G0MrEgHjHAknGROsal8E6NwXIrMKUDWzG5SCFnFlOwOLdjNU8hKzC7Gat54NdESWv4D1tOXez5cK4NUzhN4VkKz1MYnKQwGKYwOE1h8CyFwfMUhicpDIcpDE9TGD7zPB0+D/xkDRPbCAyGnpP2YXGQ9OcX3LgTSorPNLp01tGlgz4cHTWngtq+++67S3l3KQEuEzokl8kILpMG5DJJfR/pPuobhO85fTwZfhI+F/T5bPg8fM4c6OA0fBb0ORxcymVY8FIOHSaWldU9WFD374pB+AqCQm1uUWqLeokaSaGksYP2o4MPdSzbtDwhWrjkljNhdpMTIR4QRSuUNog6JaKcSO6myHU/IHLa+FCPU3e+y6nHVlc81A6L4Qb1T/vhhthNvF/2wdDeQue3kf6MSCf1c07qZzf9jYZ6QExYx+m3ceKTvrvInfbdzYcA8IC40MXot/HgOfGALp7dDKDeB0R9Cx3qCLe47zs57Q2e9oYnw9MOB8jH8QBl2cvz3mKx+D24R3ZNWJ7MmmhpeguNWYSJVuUWN8JZ+SuoYPe439H0/hcZ3ONoi2IefdDGKmk8t7a1bFXOFo+MnyoObQwwgl+ZX4sWmq6L8HBebFYongXkCSaaXWNy1PrEg57j5HGeH3tOxrY875Vlm7vUSJ89x/dWY1n287y/BrmxOb6xhDxPYbN5a3ueQ1mWO5p9+2XiLKq/kOQHY2u38AeAP0r+V2LeXfjes0FuvZLCre18re2HY+0GKbgMHUFSYA1A47QWTOOcnEbDlfTQv//BiedmZZI7J9P5Z86F96yAj98Es/txkGkioTsBtewft0FZexKNU5y7ObLaWFUSMjxnNEMKps4KcsJYtO6J76twi/vKWMXJ2RdorWtFm/W3IeF3reUo066u+8kGbYcYZiCO3OIqu+134j04cbdb8CHuud4CxAPS8GsoUaePOlD3xWVSMmcAkJTh6reyBerL5KoZ451jzPeMvXqPc1TwHAUbo9jseu8z0KYlyFOLMdRRctk49A7fk7TVyeZrnb5vueVseYrbQh11eDwakcUguIkhjS6/2qNDzMdF4ii+SnI5RogDYNyI4W8W8wax95NzrwXC5uxZguDAATbxtsbFvn+Fzsa0GUNzlFzysi6bwOGkmTWyrAyXeZtfNLI2qOMK7d3dWIHN96xAUbrdC1zKgQsM8JJN77HzXPcDUgMBnzX5TtJEVZR+4Eq+zpNRElMTSeomRWM/U/kiGd0lIYREP0OAhgYdvzOU1rhLTFZgyehXRIYSIRMuMEkTn2gwSZo4f4OyIsSpZJSo8TvMbJLStVlRLBcNzeHGje4ilA+PJ2mwPpNR4uPmSZrgnJUVAYcmQJkpsvGqfJIs44L3TdW0rKYy7kcTp6d5KAL9K6f5koYu1xJBv2qmV60ZHG0lnquXivosvmIL05rXy3eynn+iMXR+szAKcrYwFHWrjVdFGRNZLciSxXnF9aIxq50527CkhW+zUoPv4OkybnoLox17rdWHb1CGihjgQhgfOvadwjHip6GBUkVuf1n5wVi8UwhjdHtbFUp+8PjB8MlgOHgyGNIMIfbYmoNpzRZJmnCLpdnPR9+7iUF3/1+QrYV5vIV6q7B/Ci5k198nihHekc2muF/mznelg1oRalOoWuQU+0Wm+y4r86sTfl0xpkUctf09QrtMk/l+YuaQqV7MNcHHAicW6qqiPKrSEvXjtqP6YIgbnp4u02Sxn7zF/yR5n9DmzfZT941L0q0SmH8Grk+eL9Ok2I/r35s04p+I7Omz5eoSTTKNzGK8A67HKl9cR721bANGM6ILGm6EJa0octRkcWzqq5WqIUhKf1+v6/mxUgKZ3KJoOrkl51caZ7aSURwiNbMCyblZWbNudtOY4cGE9iYL5atwzZPmhiw9XeNl0ofXkxUvvSG8nt6KsC69JRU8cutdm9qp8UfH4Zs49Kidqqfs6SpCFVFwwGCxrITLdc+4EIQ3Xd99aP45067hJCEQr8u48P6r4qX32N2CYVA3UQzBROzDSyabRGI3YQd3d40QOOlYLuHujnYV9TVdustlumqgtToN7l71LRoz5LedUU0TrgY2ba2h3pK5JkvGN4SgbxsBX9FyXWuxXPY3xHC1R+/Ntw02hb2jSf4fOOZKmM5Vrd/j4DoPs+cPj3dwvGD7SYDBtHaBW0vqL8qgCwet6gu4NFbX3umDvNaxpCLWKlVaZWhMP1RQ9CDnxieZC2zPnwJK44czmDBjUadQSy4tal1X5BFulj916HcLLMmD8rU/xKL9YtNN5FMpmC9balVqxcMeJ8ZQqRWM+aaIJFZNrZO+VbsG+diPIGlCV+oR/P0KtVGSqsaUnjLJf3AeobfulCHTuGDCg3rJ5xT2JnxIyXaRiffWLz/93MJrp32/iZhfgeU5BSH3YOi8fHLnjfP1NVZiAVZ1MaL5UH+6fqEme685fxOuvOCgfKnISUnjbfXhyQn91yUjVg1CuGYpPkrbNqmFWHyUpO/vgt/vKPjm7ZfvfZZ/8Y4Pf5hnt8O3tEU7ZPreCYKhUmtBdXPEuV5TyrjOWy4Fl3gd2XY9PDm5HhBvl2lyuo19Z6pEW7giEWLiTCuqqKsEMqrw0gtgU8Yl0LWpf0duotZK32/HfBhm9zHhtMOEp5tMeC1dQNRVlp6rG5R/LKXt5a1fnlCdl05WvJpJuAdy/UmH2Ha7J9JgVmtuF8no4i6Z91jFe75/dHG1vEoTYqyiwFWljMOY2SIZJcetOJZBfUvBJ5rBCW0jh4bJnOKVG0Yzq/jx7SBZpusjtprYO6GNZVMup717R12tiDyjjfC87pC6ighU/J9IIYHAyTZUmnASgAJZTjb2Mk1of79aBfE+j7sUw2vbImYt3bYWA4shsE5Ua10Tb4lTbQ9TDZ62A0Q+BOSiOk1QZ1ucpiE8Rl6awEsrltIKpVysZLWJWsSgxcB5+8PTU+cWfzJw/uOT5841O322vOp4KUnS9URckHXdnk6Srp3ovltWkE91rFkFcebmFu5ches34e5bibZ/opyshA1sKqzpMN4ONn1hFJkqmxq7CP7LTz+7EXHjna74CN7UGio1Qz2pfaHeROCck/lEwGueFrJSoDFiAWQ1Tam8HXI+dYm8aJNkrGJjLjhpFwJTPsDYUlCmD9+sfLVH2uc0b1GQUgKhlKuVtgpYbVXp1og36EzpG6o2p6JtGFN5LVkFBjEOQVkwV7Uejl5KRgLVhpOVV2luEBgvCZisTZxMeMbd1ayk1SyzUDLJpkiLpc4nJy40BfJajSlLYZSovTlKJbqI1pNISR/Th1dU7+wId4FVtLS1ubdEDRUy5hSCdcIfas/H5ERUtDzP0KyKHwTeonaqxrsStRBQKVL5nAmyhdp7SxNZzaShmzoEdcPWNOwL9qJbI2eLPlDag24xsppIAASXN75S/KIRs29wbLjFVTxiNpttqL3H3TF/47aox2SBqdW4qWt0SrI9vPl4TDoFdWneTM5Q3/Is2hY71jx2wMfhImTe9Y0HilV862kSPENpsHVtvfjb2y/gFp70T5K0pejfA+HjL16//PzLs89pXrqK/Pkb9E/6Jy6IqowtmWwtdYZiAmf++lrLGjR3+eElyeElyeElyeElyeElyeElyeElyeElyeElyeElyeElyeElyeElyZ9WaXt4SXJ4SXJ4SXJ4SXJ4SXJ4SXJ4SXJ4SXJ4SXJ4SfJ/9JIkpFpJIx5XgnHZKhPxefmL1fuSqzQpKGU/ukju7ih2/TWVkVHz9zVqyvdfpckt05yiNy7bn8bcNqV1b5ASrC99MKp3TiunXhu5nM5akQOl5v2IF1mGlb0Xtl1V8PbN2XmSJrHur1Q5jdFsRu9j2MynbwMfXSKbuSJkweS0dlnmxM9J6XhW26Kby79xufzwo5WsZnLRwrCb5Pdk0F8iauuAuztfJ7BcNvC+a+eIwNgITTt3tVwu/wvIg5do","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),p=t(86013),c=t.n(p),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"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 \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztG8tyGzfyVzpzcawaUiItO16e4tjZXe9mY1ekVColqRRwpsmBhQEmAEYko2JVDvmM3Us+LV+y1XgMZ/gQ7SSVaGvpg8wBGkB3o9HoF+4Sy6YmGV0kr1RWlyitSa7SJEeTaV5ZrmQySs4LBINiYvhUwou3r2GKEjWzaIDB1199AbZgFlCysUADE41o7EIgEDyXU1ATYJCH+fvwraohYxKYMAq4zESdIyi3GBNQaezlOOESc5jxfIrWpDAreFaALfycqN14zLkFpQHnFZM51JWSwAxIxBzzPpwX3ECl1S3PHaIRG5xXqDnKjCYruWAarHJz//Ljv8+IxG9VrYneX378D0yEmgGXrv9NhdIBsKrqX8pLec6rEXxdCcVyWKhaw9tXf20IpVmp7eLo6BWO6yl8/fro6OrjwtrKjI6PaQ5VoSS0BBubfqbK45wAq3zymEhGjTSrp5UZLhbA8hZTbIESMlUtIFNK51zSjqRQsSmCrMsxapMCcaZUGokGBhpZvuhZ1asNwj/O3nwJE6VLZvvwVtQmbZbLucbMioWfnmiPVD0yMGYGn52CsZrLaQoluyG2cgvf1zy7IbINyjwy9cXb145XR0dndVUpbTGHbzwJo6Mj6vkMicdMo4PPVFkqCRXTrESL2njpom6N39dcO7mwBTAhIi9Gl7IHR0d2UeHo6Ahey5xnTjxpQmolEfSwfQ9KTCLQswozPuEBtMU6UDJIHfFkxvx+VoJlHk2NpsLM8lvsTjxPYUETv0KpIgaF0vwHJS0TbjtuUVueMdHeNkLQibdl2hI7K8Wlja1hhebk0O65TQlyRajlxKySS9djEG6ZqNEErGYpFITVV1hpNHTK47zESJlDgXxa7FyP5e9qYzsTQ20IzTYWYa24S4696Ng2YcIg8EmHlyW7wdZqjQbow2cLyHHCamFT4CRxVtfYhy+VpZMneEaKhiTXnWlma409t8tBHAIikpVuj9+udEDOJxPUdDip000RxkTsSM680iDy3MmxBZOg5NpGZ0oovSlCrrnLR8iUtE7zvbhlXDjkPbGmUX9jwbKbFMaixhQ05v7gLlAINUu9vDsQUnCe544/pJZJCpUk/KUKy3MDJmDVKMJ4nqizUba0CDdtroZTO1G0MrEgHjHAknGROsal8E6NwXIrMKUDWzG5SCFnFlOwOLdjNU8hKzC7Gat54NdESWv4D1tOXez5cK4NUzhN4VkKz1MYnKQwGKYwOE1h8CyFwfMUhicpDIcpDE9TGD7zPB0+D/xkDRPbCAyGnpP2YXGQ9OcX3LgTSorPNLp01tGlgz4cHTWngtq+++67S3l3KQEuEzokl8kILpMG5DJJfR/pPuobhO85fTwZfhI+F/T5bPg8fM4c6OA0fBb0ORxcymVY8FIOHSaWldU9WFD374pB+AqCQm1uUWqLeokaSaGksYP2o4MPdSzbtDwhWrjkljNhdpMTIR4QRSuUNog6JaKcSO6myHU/IHLa+FCPU3e+y6nHVlc81A6L4Qb1T/vhhthNvF/2wdDeQue3kf6MSCf1c07qZzf9jYZ6QExYx+m3ceKTvrvInfbdzYcA8IC40MXot/HgOfGALp7dDKDeB0R9Cx3qCLe47zs57Q2e9oYnw9MOB8jH8QBl2cvz3mKx+D24R3ZNWJ7MmmhpeguNWYSJVuUWN8JZ+SuoYPe439H0/hcZ3ONoi2IefdDGKmk8t7a1bFXOFo+MnyoObQwwgl+ZX4sWmq6L8HBebFYongXkCSaaXWNy1PrEg57j5HGeH3tOxrY875Vlm7vUSJ89x/dWY1n287y/BrmxOb6xhDxPYbN5a3ueQ1mWO5p9+2XiLKq/kOQHY2u38AeAP0r+V2LeXfjes0FuvZLCre18re2HY+0GKbgMHUFSYA1A47QWTOOcnEbDlfTQv//BiedmZZI7J9P5Z86F96yAj98Es/txkGkioTsBtewft0FZexKNU5y7ObLaWFUSMjxnNEMKps4KcsJYtO6J76twi/vKWMXJ2RdorWtFm/W3IeF3reUo066u+8kGbYcYZiCO3OIqu+134j04cbdb8CHuud4CxAPS8GsoUaePOlD3xWVSMmcAkJTh6reyBerL5KoZ451jzPeMvXqPc1TwHAUbo9jseu8z0KYlyFOLMdRRctk49A7fk7TVyeZrnb5vueVseYrbQh11eDwakcUguIkhjS6/2qNDzMdF4ii+SnI5RogDYNyI4W8W8wax95NzrwXC5uxZguDAATbxtsbFvn+Fzsa0GUNzlFzysi6bwOGkmTWyrAyXeZtfNLI2qOMK7d3dWIHN96xAUbrdC1zKgQsM8JJN77HzXPcDUgMBnzX5TtJEVZR+4Eq+zpNRElMTSeomRWM/U/kiGd0lIYREP0OAhgYdvzOU1rhLTFZgyehXRIYSIRMuMEkTn2gwSZo4f4OyIsSpZJSo8TvMbJLStVlRLBcNzeHGje4ilA+PJ2mwPpNR4uPmSZrgnJUVAYcmQJkpsvGqfJIs44L3TdW0rKYy7kcTp6d5KAL9K6f5koYu1xJBv2qmV60ZHG0lnquXivosvmIL05rXy3eynn+iMXR+szAKcrYwFHWrjVdFGRNZLciSxXnF9aIxq50527CkhW+zUoPv4OkybnoLox17rdWHb1CGihjgQhgfOvadwjHip6GBUkVuf1n5wVi8UwhjdHtbFUp+8PjB8MlgOHgyGNIMIfbYmoNpzRZJmnCLpdnPR9+7iUF3/1+QrYV5vIV6q7B/Ci5k198nihHekc2muF/mznelg1oRalOoWuQU+0Wm+y4r86sTfl0xpkUctf09QrtMk/l+YuaQqV7MNcHHAicW6qqiPKrSEvXjtqP6YIgbnp4u02Sxn7zF/yR5n9DmzfZT941L0q0SmH8Grk+eL9Ok2I/r35s04p+I7Omz5eoSTTKNzGK8A67HKl9cR721bANGM6ILGm6EJa0octRkcWzqq5WqIUhKf1+v6/mxUgKZ3KJoOrkl51caZ7aSURwiNbMCyblZWbNudtOY4cGE9iYL5atwzZPmhiw9XeNl0ofXkxUvvSG8nt6KsC69JRU8cutdm9qp8UfH4Zs49Kidqqfs6SpCFVFwwGCxrITLdc+4EIQ3Xd99aP45067hJCEQr8u48P6r4qX32N2CYVA3UQzBROzDSyabRGI3YQd3d40QOOlYLuHujnYV9TVdustlumqgtToN7l71LRoz5LedUU0TrgY2ba2h3pK5JkvGN4SgbxsBX9FyXWuxXPY3xHC1R+/Ntw02hb2jSf4fOOZKmM5Vrd/j4DoPs+cPj3dwvGD7SYDBtHaBW0vqL8qgCwet6gu4NFbX3umDvNaxpCLWKlVaZWhMP1RQ9CDnxieZC2zPnwJK44czmDBjUadQSy4tal1X5BFulj916HcLLMmD8rU/xKL9YtNN5FMpmC9balVqxcMeJ8ZQqRWM+aaIJFZNrZO+VbsG+diPIGlCV+oR/P0KtVGSqsaUnjLJf3AeobfulCHTuGDCg3rJ5xT2JnxIyXaRiffWLz/93MJrp32/iZhfgeU5BSH3YOi8fHLnjfP1NVZiAVZ1MaL5UH+6fqEme685fxOuvOCgfKnISUnjbfXhyQn91yUjVg1CuGYpPkrbNqmFWHyUpO/vgt/vKPjm7ZfvfZZ/8Y4Pf5hnt8O3tEU7ZPreCYKhUmtBdXPEuV5TyrjOWy4Fl3gd2XY9PDm5HhBvl2lyuo19Z6pEW7giEWLiTCuqqKsEMqrw0gtgU8Yl0LWpf0duotZK32/HfBhm9zHhtMOEp5tMeC1dQNRVlp6rG5R/LKXt5a1fnlCdl05WvJpJuAdy/UmH2Ha7J9JgVmtuF8no4i6Z91jFe75/dHG1vEoTYqyiwFWljMOY2SIZJcetOJZBfUvBJ5rBCW0jh4bJnOKVG0Yzq/jx7SBZpusjtprYO6GNZVMup717R12tiDyjjfC87pC6ighU/J9IIYHAyTZUmnASgAJZTjb2Mk1of79aBfE+j7sUw2vbImYt3bYWA4shsE5Ua10Tb4lTbQ9TDZ62A0Q+BOSiOk1QZ1ucpiE8Rl6awEsrltIKpVysZLWJWsSgxcB5+8PTU+cWfzJw/uOT5841O322vOp4KUnS9URckHXdnk6Srp3ovltWkE91rFkFcebmFu5ches34e5bibZ/opyshA1sKqzpMN4ONn1hFJkqmxq7CP7LTz+7EXHjna74CN7UGio1Qz2pfaHeROCck/lEwGueFrJSoDFiAWQ1Tam8HXI+dYm8aJNkrGJjLjhpFwJTPsDYUlCmD9+sfLVH2uc0b1GQUgKhlKuVtgpYbVXp1og36EzpG6o2p6JtGFN5LVkFBjEOQVkwV7Uejl5KRgLVhpOVV2luEBgvCZisTZxMeMbd1ayk1SyzUDLJpkiLpc4nJy40BfJajSlLYZSovTlKJbqI1pNISR/Th1dU7+wId4FVtLS1ubdEDRUy5hSCdcIfas/H5ERUtDzP0KyKHwTeonaqxrsStRBQKVL5nAmyhdp7SxNZzaShmzoEdcPWNOwL9qJbI2eLPlDag24xsppIAASXN75S/KIRs29wbLjFVTxiNpttqL3H3TF/47aox2SBqdW4qWt0SrI9vPl4TDoFdWneTM5Q3/Is2hY71jx2wMfhImTe9Y0HilV862kSPENpsHVtvfjb2y/gFp70T5K0pejfA+HjL16//PzLs89pXrqK/Pkb9E/6Jy6IqowtmWwtdYZiAmf++lrLGjR3+eElyeElyeElyeElyeElyeElyeElyeElyeElyeElyeElyeElyeElyZ9WaXt4SXJ4SXJ4SXJ4SXJ4SXJ4SXJ4SXJ4SXJ4SXJ4SfJ/9JIkpFpJIx5XgnHZKhPxefmL1fuSqzQpKGU/ukju7ih2/TWVkVHz9zVqyvdfpckt05yiNy7bn8bcNqV1b5ASrC99MKp3TiunXhu5nM5akQOl5v2IF1mGlb0Xtl1V8PbN2XmSJrHur1Q5jdFsRu9j2MynbwMfXSKbuSJkweS0dlnmxM9J6XhW26Kby79xufzwo5WsZnLRwrCb5Pdk0F8iauuAuztfJ7BcNvC+a+eIwNgITTt3tVwu/wvIg5do",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"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 \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," 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."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy"'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"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. \n",example:!0},email_subject:{type:"string",description:"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}}.",example:""},email_body:{type:"string",description:"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}}.",example:""},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.af652df7.js b/assets/js/ae010e44.af652df7.js deleted file mode 100644 index 1c7b72731..000000000 --- a/assets/js/ae010e44.af652df7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6685],{73320:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/selfsign","title":"Self Sign","description":"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 \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/selfsign.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/selfsign","permalink":"/docs/API-docs/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"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 \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztG11zG7fxr2zvxbHmSIm07Lh8qmOnrVsn9kTKZDKSRgHvljxYOOAC4EQyGs7koT+jfclPyy/pLD6Od/wQ7STTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cW71zBFiZpZNMDg66/egC2YBZRsLNDARCMauxAIBM/lFNQEGORh/j58q2rImAQmjAIuM1HnCMotxgRUGns5TrjEHGY8n6I1KcwKnhVgCz8najcec25BacB5xWQOdaUkMAMSMce8D+cFN1Bpdctzh2jEBucVao4yo8lKLpgGq9zcP//4zzMi8VtVa6L35x//BROhZsCl639boXQArKr6l/JSnvNqBF9XQrEcFqrW8O7VnxtCaVZquzg6eoXjegpfvz46uvqksLYyo+NjmkNVKAktwcamn6nyOCfAKp88JpJRI83qaWWGiwWwvMUUW6CETFULyJTSOZe0IylUbIog63KM2qRAnCmVRqKBgUaWL3pW9WqD8Lezt1/CROmS2T68E7VJm+VyrjGzYuGnJ9ojVY8MjJnBZ6dgrOZymkLJboit3ML3Nc9uiGyDMo9MffHutePV0dFZXVVKW8zhG0/C6OiIej5D4jHT6OAzVZZKQsU0K9GiNl66qFvj9zXXTi5sAUyIyIvRpezB0ZFdVDg6OoLXMueZE0+akFpJBD1s34MSkwj0rMKMT3gAbbEOlAxSRzyZMb+flWCZR1OjqTCz/Ba7E89TWNDEr1CqiEGhNP9BScuE245b1JZnTLS3jRB04m2ZtsTOSnFpY2tYoTk5tHtuU4JcEWo5Mavk0vUYhFsmajQBq1kKBWH1FVYaDZ3yOC8xUuZQIJ8WO9dj+fva2M7EUBtCs41FWCvukmMvOrZNmDAIfNLhZclusLVaowH68NkCcpywWtgUOEmc1TX24Utl6eQJnpGiIcl1Z5rZWmPP7XIQh4CIZKXb43crHZDzyQQ1HU7qdFOEMRE7kjOvNIg8d3JswSQoubbRmRJKb4qQa+7yETIlrdN8L24ZFw55T6xp1N9YsOwmhbGoMQWNuT+4CxRCzVIv7w6EFJznueMPqWWSQiUJf6nC8tyACVg1ijCeJ+pslC0twk2bq+HUThStTCyIRwywZFykjnEpvFdjsNwKTOnAVkwuUsiZxRQszu1YzVPICsxuxmoe+DVR0hr+w5ZTF3s+nmvDFE5TeJbC8xQGJykMhikMTlMYPEth8DyF4UkKw2EKw9MUhs88T4fPAz9Zw8Q2AoOh56R9WBwk/fmGG3dCSfGZRpfOOrp00Iejo+ZUUNt33313Ke8uJcBlQofkMhnBZdKAXCap7yPdR32D8D2njyfDT8Pngj6fDZ+Hz5kDHZyGz4I+h4NLuQwLXsqhw8SysroHC+r+TTEIX0FQqM0tSm1RL1EjKZQ0dtB+dPChjmWblidEC5fccibMbnIixAOiaIXSBlGnRJQTyd0Uue4HRE4bH+px6s53OfXY6oqH2mEx3KD+aT/cELuJ98s+GNpb6Pw60p8R6aR+zkn97Ka/0VAPiAnrOP06Tnzadxe50767+RAAHhAXuhj9Oh48Jx7QxbObAdT7gKhvoUMd4Rb3fSenvcHT3vBkeNrhAPk4HqAse3neWywWvwX3yK4Jy5NZEy1Nb6ExizDRqtziRjgrfwUV7B73O5reX5DBPY62KObRB22sksZza1vLVuVs8cj4qeLQxgAj+JX5tWih6boID+fFZoXiWUCeYKLZNSZHrU886BHf8+MvvjhucdI39sqyt9ZInz3H+FZjWfbzvL8GubE7vrGEPE9hs3lre55DWZY7mn37ZeJMqj+S6Adra7f0B4D/1AFYyXl34XsPB/n1Sgq3tnO2tp+OtSuk4DJ0BFGBNQCN01owjXPyGg1X0kP/9icnHpyVTe68TOegOR/eswI+eRvs7sdBqImE7gTUsn/cBmXtSTROce7myGpjVUnI8JzRDCmYOivIC2PRvCe+r+It7itjFSdvX6C1rhVt1t+GhN+1lqdMu7ruKBu0HWKYgThyi6/stt+J9+DEXW/BibjnfgsQD0jFr6FEnT7sQN0Xl0nJnAVAUoar38oWqC+Tq2aM944x3zP26gPOUcFzFGyMYrPrg89Am5YgTy3GUEfJZePRO3xP0lYnm691+r7llrPlKW4LdVTi8WhEFoPgJsY0uvxqjw5BHxeKowAryeUYIQ6AcSOGv1rMG8Q+TM69Fgibs2cJggMH2ATcGh/7/hU6G9NmDM1RcsnLumwih5Nm1siyMtzmbX7RyNqgjiu0d3djBTbfswKF6XYvcCkHLjLASza9x9Bz3Q9IDQR81uQ7SRNVUf6BK/k6T0ZJzE0kqZsUjf1M5YtkdJeEGBL9DBEaGnT83lBe4y4xWYElo18RGcqETLjAJE18psEkaeIcDkqLEKeSUaLG7zGzSUrXZkXBXDQ0hxs3uotQPj6epMH8TEaJD5wnaYJzVlYEHJoAZabIyKvySbKMC943VdOymsq4H02gnuahEPQvnOZLGrpcywT9opletWZwtJV4rl4q6rP4ii1Ma14v38l6AorG0PnNwijI2cJQ2K02XhVlTGS1IFMW5xXXi8audvZsw5IWvs1KDb6Dp8u46S2Mduy1Vh+/QRkqYoCLYXzs2PcKx4h/Cg2UK3L7y8qPxuK9Qhij29uqUPKjxw+GTwbDwZPBkGYIwcfWHExrtkjShFsszX4++t5NDLr7/4JsLczjLdRbxf1TcDG7/j5RjPCObDbF/TJ3visf1ApRm0LVIqfgLzLdd2mZX5zx64oxLeKo7e8R2mWazPcTM4dM9WKyCT4ROLFQVxUlUpWWqB+3PdUHQ9zw9HSZJov95C3+K8n7lDZvtp+6b1yWbpXB/D1wffJ8mSbFflz/2uQRf0dkT58tV5dokmlkFuMdcD1W+eI66q1lGzCaEV3QcCMsaUWRoyaLY1NfrVQNQVL++3pdz4+VEsjkFkXTSS45v9I4s5WM4hCqmRVIzs3KmnWzm8YMDya0N1koYYVrnjQ3ZOnpGi+TPryerHjpDeH1/FaEdfktqeCRW+/a1E6NPzoO38ShR+1cPaVPVyGqiIIDBotlJVyye8aFILzp+u5D88+Zdg0nCYF4XcaF918VL73H7hYMg7qZYggmYh9eMtlkErsZO7i7a4TAScdyCXd3tKuor+nSXS7TVQOt1Wlw96pv0Zghv+2MappwNbBpaw31lsw1WTK+IUR92wj4kpbrWovlsr8hhqs9+mC+bbAp7B1N8v/AMVfDdK5q/QEH13mYPX94vIPjBdtPAgymtYvcWlJ/UQZdOGhVYMClsbr2Th/ktY41FbFYqdIqQ2P6oYSiBzk3PstcYHv+FFAaP5zBhBmLOoVacmlR67oij3Cz/qlDv1tgSR6UL/4hFu0Xm24mn2rBfN1Sq1QrHvY4MYZSrWDMN1UksWxqnfSt2jXIx34ESRO6Wo/g71eojZJUNqb0lEn+g/MIvXWnDJnGBRMe1Es+p7g34UNKtotMvLd+/sdPLbx22vebiPkVWJ5TEHIPhs7LJ3feOF9fYyUWYFUXI5oP9Z/WL9Rk7zXnb8KVFxyUL1U5KWm8rT48OaH/umTEskEI1yzFR2nbJrUQiz8k6Ye74Pc7Cr55++V7n+VfvOfDH+bZ7fAdbdEOmb53gmCo1FpQ4RxxrtfUMq7zlkvBJV5Htl0PT06uB8TbZZqcbmPfmSrRFq5KhJg404pK6iqBjEq89ALYlHEJdG3q35CbqLXS99sxH4fZfUw47TDh6SYTXksXEHWlpefqBuV/ltL28tYvT6jOSycrXs0k3AO5/qRDbLvdE2kwqzW3i2R0cZfMe6ziPd8/urhaXqUJMVZR4KpSxmHMbJGMkuNWHMugvqXgE83ghLaRQ8NkTvHKDaOZVfz4dpAs0/URW03sndDGsimX0969o65WRJ7RRnhed0hdRQQq/nekkEDgZBsqTTgJQIEsJxt7mSa0v1+tgnifx12K4bVtEbOWbluLgcUQWCeqta6Jt8SptoepBk/bASIfAnJRnSaosy1O0xAeIy9N4KUVS2mFUi5WstpELWLQYuC8/eHpqXOLPx04//HJc+eanT5bXnW8lCTpeiIuyLpuTydJ10503y0ryKc61qyCOHNzC3euwvWbcPetRNs/UU5WwgY2JdZ0GG8Hm74wikyVTZFdBP/5Hz+5EXHjna74A7ytNVRqhnpS+0q9icA5J/OJgNc8LWSlQGPEAshqmlJ9O+R86hJ50SbJWMXGXHDSLgSmfICxpaBMH75Z+WqPtM9p3qIgpQRCKVcsbRWw2qrSrRFv0JnSN1RuTlXbMKb6WrIKDGIcgrJgrmw9HL2UjAQqDicrr9LcIDBeEjBZmziZ8Iy7q1lJq1lmoWSSTZEWS51PTlxoKuS1GlOWwihRe3OUanQRrSeRkj6mD6+o4NkR7gKraGlrc2+JGqpkzCkE64Q/FJ+PyYmoaHmeoVlVPwi8Re1UjXclaiGgUqTyORNkC7X3liaymklDN3UI6oatadgX7EW3Rs4WfaC0B91iZDWRAAgub3yp+EUjZt/g2HCLq3jEbDbbUHuPu2P+wm1Rj8kCU6txU9folGR7ePPxmHQK6tK8nZyhvuVZtC12rHnsgI/DRci86xsPFKv41tMkeIbSYOvaevGXd2/gFp70T5K0peg/AOHjN69ffv7l2ec0L11F/vwN+if9ExdEVcaWTLaWOkMxgTN/fa1lDZq7/PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5HertD08JTk8JTk8JTk8JdlfAn94SnJ4SnJ4SnJ4SnJ4SnJ4SvK/85Qk5FpJIx5XgnHZqhPxifmL1QOTqzQpKGc/ukju7ih4/TXVkVHz9zVqSvhfpckt05zCNy7dn8bkNuV1b5AyrC99NKp3TiunXhu5pM5alQPl5v2IF1mGlb0Xtl1W8O7t2XmSJrHwr1Q5jdFsRg9k2MznbwMfXSabuSpkweS0dmnmxM9J+XhW26KbzL9xyfzwo5WtZnLRwrCb5fdk0F8iauuAuztfKLBcNvC+a+eIwNgITTt3tVwu/w3MX5dA","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"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 \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztG11zG7fxr2zvxbHmSIm07Lh8qmOnrVsn9kTKZDKSRgHvljxYOOAC4EQyGs7koT+jfclPyy/pLD6Od/wQ7STTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cW71zBFiZpZNMDg66/egC2YBZRsLNDARCMauxAIBM/lFNQEGORh/j58q2rImAQmjAIuM1HnCMotxgRUGns5TrjEHGY8n6I1KcwKnhVgCz8najcec25BacB5xWQOdaUkMAMSMce8D+cFN1Bpdctzh2jEBucVao4yo8lKLpgGq9zcP//4zzMi8VtVa6L35x//BROhZsCl639boXQArKr6l/JSnvNqBF9XQrEcFqrW8O7VnxtCaVZquzg6eoXjegpfvz46uvqksLYyo+NjmkNVKAktwcamn6nyOCfAKp88JpJRI83qaWWGiwWwvMUUW6CETFULyJTSOZe0IylUbIog63KM2qRAnCmVRqKBgUaWL3pW9WqD8Lezt1/CROmS2T68E7VJm+VyrjGzYuGnJ9ojVY8MjJnBZ6dgrOZymkLJboit3ML3Nc9uiGyDMo9MffHutePV0dFZXVVKW8zhG0/C6OiIej5D4jHT6OAzVZZKQsU0K9GiNl66qFvj9zXXTi5sAUyIyIvRpezB0ZFdVDg6OoLXMueZE0+akFpJBD1s34MSkwj0rMKMT3gAbbEOlAxSRzyZMb+flWCZR1OjqTCz/Ba7E89TWNDEr1CqiEGhNP9BScuE245b1JZnTLS3jRB04m2ZtsTOSnFpY2tYoTk5tHtuU4JcEWo5Mavk0vUYhFsmajQBq1kKBWH1FVYaDZ3yOC8xUuZQIJ8WO9dj+fva2M7EUBtCs41FWCvukmMvOrZNmDAIfNLhZclusLVaowH68NkCcpywWtgUOEmc1TX24Utl6eQJnpGiIcl1Z5rZWmPP7XIQh4CIZKXb43crHZDzyQQ1HU7qdFOEMRE7kjOvNIg8d3JswSQoubbRmRJKb4qQa+7yETIlrdN8L24ZFw55T6xp1N9YsOwmhbGoMQWNuT+4CxRCzVIv7w6EFJznueMPqWWSQiUJf6nC8tyACVg1ijCeJ+pslC0twk2bq+HUThStTCyIRwywZFykjnEpvFdjsNwKTOnAVkwuUsiZxRQszu1YzVPICsxuxmoe+DVR0hr+w5ZTF3s+nmvDFE5TeJbC8xQGJykMhikMTlMYPEth8DyF4UkKw2EKw9MUhs88T4fPAz9Zw8Q2AoOh56R9WBwk/fmGG3dCSfGZRpfOOrp00Iejo+ZUUNt33313Ke8uJcBlQofkMhnBZdKAXCap7yPdR32D8D2njyfDT8Pngj6fDZ+Hz5kDHZyGz4I+h4NLuQwLXsqhw8SysroHC+r+TTEIX0FQqM0tSm1RL1EjKZQ0dtB+dPChjmWblidEC5fccibMbnIixAOiaIXSBlGnRJQTyd0Uue4HRE4bH+px6s53OfXY6oqH2mEx3KD+aT/cELuJ98s+GNpb6Pw60p8R6aR+zkn97Ka/0VAPiAnrOP06Tnzadxe50767+RAAHhAXuhj9Oh48Jx7QxbObAdT7gKhvoUMd4Rb3fSenvcHT3vBkeNrhAPk4HqAse3neWywWvwX3yK4Jy5NZEy1Nb6ExizDRqtziRjgrfwUV7B73O5reX5DBPY62KObRB22sksZza1vLVuVs8cj4qeLQxgAj+JX5tWih6boID+fFZoXiWUCeYKLZNSZHrU886BHf8+MvvjhucdI39sqyt9ZInz3H+FZjWfbzvL8GubE7vrGEPE9hs3lre55DWZY7mn37ZeJMqj+S6Adra7f0B4D/1AFYyXl34XsPB/n1Sgq3tnO2tp+OtSuk4DJ0BFGBNQCN01owjXPyGg1X0kP/9icnHpyVTe68TOegOR/eswI+eRvs7sdBqImE7gTUsn/cBmXtSTROce7myGpjVUnI8JzRDCmYOivIC2PRvCe+r+It7itjFSdvX6C1rhVt1t+GhN+1lqdMu7ruKBu0HWKYgThyi6/stt+J9+DEXW/BibjnfgsQD0jFr6FEnT7sQN0Xl0nJnAVAUoar38oWqC+Tq2aM944x3zP26gPOUcFzFGyMYrPrg89Am5YgTy3GUEfJZePRO3xP0lYnm691+r7llrPlKW4LdVTi8WhEFoPgJsY0uvxqjw5BHxeKowAryeUYIQ6AcSOGv1rMG8Q+TM69Fgibs2cJggMH2ATcGh/7/hU6G9NmDM1RcsnLumwih5Nm1siyMtzmbX7RyNqgjiu0d3djBTbfswKF6XYvcCkHLjLASza9x9Bz3Q9IDQR81uQ7SRNVUf6BK/k6T0ZJzE0kqZsUjf1M5YtkdJeEGBL9DBEaGnT83lBe4y4xWYElo18RGcqETLjAJE18psEkaeIcDkqLEKeSUaLG7zGzSUrXZkXBXDQ0hxs3uotQPj6epMH8TEaJD5wnaYJzVlYEHJoAZabIyKvySbKMC943VdOymsq4H02gnuahEPQvnOZLGrpcywT9opletWZwtJV4rl4q6rP4ii1Ma14v38l6AorG0PnNwijI2cJQ2K02XhVlTGS1IFMW5xXXi8audvZsw5IWvs1KDb6Dp8u46S2Mduy1Vh+/QRkqYoCLYXzs2PcKx4h/Cg2UK3L7y8qPxuK9Qhij29uqUPKjxw+GTwbDwZPBkGYIwcfWHExrtkjShFsszX4++t5NDLr7/4JsLczjLdRbxf1TcDG7/j5RjPCObDbF/TJ3visf1ApRm0LVIqfgLzLdd2mZX5zx64oxLeKo7e8R2mWazPcTM4dM9WKyCT4ROLFQVxUlUpWWqB+3PdUHQ9zw9HSZJov95C3+K8n7lDZvtp+6b1yWbpXB/D1wffJ8mSbFflz/2uQRf0dkT58tV5dokmlkFuMdcD1W+eI66q1lGzCaEV3QcCMsaUWRoyaLY1NfrVQNQVL++3pdz4+VEsjkFkXTSS45v9I4s5WM4hCqmRVIzs3KmnWzm8YMDya0N1koYYVrnjQ3ZOnpGi+TPryerHjpDeH1/FaEdfktqeCRW+/a1E6NPzoO38ShR+1cPaVPVyGqiIIDBotlJVyye8aFILzp+u5D88+Zdg0nCYF4XcaF918VL73H7hYMg7qZYggmYh9eMtlkErsZO7i7a4TAScdyCXd3tKuor+nSXS7TVQOt1Wlw96pv0Zghv+2MappwNbBpaw31lsw1WTK+IUR92wj4kpbrWovlsr8hhqs9+mC+bbAp7B1N8v/AMVfDdK5q/QEH13mYPX94vIPjBdtPAgymtYvcWlJ/UQZdOGhVYMClsbr2Th/ktY41FbFYqdIqQ2P6oYSiBzk3PstcYHv+FFAaP5zBhBmLOoVacmlR67oij3Cz/qlDv1tgSR6UL/4hFu0Xm24mn2rBfN1Sq1QrHvY4MYZSrWDMN1UksWxqnfSt2jXIx34ESRO6Wo/g71eojZJUNqb0lEn+g/MIvXWnDJnGBRMe1Es+p7g34UNKtotMvLd+/sdPLbx22vebiPkVWJ5TEHIPhs7LJ3feOF9fYyUWYFUXI5oP9Z/WL9Rk7zXnb8KVFxyUL1U5KWm8rT48OaH/umTEskEI1yzFR2nbJrUQiz8k6Ye74Pc7Cr55++V7n+VfvOfDH+bZ7fAdbdEOmb53gmCo1FpQ4RxxrtfUMq7zlkvBJV5Htl0PT06uB8TbZZqcbmPfmSrRFq5KhJg404pK6iqBjEq89ALYlHEJdG3q35CbqLXS99sxH4fZfUw47TDh6SYTXksXEHWlpefqBuV/ltL28tYvT6jOSycrXs0k3AO5/qRDbLvdE2kwqzW3i2R0cZfMe6ziPd8/urhaXqUJMVZR4KpSxmHMbJGMkuNWHMugvqXgE83ghLaRQ8NkTvHKDaOZVfz4dpAs0/URW03sndDGsimX0969o65WRJ7RRnhed0hdRQQq/nekkEDgZBsqTTgJQIEsJxt7mSa0v1+tgnifx12K4bVtEbOWbluLgcUQWCeqta6Jt8SptoepBk/bASIfAnJRnSaosy1O0xAeIy9N4KUVS2mFUi5WstpELWLQYuC8/eHpqXOLPx04//HJc+eanT5bXnW8lCTpeiIuyLpuTydJ10503y0ryKc61qyCOHNzC3euwvWbcPetRNs/UU5WwgY2JdZ0GG8Hm74wikyVTZFdBP/5Hz+5EXHjna74A7ytNVRqhnpS+0q9icA5J/OJgNc8LWSlQGPEAshqmlJ9O+R86hJ50SbJWMXGXHDSLgSmfICxpaBMH75Z+WqPtM9p3qIgpQRCKVcsbRWw2qrSrRFv0JnSN1RuTlXbMKb6WrIKDGIcgrJgrmw9HL2UjAQqDicrr9LcIDBeEjBZmziZ8Iy7q1lJq1lmoWSSTZEWS51PTlxoKuS1GlOWwihRe3OUanQRrSeRkj6mD6+o4NkR7gKraGlrc2+JGqpkzCkE64Q/FJ+PyYmoaHmeoVlVPwi8Re1UjXclaiGgUqTyORNkC7X3liaymklDN3UI6oatadgX7EW3Rs4WfaC0B91iZDWRAAgub3yp+EUjZt/g2HCLq3jEbDbbUHuPu2P+wm1Rj8kCU6txU9folGR7ePPxmHQK6tK8nZyhvuVZtC12rHnsgI/DRci86xsPFKv41tMkeIbSYOvaevGXd2/gFp70T5K0peg/AOHjN69ffv7l2ec0L11F/vwN+if9ExdEVcaWTLaWOkMxgTN/fa1lDZq7/PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5HertD08JTk8JTk8JTk8JdlfAn94SnJ4SnJ4SnJ4SnJ4SnJ4SvK/85Qk5FpJIx5XgnHZqhPxifmL1QOTqzQpKGc/ukju7ih4/TXVkVHz9zVqSvhfpckt05zCNy7dn8bkNuV1b5AyrC99NKp3TiunXhu5pM5alQPl5v2IF1mGlb0Xtl1W8O7t2XmSJrHwr1Q5jdFsRg9k2MznbwMfXSabuSpkweS0dmnmxM9J+XhW26KbzL9xyfzwo5WtZnLRwrCb5fdk0F8iauuAuztfKLBcNvC+a+eIwNgITTt3tVwu/w3MX5dA",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"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 \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," 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."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"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. \n",example:!0},email_subject:{type:"string",description:"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}}.",example:""},email_body:{type:"string",description:"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}}.",example:""},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.8c393c59.js b/assets/js/bbdfc22d.8c393c59.js deleted file mode 100644 index 20e386aef..000000000 --- a/assets/js/bbdfc22d.8c393c59.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3844],{60092:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>g});const s=JSON.parse('{"id":"API-docs/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/createtemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createtemplate","permalink":"/docs/API-docs/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyIzeuv4Ltl8m4WrKlcSazfjqTy9mdc5J4KuOp1Cnb5VDdkJpxN9kh2ZYVl972S/bT9ku2AJKtbl1sz+VknSq92GoSJAEQAAEQvEucmNnk5Dw5w6ouhUObXKZJjjYzsnZSq+QkOSsQYjd8Y1BQO7x++wZEWeq5hcaiseA0ZNSJkDXW6Ur+LiYlgosTpzAvZFaARXODICxMygZrI5WzMNUGZqjQCCfVDHKdNRVSx1y6AmqDOU6lwhysM03mGoN2CO9rrcA2WYbWTpuyXcmjIbVKwRXIiBp0jVEWBDRK/tYgHBxE6CuZHxyAK4SDTCiYIJGTEzUBIeygMxHUpxVPbGvM5FQScJhreKEu1JmsT+B9XWqRw0I3Bt5++9/tFDQvtZ0fHHyLk2YG798cHFx+UThX25PDQ1HXQ12jsnKmSjGxw0xXhzkB1vn0OXEQDdKsjCsKK8sFiDyHucxn6CxTrCDT9QIyrU0ulWd9LWYIqqkmaGwKQuVQaYMgFQgwKPLFwOlBYxH+593pj7QdlXBDeFs2Nm2Xy6XBzJULPz1xIFL1zHPm5THtj1SzFCpxTRspHfzWyOyayLaomK1hT5hXBwfvmrrWxmEOP3sSTg4OqOdrLPUchEGGz3RVaQW1MKJCx9JGG0bdBn9rpMHci4ooy8iLkws1oH1e1HhycABvVC4zYgZPSK2gpwF26EGJSQT6LmysB+2wjnbeCzHxZC78ftalyDyaBkkmnLzB/sS3KSxo4m9R6YhBoY38XSsnSt6OGzROZqLsbhshyILmhGG9qLVULraGFeD/wvbQ7vGmBLki1HJiViUV91iEG1E2aANW8xQKwuonrA1alu8wLzFS5VCgnBU71xP5r411vYmhsYRmF4uwVtwlZi8y26aitAhy2uNlJa6xsxpoNkKiHMLXC8hxKprSpSBJ4pxpcAg/ageirkuZsbUhQ0LKI8hGDHiXgzgERJSoeI/fGn0jcySTkMvpFA0pJ3XyFGFMxI7krOYBRB5rjiuEAq3WNjrTpTabIsTNfT5CppVD5Ybw+kbIkpH3xFqQKiubHGFSiuw6ZTuZgsHcK+4CyeqmXt4ZhIyp5znzByyWJIVaEf5Kh+WlXVmsIZwV0q70iTojq3kRabtcDVo71bQysSCqGGAlZJky41L4VU/ASVdiSgpbC7VIIRcOU3B46yb6NoWswOyafxmRSw2Txjky1LRmbnSd67kKvJxq5az8fYtGxp4P5+g4heMUXqbwKoXRUQqjcQqj4xRGL1MYvUphfJTCeJzC+DiF8UuP1vhV4LVoGdxFYDT2XHZ/Hu6S3f1eWtZsMpi2tcHzng0eDeHgoNUmavvll18u1N2FArhISLkukhO4SFqQiyT1fWQzqW8Uvm/p48X4q/C5oM+X41fhc86go+PwWdDneHShlmHBCzVmTJyo6nuwoO7PikH4CkJEbbwotUV7Ro1kiNLYQXvVw4c6ll1aXhAtUkknRWl3kxMhnhBFK5Q2iDomolhcd1PE3U+InC4+1MNm0nexWe10RYVnLMYb1H85DCfLbuL9sk+G9g46n0b6SyKdTNMZmabd9LfW6wkxYR2nT+PEV0N2ANgy7+ZDAHhCXOhj9Gk8eEU8oENpNwOo9wlR30GHOsIJ7/uOjgejLwfjo/FxjwMUG3mAqhrk+WCxWHwO7pHPE5Ynlyd6qN6zozB0anS1Jfzg6GAFFXwi/h1d9h/IUZ9EHxZzivv6EWyM+LpettO5WDyzfqo4tHXOCH7lmi06aHIX4cHRb1ZomQXkCSa6ZBMK8IbEgwHxPT/84YfDDid946CqBmuN9Dlgxncaq2qY58M1yI3d8Y0V5HkKm81b2/Mcqqra0ezbLxJ2qf465KQCe2K7pT8A/FEKsJLz/sL3KgflA7QqeW0O0rZrx9oRUkgVOoKowBqAwVlTCoO3FG1aqZWH/vyaExVn5a9zdMqBHcf+nhXwxWnwyZ8HoSYS+hNQy8PjNijrTmJwhrc8h0+LETIyD/kp22QFRW8iuv7E91Wehr8yUUvKEpToHLeiy4bbkPC71omwaVfXA2yLrkeMsBBHbomxeftZvEdHfLyFAOOe8y1APCETv4YSdfp0BXWfXySVYA+ApAxXv7Ur0Fwkl+0YH1Vj/sDYy0foUSFzLMUEy82uR+tAl5YgTx3GUEclVZsJYHyP0k6nuF3r9H3LLbrlKe4KdTTiUTUii6GUNuZC+vzqjg7JIk7hKfTJ1glCHACTVgw/WcxbxB4n594KhM15YAmCAwZsE3VxtQdW6G1MlzE0RyWVrJqqzThO21kjy6pwmnf5RSMpDR9X6O7uxgri9oEVQiJ8xwIXasSZgZhRuMfXCxBPyBisoXS/nn6MmeidkZ/pcHtYASNZXQXcciQSqD8MW+Wzu7VvCKd0AFGW0w+ivFWWYe0ox/Wpqtmi/OgjiLNA3czWbsnrQj0h6duC1v+zBAa4P0YKu+T9iSSxh/ajpdHn8SoxuyfY5e4nJH8Bn7XNTdJE13z3qtWbPDlJ/D1uvNVMUp4arfta54vk5C4JmXb6GfLYNPTwV0v3xXeJzQqsBP2KKNEN81SWNBUli9HYJE049ULXzcSv5CTRk18xc0lKAURN12FoaQ4ed3IXofwNY5KGQDw5SfzVY5ImeCuqmoBDE6DKNIW7PMUyrnjfXG3Lai7LP9o7XpqHbvE+choeuly7Yv+ombozLFd8XU0mjBGLZP02P17fxSjNj2vvJ8pF1BLpSBfaOyUGS9JEOqy6q+zYNaM/nNMZaqKE87IfOpa3RVQfvCaNqwutPmpguC7ZwvNHcsn3bi7c37LXFB1iHv3mweqGMwW+ZRg+JDERnqkVs+6a3gvcWPNs181358LNFropc7rKQmGGfAH90bUNXD4iyqzhCo72dOhR1qLaUjZapsntw8TcQqYH8Vodvihx6qCpazSQaaPQPO/m1p4McePj42WaLB4mb/GnJO8r2rz5w9T9zPUIq1qN/wSuL14t06R4GNe/txUT/0Fkj18uV2fd2ll+NdH54irareVDgPFQITiq33mjTk2OpsOIidYlCrXBiTdT715peEa+yLOQzOKLbmlsPFBgLssSDGZIRTOck462CoLT4W/BIVw+klf2HTWwt2ibiSUoFeezfsIJgjNyNkMqDAoQPDhc5aPgQjQqpiGsxJRu6bnYx+CN1I2N6BXC8m17ieSQugKlry+Ratb3Djvc4UqLLu3D7u5QCx1yiu7+T8/ePoKX7LsOwBVtHYGn0s8Bp2dvqXxIToMfNoT3tuVEZK3ogQD5RXAjRSwxaG37wqcXUDFHNBPbq/UahsKdAWwilEu7FaN0leBsawU3Jl7Vl9EW6cZRYZsMVRPWYW17fGQsWkae6eYxUvkAJwXMGr4fcaSysZaIk66r8h+pfBEiRz55Y2LFUxALgqSKxBWfIlcIqDN/CqisHy5gKqxDk1J5InHeNBTZtFPibY1GospwKwsMetZdNWar39TnQb+W5v1P34eqwkhDVMoJaaCfGHNoapYa1oS2xivu3DrpG44SaQeaq10O2qbrwZVYIatWo7FaAVVQmZlQ8ncvwuyRaIswwUKUHjSYCrpdInxIw/vIRFv7r3/8s4PXTo9zEzG/gshzSvU/gCFHtl7gyeM2WJMF1H2MaD40/7V+CBB2rDRXlc5bRbKPl/G3VPjnbGsXneZCUSzRl7LGq4fW3to02lgb3Eq6gTB8U8Alr7omevFWWtepUop3iZv24SckPmYdHNgNIa0mmVeLroK3eIVqqNV0XEsl+xVu7TG4pgv3H2f+vFvFpMEUU9WmVtZ75OOjI/q3tvG9ymJSzLbquFz8JUkfHxDfHw74ZgrBN0VxJTFfF+O/21pVWUFCUqG1fY9+y5AHCOjyTapSKryKTLkaHx1dfUmcW6bJ8TbmvNMVuoIlgmzB3GgqAK5LFFSQahYgZkIqoOXNZ+QVGqPN/VR/GGb3MeH46Ohq1DLhy00mvFF8DcPF5mf6GtUfS2l3eeeXJ1RvK7Zq3uwm0gNxf9IjttvuibSYNUa6RXJyfpfcDkQtB77/5PxyeUlS5wpNqaJaW8ZYuCI5SQ43Mkdc7U9pifO7hI+nJLq+Vqic7ko23F9Ry8ObUbJM10dsdZZ3QlsnZlLNBveOulyR+o62w3O8R/Aqtq/l/yIF94GfXag0kSQGBQpyj4mDtMs/rdJm38W9igmtrTmq1aasZ51i0qmXR1o3/VsyQ53E0HnMynCipc2zJCuKkjYXQj/b7Mb5SvTaRELMI4w4AB8fH3Ok+tWIQ7oXrzhaOn65vPQc7kQOnJnsur8+4d3z40JT369JkjU/oneYr5/lO8/VHcdq9KWkmmre87APpzWqd+SqkmrdjDajUywzXbVFvBH8X//4J4+Ixxgv8xc4bQzUeo6G3qtQVe60xFtJzmHnOQ0l3zg7LaoSraWMnHI4809R5IyLAaLHlYlaTGQpyVYQmPZFNx1zY4fwc4F0R0Bdz4yvi7jBkkwMlFrzQw3yDhqnq+5zF5hrcz0llFIQMKHafvJ5LGIcgqoQKqOMvVch9hfoYQr5sLWRFkHIioDJl8bpVGaSJibDaETmoBJKzPjgTzlKJi7UsTLf6AmFIlaXjXe26X0AovMk8o3BEL6l4IYJp8YcHW177v1sm/o4J9jJ8PBlQjFlTcvLDO2qgqrEGzRsMnyU2pQl1Nr5yJE8n+7e0kTOCGUpDvcIxa1p2Re8YV4jF4sh0LUBnUnkE5IAlFJd+2cq562Y/YwTKx2uMgTz+XzDfD3vj/mbdEUzIf9Sr8bNuJGNXXd4+/GcjA2ayp5O36G5kRkG27ljzUMGPgzHmsj4WIvKJmq51YMtZYbKYucQev23t9/DDbwYHiVpx2A/AuHD7998892P776jeelI8fo3Gh4Njzitqa2rhOos9Y1/jXa2MqFrSff2fN4/cds/cds/cds/cds/cds/cds/cds/cds/cds/cdsgav/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/E7amY+P0Tt/0Tt/0Tt/0Tt/0Ttyf1sGj/xO2PkMD9E7f9E7dHPHELJSzkFR7WpZBcAxUqZn350vn6w7fLNCmovunkPLm7o+u/96ZcLqn5twYNFUddpsmNMJKS3FwalcYSICqaucYFXUP7nP3gjNZPvbjzlflaRRhVMPkRr3nb74XtlmC9PX13lqTJJDzOq3ROY4yY08M9MfeVM4Gb/DRL8KuLUqhZwzU8iZ+TqpZE44p+ydM1lzyFH51SIKEWHQz7tVCeDPpLRG0dcHfny6mWyxbed+0cERgboWn/LpfL5b8BijPEcw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/get-template"}}');var i=t(74848),o=t(28453),r=t(33617),a=t.n(r),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyIzeuv4Ltl8m4WrKlcSazfjqTy9mdc5J4KuOp1Cnb5VDdkJpxN9kh2ZYVl972S/bT9ku2AJKtbl1sz+VknSq92GoSJAEQAAEQvEucmNnk5Dw5w6ouhUObXKZJjjYzsnZSq+QkOSsQYjd8Y1BQO7x++wZEWeq5hcaiseA0ZNSJkDXW6Ur+LiYlgosTpzAvZFaARXODICxMygZrI5WzMNUGZqjQCCfVDHKdNRVSx1y6AmqDOU6lwhysM03mGoN2CO9rrcA2WYbWTpuyXcmjIbVKwRXIiBp0jVEWBDRK/tYgHBxE6CuZHxyAK4SDTCiYIJGTEzUBIeygMxHUpxVPbGvM5FQScJhreKEu1JmsT+B9XWqRw0I3Bt5++9/tFDQvtZ0fHHyLk2YG798cHFx+UThX25PDQ1HXQ12jsnKmSjGxw0xXhzkB1vn0OXEQDdKsjCsKK8sFiDyHucxn6CxTrCDT9QIyrU0ulWd9LWYIqqkmaGwKQuVQaYMgFQgwKPLFwOlBYxH+593pj7QdlXBDeFs2Nm2Xy6XBzJULPz1xIFL1zHPm5THtj1SzFCpxTRspHfzWyOyayLaomK1hT5hXBwfvmrrWxmEOP3sSTg4OqOdrLPUchEGGz3RVaQW1MKJCx9JGG0bdBn9rpMHci4ooy8iLkws1oH1e1HhycABvVC4zYgZPSK2gpwF26EGJSQT6LmysB+2wjnbeCzHxZC78ftalyDyaBkkmnLzB/sS3KSxo4m9R6YhBoY38XSsnSt6OGzROZqLsbhshyILmhGG9qLVULraGFeD/wvbQ7vGmBLki1HJiViUV91iEG1E2aANW8xQKwuonrA1alu8wLzFS5VCgnBU71xP5r411vYmhsYRmF4uwVtwlZi8y26aitAhy2uNlJa6xsxpoNkKiHMLXC8hxKprSpSBJ4pxpcAg/ageirkuZsbUhQ0LKI8hGDHiXgzgERJSoeI/fGn0jcySTkMvpFA0pJ3XyFGFMxI7krOYBRB5rjiuEAq3WNjrTpTabIsTNfT5CppVD5Ybw+kbIkpH3xFqQKiubHGFSiuw6ZTuZgsHcK+4CyeqmXt4ZhIyp5znzByyWJIVaEf5Kh+WlXVmsIZwV0q70iTojq3kRabtcDVo71bQysSCqGGAlZJky41L4VU/ASVdiSgpbC7VIIRcOU3B46yb6NoWswOyafxmRSw2Txjky1LRmbnSd67kKvJxq5az8fYtGxp4P5+g4heMUXqbwKoXRUQqjcQqj4xRGL1MYvUphfJTCeJzC+DiF8UuP1vhV4LVoGdxFYDT2XHZ/Hu6S3f1eWtZsMpi2tcHzng0eDeHgoNUmavvll18u1N2FArhISLkukhO4SFqQiyT1fWQzqW8Uvm/p48X4q/C5oM+X41fhc86go+PwWdDneHShlmHBCzVmTJyo6nuwoO7PikH4CkJEbbwotUV7Ro1kiNLYQXvVw4c6ll1aXhAtUkknRWl3kxMhnhBFK5Q2iDomolhcd1PE3U+InC4+1MNm0nexWe10RYVnLMYb1H85DCfLbuL9sk+G9g46n0b6SyKdTNMZmabd9LfW6wkxYR2nT+PEV0N2ANgy7+ZDAHhCXOhj9Gk8eEU8oENpNwOo9wlR30GHOsIJ7/uOjgejLwfjo/FxjwMUG3mAqhrk+WCxWHwO7pHPE5Ynlyd6qN6zozB0anS1Jfzg6GAFFXwi/h1d9h/IUZ9EHxZzivv6EWyM+LpettO5WDyzfqo4tHXOCH7lmi06aHIX4cHRb1ZomQXkCSa6ZBMK8IbEgwHxPT/84YfDDid946CqBmuN9Dlgxncaq2qY58M1yI3d8Y0V5HkKm81b2/Mcqqra0ezbLxJ2qf465KQCe2K7pT8A/FEKsJLz/sL3KgflA7QqeW0O0rZrx9oRUkgVOoKowBqAwVlTCoO3FG1aqZWH/vyaExVn5a9zdMqBHcf+nhXwxWnwyZ8HoSYS+hNQy8PjNijrTmJwhrc8h0+LETIyD/kp22QFRW8iuv7E91Wehr8yUUvKEpToHLeiy4bbkPC71omwaVfXA2yLrkeMsBBHbomxeftZvEdHfLyFAOOe8y1APCETv4YSdfp0BXWfXySVYA+ApAxXv7Ur0Fwkl+0YH1Vj/sDYy0foUSFzLMUEy82uR+tAl5YgTx3GUEclVZsJYHyP0k6nuF3r9H3LLbrlKe4KdTTiUTUii6GUNuZC+vzqjg7JIk7hKfTJ1glCHACTVgw/WcxbxB4n594KhM15YAmCAwZsE3VxtQdW6G1MlzE0RyWVrJqqzThO21kjy6pwmnf5RSMpDR9X6O7uxgri9oEVQiJ8xwIXasSZgZhRuMfXCxBPyBisoXS/nn6MmeidkZ/pcHtYASNZXQXcciQSqD8MW+Wzu7VvCKd0AFGW0w+ivFWWYe0ox/Wpqtmi/OgjiLNA3czWbsnrQj0h6duC1v+zBAa4P0YKu+T9iSSxh/ajpdHn8SoxuyfY5e4nJH8Bn7XNTdJE13z3qtWbPDlJ/D1uvNVMUp4arfta54vk5C4JmXb6GfLYNPTwV0v3xXeJzQqsBP2KKNEN81SWNBUli9HYJE049ULXzcSv5CTRk18xc0lKAURN12FoaQ4ed3IXofwNY5KGQDw5SfzVY5ImeCuqmoBDE6DKNIW7PMUyrnjfXG3Lai7LP9o7XpqHbvE+choeuly7Yv+ombozLFd8XU0mjBGLZP02P17fxSjNj2vvJ8pF1BLpSBfaOyUGS9JEOqy6q+zYNaM/nNMZaqKE87IfOpa3RVQfvCaNqwutPmpguC7ZwvNHcsn3bi7c37LXFB1iHv3mweqGMwW+ZRg+JDERnqkVs+6a3gvcWPNs181358LNFropc7rKQmGGfAH90bUNXD4iyqzhCo72dOhR1qLaUjZapsntw8TcQqYH8Vodvihx6qCpazSQaaPQPO/m1p4McePj42WaLB4mb/GnJO8r2rz5w9T9zPUIq1qN/wSuL14t06R4GNe/txUT/0Fkj18uV2fd2ll+NdH54irareVDgPFQITiq33mjTk2OpsOIidYlCrXBiTdT715peEa+yLOQzOKLbmlsPFBgLssSDGZIRTOck462CoLT4W/BIVw+klf2HTWwt2ibiSUoFeezfsIJgjNyNkMqDAoQPDhc5aPgQjQqpiGsxJRu6bnYx+CN1I2N6BXC8m17ieSQugKlry+Ratb3Djvc4UqLLu3D7u5QCx1yiu7+T8/ePoKX7LsOwBVtHYGn0s8Bp2dvqXxIToMfNoT3tuVEZK3ogQD5RXAjRSwxaG37wqcXUDFHNBPbq/UahsKdAWwilEu7FaN0leBsawU3Jl7Vl9EW6cZRYZsMVRPWYW17fGQsWkae6eYxUvkAJwXMGr4fcaSysZaIk66r8h+pfBEiRz55Y2LFUxALgqSKxBWfIlcIqDN/CqisHy5gKqxDk1J5InHeNBTZtFPibY1GospwKwsMetZdNWar39TnQb+W5v1P34eqwkhDVMoJaaCfGHNoapYa1oS2xivu3DrpG44SaQeaq10O2qbrwZVYIatWo7FaAVVQmZlQ8ncvwuyRaIswwUKUHjSYCrpdInxIw/vIRFv7r3/8s4PXTo9zEzG/gshzSvU/gCFHtl7gyeM2WJMF1H2MaD40/7V+CBB2rDRXlc5bRbKPl/G3VPjnbGsXneZCUSzRl7LGq4fW3to02lgb3Eq6gTB8U8Alr7omevFWWtepUop3iZv24SckPmYdHNgNIa0mmVeLroK3eIVqqNV0XEsl+xVu7TG4pgv3H2f+vFvFpMEUU9WmVtZ75OOjI/q3tvG9ymJSzLbquFz8JUkfHxDfHw74ZgrBN0VxJTFfF+O/21pVWUFCUqG1fY9+y5AHCOjyTapSKryKTLkaHx1dfUmcW6bJ8TbmvNMVuoIlgmzB3GgqAK5LFFSQahYgZkIqoOXNZ+QVGqPN/VR/GGb3MeH46Ohq1DLhy00mvFF8DcPF5mf6GtUfS2l3eeeXJ1RvK7Zq3uwm0gNxf9IjttvuibSYNUa6RXJyfpfcDkQtB77/5PxyeUlS5wpNqaJaW8ZYuCI5SQ43Mkdc7U9pifO7hI+nJLq+Vqic7ko23F9Ry8ObUbJM10dsdZZ3QlsnZlLNBveOulyR+o62w3O8R/Aqtq/l/yIF94GfXag0kSQGBQpyj4mDtMs/rdJm38W9igmtrTmq1aasZ51i0qmXR1o3/VsyQ53E0HnMynCipc2zJCuKkjYXQj/b7Mb5SvTaRELMI4w4AB8fH3Ok+tWIQ7oXrzhaOn65vPQc7kQOnJnsur8+4d3z40JT369JkjU/oneYr5/lO8/VHcdq9KWkmmre87APpzWqd+SqkmrdjDajUywzXbVFvBH8X//4J4+Ixxgv8xc4bQzUeo6G3qtQVe60xFtJzmHnOQ0l3zg7LaoSraWMnHI4809R5IyLAaLHlYlaTGQpyVYQmPZFNx1zY4fwc4F0R0Bdz4yvi7jBkkwMlFrzQw3yDhqnq+5zF5hrcz0llFIQMKHafvJ5LGIcgqoQKqOMvVch9hfoYQr5sLWRFkHIioDJl8bpVGaSJibDaETmoBJKzPjgTzlKJi7UsTLf6AmFIlaXjXe26X0AovMk8o3BEL6l4IYJp8YcHW177v1sm/o4J9jJ8PBlQjFlTcvLDO2qgqrEGzRsMnyU2pQl1Nr5yJE8n+7e0kTOCGUpDvcIxa1p2Re8YV4jF4sh0LUBnUnkE5IAlFJd+2cq562Y/YwTKx2uMgTz+XzDfD3vj/mbdEUzIf9Sr8bNuJGNXXd4+/GcjA2ayp5O36G5kRkG27ljzUMGPgzHmsj4WIvKJmq51YMtZYbKYucQev23t9/DDbwYHiVpx2A/AuHD7998892P776jeelI8fo3Gh4Njzitqa2rhOos9Y1/jXa2MqFrSff2fN4/cds/cds/cds/cds/cds/cds/cds/cds/cds/cdsgav/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/E7amY+P0Tt/0Tt/0Tt/0Tt/0Ttyf1sGj/xO2PkMD9E7f9E7dHPHELJSzkFR7WpZBcAxUqZn350vn6w7fLNCmovunkPLm7o+u/96ZcLqn5twYNFUddpsmNMJKS3FwalcYSICqaucYFXUP7nP3gjNZPvbjzlflaRRhVMPkRr3nb74XtlmC9PX13lqTJJDzOq3ROY4yY08M9MfeVM4Gb/DRL8KuLUqhZwzU8iZ+TqpZE44p+ydM1lzyFH51SIKEWHQz7tVCeDPpLRG0dcHfny6mWyxbed+0cERgboWn/LpfL5b8BijPEcw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,f={},g=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," 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, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," 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, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.b0216893.js b/assets/js/bbdfc22d.b0216893.js new file mode 100644 index 000000000..1ca69aef8 --- /dev/null +++ b/assets/js/bbdfc22d.b0216893.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3844],{60092:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>g,default:()=>b,frontMatter:()=>y,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/createtemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createtemplate","permalink":"/docs/API-docs/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyIzeuv4Ltl8m4WrKlcSZz/LSTy9md3Ww8lfFUast2OVQ3pGbcTXZItmXFpbf9kv20/ZJTAMlWty6253KyTpVebDUJkgAIgAAI3iVOzGxycp6cYVWXwqFNLtMkR5sZWTupVXKSnBUIsRu+MSioHV6/fQOiLPXcQmPRWHAaMupEyBrrdCV/E5MSwcWJU5gXMivAorlBEBYmZYO1kcpZmGoDM1RohJNqBrnOmgqpYy5dAbXBHKdSYQ7WmSZzjUE7hPe1VmCbLENrp03ZruTRkFql4ApkRA26xigLAholf20QDg4i9JXMDw7AFcJBJhRMkMjJiZqAEHbQmQjq04ontjVmcioJOMw1vFAX6kzWJ/C+LrXIYaEbA2+//d92CpqX2s4PDr7FSTOD928ODi6/KJyr7cnhoajroa5RWTlTpZjYYaarw5wA63z6nDiIBmlWxhWFleUCRJ7DXOYzdJYpVpDpegGZ1iaXyrO+FjME1VQTNDYFoXKotEGQCgQYFPli4PSgsQh/e3f6A21HJdwQ3paNTdvlcmkwc+XCT08ciFQ985x5eUz7I9UshUpc00ZKB782Mrsmsi0qZmvYE+bVwcG7pq61cZjDT56Ek4MD6vkaSz0HYZDhM11VWkEtjKjQsbTRhlG3wV8baTD3oiLKMvLi5EINaJ8XNZ4cHMAblcuMmMETUivoaYAdelBiEoG+CxvrQTuso533Qkw8mQu/n3UpMo+mQZIJJ2+wP/FtCgua+FtUOmJQaCN/08qJkrfjBo2TmSi720YIsqA5YVgvai2Vi61hBfhn2B7aPd6UIFeEWk7MqqTiHotwI8oGbcBqnkJBWP2ItUHL8h3mJUaqHAqUs2LneiL/pbGuNzE0ltDsYhHWirvE7EVm21SUFkFOe7ysxDV2VgPNRkiUQ/h6ATlORVO6FCRJnDMNDuEH7UDUdSkztjZkSEh5BNmIAe9yEIeAiBIV7/Fbo29kjmQScjmdoiHlpE6eIoyJ2JGc1TyAyGPNcYVQoNXaRme61GZThLi5z0fItHKo3BBe3whZMvKeWAtSZWWTI0xKkV2nbCdTMJh7xV0gWd3UyzuDkDH1PGf+gMWSpFArwl/psLy0K4s1hLNC2pU+UWdkNS8ibZerQWunmlYmFkQVA6yELFNmXAq/6Ak46UpMSWFroRYp5MJhCg5v3UTfppAVmF3zLyNyqWHSOEeGmtbMja5zPVeBl1OtnJW/bdHI2PPhHB2ncJzCyxRepTA6SmE0TmF0nMLoZQqjVymMj1IYj1MYH6cwfunRGr8KvBYtg7sIjMaey+6Pw12yu99Ly5pNBtO2Nnjes8GjIRwctNpEbT///POFurtQABcJKddFcgIXSQtykaS+j2wm9Y3C9y19vBh/FT4X9Ply/Cp8zhl0dBw+C/ocjy7UMix4ocaMiRNVfQ8W1P1ZMQhfQYiojReltmjPqJEMURo7aK96+FDHskvLC6JFKumkKO1uciLEE6JohdIGUcdEFIvrboq4+wmR08WHethM+i42q52uqPCMxXiD+i+H4WTZTbxf9snQ3kHn00h/SaSTaToj07Sb/tZ6PSEmrOP0aZz4asgOAFvm3XwIAE+IC32MPo0Hr4gHdCjtZgD1PiHqO+hQRzjhfd/R8WD05WB8ND7ucYBiIw9QVYM8HywWi8/BPfJ5wvLk8kQP1Xt2FIZOja62hB8cHayggk/Ev6PL/g9y1CfRh8Wc4r5+BBsjvq6X7XQuFs+snyoObZ0zgl+5ZosOmtxFeHD0mxVaZgF5goku2YQCvCHxYMCcPMzzww4nqTHPB1U1WGukzwEzvtNYVcM8H65BbuyOb6wgz1PYbN7anudQVdWOZt9+kbBL9T9DTiqwJ7Zb+gPA76UAKznvL3yvclA+QKuS1+Ygbbt2rB0hhVShI4gKrAEYnDWlMHhL0aaVWnnoz685UXFW/jpHpxzYcezvWQFfnAaf/HkQaiKhPwG1PDxug7LuJAZneMtz+LQYISPzkJ+yTVZQ9Cai6098X+Vp+CsTtaQsQYnOcSu6bLgNCb9rnQibdnU9wLboesQIC3Hklhibt5/Fe3TEx1sIMO453wLEEzLxayhRp09XUPf5RVIJ9gBIynD1W7sCzUVy2Y7xUTXmD4y9fIQeFTLHUkyw3Ox6tA50aQny1GEMdVRStZkAxvco7XSK27VO37fcolue4q5QRyMeVSOyGEppYy6kz6/u6JAs4hSeQp9snSDEATBpxfCTxbxF7HFy7q1A2JwHliA4YMA2URdXe2CF3sZ0GUNzVFLJqqnajOO0nTWyrAqneZdfNJLS8HGF7u5urCBuH1ghJMJ3LHChRpwZiBmFe3y9APGEjMEaSvfr6ceYid4Z+ZkOt4cVMJLVVcAtRyKB+sOwVT67W/uGcEoHEGU5/SDKW2UZ1o5yXJ+qmi3Kjz6COAvUzWztlrwu1BOSvi1o/T9LYID7faSwS94fSBJ7aD9aGn0erxKze4Jd7n5C8hfwWdvcJE10zXevWr3Jk5PE3+PGW80k5anRuq91vkhO7pKQaaefIY9NQw9/sXRffJfYrMBK0K+IEt0wT2VJU1GyGI1N0oRTL3TdTPxKThI9+QUzl6QUQNR0HYaW5uBxJ3cRyt8wJmkIxJOTxF89JmmCt6KqCTg0AapMU7jLUyzjivfN1bas5rL8o73jpXnoFu8jp+Ghy7Ur9o+aqTvDcsXX1WTCGLFI1m/z4/VdjNL8uPZ+olxELZGOdKG9U2KwJE2kw6q7yo5dM/rDOZ2hJko4L/uhY3lbRPXBa9K4utDqowaG65ItPH8kl3zv5sL9LXtN0SHm0W8erG44U+BbhuFDEhPhmVox667pvcCNNc923Xx3LtxsoZsyp6ssFGbIF9AfXdvA5SOizBqu4GhPhx5lLaotZaNlmtw+TMwtZHoQr9XhixKnDpq6RgOZNgrN825u7ckQNz4+XqbJ4mHyFn9I8r6izZs/TN1PXI+wqtX4b+D64tUyTYqHcf1rWzHxX0T2+OVyddatneVXE50vrqLdWj4EGA8VgqP6nTfq1ORoOoyYaF2iUBuceDP17pWGZ+SLPAvJLL7olsbGAwXmsizBYIZUNMM56WirIDgd/hYcwuUjeWXfUQN7i7aZWIJScT7rJ5wgOCNnM6TCoADBg8NVPgouRKNiGsJKTOmWnot9DN5I3diIXiEs37aXSA6pK1D6+hKpZn3vsMMdrrTo0j7s7g610CGn6O7/9OztI3jJvusAXNHWEXgq/RxwevaWyofkNPhhQ3hvW05E1ooeCJBfBDdSxBKD1rYvfHoBFXNEM7G9Wq9hKNwZwCZCubRbMUpXCc62VnBj4lV9GW2RbhwVtslQNWEd1rbHR8aiZeSZbh4jlQ9wUsCs4fsRRyoba4k46boq/5HKFyFy5JM3JlY8BbEgSKpIXPEpcoWAOvOngMr64QKmwjo0KZUnEudNQ5FNOyXe1mgkqgy3ssCgZ91VY7b6TX0e9Gtp3v/4fagqjDREpZyQBvqJMYemZqlhTWhrvOLOrZO+4SiRdqC52uWgbboeXIkVsmo1GqsVUAWVmQklf/MizB6JtggTLETpQYOpoNslwoc0vI9MtLX/+de/O3jt9Dg3EfMriDynVP8DGHJk6wWePG6DNVlA3ceI5kPz5/VDgLBjpbmqdN4qkn28jL+lwj9nW7voNBeKYom+lDVePbT21qbRxtrgVtINhOGbAi551TXRi7fSuk6VUrxL3LQPPyLxMevgwG4IaTXJvFp0FbzFK1RDrabjWirZr3Brj8E1Xbj/OPPn3SomDaaYqja1st4jHx8d0b+1je9VFpNitlXH5eJPSfr4gPj+cMA3Uwi+KYorifm6GP/V1qrKChKSCq3te/RbhjxAQJdvUpVS4VVkytX46OjqS+LcMk2OtzHnna7QFSwRZAvmRlMBcF2ioIJUswAxE1IBLW8+I6/QGG3up/rDMLuPCcdHR1ejlglfbjLhjeJrGC42P9PXqH5fSrvLO788oXpbsVXzZjeRHoj7kx6x3XZPpMWsMdItkpPzu+R2IGo58P0n55fLS5I6V2hKFdXaMsbCFclJcriROeJqf0pLnN8lfDwl0fW1QuV0V7Lh/opaHt6MkmW6PmKrs7wT2joxk2o2uHfU5YrUd7QdnuM9glexfS3/jhTcB352odJEkhgUKMg9Jg7SLv+4Spt9F/cqJrS25qhWm7KedYpJp14ead30b8kMdRJD5zErw4mWNs+SrChK2lwI/WyzG+cr0WsTCTGPMOIAfHx8zJHqVyMO6V684mjp+OXy0nO4EzlwZrLr/vqEd8+PC019vyZJ1vyI3mG+fpbvPFd3HKvRl5JqqnnPwz6c1qjekatKqnUz2oxOscx01RbxRvD//OvfPCIeY7zMn+C0MVDrORp6r0JVudMSbyU5h53nNJR84+y0qEq0ljJyyuHMP0WRMy4GiB5XJmoxkaUkW0Fg2hfddMyNHcJPBdIdAXU9M74u4gZLMjFQas0PNcg7aJyuus9dYK7N9ZRQSkHAhGr7yeexiHEIqkKojDL2XoXYX6CHKeTD1kZaBCErAiZfGqdTmUmamAyjEZmDSigx44M/5SiZuFDHynyjJxSKWF023tmm9wGIzpPINwZD+JaCGyacGnN0tO2597Nt6uOcYCfDw5cJxZQ1LS8ztKsKqhJv0LDJ8FFqU5ZQa+cjR/J8untLEzkjlKU43CMUt6ZlX/CGeY1cLIZA1wZ0JpFPSAJQSnXtn6mct2L2E06sdLjKEMzn8w3z9bw/5i/SFc2E/Eu9GjfjRjZ23eHtx3MyNmgqezp9h+ZGZhhs5441Dxn4MBxrIuNjLSqbqOVWD7aUGSqLnUPo9V/efg838GJ4lKQdg/0IhA+/f/PNdz+8+47mpSPF699oeDQ84rSmtq4SqrPUN/412tnKhK4l3dvzef/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/EbYOo/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3p2Li90/c9k/c9k/c9k/c9k/cntTDov0Tt99DAvdP3PZP3B7xxC2UsJBXeFiXQnINVKiY9eVL5+sP3y7TpKD6ppPz5O6Orv/em3K5pOZfGzRUHHWZJjfCSEpyc2lUGkuAqGjmGhd0De1z9oMzWj/14s5X5msVYVTB5Ee85m2/F7ZbgvX29N1ZkiaT8Div0jmNMWJOD/fE3FfOBG7y0yzBry5KoWYN1/Akfk6qWhKNK/olT9dc8hR+dEqBhFp0MOzXQnky6C8RtXXA3Z0vp1ouW3jftXNEYGyEpv27XC6X/wfuWsTz","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/get-template"}}');var s=t(74848),r=t(28453),o=t(33617),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const y={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyIzeuv4Ltl8m4WrKlcSZz/LSTy9md3Ww8lfFUast2OVQ3pGbcTXZItmXFpbf9kv20/ZJTAMlWty6253KyTpVebDUJkgAIgAAI3iVOzGxycp6cYVWXwqFNLtMkR5sZWTupVXKSnBUIsRu+MSioHV6/fQOiLPXcQmPRWHAaMupEyBrrdCV/E5MSwcWJU5gXMivAorlBEBYmZYO1kcpZmGoDM1RohJNqBrnOmgqpYy5dAbXBHKdSYQ7WmSZzjUE7hPe1VmCbLENrp03ZruTRkFql4ApkRA26xigLAholf20QDg4i9JXMDw7AFcJBJhRMkMjJiZqAEHbQmQjq04ontjVmcioJOMw1vFAX6kzWJ/C+LrXIYaEbA2+//d92CpqX2s4PDr7FSTOD928ODi6/KJyr7cnhoajroa5RWTlTpZjYYaarw5wA63z6nDiIBmlWxhWFleUCRJ7DXOYzdJYpVpDpegGZ1iaXyrO+FjME1VQTNDYFoXKotEGQCgQYFPli4PSgsQh/e3f6A21HJdwQ3paNTdvlcmkwc+XCT08ciFQ985x5eUz7I9UshUpc00ZKB782Mrsmsi0qZmvYE+bVwcG7pq61cZjDT56Ek4MD6vkaSz0HYZDhM11VWkEtjKjQsbTRhlG3wV8baTD3oiLKMvLi5EINaJ8XNZ4cHMAblcuMmMETUivoaYAdelBiEoG+CxvrQTuso533Qkw8mQu/n3UpMo+mQZIJJ2+wP/FtCgua+FtUOmJQaCN/08qJkrfjBo2TmSi720YIsqA5YVgvai2Vi61hBfhn2B7aPd6UIFeEWk7MqqTiHotwI8oGbcBqnkJBWP2ItUHL8h3mJUaqHAqUs2LneiL/pbGuNzE0ltDsYhHWirvE7EVm21SUFkFOe7ysxDV2VgPNRkiUQ/h6ATlORVO6FCRJnDMNDuEH7UDUdSkztjZkSEh5BNmIAe9yEIeAiBIV7/Fbo29kjmQScjmdoiHlpE6eIoyJ2JGc1TyAyGPNcYVQoNXaRme61GZThLi5z0fItHKo3BBe3whZMvKeWAtSZWWTI0xKkV2nbCdTMJh7xV0gWd3UyzuDkDH1PGf+gMWSpFArwl/psLy0K4s1hLNC2pU+UWdkNS8ibZerQWunmlYmFkQVA6yELFNmXAq/6Ak46UpMSWFroRYp5MJhCg5v3UTfppAVmF3zLyNyqWHSOEeGmtbMja5zPVeBl1OtnJW/bdHI2PPhHB2ncJzCyxRepTA6SmE0TmF0nMLoZQqjVymMj1IYj1MYH6cwfunRGr8KvBYtg7sIjMaey+6Pw12yu99Ly5pNBtO2Nnjes8GjIRwctNpEbT///POFurtQABcJKddFcgIXSQtykaS+j2wm9Y3C9y19vBh/FT4X9Ply/Cp8zhl0dBw+C/ocjy7UMix4ocaMiRNVfQ8W1P1ZMQhfQYiojReltmjPqJEMURo7aK96+FDHskvLC6JFKumkKO1uciLEE6JohdIGUcdEFIvrboq4+wmR08WHethM+i42q52uqPCMxXiD+i+H4WTZTbxf9snQ3kHn00h/SaSTaToj07Sb/tZ6PSEmrOP0aZz4asgOAFvm3XwIAE+IC32MPo0Hr4gHdCjtZgD1PiHqO+hQRzjhfd/R8WD05WB8ND7ucYBiIw9QVYM8HywWi8/BPfJ5wvLk8kQP1Xt2FIZOja62hB8cHayggk/Ev6PL/g9y1CfRh8Wc4r5+BBsjvq6X7XQuFs+snyoObZ0zgl+5ZosOmtxFeHD0mxVaZgF5goku2YQCvCHxYMCcPMzzww4nqTHPB1U1WGukzwEzvtNYVcM8H65BbuyOb6wgz1PYbN7anudQVdWOZt9+kbBL9T9DTiqwJ7Zb+gPA76UAKznvL3yvclA+QKuS1+Ygbbt2rB0hhVShI4gKrAEYnDWlMHhL0aaVWnnoz685UXFW/jpHpxzYcezvWQFfnAaf/HkQaiKhPwG1PDxug7LuJAZneMtz+LQYISPzkJ+yTVZQ9Cai6098X+Vp+CsTtaQsQYnOcSu6bLgNCb9rnQibdnU9wLboesQIC3Hklhibt5/Fe3TEx1sIMO453wLEEzLxayhRp09XUPf5RVIJ9gBIynD1W7sCzUVy2Y7xUTXmD4y9fIQeFTLHUkyw3Ox6tA50aQny1GEMdVRStZkAxvco7XSK27VO37fcolue4q5QRyMeVSOyGEppYy6kz6/u6JAs4hSeQp9snSDEATBpxfCTxbxF7HFy7q1A2JwHliA4YMA2URdXe2CF3sZ0GUNzVFLJqqnajOO0nTWyrAqneZdfNJLS8HGF7u5urCBuH1ghJMJ3LHChRpwZiBmFe3y9APGEjMEaSvfr6ceYid4Z+ZkOt4cVMJLVVcAtRyKB+sOwVT67W/uGcEoHEGU5/SDKW2UZ1o5yXJ+qmi3Kjz6COAvUzWztlrwu1BOSvi1o/T9LYID7faSwS94fSBJ7aD9aGn0erxKze4Jd7n5C8hfwWdvcJE10zXevWr3Jk5PE3+PGW80k5anRuq91vkhO7pKQaaefIY9NQw9/sXRffJfYrMBK0K+IEt0wT2VJU1GyGI1N0oRTL3TdTPxKThI9+QUzl6QUQNR0HYaW5uBxJ3cRyt8wJmkIxJOTxF89JmmCt6KqCTg0AapMU7jLUyzjivfN1bas5rL8o73jpXnoFu8jp+Ghy7Ur9o+aqTvDcsXX1WTCGLFI1m/z4/VdjNL8uPZ+olxELZGOdKG9U2KwJE2kw6q7yo5dM/rDOZ2hJko4L/uhY3lbRPXBa9K4utDqowaG65ItPH8kl3zv5sL9LXtN0SHm0W8erG44U+BbhuFDEhPhmVox667pvcCNNc923Xx3LtxsoZsyp6ssFGbIF9AfXdvA5SOizBqu4GhPhx5lLaotZaNlmtw+TMwtZHoQr9XhixKnDpq6RgOZNgrN825u7ckQNz4+XqbJ4mHyFn9I8r6izZs/TN1PXI+wqtX4b+D64tUyTYqHcf1rWzHxX0T2+OVyddatneVXE50vrqLdWj4EGA8VgqP6nTfq1ORoOoyYaF2iUBuceDP17pWGZ+SLPAvJLL7olsbGAwXmsizBYIZUNMM56WirIDgd/hYcwuUjeWXfUQN7i7aZWIJScT7rJ5wgOCNnM6TCoADBg8NVPgouRKNiGsJKTOmWnot9DN5I3diIXiEs37aXSA6pK1D6+hKpZn3vsMMdrrTo0j7s7g610CGn6O7/9OztI3jJvusAXNHWEXgq/RxwevaWyofkNPhhQ3hvW05E1ooeCJBfBDdSxBKD1rYvfHoBFXNEM7G9Wq9hKNwZwCZCubRbMUpXCc62VnBj4lV9GW2RbhwVtslQNWEd1rbHR8aiZeSZbh4jlQ9wUsCs4fsRRyoba4k46boq/5HKFyFy5JM3JlY8BbEgSKpIXPEpcoWAOvOngMr64QKmwjo0KZUnEudNQ5FNOyXe1mgkqgy3ssCgZ91VY7b6TX0e9Gtp3v/4fagqjDREpZyQBvqJMYemZqlhTWhrvOLOrZO+4SiRdqC52uWgbboeXIkVsmo1GqsVUAWVmQklf/MizB6JtggTLETpQYOpoNslwoc0vI9MtLX/+de/O3jt9Dg3EfMriDynVP8DGHJk6wWePG6DNVlA3ceI5kPz5/VDgLBjpbmqdN4qkn28jL+lwj9nW7voNBeKYom+lDVePbT21qbRxtrgVtINhOGbAi551TXRi7fSuk6VUrxL3LQPPyLxMevgwG4IaTXJvFp0FbzFK1RDrabjWirZr3Brj8E1Xbj/OPPn3SomDaaYqja1st4jHx8d0b+1je9VFpNitlXH5eJPSfr4gPj+cMA3Uwi+KYorifm6GP/V1qrKChKSCq3te/RbhjxAQJdvUpVS4VVkytX46OjqS+LcMk2OtzHnna7QFSwRZAvmRlMBcF2ioIJUswAxE1IBLW8+I6/QGG3up/rDMLuPCcdHR1ejlglfbjLhjeJrGC42P9PXqH5fSrvLO788oXpbsVXzZjeRHoj7kx6x3XZPpMWsMdItkpPzu+R2IGo58P0n55fLS5I6V2hKFdXaMsbCFclJcriROeJqf0pLnN8lfDwl0fW1QuV0V7Lh/opaHt6MkmW6PmKrs7wT2joxk2o2uHfU5YrUd7QdnuM9glexfS3/jhTcB352odJEkhgUKMg9Jg7SLv+4Spt9F/cqJrS25qhWm7KedYpJp14ead30b8kMdRJD5zErw4mWNs+SrChK2lwI/WyzG+cr0WsTCTGPMOIAfHx8zJHqVyMO6V684mjp+OXy0nO4EzlwZrLr/vqEd8+PC019vyZJ1vyI3mG+fpbvPFd3HKvRl5JqqnnPwz6c1qjekatKqnUz2oxOscx01RbxRvD//OvfPCIeY7zMn+C0MVDrORp6r0JVudMSbyU5h53nNJR84+y0qEq0ljJyyuHMP0WRMy4GiB5XJmoxkaUkW0Fg2hfddMyNHcJPBdIdAXU9M74u4gZLMjFQas0PNcg7aJyuus9dYK7N9ZRQSkHAhGr7yeexiHEIqkKojDL2XoXYX6CHKeTD1kZaBCErAiZfGqdTmUmamAyjEZmDSigx44M/5SiZuFDHynyjJxSKWF023tmm9wGIzpPINwZD+JaCGyacGnN0tO2597Nt6uOcYCfDw5cJxZQ1LS8ztKsKqhJv0LDJ8FFqU5ZQa+cjR/J8untLEzkjlKU43CMUt6ZlX/CGeY1cLIZA1wZ0JpFPSAJQSnXtn6mct2L2E06sdLjKEMzn8w3z9bw/5i/SFc2E/Eu9GjfjRjZ23eHtx3MyNmgqezp9h+ZGZhhs5441Dxn4MBxrIuNjLSqbqOVWD7aUGSqLnUPo9V/efg838GJ4lKQdg/0IhA+/f/PNdz+8+47mpSPF699oeDQ84rSmtq4SqrPUN/412tnKhK4l3dvzef/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/EbYOo/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3p2Li90/c9k/c9k/c9k/c9k/cntTDov0Tt99DAvdP3PZP3B7xxC2UsJBXeFiXQnINVKiY9eVL5+sP3y7TpKD6ppPz5O6Orv/em3K5pOZfGzRUHHWZJjfCSEpyc2lUGkuAqGjmGhd0De1z9oMzWj/14s5X5msVYVTB5Ee85m2/F7ZbgvX29N1ZkiaT8Div0jmNMWJOD/fE3FfOBG7y0yzBry5KoWYN1/Akfk6qWhKNK/olT9dc8hR+dEqBhFp0MOzXQnky6C8RtXXA3Z0vp1ouW3jftXNEYGyEpv27XC6X/wfuWsTz",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", 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."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," 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, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," 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, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," 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."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"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.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.9e901803.js b/assets/js/runtime~main.b32e6f9d.js similarity index 77% rename from assets/js/runtime~main.9e901803.js rename to assets/js/runtime~main.b32e6f9d.js index 3869bba5e..22f316827 100644 --- a/assets/js/runtime~main.9e901803.js +++ b/assets/js/runtime~main.b32e6f9d.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,b,r={},d={};function t(e){var a=d[e];if(void 0!==a)return a.exports;var c=d[e]={id:e,loaded:!1,exports:{}};return r[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=r,t.c=d,e=[],t.O=(a,c,f,b)=>{if(!c){var r=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(d=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var r={};a=a||[null,c({}),c([]),c(c)];for(var d=2&f&&e;"object"==typeof d&&!~a.indexOf(d);d=c(d))Object.getOwnPropertyNames(d).forEach((a=>r[a]=()=>e[a]));return r.default=()=>e,t.d(b,r),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({157:"8001f939",291:"4f7a2d40",490:"ce589067",560:"500027af",724:"fa40969b",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",962:"046910c8",1019:"5ce9853b",1179:"489b8a4d",1235:"a7456010",1381:"a2bc1463",1440:"277a78f5",1519:"78b2b753",1640:"c9fa5aa5",1688:"9640838e",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2089:"c7b98810",2131:"299c7a47",2223:"5a2de241",2264:"17e5210b",2634:"c4f5d8e4",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3213:"a9f09360",3249:"ccc49370",3276:"e5aefb32",3381:"42f80fc5",3392:"reactPlayerVidyard",3451:"70853c19",3605:"a88a3db3",3637:"f4f34a3a",3694:"8717b14a",3841:"56b5f4f8",3844:"bbdfc22d",3976:"0e384e19",4134:"393be207",4212:"621db11d",4317:"0028a090",4469:"52d5c0f9",4553:"451a5132",4584:"f82cd581",4813:"6875c492",4948:"bfe4b778",5277:"8320e026",5378:"38e3d9c8",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5772:"28b19cd2",5970:"0f8cf55d",6007:"611db08b",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6197:"1aff3f87",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6382:"5c04ee3b",6463:"reactPlayerKaltura",6473:"4c5e977b",6648:"0c0943c7",6653:"f214d5ff",6685:"ae010e44",6743:"e226bb09",6792:"4d665321",6887:"reactPlayerFacebook",6969:"14eb3368",7068:"e92d0461",7098:"a7bd4aaa",7315:"f0ff4a36",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7605:"770b40a9",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7910:"e4f5c862",8025:"5e90a9b3",8097:"ab2a161b",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8209:"01a85c17",8211:"1f73ca32",8446:"reactPlayerYouTube",8462:"3217192f",8472:"13fdae3b",8503:"012b45bf",8609:"925b3f96",8669:"05632a52",8672:"8a725248",8734:"reactPlayerPreview",8737:"7661071f",8790:"2304e9ae",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9180:"8a855f99",9190:"6cb65baf",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9426:"38ec836e",9441:"377084eb",9599:"2c586be5",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9938:"7b076186",9979:"reactPlayerSoundCloud",9983:"ada7accb"}[e]||e)+"."+{157:"be2f595e",291:"fb6bc395",490:"06dc6e05",560:"d65f3f92",724:"0711c505",746:"33cab0ea",841:"42868966",849:"7fa088b2",850:"3ac080ec",962:"abe7aaf7",1019:"b628cd80",1179:"b551b44c",1235:"e0fce024",1381:"9fe35bff",1440:"5dc69857",1463:"6c989e27",1519:"5bb2f535",1640:"d2ce80bf",1688:"be33b996",1903:"9c2000d9",1924:"7f7bb4f2",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2089:"11b02d02",2131:"d7f2b515",2223:"7898036f",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"cecb2797",3021:"eb474160",3042:"040aac0d",3073:"732a63bb",3213:"49530215",3249:"d6c50b29",3276:"00ab24d9",3381:"a7f76393",3392:"a7951473",3451:"5d1e4741",3605:"0b93ed81",3637:"ffa80471",3694:"4d710693",3841:"6784ed33",3844:"8c393c59",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"53e80455",4469:"b91649d3",4553:"c012dd2f",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"f69d6817",5013:"b10f6f78",5277:"6e628336",5378:"73b1ae3a",5550:"def3ac1b",5557:"dffbf1c4",5597:"dccc1a9f",5742:"ac359952",5772:"45ebbf79",5970:"91dc704f",6007:"fe62cc08",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6197:"b8553e32",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"aea9ee55",6382:"08676753",6463:"665cb544",6473:"0243df4f",6648:"152274c2",6653:"fdbc0c47",6685:"af652df7",6743:"a3fe848c",6792:"3e46ed7a",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b2ebdef8",7098:"c920e4e4",7315:"c4f1b7a2",7318:"deb0893f",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7605:"49352e31",7627:"df6df631",7643:"4bb958af",7696:"6ededead",7757:"ad93b050",7910:"61af651f",8025:"18e81984",8097:"43a7d9e8",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8209:"b9e31ef1",8211:"48f7e73e",8446:"594ab8ca",8462:"d040ed86",8472:"7a8c2a64",8503:"45b8fe0a",8609:"6bdc8628",8669:"96765119",8672:"8dd48c73",8734:"1f259505",8737:"f138d21c",8790:"7b709933",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9180:"0210056e",9190:"dd359a70",9241:"77521554",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9426:"4597631d",9441:"5276d129",9599:"98316ca0",9611:"9a74cba2",9647:"2f22c378",9858:"939e017f",9938:"5f0c09d6",9979:"84827225",9983:"b4126a82"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,r)=>{if(f[e])f[e].push(a);else{var d,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{d.onerror=d.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],d.parentNode&&d.parentNode.removeChild(d),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=u.bind(null,d.onerror),d.onload=u.bind(null,d.onload),o&&document.head.appendChild(d)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325","8001f939":"157","4f7a2d40":"291",ce589067:"490","500027af":"560",fa40969b:"724",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","046910c8":"962","5ce9853b":"1019","489b8a4d":"1179",a7456010:"1235",a2bc1463:"1381","277a78f5":"1440","78b2b753":"1519",c9fa5aa5:"1640","9640838e":"1688",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",c7b98810:"2089","299c7a47":"2131","5a2de241":"2223","17e5210b":"2264",c4f5d8e4:"2634","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",a9f09360:"3213",ccc49370:"3249",e5aefb32:"3276","42f80fc5":"3381",reactPlayerVidyard:"3392","70853c19":"3451",a88a3db3:"3605",f4f34a3a:"3637","8717b14a":"3694","56b5f4f8":"3841",bbdfc22d:"3844","0e384e19":"3976","393be207":"4134","621db11d":"4212","0028a090":"4317","52d5c0f9":"4469","451a5132":"4553",f82cd581:"4584","6875c492":"4813",bfe4b778:"4948","8320e026":"5277","38e3d9c8":"5378","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","28b19cd2":"5772","0f8cf55d":"5970","611db08b":"6007","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173","1aff3f87":"6197",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353","5c04ee3b":"6382",reactPlayerKaltura:"6463","4c5e977b":"6473","0c0943c7":"6648",f214d5ff:"6653",ae010e44:"6685",e226bb09:"6743","4d665321":"6792",reactPlayerFacebook:"6887","14eb3368":"6969",e92d0461:"7068",a7bd4aaa:"7098",f0ff4a36:"7315",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570","770b40a9":"7605",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757",e4f5c862:"7910","5e90a9b3":"8025",ab2a161b:"8097","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","1f73ca32":"8211",reactPlayerYouTube:"8446","3217192f":"8462","13fdae3b":"8472","012b45bf":"8503","925b3f96":"8609","05632a52":"8669","8a725248":"8672",reactPlayerPreview:"8734","7661071f":"8737","2304e9ae":"8790",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","8a855f99":"9180","6cb65baf":"9190","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","38ec836e":"9426","377084eb":"9441","2c586be5":"9599","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858","7b076186":"9938",reactPlayerSoundCloud:"9979",ada7accb:"9983"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var r=t.p+t.u(a),d=new Error;t.l(r,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),r=c&&c.target&&c.target.src;d.message="Loading chunk "+a+" failed.\n("+b+": "+r+")",d.name="ChunkLoadError",d.type=b,d.request=r,f[1](d)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,r=c[0],d=c[1],o=c[2],l=0;if(r.some((a=>0!==e[a]))){for(f in d)t.o(d,f)&&(t.m[f]=d[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({157:"8001f939",291:"4f7a2d40",490:"ce589067",560:"500027af",724:"fa40969b",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",962:"046910c8",1019:"5ce9853b",1179:"489b8a4d",1235:"a7456010",1381:"a2bc1463",1440:"277a78f5",1519:"78b2b753",1640:"c9fa5aa5",1688:"9640838e",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2089:"c7b98810",2131:"299c7a47",2223:"5a2de241",2264:"17e5210b",2634:"c4f5d8e4",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3213:"a9f09360",3249:"ccc49370",3276:"e5aefb32",3381:"42f80fc5",3392:"reactPlayerVidyard",3451:"70853c19",3605:"a88a3db3",3637:"f4f34a3a",3694:"8717b14a",3841:"56b5f4f8",3844:"bbdfc22d",3976:"0e384e19",4134:"393be207",4212:"621db11d",4317:"0028a090",4469:"52d5c0f9",4553:"451a5132",4584:"f82cd581",4813:"6875c492",4948:"bfe4b778",5277:"8320e026",5378:"38e3d9c8",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5772:"28b19cd2",5970:"0f8cf55d",6007:"611db08b",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6197:"1aff3f87",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6382:"5c04ee3b",6463:"reactPlayerKaltura",6473:"4c5e977b",6648:"0c0943c7",6653:"f214d5ff",6685:"ae010e44",6743:"e226bb09",6792:"4d665321",6887:"reactPlayerFacebook",6969:"14eb3368",7068:"e92d0461",7098:"a7bd4aaa",7315:"f0ff4a36",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7605:"770b40a9",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7910:"e4f5c862",8025:"5e90a9b3",8097:"ab2a161b",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8209:"01a85c17",8211:"1f73ca32",8446:"reactPlayerYouTube",8462:"3217192f",8472:"13fdae3b",8503:"012b45bf",8609:"925b3f96",8669:"05632a52",8672:"8a725248",8734:"reactPlayerPreview",8737:"7661071f",8790:"2304e9ae",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9180:"8a855f99",9190:"6cb65baf",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9426:"38ec836e",9441:"377084eb",9599:"2c586be5",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9938:"7b076186",9979:"reactPlayerSoundCloud",9983:"ada7accb"}[e]||e)+"."+{157:"be2f595e",291:"fb6bc395",490:"06dc6e05",560:"d65f3f92",724:"0711c505",746:"33cab0ea",841:"42868966",849:"7fa088b2",850:"3ac080ec",962:"abe7aaf7",1019:"b628cd80",1179:"b551b44c",1235:"e0fce024",1381:"9fe35bff",1440:"5dc69857",1463:"6c989e27",1519:"5bb2f535",1640:"d2ce80bf",1688:"be33b996",1903:"9c2000d9",1924:"7f7bb4f2",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2089:"11b02d02",2131:"d7f2b515",2223:"7898036f",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"cecb2797",3021:"eb474160",3042:"040aac0d",3073:"732a63bb",3213:"7d37e13c",3249:"d6c50b29",3276:"00ab24d9",3381:"a7f76393",3392:"a7951473",3451:"5d1e4741",3605:"0b93ed81",3637:"ffa80471",3694:"4d710693",3841:"6784ed33",3844:"b0216893",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"cbfaf7cf",4469:"b91649d3",4553:"c012dd2f",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"f69d6817",5013:"b10f6f78",5277:"6e628336",5378:"73b1ae3a",5550:"def3ac1b",5557:"dffbf1c4",5597:"dccc1a9f",5742:"ac359952",5772:"45ebbf79",5970:"91dc704f",6007:"fe62cc08",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6197:"b8553e32",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"aea9ee55",6382:"08676753",6463:"665cb544",6473:"0243df4f",6648:"152274c2",6653:"fdbc0c47",6685:"73bf45a2",6743:"a3fe848c",6792:"3e46ed7a",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b2ebdef8",7098:"c920e4e4",7315:"c4f1b7a2",7318:"deb0893f",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7605:"49352e31",7627:"df6df631",7643:"4bb958af",7696:"6ededead",7757:"ad93b050",7910:"61af651f",8025:"18e81984",8097:"43a7d9e8",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8209:"b9e31ef1",8211:"48f7e73e",8446:"594ab8ca",8462:"d040ed86",8472:"7a8c2a64",8503:"45b8fe0a",8609:"6bdc8628",8669:"96765119",8672:"8dd48c73",8734:"1f259505",8737:"f138d21c",8790:"7b709933",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9180:"0210056e",9190:"dd359a70",9241:"77521554",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9426:"4597631d",9441:"5276d129",9599:"1eb0d033",9611:"9a74cba2",9647:"2f22c378",9858:"939e017f",9938:"5f0c09d6",9979:"84827225",9983:"b4126a82"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325","8001f939":"157","4f7a2d40":"291",ce589067:"490","500027af":"560",fa40969b:"724",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","046910c8":"962","5ce9853b":"1019","489b8a4d":"1179",a7456010:"1235",a2bc1463:"1381","277a78f5":"1440","78b2b753":"1519",c9fa5aa5:"1640","9640838e":"1688",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",c7b98810:"2089","299c7a47":"2131","5a2de241":"2223","17e5210b":"2264",c4f5d8e4:"2634","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",a9f09360:"3213",ccc49370:"3249",e5aefb32:"3276","42f80fc5":"3381",reactPlayerVidyard:"3392","70853c19":"3451",a88a3db3:"3605",f4f34a3a:"3637","8717b14a":"3694","56b5f4f8":"3841",bbdfc22d:"3844","0e384e19":"3976","393be207":"4134","621db11d":"4212","0028a090":"4317","52d5c0f9":"4469","451a5132":"4553",f82cd581:"4584","6875c492":"4813",bfe4b778:"4948","8320e026":"5277","38e3d9c8":"5378","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","28b19cd2":"5772","0f8cf55d":"5970","611db08b":"6007","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173","1aff3f87":"6197",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353","5c04ee3b":"6382",reactPlayerKaltura:"6463","4c5e977b":"6473","0c0943c7":"6648",f214d5ff:"6653",ae010e44:"6685",e226bb09:"6743","4d665321":"6792",reactPlayerFacebook:"6887","14eb3368":"6969",e92d0461:"7068",a7bd4aaa:"7098",f0ff4a36:"7315",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570","770b40a9":"7605",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757",e4f5c862:"7910","5e90a9b3":"8025",ab2a161b:"8097","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","1f73ca32":"8211",reactPlayerYouTube:"8446","3217192f":"8462","13fdae3b":"8472","012b45bf":"8503","925b3f96":"8609","05632a52":"8669","8a725248":"8672",reactPlayerPreview:"8734","7661071f":"8737","2304e9ae":"8790",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","8a855f99":"9180","6cb65baf":"9190","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","38ec836e":"9426","377084eb":"9441","2c586be5":"9599","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858","7b076186":"9938",reactPlayerSoundCloud:"9979",ada7accb:"9983"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index d02d10d63..3a978abdc 100644 --- a/blog/authors/index.html +++ b/blog/authors/index.html @@ -5,7 +5,7 @@ Authors | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index dfe755694..b2c228bc1 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,7 +5,7 @@ First Blog Post | OpenSign™ - + diff --git a/blog/index.html b/blog/index.html index 2008db566..35943c004 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | OpenSign™ - + diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index ac09dbf43..64c5783aa 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,7 +5,7 @@ Long Blog Post | OpenSign™ - + diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index 07af3e216..c2da440e4 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,7 +5,7 @@ MDX Blog Post | OpenSign™ - + diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index 0fe7c1d87..561c46d8b 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,7 +5,7 @@ 4 posts tagged with "docusaurus" | OpenSign™ - + diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index 21fa5ae08..50ebeb79c 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,7 +5,7 @@ One post tagged with "facebook" | OpenSign™ - + diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index d90cb99af..70afe4ba5 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,7 +5,7 @@ 2 posts tagged with "hello" | OpenSign™ - + diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index aff9132d9..04ace7dcb 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,7 +5,7 @@ One post tagged with "hola" | OpenSign™ - + diff --git a/blog/tags/index.html b/blog/tags/index.html index a1be5a4d6..c02caaeed 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | OpenSign™ - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index 1496c0b54..d424f961d 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index 5d4ec62e2..72b410e8e 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 579b9b909..dd0ef8b31 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index fff9831ae..5640648f0 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -62,7 +62,7 @@
  • default: 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.
  • format: Specify the date format of your choice from the options below.
      -
    • "dd/MM/yyyy",
      • +
    • "mm/dd/yyyy"
    • "dd-mm-yyyy",
    • "yyyy-mm-dd",
    • "mm.dd.yyyy",
      • diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 3c158edc8..9a56429d7 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index 62e918a0e..6dea8b519 100644 --- a/docs/API-docs/createfolder/index.html +++ b/docs/API-docs/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 4fafa683a..9a968d456 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -62,7 +62,7 @@
    • default: 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.
    • format: Specify the date format of your choice from the options below.
        -
      • "dd/MM/yyyy",
        • +
      • "mm/dd/yyyy",
      • "dd-mm-yyyy",
      • "yyyy-mm-dd",
      • "mm.dd.yyyy",
        • diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 892680d6f..8eb44aa2e 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index 6445deccf..ce7081318 100644 --- a/docs/API-docs/delete-webhook/index.html +++ b/docs/API-docs/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index d48e54459..e0fd106fa 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index 7c15f337a..3c0de60d2 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/deletefolder/index.html b/docs/API-docs/deletefolder/index.html index 473e45c82..d3d3ec5eb 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftdocument/index.html b/docs/API-docs/draftdocument/index.html index 7a9a43d12..317931f82 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + @@ -62,7 +62,7 @@
      • default: 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.
      • format: Specify the date format of your choice from the options below.
          -
        • "dd/MM/yyyy",
          • +
        • "mm/dd/yyyy"
        • "dd-mm-yyyy",
        • "yyyy-mm-dd",
        • "mm.dd.yyyy",
          • diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 809d37259..fb1897de0 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -64,7 +64,7 @@
        • default: 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.
        • format: Specify the date format of your choice from the options below.
            -
          • "dd/MM/yyyy",
            • +
          • "mm/dd/yyyy"
          • "dd-mm-yyyy",
          • "yyyy-mm-dd",
          • "mm.dd.yyyy",
            • diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index 65ffff7bf..32f7148c7 100644 --- a/docs/API-docs/folderlist/index.html +++ b/docs/API-docs/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index bd911df18..191008219 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index f9057d635..a84c640e8 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index a80fbce27..d36e6b1dd 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 59ef9d84c..1f360d7ed 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index bd766ec5a..3e5dd60f2 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 02f63c176..9ac33555a 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/getfolder/index.html b/docs/API-docs/getfolder/index.html index 581459dde..5f1095223 100644 --- a/docs/API-docs/getfolder/index.html +++ b/docs/API-docs/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index b4619763f..695eb8fe3 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index d887e5f60..6bc1114cd 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index 8a3fc09c9..0834bc8bf 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index 7f7fbd235..c4e4db77c 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/revokedocument/index.html b/docs/API-docs/revokedocument/index.html index e9bc9cd28..e644b889e 100644 --- a/docs/API-docs/revokedocument/index.html +++ b/docs/API-docs/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index a5f08c638..9e6071d2b 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/selfsign/index.html b/docs/API-docs/selfsign/index.html index cd0ae2cff..beb3c66b8 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + @@ -62,7 +62,7 @@
          • default: 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.
          • format: Specify the date format of your choice from the options below.
              -
            • "dd/MM/yyyy",
              • +
            • "mm/dd/yyyy"
            • "dd-mm-yyyy",
            • "yyyy-mm-dd",
            • "mm.dd.yyyy",
              • diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index dd1831386..b2035ea0c 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index cb61c6bfc..0b1498ed8 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index 04d665727..758a55b1c 100644 --- a/docs/API-docs/updatefolder/index.html +++ b/docs/API-docs/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index e6b3595df..b0e91edd3 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index e774cedf9..9e145ede3 100644 --- a/docs/category/create-new-opensign-document/index.html +++ b/docs/category/create-new-opensign-document/index.html @@ -5,7 +5,7 @@ Create New OpenSign Document | OpenSign™ - + diff --git a/docs/category/docker/index.html b/docs/category/docker/index.html index c215b6140..62f018025 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index c8b4406b4..6bafbfcac 100644 --- a/docs/category/faqs/index.html +++ b/docs/category/faqs/index.html @@ -5,7 +5,7 @@ FAQs | OpenSign™ - + diff --git a/docs/category/guides/index.html b/docs/category/guides/index.html index 07341a800..0fda54a76 100644 --- a/docs/category/guides/index.html +++ b/docs/category/guides/index.html @@ -5,7 +5,7 @@ Guides | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index fae7b55de..cd0249107 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index 92aa633d8..8f0c3b873 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index a4140163e..6c92fa166 100644 --- a/docs/category/settings/index.html +++ b/docs/category/settings/index.html @@ -5,7 +5,7 @@ Settings | OpenSign™ - + diff --git a/docs/category/templates/index.html b/docs/category/templates/index.html index bb4b5e9a7..a45f19ce6 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 1dabc2282..1aabe9ff0 100644 --- a/docs/contribute/CODE_OF_CONDUCT/index.html +++ b/docs/contribute/CODE_OF_CONDUCT/index.html @@ -5,7 +5,7 @@ Code of conduct | OpenSign™ - + diff --git a/docs/contribute/COMMUNITY/index.html b/docs/contribute/COMMUNITY/index.html index 554340599..a90b92766 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ Community at OpenSign™ | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index 992b5f35a..5a818cbeb 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ Installation instructions | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 701ce46b4..e6e746e2e 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ OpenSign™ Reporting Guidelines | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index 9cc29947a..210310dae 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html index ba2d50e95..ef8f10cdc 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index dbe997c0a..048c16904 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index dbedccb62..9adc22e58 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index b62e5abe7..a9277c14f 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index e742860a4..1f233e66e 100644 --- a/docs/help/New-Document/request-signatures/index.html +++ b/docs/help/New-Document/request-signatures/index.html @@ -5,7 +5,7 @@ Request signatures | OpenSign™ - + diff --git a/docs/help/New-Document/sign-yourself/index.html b/docs/help/New-Document/sign-yourself/index.html index 2e934d171..35a2f5d0c 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 36b6bf3f4..7632ea799 100644 --- a/docs/help/OpenSign™ Drive/create-document/index.html +++ b/docs/help/OpenSign™ Drive/create-document/index.html @@ -5,7 +5,7 @@ Create Docs & Folders | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/list-grid-view/index.html b/docs/help/OpenSign™ Drive/list-grid-view/index.html index 5b11508f6..aab0449cf 100644 --- a/docs/help/OpenSign™ Drive/list-grid-view/index.html +++ b/docs/help/OpenSign™ Drive/list-grid-view/index.html @@ -5,7 +5,7 @@ Grid vs List view | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/organize-documents/index.html b/docs/help/OpenSign™ Drive/organize-documents/index.html index 159c0ceaa..733af4203 100644 --- a/docs/help/OpenSign™ Drive/organize-documents/index.html +++ b/docs/help/OpenSign™ Drive/organize-documents/index.html @@ -5,7 +5,7 @@ OpenSign™ Drive Interface Documentation | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/rename-document/index.html b/docs/help/OpenSign™ Drive/rename-document/index.html index 7543bb022..9fa92141b 100644 --- a/docs/help/OpenSign™ Drive/rename-document/index.html +++ b/docs/help/OpenSign™ Drive/rename-document/index.html @@ -5,7 +5,7 @@ Rename documents from OpenSign™ Drive | OpenSign™ - + diff --git a/docs/help/Reports/completed/index.html b/docs/help/Reports/completed/index.html index 4b453a7cc..ca574fb47 100644 --- a/docs/help/Reports/completed/index.html +++ b/docs/help/Reports/completed/index.html @@ -5,7 +5,7 @@ Completed | OpenSign™ - + diff --git a/docs/help/Reports/contactbook/index.html b/docs/help/Reports/contactbook/index.html index 507c0c726..73ebae567 100644 --- a/docs/help/Reports/contactbook/index.html +++ b/docs/help/Reports/contactbook/index.html @@ -5,7 +5,7 @@ Contactbook | OpenSign™ - + diff --git a/docs/help/Reports/declined/index.html b/docs/help/Reports/declined/index.html index a1865ddd7..fffaed0dc 100644 --- a/docs/help/Reports/declined/index.html +++ b/docs/help/Reports/declined/index.html @@ -5,7 +5,7 @@ Declined | OpenSign™ - + diff --git a/docs/help/Reports/drafts/index.html b/docs/help/Reports/drafts/index.html index 1e98807e4..7e85b7658 100644 --- a/docs/help/Reports/drafts/index.html +++ b/docs/help/Reports/drafts/index.html @@ -5,7 +5,7 @@ Drafts | OpenSign™ - + diff --git a/docs/help/Reports/expired/index.html b/docs/help/Reports/expired/index.html index 95a03d4f5..ef7f79cef 100644 --- a/docs/help/Reports/expired/index.html +++ b/docs/help/Reports/expired/index.html @@ -5,7 +5,7 @@ Expired | OpenSign™ - + diff --git a/docs/help/Reports/in-progress/index.html b/docs/help/Reports/in-progress/index.html index 041c7c47b..92be464d8 100644 --- a/docs/help/Reports/in-progress/index.html +++ b/docs/help/Reports/in-progress/index.html @@ -5,7 +5,7 @@ In Progress | OpenSign™ - + diff --git a/docs/help/Reports/need-your-sign/index.html b/docs/help/Reports/need-your-sign/index.html index 39c957d39..1287668e4 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index 753a21816..d6617f333 100644 --- a/docs/help/Settings/disabledocumentid/index.html +++ b/docs/help/Settings/disabledocumentid/index.html @@ -5,7 +5,7 @@ Disable DocumentId | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index 3fc268442..7aa7b9f9d 100644 --- a/docs/help/Settings/manage-users/index.html +++ b/docs/help/Settings/manage-users/index.html @@ -5,7 +5,7 @@ Manage users | OpenSign™ - + diff --git a/docs/help/Settings/my-signature/index.html b/docs/help/Settings/my-signature/index.html index fba095057..33de81917 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index a55d89026..8d477e997 100644 --- a/docs/help/Templates/create-template/index.html +++ b/docs/help/Templates/create-template/index.html @@ -5,7 +5,7 @@ Create Templates | OpenSign™ - + diff --git a/docs/help/Templates/embed-template/index.html b/docs/help/Templates/embed-template/index.html index 8274ec278..306d3186c 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index 285c557c8..fd8ccfdd3 100644 --- a/docs/help/Templates/publicTemplate/index.html +++ b/docs/help/Templates/publicTemplate/index.html @@ -5,7 +5,7 @@ Setting up an OpenSign template for public signing | OpenSign™ - + diff --git a/docs/help/Templates/quick-send/index.html b/docs/help/Templates/quick-send/index.html index 717ea00d1..454f3ddf6 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send the Document for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index 8b5b8b0e0..2a305a3f8 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index e9d5a4a3d..06c78df07 100644 --- a/docs/help/intro/index.html +++ b/docs/help/intro/index.html @@ -5,7 +5,7 @@ Intro | OpenSign™ - + diff --git a/docs/intro/index.html b/docs/intro/index.html index 8e00bdb2a..8af67ab80 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/One-click-Install/DigitalOcean/index.html b/docs/self-host/One-click-Install/DigitalOcean/index.html index 6162276a7..ff6f7b9a1 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/cloud-storage/s3/index.html b/docs/self-host/cloud-storage/s3/index.html index 143ffb045..4325141d2 100644 --- a/docs/self-host/cloud-storage/s3/index.html +++ b/docs/self-host/cloud-storage/s3/index.html @@ -5,7 +5,7 @@ AWS S3 | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index e5b32e0c7..e6016e5f5 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Self-host OpenSign™ with Docker on Linux/MacOS/Windows | OpenSign™ - + diff --git a/docs/self-host/docker/upgrade-deployment/index.html b/docs/self-host/docker/upgrade-deployment/index.html index f24d47a11..769c8df1f 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index eb9ecfd3d..e28470893 100644 --- a/docs/self-host/guides/env-variables/index.html +++ b/docs/self-host/guides/env-variables/index.html @@ -5,7 +5,7 @@ ENV variables which are used to setup OpenSign™ with Docker on Localhost | OpenSign™ - + diff --git a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html index 7d793fdc4..1da625b19 100644 --- a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html +++ b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html @@ -5,7 +5,7 @@ How to generate self-signed document signing certificate? | OpenSign™ - + diff --git a/docs/self-host/guides/upgrade-to-v2.1.0/index.html b/docs/self-host/guides/upgrade-to-v2.1.0/index.html index 7df6b5659..0416c4a0e 100644 --- a/docs/self-host/guides/upgrade-to-v2.1.0/index.html +++ b/docs/self-host/guides/upgrade-to-v2.1.0/index.html @@ -5,7 +5,7 @@ How to upgrade self-hosted OpenSign to v2.1.0? | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 764c015ab..0e3bfb909 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Self-Hosting OpenSign | OpenSign™ - + diff --git a/index.html b/index.html index 31d3fdecd..6e663f8f3 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more. | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 666e4c761..ab1b4b46c 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +