From 8823d8be827bbb01d1cccfb659d8ab5918acf883 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 18 Feb 2025 07:43:48 +0000 Subject: [PATCH] deploy: 9aebbde627ce13cb40c45129c1403482af107cb9 --- 404.html | 2 +- assets/js/2c586be5.7cf9c80b.js | 1 + assets/js/2c586be5.d66b6249.js | 1 - assets/js/ae010e44.5eca02a5.js | 1 + assets/js/ae010e44.b5687ca9.js | 1 - assets/js/bbdfc22d.6ba5aede.js | 1 - assets/js/bbdfc22d.de0fa34e.js | 1 + ...n.44114b57.js => runtime~main.cc74056c.js} | 2 +- blog/archive/index.html | 2 +- blog/authors/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 2 +- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 60 +++++++++---------- .../createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/createfolder/index.html | 2 +- docs/API-docs/createtemplate/index.html | 60 +++++++++---------- docs/API-docs/delete-template/index.html | 2 +- docs/API-docs/delete-webhook/index.html | 2 +- docs/API-docs/deletecontact/index.html | 2 +- docs/API-docs/deletedocument/index.html | 2 +- docs/API-docs/deletefolder/index.html | 2 +- docs/API-docs/draftdocument/index.html | 2 +- docs/API-docs/drafttemplate/index.html | 2 +- docs/API-docs/folderlist/index.html | 2 +- docs/API-docs/get-template/index.html | 2 +- docs/API-docs/get-user/index.html | 2 +- docs/API-docs/get-webhook/index.html | 2 +- docs/API-docs/getcontact/index.html | 2 +- docs/API-docs/getdocument/index.html | 2 +- docs/API-docs/getdocumentlist/index.html | 2 +- docs/API-docs/getfolder/index.html | 2 +- docs/API-docs/gettemplatelist/index.html | 2 +- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/resendrequestmail/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 2 +- docs/API-docs/selfsign/index.html | 52 ++++++++-------- docs/API-docs/update-document/index.html | 2 +- docs/API-docs/update-template/index.html | 2 +- docs/API-docs/updatefolder/index.html | 2 +- docs/category/cloud-storage/index.html | 2 +- .../create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- .../index.html | 2 +- docs/category/reports/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- .../REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/index.html | 2 +- .../enforce-email-verification/index.html | 2 +- .../navigate-between-pages/index.html | 2 +- .../request-signatures/index.html | 2 +- .../New-Document/sign-yourself/index.html | 2 +- .../create-document/index.html | 2 +- .../OpenSign™ Drive/list-grid-view/index.html | 2 +- .../organize-documents/index.html | 2 +- .../rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/contactbook/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- .../Settings/disabledocumentid/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- .../help/Templates/create-template/index.html | 2 +- docs/help/Templates/embed-template/index.html | 2 +- docs/help/Templates/publicTemplate/index.html | 2 +- docs/help/Templates/quick-send/index.html | 2 +- docs/help/Templates/use-template/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- .../One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/cloud-storage/s3/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- .../docker/upgrade-deployment/index.html | 2 +- .../self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- .../guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 101 files changed, 182 insertions(+), 180 deletions(-) create mode 100644 assets/js/2c586be5.7cf9c80b.js delete mode 100644 assets/js/2c586be5.d66b6249.js create mode 100644 assets/js/ae010e44.5eca02a5.js delete mode 100644 assets/js/ae010e44.b5687ca9.js delete mode 100644 assets/js/bbdfc22d.6ba5aede.js create mode 100644 assets/js/bbdfc22d.de0fa34e.js rename assets/js/{runtime~main.44114b57.js => runtime~main.cc74056c.js} (97%) diff --git a/404.html b/404.html index be75cbda6..fcdb53590 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/2c586be5.7cf9c80b.js b/assets/js/2c586be5.7cf9c80b.js new file mode 100644 index 000000000..f313032bd --- /dev/null +++ b/assets/js/2c586be5.7cf9c80b.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:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,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":"eJztO11zGzeSf6V3XhyrhpRIy45PT+vYuT3dJZEqlit1JakUcKZJwpoBJgBGFKPi2/6S/Wn7S666AQxn+CHJH5tV6ugHiwM0gEaju9FfuEucmNjk6Dx5p7O6ROVscpkmOdrMyMpJrZKj5GyK8NagcAgRCt6cHoMoCj2zUFs0FpyGCSo0BKVwBnmcD0ZzqIy+kblUE8iFEzCTbgojYfHVIaDKdI45jGWB/Qt1oc5kdQQfqkKLHOa6NnD67j+b2WgZajvf23uHo3oCH4739i6/mTpX2aP9fVFVfV2hsnKiCjGy/UyX+zkBVvn4eQqzKRqkWSETClBYWcxB5DnMZD5BZ1NwU1SQ6WoOmdYml0o4tClUYoKg6nKExqYgVA6lNghSgQCDIp/3nO7VFuG/35/8BGNtSuH6cFrUNm2Wy6XBzBVzP72bYrOrZzZSwzoj1SSFUlwTtaSD32qZXdO2Laqc/tLAN6fHTKu9vfd1VWnjMIdf/BaO9vao5zss9AyEQYbPdFlqBZUwokTHxzUVjrsN/lZLg7k/FFEUkRZHF6oHe3tuXuHR3h4cq1xmRAyekFpBjwNs34MSkQj0fYWZHMsA2iIdaAWzqcymTJOZ8OdZFSLzaBq0FWZO3mB34tsU5jTxO1Q6YjDVRv6ulRMFH8cNGiczUbSPjRAkUOuEcUTOSkvlYmtYAf43HA+dHh9K4CtCLSdilVJxj0W4EUWNNmA1S2FKWP2MlUHLrB7mJUKqHKYoJ9Ot64n8Y21dZ2KoLaHZxiKsFU+JyYtMtrEoLIIcd2hZimtsrQaaZVgUffhuDjmORV24FCRxnDM19uEn7UBUVSEzMSqQOBdIeISrDfb4lAM7BESUKPmMT1mi0YKAXI7HaEg4qZOnCGMidsRnSxXAkuOmQoFWKwed6UKbdRbi5i4dIdPKoXJ9eHMjZMHI+81akCor6hxhVIjsOoVRUWMKBnMvuHMktZUGJUQgIGygOdMHLBbEhVoR/kqH5aUFG7DK+3A2lXYpT9QZSc2LSNumapDasaaViQRRxABLIYuUCZfCRz0CJ12BKQlsJdQ8JX2JKTi8dSN9m0I2xeyafxmRSw2j2jmt/MZyo6tcz1Sg5VgrZ+XvGyQy9nw6RYcpHKbwKoXXKQwOUhgMUxgcpjB4lcLgdQrDgxSGwxSGhykMX3m0hq8DrUVD4DYCg6GnsvvzUJf07g/SsmSTwrSNDp51dPCgD3t7jTRR26+//nqh7i4UwEVCwnWRHMFF0oBcJKnvI51JfYPwfUsfL4bfhs85fb4avg6fMwYdHIbPKX0OBxdqERa8UEPGxImyugcL6v6qGISvwETUxotSW9Rn1EiKKI0ddFYdfKhj0d7LC9qLVNJJUdjt24kQT2hHS5TWNnVIm2J23b4j7n5C22njQz2sJn0Xq9VWVxR4xmK4tvuX/XCzbN+8X/bJ7L2Fzpdt/RVzsx7BGamm7ftvtNcTIsIqTl9GiW/7bACwZt5OhwDwhKjQxejLaPCaaECX0nYCUO8T2n0LHeoIN7zvOzjsDV72hgfDww4FyDfyAGXZy/PefD7/GtQjmycsTyZPtFC9ZUde6djocoP7wd7BEirYRPw7muw/kqE+ijYs5uT3sWMRLZbG42tb2U7nYv7M+qni0MY4I/ilaTZvocldhAd7v9lUyywgTzDRJBuRg9cnGvSI7vn+jz/utyjpG3tl2VtppM8eE77VWJb9PO+vQK6djm8sIc9TWG/e2J7nUJbllmbffpGwSfUfxPrBEtvO/QHgjxKAJZ93F75XOCgeoFXBa7OTtlk6Vq6QqVShI7AKrAAYnNSFMHhL3qaVWnnory85UXCW9jp7p+zYse/vSQHfnASb/HlgatpCdwJqeXjc2s7akxic4C3PkdXW6ZKQkbmgGVKwdTYl701E05/ovozT8FcmKklRggKd41Z0WX8TEv7UWh42neqqg23RdTYjLMSRG3xsPn5m78EBX2/BwbjnfgsQT0jFr6BEnT5cQd3nF0kp2AIgLsPlb+2maC6Sy2aM96oxf2Ds5SPkaCpzLMQIi/WuR8tAey+Bn1qEoY5SqiYSwPgepK1OcbvS6fsWG2TL77jN1FGJR9GIJIZC2hgL6dKrPToEiziEpxA5KjhCiAMo4Bol90vZvEHscXzutUA4nAeWIDhgwCZQF1d7YIXOwbQJQ3OUUsmyLpuI47iZNZKsDLd5m140kuLYcYX26a6tIG4fWIHCe9sXuFADjgzEiMI9tl6AeELKYAWl++X0c9RE5478SpfbwwIYt9UWwA1XIoH6y7ARPrtd+vpwQhcQRTn9IIpbZRlWjmJcXyqaDcqPvoI4CuQjW99xZGs757XjX0+I+zag9S/mwAD3x3Bhe3t/Ik7soP1obvRxvFJM7nF2ufsJ8V/AZ+VwkzTRFWU+pVbHeXKUZJwsjdm9JOWp0brvdD5Pju6SEGmnnyGOTUP3P1pKt94lNptiKehXRIkStJQgTVIOFqOxSZpw6IWytUSv5CjRo4+Y0WqVIXScREtz8LijuwjlM4xJGhzx5CjxqcckTfBWlBUBJyu52SofJ4u44H1TNS3LqSz/aFKdNA8l8T5zmp9oKKNS4pl+q6nR4Tsxt60J/cWcrKaxaQyxbRZGQS7mliShtt6GykSR1QX54HhbSTNvAgLsiLeOs0G0WalBdPBysTyjJUrCGDFP0kQ6LNvtW87M6E8ndIaaKMNR2U8d+1HjCPGvoYGy5nxOovxkLD5qhBHyGVVTrT55/GD4YjAcvBgMaYaQTvl8OvredQy6jPGGvEfMo13dW2ZAU+AsRP8h5ozwvG0xwYeZ8WxbZryVkLNTXRc5pbpQmD4nqD+79qHL383t0X+AmxdpcvvwZm4h072YdodvChw7qKsKDWTaKDTP27G3J7O54eHhIk3mD29v/qfc3rd0eLOHd/cL1yssazn+Hbi+eL1Ik+nDuP5XU1Hxb0T28NVieRmu3PVXI53Pr6LeWjwEGC8KghvrIkdD9sO6vlqqGtIwVAl0tarnR1oXKNQGRdNJpYeaLTLjyIILwefZFMkKXlp3PPvSoAz2nseW0vO4EhuUluw2U+NF0ofjccs8Zdd+NZsfYTmzrjQ84/WubM1q/Nl++CYaPWtXLVEhyTLoHlFgYHBYVgWX/cxkURDedK/3ofnHhlpDSUIgXpdx4Yevirc+BskLhkHdmhkIpl4f3grV1E106xPg7q5hA+aOxQLu7uhU0VzRpbtYpMsGWqvTwPeqbzGYobzpjGqacDmwaWsN9SbOFZk4viHksdoIyImSanJVm2Kx6K+x4fKMHk23NTKFs6NJ/h9QjNA5VicmR/MIyT0eew9LwzNi1mchns2Ukca6II+e3QPCPi21hcqh/oAcs+8b+bb1yBKUivMt5ccZOZkg1QYGCB4cqnlQZFOvGRgrMSbR5no/gzdS1zaiNxW2MblzgpBeXKSadB3EFnW42Kq99/4m0VVU/nNydvoIWrL72vOayPt+fpd+Djg5O6UKQjkOrlgfPtiGEpG0ogMC5BrBjRSxyqgx3+Y+woiKKeLVZqfcsx9q93qwjlAu7UaM0mWOo6m3XZt4WWJKR6RrR7WtMhROWYeV7dCRsWgIeabrx3DlA5QUMKk5ReroVo6qkfMuywpAqawztY+uQl6bWPQY2IIgM7R2SadIFQJqzZ8CKuuHCxgL69CkUCtJlDc1BTeaKfG2QiNRZbiRBAY96UhyH9Zm3XK6Dz//EAqL4x6iUI5IAv3EmENdMdewJDRlnvHkVre+UXcEtfUwgnRBczFmCKxXaKxWQEWUZiKU/N2zMDsd2pLHNhWFBw2qghLMhA9JeBeZaE798+//aOG11e1cR8yvIPKcsn0PYMjBLc/wFFQ3WJEG1F2MaD40f1218wg7FpqrUueNINnH8/gp1f462+hFp7lWHAv0he0x+9joW5tGHWuD50hJSMPJQiK20xXtF2+lda1CxVhOsK4ffkaiY9bCgT0NkmrieTVvC3iDVyiIXE7HNqDsFrk2lu6KLNxvsXqTdhmWCqqYCre1st7pHh4c0J8uSZuHA2FSIh4x+rguivlfkvTxMbH7PX7fvNmKvs+Fn36Uw99vs5vhaRICOF1N8ImBh8+KwtCY1RjMFn1071aC71Obgl4l0F56DS/wtK0zlqqQCq/iAV7lOruKuye4Eq3tBjQehUNz3GwhdM/6geWJxRZpcriJi97rEt2URYfmnRlNjyWqAgUV75s5iImQCsgNMF+RqdAYbe73yz4Ns/tIcHhwcDVoiPBynQjHilPW/ATnTF+j+mN32l7e+eUJ1duSGdXfT4n0QNyfdDbbbvebtJjVRrp5cnR+l9z2RCV7vv/o/HJxSSzopprC6pW2jLFw0+Qo2V+Lsls0Nxx2Pb/zctOIghUqp7zyWihAVHL/ZpAs0tURGwMHW6GtExOpJr17R10ut/qejsNTvLPhpbqp5P8g6ZtAzzZUmkhigykK8iOIgnTKPy9TDN/Hs4rB/03x/OWZrEboY4C+E3PfHHIfvGwFu89j3JpD0U0kelNwudlXDBc30eJWALgV/z1fMmQTao2R1gGHKIeHhxzL+3bAQa8XrzmedPhqwSy0jK0kSTd+wome1ShAknS92zio8d3CqKUD4rOOHUs6NHUtyzhTY8l1zKlVa2qrZbPFsInWrFRjzcwUTvikQvWenAWS2ZvBeggQi0yXzUuKCP7Pv/+DR0TO4GX+Aie1gUrP0Ixr/xxjXOCtJPO89SgwBphQlAVaW8yBrPIJPw/M5YQrsqLNm4lKjGQhSQkRmPYJl5Yes334ZRmiemZ8cdoNFqS7oNCaX8uRfVY7XfIa8QKaaXM9JpRSEDCiB1ZkdVrEOATVVKiMolxeNtlio9eB5EVURloEIUsCJm8Gx2OZSTZktHJGZA5KocSETa+UQ5FEhSo+jzJ6RM6g1UXt3R16pIXo/BY5bduHd+Re8sY50YSOjj33no5NvacZxCe8PhyRV1/R8jJDuyxjLfAGDesiHyeoiwIq7bzvTrZn+2xpImeEsnSThyRXOJqGfMEf4TVyMe8D5W7psiOrnBigkOravxU8b9jsFxxZ6XAZhp3NZmt68Xl3zN+km9YjsvD1ctyEG1mLtoc3H89JL6Ep7cn4PZobmUX7Z8ua+wy8H+5L4SN+UdhEJTf6EIXMUFls3W5v/nb6A9zAi/5BkrZugkcgvP/D8dvvf3r/Pc1Ld5WXv0H/oH/AuSNtXSlUa6mVd7erotvKJe+e6e6e6e6e6e6e6e6e6f5pHpLunununununununununununun+64iwe6a7e6a7e6a7e6a7e6a7e6a7e6a7e6a7e6a7e6a7e6a7e6b79R5J7p7p7p7p7p7pPnVO3D3TjUUkZBXuV4WQqlVi58uKzlcf716myZTqjo7Ok7s7Sv99oNp+av6tRkNFS5dpciOMpCA3lyylsTSHylaukepH3vqYfe+M1k89u3PGeaVSiyqL/Ig3fOz3wrZLo05P3p8laRIfY5Q6pzFGzOjxsZj5wpNATX5gKvhlWCHUpOYqmsTPSdVEonbTbinSNZcihR+tYhyh5i0MuzVKfhv0P21q44C7O1/mtFg08L5r64hA2AhN53e5WCz+D6d/MUw=","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),a=t.n(r),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 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:"eJztO11zGzeSf6V3XhyrhpRIy45PT+vYuT3dJZEqlit1JakUcKZJwpoBJgBGFKPi2/6S/Wn7S666AQxn+CHJH5tV6ugHiwM0gEaju9FfuEucmNjk6Dx5p7O6ROVscpkmOdrMyMpJrZKj5GyK8NagcAgRCt6cHoMoCj2zUFs0FpyGCSo0BKVwBnmcD0ZzqIy+kblUE8iFEzCTbgojYfHVIaDKdI45jGWB/Qt1oc5kdQQfqkKLHOa6NnD67j+b2WgZajvf23uHo3oCH4739i6/mTpX2aP9fVFVfV2hsnKiCjGy/UyX+zkBVvn4eQqzKRqkWSETClBYWcxB5DnMZD5BZ1NwU1SQ6WoOmdYml0o4tClUYoKg6nKExqYgVA6lNghSgQCDIp/3nO7VFuG/35/8BGNtSuH6cFrUNm2Wy6XBzBVzP72bYrOrZzZSwzoj1SSFUlwTtaSD32qZXdO2Laqc/tLAN6fHTKu9vfd1VWnjMIdf/BaO9vao5zss9AyEQYbPdFlqBZUwokTHxzUVjrsN/lZLg7k/FFEUkRZHF6oHe3tuXuHR3h4cq1xmRAyekFpBjwNs34MSkQj0fYWZHMsA2iIdaAWzqcymTJOZ8OdZFSLzaBq0FWZO3mB34tsU5jTxO1Q6YjDVRv6ulRMFH8cNGiczUbSPjRAkUOuEcUTOSkvlYmtYAf43HA+dHh9K4CtCLSdilVJxj0W4EUWNNmA1S2FKWP2MlUHLrB7mJUKqHKYoJ9Ot64n8Y21dZ2KoLaHZxiKsFU+JyYtMtrEoLIIcd2hZimtsrQaaZVgUffhuDjmORV24FCRxnDM19uEn7UBUVSEzMSqQOBdIeISrDfb4lAM7BESUKPmMT1mi0YKAXI7HaEg4qZOnCGMidsRnSxXAkuOmQoFWKwed6UKbdRbi5i4dIdPKoXJ9eHMjZMHI+81akCor6hxhVIjsOoVRUWMKBnMvuHMktZUGJUQgIGygOdMHLBbEhVoR/kqH5aUFG7DK+3A2lXYpT9QZSc2LSNumapDasaaViQRRxABLIYuUCZfCRz0CJ12BKQlsJdQ8JX2JKTi8dSN9m0I2xeyafxmRSw2j2jmt/MZyo6tcz1Sg5VgrZ+XvGyQy9nw6RYcpHKbwKoXXKQwOUhgMUxgcpjB4lcLgdQrDgxSGwxSGhykMX3m0hq8DrUVD4DYCg6GnsvvzUJf07g/SsmSTwrSNDp51dPCgD3t7jTRR26+//nqh7i4UwEVCwnWRHMFF0oBcJKnvI51JfYPwfUsfL4bfhs85fb4avg6fMwYdHIbPKX0OBxdqERa8UEPGxImyugcL6v6qGISvwETUxotSW9Rn1EiKKI0ddFYdfKhj0d7LC9qLVNJJUdjt24kQT2hHS5TWNnVIm2J23b4j7n5C22njQz2sJn0Xq9VWVxR4xmK4tvuX/XCzbN+8X/bJ7L2Fzpdt/RVzsx7BGamm7ftvtNcTIsIqTl9GiW/7bACwZt5OhwDwhKjQxejLaPCaaECX0nYCUO8T2n0LHeoIN7zvOzjsDV72hgfDww4FyDfyAGXZy/PefD7/GtQjmycsTyZPtFC9ZUde6djocoP7wd7BEirYRPw7muw/kqE+ijYs5uT3sWMRLZbG42tb2U7nYv7M+qni0MY4I/ilaTZvocldhAd7v9lUyywgTzDRJBuRg9cnGvSI7vn+jz/utyjpG3tl2VtppM8eE77VWJb9PO+vQK6djm8sIc9TWG/e2J7nUJbllmbffpGwSfUfxPrBEtvO/QHgjxKAJZ93F75XOCgeoFXBa7OTtlk6Vq6QqVShI7AKrAAYnNSFMHhL3qaVWnnory85UXCW9jp7p+zYse/vSQHfnASb/HlgatpCdwJqeXjc2s7akxic4C3PkdXW6ZKQkbmgGVKwdTYl701E05/ovozT8FcmKklRggKd41Z0WX8TEv7UWh42neqqg23RdTYjLMSRG3xsPn5m78EBX2/BwbjnfgsQT0jFr6BEnT5cQd3nF0kp2AIgLsPlb+2maC6Sy2aM96oxf2Ds5SPkaCpzLMQIi/WuR8tAey+Bn1qEoY5SqiYSwPgepK1OcbvS6fsWG2TL77jN1FGJR9GIJIZC2hgL6dKrPToEiziEpxA5KjhCiAMo4Bol90vZvEHscXzutUA4nAeWIDhgwCZQF1d7YIXOwbQJQ3OUUsmyLpuI47iZNZKsDLd5m140kuLYcYX26a6tIG4fWIHCe9sXuFADjgzEiMI9tl6AeELKYAWl++X0c9RE5478SpfbwwIYt9UWwA1XIoH6y7ARPrtd+vpwQhcQRTn9IIpbZRlWjmJcXyqaDcqPvoI4CuQjW99xZGs757XjX0+I+zag9S/mwAD3x3Bhe3t/Ik7soP1obvRxvFJM7nF2ufsJ8V/AZ+VwkzTRFWU+pVbHeXKUZJwsjdm9JOWp0brvdD5Pju6SEGmnnyGOTUP3P1pKt94lNptiKehXRIkStJQgTVIOFqOxSZpw6IWytUSv5CjRo4+Y0WqVIXScREtz8LijuwjlM4xJGhzx5CjxqcckTfBWlBUBJyu52SofJ4u44H1TNS3LqSz/aFKdNA8l8T5zmp9oKKNS4pl+q6nR4Tsxt60J/cWcrKaxaQyxbRZGQS7mliShtt6GykSR1QX54HhbSTNvAgLsiLeOs0G0WalBdPBysTyjJUrCGDFP0kQ6LNvtW87M6E8ndIaaKMNR2U8d+1HjCPGvoYGy5nxOovxkLD5qhBHyGVVTrT55/GD4YjAcvBgMaYaQTvl8OvredQy6jPGGvEfMo13dW2ZAU+AsRP8h5ozwvG0xwYeZ8WxbZryVkLNTXRc5pbpQmD4nqD+79qHL383t0X+AmxdpcvvwZm4h072YdodvChw7qKsKDWTaKDTP27G3J7O54eHhIk3mD29v/qfc3rd0eLOHd/cL1yssazn+Hbi+eL1Ik+nDuP5XU1Hxb0T28NVieRmu3PVXI53Pr6LeWjwEGC8KghvrIkdD9sO6vlqqGtIwVAl0tarnR1oXKNQGRdNJpYeaLTLjyIILwefZFMkKXlp3PPvSoAz2nseW0vO4EhuUluw2U+NF0ofjccs8Zdd+NZsfYTmzrjQ84/WubM1q/Nl++CYaPWtXLVEhyTLoHlFgYHBYVgWX/cxkURDedK/3ofnHhlpDSUIgXpdx4Yevirc+BskLhkHdmhkIpl4f3grV1E106xPg7q5hA+aOxQLu7uhU0VzRpbtYpMsGWqvTwPeqbzGYobzpjGqacDmwaWsN9SbOFZk4viHksdoIyImSanJVm2Kx6K+x4fKMHk23NTKFs6NJ/h9QjNA5VicmR/MIyT0eew9LwzNi1mchns2Ukca6II+e3QPCPi21hcqh/oAcs+8b+bb1yBKUivMt5ccZOZkg1QYGCB4cqnlQZFOvGRgrMSbR5no/gzdS1zaiNxW2MblzgpBeXKSadB3EFnW42Kq99/4m0VVU/nNydvoIWrL72vOayPt+fpd+Djg5O6UKQjkOrlgfPtiGEpG0ogMC5BrBjRSxyqgx3+Y+woiKKeLVZqfcsx9q93qwjlAu7UaM0mWOo6m3XZt4WWJKR6RrR7WtMhROWYeV7dCRsWgIeabrx3DlA5QUMKk5ReroVo6qkfMuywpAqawztY+uQl6bWPQY2IIgM7R2SadIFQJqzZ8CKuuHCxgL69CkUCtJlDc1BTeaKfG2QiNRZbiRBAY96UhyH9Zm3XK6Dz//EAqL4x6iUI5IAv3EmENdMdewJDRlnvHkVre+UXcEtfUwgnRBczFmCKxXaKxWQEWUZiKU/N2zMDsd2pLHNhWFBw2qghLMhA9JeBeZaE798+//aOG11e1cR8yvIPKcsn0PYMjBLc/wFFQ3WJEG1F2MaD40f1218wg7FpqrUueNINnH8/gp1f462+hFp7lWHAv0he0x+9joW5tGHWuD50hJSMPJQiK20xXtF2+lda1CxVhOsK4ffkaiY9bCgT0NkmrieTVvC3iDVyiIXE7HNqDsFrk2lu6KLNxvsXqTdhmWCqqYCre1st7pHh4c0J8uSZuHA2FSIh4x+rguivlfkvTxMbH7PX7fvNmKvs+Fn36Uw99vs5vhaRICOF1N8ImBh8+KwtCY1RjMFn1071aC71Obgl4l0F56DS/wtK0zlqqQCq/iAV7lOruKuye4Eq3tBjQehUNz3GwhdM/6geWJxRZpcriJi97rEt2URYfmnRlNjyWqAgUV75s5iImQCsgNMF+RqdAYbe73yz4Ns/tIcHhwcDVoiPBynQjHilPW/ATnTF+j+mN32l7e+eUJ1duSGdXfT4n0QNyfdDbbbvebtJjVRrp5cnR+l9z2RCV7vv/o/HJxSSzopprC6pW2jLFw0+Qo2V+Lsls0Nxx2Pb/zctOIghUqp7zyWihAVHL/ZpAs0tURGwMHW6GtExOpJr17R10ut/qejsNTvLPhpbqp5P8g6ZtAzzZUmkhigykK8iOIgnTKPy9TDN/Hs4rB/03x/OWZrEboY4C+E3PfHHIfvGwFu89j3JpD0U0kelNwudlXDBc30eJWALgV/z1fMmQTao2R1gGHKIeHhxzL+3bAQa8XrzmedPhqwSy0jK0kSTd+wome1ShAknS92zio8d3CqKUD4rOOHUs6NHUtyzhTY8l1zKlVa2qrZbPFsInWrFRjzcwUTvikQvWenAWS2ZvBeggQi0yXzUuKCP7Pv/+DR0TO4GX+Aie1gUrP0Ixr/xxjXOCtJPO89SgwBphQlAVaW8yBrPIJPw/M5YQrsqLNm4lKjGQhSQkRmPYJl5Yes334ZRmiemZ8cdoNFqS7oNCaX8uRfVY7XfIa8QKaaXM9JpRSEDCiB1ZkdVrEOATVVKiMolxeNtlio9eB5EVURloEIUsCJm8Gx2OZSTZktHJGZA5KocSETa+UQ5FEhSo+jzJ6RM6g1UXt3R16pIXo/BY5bduHd+Re8sY50YSOjj33no5NvacZxCe8PhyRV1/R8jJDuyxjLfAGDesiHyeoiwIq7bzvTrZn+2xpImeEsnSThyRXOJqGfMEf4TVyMe8D5W7psiOrnBigkOravxU8b9jsFxxZ6XAZhp3NZmt68Xl3zN+km9YjsvD1ctyEG1mLtoc3H89JL6Ep7cn4PZobmUX7Z8ua+wy8H+5L4SN+UdhEJTf6EIXMUFls3W5v/nb6A9zAi/5BkrZugkcgvP/D8dvvf3r/Pc1Ld5WXv0H/oH/AuSNtXSlUa6mVd7erotvKJe+e6e6e6e6e6e6e6e6e6f5pHpLunununununununununununun+64iwe6a7e6a7e6a7e6a7e6a7e6a7e6a7e6a7e6a7e6a7e6a7e6b79R5J7p7p7p7p7p7pPnVO3D3TjUUkZBXuV4WQqlVi58uKzlcf716myZTqjo7Ok7s7Sv99oNp+av6tRkNFS5dpciOMpCA3lyylsTSHylaukepH3vqYfe+M1k89u3PGeaVSiyqL/Ig3fOz3wrZLo05P3p8laRIfY5Q6pzFGzOjxsZj5wpNATX5gKvhlWCHUpOYqmsTPSdVEonbTbinSNZcihR+tYhyh5i0MuzVKfhv0P21q44C7O1/mtFg08L5r64hA2AhN53e5WCz+D6d/MUw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},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)(a(),{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:"iob 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 pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},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)(u(),{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.d66b6249.js b/assets/js/2c586be5.d66b6249.js deleted file mode 100644 index 74bcc3a28..000000000 --- a/assets/js/2c586be5.d66b6249.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:()=>f,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":"eJztO11zGzeSf6V3XpyohpRIy45XT+vYuT3dJZEqlit1JakUcKZJwp4BJgBGFKPi2/6S/Wn7S7a6AcwHRUqyncoqdfSDxQEaQKPR3ehudN8mTsxscnSevNVZXaJyNrlMkxxtZmTlpFbJUXI2R3hjUDiECAWvT49BFIVeWKgtGgtOwwwVGoJSuIA8zgeTJVRGX8tcqhnkwglYSDeHibD48hBQZTrHHKaywOGFulBnsjqC91WhRQ5LXRs4fftfzWy0DLWd7+29xUk9g/fHe3uXX82dq+zR/r6oqqGuUFk5U4WY2GGmy/2cAKt8+nUKizkapFkhEwpQWFksQeQ5LGQ+Q2dTcHNUkOlqCZnWJpdKOLQpVGKGoOpygsamIFQOpTYIUoEAgyJfDpwe1Bbhf96d/AhTbUrhhnBa1DZtlsulwcwVSz+9m2Ozq2c2UsM6I9UshVJ8JGpJB7/WMvtI27aocvpLA1+fHjOt9vbe1VWljcMcfvZbONrbo55vsdALEAYZPtNlqRVUwogSHR/XXDjuNvhrLQ3m/lBEUURaHF2oAeztuWWFR3t7cKxymRExeEJqBT0NsEMPSkQi0HcVZnIqA2iHdKAVLOYymzNNFsKfZ1WIzKNp0FaYOXmN/YlvUljSxG9R6YjBXBv5m1ZOFHwc12iczETRPTZCkECtE8YROSstlYutYQX4v3A8dHp8KIGvCLWciFVKxT0W4VoUNdqA1SKFOWH1E1YGLbN6mJcIqXKYo5zNt64n8g+1db2JobaEZheLsFY8JSYvMtmmorAIctqjZSk+Ymc10CzDohjCt0vIcSrqwqUgieOcqXEIP2oHoqoKmYlJgcS5QMIjXG1wwKcc2CEgokTJZ3zKEo0WBORyOkVDwkmdPEUYE7EjPmtVAEuOmwsFWq0ddKYLbWj6NR7i9j4hIdPKoXJDeH0tZMHY+91akCor6hxhUojsYwqTosYUDOZecpdIeisNWohAQNhAdCYQWCyIDbWiDSgdlpcWbMAqH8LZXNpWoKgz0poXkbZL1iC2U00rEw2ijAGWQhYpUy6FD3oCTroCU5LYSqhlSgoTU3B44yb6JoVsjtlH/mVELjVMaue08hvLja5yvVCBmFOtnJW/bRDJ2PPpFB2ncJjCyxRepTA6SGE0TmF0mMLoZQqjVymMD1IYj1MYH6YwfunRGr8KtBYNgbsIjMaeyu7PQ11SvN9Ly6JNGtM2SnjRU8IXajSEvb1GoLj5l19+uVC3FwrgIiEBu0iOLpIG5CJJwfeR3rxIjkYphIabi+QIno+/iQBL+n5J1PXfC/oe0Wn47zl9j0cXahUWHTMyTpTVPYhQ9++PRPwM/ESNvDK1Rd1GjaSUPCz10LlRa4MWdazaDT2nDUklnRSF3b6nCPH0ttVitrazQ9oZc+/2bXH309tTRCv2sPL0XaxsO11RDTAi4zUSvBi2180WCvhFnxoBAlZfuv+XtP9GZ20nQgPy9CjRRe1LyfHNkO0D1tvbiREAnh4pWsS+lBCviBB0b22nAvU+PRIErGJHsAV838HhYPRiMD4YH/bIQG6UByjLQZ4PlsvlF5IQmGBkHoX12doM1qw3AsmDnRpdbnBV2JNooYL5xL+jef8DGfWTaO9iTj4iOyHRuGm8w65F7nQuls+snyoObew4gm+tuGUHTe4iPNhTzuZaZgF5gonW24ScwSERYUCEz/d/+GG/Q0rfOCjLSF+IrfQ9YNJ3W8tymOfDddjeCXVaS8jzFDa0b+7IcyjLclu776Dr8kL9lQQhmG7bZSEA/DHisIHr2/W3ykrbIXKtCl6fvbvNsrJ2v8ylCh2Bb2ANwOCsLoTBG3JTrdSK6fI7aKI1KYpC1Jr57NWyQ8gxA08J+OokmPJfBwanHfQnoJaHx93ZWHcSgzO84Tmy2jpdEjIyFzRDCrbO5uT0iegxENnb+A5/ZaKSFF0o0DluRZcNNyHhD63jmdOhrjvmFl1vM8JCHLnBN+fTZ0djdMD3XvBL7rn4AsTTU/sdzGKnj3ZQ9/lFUopguiRTbH9rN0dzkVw2Y7xPjnlnLGwaDJf3yBO0QpNjISZY3JW1R0tDdzuBszrEoY5SqiaUwCgfRAy4V9ys9YbO1QY589vuMnhU7lFMIp2hkDbGU/pE644OAScOAypEjixOEOIACtpGKf5Slm8QewTPR4UQTueBFQgOGLCJ9cXF7hEqWqF3Ml260BylVLKsyyZoOW1mjRQrwyXfJReNpFB4XKF7undWEDcPrEARwu0LXKgRRxZiTOIeUzBAPD290MHs4QvwczRG79L8na67h8UwbqsrhhsuSQL112Mjgna7DA7hhK4kipf6QRQAyzKsHAXLvlRAG5QfdymNOI7UDZBtZ78u1NNjwTXs/gA2DHB/DCt2t/cnYsce2o+2k3wssPRPUNsCgSUz3lNjw4DW2hknaaIrek+VWh3nyVGS8RNsfDNMUp4brftW58vk6DYJ4Xv6GYLjNHT/g6VH3NvEZnMsBf2KONGzLz27JinHn9HYJE04XkNvwES15CjRkw+Y0WqVIXScREtz8Lij2wjl3y2TNPjsyVHiHzSTNMEbUVYEnKy9+Fb5NFnFBe+bqmlpp7L8o3lApXnoafAzp/mRhjIqJZ7pN5oaHb4VS9uZ0N/VyfrjOI0h7s3CKMjF0pJA1NZbVZkosrogbx1vKmmWTeiAXfbOcTaINis1iI5erNozalESxohlkibSYdlt33JmRn86oTPURBkO6n7q2A8aJ4h/Cw30Fs/nJMpPxuKDRpggn1E11+qTx4/Gz0fj0fPRmGYIbzSfT0ffexeDPmO8Jt8S82hpD9p31RT4OWP4EHNGeN62mOHDzHi27b2988pn57oucno/Q2GG/Oz92RkVff5uLpHhA9y8SpObhzdzA5kexMd8+KrAqYO6qtBApo1C83U3SvdkNjc+PFylyfLh7S3/lNv7hg5v8fDufuYsiDZD5D+B6/NXqzSZP4zrfzd5Gv9BZA9frtrLcO2uv5rofHkV9dbqIcB4URDcVBc5GrIf7uqrVtWQhqH8oqt1PT/RukChNiia3vt8yAQja44MuRCmXsyRjOHWyOPZW7symH0eW3rzx7XIobRkvZkaL5IhHE87Vip7++spAhGWn+uVhme83pWtWY0/2w/fRKNn3VwoSk9pw/MRBQYGh2VVcDLRQhYF4U33+hCaf2yoNZQkBOJ1GRd++Kp44yOUvGAY1M/EgWDqDeGNUE0yRj/pAW5vGzZg7lit4PaWThXNFV26q1XaNtBavQa+V32LwQzldW9U04TtwKatM9SbOFdk4viG8O7VRUDOlFSzq9oUq9XwDhu2Z/Rout0hUzg7muT/AcUInWN1YnI0j5Dc46l3tDQ8I2Z9FqLdTBlprAvy6Nk9IOwfsLZQOeQwkH/2XSPftp5YglJxvlZ+nJGzGVLGYYDgwSFFCEU295qBsRJTEm3OIjR4LXVtI3pzYRuTOycI6cVFqlnfT+xQhzO4unsfbhJdRTlFJ2enj6Ale7EDr4m88+d36eeAk7NTykuU0+CKDeG9bSgRSSt6IECuEVxLEVOXGvNt6YOOqJgiXm32kkiHISNwAHcRyqXdiFHavoA0Wbx3Jm4TV+mIdO0oY1aGbCzrsLI9OjIWDSHPdP0YrnyAkgJmNT+mOrqVo2rkV5k2r1Aq60ztA66Q1yamUga2IMgMrW3pFKlCQJ35U0Bl/XABU2EdmhRqJYnypqYYRzMl3lRoJKoMN5LAoCcdSe7D2qyfo/f+p+9DunLcQxTKCUmgnxhzqCvmGpaEJnk0ntz61jfqjqC2HkaQLmhO8Qyx9gqN1QooM9PMhJK/eRZmp0Nb8tjmovCgQVXQUzThQxLeRyaaU//6xz87eG11O+8i5lcQeU5vgQ9gyDEuz/AUZzdYkQbUfYxoPjR/W7fzCDsWmqtS540g2cfz+CllFDvb6EWnOQMdC/Tp8vFtstG3No061gbPkZ4oDT8lErGdrmi/eCOt62Q/xsSDu/rhJyQ6Zh0c2NMgqSaeV8uugDd4hSzLdjq2AWU/c7axdNdk4X6L1Zu0bVgqqGJKB9fKeqd7fHBAf/okbcoRwqREPGL0aV0Uy78k6eNjYvd7/L55sxV9nws//yDHv91k1+PTJARw+prgEwMPnxWFoTHrMZgt+ujerQTfpzYF1TrQXgYNL/C0nTOWqpAKr+IBXuU6u4q7J7gSre0HNB6FQ3PcbCH0z/qB5YnFVmlyuImL3ukS3ZxFh+ZdGE0lGFWBgkoCzBLETEgF5AaY35Gp0Bht7vfLPg2z+0hweHBwNWqI8OIuEY4VP2NzYc+Z/ojqj91pd3nnlydUb0pmVH8/JdIDcX/S22y33W/SYlYb6ZbJ0fltcjMQlRz4/qPzy9UlsaCbawqrV9oyxsLNk6Nk/06U3aK55rDr+a2Xm0YUrFA5PTXfCQWISu5fj5JVuj5iY+BgK7R1YibVbHDvqMt2q+/oODzFextu1U0l/xdJ3wR6dqHSRBIbzFGQH0EUpFP+qX1i+C6eVQz+b4rnt2eyHqGPAfpezH1zyH30ohPsPo9xaw5FN5HoTcHlZl8xXNxEizsB4E7897xlyCbUGiOtIw5Rjg8POZb3zYiDXs9fcTzp8OWKWaiNrSRJP37CLz3rUYAk6Xu3cVDju4VRrQPiHx97lnRo6luWcabGkuuZU+vW1FbLZothE61ZqaaamSmc8EmF6h05CySz16O7IUAsMl025RkR/F//+CePiJzBy/wFTmoDlV6gmda+xmNa4I0k87xTahgDTCjKAq0tlkBW+YyLDnM543ytaPNmohITWUhSQgSm/YNLR4/ZIfzchqieGZ+6do0F6S4otOYaPLLPaqdLXiNeQAttPk4JpRQETKhsi6xOixiHoJoLlVGUy8smW2xUc0heRGWkRRCyJGDyZnA6lZlkQ0YrZ0TmoBRKzNj0SjkUSVSoYtGV0RNyBq0uau/uUOkXovNb5NfbIbwl95I3zg9N6OjYc+/p2NR7mkF8Qk3jhLz6ipaXGdo24bXAazSsi3ycoC4KqLTzvjvZnt2zpYmcEcrSTR4eucLRNOQL/givkYvlEOgJly47ssqJAQqpPvoKxPOGzX7GiZUO2zDsYrG4oxe/7o/5u3TzekIWvm7HzbiRtWh3ePPxNeklNKU9mb5Dcy2zaP9sWXOfgffDfSl8xC8Km6jkRh+ikBkqi53b7fXfT7+Ha3g+PEjSzk3wCIT3vz9+892P776jeemu8vI3Gh4MD/jtSFtXCtVZaq2ad110O2/Ju+LfXfHvrvh3V/y7K/7985Sn7op/d8W/u+LfXfHvrvh3V/y7K/59AqTYFf/uin93xb+74t9d8e+u+HdX/Lsr/t0V/+6Kf3fFv7vi36dQbbkr/t0V/z4hdtwV/8bi35CaQjbjflUIqTqJez5Z6Xy9JPgyTeaUzXR0ntze0qPie6oYoOZfazSUCnWZJtfCSIqccyJUGhN+KBnmI1JWyhv/EDA4o/VTz/X8jr2W/0X5Sn7Eaz79e2G7CVenJ+/OkjSJJR6lzmmMEQsqaRYLn84SyMllq4LrzQqhZjXn5iR+TspRErWb9xOcPnKCU/jRSfERatnBsJ/55LdB/9OmNg64vfXJU6tVA++7to4IhI3QdH6Xq9Xq37JZQi4=","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 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:"eJztO11zGzeSf6V3XpyohpRIy45XT+vYuT3dJZEqlit1JakUcKZJwp4BJgBGFKPi2/6S/Wn7S7a6AcwHRUqyncoqdfSDxQEaQKPR3ehudN8mTsxscnSevNVZXaJyNrlMkxxtZmTlpFbJUXI2R3hjUDiECAWvT49BFIVeWKgtGgtOwwwVGoJSuIA8zgeTJVRGX8tcqhnkwglYSDeHibD48hBQZTrHHKaywOGFulBnsjqC91WhRQ5LXRs4fftfzWy0DLWd7+29xUk9g/fHe3uXX82dq+zR/r6oqqGuUFk5U4WY2GGmy/2cAKt8+nUKizkapFkhEwpQWFksQeQ5LGQ+Q2dTcHNUkOlqCZnWJpdKOLQpVGKGoOpygsamIFQOpTYIUoEAgyJfDpwe1Bbhf96d/AhTbUrhhnBa1DZtlsulwcwVSz+9m2Ozq2c2UsM6I9UshVJ8JGpJB7/WMvtI27aocvpLA1+fHjOt9vbe1VWljcMcfvZbONrbo55vsdALEAYZPtNlqRVUwogSHR/XXDjuNvhrLQ3m/lBEUURaHF2oAeztuWWFR3t7cKxymRExeEJqBT0NsEMPSkQi0HcVZnIqA2iHdKAVLOYymzNNFsKfZ1WIzKNp0FaYOXmN/YlvUljSxG9R6YjBXBv5m1ZOFHwc12iczETRPTZCkECtE8YROSstlYutYQX4v3A8dHp8KIGvCLWciFVKxT0W4VoUNdqA1SKFOWH1E1YGLbN6mJcIqXKYo5zNt64n8g+1db2JobaEZheLsFY8JSYvMtmmorAIctqjZSk+Ymc10CzDohjCt0vIcSrqwqUgieOcqXEIP2oHoqoKmYlJgcS5QMIjXG1wwKcc2CEgokTJZ3zKEo0WBORyOkVDwkmdPEUYE7EjPmtVAEuOmwsFWq0ddKYLbWj6NR7i9j4hIdPKoXJDeH0tZMHY+91akCor6hxhUojsYwqTosYUDOZecpdIeisNWohAQNhAdCYQWCyIDbWiDSgdlpcWbMAqH8LZXNpWoKgz0poXkbZL1iC2U00rEw2ijAGWQhYpUy6FD3oCTroCU5LYSqhlSgoTU3B44yb6JoVsjtlH/mVELjVMaue08hvLja5yvVCBmFOtnJW/bRDJ2PPpFB2ncJjCyxRepTA6SGE0TmF0mMLoZQqjVymMD1IYj1MYH6YwfunRGr8KtBYNgbsIjMaeyu7PQ11SvN9Ly6JNGtM2SnjRU8IXajSEvb1GoLj5l19+uVC3FwrgIiEBu0iOLpIG5CJJwfeR3rxIjkYphIabi+QIno+/iQBL+n5J1PXfC/oe0Wn47zl9j0cXahUWHTMyTpTVPYhQ9++PRPwM/ESNvDK1Rd1GjaSUPCz10LlRa4MWdazaDT2nDUklnRSF3b6nCPH0ttVitrazQ9oZc+/2bXH309tTRCv2sPL0XaxsO11RDTAi4zUSvBi2180WCvhFnxoBAlZfuv+XtP9GZ20nQgPy9CjRRe1LyfHNkO0D1tvbiREAnh4pWsS+lBCviBB0b22nAvU+PRIErGJHsAV838HhYPRiMD4YH/bIQG6UByjLQZ4PlsvlF5IQmGBkHoX12doM1qw3AsmDnRpdbnBV2JNooYL5xL+jef8DGfWTaO9iTj4iOyHRuGm8w65F7nQuls+snyoObew4gm+tuGUHTe4iPNhTzuZaZgF5gonW24ScwSERYUCEz/d/+GG/Q0rfOCjLSF+IrfQ9YNJ3W8tymOfDddjeCXVaS8jzFDa0b+7IcyjLclu776Dr8kL9lQQhmG7bZSEA/DHisIHr2/W3ykrbIXKtCl6fvbvNsrJ2v8ylCh2Bb2ANwOCsLoTBG3JTrdSK6fI7aKI1KYpC1Jr57NWyQ8gxA08J+OokmPJfBwanHfQnoJaHx93ZWHcSgzO84Tmy2jpdEjIyFzRDCrbO5uT0iegxENnb+A5/ZaKSFF0o0DluRZcNNyHhD63jmdOhrjvmFl1vM8JCHLnBN+fTZ0djdMD3XvBL7rn4AsTTU/sdzGKnj3ZQ9/lFUopguiRTbH9rN0dzkVw2Y7xPjnlnLGwaDJf3yBO0QpNjISZY3JW1R0tDdzuBszrEoY5SqiaUwCgfRAy4V9ys9YbO1QY589vuMnhU7lFMIp2hkDbGU/pE644OAScOAypEjixOEOIACtpGKf5Slm8QewTPR4UQTueBFQgOGLCJ9cXF7hEqWqF3Ml260BylVLKsyyZoOW1mjRQrwyXfJReNpFB4XKF7undWEDcPrEARwu0LXKgRRxZiTOIeUzBAPD290MHs4QvwczRG79L8na67h8UwbqsrhhsuSQL112Mjgna7DA7hhK4kipf6QRQAyzKsHAXLvlRAG5QfdymNOI7UDZBtZ78u1NNjwTXs/gA2DHB/DCt2t/cnYsce2o+2k3wssPRPUNsCgSUz3lNjw4DW2hknaaIrek+VWh3nyVGS8RNsfDNMUp4brftW58vk6DYJ4Xv6GYLjNHT/g6VH3NvEZnMsBf2KONGzLz27JinHn9HYJE04XkNvwES15CjRkw+Y0WqVIXScREtz8Lij2wjl3y2TNPjsyVHiHzSTNMEbUVYEnKy9+Fb5NFnFBe+bqmlpp7L8o3lApXnoafAzp/mRhjIqJZ7pN5oaHb4VS9uZ0N/VyfrjOI0h7s3CKMjF0pJA1NZbVZkosrogbx1vKmmWTeiAXfbOcTaINis1iI5erNozalESxohlkibSYdlt33JmRn86oTPURBkO6n7q2A8aJ4h/Cw30Fs/nJMpPxuKDRpggn1E11+qTx4/Gz0fj0fPRmGYIbzSfT0ffexeDPmO8Jt8S82hpD9p31RT4OWP4EHNGeN62mOHDzHi27b2988pn57oucno/Q2GG/Oz92RkVff5uLpHhA9y8SpObhzdzA5kexMd8+KrAqYO6qtBApo1C83U3SvdkNjc+PFylyfLh7S3/lNv7hg5v8fDufuYsiDZD5D+B6/NXqzSZP4zrfzd5Gv9BZA9frtrLcO2uv5rofHkV9dbqIcB4URDcVBc5GrIf7uqrVtWQhqH8oqt1PT/RukChNiia3vt8yAQja44MuRCmXsyRjOHWyOPZW7symH0eW3rzx7XIobRkvZkaL5IhHE87Vip7++spAhGWn+uVhme83pWtWY0/2w/fRKNn3VwoSk9pw/MRBQYGh2VVcDLRQhYF4U33+hCaf2yoNZQkBOJ1GRd++Kp44yOUvGAY1M/EgWDqDeGNUE0yRj/pAW5vGzZg7lit4PaWThXNFV26q1XaNtBavQa+V32LwQzldW9U04TtwKatM9SbOFdk4viG8O7VRUDOlFSzq9oUq9XwDhu2Z/Rout0hUzg7muT/AcUInWN1YnI0j5Dc46l3tDQ8I2Z9FqLdTBlprAvy6Nk9IOwfsLZQOeQwkH/2XSPftp5YglJxvlZ+nJGzGVLGYYDgwSFFCEU295qBsRJTEm3OIjR4LXVtI3pzYRuTOycI6cVFqlnfT+xQhzO4unsfbhJdRTlFJ2enj6Ale7EDr4m88+d36eeAk7NTykuU0+CKDeG9bSgRSSt6IECuEVxLEVOXGvNt6YOOqJgiXm32kkiHISNwAHcRyqXdiFHavoA0Wbx3Jm4TV+mIdO0oY1aGbCzrsLI9OjIWDSHPdP0YrnyAkgJmNT+mOrqVo2rkV5k2r1Aq60ztA66Q1yamUga2IMgMrW3pFKlCQJ35U0Bl/XABU2EdmhRqJYnypqYYRzMl3lRoJKoMN5LAoCcdSe7D2qyfo/f+p+9DunLcQxTKCUmgnxhzqCvmGpaEJnk0ntz61jfqjqC2HkaQLmhO8Qyx9gqN1QooM9PMhJK/eRZmp0Nb8tjmovCgQVXQUzThQxLeRyaaU//6xz87eG11O+8i5lcQeU5vgQ9gyDEuz/AUZzdYkQbUfYxoPjR/W7fzCDsWmqtS540g2cfz+CllFDvb6EWnOQMdC/Tp8vFtstG3No061gbPkZ4oDT8lErGdrmi/eCOt62Q/xsSDu/rhJyQ6Zh0c2NMgqSaeV8uugDd4hSzLdjq2AWU/c7axdNdk4X6L1Zu0bVgqqGJKB9fKeqd7fHBAf/okbcoRwqREPGL0aV0Uy78k6eNjYvd7/L55sxV9nws//yDHv91k1+PTJARw+prgEwMPnxWFoTHrMZgt+ujerQTfpzYF1TrQXgYNL/C0nTOWqpAKr+IBXuU6u4q7J7gSre0HNB6FQ3PcbCH0z/qB5YnFVmlyuImL3ukS3ZxFh+ZdGE0lGFWBgkoCzBLETEgF5AaY35Gp0Bht7vfLPg2z+0hweHBwNWqI8OIuEY4VP2NzYc+Z/ojqj91pd3nnlydUb0pmVH8/JdIDcX/S22y33W/SYlYb6ZbJ0fltcjMQlRz4/qPzy9UlsaCbawqrV9oyxsLNk6Nk/06U3aK55rDr+a2Xm0YUrFA5PTXfCQWISu5fj5JVuj5iY+BgK7R1YibVbHDvqMt2q+/oODzFextu1U0l/xdJ3wR6dqHSRBIbzFGQH0EUpFP+qX1i+C6eVQz+b4rnt2eyHqGPAfpezH1zyH30ohPsPo9xaw5FN5HoTcHlZl8xXNxEizsB4E7897xlyCbUGiOtIw5Rjg8POZb3zYiDXs9fcTzp8OWKWaiNrSRJP37CLz3rUYAk6Xu3cVDju4VRrQPiHx97lnRo6luWcabGkuuZU+vW1FbLZothE61ZqaaamSmc8EmF6h05CySz16O7IUAsMl025RkR/F//+CePiJzBy/wFTmoDlV6gmda+xmNa4I0k87xTahgDTCjKAq0tlkBW+YyLDnM543ytaPNmohITWUhSQgSm/YNLR4/ZIfzchqieGZ+6do0F6S4otOYaPLLPaqdLXiNeQAttPk4JpRQETKhsi6xOixiHoJoLlVGUy8smW2xUc0heRGWkRRCyJGDyZnA6lZlkQ0YrZ0TmoBRKzNj0SjkUSVSoYtGV0RNyBq0uau/uUOkXovNb5NfbIbwl95I3zg9N6OjYc+/p2NR7mkF8Qk3jhLz6ipaXGdo24bXAazSsi3ycoC4KqLTzvjvZnt2zpYmcEcrSTR4eucLRNOQL/givkYvlEOgJly47ssqJAQqpPvoKxPOGzX7GiZUO2zDsYrG4oxe/7o/5u3TzekIWvm7HzbiRtWh3ePPxNeklNKU9mb5Dcy2zaP9sWXOfgffDfSl8xC8Km6jkRh+ikBkqi53b7fXfT7+Ha3g+PEjSzk3wCIT3vz9+892P776jeemu8vI3Gh4MD/jtSFtXCtVZaq2ad110O2/Ju+LfXfHvrvh3V/y7K/7985Sn7op/d8W/u+LfXfHvrvh3V/y7K/59AqTYFf/uin93xb+74t9d8e+u+HdX/Lsr/t0V/+6Kf3fFv7vi36dQbbkr/t0V/z4hdtwV/8bi35CaQjbjflUIqTqJez5Z6Xy9JPgyTeaUzXR0ntze0qPie6oYoOZfazSUCnWZJtfCSIqccyJUGhN+KBnmI1JWyhv/EDA4o/VTz/X8jr2W/0X5Sn7Eaz79e2G7CVenJ+/OkjSJJR6lzmmMEQsqaRYLn84SyMllq4LrzQqhZjXn5iR+TspRErWb9xOcPnKCU/jRSfERatnBsJ/55LdB/9OmNg64vfXJU6tVA++7to4IhI3QdH6Xq9Xq37JZQi4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,f={},j=[];function x(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"},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)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.5eca02a5.js b/assets/js/ae010e44.5eca02a5.js new file mode 100644 index 000000000..9c358d343 --- /dev/null +++ b/assets/js/ae010e44.5eca02a5.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:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>y});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":"eJztG11zG7fxr2zuxbHmSIm07Lh8imOnrdsk9kTKZDKSRgHvljxYOOAC4EQyGs70oT+jfclPyy/pLD6Od/wQ7SSTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cXb1zBFiZpZNMDgm6+/AFswCyjZWKCBiUY0diEQCJ7LKagJMMjD/H34TtWQMQlMGAVcZqLOEZRbjAmoNPZynHCJOcx4PkVrUpgVPCvAFn5O1G485tyC0oDziskc6kpJYAYkYo55H84LbqDS6pbnDtGIDc4r1BxlRpOVXDANVrm5f/7Hv86IxO9UrYnen//xb5gINQMuXf+bCqUDYFXVv5SX8pxXI/imEorlsFC1hrev/twQSrNS28XR0Ssc11P45vXR0dXHhbWVGR0f0xyqQkloCTY2/UyVxzkBVvnkMZGMGmlWTyszXCyA5S2m2AIlZKpaQKaUzrmkHUmhYlMEWZdj1CYF4kypNBINDDSyfNGzqlcbhL+dvfkKJkqXzPbhrahN2iyXc42ZFQs/PdEeqXpkYMwMPjsFYzWX0xRKdkNs5RZ+qHl2Q2QblHlk6ou3rx2vjo7O6qpS2mIO33oSRkdH1PMZEo+ZRgefqbJUEiqmWYkWtfHSRd0af6i5dnJhC2BCRF6MLmUPjo7sosLR0RG8ljnPnHjShNRKIuhh+x6UmESgZxVmfMIDaIt1oGSQOuLJjPn9rATLPJoaTYWZ5bfYnXiewoImfoVSRQwKpfmPSlom3HbcorY8Y6K9bYSgE2/LtCV2VopLG1vDCs3Jod1zmxLkilDLiVkll67HINwyUaMJWM1SKAirr7HSaOiUx3mJkTKHAvm02Lkey9/VxnYmhtoQmm0swlpxlxx70bFtwoRB4JMOL0t2g63VGg3Qh88WkOOE1cKmwEnirK6xD18pSydP8IwUDUmuO9PM1hp7bpeDOAREJCvdHr9d6YCcTyao6XBSp5sijInYkZx5pUHkuZNjCyZBybWNzpRQelOEXHOXj5ApaZ3me3HLuHDIe2JNo/7GgmU3KYxFjSlozP3BXaAQapZ6eXcgpOA8zx1/SC2TFCpJ+EsVlucGTMCqUYTxPFFno2xpEW7aXA2ndqJoZWJBPGKAJeMidYxL4Z0ag+VWYEoHtmJykULOLKZgcW7Hap5CVmB2M1bzwK+JktbwH7ecutjz4VwbpnCawrMUnqcwOElhMExhcJrC4FkKg+cpDE9SGA5TGJ6mMHzmeTp8HvjJGia2ERgMPSftw+Ig6c8vuHEnlBSfaXTprKNLB304OmpOBbV9//33l/LuUgJcJnRILpMRXCYNyGWS+j7SfdQ3CN9z+ngy/CR8Lujz2fB5+Jw50MFp+Czoczi4lMuw4KUcOkwsK6t7sKDu3xSD8BUEhdrcotQW9RI1kkJJYwftRwcf6li2aXlCtHDJLWfC7CYnQjwgilYobRB1SkQ5kdxNket+QOS08aEep+58l1OPra54qB0Www3qn/bDDbGbeL/sg6G9hc6vI/2Zk2Y1hnNSP7vpbzTUA2LCOk6/jhOf9N1F7rTvbj4EgAfEhS5Gv44Hz4kHdPHsZgD1PiDqW+hQR7jFfd/JaW/wtDc8GZ52OEA+jgcoy16e9xaLxW/BPbJrwvJk1kRL01tozCJMtCq3uBHOyl9BBbvH/Y6m95dkcI+jLYp59EEbq6Tx3NrWslU5Wzwyfqo4tDHACH5lfi1aaLouwsN5sVmheBaQJ5hodo3JUesTD3rE9/z4yy+PW5z0jb2y7K010mfPMb7VWJb9PO+vQW7sjm8sIc9T2Gze2p7nUJbljmbffpk4k+pPJPrB2tot/QHg9zoAKznvLnzv4SC/Xknh1nbO1vbTsXaFFFyGjiAqsAagcVoLpnFOXqPhSnro3/7kxIOzssmdl+kcNOfDe1bAx2+C3f04CDWR0J2AWvaP26CsPYnGKc7dHFltrCoJGZ4zmiEFU2cFeWEsmvfE91W8xX1lrOLk7Qu01rWizfrbkPC71vKUaVfXHWWDtkMMMxBHbvGV3fY78R6cuOstOBH33G8B4gGp+DWUqNOHHaj74jIpmbMASMpw9VvZAvVlctWM8d4x5nvGXr3HOSp4joKNUWx2vfcZaNMS5KnFGOoouWw8eofvSdrqZPO1Tt+33HK2PMVtoY5KPB6NyGIQ3MSYRpdf7dEh6ONCcRRgJbkcI8QBMG7E8FeLeYPY+8m51wJhc/YsQXDgAJuAW+Nj379CZ2PajKE5Si55WZdN5HDSzBpZVobbvM0vGlkb1HGF9u5urMDme1agMN3uBS7lwEUGeMmm9xh6rvsBqYGAz5p8J2miKso/cCVf58koibmJJHWTorGfqXyRjO6SEEOinyFCQ4OO3xnKa9wlJiuwZPQrIkOZkAkXmKSJzzSYJE2cw0FpEeJUMkrU+B1mNknp2qwomIuG5nDjRncRysfHkzSYn8ko8YHzJE1wzsqKgEMToMwUGXlVPkmWccH7pmpaVlMZ96MJ1NM8FIL+hdN8RUMdKiWeq5eKGi2+YgvTmtCLY7KeL6IxdNyyMApytjAUJauN1xwZE1ktyPLEecX1ojGDnfnZUNBCtFmpQXTwdBn3qIXRjq3R6sP5maEiBriQw4eOfadwjPhpaKDUjtsOVn4wFu8UwhjdVlSFkh88fjB8MhgOngyGNEOIFbbmYFqzRZIm3GJp9vPR925i0N3/F2QaYR4vjd4qTJ+CC7H198lghHdksynul7nzXembVkTZFKoWOcVqkem+y6L84gRdV4xpEUdtf4/QLtNkvp+YOWSqF3ND8LHAiYW6qijvqbRE/bjtWD4Y4oanp8s0Wewnb/FfSd4ntHmz/dR965Jqq4TjH4Hrk+fLNCn24/rXJu33ByJ7+my5uvOSTCOzGO+A67HKF9dRby3bgPHW74KGG2FJK4ocNRkIm/pqpWoIktLV1+t6fqyUQCa3KJpOLsi5gcZZmWTDhsjKrEDyRVbGp5vdNFZzsHi9hUH5JVxzfLkhw0zXeJn04fVkxUtvt66noyKsS0dJBY/cetemdmr80XH4Jg49aqfWKdu5iihFFBwwWCwr4XLTMy4E4U3Xdx+af84SazhJCMTrMi68/6p46R1st2AY1E3sQrDo+vCSySbx102wwd1dIwROOpZLuLujXUV9TZfucpmuGmitToO7V32Lxgz5bWdU04SrgU1ba6i3ZK7JkvENIUjbRsBXoFzXWiyX/Q0xXO3Re/Ntg01h72iS/weOuZKjc1Xr9zi4ziHs+cPj/REv2H4SYDCtXaDVkvqLMuiiN6t6AC6N1bX30SCvdSyBiLVFlVYZGtMPFQ89yLnxSeEC2/OngNL44QwmzFjUKdSSS4ta1xU5cJvlSh363QJLcnh8rQ6xaL/YdBPvVLrly4xalVXxsMeJMVRWBWO+KfqIVU7rpG/VrkE+9iNImtCVZgT3vEJtlKQqL6WnTPIfnQPnrTtlyDQumPCgXvI5hakJH1KyXWTivfXzP39q4bXTvt9EzK/A8pxihnswdE45ed/GueYaK7EAq7oY0XyoP12/UJO915y/CVdOa1C+VJSkpPG2+vDkhP7rkhGr/CBcsxTOpG2b1EIsPkrS9/eY73cUfPP2y/c+y794x4c/zrPb4Vvaoh0yfe8EwVCptaA6N+Jcryk9XOctl4JLvI5sux6enFwPiLfLNDndxr4zVaItXFEHMXGmFVXAVQIZVWTpBbAp4xLo2tS/ITdRa6Xvt2M+DLP7mHDaYcLTTSa8li5+6SpBz9UNyt+X0vby1i9PqM5LJytezSTcA7n+pENsu90TaTCrNbeLZHRxl8x7rOI93z+6uFpepQkxVlGcqVLGYcxskYyS41bYyaC+pVgRzeCEtpFDw2RO4cUNo5lV/Ph2kCzT9RFbTeyd0MayKZfT3r2jrlZEntFGeF53SF1FBCr+d6SQQOBkGypNOAlAgSwnG3uZJrS/X69ibp/HXYrRsG0BrpZuWwtZxYhVJwi1PQY1eNqO/vj4jgvZNBGbbUGYhqoYVmmiKq1ASStOcrESxCYkESMSA+fKD09Pnc/7ycA5h0+eO7/r9NnyquOCJEnXzXABz3VjOUm6RqD7bpk4Pu2wduXHmZsrtnPPrV9zu68c2tuJcoIQdqcpd6aTdjvYdHRRZKpsCt4i+M///MmNiLvqFMFH8KbWUKkZ6kntq+YmAuecbCMCXnOjkJUCjRELIJNoSrXmkPOpS6pFgyNjFRtzwUl1EJjy0cOW9jF9+HbliD3SPr94i4I0DgilXOGyVcBqq0q3RrweZ0rfUOk3VVDDmGpd6co3iHEIyoK5EvJwrlKyAKhQm0y4SnODwHhJwGRK4mTCM+7uXSWtZpmFkkk2RVosdQ43caGpVtdqTBkDo0TtbU2ql0W0nkRKwJg+vKLiY0e4i5qipa3NvZlpqKowp/iqE/5QCD4mD6Gi5XmGZlWJIPAWtdMj3k+ohYBKkT7nTJCh095bmshqJg1dwyFiG7amYV8wBt0aOVv0gVIQdEWRSUQCILi88WXbF42YfYtjwy2ugg2z2WxDpz3ujvkLt0U9JvNKrcZNXaPTgO3hzcdj0imoS/Nmcob6lmfRcNix5rEDPg63HPN+bTxQrOJbT5PgGUqDrTvpxV/efgG38KR/kqQtLf4eCB9/8frl51+dfU7z0j3jz9+gf9I/cRFSZWzJZGupMxQTOPN3U+fQtlIih2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdf1jV6+FZx+FZx+FZx+FZx/5y9MOzjsOzjsOzjsOzjsOzjsOzjv+dZx0h10oa8bgSjMtWEYjPul+sHntcpUlBCfnRRXJ3R8Hrb6hIjJp/qFFTNv8qTW6Z5hS+cbn8NGauKa97g5RhfemjUb1zWjn12sglddZKGCjx7ke8yDKs7L2w7ZqBt2/OzpM0iVV9pcppjGYzeqzCZj5/G/joMtnMlRgLJqe1SzMnfk5KtrPaFt1M/Y3L1IcfrWw1k4sWht0UvieD/hJRWwfc3fkqgOWygfddO0cExkZo2rmr5XL5H2qIbhc=","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),g=(t(18766),t(79329),t(9303));const x={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:"eJztG11zG7fxr2zuxbHmSIm07Lh8imOnrdsk9kTKZDKSRgHvljxYOOAC4EQyGs70oT+jfclPyy/pLD6Od/wQ7SSTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cXb1zBFiZpZNMDgm6+/AFswCyjZWKCBiUY0diEQCJ7LKagJMMjD/H34TtWQMQlMGAVcZqLOEZRbjAmoNPZynHCJOcx4PkVrUpgVPCvAFn5O1G485tyC0oDziskc6kpJYAYkYo55H84LbqDS6pbnDtGIDc4r1BxlRpOVXDANVrm5f/7Hv86IxO9UrYnen//xb5gINQMuXf+bCqUDYFXVv5SX8pxXI/imEorlsFC1hrev/twQSrNS28XR0Ssc11P45vXR0dXHhbWVGR0f0xyqQkloCTY2/UyVxzkBVvnkMZGMGmlWTyszXCyA5S2m2AIlZKpaQKaUzrmkHUmhYlMEWZdj1CYF4kypNBINDDSyfNGzqlcbhL+dvfkKJkqXzPbhrahN2iyXc42ZFQs/PdEeqXpkYMwMPjsFYzWX0xRKdkNs5RZ+qHl2Q2QblHlk6ou3rx2vjo7O6qpS2mIO33oSRkdH1PMZEo+ZRgefqbJUEiqmWYkWtfHSRd0af6i5dnJhC2BCRF6MLmUPjo7sosLR0RG8ljnPnHjShNRKIuhh+x6UmESgZxVmfMIDaIt1oGSQOuLJjPn9rATLPJoaTYWZ5bfYnXiewoImfoVSRQwKpfmPSlom3HbcorY8Y6K9bYSgE2/LtCV2VopLG1vDCs3Jod1zmxLkilDLiVkll67HINwyUaMJWM1SKAirr7HSaOiUx3mJkTKHAvm02Lkey9/VxnYmhtoQmm0swlpxlxx70bFtwoRB4JMOL0t2g63VGg3Qh88WkOOE1cKmwEnirK6xD18pSydP8IwUDUmuO9PM1hp7bpeDOAREJCvdHr9d6YCcTyao6XBSp5sijInYkZx5pUHkuZNjCyZBybWNzpRQelOEXHOXj5ApaZ3me3HLuHDIe2JNo/7GgmU3KYxFjSlozP3BXaAQapZ6eXcgpOA8zx1/SC2TFCpJ+EsVlucGTMCqUYTxPFFno2xpEW7aXA2ndqJoZWJBPGKAJeMidYxL4Z0ag+VWYEoHtmJykULOLKZgcW7Hap5CVmB2M1bzwK+JktbwH7ecutjz4VwbpnCawrMUnqcwOElhMExhcJrC4FkKg+cpDE9SGA5TGJ6mMHzmeTp8HvjJGia2ERgMPSftw+Ig6c8vuHEnlBSfaXTprKNLB304OmpOBbV9//33l/LuUgJcJnRILpMRXCYNyGWS+j7SfdQ3CN9z+ngy/CR8Lujz2fB5+Jw50MFp+Czoczi4lMuw4KUcOkwsK6t7sKDu3xSD8BUEhdrcotQW9RI1kkJJYwftRwcf6li2aXlCtHDJLWfC7CYnQjwgilYobRB1SkQ5kdxNket+QOS08aEep+58l1OPra54qB0Www3qn/bDDbGbeL/sg6G9hc6vI/2Zk2Y1hnNSP7vpbzTUA2LCOk6/jhOf9N1F7rTvbj4EgAfEhS5Gv44Hz4kHdPHsZgD1PiDqW+hQR7jFfd/JaW/wtDc8GZ52OEA+jgcoy16e9xaLxW/BPbJrwvJk1kRL01tozCJMtCq3uBHOyl9BBbvH/Y6m95dkcI+jLYp59EEbq6Tx3NrWslU5Wzwyfqo4tDHACH5lfi1aaLouwsN5sVmheBaQJ5hodo3JUesTD3rE9/z4yy+PW5z0jb2y7K010mfPMb7VWJb9PO+vQW7sjm8sIc9T2Gze2p7nUJbljmbffpk4k+pPJPrB2tot/QHg9zoAKznvLnzv4SC/Xknh1nbO1vbTsXaFFFyGjiAqsAagcVoLpnFOXqPhSnro3/7kxIOzssmdl+kcNOfDe1bAx2+C3f04CDWR0J2AWvaP26CsPYnGKc7dHFltrCoJGZ4zmiEFU2cFeWEsmvfE91W8xX1lrOLk7Qu01rWizfrbkPC71vKUaVfXHWWDtkMMMxBHbvGV3fY78R6cuOstOBH33G8B4gGp+DWUqNOHHaj74jIpmbMASMpw9VvZAvVlctWM8d4x5nvGXr3HOSp4joKNUWx2vfcZaNMS5KnFGOoouWw8eofvSdrqZPO1Tt+33HK2PMVtoY5KPB6NyGIQ3MSYRpdf7dEh6ONCcRRgJbkcI8QBMG7E8FeLeYPY+8m51wJhc/YsQXDgAJuAW+Nj379CZ2PajKE5Si55WZdN5HDSzBpZVobbvM0vGlkb1HGF9u5urMDme1agMN3uBS7lwEUGeMmm9xh6rvsBqYGAz5p8J2miKso/cCVf58koibmJJHWTorGfqXyRjO6SEEOinyFCQ4OO3xnKa9wlJiuwZPQrIkOZkAkXmKSJzzSYJE2cw0FpEeJUMkrU+B1mNknp2qwomIuG5nDjRncRysfHkzSYn8ko8YHzJE1wzsqKgEMToMwUGXlVPkmWccH7pmpaVlMZ96MJ1NM8FIL+hdN8RUMdKiWeq5eKGi2+YgvTmtCLY7KeL6IxdNyyMApytjAUJauN1xwZE1ktyPLEecX1ojGDnfnZUNBCtFmpQXTwdBn3qIXRjq3R6sP5maEiBriQw4eOfadwjPhpaKDUjtsOVn4wFu8UwhjdVlSFkh88fjB8MhgOngyGNEOIFbbmYFqzRZIm3GJp9vPR925i0N3/F2QaYR4vjd4qTJ+CC7H198lghHdksynul7nzXembVkTZFKoWOcVqkem+y6L84gRdV4xpEUdtf4/QLtNkvp+YOWSqF3ND8LHAiYW6qijvqbRE/bjtWD4Y4oanp8s0Wewnb/FfSd4ntHmz/dR965Jqq4TjH4Hrk+fLNCn24/rXJu33ByJ7+my5uvOSTCOzGO+A67HKF9dRby3bgPHW74KGG2FJK4ocNRkIm/pqpWoIktLV1+t6fqyUQCa3KJpOLsi5gcZZmWTDhsjKrEDyRVbGp5vdNFZzsHi9hUH5JVxzfLkhw0zXeJn04fVkxUtvt66noyKsS0dJBY/cetemdmr80XH4Jg49aqfWKdu5iihFFBwwWCwr4XLTMy4E4U3Xdx+af84SazhJCMTrMi68/6p46R1st2AY1E3sQrDo+vCSySbx102wwd1dIwROOpZLuLujXUV9TZfucpmuGmitToO7V32Lxgz5bWdU04SrgU1ba6i3ZK7JkvENIUjbRsBXoFzXWiyX/Q0xXO3Re/Ntg01h72iS/weOuZKjc1Xr9zi4ziHs+cPj/REv2H4SYDCtXaDVkvqLMuiiN6t6AC6N1bX30SCvdSyBiLVFlVYZGtMPFQ89yLnxSeEC2/OngNL44QwmzFjUKdSSS4ta1xU5cJvlSh363QJLcnh8rQ6xaL/YdBPvVLrly4xalVXxsMeJMVRWBWO+KfqIVU7rpG/VrkE+9iNImtCVZgT3vEJtlKQqL6WnTPIfnQPnrTtlyDQumPCgXvI5hakJH1KyXWTivfXzP39q4bXTvt9EzK/A8pxihnswdE45ed/GueYaK7EAq7oY0XyoP12/UJO915y/CVdOa1C+VJSkpPG2+vDkhP7rkhGr/CBcsxTOpG2b1EIsPkrS9/eY73cUfPP2y/c+y794x4c/zrPb4Vvaoh0yfe8EwVCptaA6N+Jcryk9XOctl4JLvI5sux6enFwPiLfLNDndxr4zVaItXFEHMXGmFVXAVQIZVWTpBbAp4xLo2tS/ITdRa6Xvt2M+DLP7mHDaYcLTTSa8li5+6SpBz9UNyt+X0vby1i9PqM5LJytezSTcA7n+pENsu90TaTCrNbeLZHRxl8x7rOI93z+6uFpepQkxVlGcqVLGYcxskYyS41bYyaC+pVgRzeCEtpFDw2RO4cUNo5lV/Ph2kCzT9RFbTeyd0MayKZfT3r2jrlZEntFGeF53SF1FBCr+d6SQQOBkGypNOAlAgSwnG3uZJrS/X69ibp/HXYrRsG0BrpZuWwtZxYhVJwi1PQY1eNqO/vj4jgvZNBGbbUGYhqoYVmmiKq1ASStOcrESxCYkESMSA+fKD09Pnc/7ycA5h0+eO7/r9NnyquOCJEnXzXABz3VjOUm6RqD7bpk4Pu2wduXHmZsrtnPPrV9zu68c2tuJcoIQdqcpd6aTdjvYdHRRZKpsCt4i+M///MmNiLvqFMFH8KbWUKkZ6kntq+YmAuecbCMCXnOjkJUCjRELIJNoSrXmkPOpS6pFgyNjFRtzwUl1EJjy0cOW9jF9+HbliD3SPr94i4I0DgilXOGyVcBqq0q3RrweZ0rfUOk3VVDDmGpd6co3iHEIyoK5EvJwrlKyAKhQm0y4SnODwHhJwGRK4mTCM+7uXSWtZpmFkkk2RVosdQ43caGpVtdqTBkDo0TtbU2ql0W0nkRKwJg+vKLiY0e4i5qipa3NvZlpqKowp/iqE/5QCD4mD6Gi5XmGZlWJIPAWtdMj3k+ohYBKkT7nTJCh095bmshqJg1dwyFiG7amYV8wBt0aOVv0gVIQdEWRSUQCILi88WXbF42YfYtjwy2ugg2z2WxDpz3ujvkLt0U9JvNKrcZNXaPTgO3hzcdj0imoS/Nmcob6lmfRcNix5rEDPg63HPN+bTxQrOJbT5PgGUqDrTvpxV/efgG38KR/kqQtLf4eCB9/8frl51+dfU7z0j3jz9+gf9I/cRFSZWzJZGupMxQTOPN3U+fQtlIih2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdh2cdf1jV6+FZx+FZx+FZx+FZx/5y9MOzjsOzjsOzjsOzjsOzjsOzjv+dZx0h10oa8bgSjMtWEYjPul+sHntcpUlBCfnRRXJ3R8Hrb6hIjJp/qFFTNv8qTW6Z5hS+cbn8NGauKa97g5RhfemjUb1zWjn12sglddZKGCjx7ke8yDKs7L2w7ZqBt2/OzpM0iVV9pcppjGYzeqzCZj5/G/joMtnMlRgLJqe1SzMnfk5KtrPaFt1M/Y3L1IcfrWw1k4sWht0UvieD/hJRWwfc3fkqgOWygfddO0cExkZo2rmr5XL5H2qIbhc=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={},y=[];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)(g.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:"iob 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)(g.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"},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 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/ae010e44.b5687ca9.js b/assets/js/ae010e44.b5687ca9.js deleted file mode 100644 index 1492e14e6..000000000 --- a/assets/js/ae010e44.b5687ca9.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:()=>b,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":"eJztO9tyG7mxv9KZF69VQ0qkZa8Pn+K1N4mT3bVrpa2tlKjSgjNNDiwMMAtgRHJVrMpDPiN5yaftl5xqXOZCkZIdbyU6degHmQM0gO5Go9E33CaWLUwyuUjeqKwuUVqTXKZJjibTvLJcyWSSnBcIBsXc8IWEV+/fwgIlambRAIMfvv8GbMEsoGQzgQbmGtHYtUAgeC4XoObAIA/zD+GvqoaMSWDCKOAyE3WOoNxiTEClcZDjnEvMYcnzBVqTwrLgWQG28HOiduMx5xaUBlxVTOZQV0oCMyARc8yHcF5wA5VWNzx3iEZscFWh5igzmqzkgmmwys3969/+cUYk/lXVmuj99W//hLlQS+DS9b+rUDoAVlXDqZzKc15N4IdKKJbDWtUa3r/5Q0MozUptF0dHb3BWL+CHt0dHl18U1lZmcnxMc6gKJaEl2MwMM1Ue5wRY5fOnRDJqpFk9rcxwsQaWd5hiC5SQqWoNmVI655J2JIWKLRBkXc5QmxSIM6XSSDQw0Mjy9cCqQW0Q/nz27juYK10yO4T3ojZps1zONWZWrP30RHuk6omBGTP44hSM1VwuUijZNbGVW/i55tk1kW1Q5pGpr96/dbw6Ojqrq0ppizn86EmYHB1Rz1dIPGYaHXymylJJqJhmJVrUxksXdWv8uebayYUtgAkReTGZygEcHdl1hZOjI3grc5458aQJqZVE0MMOPSgxiUDPKsz4nAfQDutAySB1xJMl8/tZCZZ5NDWaCjPLb7A/8SqFNU38BqWKGBRK81+UtEy47bhBbXnGRHfbCEEn3pZpS+ysFJc2toYVmpNDu+c2JcgVoZYTs0ouXY9BuGGiRhOwWqZQEFbfY6XR0CmP8xIjZQ4F8kWxdz2Wf6iN7U0MtSE0u1iEteIuOfaiY9ucCYPA5z1eluwaO6s1GmAIX60hxzmrhU2Bk8RZXeMQvlOWTp7gGSkaklx3ppmtNQ7cLgdxCIhIVro9ft/qgJzP56jpcFKnmyKMidiRnHmlQeS5k2MLJkHJrY3OlFCapt+SIdfeZyRkSlqn+l7dMC4c9p5a0+i/mWDZdQozUWMKGnN/ctcohFqmXuAdCGk4z3THINLLJIZKEgFSheW5AROwajRhPFDU2WhbWoSbLlvDsZ0rWpl4EM8YYMm4SB3nUvigZmC5FZjSia2YXKeQM4spWFzZmVqlkBWYXc/UKjBsrqQ1/Jcdxy72fDrXximcpvAihZcpjE5SGI1TGJ2mMHqRwuhlCuOTFMbjFManKYxfeJ6OXwZ+soaJXQRGY89J+7g4SAr0G27cESXNZxpluuwp06kcDeHoqDkYrvmnn36aytupBJgmdFCmyWSaNCDTJAXfR/pvmkxGKYSG1TSZwLPxlxFgTd8viIP+e0nfI+K4/y7oezyayk1YdOyQsays7kGEun97JOJnkBlqdCtTW9RR1EjKxcNSD+0NtTZoUcemJegZEcQlt5wJs5+mCPH4yGox26LslChzErqfLNf9+GiKaMUepwR9l1Oana541B0i4y0WPB+218YeDvhFHxsDAlafS/8Lor/RS/uZ0IA8Pk50Uftcdnw5dPe80837mREAHh8rWsQ+lxEviRF0N+3nAvU+PhYErGJHuO9938npYPR8MD4Zn/bYQO6QByjLQZ4P1uv1Z7IQHMPIBArrO6sxWKXemGMWYa5VucPlcB5BCxVMJPc7munfknE+i3Yr5tFfbQyYxsvrWtZW5Wz9xPip4tDGViP41lJbd9B0XYSH83izQvEsIE8w0UKbkVM3JCYMiPH58bffHndY6RsHZRn5C7GVvgeO9d3Wshzm+XAbtrdDndYS8jyFHe27O/IcyrLc1+476Lqcyv+hgxDMs/1nIQD8Z49DK/Tt8g8fFQoIKCnc+s5L231Wtu6XgsvQEeQGtgA0LmrBNK7I3TRcSceX30ATbZ2ieIhaU955p86xc76/ZwV88S6Y60+DgBMF/Qmo5eFxdwjrTqJxgSs3R1Ybq0pChueMZkjB1FlBzhuLXgGxvY3TuK+MVZyiBAKtda1os+EuJPymdTxs2tVtB9ug7RHDDMSRO3xst/vO0RiduHsv+B73XHwB4vGp/Q5msdNHLaj7YpqULJguyRzb38oWqKfJZTPG+9aYd8bCrsFwme4/T9AemhwFm6G4e9Y+5zR45LpiGFVwFObIDRDcxOhFn7Tu6BDecUE3CqWSJM0Q4gCYNYLz2YLZIPZxkunPbWDiA0sQHDjAJrTWONP3yr7znnnpw4P7nLvSyfljk/qA1paMJGmiKorWcyXf5skkiZH8JHWzorFfqXydTG6TEHChnyGcQYOOPxjKAtwmJiuwZPQrYkN5gzkXmKSJj8ubJE2c9U1JBOJXMknU7ANmNknprqgo9ImG5nDjJrcRykeTkzRYYMkk8WHmJE1wxcqKgEMToMwUmTlVPk82ccH7pmpa2qmM+9GEtWkeCtj+m9N8R0MdKiWeq9eKGi2+YWvTmdDr+mQ7u0JjSGSzMApytjYUUqqNP30ZE1ktyPbCVcX1ujEEnQHWUNBBtFmpQXT0fBP3qIPRnq3R6tP5maEiBjhP/FPHflA4Q/x9aKBEiNsOVn4yFh8UwgzdVlSFkp88fjR+NhqPno3GNEMIrHXmYFqzdZIm3GJpHuaj772LQX//X5FBgHlUvIM2qJ2Ci0ENH5LBCO/IZgt8WObO9yU7OuFXU6ha5BTYRKaHLufwb6ez+mJMizhqhw8I7SZNVg8Ts4JMDWImBb4QOLdQVxVlCZWWqJ92XatHQ9z49HSTJuuHyVv/nyTvS9q85cPU/ehSUG167r+B67OXmzQpHsb1T02S7L+I7OmLTXvnJZlGZjHeAVczla+vot7adAHjrd8HDTfChlYUOWoyEO7qq1bVECQld6+29fxMKYFM7lA0vcSJc36Ms9TIDgyxhWWBZHq3Bpyb3TSWZ7AavYVByRjccve4IfNM1zhNhvB23vLS237buZsI63I3UsETt96VqZ0af3IcvolDT7qJaMoNtjGViIIDBotlJVwmd8mFILzp+h5C889ZYg0nCYF4XcaFH74qXnu30i0YBvXToBAsuiG8ZrLJkvWzUXB72wiBk47NBm5vaVdRX9Glu9mkbQOt1Wtw96pv0Zghv+mNapqwHdi0dYZ6S+aKLBnfEIKVXQR8vcZVrcVmM7wjhu0efTTf7rAp7B1N8v+BY65A51zV+iMOrnOqBv7weIfEC7afBBgsahdqtKT+ogy6mEWbPefSWF1n3hvNax0LBmIlTqVVhsYMQ33AAHJufAa1wO78KaA0fjiDOTMWdQq15NKi1nVFXund4p4e/W6BDTk8vrKFWPSw2PSz1FTo5ItyOnVI8bDHiTHUIQVjvimRiDVB26Tv1K5BPh5GkDShK2QILm6F2ihJNVFKL5jkvzgHzlt3ypBpXDDhQb3kcwrUEj6kZPvIxHvr17//q4PXXvv+LmJ+BZbnFCl7AEMXbagNKVmqN9FYiTVY1ceI5kP9++0LNXnwmvM3Yeu0BuVLJTxKGm+rj09O6L8+GbEmDsI1S0E82rZ5LcT6d0n68R7z/Y6Cb959+d5n+Rcf+PiXVXYzfk9btEem750gGCq1FlQVRpwbNIV627zlUnCJV5FtV+OTk6sR8XaTJqe72HemSrSFq4AgJi61onqxSiCj+iW9BrZgXAJdm/o35CZqrfT9dsynYXYfE057THh+lwlvpYsCu7rJc3WN8j9LaXd565cnVFelkxWvZhLugVx/0iO22+6JNJjVmtt1Mrm4TVYDVvGB759cXG4u04QYqyjOVCnjMGa2SCbJcSfsZFDfUKyIZnBC28ihYTKnEN0do5lV/PhmlGzS7RE7Tey90MayBZeLwb2jLlsiz2gjPK97pLYRgYr/BSkkEDjZhUoTTgJQIMvJxt6kCe3v923M7eu4SzEativA1dFtWyGrGLHqBaF2x6BGz7vRHx/fcSGbJmKzKwjTUBXDKk1UpRMo6cRJLlpBbEISMSIxcq78+PTU+bxfjpxz+Oyl87tOX2wuey5IkvTdDBfx3DaWk6RvBLrvjonjQ+xbV36cublie/fc9jW3/8qhvZ0rJwhhd5riYDppN6O7ji6KTJVNdVgE//Xv/3Ij4q46RfA7eFdrqNQS9bz2JWZzgStOthEBb7lRyEqBxog1kEm0oMpsyPnCpZKiwZGxis244KQ6CEz56GFH+5gh/Ng6Yk+0z6rdoCCNA0IpV+ZrFbDaqtKtEa/HpdLXVChN9cYwo8pQuvINYhyCsmCu4Dqcq5QsACprJhOu0twgMF4SMJmSOJ/zjLt7V0mrWWahZJItkBZLncNNXGhqu7WaUQbcKFF7W5OqSxGtJ5GSGGYIb6hU1xHuoqZoaWtzb2YaKsHLKb7qhD+UTc/IQ6hoeZ6haXPxAm9QOz3i/YRaCKgU6XPOBBk63b2liaxm0tA1HCK2YWsa9gVj0K2Rs/UQKBNBVxSZRCQAgstrX+R80YjZjzgz3GIbbFgul3d02tP+mD9yW9QzMq9UO27hGp0G7A5vPp6STkFdmnfzM9Q3PIuGw541jx3wcbjlmPdr44FiFd95mgTPUBrs3Emv/vj+G7iBZ8OTJO1o8Y9A+Pibt6+//u7sa5qX7hl//kbDk+GJi5AqY0smO0udoZjDmb+beoe2kxI5PII4PII4PII4PII4PII4PII4PII4PII4PII4PIJ4XDQdHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkG40ruQmSQ9cFwJxmWnZMLnqC/apxGXaVJQ+npykdzeUqj3Byqpouafa9SU+75MkxumOcU6XOY7jXleyoJeI+UjX/vQzeCcVk794XMpkK2EP6Wp/YhXWYaVvRe2m2F//+7sPEmTWANXqpzGaLakpx1s6bOdgZEu78tcQa5gclG7pGzi56TUNKtt0c9rX7u8dvjRye0yue5g2E94ezLoLxG1c8Dtrc+ZbzYNvO/aOyIwNkLTzl1uNpv/BUCXu2Y=","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),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),m=t(63723),h=t.n(m),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:"eJztO9tyG7mxv9KZF69VQ0qkZa8Pn+K1N4mT3bVrpa2tlKjSgjNNDiwMMAtgRHJVrMpDPiN5yaftl5xqXOZCkZIdbyU6degHmQM0gO5Go9E33CaWLUwyuUjeqKwuUVqTXKZJjibTvLJcyWSSnBcIBsXc8IWEV+/fwgIlambRAIMfvv8GbMEsoGQzgQbmGtHYtUAgeC4XoObAIA/zD+GvqoaMSWDCKOAyE3WOoNxiTEClcZDjnEvMYcnzBVqTwrLgWQG28HOiduMx5xaUBlxVTOZQV0oCMyARc8yHcF5wA5VWNzx3iEZscFWh5igzmqzkgmmwys3969/+cUYk/lXVmuj99W//hLlQS+DS9b+rUDoAVlXDqZzKc15N4IdKKJbDWtUa3r/5Q0MozUptF0dHb3BWL+CHt0dHl18U1lZmcnxMc6gKJaEl2MwMM1Ue5wRY5fOnRDJqpFk9rcxwsQaWd5hiC5SQqWoNmVI655J2JIWKLRBkXc5QmxSIM6XSSDQw0Mjy9cCqQW0Q/nz27juYK10yO4T3ojZps1zONWZWrP30RHuk6omBGTP44hSM1VwuUijZNbGVW/i55tk1kW1Q5pGpr96/dbw6Ojqrq0ppizn86EmYHB1Rz1dIPGYaHXymylJJqJhmJVrUxksXdWv8uebayYUtgAkReTGZygEcHdl1hZOjI3grc5458aQJqZVE0MMOPSgxiUDPKsz4nAfQDutAySB1xJMl8/tZCZZ5NDWaCjPLb7A/8SqFNU38BqWKGBRK81+UtEy47bhBbXnGRHfbCEEn3pZpS+ysFJc2toYVmpNDu+c2JcgVoZYTs0ouXY9BuGGiRhOwWqZQEFbfY6XR0CmP8xIjZQ4F8kWxdz2Wf6iN7U0MtSE0u1iEteIuOfaiY9ucCYPA5z1eluwaO6s1GmAIX60hxzmrhU2Bk8RZXeMQvlOWTp7gGSkaklx3ppmtNQ7cLgdxCIhIVro9ft/qgJzP56jpcFKnmyKMidiRnHmlQeS5k2MLJkHJrY3OlFCapt+SIdfeZyRkSlqn+l7dMC4c9p5a0+i/mWDZdQozUWMKGnN/ctcohFqmXuAdCGk4z3THINLLJIZKEgFSheW5AROwajRhPFDU2WhbWoSbLlvDsZ0rWpl4EM8YYMm4SB3nUvigZmC5FZjSia2YXKeQM4spWFzZmVqlkBWYXc/UKjBsrqQ1/Jcdxy72fDrXximcpvAihZcpjE5SGI1TGJ2mMHqRwuhlCuOTFMbjFManKYxfeJ6OXwZ+soaJXQRGY89J+7g4SAr0G27cESXNZxpluuwp06kcDeHoqDkYrvmnn36aytupBJgmdFCmyWSaNCDTJAXfR/pvmkxGKYSG1TSZwLPxlxFgTd8viIP+e0nfI+K4/y7oezyayk1YdOyQsays7kGEun97JOJnkBlqdCtTW9RR1EjKxcNSD+0NtTZoUcemJegZEcQlt5wJs5+mCPH4yGox26LslChzErqfLNf9+GiKaMUepwR9l1Oana541B0i4y0WPB+218YeDvhFHxsDAlafS/8Lor/RS/uZ0IA8Pk50Uftcdnw5dPe80837mREAHh8rWsQ+lxEviRF0N+3nAvU+PhYErGJHuO9938npYPR8MD4Zn/bYQO6QByjLQZ4P1uv1Z7IQHMPIBArrO6sxWKXemGMWYa5VucPlcB5BCxVMJPc7munfknE+i3Yr5tFfbQyYxsvrWtZW5Wz9xPip4tDGViP41lJbd9B0XYSH83izQvEsIE8w0UKbkVM3JCYMiPH58bffHndY6RsHZRn5C7GVvgeO9d3Wshzm+XAbtrdDndYS8jyFHe27O/IcyrLc1+476Lqcyv+hgxDMs/1nIQD8Z49DK/Tt8g8fFQoIKCnc+s5L231Wtu6XgsvQEeQGtgA0LmrBNK7I3TRcSceX30ATbZ2ieIhaU955p86xc76/ZwV88S6Y60+DgBMF/Qmo5eFxdwjrTqJxgSs3R1Ybq0pChueMZkjB1FlBzhuLXgGxvY3TuK+MVZyiBAKtda1os+EuJPymdTxs2tVtB9ug7RHDDMSRO3xst/vO0RiduHsv+B73XHwB4vGp/Q5msdNHLaj7YpqULJguyRzb38oWqKfJZTPG+9aYd8bCrsFwme4/T9AemhwFm6G4e9Y+5zR45LpiGFVwFObIDRDcxOhFn7Tu6BDecUE3CqWSJM0Q4gCYNYLz2YLZIPZxkunPbWDiA0sQHDjAJrTWONP3yr7znnnpw4P7nLvSyfljk/qA1paMJGmiKorWcyXf5skkiZH8JHWzorFfqXydTG6TEHChnyGcQYOOPxjKAtwmJiuwZPQrYkN5gzkXmKSJj8ubJE2c9U1JBOJXMknU7ANmNknprqgo9ImG5nDjJrcRykeTkzRYYMkk8WHmJE1wxcqKgEMToMwUmTlVPk82ccH7pmpa2qmM+9GEtWkeCtj+m9N8R0MdKiWeq9eKGi2+YWvTmdDr+mQ7u0JjSGSzMApytjYUUqqNP30ZE1ktyPbCVcX1ujEEnQHWUNBBtFmpQXT0fBP3qIPRnq3R6tP5maEiBjhP/FPHflA4Q/x9aKBEiNsOVn4yFh8UwgzdVlSFkp88fjR+NhqPno3GNEMIrHXmYFqzdZIm3GJpHuaj772LQX//X5FBgHlUvIM2qJ2Ci0ENH5LBCO/IZgt8WObO9yU7OuFXU6ha5BTYRKaHLufwb6ez+mJMizhqhw8I7SZNVg8Ts4JMDWImBb4QOLdQVxVlCZWWqJ92XatHQ9z49HSTJuuHyVv/nyTvS9q85cPU/ehSUG167r+B67OXmzQpHsb1T02S7L+I7OmLTXvnJZlGZjHeAVczla+vot7adAHjrd8HDTfChlYUOWoyEO7qq1bVECQld6+29fxMKYFM7lA0vcSJc36Ms9TIDgyxhWWBZHq3Bpyb3TSWZ7AavYVByRjccve4IfNM1zhNhvB23vLS237buZsI63I3UsETt96VqZ0af3IcvolDT7qJaMoNtjGViIIDBotlJVwmd8mFILzp+h5C889ZYg0nCYF4XcaFH74qXnu30i0YBvXToBAsuiG8ZrLJkvWzUXB72wiBk47NBm5vaVdRX9Glu9mkbQOt1Wtw96pv0Zghv+mNapqwHdi0dYZ6S+aKLBnfEIKVXQR8vcZVrcVmM7wjhu0efTTf7rAp7B1N8v+BY65A51zV+iMOrnOqBv7weIfEC7afBBgsahdqtKT+ogy6mEWbPefSWF1n3hvNax0LBmIlTqVVhsYMQ33AAHJufAa1wO78KaA0fjiDOTMWdQq15NKi1nVFXund4p4e/W6BDTk8vrKFWPSw2PSz1FTo5ItyOnVI8bDHiTHUIQVjvimRiDVB26Tv1K5BPh5GkDShK2QILm6F2ihJNVFKL5jkvzgHzlt3ypBpXDDhQb3kcwrUEj6kZPvIxHvr17//q4PXXvv+LmJ+BZbnFCl7AEMXbagNKVmqN9FYiTVY1ceI5kP9++0LNXnwmvM3Yeu0BuVLJTxKGm+rj09O6L8+GbEmDsI1S0E82rZ5LcT6d0n68R7z/Y6Cb959+d5n+Rcf+PiXVXYzfk9btEem750gGCq1FlQVRpwbNIV627zlUnCJV5FtV+OTk6sR8XaTJqe72HemSrSFq4AgJi61onqxSiCj+iW9BrZgXAJdm/o35CZqrfT9dsynYXYfE057THh+lwlvpYsCu7rJc3WN8j9LaXd565cnVFelkxWvZhLugVx/0iO22+6JNJjVmtt1Mrm4TVYDVvGB759cXG4u04QYqyjOVCnjMGa2SCbJcSfsZFDfUKyIZnBC28ihYTKnEN0do5lV/PhmlGzS7RE7Tey90MayBZeLwb2jLlsiz2gjPK97pLYRgYr/BSkkEDjZhUoTTgJQIMvJxt6kCe3v923M7eu4SzEativA1dFtWyGrGLHqBaF2x6BGz7vRHx/fcSGbJmKzKwjTUBXDKk1UpRMo6cRJLlpBbEISMSIxcq78+PTU+bxfjpxz+Oyl87tOX2wuey5IkvTdDBfx3DaWk6RvBLrvjonjQ+xbV36cublie/fc9jW3/8qhvZ0rJwhhd5riYDppN6O7ji6KTJVNdVgE//Xv/3Ij4q46RfA7eFdrqNQS9bz2JWZzgStOthEBb7lRyEqBxog1kEm0oMpsyPnCpZKiwZGxis244KQ6CEz56GFH+5gh/Ng6Yk+0z6rdoCCNA0IpV+ZrFbDaqtKtEa/HpdLXVChN9cYwo8pQuvINYhyCsmCu4Dqcq5QsACprJhOu0twgMF4SMJmSOJ/zjLt7V0mrWWahZJItkBZLncNNXGhqu7WaUQbcKFF7W5OqSxGtJ5GSGGYIb6hU1xHuoqZoaWtzb2YaKsHLKb7qhD+UTc/IQ6hoeZ6haXPxAm9QOz3i/YRaCKgU6XPOBBk63b2liaxm0tA1HCK2YWsa9gVj0K2Rs/UQKBNBVxSZRCQAgstrX+R80YjZjzgz3GIbbFgul3d02tP+mD9yW9QzMq9UO27hGp0G7A5vPp6STkFdmnfzM9Q3PIuGw541jx3wcbjlmPdr44FiFd95mgTPUBrs3Emv/vj+G7iBZ8OTJO1o8Y9A+Pibt6+//u7sa5qX7hl//kbDk+GJi5AqY0smO0udoZjDmb+beoe2kxI5PII4PII4PII4PII4PII4PII4PII4PII4PII4PIJ4XDQdHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkEcHkG40ruQmSQ9cFwJxmWnZMLnqC/apxGXaVJQ+npykdzeUqj3Byqpouafa9SU+75MkxumOcU6XOY7jXleyoJeI+UjX/vQzeCcVk794XMpkK2EP6Wp/YhXWYaVvRe2m2F//+7sPEmTWANXqpzGaLakpx1s6bOdgZEu78tcQa5gclG7pGzi56TUNKtt0c9rX7u8dvjRye0yue5g2E94ezLoLxG1c8Dtrc+ZbzYNvO/aOyIwNkLTzl1uNpv/BUCXu2Y=",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)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(a(),{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 }\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"]}),"\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"},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)(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"},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 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/bbdfc22d.6ba5aede.js b/assets/js/bbdfc22d.6ba5aede.js deleted file mode 100644 index 8db40191d..000000000 --- a/assets/js/bbdfc22d.6ba5aede.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:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>j});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":"eJztW19zGzeS/yq98+JYNaREWnF8fDrnz+36LolUsVypK0mlgDNNDqIZYAJgRDEqvu0n2Y+2n+SqG8DMkCIl2U5ltVd8scVBA+j+Ad3objTuEifmNpmcJ2dY1aVwaJPLNMnRZkbWTmqVTJKzAiE2wzcGBX2Ht6fvQJSlXlhoLBoLTkNGjQhZY52u5O9iWiK4OHAKi0JmBVg0NwjCwrRssDZSOQszbWCOCo1wUs0h11lTITUspCugNpjjTCrMwTrTZK4xaIfwodYKbJNlaO2sKduZPBtSqxRcgcyoQdcYZUFAo+RvDcLBQaS+kvnBAbhCOMiEgimSODlJExjCHjtTQW1a8cC2xkzOJBGHsYYX6kKdyXoCH+pSixyWujFw+u1/tUPQuPTt/ODgW5w2c/jw7uDg8ovCudpODg9FXQ91jcrKuSrF1A4zXR3mRFjns5eEIBqkUZlXFFaWSxB5DguZz9FZllhBpuslZFqbXCoPfS3mCKqppmhsCkLlUGmDIBUIMCjy5cDpQWMR/vv9yY+0HJVwQzgtG5u20+XSYObKpR+eEIhSvfDIvD6m9ZFqnkIlrmkhpYPfGpldk9gWFcMa1oSxOjh439S1Ng5z+NmLMDk4oJavsdQLEAaZPtNVpRXUwogKHe82WjBqNvhbIw3mfquIsoxYTGiYAa30ssbJwQG8U7nMCA4ekr6CngXqoSclmIj0fVhaT9oDj9beb2NCZSH8italyDyjBmlXOHmD6wPfprCkgb9FpSMHhTbyd62cKHlBbtA4mYmyv3DEIG81JwxrRq2lcvFrmAH+NywQrR8vS9hZxFpOcFVScYtFuBFlgzZwtUihIK5+wtqg5R0exiUoVQ4Fynmxcz6R/9pYtzYwNJbY7HMR5orrxPAiwzYTpUWQszUsK3GNvdlAsxkS5RC+XkKOM9GULgVJe86ZBofwo3Yg6rqUGdsbMiWkPoKsxIBXOWyIwIgSFa/xqdE3MkcyCrmczdCQelIjDxH6RO5op9XcgcRj3XGFUKDVxkJnutSGht/YQ/x9HUjItHKo3BDe3ghZMvdeWgtSZWWTI0xLkV2nbCpTMJh73V0iGd7Ub3kmIXvqQWeAwGJJ21ArEkDpML20ndEanhXSdhpFbRFqnkPaPqpBb2eaJiYIopIBVkKWKQOXwq96Ck66ElNS2VqoZQq5cJiCw1s31bcpZAVm1/yXEbnUMG2cI1NNc+ZG17leqIDlTCtn5e9bNDK2fDyg4xSOU3idwpsURkcpjMYpjI5TGL1OYfQmhfFRCuNxCuPjFMavPVvjNwFq0eLbZ2A09iC7HrjwvNEly/u9tKzZZDJta4UXa1b4Qo2GcHDQ6hN//uWXXy7U3YUCuEhIvy6SyUXSklwkKfg2MpsXyWSUQvhwe5FM4NX4q0iwpN+vCV3/e0G/R7Qa/ndBv8ejC7UKk46ZGSeq+gFGqPmPZyL+DPuJPvLM9C2aNvpINsnTUgutG31t2aKGVSfQKxJIKumkKO1umSLF8xOr42xDsmOSjHfvbrG4+fnJFNmKLWw7fRPb2l5TNAPMyHgDgi+H3WmzAwE/6XMDIHD1ufK/Jvlbm7UbhJbk+SHRZ+1z4fhqyO4B2+3dYASC5wdFx9jnAvGGgKBzazcK1Pr8IAhcxYbgC/i2o+PB6MvB+Gh8vAYDxVGeoKoGeT5YLpefCSEwYOQehfnZ2QzOrPcBKWadGV1tiVQ4kOiogvvEf0fv/gfy6afR3cWcgsT1cDeGh32H3OlcLF9YP1Ts2vpxRN95ccsem9xEfHConBVaZoF5oone25SiwSGBMCDg88MffjjsQek/Dqoq4gvxK/0eMPT9r1U1zPPhJu3aCvW+VpDnKWz5vr0hz6Gqql3ffQMdlxfqP4ach2DXbbcuBII/Rx227Ppu/p260jWIXKuS5+fgbruubJwvhVShIewb2CAwOG9KYfCWolQrtWJc/gBLtKFFUYk6N5+DWo4HOWXgkYAvToIr/zJscJJgfQD68ni/e4L1BzE4x1sew+fTiBmZh8SWbbKCYj4RIwaCvUvw8K9M1JKSCyU6x1/RZcNtTPhF6wXmtKibcblFtyaMsBB7bgnNefU50Bgd8bkX4pIHDr5A8fzMfo+z2OiTHdR8fpFUIrguyQy7v7Ur0Fwkl20fH5Jj3usL2zrD5QP6BJ3S5FiKKZb3de3J2tAXJ+ysHjjUUEnVZhKY5aPIAbeK243W0Ljaomde7P4Gj8Y9qknEGUppYzplHbR+75Bv4jygQp+xnSLEDjBtt+Rnb/mWsSfs+WgQwuo8MgPRARO2qb442QNKRTOsrUwfFxqjkkpWTdXmLGftqBGxKhzyfbioJ6Xy4wz91b03g7h9ZIaQTN8xwYUacWYh5iQecAUDxfOzCz3OHj8AP8VirB2af9Bx97gaRrH6arjlkCRSfzy2Kmh36+AQTuhIonSp70QJsCzD2lGy7HMVtGX5aYfSiPNI/QTZ7u3Xp3p+W3CDuz9hGwa6P2cr9sX7N9qOa2w/2U/yucDK30DtSgRWvPGe2zYMbG2scZImuuYrXa3e5ckk8dfD8bI0SXlstO5rnS+TyV0S0vf0Z0iOU9fDXy1dQ98lNiuwEvRX5IkurmeypKEo/4zGJmnC+Rq6xSbUkkmip79i5pKUooua7tjQ0hjcb3IXqfzFZZKGmD2ZJP5GM0kTvBVVTcThE6DKNAXGPMQqzvjQWO2XbizLf7RXxzQOXQ1+4jDcdbVxc/9JI/VHWHW4doMJY8Qy2SwSiHeCMYTz/dpLj3IZlUU6Uon2norJkjSRDqv+LDtWzeiPRzpDTZJwWvdj+/KyiOqj56R+daHVJ3UMdzBbMH8iSr71/sTrS/aWYkfMoyc96K5NU+DriuFjOybSs7Ri3p/TO4b35jzbdZ3eu8WzhW7KnO7HUJgh32p/cskEV6WIMmu4MKQ9JNYka1ltJRut0uT2cWFuIdODeFcPX5Q4c9DUNRrItFFoXvazcM9GuPHx8SpNlo+Lt/y3FO8rWrzF49L9zEUOXQHIv4LXV29WaVI8zuvf2jKMfyGzx69X3Vm3cZZfTXW+vIp2a/UYYTxUiI7Kgt6pE5Oj6QEx1bpEoe4h8W7mvSwNL8gZeRFSXXx7Lo2NBwosZFmCwQypEoez19FWQXA6/NU6hAtMcs6+ow/sNNpmaolKxfGsH3CK4Iycz5HqjQIFdw71ASi4vo0qdIgrMaOrf64gMngjdWMje4WwfIVfIvmlrkDpi1akmq87iT10uHqjL/uwvzr0hQ45RQUFJ2enT8CSXdgBuKItTvBS+jHg5OyUapLkLPhhQ/hgWyQitGKNBMgvghspYt1Ca9uXPuOAihHRLOxaCdkwVAMN4D5DubRbOUq79Gdbgnhv4K5sjZZIN47q5WQoxbAOa7uGI3PRAnmmm6fsykeQFDBv+CbFkcrGAiVOyXY1RVL52kYOgPLGxDKqsC2IkgodO5wiKkTUGz8FVNZ3FzAT1qFJqeqRkDcNBTjtkHhbo5GoMtwKgUEP3VVjtvpN6xisF+h8+On7UKwYZYhKOSUN9ANjDk3Nu4Y1oS0ciyu3Kfo9R4m0A83VLgftvuvB5V0h0VajsVoBVWWZuVDyd7+F2SPRFmGKhSg9aTAVdA9F/JCGrzMTbe0///6PHl87Pc77jPkZRJ7TRcAjHHKA6zc8edwGa7KAep0jGg/Nf24eAsQdK81VpfNWkezT9/gpVRM629pFp7n+FEv0FbLxYqK1tzaNNtYGt5LuJwzfI3Alra5JXryV1vVKn+Kt43378BMSjlmPB3ZDSKtpz6tlX8FbvkKJVTccF2jJ9aq59hjc0IWHjzN/3nUxaTDFVAqqlfUe+fjoiP7bWPi1gmVSzLaYuVz+JUmfHhA/HA74zxSC39+K3Y75uhj/zdaqygraJBVau+7Rb+nyiAB93KQqpcKrCMrV+Ojo6ktCbpUmx9vAea8rdAXvCLIFC6OprrguUVCVq1mCmAupgKY3fyBWaIw2D0v9cZw9BMLx0dHVqAXhy/sgvFN8NcM17Gf6GtWfK2l/euenJ1ZvK7Zq3uwm0hNxe7ImbP+7F9Ji1hjplsnk/C65HYhaDnz75PxydUm7zhWaUkW1tsyxcEUySQ7vZY74EQGlJc7vEj6ekuj6WqFyuj655/6KWh7ejJJVutljq7O8k9o6MZdqPniw12Un6ntaDo/4msBdbF/L/0EK7gOefao0kbQNChTkHhOCtMo/dWmz7+JaxYTW1hxVtyibWaeYdFrLI22a/i2ZoV5i6DxmZTjR0uZZkk6ipM2F0J9tduO823ptIiHmEUYcgI+PjzlS/WrEId2rNxwtHb9eXXqEe5EDpyb77q/Pe6/5ceHTul+TJBt+xNphvnmW7zxXdxyr0ZeSaqZ5zcM6nNSo3pOrSqp1M7ofnWKZ6aqtDI7k//z7P7hHPMZ4mr/ASWOg1gs09AyGSn1nJd5Kcg57r3Qo+cZJalGVaC1l5JTDuX/hIudcKhA9rkzUYipLSbaCyLQvz+mZGzuEnwukqwJqemF81cQNlmRioNSa33+Qd9A4XfVf0cBCm+sZsZSCgCk9GCCfxyLGLqgKoTJK3HsVYn+B3ruQD1sbaRGErIiYfGmczWQmaWAyjEZkDiqhxJwP/pSjZEKhjuX+Rk8pFLG6bLyzTY8OEJ0XkS8OhvAtBTcsOH3M0dGy597PtqmPc4KdDO9pphRT1jS9zNB2tVYl3qBhk+Gj1KYsodbOR47k+fTXlgZyRihLcbhnKC5NC1/whnmOXCyHQLcHdCaRT0gboJTqml6/DOC83WY/49RKh12GYLFY3DNfL9f7/FW6opmSf6m7fnP+yMau37398ZKMDZrKnszeo7mRGQbbuWPOQyY+DMeayPhYi8omarnVgy1lhspi7xB6+9fT7+EGXg2PkrRnsJ/A8OH377757sf339G4dKR4/RsNj4ZHnNbU1lVC9ab6xj9yO+tM6EbSvT2f9y/n9i/n9i/n9i/n9i/n9i/n9i/n9i/n9i/n9i/n9i/n9i/nHpV//3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Lu//3LuVAZQz7jYV0KyaVVoRDXV0Wdb76nu0yTgsqmJufJ3R3dKn4w5WpFn39r0FDN1WWa3AgjKXPOFVdprCyiWpxrXNLttr8IGJzR/Knf9XwTv1FoRoVRvsdbXv0HafuVXacn78+SNJmGN3+VzqmPEQt6DygWviAnwMkvvgQ/5iiFmjdcGpT4MakYSjSuWK+kuuZKqvBHr8JIqGWPw/USKy8G/UtCbe1wd+ertFarlt437ewRgI3UtH6Xq9Xq/wA/TtZn","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),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={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:"eJztW19zGzeS/yq98+JYNaREWnF8fDrnz+36LolUsVypK0mlgDNNDqIZYAJgRDEqvu0n2Y+2n+SqG8DMkCIl2U5ltVd8scVBA+j+Ad3objTuEifmNpmcJ2dY1aVwaJPLNMnRZkbWTmqVTJKzAiE2wzcGBX2Ht6fvQJSlXlhoLBoLTkNGjQhZY52u5O9iWiK4OHAKi0JmBVg0NwjCwrRssDZSOQszbWCOCo1wUs0h11lTITUspCugNpjjTCrMwTrTZK4xaIfwodYKbJNlaO2sKduZPBtSqxRcgcyoQdcYZUFAo+RvDcLBQaS+kvnBAbhCOMiEgimSODlJExjCHjtTQW1a8cC2xkzOJBGHsYYX6kKdyXoCH+pSixyWujFw+u1/tUPQuPTt/ODgW5w2c/jw7uDg8ovCudpODg9FXQ91jcrKuSrF1A4zXR3mRFjns5eEIBqkUZlXFFaWSxB5DguZz9FZllhBpuslZFqbXCoPfS3mCKqppmhsCkLlUGmDIBUIMCjy5cDpQWMR/vv9yY+0HJVwQzgtG5u20+XSYObKpR+eEIhSvfDIvD6m9ZFqnkIlrmkhpYPfGpldk9gWFcMa1oSxOjh439S1Ng5z+NmLMDk4oJavsdQLEAaZPtNVpRXUwogKHe82WjBqNvhbIw3mfquIsoxYTGiYAa30ssbJwQG8U7nMCA4ekr6CngXqoSclmIj0fVhaT9oDj9beb2NCZSH8italyDyjBmlXOHmD6wPfprCkgb9FpSMHhTbyd62cKHlBbtA4mYmyv3DEIG81JwxrRq2lcvFrmAH+NywQrR8vS9hZxFpOcFVScYtFuBFlgzZwtUihIK5+wtqg5R0exiUoVQ4Fynmxcz6R/9pYtzYwNJbY7HMR5orrxPAiwzYTpUWQszUsK3GNvdlAsxkS5RC+XkKOM9GULgVJe86ZBofwo3Yg6rqUGdsbMiWkPoKsxIBXOWyIwIgSFa/xqdE3MkcyCrmczdCQelIjDxH6RO5op9XcgcRj3XGFUKDVxkJnutSGht/YQ/x9HUjItHKo3BDe3ghZMvdeWgtSZWWTI0xLkV2nbCpTMJh73V0iGd7Ub3kmIXvqQWeAwGJJ21ArEkDpML20ndEanhXSdhpFbRFqnkPaPqpBb2eaJiYIopIBVkKWKQOXwq96Ck66ElNS2VqoZQq5cJiCw1s31bcpZAVm1/yXEbnUMG2cI1NNc+ZG17leqIDlTCtn5e9bNDK2fDyg4xSOU3idwpsURkcpjMYpjI5TGL1OYfQmhfFRCuNxCuPjFMavPVvjNwFq0eLbZ2A09iC7HrjwvNEly/u9tKzZZDJta4UXa1b4Qo2GcHDQ6hN//uWXXy7U3YUCuEhIvy6SyUXSklwkKfg2MpsXyWSUQvhwe5FM4NX4q0iwpN+vCV3/e0G/R7Qa/ndBv8ejC7UKk46ZGSeq+gFGqPmPZyL+DPuJPvLM9C2aNvpINsnTUgutG31t2aKGVSfQKxJIKumkKO1umSLF8xOr42xDsmOSjHfvbrG4+fnJFNmKLWw7fRPb2l5TNAPMyHgDgi+H3WmzAwE/6XMDIHD1ufK/Jvlbm7UbhJbk+SHRZ+1z4fhqyO4B2+3dYASC5wdFx9jnAvGGgKBzazcK1Pr8IAhcxYbgC/i2o+PB6MvB+Gh8vAYDxVGeoKoGeT5YLpefCSEwYOQehfnZ2QzOrPcBKWadGV1tiVQ4kOiogvvEf0fv/gfy6afR3cWcgsT1cDeGh32H3OlcLF9YP1Ts2vpxRN95ccsem9xEfHConBVaZoF5oone25SiwSGBMCDg88MffjjsQek/Dqoq4gvxK/0eMPT9r1U1zPPhJu3aCvW+VpDnKWz5vr0hz6Gqql3ffQMdlxfqP4ach2DXbbcuBII/Rx227Ppu/p260jWIXKuS5+fgbruubJwvhVShIewb2CAwOG9KYfCWolQrtWJc/gBLtKFFUYk6N5+DWo4HOWXgkYAvToIr/zJscJJgfQD68ni/e4L1BzE4x1sew+fTiBmZh8SWbbKCYj4RIwaCvUvw8K9M1JKSCyU6x1/RZcNtTPhF6wXmtKibcblFtyaMsBB7bgnNefU50Bgd8bkX4pIHDr5A8fzMfo+z2OiTHdR8fpFUIrguyQy7v7Ur0Fwkl20fH5Jj3usL2zrD5QP6BJ3S5FiKKZb3de3J2tAXJ+ysHjjUUEnVZhKY5aPIAbeK243W0Ljaomde7P4Gj8Y9qknEGUppYzplHbR+75Bv4jygQp+xnSLEDjBtt+Rnb/mWsSfs+WgQwuo8MgPRARO2qb442QNKRTOsrUwfFxqjkkpWTdXmLGftqBGxKhzyfbioJ6Xy4wz91b03g7h9ZIaQTN8xwYUacWYh5iQecAUDxfOzCz3OHj8AP8VirB2af9Bx97gaRrH6arjlkCRSfzy2Kmh36+AQTuhIonSp70QJsCzD2lGy7HMVtGX5aYfSiPNI/QTZ7u3Xp3p+W3CDuz9hGwa6P2cr9sX7N9qOa2w/2U/yucDK30DtSgRWvPGe2zYMbG2scZImuuYrXa3e5ckk8dfD8bI0SXlstO5rnS+TyV0S0vf0Z0iOU9fDXy1dQ98lNiuwEvRX5IkurmeypKEo/4zGJmnC+Rq6xSbUkkmip79i5pKUooua7tjQ0hjcb3IXqfzFZZKGmD2ZJP5GM0kTvBVVTcThE6DKNAXGPMQqzvjQWO2XbizLf7RXxzQOXQ1+4jDcdbVxc/9JI/VHWHW4doMJY8Qy2SwSiHeCMYTz/dpLj3IZlUU6Uon2norJkjSRDqv+LDtWzeiPRzpDTZJwWvdj+/KyiOqj56R+daHVJ3UMdzBbMH8iSr71/sTrS/aWYkfMoyc96K5NU+DriuFjOybSs7Ri3p/TO4b35jzbdZ3eu8WzhW7KnO7HUJgh32p/cskEV6WIMmu4MKQ9JNYka1ltJRut0uT2cWFuIdODeFcPX5Q4c9DUNRrItFFoXvazcM9GuPHx8SpNlo+Lt/y3FO8rWrzF49L9zEUOXQHIv4LXV29WaVI8zuvf2jKMfyGzx69X3Vm3cZZfTXW+vIp2a/UYYTxUiI7Kgt6pE5Oj6QEx1bpEoe4h8W7mvSwNL8gZeRFSXXx7Lo2NBwosZFmCwQypEoez19FWQXA6/NU6hAtMcs6+ow/sNNpmaolKxfGsH3CK4Iycz5HqjQIFdw71ASi4vo0qdIgrMaOrf64gMngjdWMje4WwfIVfIvmlrkDpi1akmq87iT10uHqjL/uwvzr0hQ45RQUFJ2enT8CSXdgBuKItTvBS+jHg5OyUapLkLPhhQ/hgWyQitGKNBMgvghspYt1Ca9uXPuOAihHRLOxaCdkwVAMN4D5DubRbOUq79Gdbgnhv4K5sjZZIN47q5WQoxbAOa7uGI3PRAnmmm6fsykeQFDBv+CbFkcrGAiVOyXY1RVL52kYOgPLGxDKqsC2IkgodO5wiKkTUGz8FVNZ3FzAT1qFJqeqRkDcNBTjtkHhbo5GoMtwKgUEP3VVjtvpN6xisF+h8+On7UKwYZYhKOSUN9ANjDk3Nu4Y1oS0ciyu3Kfo9R4m0A83VLgftvuvB5V0h0VajsVoBVWWZuVDyd7+F2SPRFmGKhSg9aTAVdA9F/JCGrzMTbe0///6PHl87Pc77jPkZRJ7TRcAjHHKA6zc8edwGa7KAep0jGg/Nf24eAsQdK81VpfNWkezT9/gpVRM629pFp7n+FEv0FbLxYqK1tzaNNtYGt5LuJwzfI3Alra5JXryV1vVKn+Kt43378BMSjlmPB3ZDSKtpz6tlX8FbvkKJVTccF2jJ9aq59hjc0IWHjzN/3nUxaTDFVAqqlfUe+fjoiP7bWPi1gmVSzLaYuVz+JUmfHhA/HA74zxSC39+K3Y75uhj/zdaqygraJBVau+7Rb+nyiAB93KQqpcKrCMrV+Ojo6ktCbpUmx9vAea8rdAXvCLIFC6OprrguUVCVq1mCmAupgKY3fyBWaIw2D0v9cZw9BMLx0dHVqAXhy/sgvFN8NcM17Gf6GtWfK2l/euenJ1ZvK7Zq3uwm0hNxe7ImbP+7F9Ji1hjplsnk/C65HYhaDnz75PxydUm7zhWaUkW1tsyxcEUySQ7vZY74EQGlJc7vEj6ekuj6WqFyuj655/6KWh7ejJJVutljq7O8k9o6MZdqPniw12Un6ntaDo/4msBdbF/L/0EK7gOefao0kbQNChTkHhOCtMo/dWmz7+JaxYTW1hxVtyibWaeYdFrLI22a/i2ZoV5i6DxmZTjR0uZZkk6ipM2F0J9tduO823ptIiHmEUYcgI+PjzlS/WrEId2rNxwtHb9eXXqEe5EDpyb77q/Pe6/5ceHTul+TJBt+xNphvnmW7zxXdxyr0ZeSaqZ5zcM6nNSo3pOrSqp1M7ofnWKZ6aqtDI7k//z7P7hHPMZ4mr/ASWOg1gs09AyGSn1nJd5Kcg57r3Qo+cZJalGVaC1l5JTDuX/hIudcKhA9rkzUYipLSbaCyLQvz+mZGzuEnwukqwJqemF81cQNlmRioNSa33+Qd9A4XfVf0cBCm+sZsZSCgCk9GCCfxyLGLqgKoTJK3HsVYn+B3ruQD1sbaRGErIiYfGmczWQmaWAyjEZkDiqhxJwP/pSjZEKhjuX+Rk8pFLG6bLyzTY8OEJ0XkS8OhvAtBTcsOH3M0dGy597PtqmPc4KdDO9pphRT1jS9zNB2tVYl3qBhk+Gj1KYsodbOR47k+fTXlgZyRihLcbhnKC5NC1/whnmOXCyHQLcHdCaRT0gboJTqml6/DOC83WY/49RKh12GYLFY3DNfL9f7/FW6opmSf6m7fnP+yMau37398ZKMDZrKnszeo7mRGQbbuWPOQyY+DMeayPhYi8omarnVgy1lhspi7xB6+9fT7+EGXg2PkrRnsJ/A8OH377757sf339G4dKR4/RsNj4ZHnNbU1lVC9ab6xj9yO+tM6EbSvT2f9y/n9i/n9i/n9i/n9i/n9i/n9i/n9i/n9i/n9i/n9i/n9i/nHpV//3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Ju/3Lu//3LuVAZQz7jYV0KyaVVoRDXV0Wdb76nu0yTgsqmJufJ3R3dKn4w5WpFn39r0FDN1WWa3AgjKXPOFVdprCyiWpxrXNLttr8IGJzR/Knf9XwTv1FoRoVRvsdbXv0HafuVXacn78+SNJmGN3+VzqmPEQt6DygWviAnwMkvvgQ/5iiFmjdcGpT4MakYSjSuWK+kuuZKqvBHr8JIqGWPw/USKy8G/UtCbe1wd+ertFarlt437ewRgI3UtH6Xq9Xq/wA/TtZn",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},j=[];function y(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:"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:'"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"},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)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.de0fa34e.js b/assets/js/bbdfc22d.de0fa34e.js new file mode 100644 index 000000000..92d8843a5 --- /dev/null +++ b/assets/js/bbdfc22d.de0fa34e.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:()=>g,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,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":"eJztO9tyIzeuv4Ltl8m4WrKlOJNZP52ZJGd3zkniqYynUqdsl0N1Q2rG3WSHZFtWXHrbL9lP2y/ZAki2unWxPZeTdar0YqtJkARAAARA8C5xYmaTk/PkDKu6FA5tcpkmOdrMyNpJrZKT5KxAiN3wjUFB7fDq7RsQZannFhqLxoLTkFEnQtZYpyv5u5iUCC5OnMK8kFkBFs0NgrAwKRusjVTOwlQbmKFCI5xUM8h11lRIHXPpCqgN5jiVCnOwzjSZawzaIbyvtQLbZBlaO23KdiWPhtQqBVcgI2rQNUZZENAo+VuDcHAQoa9kfnAArhAOMqFggkROTtQEhLCDzkRQn1Y8sa0xk1NJwGGu4YW6UGeyPoH3dalFDgvdGHj77X+3U9C81HZ+cPAtTpoZvH9zcHD5ReFcbU8OD0VdD3WNysqZKsXEDjNdHeYEWOfT58RBNEizMq4orCwXIPIc5jKfobNMsYJM1wvItDa5VJ71tZghqKaaoLEpCJVDpQ2CVCDAoMgXA6cHjUX4n3enP9J2VMIN4W3Z2LRdLpcGM1cu/PTEgUjVM8+ZF8e0P1LNUqjENW2kdPBbI7NrItuiYraGPWFeHRy8a+paG4c5/OxJODk4oJ7XWOo5CIMMn+mq0gpqYUSFjqWNNoy6Df7WSIO5FxVRlpEXJxdqQPu8qPHk4ADeqFxmxAyekFpBTwPs0IMSkwj0XdhYD9phHe28F2LiyVz4/axLkXk0DZJMOHmD/YlvU1jQxN+i0hGDQhv5u1ZOlLwdN2iczETZ3TZCkAXNCcN6UWupXGwNK8D/he2h3eNNCXJFqOXErEoq7rEIN6Js0Aas5ikUhNVPWBu0LN9hXmKkyqFAOSt2rifyXxvrehNDYwnNLhZhrbhLzF5ktk1FaRHktMfLSlxjZzXQbIREOYTXC8hxKprSpSBJ4pxpcAg/ageirkuZsbUhQ0LKI8hGDHiXgzgERJSoeI/fGn0jcySTkMvpFA0pJ3XyFGFMxI7krOYBRB5rjiuEAq3WNjrTpTabIsTNfT5CppVD5Ybw6kbIkpH3xFqQKiubHGFSiuw6ZTuZgsHcK+4CyeqmXt4ZhIyp5znzByyWJIVaEf5Kh+WlXVmsIZwV0q70iTojq3kRabtcDVo71bQysSCqGGAlZJky41L4VU/ASVdiSgpbC7VIIRcOU3B46yb6NoWswOyafxmRSw2Txjky1LRmbnSd67kKvJxq5az8fYtGxp4P5+g4heMUXqTwMoXRUQqjcQqj4xRGL1IYvUxhfJTCeJzC+DiF8QuP1vhl4LVoGdxFYDT2XHZ/Hu6S3f1eWtZsMpi2tcHzng0eDeHgoNUmavvll18u1N2FArhISLkukhO4SFqQiyT1fWQzqW8Uvm/p48vx1+FzQZ8vxi/D55xBR8fhs6DP8ehCLcOCF2rMmDhR1fdgQd2fFYPwFYSI2nhRaov2jBrJEKWxg/aqhw91LLu0fEm0SCWdFKXdTU6EeEIUrVDaIOqYiGJx3U0Rdz8hcrr4UA+bSd/FZrXTFRWesRhvUP/VMJwsu4n3yz4Z2jvofBrpL1ia9QTOyDTtpr+1Xk+ICes4fRonvh6yA8CWeTcfAsAT4kIfo0/jwUviAR1KuxlAvU+I+g461BFOeN93dDwYfTUYH42Pexyg2MgDVNUgzweLxeJzcI98nrA8uTzRQ/WeHYWhU6OrLeEHRwcrqOAT8e/osv9Ajvok+rCYU9zXj2BjxNf1sp3OxeKZ9VPFoa1zRvAr12zRQZO7CA+OfrNCyywgTzDRJZtQgDckHgyI7/nhDz8cdjjpGwdVNVhrpM8BM77TWFXDPB+uQW7sjm+sIM9T2Gze2p7nUFXVjmbffpGwS/XXIScV2BPbLf0B4I9SgJWc9xe+VzkoH6BVyWtzkLZdO9aOkEKq0BFEBdYADM6aUhi8pWjTSq089OfXnKg4K3+do1MO7Dj296yAL06DT/48CDWR0J+AWh4et0FZdxKDM7zlOXxajJCRechP2SYrKHoT0fUnvq/yNPyViVpSlqBE57gVXTbchoTftU6ETbu6HmBbdD1ihIU4ckuMzdvP4j064uMtBBj3nG8B4gmZ+DWUqNOnK6j7/CKpBHsAJGW4+q1dgeYiuWzH+Kga8wfGXj5CjwqZYykmWG52PVoHurQEeeowhjoqqdpMAON7lHY6xe1ap+9bbtEtT3FXqKMRj6oRWQyltDEX0udXd3RIFnEKT6FPtk4Q4gCYtGL4yWLeIvY4OfdWIGzOA0sQHDBgm6iLqz2wQm9juoyhOSqpZNVUbcZx2s4aWVaF07zLLxpJafi4Qnd3N1YQtw+sEBLhOxa4UCPODMSMwj2+XoB4QsZgDaX79fRjzETvjPxMh9vDChjJ6irgliORQP1h2Cqf3a19QzilA4iynH4Q5a2yDGtHOa5PVc0W5UcfQZwF8pmt15zZ2i153fzXE5K+LWj9P0tggPtjpLBL3p9IEntoP1oafR6vErN7gl3ufkLyF/BZ29wkTXTNd69avcmTk8Tf48ZbzSTlqdG61zpfJCd3Sci008+Qx6ahh79aui++S2xWYCXoV0SJbpinsqSpKFmMxiZpwqkXum4mfiUniZ78iplLUgogaroOQ0tz8LiTuwjlbxiTNATiyUnirx6TNMFbUdUEHJoAVaYp3OUplnHF++ZqW1ZzWf7R3vHSPHSL95HT8NDl2hX7R83UnWG54utqMmGMWCTrt/nx+i5GaX5cez9RLqKWSEe60N4pMViSJtJh1V1lx64Z/eGczlATJZyX/dCxvC2i+uA1aVxdaPVRA8N1yRaeP5JLvndz4f6WvaLoEPPoNw9WN5wp8C3D8CGJifBMrZh11/Re4MaaZ7tuvjsXbrbQTZnTVRYKM+QL6I+ubeDyEVFmDVdwtKdDj7IW1Zay0TJNbh8m5hYyPYjX6vBFiVMHTV2jgUwbheZ5N7f2ZIgbHx8v02TxMHmLPyV5X9PmzR+m7meuR1jVavwncP3y5TJNiodx/XtbMfEfRPb4xXJ11q2d5VcTnS+uot1aPgQYDxWCo/qdN+rU5Gg6jJhoXaJQG5x4M/XulYZn5Is8C8ksvuiWxsYDBeayLMFghlQ0wznpaKsgOB3+FhzC5SN5Zd9RA3uLtplYglJxPusnnCA4I2czpMKgAMGDw1U+Ci5Eo2IawkpM6Zaei30M3kjd2IheISzftpdIDqkrUPr6Eqlmfe+wwx2utOjSPuzuDrXQIafo7v/07O0jeMm+6wBc0dYReCr9HHB69pbKh+Q0+GFDeG9bTkTWih4IkF8EN1LEEoPWti98egEVc0Qzsb1ar2Eo3BnAJkK5tFsxSlcJzrZWcGPiVX0ZbZFuHBW2yVA1YR3WtsdHxqJl5JluHiOVD3BSwKzh+xFHKhtriTjpuir/kcoXIXLkkzcmVjwFsSBIqkhc8SlyhYA686eAyvrhAqbCOjQplScS501DkU07Jd7WaCSqDLeywKBn3VVjtvpNfR70a2ne//R9qCqMNESlnJAG+okxh6ZmqWFNaGu84s6tk77hKJF2oLna5aBtuh5ciRWyajUaqxVQBZWZCSV/9yLMHom2CBMsROlBg6mg2yXChzS8j0y0tf/6xz87eO30ODcR8yuIPKdU/wMYcmTrBZ48boM1WUDdx4jmQ/Nf64cAYcdKc1XpvFUk+3gZf0uFf862dtFpLhTFEn0pa7x6aO2tTaONtcGtpBsIwzcFXPKqa6IXb6V1nSqleJe4aR9+QuJj1sGB3RDSapJ5tegqeItXqIZaTce1VLJf4dYeg2u6cP9x5s+7VUwaTDFVbWplvUc+Pjqif2sb36ssJsVsq47LxV+S9PEB8f3hgG+mEHxTFFcS87oY/93WqsoKEpIKre179FuGPEBAl29SlVLhVWTK1fjo6Oor4twyTY63MeedrtAVLBFkC+ZGUwFwXaKgglSzADETUgEtbz4jr9AYbe6n+sMwu48Jx0dHV6OWCV9tMuGN4msYLjY/09eo/lhKu8s7vzyheluxVfNmN5EeiPuTHrHddk+kxawx0i2Sk/O75HYgajnw/Sfnl8tLkjpXaEoV1doyxsIVyUlyuJE54mp/Skuc3yV8PCXR9bVC5XRXsuH+iloe3oySZbo+YquzvBPaOjGTaja4d9TlitR3tB2e4z2CV7F9Lf8XKbgP/OxCpYkkMShQkHtMHKRd/mmVNvsu7lVMaG3NUa02ZT3rFJNOvTzSuunfkhnqJIbOY1aGEy1tniVZUZS0uRD62WY3zlei1yYSYh5hxAH4+PiYI9WvRxzSffmSo6XjF8tLz+FO5MCZya776xPePT8uNPX9miRZ8yN6h/n6Wb7zXN1xrEZfSqqp5j0P+3Bao3pHriqp1s1oMzrFMtNVW8Qbwf/1j3/yiHiM8TJ/gdPGQK3naOi9ClXlTku8leQcdp7TUPKNs9OiKtFaysgphzP/FEXOuBggelyZqMVElpJsBYFpX3TTMTd2CD8XSHcE1PXM+LqIGyzJxECpNT/UIO+gcbrqPneBuTbXU0IpBQETqu0nn8cixiGoCqEyyth7FWJ/gR6mkA9bG2kRhKwImHxpnE5lJmliMoxGZA4qocSMD/6Uo2TiQh0r842eUChiddl4Z5veByA6TyLfGAzhWwpumHBqzNHRtufez7apj3OCnQwPXyYUU9a0vMzQriqoSrxBwybDR6lNWUKtnY8cyfPp7i1N5IxQluJwj1DcmpZ9wRvmNXKxGAJdG9CZRD4hCUAp1bV/pnLeitnPOLHS4SpDMJ/PN8zX8/6Yv0lXNBPyL/Vq3Iwb2dh1h7cfz8nYoKns6fQdmhuZYbCdO9Y8ZODDcKyJjI+1qGyills92FJmqCx2DqFXf3v7PdzAl8OjJO0Y7EcgfPj9m2+++/HddzQvHSle/0bDo+ERpzW1dZVQnaW+8a/RzlYmdC3p3p7P+ydu+ydu+ydu+ydu+ydu+ydu+ydu+ydu+ydu+yduG0Ttn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7g9FRO/f+K2f+K2f+K2f+K2f+L2pB4W7Z+4/RESuH/itn/i9ognbqGEhbzCw7oUkmugQsWsL186X3/4dpkmBdU3nZwnd3d0/ffelMslNf/WoKHiqMs0uRFGUpKbS6PSWAJERTPXuKBraJ+zH5zR+qkXd74yX6sIowomP+IVb/u9sN0SrLen786SNJmEx3mVzmmMEXN6uCfmvnImcJOfZgl+dVEKNWu4hifxc1LVkmhc0S95uuaSp/CjUwok1KKDYb8WypNBf4morQPu7nw51XLZwvuunSMCYyM07d/lcrn8NwWGxDE=","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),a=t(33617),o=t.n(a),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 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:"eJztO9tyIzeuv4Ltl8m4WrKlOJNZP52ZJGd3zkniqYynUqdsl0N1Q2rG3WSHZFtWXHrbL9lP2y/ZAki2unWxPZeTdar0YqtJkARAAARA8C5xYmaTk/PkDKu6FA5tcpkmOdrMyNpJrZKT5KxAiN3wjUFB7fDq7RsQZannFhqLxoLTkFEnQtZYpyv5u5iUCC5OnMK8kFkBFs0NgrAwKRusjVTOwlQbmKFCI5xUM8h11lRIHXPpCqgN5jiVCnOwzjSZawzaIbyvtQLbZBlaO23KdiWPhtQqBVcgI2rQNUZZENAo+VuDcHAQoa9kfnAArhAOMqFggkROTtQEhLCDzkRQn1Y8sa0xk1NJwGGu4YW6UGeyPoH3dalFDgvdGHj77X+3U9C81HZ+cPAtTpoZvH9zcHD5ReFcbU8OD0VdD3WNysqZKsXEDjNdHeYEWOfT58RBNEizMq4orCwXIPIc5jKfobNMsYJM1wvItDa5VJ71tZghqKaaoLEpCJVDpQ2CVCDAoMgXA6cHjUX4n3enP9J2VMIN4W3Z2LRdLpcGM1cu/PTEgUjVM8+ZF8e0P1LNUqjENW2kdPBbI7NrItuiYraGPWFeHRy8a+paG4c5/OxJODk4oJ7XWOo5CIMMn+mq0gpqYUSFjqWNNoy6Df7WSIO5FxVRlpEXJxdqQPu8qPHk4ADeqFxmxAyekFpBTwPs0IMSkwj0XdhYD9phHe28F2LiyVz4/axLkXk0DZJMOHmD/YlvU1jQxN+i0hGDQhv5u1ZOlLwdN2iczETZ3TZCkAXNCcN6UWupXGwNK8D/he2h3eNNCXJFqOXErEoq7rEIN6Js0Aas5ikUhNVPWBu0LN9hXmKkyqFAOSt2rifyXxvrehNDYwnNLhZhrbhLzF5ktk1FaRHktMfLSlxjZzXQbIREOYTXC8hxKprSpSBJ4pxpcAg/ageirkuZsbUhQ0LKI8hGDHiXgzgERJSoeI/fGn0jcySTkMvpFA0pJ3XyFGFMxI7krOYBRB5rjiuEAq3WNjrTpTabIsTNfT5CppVD5Ybw6kbIkpH3xFqQKiubHGFSiuw6ZTuZgsHcK+4CyeqmXt4ZhIyp5znzByyWJIVaEf5Kh+WlXVmsIZwV0q70iTojq3kRabtcDVo71bQysSCqGGAlZJky41L4VU/ASVdiSgpbC7VIIRcOU3B46yb6NoWswOyafxmRSw2Txjky1LRmbnSd67kKvJxq5az8fYtGxp4P5+g4heMUXqTwMoXRUQqjcQqj4xRGL1IYvUxhfJTCeJzC+DiF8QuP1vhl4LVoGdxFYDT2XHZ/Hu6S3f1eWtZsMpi2tcHzng0eDeHgoNUmavvll18u1N2FArhISLkukhO4SFqQiyT1fWQzqW8Uvm/p48vx1+FzQZ8vxi/D55xBR8fhs6DP8ehCLcOCF2rMmDhR1fdgQd2fFYPwFYSI2nhRaov2jBrJEKWxg/aqhw91LLu0fEm0SCWdFKXdTU6EeEIUrVDaIOqYiGJx3U0Rdz8hcrr4UA+bSd/FZrXTFRWesRhvUP/VMJwsu4n3yz4Z2jvofBrpL1ia9QTOyDTtpr+1Xk+ICes4fRonvh6yA8CWeTcfAsAT4kIfo0/jwUviAR1KuxlAvU+I+g461BFOeN93dDwYfTUYH42Pexyg2MgDVNUgzweLxeJzcI98nrA8uTzRQ/WeHYWhU6OrLeEHRwcrqOAT8e/osv9Ajvok+rCYU9zXj2BjxNf1sp3OxeKZ9VPFoa1zRvAr12zRQZO7CA+OfrNCyywgTzDRJZtQgDckHgyI7/nhDz8cdjjpGwdVNVhrpM8BM77TWFXDPB+uQW7sjm+sIM9T2Gze2p7nUFXVjmbffpGwS/XXIScV2BPbLf0B4I9SgJWc9xe+VzkoH6BVyWtzkLZdO9aOkEKq0BFEBdYADM6aUhi8pWjTSq089OfXnKg4K3+do1MO7Dj296yAL06DT/48CDWR0J+AWh4et0FZdxKDM7zlOXxajJCRechP2SYrKHoT0fUnvq/yNPyViVpSlqBE57gVXTbchoTftU6ETbu6HmBbdD1ihIU4ckuMzdvP4j064uMtBBj3nG8B4gmZ+DWUqNOnK6j7/CKpBHsAJGW4+q1dgeYiuWzH+Kga8wfGXj5CjwqZYykmWG52PVoHurQEeeowhjoqqdpMAON7lHY6xe1ap+9bbtEtT3FXqKMRj6oRWQyltDEX0udXd3RIFnEKT6FPtk4Q4gCYtGL4yWLeIvY4OfdWIGzOA0sQHDBgm6iLqz2wQm9juoyhOSqpZNVUbcZx2s4aWVaF07zLLxpJafi4Qnd3N1YQtw+sEBLhOxa4UCPODMSMwj2+XoB4QsZgDaX79fRjzETvjPxMh9vDChjJ6irgliORQP1h2Cqf3a19QzilA4iynH4Q5a2yDGtHOa5PVc0W5UcfQZwF8pmt15zZ2i153fzXE5K+LWj9P0tggPtjpLBL3p9IEntoP1oafR6vErN7gl3ufkLyF/BZ29wkTXTNd69avcmTk8Tf48ZbzSTlqdG61zpfJCd3Sci008+Qx6ahh79aui++S2xWYCXoV0SJbpinsqSpKFmMxiZpwqkXum4mfiUniZ78iplLUgogaroOQ0tz8LiTuwjlbxiTNATiyUnirx6TNMFbUdUEHJoAVaYp3OUplnHF++ZqW1ZzWf7R3vHSPHSL95HT8NDl2hX7R83UnWG54utqMmGMWCTrt/nx+i5GaX5cez9RLqKWSEe60N4pMViSJtJh1V1lx64Z/eGczlATJZyX/dCxvC2i+uA1aVxdaPVRA8N1yRaeP5JLvndz4f6WvaLoEPPoNw9WN5wp8C3D8CGJifBMrZh11/Re4MaaZ7tuvjsXbrbQTZnTVRYKM+QL6I+ubeDyEVFmDVdwtKdDj7IW1Zay0TJNbh8m5hYyPYjX6vBFiVMHTV2jgUwbheZ5N7f2ZIgbHx8v02TxMHmLPyV5X9PmzR+m7meuR1jVavwncP3y5TJNiodx/XtbMfEfRPb4xXJ11q2d5VcTnS+uot1aPgQYDxWCo/qdN+rU5Gg6jJhoXaJQG5x4M/XulYZn5Is8C8ksvuiWxsYDBeayLMFghlQ0wznpaKsgOB3+FhzC5SN5Zd9RA3uLtplYglJxPusnnCA4I2czpMKgAMGDw1U+Ci5Eo2IawkpM6Zaei30M3kjd2IheISzftpdIDqkrUPr6Eqlmfe+wwx2utOjSPuzuDrXQIafo7v/07O0jeMm+6wBc0dYReCr9HHB69pbKh+Q0+GFDeG9bTkTWih4IkF8EN1LEEoPWti98egEVc0Qzsb1ar2Eo3BnAJkK5tFsxSlcJzrZWcGPiVX0ZbZFuHBW2yVA1YR3WtsdHxqJl5JluHiOVD3BSwKzh+xFHKhtriTjpuir/kcoXIXLkkzcmVjwFsSBIqkhc8SlyhYA686eAyvrhAqbCOjQplScS501DkU07Jd7WaCSqDLeywKBn3VVjtvpNfR70a2ne//R9qCqMNESlnJAG+okxh6ZmqWFNaGu84s6tk77hKJF2oLna5aBtuh5ciRWyajUaqxVQBZWZCSV/9yLMHom2CBMsROlBg6mg2yXChzS8j0y0tf/6xz87eO30ODcR8yuIPKdU/wMYcmTrBZ48boM1WUDdx4jmQ/Nf64cAYcdKc1XpvFUk+3gZf0uFf862dtFpLhTFEn0pa7x6aO2tTaONtcGtpBsIwzcFXPKqa6IXb6V1nSqleJe4aR9+QuJj1sGB3RDSapJ5tegqeItXqIZaTce1VLJf4dYeg2u6cP9x5s+7VUwaTDFVbWplvUc+Pjqif2sb36ssJsVsq47LxV+S9PEB8f3hgG+mEHxTFFcS87oY/93WqsoKEpIKre179FuGPEBAl29SlVLhVWTK1fjo6Oor4twyTY63MeedrtAVLBFkC+ZGUwFwXaKgglSzADETUgEtbz4jr9AYbe6n+sMwu48Jx0dHV6OWCV9tMuGN4msYLjY/09eo/lhKu8s7vzyheluxVfNmN5EeiPuTHrHddk+kxawx0i2Sk/O75HYgajnw/Sfnl8tLkjpXaEoV1doyxsIVyUlyuJE54mp/Skuc3yV8PCXR9bVC5XRXsuH+iloe3oySZbo+YquzvBPaOjGTaja4d9TlitR3tB2e4z2CV7F9Lf8XKbgP/OxCpYkkMShQkHtMHKRd/mmVNvsu7lVMaG3NUa02ZT3rFJNOvTzSuunfkhnqJIbOY1aGEy1tniVZUZS0uRD62WY3zlei1yYSYh5hxAH4+PiYI9WvRxzSffmSo6XjF8tLz+FO5MCZya776xPePT8uNPX9miRZ8yN6h/n6Wb7zXN1xrEZfSqqp5j0P+3Bao3pHriqp1s1oMzrFMtNVW8Qbwf/1j3/yiHiM8TJ/gdPGQK3naOi9ClXlTku8leQcdp7TUPKNs9OiKtFaysgphzP/FEXOuBggelyZqMVElpJsBYFpX3TTMTd2CD8XSHcE1PXM+LqIGyzJxECpNT/UIO+gcbrqPneBuTbXU0IpBQETqu0nn8cixiGoCqEyyth7FWJ/gR6mkA9bG2kRhKwImHxpnE5lJmliMoxGZA4qocSMD/6Uo2TiQh0r842eUChiddl4Z5veByA6TyLfGAzhWwpumHBqzNHRtufez7apj3OCnQwPXyYUU9a0vMzQriqoSrxBwybDR6lNWUKtnY8cyfPp7i1N5IxQluJwj1DcmpZ9wRvmNXKxGAJdG9CZRD4hCUAp1bV/pnLeitnPOLHS4SpDMJ/PN8zX8/6Yv0lXNBPyL/Vq3Iwb2dh1h7cfz8nYoKns6fQdmhuZYbCdO9Y8ZODDcKyJjI+1qGyills92FJmqCx2DqFXf3v7PdzAl8OjJO0Y7EcgfPj9m2+++/HddzQvHSle/0bDo+ERpzW1dZVQnaW+8a/RzlYmdC3p3p7P+ydu+ydu+ydu+ydu+ydu+ydu+ydu+ydu+ydu+yduG0Ttn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7g9FRO/f+K2f+K2f+K2f+K2f+L2pB4W7Z+4/RESuH/itn/i9ognbqGEhbzCw7oUkmugQsWsL186X3/4dpkmBdU3nZwnd3d0/ffelMslNf/WoKHiqMs0uRFGUpKbS6PSWAJERTPXuKBraJ+zH5zR+qkXd74yX6sIowomP+IVb/u9sN0SrLen786SNJmEx3mVzmmMEXN6uCfmvnImcJOfZgl+dVEKNWu4hifxc1LVkmhc0S95uuaSp/CjUwok1KKDYb8WypNBf4morQPu7nw51XLZwvuunSMCYyM07d/lcrn8NwWGxDE=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,g={},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:"Create Template"}),"\n",(0,s.jsx)(o(),{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:"iob 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"},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.44114b57.js b/assets/js/runtime~main.cc74056c.js similarity index 97% rename from assets/js/runtime~main.44114b57.js rename to assets/js/runtime~main.cc74056c.js index 30a1f2f45..fcbd49353 100644 --- a/assets/js/runtime~main.44114b57.js +++ b/assets/js/runtime~main.cc74056c.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",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:"accd8a6d",850:"3ac080ec",962:"abe7aaf7",1019:"b628cd80",1179:"5fdf345b",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:"7b17b751",2223:"7898036f",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"cecb2797",3021:"eb474160",3042:"040aac0d",3073:"732a63bb",3213:"2f134de8",3249:"d6c50b29",3276:"00ab24d9",3381:"a7f76393",3392:"a7951473",3451:"db466139",3605:"0b93ed81",3637:"ffa80471",3694:"4d710693",3841:"6784ed33",3844:"6ba5aede",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"03f50aca",4469:"5faf56ff",4553:"c012dd2f",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"be7bdbbb",5013:"b10f6f78",5277:"6e628336",5378:"73b1ae3a",5550:"def3ac1b",5557:"dffbf1c4",5597:"2a8ff7c7",5742:"ac359952",5772:"40bab2e5",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:"b5687ca9",6743:"a3fe848c",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b2ebdef8",7098:"c920e4e4",7315:"92ed8946",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:"d66b6249",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",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,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",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:"accd8a6d",850:"3ac080ec",962:"abe7aaf7",1019:"b628cd80",1179:"5fdf345b",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:"7b17b751",2223:"7898036f",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"cecb2797",3021:"eb474160",3042:"040aac0d",3073:"732a63bb",3213:"2f134de8",3249:"d6c50b29",3276:"00ab24d9",3381:"a7f76393",3392:"a7951473",3451:"db466139",3605:"0b93ed81",3637:"ffa80471",3694:"4d710693",3841:"6784ed33",3844:"de0fa34e",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"03f50aca",4469:"5faf56ff",4553:"c012dd2f",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"be7bdbbb",5013:"b10f6f78",5277:"6e628336",5378:"73b1ae3a",5550:"def3ac1b",5557:"dffbf1c4",5597:"2a8ff7c7",5742:"ac359952",5772:"40bab2e5",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:"5eca02a5",6743:"a3fe848c",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b2ebdef8",7098:"c920e4e4",7315:"92ed8946",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:"7cf9c80b",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",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 Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index b03222f14..17c7c0ea3 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 2f1dbdf00..f5158666a 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 0b3f661c5..a3e462e6b 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 62a1c36bb..1f4174e39 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 60a5515c9..19537f43b 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 ac01e75df..19bed219f 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 e37ddcce9..b48401283 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 ac54a5d31..a8742417c 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 83c34eed7..1d758f1d4 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 fc7721a76..51c628305 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 d6226da15..7370b3894 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 114312b9b..ef7bb908f 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 b6f69240a..64eb2a51e 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 1c0f5857c..d5566f756 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -22,42 +22,42 @@
  • w, h: Represents the width and height of the widget. You can adjust these values using the debug UI.
  • required: Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.
  • name: Provides a different name for widgets if you are providing more than one widget.
    • -
  • 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.
    • +
  • 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.
  • 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.

    • List of all supported widgets:

      -
    1. signature:
      2. +
    2. signature
    -
    {
      "type":"signature", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21
    }
    +
    {
      "type": "signature",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21
    }
      -
    1. stamp:
      2. +
    2. stamp
    -
    {
      "type":"stamp", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "stamp"
      }
    }
    +
    {
      "type": "stamp",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "stamp"
      }
    }
      -
    1. initials:
      2. +
    2. initials
    -
    {
      "type":"initials", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "initials"
      }
    }
    +
    {
      "type": "initials",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "initials"
      }
    }
      -
    1. email:
      2. +
    2. email
    -
    {
      "type":"email", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "email",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "email",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "email",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. name:
      2. +
    2. name
    -
    {
      "type":"name", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "name",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "name",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "name",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. job title:
      2. +
    2. iob Title
    -
    {
      "type":"job title", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "job title",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "job title",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "job title",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. company:
      2. +
    2. company
    -
    {
      "type":"company", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "company",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "company",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "company",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. date:
      2. +
    2. date
    -
    {
      "type":"date", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "date",
        "default": "04-15-2024",
        "format": "mm-dd-yyyy",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "date",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "date",
        "default": "04-15-2024",
        "format": "mm-dd-yyyy",
        "color": "black",
        "fontsize": 12
      }
    }
    • 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. @@ -70,14 +70,14 @@
    • "mmm dd, yyyy",
    • "mmmm dd, yyyy",
    • "dd mmm, yyyy",
      • -
    • "dd mmmm, yyy"
      • +
    • "dd mmmm, yyy".
      -
    1. textbox:
      2. +
    2. textbox
    -
    {
      "type":"textbox", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": { 
        "name": "textbox",
        "required": true,
        "readonly": false,
        "default": "name",
        "hint": "provide name",
        "regularexpression":"",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "textbox",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "name": "textbox",
        "required": true,
        "readonly": false,
        "default": "name",
        "hint": "provide name",
        "regularexpression": "",
        "color": "black",
        "fontsize": 12
      }
    }
    • default: Provide a default value for the textbox (Optional).
    • hint: Provide a hint for the textbox (Optional).
      • @@ -85,39 +85,39 @@
    • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
      -
    1. checkbox:
      2. +
    2. checkbox
    -
    {
      "type":"checkbox", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "checkbox",
        "values": ["male", "female", "other"],
        "selectedvalues": [ "male", "female" ],
        "readonly": false, 
        "hidelabel": false,
        "color": "black",
        "fontsize": 12,
        "validation": {
          "minselections": 0, 
          "maxselections": 0 
        }
      }
    }
    +
    {
      "type": "checkbox",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "checkbox",
        "values": ["male", "female", "other"],
        "selectedvalues": ["male", "female"],
        "readonly": false,
        "hidelabel": false,
        "color": "black",
        "fontsize": 12,
        "validation": {
          "minselections": 0,
          "maxselections": 0
        }
      }
    }
    • values: Provide options for the checkbox list.
    • selectedvalues: Provide values that need to be selected by default (Optional).
      • -
    • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false
      • +
    • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false.
    • hidelabel: Set to true if you want to hide labels of the checkbox. By default, it's false.
    • minselections: Provide the minimum number of checkboxes that must be selected by the user.
    • maxselections: Provide the maximum number of checkboxes that can be selected by the user.
      -
    1. dropdown:
      2. +
    2. dropdown
    -
    {
      "type":"dropdown", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "dropdown",
        "readonly": false,
        "values": ["male", "female", "other"],
        "default": "",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "dropdown",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "dropdown",
        "readonly": false,
        "values": ["male", "female", "other"],
        "default": "",
        "color": "black",
        "fontsize": 12
      }
    }
    • values: Provide options for the dropdown list.
    • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
    • readonly: Set to true if you want to set the dropdown as readonly. By default, it's false.
      -
    1. radio button:
      2. +
    2. radio Button
    -
    {
      "type":"radio button", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "radio button",
        "readonly": false,
        "values": ["male", "female", "other"],
        "default": "male",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "radio button",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "radio button",
        "readonly": false,
        "values": ["male", "female", "other"],
        "default": "male",
        "color": "black",
        "fontsize": 12
      }
    }
    • values: Provide options for the radio button list.
    • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
    • readonly: Set to true if you want to set the radio button as readonly. By default, it's false.
      -
    1. image:
      2. +
    2. image
    -
    {
      "type":"image", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "image"
      }
    }
    +
    {
      "type": "image",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "image"
      }
    }

    Request​

    diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index f0599e2a1..cc3dfdb38 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 a5464f33f..876b7bd54 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 b0d185711..e1bb51ef0 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -22,42 +22,42 @@
  • w, h: Represents the width and height of the widget. You can adjust these values using the debug UI.
  • required: Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.
  • name: Provides a different name for widgets if you are providing more than one widget.
    • -
  • 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.
    • +
  • 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.
  • 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.

    • List of all supported widgets:

      -
    1. signature:
      2. +
    2. signature
    -
    {
      "type":"signature", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21
    }
    +
    {
      "type": "signature",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21
    }
      -
    1. stamp:
      2. +
    2. stamp
    -
    {
      "type":"stamp", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "stamp"
      }
    }
    +
    {
      "type": "stamp",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "stamp"
      }
    }
      -
    1. initials:
      2. +
    2. initials
    -
    {
      "type":"initials", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "initials"
      }
    }
    +
    {
      "type": "initials",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "initials"
      }
    }
      -
    1. email:
      2. +
    2. email
    -
    {
      "type":"email", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "email",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "email",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "email",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. name:
      2. +
    2. name
    -
    {
      "type":"name", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "name",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "name",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "name",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. job title:
      2. +
    2. iob Title
    -
    {
      "type":"job title", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "job title",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "job title",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "job title",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. company:
      2. +
    2. company
    -
    {
      "type":"company", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "company",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "company",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "company",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. date:
      2. +
    2. date
    -
    {
      "type":"date", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "date",
        "default": "04-15-2024",
        "format": "mm-dd-yyyy",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "date",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "date",
        "default": "04-15-2024",
        "format": "mm-dd-yyyy",
        "color": "black",
        "fontsize": 12
      }
    }
    • 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. @@ -70,14 +70,14 @@
    • "mmm dd, yyyy",
    • "mmmm dd, yyyy",
    • "dd mmm, yyyy",
      • -
    • "dd mmmm, yyy"
      • +
    • "dd mmmm, yyy".
      -
    1. textbox:
      2. +
    2. textbox
    -
    {
      "type":"textbox", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": { 
        "name": "textbox",
        "required": true,
        "readonly": false,
        "default": "name",
        "hint": "provide name",
        "regularexpression":"",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "textbox",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "name": "textbox",
        "required": true,
        "readonly": false,
        "default": "name",
        "hint": "provide name",
        "regularexpression": "",
        "color": "black",
        "fontsize": 12
      }
    }
    • default: Provide a default value for the textbox (Optional).
    • hint: Provide a hint for the textbox (Optional).
      • @@ -85,39 +85,39 @@
    • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
      -
    1. checkbox:
      2. +
    2. checkbox
    -
    {
      "type":"checkbox", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "checkbox",
        "values": ["male", "female", "other"],
        "selectedvalues": [ "male", "female" ],
        "readonly": false, 
        "hidelabel": false,
        "color": "black",
        "fontsize": 12,
        "validation": {
          "minselections": 0, 
          "maxselections": 0 
        }
      }
    }
    +
    {
      "type": "checkbox",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "checkbox",
        "values": ["male", "female", "other"],
        "selectedvalues": ["male", "female"],
        "readonly": false,
        "hidelabel": false,
        "color": "black",
        "fontsize": 12,
        "validation": {
          "minselections": 0,
          "maxselections": 0
        }
      }
    }
    • values: Provide options for the checkbox list.
    • selectedvalues: Provide values that need to be selected by default (Optional).
      • -
    • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false
      • +
    • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false.
    • hidelabel: Set to true if you want to hide labels of the checkbox. By default, it's false.
    • minselections: Provide the minimum number of checkboxes that must be selected by the user.
    • maxselections: Provide the maximum number of checkboxes that can be selected by the user.
      -
    1. dropdown:
      2. +
    2. dropdown
    -
    {
      "type":"dropdown", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "dropdown",
        "readonly": false,
        "values": ["male", "female", "other"],
        "default": "",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "dropdown",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "dropdown",
        "readonly": false,
        "values": ["male", "female", "other"],
        "default": "",
        "color": "black",
        "fontsize": 12
      }
    }
    • values: Provide options for the dropdown list.
    • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
    • readonly: Set to true if you want to set the dropdown as readonly. By default, it's false.
      -
    1. radio button:
      2. +
    2. radio Button
    -
    {
      "type":"radio button", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "radio button",
        "readonly": false,
        "values": ["male", "female", "other"],
        "default": "male",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "radio button",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "radio button",
        "readonly": false,
        "values": ["male", "female", "other"],
        "default": "male",
        "color": "black",
        "fontsize": 12
      }
    }
    • values: Provide options for the radio button list.
    • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
    • readonly: Set to true if you want to set the radio button as readonly. By default, it's false.
      -
    1. image:
      2. +
    2. image
    -
    {
      "type":"image", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "image"
      }
    }
    +
    {
      "type": "image",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "image"
      }
    }

    Request​

    diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 9ee51271a..98bc88e9e 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 964356a40..f5ab1a328 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 60bed3217..492660298 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 9ae6693f7..9e1250b62 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 0895ec4e5..9d4afe6b2 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 2190bb69e..db4ccb605 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 43110ed76..a3f4babe1 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index 1bfe58c1b..8f8ad984b 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 41325e8c1..230ee818b 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 19e4340b4..922ecd43d 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 4d5f24b12..149016247 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 ca0a6d27f..36f72a72e 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 a92e813ec..055a4ae3d 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 33a90bd24..290ecb2aa 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 ea54db19d..d3eec9968 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 db2d4113d..616ae73ea 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 5a3962a96..068d39916 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 aebdd4aea..c211c3672 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 763788b65..6b1acdb36 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/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index e351723fd..70d0d63d4 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 00c1ae1a0..6313b98e7 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + @@ -22,42 +22,42 @@
  • w, h: Represents the width and height of the widget. You can adjust these values using the debug UI.
  • required: Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.
  • name: Provides a different name for widgets if you are providing more than one widget.
    • -
  • 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.
    • +
  • 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.
  • 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.

    • List of all supported widgets:

      -
    1. signature:
      2. +
    2. signature
    -
    {
      "type":"signature", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21
    }
    +
    {
      "type": "signature",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21
    }
      -
    1. stamp:
      2. +
    2. stamp
    -
    {
      "type":"stamp", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "stamp"
      }
    }
    +
    {
      "type": "stamp",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "stamp"
      }
    }
      -
    1. initials:
      2. +
    2. initials
    -
    {
      "type":"initials", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "initials"
      }
    }
    +
    {
      "type": "initials",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "initials"
      }
    }
      -
    1. email:
      2. +
    2. email
    -
    {
      "type":"email", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "email",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "email",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "email",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. name:
      2. +
    2. name
    -
    {
      "type":"name", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "name",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "name",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "name",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. job title:
      2. +
    2. iob Title
    -
    {
      "type":"job title", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "job title",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "job title",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "job title",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. company:
      2. +
    2. company
    -
    {
      "type":"company", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "company",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "company",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "company",
        "color": "black",
        "fontsize": 12
      }
    }
      -
    1. date:
      2. +
    2. date
    -
    {
      "type":"date", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "date",
        "default": "04-15-2024",
        "format": "mm-dd-yyyy",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "date",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "date",
        "default": "04-15-2024",
        "format": "mm-dd-yyyy",
        "color": "black",
        "fontsize": 12
      }
    }
    • 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. @@ -70,14 +70,14 @@
    • "mmm dd, yyyy",
    • "mmmm dd, yyyy",
    • "dd mmm, yyyy",
      • -
    • "dd mmmm, yyy"
      • +
    • "dd mmmm, yyy".
      -
    1. textbox:
      2. +
    2. textbox
    -
    {
      "type":"textbox", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "name": "textbox",
        "required": true, 
        "readonly": false,
        "default": "name",
        "hint": "provide name",
        "regularexpression":"",
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "textbox",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "name": "textbox",
        "required": true,
        "readonly": false,
        "default": "name",
        "hint": "provide name",
        "regularexpression": "",
        "color": "black",
        "fontsize": 12
      }
    }
    • default: Provide a default value for the textbox (Optional).
    • hint: Provide a hint for the textbox (Optional).
      • @@ -85,19 +85,21 @@
    • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
      -
    1. checkbox:
      2. +
    2. checkbox
    -
    {
      "type":"checkbox", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "checkbox",
        "values": ["male", "female", "other"],
        "selectedvalues": [ "male", "female" ],
        "readonly": false, 
        "hidelabel": false,
        "color": "black",
        "fontsize": 12
      }
    }
    +
    {
      "type": "checkbox",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "checkbox",
        "values": ["male", "female", "other"],
        "selectedvalues": ["male", "female"],
        "readonly": false,
        "hidelabel": false,
        "color": "black",
        "fontsize": 12,
        "validation": {
          "minselections": 0,
          "maxselections": 0
        }
      }
    }
    • values: Provide options for the checkbox list.
    • selectedvalues: Provide values that need to be selected by default (Optional).
    • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false.
    • hidelabel: Set to true if you want to hide labels of the checkbox. By default, it's false.
      • +
    • minselections: Provide the minimum number of checkboxes that must be selected by the user.
      • +
    • maxselections: Provide the maximum number of checkboxes that can be selected by the user.
      -
    1. image:
      2. +
    2. image
    -
    {
      "type":"image", 
      "page":1,  
      "x": 327, 
      "y": 628, 
      "w": 114, 
      "h": 21, 
      "options": {
        "required": true, 
        "name": "image"
      }
    }
    +
    {
      "type": "image",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "image"
      }
    }

    Request​

    diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 5f6159b40..4077b85e2 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 0532298b9..f535b1e07 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 a432ab941..c55065114 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 9eb66326b..5d002c5ee 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 9778bd29a..81bf91aab 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 858f26b4f..5306e2df1 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 feef2a4e6..7dc24baf8 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 79891c555..9dcdb390a 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 f4b51a89b..52ef39941 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 24e1b8ce7..bef3ff33e 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 38d420081..fad6dcc63 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 77d0928ba..4cd8c79a8 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 abc156568..e694acb0b 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 45484d3bc..457c638e6 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 3539c0d52..8577c2483 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 10e758d56..bf3829212 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 9a8f6b212..ab20fd995 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 052c377bd..59181e64d 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 9afc9c4db..cef6a8ff5 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 088b06ec5..06fd75611 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 7107630d8..2ab9e4894 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 7765b809a..962b468e9 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 d945b32e4..658ded425 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 4d37eeb33..4bf74d1ed 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 3415af639..f41613289 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 ea8e70879..3e84aa37e 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 311f5274e..a40129907 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 c591e3321..c46eb6616 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 4da091003..656d2517c 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 83bd26ef7..bf567fe90 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 c7dcd8b4f..762d1ead8 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 e57547c09..0ad5b6183 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 1f82ec986..8bceea34e 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 73846f6ca..905c63620 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 ddc369c07..1f9990986 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 11ea8137e..5896ca939 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 ed902a199..ebe76c9cb 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 6e7362ca1..5896f6669 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 db3e743d2..960e36368 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 65c7ca533..241e0a15f 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 f3ba397ca..163af481d 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 a2801a9f9..4d30bb13e 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 80d17ed51..ef0418281 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 1d102adbd..bf496a94c 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 c0e300b64..f0d6916dc 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 967760e84..2a0eb89bd 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 159375a01..3fde65d47 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 252910dd0..f9cd9aff0 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 367bfd1d8..e971f4066 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 a18551139..6f59599f5 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 a86e2363a..b93ff06a8 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 838fbad4e..b0d32dd96 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 9700b78b1..2f8bc70af 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 c516fb2c0..71e26a60f 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +