From 4ff87ad43b5bc29df45be10d3feb60e503bef253 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 4 Jul 2025 13:07:22 +0000 Subject: [PATCH] deploy: 73b36fafd72cb10f8a9db382ee975b8961b24acf --- 404.html | 2 +- assets/js/0028a090.3fbeff72.js | 1 - assets/js/0028a090.957b6a0a.js | 1 + assets/js/28b19cd2.2d4415d2.js | 1 + assets/js/28b19cd2.6d63629e.js | 1 - assets/js/2c586be5.1cb53b0f.js | 1 - assets/js/2c586be5.971c43af.js | 1 + assets/js/a9f09360.8ac14f3d.js | 1 - assets/js/a9f09360.afadc0af.js | 1 + assets/js/ae010e44.0eaaabdc.js | 1 + assets/js/ae010e44.13adcb02.js | 1 - assets/js/bbdfc22d.2cfac16d.js | 1 + assets/js/bbdfc22d.666e8e27.js | 1 - ...ntime~main.f90e32ae.js => runtime~main.fa074b84.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 | 10 ++++++---- docs/API-docs/createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/createfolder/index.html | 2 +- docs/API-docs/createtemplate/index.html | 10 ++++++---- 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 | 10 ++++++---- docs/API-docs/drafttemplate/index.html | 10 ++++++---- 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/revokedocument/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 2 +- docs/API-docs/selfsign/index.html | 8 +++++--- 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 +- docs/category/create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/documents/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- .../manage-docs-using-opensign-drive/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 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/index.html | 2 +- .../edit-document-before-sending/index.html | 2 +- .../New-Document/enforce-email-verification/index.html | 2 +- .../New-Document/navigate-between-pages/index.html | 2 +- docs/help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/OpenSign™ Drive/create-document/index.html | 2 +- docs/help/OpenSign™ Drive/list-grid-view/index.html | 2 +- .../help/OpenSign™ Drive/organize-documents/index.html | 2 +- docs/help/OpenSign™ Drive/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 +- docs/help/Settings/APIToken/index.html | 2 +- docs/help/Settings/Custom-email-templates/index.html | 2 +- docs/help/Settings/Preferences/index.html | 2 +- docs/help/Settings/SecurityManagement/index.html | 2 +- docs/help/Settings/Teams/index.html | 2 +- docs/help/Settings/Webhook/index.html | 2 +- docs/help/Settings/disabledocumentid/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- docs/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 +- docs/self-host/docker/upgrade-deployment/index.html | 2 +- docs/self-host/guides/azure-vm-setup/index.html | 2 +- docs/self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- docs/self-host/guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 116 files changed, 134 insertions(+), 124 deletions(-) delete mode 100644 assets/js/0028a090.3fbeff72.js create mode 100644 assets/js/0028a090.957b6a0a.js create mode 100644 assets/js/28b19cd2.2d4415d2.js delete mode 100644 assets/js/28b19cd2.6d63629e.js delete mode 100644 assets/js/2c586be5.1cb53b0f.js create mode 100644 assets/js/2c586be5.971c43af.js delete mode 100644 assets/js/a9f09360.8ac14f3d.js create mode 100644 assets/js/a9f09360.afadc0af.js create mode 100644 assets/js/ae010e44.0eaaabdc.js delete mode 100644 assets/js/ae010e44.13adcb02.js create mode 100644 assets/js/bbdfc22d.2cfac16d.js delete mode 100644 assets/js/bbdfc22d.666e8e27.js rename assets/js/{runtime~main.f90e32ae.js => runtime~main.fa074b84.js} (95%) diff --git a/404.html b/404.html index 8673fd61a..b4a8d9848 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.3fbeff72.js b/assets/js/0028a090.3fbeff72.js deleted file mode 100644 index ff86e7865..000000000 --- a/assets/js/0028a090.3fbeff72.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/drafttemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/drafttemplate","permalink":"/docs/API-docs/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9ty27iSv4LD2qpMtJRsKY4n8dN6Ek+inPiysXO1fTwg2RJhkwADgJYVl6r24fzB/sH5tPmSrcaFInWxncvmeKr0klhEA+hu9A2N7utA06EKto6DI8iLjGpQwWkYJKBiyQrNBA+2gqMUiB8mzyUdaMaHZPugT4DTKANFSgVSES1ILAGB4lJpkbMvOEq0XzkkCuQlzqWKRFkJhWRcKzIQkgyBg6Rm4UTEZQ44MGI6JYWEBAaMQ0KUlmWsSwmqQ94WghNVxjEoNSgzuzMTnIgBodWeIdEpGFQl6FJyRSgpOftcAmm1RHQOse4nrRb5JQHFhpxqSBA5P/2MJQ9DMkpZnJKYchIBkpogpQ5hqKEbURwT3OypCojZgCGwW6xDtpOEIY40y8YhoaTVKmXWahGmSCHFJUsg8buJwQBZSg1rCeMa5IDGYHgFuAofmm384oTyhAxozDKmm2wkCVNasqjEnTsn/IQfsWKLvC0yQRMyFqUkB89/n4JrQfDbcav1HKJySN72W63TX1KtC7W1tkaLoiMK4MitjEaqE4t8LUHAIhkYXoEEXNXwC6hi2ZjQJCEjlgxBK3MgnMSiGJNYCJkwbkWjoEMgvMwjkCo01ORCAmGcUCKBJuO2Fu1SAXl1uL+HbMip7pCDrFRhtV3CJMQ6G9vlkT2eqgf2dDY3UIYYH4YkpxfIJabJ55LFF0i2Am6O1omM4VWr9R7xrbjDlJPxhBCdMkVGEKVCXBC4xOERyzKiJRsOQbZaJ/yPP/444dcnnJCTwECcBFvkJHBLnAShHdLjAuzI8/1nb3d39o7Ojj4e7FTjXlJnYPrPK4gBy2ZXePvmdTXMaT47vLe9O92AC+3GDzKgCoiESwYjcw541JZWz4VqWs1O2NnVCE4CqfDrMX4h5Nr+18TmsP9ib+dNHRcLATllWQNkZ3e7/7oBU6SCN5c5eLm/11ynlLVV+nsvLFPs+AT/O3X4uhPZdgd01N/dOTza3j1A4Ik7R5SGw7IohMTjf28FeguP+YT/BpkYESrBSE8s8lxwUlBJc9DGNqZUm2EJn0smIbHGjWaZ14ytE94mrRaKwlarRfo8YTGqhlXzcQFo2Sxsx4KiyiDooTM1FrSmSGiLrDlBDRlRq91FhoYEQSWgldLsEpoLX4VkjAs/B5QLu2wqJPsiuKaZEYpLkJrFNKsrMSJoTJ+m0pigQjCu/Ve3A/nolBV12aioszKIWoLMyhk3IwrIJc1KUA6rUUhSxOoNFBKUsbhuXWQkT0gKbJgu3Y8m56XSjYVJqbwd9Vi4vfwpGfaCYduAZgoIGzR4mdMLqO1GRGHte4f8NiYJDGiZ6ZAwtD9altAhe0ITWhQZi41vRHNuHU8poW1O2YmDQwRVBZE4sP4BPULC0DegtcFBs4Sb47FDObMOBckzdlSnlBPBZw46FpmQ8yJkPjf5SGLBNXDdIduXlGUGeUusIozHWZkAiTIaX4TGs4dEoi/DUxlDlolRaOXdgBgPa3hu+EMUZCiFgiP+XLjtmZr60A45QvtT6RMOelabTZiqc9XZ8IHAnZEFXsWIsSuhYVxIzkVENNMZhKiwBeXjkCQ2aIArHYmrkMQpxBfmL0kTJkhUai24JSyRokjEiDteDgTXin1ZoJF+5Os52gvJRkg2Q/IkJN31kHR7IeluhKS7GZLuk5D01kPS64WktxGS3qZFq/fE8ZpWDK4j0O1ZLuu/DnfR7r5mymg2GkxV2eBRwwZ3O6TVqrRp1v1OfWwFUnkrtJk41nW/r/DHo96v7ucYf272nrifIwPa3XA/U/zZ69b9RM9gomle3IAFDv9QDHywYIUIvzmfexJ4e4Yf0RCFfmDqih0+ODCp0/IIaWGcaUYztZwcD3GPKJqiNEfUBhJlxHU5RS4GuTfk1PExIQuaSTtkzGptyCu8waI3R/3jjvMsy4m3294b2mvofB/pm0g6mqYjNE3L6a+s1z1iwixO38eJXzsmADCWeTkfHMA94kITo+/jwRPkATql5QzA0XtEfQ0dewEzHt6OrW+0u4/bvfXeRoMDeFO2AHneTpL2eDz+EdzDmMdtjyGPj1BtZIcZiYEU+YLrh7kdTKFcTGT+9iH7LgbqEVRJEcwCNHMq/v5fj7K1SOj4gbJL+alVcIbw09BsXEPTDCEeJhcSp4LFDnmE8SFZhBe8DvKgbTi5liRrNU7ixyRp53l75iP+bBvG1z7meSdJOjOQc6djP+YkSUIy/3nh9yQheZ4v+Wy/nwQmpHqKou8iseXS7wB+lgJM5by58Y3KgdkhwTOzt7mkLdaOGReSMp+McaJCZgAkDMuMSrjC26aazXD8QM3xijON183t1FzsbIrPsIL8su9i8odOqJGE5gL45fZ5c5ThItsuaUskDOGKFFRrkNwsdkkzltjkatsmIK9oXmBgv/aPk5PkP/9jzaQV8OauCZ4ESdiQYa5v7R/H2+1PpwsgyqIAGWOmKQPcSYUEdNwhxylkxTTdOBqNOqNHKk6FyGyu8VxJGNh/z0R0fmbQLTpUFQ8XUWpFo3aNR9GZvcUr0A2OUUX8zAUXeSNjRoe668aHulvMDU7UQdwjPzKDEg7anIjN2AU5NWEGijJM/xY6BXkSnFZz7NUdklvmnt5BWVOWQEYjyOaH7qxodVqcyNYYgwM541W6weC7XssW5vRqZvBkmimcUWBLcV39vKfw+udZTDKmfMKlya/6bJeRMnlCDvaNIQLiJ5CoEsPvFvMKsbvJuTU17nBu2QLhiAGssoF+t1t2aBxMnTG4Rs44y8u8SmsOqlU9y3IXMtT5hTPx+cTvUD/duR3o1S07uPefJRuc8K5JP/i0xQ0BpYO4R8ZgBqWb9fRbzETDEf8gD3q7Anqy6gq4wO8iqPW4lfKp5drXIfvovzCVaidhciyOodCYSPte1axQvrMLMqmmevpsueTVoe6R9C1A6/9ZAh3cz5HCOnl/IUlsoH1nabTJwpwOb7hRm+F7JH8On5nDDcJAFKYkQfB+EmwFCRY++Of2IDQrg9K/iWQcbF0HLpuPf7pcOc5cO1dYQnEdqDiFnOJfHiMsusBX2yD0j6VBGJj0DlZgILuCLffwG4R4SSnwyQ0UrmHmbV17KPumHYTush9sBfaxOwgDF6pXnwjwWOCVukgGwcRveNNS1ZfpUsr8UdUe4Dr4UPiNy5ipk5mik29aqb7CZMrW6WJUSjoOZutb/AuhvwjaedUTSDb2OsI0akL1bGXAgjBgGvL6LksOTYqv53QMAikxqd+vnWuOheZfvSfOM2/r3zLRvcgs4PkduWRH5zduHtk2vj1B4qPm9vQRNSTmIaNzm8R4eEMtHdb3tDHg3J5Hyx7Xa296KhVlluBrGVDZMW/c31xMY+qpaBaXpr6n8g0NyipUK8q6kzC4up2YKxKLtn+5J79kMND2Tk5iITnIh/X03b0hrrexMQmD8e3kjf+S5P2Khze6nbr3puRhWg7y78D10ZNJGKS34/qyKsr4NyK7sTmZ+jpX61PV+EUiGZ95uzW5DdA7FYTDgrE+35cJyBojIiEyoHyOE/2BDa4EeYCRyIPQZsLMWzqTyjsUW0MmIQasyzFpb2+riIs57EM7ce+bGJPt4AcTK6oyUgjF/XrKLhiBr0vDQkoLwWwhoqkWABqnWAHn8nN0gIUApp4IS8FEqTx6KVXmQT8DDEd1CsyWsDA+bMaGNe6YYo467Z366eAXdHKmmHT/6OAOvDSRa9tWpVk/bam0a5D9owOsUGIDF4Z1yFtVccKzljZACIZF5JJRX8VQ2faxTS4ANxwRvh5uWlzYcbVBbTKPUMLUQoxCrGSw5RNV8ezcwtOCRjwiUWqspHQVpERpKFSDjwaLipFHoryLVN7CSUqGpXmC0aiyvlzJ5GunFUaM28pcc+9JSumLqpxYICSW6U755LmCQLX1QwJc2emUDKjSIEMs10XOyxLvNdWScFWAZMBjWMgCCZZ1Z6VcGDc1edAs13n75rUrY/U0eKWMUAPtwpCQsjBSYzShKiPzJzdL+lyghNoB8mxZgDYfephiL5dTK0AqLHWWRMgh5eyLK33GiEQoIBGkNLOgzlTgAxbigxreRMbb2j//+a8aXksjznnE7A40SfA14RYMzb3WCjxG3BIKtICiiRGuB/K/Zp0AYmeU5iwXSaVI6u4yfmDeH1RlF7UwlcmQga3fVmWcYoBf2VsVehurXFipQiQJ3wlMnbcokF64YkrXCqH8c+W8fXgDyMe4hoMJQ1CrUeb5uK7gFV6u4Gq6nCnXYs0iusoNzukCLbU4k5Azfjc/VU8OaFEZglKLnGoWE7+U6jRLI7F+c6rXOdbUW9RQGi+ZkA+XqCoudyZ4DGeMn8ElyDsEeHtVnjahYxRuPQLgddw8k6w7m5avjbCeu8GTmncyRZp1LB/fEg/YgGF6p3e+DCtrBVf2StNbX8f/ZjTHF+77cvJpL0M2/lsQ3j2hcPN9ypeOL9Llqcr9lvZeqoLncYpatsRoTsFvjtXqiZI1GL9Koxcx22ev+m+/9Lt7rK/6/M3j+Fl/s39RfHj37NXTDoxfdePeu/GH3jv98X2m+ueCxS9fpZ/4OxU9e1x+/PBJfvzQlx/fv9H0/ePtiKc8evE7i8ePz6PeOnv97NX6p/fdUfTi9/VP754Wn8ziv69/urhYj/O9ZxHfRpji44f/ZvvnO492v+x82T3audr9kj3t0L3P58+u4qe7Fzub7U992d7dj/5+/lkXbx4nj/Y+sM0nsAvv+dH66zioSwPjGeNw5o/6zNB9hoc9MUKxsejYD0UOOjXGwvQLSIHNCIUtutdyTOiQMk6QdfIHSgFIKeTNZ/p1mN3EiI319bNuxYTH80zoc/M+Z/pyjsQF8J9LaX17bbdHVK9yI/XWIwfMApnxoEFs/bslUkFcSqbHwdbxdXDVpgVr2/Gt49PJaRggYwXmEAuhDMZUp8FWsDabUsT2KJOwOr62OlgpmqI8wTe0OWWjBVu77AaTcHbGQtVcCg1l++smKE2HjA9vnnU6Zc0hHp89oQaDpmmigv0dME/k+F+HCgOGYpMCRQ+GHEepeDNNwO74s/Wp0UXZzukZzuYvffqykZGc9TgLcoy1FOOxz++ZlF2VsQumBAVVVg3/rPJkx1NJrVJSPiPVNamc3saGyXn82jXJgUdPzL17Y3Nyahlcu4OaDHf9ImUfTho3AvepGSEHwUxE2ggLZ6PCpRHakgDNbTkTiFSILPL/jyd46ANhJMQd234B/BDvSKi4l935tAhkscirAnUP/uc//2Vm+PjJYPU3fK7YLyUpxAgkNhCaBroMrhgGCaa5MTdjyqR+zcsIzTNQCvPBXMPQdv9hpQvexly8H9OCRtiEh7cJxrWwVWU1i6Y65H0K+D6FQw+kLfy5hAytWBVm1Rv4RkJeDDIxwr44EmHPCgbawFPKYxvTWx0zsSl23eF9qZBMYSuORKyZxU1wLWmsSU45HZrgMmxwKYGMoQEiUkR45VUiK+2lTlOWCWmrEgxB5m3KvPnsXBU4ZFI6eBuSkKJUXLqbnQrtzdqqj2vtizCJUSAuLAYT4JY8E9iFh8mQMstIIbRNUGCIV8cRp2tJucJ0j8XFn0HFMHfpAuWaB94qwBN+zfiF7RVok+NKmN5DpJiGZs3RrGQ/bM55wfTLMsJOJKGYFnI8nT1kOi0jYwbri1Q/7EovfPdozcxN10hErBbEVSJWa1getXYIGiVErW0f9I3/fEj+/J//Ja+BSk5SMbLSGpcSsvG0UdX0VJqTt2yr3J+51tMSGzO1EVI+9Jkm5GAQzprsptpJGIBE5qtGXywtmFv+2KNJmsVdX08mOmKUYhqbOMGbI1qwhbdFbCZT+4ND7DqOfdy65ITXDPBaEAYZi4ErqMUC2y8OXpNL8qizHoQ1P3iH01573X+2s3e4g9igZlmOdTvrnXXz8CCUzimvbWXaq6tu61kTV3tmXHVlr7qyV13Zq67sVVf2qit71ZW96spedWWvurJXXdmrrmyy6spedWX/JNpXXdmrruxVV/aqK3vVlb3qyl51Za+6sldd2auu7FVX9qore9WV/UOCylVX9j3phV11Zf8MCVx1Za+6su/Qle2q5TAqXCsyynitYtkWVh7P9GqfhkGKhZdbx8H1NT44v5XZZIKfP5em2Oz4NAwuqWSYSDc1m6GvNcTyvAsYB1vBM/su0D7C7UMr7ab0ZKZUFUsl7Yxtc+o3wtZrQw/2D4+CMIhcP3kuEpwj6Qh7zenI1ug5Zpp2Ymo6BTPKh6WpFgzsmhNb8p82aysvTG2l+6NWdEj5uIZhs+jSkoH/IlELJ1xf27rNyaSCt0NLZzjGemg8vtPJZPJ/bWYI/A==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"}}');var s=t(74848),r=t(28453),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 g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9ty27iSv4LD2qpMtJRsKY4n8dN6Ek+inPiysXO1fTwg2RJhkwADgJYVl6r24fzB/sH5tPmSrcaFInWxncvmeKr0klhEA+hu9A2N7utA06EKto6DI8iLjGpQwWkYJKBiyQrNBA+2gqMUiB8mzyUdaMaHZPugT4DTKANFSgVSES1ILAGB4lJpkbMvOEq0XzkkCuQlzqWKRFkJhWRcKzIQkgyBg6Rm4UTEZQ44MGI6JYWEBAaMQ0KUlmWsSwmqQ94WghNVxjEoNSgzuzMTnIgBodWeIdEpGFQl6FJyRSgpOftcAmm1RHQOse4nrRb5JQHFhpxqSBA5P/2MJQ9DMkpZnJKYchIBkpogpQ5hqKEbURwT3OypCojZgCGwW6xDtpOEIY40y8YhoaTVKmXWahGmSCHFJUsg8buJwQBZSg1rCeMa5IDGYHgFuAofmm384oTyhAxozDKmm2wkCVNasqjEnTsn/IQfsWKLvC0yQRMyFqUkB89/n4JrQfDbcav1HKJySN72W63TX1KtC7W1tkaLoiMK4MitjEaqE4t8LUHAIhkYXoEEXNXwC6hi2ZjQJCEjlgxBK3MgnMSiGJNYCJkwbkWjoEMgvMwjkCo01ORCAmGcUCKBJuO2Fu1SAXl1uL+HbMip7pCDrFRhtV3CJMQ6G9vlkT2eqgf2dDY3UIYYH4YkpxfIJabJ55LFF0i2Am6O1omM4VWr9R7xrbjDlJPxhBCdMkVGEKVCXBC4xOERyzKiJRsOQbZaJ/yPP/444dcnnJCTwECcBFvkJHBLnAShHdLjAuzI8/1nb3d39o7Ojj4e7FTjXlJnYPrPK4gBy2ZXePvmdTXMaT47vLe9O92AC+3GDzKgCoiESwYjcw541JZWz4VqWs1O2NnVCE4CqfDrMX4h5Nr+18TmsP9ib+dNHRcLATllWQNkZ3e7/7oBU6SCN5c5eLm/11ynlLVV+nsvLFPs+AT/O3X4uhPZdgd01N/dOTza3j1A4Ik7R5SGw7IohMTjf28FeguP+YT/BpkYESrBSE8s8lxwUlBJc9DGNqZUm2EJn0smIbHGjWaZ14ytE94mrRaKwlarRfo8YTGqhlXzcQFo2Sxsx4KiyiDooTM1FrSmSGiLrDlBDRlRq91FhoYEQSWgldLsEpoLX4VkjAs/B5QLu2wqJPsiuKaZEYpLkJrFNKsrMSJoTJ+m0pigQjCu/Ve3A/nolBV12aioszKIWoLMyhk3IwrIJc1KUA6rUUhSxOoNFBKUsbhuXWQkT0gKbJgu3Y8m56XSjYVJqbwd9Vi4vfwpGfaCYduAZgoIGzR4mdMLqO1GRGHte4f8NiYJDGiZ6ZAwtD9altAhe0ITWhQZi41vRHNuHU8poW1O2YmDQwRVBZE4sP4BPULC0DegtcFBs4Sb47FDObMOBckzdlSnlBPBZw46FpmQ8yJkPjf5SGLBNXDdIduXlGUGeUusIozHWZkAiTIaX4TGs4dEoi/DUxlDlolRaOXdgBgPa3hu+EMUZCiFgiP+XLjtmZr60A45QvtT6RMOelabTZiqc9XZ8IHAnZEFXsWIsSuhYVxIzkVENNMZhKiwBeXjkCQ2aIArHYmrkMQpxBfmL0kTJkhUai24JSyRokjEiDteDgTXin1ZoJF+5Os52gvJRkg2Q/IkJN31kHR7IeluhKS7GZLuk5D01kPS64WktxGS3qZFq/fE8ZpWDK4j0O1ZLuu/DnfR7r5mymg2GkxV2eBRwwZ3O6TVqrRp1v1OfWwFUnkrtJk41nW/r/DHo96v7ucYf272nrifIwPa3XA/U/zZ69b9RM9gomle3IAFDv9QDHywYIUIvzmfexJ4e4Yf0RCFfmDqih0+ODCp0/IIaWGcaUYztZwcD3GPKJqiNEfUBhJlxHU5RS4GuTfk1PExIQuaSTtkzGptyCu8waI3R/3jjvMsy4m3294b2mvofB/pm0g6mqYjNE3L6a+s1z1iwixO38eJXzsmADCWeTkfHMA94kITo+/jwRPkATql5QzA0XtEfQ0dewEzHt6OrW+0u4/bvfXeRoMDeFO2AHneTpL2eDz+EdzDmMdtjyGPj1BtZIcZiYEU+YLrh7kdTKFcTGT+9iH7LgbqEVRJEcwCNHMq/v5fj7K1SOj4gbJL+alVcIbw09BsXEPTDCEeJhcSp4LFDnmE8SFZhBe8DvKgbTi5liRrNU7ixyRp53l75iP+bBvG1z7meSdJOjOQc6djP+YkSUIy/3nh9yQheZ4v+Wy/nwQmpHqKou8iseXS7wB+lgJM5by58Y3KgdkhwTOzt7mkLdaOGReSMp+McaJCZgAkDMuMSrjC26aazXD8QM3xijON183t1FzsbIrPsIL8su9i8odOqJGE5gL45fZ5c5ThItsuaUskDOGKFFRrkNwsdkkzltjkatsmIK9oXmBgv/aPk5PkP/9jzaQV8OauCZ4ESdiQYa5v7R/H2+1PpwsgyqIAGWOmKQPcSYUEdNwhxylkxTTdOBqNOqNHKk6FyGyu8VxJGNh/z0R0fmbQLTpUFQ8XUWpFo3aNR9GZvcUr0A2OUUX8zAUXeSNjRoe668aHulvMDU7UQdwjPzKDEg7anIjN2AU5NWEGijJM/xY6BXkSnFZz7NUdklvmnt5BWVOWQEYjyOaH7qxodVqcyNYYgwM541W6weC7XssW5vRqZvBkmimcUWBLcV39vKfw+udZTDKmfMKlya/6bJeRMnlCDvaNIQLiJ5CoEsPvFvMKsbvJuTU17nBu2QLhiAGssoF+t1t2aBxMnTG4Rs44y8u8SmsOqlU9y3IXMtT5hTPx+cTvUD/duR3o1S07uPefJRuc8K5JP/i0xQ0BpYO4R8ZgBqWb9fRbzETDEf8gD3q7Anqy6gq4wO8iqPW4lfKp5drXIfvovzCVaidhciyOodCYSPte1axQvrMLMqmmevpsueTVoe6R9C1A6/9ZAh3cz5HCOnl/IUlsoH1nabTJwpwOb7hRm+F7JH8On5nDDcJAFKYkQfB+EmwFCRY++Of2IDQrg9K/iWQcbF0HLpuPf7pcOc5cO1dYQnEdqDiFnOJfHiMsusBX2yD0j6VBGJj0DlZgILuCLffwG4R4SSnwyQ0UrmHmbV17KPumHYTush9sBfaxOwgDF6pXnwjwWOCVukgGwcRveNNS1ZfpUsr8UdUe4Dr4UPiNy5ipk5mik29aqb7CZMrW6WJUSjoOZutb/AuhvwjaedUTSDb2OsI0akL1bGXAgjBgGvL6LksOTYqv53QMAikxqd+vnWuOheZfvSfOM2/r3zLRvcgs4PkduWRH5zduHtk2vj1B4qPm9vQRNSTmIaNzm8R4eEMtHdb3tDHg3J5Hyx7Xa296KhVlluBrGVDZMW/c31xMY+qpaBaXpr6n8g0NyipUK8q6kzC4up2YKxKLtn+5J79kMND2Tk5iITnIh/X03b0hrrexMQmD8e3kjf+S5P2Khze6nbr3puRhWg7y78D10ZNJGKS34/qyKsr4NyK7sTmZ+jpX61PV+EUiGZ95uzW5DdA7FYTDgrE+35cJyBojIiEyoHyOE/2BDa4EeYCRyIPQZsLMWzqTyjsUW0MmIQasyzFpb2+riIs57EM7ce+bGJPt4AcTK6oyUgjF/XrKLhiBr0vDQkoLwWwhoqkWABqnWAHn8nN0gIUApp4IS8FEqTx6KVXmQT8DDEd1CsyWsDA+bMaGNe6YYo467Z366eAXdHKmmHT/6OAOvDSRa9tWpVk/bam0a5D9owOsUGIDF4Z1yFtVccKzljZACIZF5JJRX8VQ2faxTS4ANxwRvh5uWlzYcbVBbTKPUMLUQoxCrGSw5RNV8ezcwtOCRjwiUWqspHQVpERpKFSDjwaLipFHoryLVN7CSUqGpXmC0aiyvlzJ5GunFUaM28pcc+9JSumLqpxYICSW6U755LmCQLX1QwJc2emUDKjSIEMs10XOyxLvNdWScFWAZMBjWMgCCZZ1Z6VcGDc1edAs13n75rUrY/U0eKWMUAPtwpCQsjBSYzShKiPzJzdL+lyghNoB8mxZgDYfephiL5dTK0AqLHWWRMgh5eyLK33GiEQoIBGkNLOgzlTgAxbigxreRMbb2j//+a8aXksjznnE7A40SfA14RYMzb3WCjxG3BIKtICiiRGuB/K/Zp0AYmeU5iwXSaVI6u4yfmDeH1RlF7UwlcmQga3fVmWcYoBf2VsVehurXFipQiQJ3wlMnbcokF64YkrXCqH8c+W8fXgDyMe4hoMJQ1CrUeb5uK7gFV6u4Gq6nCnXYs0iusoNzukCLbU4k5Azfjc/VU8OaFEZglKLnGoWE7+U6jRLI7F+c6rXOdbUW9RQGi+ZkA+XqCoudyZ4DGeMn8ElyDsEeHtVnjahYxRuPQLgddw8k6w7m5avjbCeu8GTmncyRZp1LB/fEg/YgGF6p3e+DCtrBVf2StNbX8f/ZjTHF+77cvJpL0M2/lsQ3j2hcPN9ypeOL9Llqcr9lvZeqoLncYpatsRoTsFvjtXqiZI1GL9Koxcx22ev+m+/9Lt7rK/6/M3j+Fl/s39RfHj37NXTDoxfdePeu/GH3jv98X2m+ueCxS9fpZ/4OxU9e1x+/PBJfvzQlx/fv9H0/ePtiKc8evE7i8ePz6PeOnv97NX6p/fdUfTi9/VP754Wn8ziv69/urhYj/O9ZxHfRpji44f/ZvvnO492v+x82T3audr9kj3t0L3P58+u4qe7Fzub7U992d7dj/5+/lkXbx4nj/Y+sM0nsAvv+dH66zioSwPjGeNw5o/6zNB9hoc9MUKxsejYD0UOOjXGwvQLSIHNCIUtutdyTOiQMk6QdfIHSgFIKeTNZ/p1mN3EiI319bNuxYTH80zoc/M+Z/pyjsQF8J9LaX17bbdHVK9yI/XWIwfMApnxoEFs/bslUkFcSqbHwdbxdXDVpgVr2/Gt49PJaRggYwXmEAuhDMZUp8FWsDabUsT2KJOwOr62OlgpmqI8wTe0OWWjBVu77AaTcHbGQtVcCg1l++smKE2HjA9vnnU6Zc0hHp89oQaDpmmigv0dME/k+F+HCgOGYpMCRQ+GHEepeDNNwO74s/Wp0UXZzukZzuYvffqykZGc9TgLcoy1FOOxz++ZlF2VsQumBAVVVg3/rPJkx1NJrVJSPiPVNamc3saGyXn82jXJgUdPzL17Y3Nyahlcu4OaDHf9ImUfTho3AvepGSEHwUxE2ggLZ6PCpRHakgDNbTkTiFSILPL/jyd46ANhJMQd234B/BDvSKi4l935tAhkscirAnUP/uc//2Vm+PjJYPU3fK7YLyUpxAgkNhCaBroMrhgGCaa5MTdjyqR+zcsIzTNQCvPBXMPQdv9hpQvexly8H9OCRtiEh7cJxrWwVWU1i6Y65H0K+D6FQw+kLfy5hAytWBVm1Rv4RkJeDDIxwr44EmHPCgbawFPKYxvTWx0zsSl23eF9qZBMYSuORKyZxU1wLWmsSU45HZrgMmxwKYGMoQEiUkR45VUiK+2lTlOWCWmrEgxB5m3KvPnsXBU4ZFI6eBuSkKJUXLqbnQrtzdqqj2vtizCJUSAuLAYT4JY8E9iFh8mQMstIIbRNUGCIV8cRp2tJucJ0j8XFn0HFMHfpAuWaB94qwBN+zfiF7RVok+NKmN5DpJiGZs3RrGQ/bM55wfTLMsJOJKGYFnI8nT1kOi0jYwbri1Q/7EovfPdozcxN10hErBbEVSJWa1getXYIGiVErW0f9I3/fEj+/J//Ja+BSk5SMbLSGpcSsvG0UdX0VJqTt2yr3J+51tMSGzO1EVI+9Jkm5GAQzprsptpJGIBE5qtGXywtmFv+2KNJmsVdX08mOmKUYhqbOMGbI1qwhbdFbCZT+4ND7DqOfdy65ITXDPBaEAYZi4ErqMUC2y8OXpNL8qizHoQ1P3iH01573X+2s3e4g9igZlmOdTvrnXXz8CCUzimvbWXaq6tu61kTV3tmXHVlr7qyV13Zq67sVVf2qit71ZW96spedWWvurJXXdmrrmyy6spedWX/JNpXXdmrruxVV/aqK3vVlb3qyl51Za+6sldd2auu7FVX9qore9WV/UOCylVX9j3phV11Zf8MCVx1Za+6su/Qle2q5TAqXCsyynitYtkWVh7P9GqfhkGKhZdbx8H1NT44v5XZZIKfP5em2Oz4NAwuqWSYSDc1m6GvNcTyvAsYB1vBM/su0D7C7UMr7ab0ZKZUFUsl7Yxtc+o3wtZrQw/2D4+CMIhcP3kuEpwj6Qh7zenI1ug5Zpp2Ymo6BTPKh6WpFgzsmhNb8p82aysvTG2l+6NWdEj5uIZhs+jSkoH/IlELJ1xf27rNyaSCt0NLZzjGemg8vtPJZPJ/bWYI/A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,x={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.957b6a0a.js b/assets/js/0028a090.957b6a0a.js new file mode 100644 index 000000000..1163179ba --- /dev/null +++ b/assets/js/0028a090.957b6a0a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>x});const i=JSON.parse('{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/drafttemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/drafttemplate","permalink":"/docs/API-docs/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9ty27iSv4LD2qpMtJRsKY4n8dN6Ek+inPiysXO1fTwg2RJhkwADgJYVl6r24fzB/sH5tPmSrcaFInWxncvmeKr0klhEA+hu9A2N7utA06EKto6DI8iLjGpQwWkYJKBiyQrNBA+2gqMUiB8mzyUdaMaHZPugT4DTKANFSgVSES1ILAGB4lJpkbMvOEq0XzkkCuQlzqWKRFkJhWRcKzIQkgyBg6Rm4UTEZQ44MGI6JYWEBAaMQ0KUlmWsSwmqQ94WghNVxjEoNSgzuzMTnIgBodWeIdEpGFQl6FJyRSgpOftcAmm1RHQOse4nrRb5JQHFhpxqSBA5P/2MJQ9DMkpZnJKYchIBkpogpQ5hqKEbURwT3OypCojZgCGwW6xDtpOEIY40y8YhoaTVKmXWahGmSCHFJUsg8buJwQBZSg1rCeMa5IDGYHgFuAofmm384oTyhAxozDKmm2wkCVNasqjEnTsn/IQfsWKLvC0yQRMyFqUkB89/n4JrQfDbcav1HKJySN72W63TX1KtC7W1tkaLoiMK4MitjEaqE4t8LUHAIhkYXoEEXNXwC6hi2ZjQJCEjlgxBK3MgnMSiGJNYCJkwbkWjoEMgvMwjkCo01ORCAmGcUCKBJuO2Fu1SAXl1uL+HbMip7pCDrFRhtV3CJMQ6G9vlkT2eqgf2dDY3UIYYH4YkpxfIJabJ55LFF0i2Am6O1omM4VWr9R7xrbjDlJPxhBCdMkVGEKVCXBC4xOERyzKiJRsOQbZaJ/yPP/444dcnnJCTwECcBFvkJHBLnAShHdLjAuzI8/1nb3d39o7Ojj4e7FTjXlJnYPrPK4gBy2ZXePvmdTXMaT47vLe9O92AC+3GDzKgCoiESwYjcw541JZWz4VqWs1O2NnVCE4CqfDrMX4h5Nr+18TmsP9ib+dNHRcLATllWQNkZ3e7/7oBU6SCN5c5eLm/11ynlLVV+nsvLFPs+AT/O3X4uhPZdgd01N/dOTza3j1A4Ik7R5SGw7IohMTjf28FeguP+YT/BpkYESrBSE8s8lxwUlBJc9DGNqZUm2EJn0smIbHGjWaZ14ytE94mrRaKwlarRfo8YTGqhlXzcQFo2Sxsx4KiyiDooTM1FrSmSGiLrDlBDRlRq91FhoYEQSWgldLsEpoLX4VkjAs/B5QLu2wqJPsiuKaZEYpLkJrFNKsrMSJoTJ+m0pigQjCu/Ve3A/nolBV12aioszKIWoLMyhk3IwrIJc1KUA6rUUhSxOoNFBKUsbhuXWQkT0gKbJgu3Y8m56XSjYVJqbwd9Vi4vfwpGfaCYduAZgoIGzR4mdMLqO1GRGHte4f8NiYJDGiZ6ZAwtD9altAhe0ITWhQZi41vRHNuHU8poW1O2YmDQwRVBZE4sP4BPULC0DegtcFBs4Sb47FDObMOBckzdlSnlBPBZw46FpmQ8yJkPjf5SGLBNXDdIduXlGUGeUusIozHWZkAiTIaX4TGs4dEoi/DUxlDlolRaOXdgBgPa3hu+EMUZCiFgiP+XLjtmZr60A45QvtT6RMOelabTZiqc9XZ8IHAnZEFXsWIsSuhYVxIzkVENNMZhKiwBeXjkCQ2aIArHYmrkMQpxBfmL0kTJkhUai24JSyRokjEiDteDgTXin1ZoJF+5Os52gvJRkg2Q/IkJN31kHR7IeluhKS7GZLuk5D01kPS64WktxGS3qZFq/fE8ZpWDK4j0O1ZLuu/DnfR7r5mymg2GkxV2eBRwwZ3O6TVqrRp1v1OfWwFUnkrtJk41nW/r/DHo96v7ucYf272nrifIwPa3XA/U/zZ69b9RM9gomle3IAFDv9QDHywYIUIvzmfexJ4e4Yf0RCFfmDqih0+ODCp0/IIaWGcaUYztZwcD3GPKJqiNEfUBhJlxHU5RS4GuTfk1PExIQuaSTtkzGptyCu8waI3R/3jjvMsy4m3294b2mvofB/pm0g6mqYjNE3L6a+s1z1iwixO38eJXzsmADCWeTkfHMA94kITo+/jwRPkATql5QzA0XtEfQ0dewEzHt6OrW+0u4/bvfXeRoMDeFO2AHneTpL2eDz+EdzDmMdtjyGPj1BtZIcZiYEU+YLrh7kdTKFcTGT+9iH7LgbqEVRJEcwCNHMq/v5fj7K1SOj4gbJL+alVcIbw09BsXEPTDCEeJhcSp4LFDnmE8SFZhBe8DvKgbTi5liRrNU7ixyRp53l75iP+bBvG1z7meSdJOjOQc6djP+YkSUIy/3nh9yQheZ4v+Wy/Nz6v5fk8FZ08d7iZ4OspKomL2ZbriQP4Waoy1YjmxjeqEeaRBM/M3uY6t1iPZpxNynzaxgkVmQGQMCwzKuEK76VqNhfyA3XMq9g0sjf3WHMFtMlAwwryy76L3h868UcSmgvgl9vnzVGGi2y79C6RMIQrUlCtQXKz2CXNWGLTsG2bqryieYFXgLV/nJwk//kfayYBgXd8TfAkSMKGDLOCa/843m5/Ol0AURYFyBhzUhngTiokoOMOOU4hK6aJydFo1Bk9UnEqRGazkudKwsD+eyai8zODbtGhqni4iFIrGrULP4rO7H1fgW5wjCriZy648hsZMzrUXTfe1t13bnC3DuIeeZwZlHDQZk9sbi/IqQlIUJRh+rfQKciT4LSaYy/5kNwy9/QOypqyBDIaQTY/dGdFqz5ndCxKp98+qdUk1Ul0jW84kDNe5S0MOeu1tGNOr2YGT6Ypxxn9tgypa6d3OV49/QmQjCmfuWmysz7bpbZMwpGDfayIgPgJJKqk9Lu1oELsbmpgLZE7u1u2QDhiAKu0ot/tlh0aB1NnDK6RM87yMq/yo4NqVc+y3MUedX7hTHyH8TvUT3duB3p1yw7uIWnJBie8a/IYPv9xQ2TqIO6RrZhB6WY1/hYr0vDTP8jB3q6Anqy6Ai5wywhqHXKlfGq59nXIPro3zMnaSZhli2MoNGbkvlc1K5Tv7KFMzqqeh1sueXWoeyR9C9D6f5ZAB/ejvc83CWmd+r+QoDbQvrOw2qRkToc33NzN8D0ST4fPzOEGYSAKU/ogeD8JtoIECyz8s34QmpVB6d9EMg62rgP3aoB/upw8zlw7V1iqcR2oOIWc4l8eIyzuwNfhIPSPskEYmDQSVnogu4It98AchHjFKVAOQeEaZt7WtYeyb+dB6JIKwVZgH9WDMHCBfvWJAI8FXt2LZBBM/IY3LVV9mS6lzB9VjQOugw+S37iMmTqZKW75ppXqK0ymbJ0uRqWk42C2jsa/RPprpJ1XPbVkY68jTKMmVM9jBiwIA6Yhr++y5NCk+HpOxyCQEpNi/tq55lho/tV74jzzhv8tE93LzwKe35FLdnR+4+aRbeMbFyQ+qG5PH2tDYh5MOrdJjIc31NJhfU8bIs7tebTsEb/2dqhSUWYJvsoBlR3zlv7NRTumbotmcWnqiCrf0KCsQrWirDsJg6vbibkisWj7CgHySwYDbW/0JBaSg3xYTxPeG+J6GxuTMBjfTt74L0ner3h4o9upe29KK6ZlJ/8OXB89mYRBejuuL6vij38jshubk6mvczVFVS1hJJLxmbdbk9sAvVNBOCxM6/N9mYCsMSISIgPK5zjRH9jgSpAHGIk8CG0ezbzZM6m8Q7G1ahJiwPofk173toq4mMM+6BP3joox2Q5+MLGiKiOFUNyvp+yCEfj6NyzYtBDMFjyaqgSgcYqVdi67RwdYcGDqlrDkTJTKo5dSZQoHMsBwVKfAbKkM48NmbFjjjikaqdPeqZ8OfkEnZ4pW948O7sBLE7m2bfWb9dOWSrsG2T86wEooNnBhWIe8VRUnPGtpA4RgWEQuGfXVEpVtH9vcA3DDEeHr7qZFjB1Xg9Qm8wglTC3EKMSKCVumURXpzi08LZzEIxKlxopNV6lKlIZCNfhosKgYeSTKu0jlLZykZFiapx6NKuvLoky2d1rJxLitADb3nqSUvnjLiQVCYjnwlE+eKwhUWz8kwJWdTsmAKg0yxLJg5Lws8V5TLQlXBUgGPIaFLJBgWXdWyoVxU5MHzbKgt29eu3JZT4NXygg10C4MCSkLIzVGE6pyNX9ys6TPBUqoHSDPlgVo86GHKSpzKbcCpMKSakmEHFLOvrgSa4xIhAISQUozC+pMBT6UIT6o4U1kvK3985//quG1NOKcR8zuQJME3yJuwdDca63AY8QtoUALKJoY4Xog/2vWCSB2RmnOcpFUiqTuLuMH5vVCVXZRC1MBDRnYOnFVxikG+JW9VaG3scqFlSpEkvCVwdSTiwLphSumdK3gyj+LztuHN4B8jGs4mDAEtRplno/rCl7h5Qq7psuZsjDWLNar3OCcLtBSizMJOeN381P15IAWlSEotcipZjHxS6lOswQT60Snep1j7b5FDaXxkgn5cImq4nJngsdwxvgZXIK8Q4C3V6VxEzpG4dYjAF7HzTPJurNpmdwI68YbPKl5J1MMWsfy8S3xgA0Ypnd658uwgldwZa80vfV1/G9Gc3yDgC9bn/ZMZOO/BeHdEwo336d8ifoiXZ6q3G9p76UqeB6nqGVLjOYU/OZYrZ4oWYPxqzR6EbN99qr/9ku/u8f6qs/fPI6f9Tf7F8WHd89ePe3A+FU37r0bf+i90x/fZ6p/Llj88lX6ib9T0bPH5ccPn+THD3358f0bTd8/3o54yqMXv7N4/Pg86q2z189erX963x1FL35f//TuafHJLP77+qeLi/U433sW8W2EKT5++G+2f77zaPfLzpfdo52r3S/Z0w7d+3z+7Cp+unuxs9n+1Jft3f3o7+efdfHmcfJo7wPbfAK78J4frb+Og7o0MJ4xDmf+qM8M3Wd42BMjFBuLjv1Q5KBTYyxMX4IU2PRQ2OJ+LceEDinjBFknf6AUgJRC3nymX4fZTYzYWF8/61ZMeDzPhD43z3em/+dIXAD/uZTWt9d2e0T1KjdSbz1ywCyQGQ8axNa/WyIVxKVkehxsHV8HV21asLYd3zo+nZyGATJWYA6xEMpgTHUabAVrsylFbMMyCavja6uDlaIpyhN8YptTNlqwtctuMAlnZyxUzaXQULa/boLSdMj48OZZp1PWHOLx2RNqMGiaJirY3wHzRI7/dagwYCg2KVD0YMhxlIo30wTsjj9bnxpdlO2cnuFs/tKnLxsZyVmPsyDHWEsxHvv8nknZVRm7YEpQUGXV8M8qT3Y8ldQqJeUzUl2TyultbJicx69dkxx49MTcuzc2J6eWwbU7qMlw1y9S9l2lcSNwn5oRchDMRKSNsHA2KlwaoS0J0NyWM4FIhcgi//94goc+EEZC3LHtF8AP8Y6EinvZnU+LQBaLvCqE9+B//vNfZoaPnwxWf8Pniv1SkkKMQGKjomnUy+CKYZBgmihzM6ZM6te8jNA8A6UwH8w1DG2XIdbJ4G3MxfsxLWiEzX54m2BcC1u9VrNoqkPep4DPVzj0QNqyoUvI0IpVYVa9UXAk5MUgEyPsvyMR9sZgoA08pTy2Mb3VMRObYncf3pcKyRS2/EjEmlncBNeSxprklNOhCS7DBpcSyBgaICJFhFdeJbLSXuo0ZZmQtmjBEGTepsybz85VgUMmpYO3IQkpSsWlu9mp0N6srfq4FsIIkxgF4sJiMAFuyTOB3X6YDCmzjBRC2wQFhnh1HHG6lpQrTPdYXPwZVAxzly5QrknhrQI84deMX9iehDY5roTpPUSKaWhWLM1K9sPmnBdMvywj7HgSimkhx9PZQ6bTMjJmsL5I9cOu9MJ3qdbM3HSNRMRqQVwlYrWGxVVrh6BRQtTa9kHf+M+H5M//+V/yGqjkJBUjK61xKSEbTxtiTe+mOXnLtsr9mWs9LbEBVBsh5UOfaUIOBuGsyW6qnYQBSGS+avTf0oK55Y89mqRZGvb1ZKIjRimmsYkTvDmiBVt4W8SmNbU/OMTu5tjHrUtOeM0ArwVhkLEYuIJaLLD94uA1uSSPOutBWPODdzjttdf9Zzt7hzuIDWqW5Vi3s95ZNw8PQumc8tpWpo276uqeNXG1Z8ZV9/eq+3vV/b3q/l51f6+6v1fd36vu71X396r7e9X9ver+Jqvu71X390+ifdX9ver+XnV/r7q/V93fq+7vVff3qvt71f398/ztqvt71f296v5edX+vur//Qk21q+7vnyGBq+7vVff393d/u6o8jCnXiowyXquMtgWcxzM94adhkGKB59ZxcH2ND9tvZTaZ4OfPpSlqOz4Ng0sqGSbsTW1o6GsasQzwAsbBVvDMvj+0j3D70CqDKXGZKYnFkkw7Y9uc+o2w9RrUg/3DoyAMIte3nosE50g6wp52OrK1gI6Zpm2Zmo7EjPJhaaoSA7vmxLYWpM0azgtTw+n+qBU3Uj6uYdgs7rRk4L9I1MIJ19e2PnQyqeDt0NIZjrEeGo/vdDKZ/B9IFEmE","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"}}');var s=t(74848),r=t(28453),o=t(33617),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9ty27iSv4LD2qpMtJRsKY4n8dN6Ek+inPiysXO1fTwg2RJhkwADgJYVl6r24fzB/sH5tPmSrcaFInWxncvmeKr0klhEA+hu9A2N7utA06EKto6DI8iLjGpQwWkYJKBiyQrNBA+2gqMUiB8mzyUdaMaHZPugT4DTKANFSgVSES1ILAGB4lJpkbMvOEq0XzkkCuQlzqWKRFkJhWRcKzIQkgyBg6Rm4UTEZQ44MGI6JYWEBAaMQ0KUlmWsSwmqQ94WghNVxjEoNSgzuzMTnIgBodWeIdEpGFQl6FJyRSgpOftcAmm1RHQOse4nrRb5JQHFhpxqSBA5P/2MJQ9DMkpZnJKYchIBkpogpQ5hqKEbURwT3OypCojZgCGwW6xDtpOEIY40y8YhoaTVKmXWahGmSCHFJUsg8buJwQBZSg1rCeMa5IDGYHgFuAofmm384oTyhAxozDKmm2wkCVNasqjEnTsn/IQfsWKLvC0yQRMyFqUkB89/n4JrQfDbcav1HKJySN72W63TX1KtC7W1tkaLoiMK4MitjEaqE4t8LUHAIhkYXoEEXNXwC6hi2ZjQJCEjlgxBK3MgnMSiGJNYCJkwbkWjoEMgvMwjkCo01ORCAmGcUCKBJuO2Fu1SAXl1uL+HbMip7pCDrFRhtV3CJMQ6G9vlkT2eqgf2dDY3UIYYH4YkpxfIJabJ55LFF0i2Am6O1omM4VWr9R7xrbjDlJPxhBCdMkVGEKVCXBC4xOERyzKiJRsOQbZaJ/yPP/444dcnnJCTwECcBFvkJHBLnAShHdLjAuzI8/1nb3d39o7Ojj4e7FTjXlJnYPrPK4gBy2ZXePvmdTXMaT47vLe9O92AC+3GDzKgCoiESwYjcw541JZWz4VqWs1O2NnVCE4CqfDrMX4h5Nr+18TmsP9ib+dNHRcLATllWQNkZ3e7/7oBU6SCN5c5eLm/11ynlLVV+nsvLFPs+AT/O3X4uhPZdgd01N/dOTza3j1A4Ik7R5SGw7IohMTjf28FeguP+YT/BpkYESrBSE8s8lxwUlBJc9DGNqZUm2EJn0smIbHGjWaZ14ytE94mrRaKwlarRfo8YTGqhlXzcQFo2Sxsx4KiyiDooTM1FrSmSGiLrDlBDRlRq91FhoYEQSWgldLsEpoLX4VkjAs/B5QLu2wqJPsiuKaZEYpLkJrFNKsrMSJoTJ+m0pigQjCu/Ve3A/nolBV12aioszKIWoLMyhk3IwrIJc1KUA6rUUhSxOoNFBKUsbhuXWQkT0gKbJgu3Y8m56XSjYVJqbwd9Vi4vfwpGfaCYduAZgoIGzR4mdMLqO1GRGHte4f8NiYJDGiZ6ZAwtD9altAhe0ITWhQZi41vRHNuHU8poW1O2YmDQwRVBZE4sP4BPULC0DegtcFBs4Sb47FDObMOBckzdlSnlBPBZw46FpmQ8yJkPjf5SGLBNXDdIduXlGUGeUusIozHWZkAiTIaX4TGs4dEoi/DUxlDlolRaOXdgBgPa3hu+EMUZCiFgiP+XLjtmZr60A45QvtT6RMOelabTZiqc9XZ8IHAnZEFXsWIsSuhYVxIzkVENNMZhKiwBeXjkCQ2aIArHYmrkMQpxBfmL0kTJkhUai24JSyRokjEiDteDgTXin1ZoJF+5Os52gvJRkg2Q/IkJN31kHR7IeluhKS7GZLuk5D01kPS64WktxGS3qZFq/fE8ZpWDK4j0O1ZLuu/DnfR7r5mymg2GkxV2eBRwwZ3O6TVqrRp1v1OfWwFUnkrtJk41nW/r/DHo96v7ucYf272nrifIwPa3XA/U/zZ69b9RM9gomle3IAFDv9QDHywYIUIvzmfexJ4e4Yf0RCFfmDqih0+ODCp0/IIaWGcaUYztZwcD3GPKJqiNEfUBhJlxHU5RS4GuTfk1PExIQuaSTtkzGptyCu8waI3R/3jjvMsy4m3294b2mvofB/pm0g6mqYjNE3L6a+s1z1iwixO38eJXzsmADCWeTkfHMA94kITo+/jwRPkATql5QzA0XtEfQ0dewEzHt6OrW+0u4/bvfXeRoMDeFO2AHneTpL2eDz+EdzDmMdtjyGPj1BtZIcZiYEU+YLrh7kdTKFcTGT+9iH7LgbqEVRJEcwCNHMq/v5fj7K1SOj4gbJL+alVcIbw09BsXEPTDCEeJhcSp4LFDnmE8SFZhBe8DvKgbTi5liRrNU7ixyRp53l75iP+bBvG1z7meSdJOjOQc6djP+YkSUIy/3nh9yQheZ4v+Wy/Nz6v5fk8FZ08d7iZ4OspKomL2ZbriQP4Waoy1YjmxjeqEeaRBM/M3uY6t1iPZpxNynzaxgkVmQGQMCwzKuEK76VqNhfyA3XMq9g0sjf3WHMFtMlAwwryy76L3h868UcSmgvgl9vnzVGGi2y79C6RMIQrUlCtQXKz2CXNWGLTsG2bqryieYFXgLV/nJwk//kfayYBgXd8TfAkSMKGDLOCa/843m5/Ol0AURYFyBhzUhngTiokoOMOOU4hK6aJydFo1Bk9UnEqRGazkudKwsD+eyai8zODbtGhqni4iFIrGrULP4rO7H1fgW5wjCriZy648hsZMzrUXTfe1t13bnC3DuIeeZwZlHDQZk9sbi/IqQlIUJRh+rfQKciT4LSaYy/5kNwy9/QOypqyBDIaQTY/dGdFqz5ndCxKp98+qdUk1Ul0jW84kDNe5S0MOeu1tGNOr2YGT6Ypxxn9tgypa6d3OV49/QmQjCmfuWmysz7bpbZMwpGDfayIgPgJJKqk9Lu1oELsbmpgLZE7u1u2QDhiAKu0ot/tlh0aB1NnDK6RM87yMq/yo4NqVc+y3MUedX7hTHyH8TvUT3duB3p1yw7uIWnJBie8a/IYPv9xQ2TqIO6RrZhB6WY1/hYr0vDTP8jB3q6Anqy6Ai5wywhqHXKlfGq59nXIPro3zMnaSZhli2MoNGbkvlc1K5Tv7KFMzqqeh1sueXWoeyR9C9D6f5ZAB/ejvc83CWmd+r+QoDbQvrOw2qRkToc33NzN8D0ST4fPzOEGYSAKU/ogeD8JtoIECyz8s34QmpVB6d9EMg62rgP3aoB/upw8zlw7V1iqcR2oOIWc4l8eIyzuwNfhIPSPskEYmDQSVnogu4It98AchHjFKVAOQeEaZt7WtYeyb+dB6JIKwVZgH9WDMHCBfvWJAI8FXt2LZBBM/IY3LVV9mS6lzB9VjQOugw+S37iMmTqZKW75ppXqK0ymbJ0uRqWk42C2jsa/RPprpJ1XPbVkY68jTKMmVM9jBiwIA6Yhr++y5NCk+HpOxyCQEpNi/tq55lho/tV74jzzhv8tE93LzwKe35FLdnR+4+aRbeMbFyQ+qG5PH2tDYh5MOrdJjIc31NJhfU8bIs7tebTsEb/2dqhSUWYJvsoBlR3zlv7NRTumbotmcWnqiCrf0KCsQrWirDsJg6vbibkisWj7CgHySwYDbW/0JBaSg3xYTxPeG+J6GxuTMBjfTt74L0ner3h4o9upe29KK6ZlJ/8OXB89mYRBejuuL6vij38jshubk6mvczVFVS1hJJLxmbdbk9sAvVNBOCxM6/N9mYCsMSISIgPK5zjRH9jgSpAHGIk8CG0ezbzZM6m8Q7G1ahJiwPofk173toq4mMM+6BP3joox2Q5+MLGiKiOFUNyvp+yCEfj6NyzYtBDMFjyaqgSgcYqVdi67RwdYcGDqlrDkTJTKo5dSZQoHMsBwVKfAbKkM48NmbFjjjikaqdPeqZ8OfkEnZ4pW948O7sBLE7m2bfWb9dOWSrsG2T86wEooNnBhWIe8VRUnPGtpA4RgWEQuGfXVEpVtH9vcA3DDEeHr7qZFjB1Xg9Qm8wglTC3EKMSKCVumURXpzi08LZzEIxKlxopNV6lKlIZCNfhosKgYeSTKu0jlLZykZFiapx6NKuvLoky2d1rJxLitADb3nqSUvnjLiQVCYjnwlE+eKwhUWz8kwJWdTsmAKg0yxLJg5Lws8V5TLQlXBUgGPIaFLJBgWXdWyoVxU5MHzbKgt29eu3JZT4NXygg10C4MCSkLIzVGE6pyNX9ys6TPBUqoHSDPlgVo86GHKSpzKbcCpMKSakmEHFLOvrgSa4xIhAISQUozC+pMBT6UIT6o4U1kvK3985//quG1NOKcR8zuQJME3yJuwdDca63AY8QtoUALKJoY4Xog/2vWCSB2RmnOcpFUiqTuLuMH5vVCVXZRC1MBDRnYOnFVxikG+JW9VaG3scqFlSpEkvCVwdSTiwLphSumdK3gyj+LztuHN4B8jGs4mDAEtRplno/rCl7h5Qq7psuZsjDWLNar3OCcLtBSizMJOeN381P15IAWlSEotcipZjHxS6lOswQT60Snep1j7b5FDaXxkgn5cImq4nJngsdwxvgZXIK8Q4C3V6VxEzpG4dYjAF7HzTPJurNpmdwI68YbPKl5J1MMWsfy8S3xgA0Ypnd658uwgldwZa80vfV1/G9Gc3yDgC9bn/ZMZOO/BeHdEwo336d8ifoiXZ6q3G9p76UqeB6nqGVLjOYU/OZYrZ4oWYPxqzR6EbN99qr/9ku/u8f6qs/fPI6f9Tf7F8WHd89ePe3A+FU37r0bf+i90x/fZ6p/Llj88lX6ib9T0bPH5ccPn+THD3358f0bTd8/3o54yqMXv7N4/Pg86q2z189erX963x1FL35f//TuafHJLP77+qeLi/U433sW8W2EKT5++G+2f77zaPfLzpfdo52r3S/Z0w7d+3z+7Cp+unuxs9n+1Jft3f3o7+efdfHmcfJo7wPbfAK78J4frb+Og7o0MJ4xDmf+qM8M3Wd42BMjFBuLjv1Q5KBTYyxMX4IU2PRQ2OJ+LceEDinjBFknf6AUgJRC3nymX4fZTYzYWF8/61ZMeDzPhD43z3em/+dIXAD/uZTWt9d2e0T1KjdSbz1ywCyQGQ8axNa/WyIVxKVkehxsHV8HV21asLYd3zo+nZyGATJWYA6xEMpgTHUabAVrsylFbMMyCavja6uDlaIpyhN8YptTNlqwtctuMAlnZyxUzaXQULa/boLSdMj48OZZp1PWHOLx2RNqMGiaJirY3wHzRI7/dagwYCg2KVD0YMhxlIo30wTsjj9bnxpdlO2cnuFs/tKnLxsZyVmPsyDHWEsxHvv8nknZVRm7YEpQUGXV8M8qT3Y8ldQqJeUzUl2TyultbJicx69dkxx49MTcuzc2J6eWwbU7qMlw1y9S9l2lcSNwn5oRchDMRKSNsHA2KlwaoS0J0NyWM4FIhcgi//94goc+EEZC3LHtF8AP8Y6EinvZnU+LQBaLvCqE9+B//vNfZoaPnwxWf8Pniv1SkkKMQGKjomnUy+CKYZBgmihzM6ZM6te8jNA8A6UwH8w1DG2XIdbJ4G3MxfsxLWiEzX54m2BcC1u9VrNoqkPep4DPVzj0QNqyoUvI0IpVYVa9UXAk5MUgEyPsvyMR9sZgoA08pTy2Mb3VMRObYncf3pcKyRS2/EjEmlncBNeSxprklNOhCS7DBpcSyBgaICJFhFdeJbLSXuo0ZZmQtmjBEGTepsybz85VgUMmpYO3IQkpSsWlu9mp0N6srfq4FsIIkxgF4sJiMAFuyTOB3X6YDCmzjBRC2wQFhnh1HHG6lpQrTPdYXPwZVAxzly5QrknhrQI84deMX9iehDY5roTpPUSKaWhWLM1K9sPmnBdMvywj7HgSimkhx9PZQ6bTMjJmsL5I9cOu9MJ3qdbM3HSNRMRqQVwlYrWGxVVrh6BRQtTa9kHf+M+H5M//+V/yGqjkJBUjK61xKSEbTxtiTe+mOXnLtsr9mWs9LbEBVBsh5UOfaUIOBuGsyW6qnYQBSGS+avTf0oK55Y89mqRZGvb1ZKIjRimmsYkTvDmiBVt4W8SmNbU/OMTu5tjHrUtOeM0ArwVhkLEYuIJaLLD94uA1uSSPOutBWPODdzjttdf9Zzt7hzuIDWqW5Vi3s95ZNw8PQumc8tpWpo276uqeNXG1Z8ZV9/eq+3vV/b3q/l51f6+6v1fd36vu71X396r7e9X9ver+Jqvu71X390+ifdX9ver+XnV/r7q/V93fq+7vVff3qvt71f398/ztqvt71f296v5edX+vur//Qk21q+7vnyGBq+7vVff393d/u6o8jCnXiowyXquMtgWcxzM94adhkGKB59ZxcH2ND9tvZTaZ4OfPpSlqOz4Ng0sqGSbsTW1o6GsasQzwAsbBVvDMvj+0j3D70CqDKXGZKYnFkkw7Y9uc+o2w9RrUg/3DoyAMIte3nosE50g6wp52OrK1gI6Zpm2Zmo7EjPJhaaoSA7vmxLYWpM0azgtTw+n+qBU3Uj6uYdgs7rRk4L9I1MIJ19e2PnQyqeDt0NIZjrEeGo/vdDKZ/B9IFEmE",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,y={},x=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\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 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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.2d4415d2.js b/assets/js/28b19cd2.2d4415d2.js new file mode 100644 index 000000000..79419126d --- /dev/null +++ b/assets/js/28b19cd2.2d4415d2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5772],{98681:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>g,default:()=>j,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocumentwithtemplateid","permalink":"/docs/API-docs/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztWs1uHDcSfpUKL7KF1owkW9ndOcWxvYmwRizYMoKFRpiwu2umKbHJDsmeUWcwQA55gz3tNY/mJ1kU2b/SjH6S3NZA4Gi6i6xi/dfXXDPHF5ZNLtgbnZQ5KmfZZcRStIkRhRNasQk7zxBeG+QOoaGCudE5OMwLSY9fnZ0Cl1KvLFS6BKdhgQoNvVK4grTZG+IKrkrroDB6KVKhFu0eM5GCUNYhT0HPoSyk5p6A+y3mQuIzocBlCHNtcqKJucWvX4I2EAvFTfUccImmAidy9HIoxJSESYLwvBVkBOc1W0u7gcGCKFJZQWkx9dwsJFxBjPXqNBy5tGhAKIdmzhME7uBif/8NxuUCPp3u718+y5wr7GQ85kUx0gUqKxZK8tiOEp2PUyIs0vlzErq0/vydcs976hxN1VT9W5deiKAthBTnvJQOllyWXg2kdFiJdIGkW06ia68jYUDxHAfvbVkU2jjAmwQLByQYd6XBCKzjeRGBUMIJLm0EIucLHE3V0Qj29zHnQu7vT9VPP/00VeupApgy2n3KJjBl/vWUReG5QZ5qJSt6N+fSYv28Fr235Bu84XkhkRQzZVO1qRlM1TFxJQa7mYa/nsLzSuOQywvicqVjOBdO3sOKSByRPI1fgnrI7yXxS3RecFXt5lYTPFGfQZNQLB1Ilw75nhDflLt7jkhvn8bx6Ojg8OTg+PD4ZMjsa2Lm8MbF+mY3v5rgaSzzCmjdkN/fvFIzTK7vZdhQPIXjxZRpnwEPjqfssmN6QOoMZJP9fWhiNONLBK2QIjvXBsFlXPkHIVpdxp1PSJYyUoxgUWJCeSWumsD2Qf93by+ji1Sv1D02qymepsRwoqOhEv9BHA1PhYa4dE7fw9VT/WmWLGK6oPIgtDpN2YTVKbbOzivhsqYsiJRFrOCG5+jQUKVae3HYhPUqB4uYoEpVcJex2+VLx1eYuFNfVpoUyyJm8OdSGEzZxJkSI2ZdJWlbKyiWWMTwppA6RTYJR2M2yTDnbLJmrio8pTNCLVjEqCBx139SRySJ9P1RnCXHWRGzzeYysEXrvtVpRVslWjlUjv7kRSFF4pUyvrIk+rrHsxP3glHqJmVcRo0o4YykKkOadQKtF5Ty1lMl/qFXsUPmu6PSVwqCWbmE1jhgC0zEvGqqml/qqxT9UriSVVtLu0J8OgedC+cwjcKq2kKff/2vrbdYCSkpYnxpHkQL20StMrpTcmN4RS7hMO8/36Eko7frqNPIqyTRpVNcOWLoq9e9SvUE/Q2uNPbLHe0SnPg+rlcaIUYk4iLT6gHqo+MX9N+LI6KvS/4f18nD0tU5fOb5NYmgtyTWWiJX/TU+jjZRkx7u379O97G+YZtN1HjyrUzRSwGzj8EPZs3ZN09a5pnMtUzRUEa6TzLvdKjS2W1H6I58u38Wthcmw0a5DhpYZegyNP7xiisHfveuWFAsaqidfQTUkw/bQWGpspoSp8xHFQVTeKPpx0CEHi1wlYLSsOf5zWzpHWJvXP+OdVrtdSstcIO1zILiuBbBE7exawchO5oOvIDYNlHUsNum8KEOX5fW6Rw8m3qRTy1tFwt1Yh3Ba65AqESWKdbjAimcshKs140LzLxnbDawXpMt0czI5TebqHtAvAYPfBSGJwYTFMvBqvYRdgvbZ72leFMIU82o5woP6pavL4BYKKEWs9LU+yhNxKM7btjZ6NEavKOw2na0yf+V7kiwU/XepGgeEcOnc7DoQ3CPHHgvAsp3QUfCWFdHZnD8WnT/dpe+62FLViN420a6LWNLVKrZr4skZ8RigQZTqCn84gioWQLkSRZyhJeKzynIiXthcCl0aRvxMm6BdCaRqnAYFGuNjeDbtrRG0NMOZYvB2Udbwplm7nP9ut76Da/6RUaVeYzmjk79nE7jeb0KUl5Z4uYLPb3gMin9RBwMD2R4SmeVLk3bQ/Qrb8uple/ohOJE8Vji+/OzR1iaDgQHIWOGJifYIOwB78/PYIlGzOtWbQSfbGunxvB8QAKJThGWggfTR7DKRJKR9ivICQ1B5e0V0ru3W9cf+aIJB3BXoFTYrRJFocJQ0JZetG0bQyoMJk5W3oF06YCnqahbOuuwsKNtpTso4VyXj4mZBzTJYVGK1Fu6NG0yR2OjHjxEkJApE1psIS1N01zWTkuUCVrb6anRChH19o8AlQ3LOcy5dWgiKJVHckxZUDQ0W+JNgUagSnCrCnop7+GkS2XaAzE6FOQCjdWKZkRtFlyJX4KDkGYybanfy7gMpHWasBAjSUXRPUxiDbr0+bffWSfXzu70rmCBA09Tg9Y+IKEfX4M70bRrsKDsp4cS0X5ovrkNe5F03iVnuU5bN7WP96AzNLlwts2JTpPUgBIDqmjLJANuu1xr+2CWR7dsREeijtIjZLqg8+KNsI6U20BkYlf0fUDSY9KTwaOBFDPkUarqh08rl9O3tvOdoLDhab972+pphEI+bEkCIHJetSAh7V0jo6go86Rw9uafHtIkgchyhFx6F2vOT9NFL4uG5XcqJi+dnhnMhXpczfwYioY3otNt2JdO59yJBJqt7Ahq0qBup/tRnMOzRlUUHUuhzfOt6grbzbRKcCbUzGPBDxehH/xj8gZffWJ0K0TVl60xWiitYUgn2VYZKhjopFcp6dADKU92jyOz/jzimzk/uwwBCv/AFlrZMKEdHx7S/4aHaeH5Zs62ZULpcV5KWX3FosfDDfePhw2k8lRoIbsSx7/cJMvjs2ZyL43841Pqw5P4tsHyFvZMkgyleNxRapy/NPLA6QM6y0Eb6H7bnr2FkkLhrDHgLNXJrDk90eVoLV88Galpze1bv6GtH2BPLraJ2MttXnTqGyyPaKo93xi0CZKGxSYDUrJsvlhoA0q7Ngc1JFxqn11dVveahLX4ld7N/zJ/RGO0ear2ziRyS6O1K4vuJGHjhzT48vBwlnRKPNmiRLXkUqT+09i5vkb1F4bfzuN2h+uzd4E9iXqTyw7eYSIQ+fdscNr+83BIi0lphKs8AntzwAtxEN5PLi4J18zRZZqw3EJbLzFBsRM2Hqa68bqX6zaMtjXLBtf1UdgGluUqjfXN3Y9ovBDjJcFOt1ds/eS2kxrLg6ctsI4vhFrcv+qy09RHsmYw2EBfXbYrxL+QoqA2R5+qBrQz5FRryQDkJB868PhtY+oW5d0O3Lbw6EWDdPbhzBbNvANRtlI1MGSLQvagxh7S2MflG2SwDwzWIHqL/Q0APu9BHfrG2BBhCwD9LcSIsSH+0SxqZ/qwattgenQyGAlr0fqzTQP593v9QcN9u9/e2fvuaH1rBqHFI9FvNVf1++09DY20Qs113/jvC1SEZfqIXx7d6XN+RJnoMG9T69eQf/7td7+i8Rsv31f0Veh9aaDQKzTzUvq8P5d4I6jxIXrM/bsOxkSeS7RWVv7r+MJ/+0/FQjiaJ+vJKuEFj4UUlMeITIdBvpcK7Qh+7IDQPeM/2uMSJaW/tnVUi87PV9pczwlQjYBDTN/UaZhBlXGVhLkpRKPv/7kKs3ZhBGV+Z0hqEWTTyhmeOMi54gvfwEcDLaUoCY6yYHRMQ7vVsgxjqeNCahMgC38g/5nPf8x7S9+QDAI9JZjDYEb+saxnUxsFbMD6uKMjqBRi9BckeOJEgn6IKJXUyXUAm0opodAuAEDUtvZlpOXOcGX9FYmAktQ2aBVWT8wYBNzf/2SRLPxOqGs7oS9/B3DROtOPGFvhsLvWsFqt7iS/58M13wn3fRnDByy0FU6bqlu9EC4rY58w+5u0P8JO3zV3R3oJsdsj1YndcrNCJ3acoSzGH9GRh9jxq7NTX3ifw+df/wPvkBsFmV4Fb01Kg7LqrqmQ5oLlg9rauhmuWZQuI40nwflqJM8GZPtWch+GncE5eqjKDm7F8ELU2180YgJJ/2eOSRWcvJgHPL1JTLwQWydyhya37+cf0SxF0nS0Oyw89sRjFjEpElQWe03Eq+/O3sESXowOWdSrmI+w9vjd6eu3P3x8S9JQZAWNHY0OR4f+o5e2Lueqx2rrJaTeJ92B6nvfVr/cYPpyg+nLDaYvN5i+3GD6coPpL7vBVA9xZNFxIblQPSApDL8Xt3A+FrFJ/9LSZcQyGpYnF2y9ptz3ib5Z0uOfS9/nX1xGbMmNoLnET1g1LJr2xqkdFe/Zhxo9fA477j9tlb+ZTBWNpd7sYTq5xurWjavN5SZqxlMSLVC8DgIcnNM+3Q53wA6arsOKVwnl8ntp++jC2fuP5yxizSfv3F/QYoavaNjkqyBtMFi43EPP1kxytSg9wsbCnpuAZ2fDcfzaj+P1H3SqrfoYzunhGPQvHWrrgvU6jPqbTUsfXu1cUSu2oSbjXG42m/8BGFsO9w==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"}}');var a=n(74848),s=n(28453),r=n(33617),o=n.n(r),l=n(17543),d=n.n(l),p=n(86013),c=n.n(p),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const f={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWs1uHDcSfpUKL7KF1owkW9ndOcWxvYmwRizYMoKFRpiwu2umKbHJDsmeUWcwQA55gz3tNY/mJ1kU2b/SjH6S3NZA4Gi6i6xi/dfXXDPHF5ZNLtgbnZQ5KmfZZcRStIkRhRNasQk7zxBeG+QOoaGCudE5OMwLSY9fnZ0Cl1KvLFS6BKdhgQoNvVK4grTZG+IKrkrroDB6KVKhFu0eM5GCUNYhT0HPoSyk5p6A+y3mQuIzocBlCHNtcqKJucWvX4I2EAvFTfUccImmAidy9HIoxJSESYLwvBVkBOc1W0u7gcGCKFJZQWkx9dwsJFxBjPXqNBy5tGhAKIdmzhME7uBif/8NxuUCPp3u718+y5wr7GQ85kUx0gUqKxZK8tiOEp2PUyIs0vlzErq0/vydcs976hxN1VT9W5deiKAthBTnvJQOllyWXg2kdFiJdIGkW06ia68jYUDxHAfvbVkU2jjAmwQLByQYd6XBCKzjeRGBUMIJLm0EIucLHE3V0Qj29zHnQu7vT9VPP/00VeupApgy2n3KJjBl/vWUReG5QZ5qJSt6N+fSYv28Fr235Bu84XkhkRQzZVO1qRlM1TFxJQa7mYa/nsLzSuOQywvicqVjOBdO3sOKSByRPI1fgnrI7yXxS3RecFXt5lYTPFGfQZNQLB1Ilw75nhDflLt7jkhvn8bx6Ojg8OTg+PD4ZMjsa2Lm8MbF+mY3v5rgaSzzCmjdkN/fvFIzTK7vZdhQPIXjxZRpnwEPjqfssmN6QOoMZJP9fWhiNONLBK2QIjvXBsFlXPkHIVpdxp1PSJYyUoxgUWJCeSWumsD2Qf93by+ji1Sv1D02qymepsRwoqOhEv9BHA1PhYa4dE7fw9VT/WmWLGK6oPIgtDpN2YTVKbbOzivhsqYsiJRFrOCG5+jQUKVae3HYhPUqB4uYoEpVcJex2+VLx1eYuFNfVpoUyyJm8OdSGEzZxJkSI2ZdJWlbKyiWWMTwppA6RTYJR2M2yTDnbLJmrio8pTNCLVjEqCBx139SRySJ9P1RnCXHWRGzzeYysEXrvtVpRVslWjlUjv7kRSFF4pUyvrIk+rrHsxP3glHqJmVcRo0o4YykKkOadQKtF5Ty1lMl/qFXsUPmu6PSVwqCWbmE1jhgC0zEvGqqml/qqxT9UriSVVtLu0J8OgedC+cwjcKq2kKff/2vrbdYCSkpYnxpHkQL20StMrpTcmN4RS7hMO8/36Eko7frqNPIqyTRpVNcOWLoq9e9SvUE/Q2uNPbLHe0SnPg+rlcaIUYk4iLT6gHqo+MX9N+LI6KvS/4f18nD0tU5fOb5NYmgtyTWWiJX/TU+jjZRkx7u379O97G+YZtN1HjyrUzRSwGzj8EPZs3ZN09a5pnMtUzRUEa6TzLvdKjS2W1H6I58u38Wthcmw0a5DhpYZegyNP7xiisHfveuWFAsaqidfQTUkw/bQWGpspoSp8xHFQVTeKPpx0CEHi1wlYLSsOf5zWzpHWJvXP+OdVrtdSstcIO1zILiuBbBE7exawchO5oOvIDYNlHUsNum8KEOX5fW6Rw8m3qRTy1tFwt1Yh3Ba65AqESWKdbjAimcshKs140LzLxnbDawXpMt0czI5TebqHtAvAYPfBSGJwYTFMvBqvYRdgvbZ72leFMIU82o5woP6pavL4BYKKEWs9LU+yhNxKM7btjZ6NEavKOw2na0yf+V7kiwU/XepGgeEcOnc7DoQ3CPHHgvAsp3QUfCWFdHZnD8WnT/dpe+62FLViN420a6LWNLVKrZr4skZ8RigQZTqCn84gioWQLkSRZyhJeKzynIiXthcCl0aRvxMm6BdCaRqnAYFGuNjeDbtrRG0NMOZYvB2Udbwplm7nP9ut76Da/6RUaVeYzmjk79nE7jeb0KUl5Z4uYLPb3gMin9RBwMD2R4SmeVLk3bQ/Qrb8uple/ohOJE8Vji+/OzR1iaDgQHIWOGJifYIOwB78/PYIlGzOtWbQSfbGunxvB8QAKJThGWggfTR7DKRJKR9ivICQ1B5e0V0ru3W9cf+aIJB3BXoFTYrRJFocJQ0JZetG0bQyoMJk5W3oF06YCnqahbOuuwsKNtpTso4VyXj4mZBzTJYVGK1Fu6NG0yR2OjHjxEkJApE1psIS1N01zWTkuUCVrb6anRChH19o8AlQ3LOcy5dWgiKJVHckxZUDQ0W+JNgUagSnCrCnop7+GkS2XaAzE6FOQCjdWKZkRtFlyJX4KDkGYybanfy7gMpHWasBAjSUXRPUxiDbr0+bffWSfXzu70rmCBA09Tg9Y+IKEfX4M70bRrsKDsp4cS0X5ovrkNe5F03iVnuU5bN7WP96AzNLlwts2JTpPUgBIDqmjLJANuu1xr+2CWR7dsREeijtIjZLqg8+KNsI6U20BkYlf0fUDSY9KTwaOBFDPkUarqh08rl9O3tvOdoLDhab972+pphEI+bEkCIHJetSAh7V0jo6go86Rw9uafHtIkgchyhFx6F2vOT9NFL4uG5XcqJi+dnhnMhXpczfwYioY3otNt2JdO59yJBJqt7Ahq0qBup/tRnMOzRlUUHUuhzfOt6grbzbRKcCbUzGPBDxehH/xj8gZffWJ0K0TVl60xWiitYUgn2VYZKhjopFcp6dADKU92jyOz/jzimzk/uwwBCv/AFlrZMKEdHx7S/4aHaeH5Zs62ZULpcV5KWX3FosfDDfePhw2k8lRoIbsSx7/cJMvjs2ZyL43841Pqw5P4tsHyFvZMkgyleNxRapy/NPLA6QM6y0Eb6H7bnr2FkkLhrDHgLNXJrDk90eVoLV88Galpze1bv6GtH2BPLraJ2MttXnTqGyyPaKo93xi0CZKGxSYDUrJsvlhoA0q7Ngc1JFxqn11dVveahLX4ld7N/zJ/RGO0ear2ziRyS6O1K4vuJGHjhzT48vBwlnRKPNmiRLXkUqT+09i5vkb1F4bfzuN2h+uzd4E9iXqTyw7eYSIQ+fdscNr+83BIi0lphKs8AntzwAtxEN5PLi4J18zRZZqw3EJbLzFBsRM2Hqa68bqX6zaMtjXLBtf1UdgGluUqjfXN3Y9ovBDjJcFOt1ds/eS2kxrLg6ctsI4vhFrcv+qy09RHsmYw2EBfXbYrxL+QoqA2R5+qBrQz5FRryQDkJB868PhtY+oW5d0O3Lbw6EWDdPbhzBbNvANRtlI1MGSLQvagxh7S2MflG2SwDwzWIHqL/Q0APu9BHfrG2BBhCwD9LcSIsSH+0SxqZ/qwattgenQyGAlr0fqzTQP593v9QcN9u9/e2fvuaH1rBqHFI9FvNVf1++09DY20Qs113/jvC1SEZfqIXx7d6XN+RJnoMG9T69eQf/7td7+i8Rsv31f0Veh9aaDQKzTzUvq8P5d4I6jxIXrM/bsOxkSeS7RWVv7r+MJ/+0/FQjiaJ+vJKuEFj4UUlMeITIdBvpcK7Qh+7IDQPeM/2uMSJaW/tnVUi87PV9pczwlQjYBDTN/UaZhBlXGVhLkpRKPv/7kKs3ZhBGV+Z0hqEWTTyhmeOMi54gvfwEcDLaUoCY6yYHRMQ7vVsgxjqeNCahMgC38g/5nPf8x7S9+QDAI9JZjDYEb+saxnUxsFbMD6uKMjqBRi9BckeOJEgn6IKJXUyXUAm0opodAuAEDUtvZlpOXOcGX9FYmAktQ2aBVWT8wYBNzf/2SRLPxOqGs7oS9/B3DROtOPGFvhsLvWsFqt7iS/58M13wn3fRnDByy0FU6bqlu9EC4rY58w+5u0P8JO3zV3R3oJsdsj1YndcrNCJ3acoSzGH9GRh9jxq7NTX3ifw+df/wPvkBsFmV4Fb01Kg7LqrqmQ5oLlg9rauhmuWZQuI40nwflqJM8GZPtWch+GncE5eqjKDm7F8ELU2180YgJJ/2eOSRWcvJgHPL1JTLwQWydyhya37+cf0SxF0nS0Oyw89sRjFjEpElQWe03Eq+/O3sESXowOWdSrmI+w9vjd6eu3P3x8S9JQZAWNHY0OR4f+o5e2Lueqx2rrJaTeJ92B6nvfVr/cYPpyg+nLDaYvN5i+3GD6coPpL7vBVA9xZNFxIblQPSApDL8Xt3A+FrFJ/9LSZcQyGpYnF2y9ptz3ib5Z0uOfS9/nX1xGbMmNoLnET1g1LJr2xqkdFe/Zhxo9fA477j9tlb+ZTBWNpd7sYTq5xurWjavN5SZqxlMSLVC8DgIcnNM+3Q53wA6arsOKVwnl8ntp++jC2fuP5yxizSfv3F/QYoavaNjkqyBtMFi43EPP1kxytSg9wsbCnpuAZ2fDcfzaj+P1H3SqrfoYzunhGPQvHWrrgvU6jPqbTUsfXu1cUSu2oSbjXG42m/8BGFsO9w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={},y=[];function b(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,a.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,a.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,a.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,a.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,a.jsxs)(t.ol,{children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"2",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"3",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"4",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"5",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"6",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"7",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,a.jsxs)(t.ul,{children:["\n",(0,a.jsxs)(t.li,{children:[(0,a.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,a.jsxs)(t.ol,{start:"8",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"9",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_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}}, {{note}}.",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}}, {{note}}.",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},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},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},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},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,a.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:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.6d63629e.js b/assets/js/28b19cd2.6d63629e.js deleted file mode 100644 index f7500da78..000000000 --- a/assets/js/28b19cd2.6d63629e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5772],{98681:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>f,default:()=>x,frontMatter:()=>g,metadata:()=>r,toc:()=>b});const r=JSON.parse('{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocumentwithtemplateid","permalink":"/docs/API-docs/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztWl1uHDcSvkqFL7KF1owkW9ndeYpjexNhjUiwZAQLjTBhd9dMU2aTHZI9o85ggH3IDfYGOVpOsiiyf6UZ/SR5WwOGLLGLrGL9seoj18zxhWWTK/ZOJ2WOyll2HbEUbWJE4YRWbMIuM4S3BrlDaKhgbnQODvNC0vCb81PgUuqVhUqX4DQsUKGhTwpXkDZrQ1zBTWkdFEYvRSrUol1jJlIQyjrkKeg5lIXU3BNwv8RcSHwhFLgMYa5NTjQxt/j1a9AGYqG4qV4CLtFU4ESOXg6FmJIwSRCet4KM4LJma2k1MFgQRSorKC2mnpuFhCuIsZ6dhi2XFg0I5dDMeYLAHVzt77/DuFzAp9P9/esXmXOFnYzHvChGukBlxUJJHttRovNxSoRFOn9JQpfW779T7mVPnaOpmqp/69ILEbSFkOKcl9LBksvSq4GUDiuRLpB0y0l07XUkDCie4+C7LYtCGwd4m2DhgATjrjQYgXU8LyIQSjjBpY1A5HyBo6k6GsH+PuZcyP39qfrpp5+maj1VAFNGq0/ZBKbMf56yKIwb5KlWsqJvcy4t1uO16L0p3+AtzwuJpJgpm6pNzWCqjokrMdjNNPz2HJ43GodcXhGXGx3DpXDyAVZE4ojkefwS1EN+r4lfovOCq2o3t5rgmfoMmoRi6UC6dMj3hPim3D2wRfr6PI5HRweHJwfHh8cnQ2ZfEzOHty7Wt7v51QTPY5lXQPOG/P7mlZph8vlBhg3FczheTZn2GfDgeMquO6YHpM5ANtnfhyZGM75E0AopsnNtEFzGlR8I0eoy7nxCspSRYgSLEhPKK3HVBLYP+r97exldpHqlHrBZTfE8JYYdHQ2V+A/iaHgqNMSlc/oBrp7qT7NkEdMFHQ9Cq9OUTVidYuvsvBIua44FkbKIFdzwHB0aOqnWXhw2Yb2Tg0VM0ElVcJexu8eXjm8wcaf+WGlSLIuYwZ9LYTBlE2dKjJh1laRlraBYYhHD20LqFNkkbI3ZJMOcs8mauarwlM4ItWARowOJu/5IHZEk0vdHcZYcZ0XMNpvrwBat+1anFS2VaOVQOfqVF4UUiVfK+MaS6Osez07cK0apm5RxHTWihD2Sqgxp1gm0fnpN2MnMjeEVqcth3h/fsYDRtIn7O+729yZJdOkUV45topDZH1SRJ+gvcKOxfxTQKsHAD3G90QgxIhEXmVaPUB8dv6J/r46Ivj4O/7hOHpeuzm8zz68Jkt6UWGuJXPXneB/bRE3oPLx+nQpjfcs2m4j50+leFPXCY3YR/GDW7H3zrGmeyVzLFA1F60OS0YYtqnR21xG6Ld+tLYWFNr7vFJG2wETMK1hl6DI0fnjFlQO/epdIlfPUQdoRUL06LJWEpVPHlDhlIzid+6IrfNH0x0CEHi1wlYLSsOf5zWzpHWJvXP8d67Ta62Za4AZrmQWmrQieuK1zLayElCQ3VZqj6cALiG0TRQ27bQof6vBtaZ3OwbOpJ/nisK3woE46I3jLFQiVyDLFupQmhVMdCut14wIz7xmbDazXZEs0M3L5zSbqBojXYMBHYRgxmKBYDma1Q9hNbMd6U/G2EKaaUT0SBupyqC+AWCihFrPS1OsoTcSje27Y2ejJGrynsNp2tMj/le5IsFN1ZlI0T4jh0zlY9CG4Rw68FwHlu6AjYayrIzM4fi26/7pL33UjIqsRvG8j3ZaxJSrVrNdFkjNisUCDKdQUfnIEVEgA8iQLOcJLxecU5MS9MLgUurSNeBm3QDqTSFVZaKJqjY3g27ZIi6CnHcoWg72PtoQz9aOX+m299Dte9Q8ZVeYxmns69T0sta71LEh5ZYmb70/pA5dJ6bvFYHggw1M6q3Rp2ka3f/K2nFr5jk4oThSPJZ5dnj/B0rQhOAgZM9R1wQZhDTi7PIclGjGvy5gRfLKtnRrD8wEJJDpFWAoeTB/BKhNJRtqvICekAJW3V0jv3m5dE+8PTTiA+wKlwm6VKAonDAVt6UXbtjCkwmDiZOUdSJcOeJoKms4lWIeFHW07uoMSLnX5lJh5RJMcFqVIvaVL0yZzNDbqQScEl5gyockW0tI0cELttESZoLWdnhqtEFFv/QhQ2TCdw5xbhyaCUnmUw5QFRUOzJN4WaASqBLeqoJfyHk+6dEx7kEKHA7lAY7Wi/kmbBVfil+AgpJlMW6r3Mi4DaZ0mLMRIUlF0D5NYg7z8/utvrJNrZ3V6X7DAgaepQWsfkdC3dsGdqBM0WFD200OJaD0039yFhEg675KzXKetm9qne9A5mlw42+ZEp0lqQIkBcbNlkgG3Xa61faDHIz82oi1RRenRI13QfvFWWEfKbeAjsSv6PiLpMenJ4JEyihnyKFX1w6eVy+k7y/lKUNgw2q/etnoaIXSPW5Ka85xXLYBGa9eoISrKPCmcv/unh/tIILIcoXrexZr9U3fRy6Jh+r0Tk5dOzwzmQj3tzLwIh4Y3otNt2JdO59yJBJql7Ahq0qBup/tRnMOLRlUUHUuhzcut6grLzbRKcCbUzOOkjx9CP/hh8gZ/+sToVoiqL1tjtHC0hgaWZFtlqGCgk95JSZseSHmyux2Z9fsRX8z53mXYvPsBW2hlQ4d2fHhI/w0300LXDZ5ry4TS47yUsvqKRU9vxR9uDxu44blAQXYjjn+5TZbH5z5jiYUqjfzjXerjnfi2xvIOLkuSDKV42lZqDLw08sDpA9rLQRvoftmevYWSQuGsMeAs1cms2T3R5WgtX2wN9odkaM3tS7+hrR9hTy62idjrbV506gssj/apPV8YtAmSmsUmA1KybNB8bUBp1+aghoRL7bOry+pak7AWP9O7+V/mj2iMNs/V3rlEbqm1dmXR7SQs/JgGXx8ezpJOiSdblKiWXIrUXxtd6s+o/sLw27ndbnN99i6wJ1Fvc9nBO0wEIv+dDXbbHw+btJiURrjKo5O3B7wQB+H75OqaML8cXaYJ5yy09RITTDlh42GqG697uW7DaFmzbDBPH4VtYFmu0ljf3r9g4oUYLwl2ujtj63XUTmosD543wTq+EGrx8KzrTlMXZM1gsIG+umxXiH8hRUFtjj5VDfZmyOmsJQOQk3zsgNX3jal7COhVA2b2EcsWsLyHQraMG6SxBRp7aGIPTOzD0g3418f+agy5hfcGGJ53kg5gY2wIogV8+g4oxNgQ4mgmtW17mLWt9zw6GXR9tWj99qVBvPvl/KCmvltS7yxvd1S3NYNQxZHod+qn+vv2soW6VqHm2rtLHZZnBSqCK31QL4/ulTI/okx0aKmpumvIf//1Nz+jiUEv31d0KXJWGij0Cs28lD61zyXeCqptiB5z/61DKpHnEq2Vlb8cXvir71QshKOWsW6eEl7wWEhBqYrIdOjVe9nOjuDHDuvcM/7OGpcoKcO11aFadK3qSpvPc8JMI+AQ05Uy9SuoMq6S0BqFgPMlPlehnS6MoOTuDEktgmxaOcMTBzlXfOFr9GigpRQlIU4WjI6pL7dalqHzdFxIbQIq4Tfkb7n8XdZ7ukIxCDRKSIbBjPxjWbefNgrtv/VxR1tQKcTo3wfwxIkEfZ9QKqmTzwFPKqWEQruA8VBl2peRpjvDlfUvBAIQUtugVVjdFGMQcH//k0Wy8AehPtsJXXwdwFXrTD9ibIXD7lZ/tVrdy28vh3O+E+77MoaPWGgrnDZVN3shXFbGPif2F2n/CCt91zyd6OW8bo1UJ3bLwwKd2HGGshhfoCMPseM356f+bH0Jv//nv/ABuVGQ6VXw1qQ0KKvulQZpLlg+qK09GsMrg9JlpPEkOF8N1tkAXt/J38OwMzhHj0bZwaMQXoh6+atGTCDp/8w26ZAmL+YBMm8SEy/E1qbbocnt2fwCzVIkTdG6w8JjTzxmEZMiQWWxVye8+e78Ayzh1eiQRb1D8QnWHn84ffv+h4v3JA1FVtDY0ehwdOjvtbR1OVc9Vlvf4PRuNAeq710tfnnA8+UBz5cHPF8e8Hx5wPPlAc9f9oCn7tPIouNCcqF6WFHob6/uQHksYpP+m53riGXUD0+u2HpNue8TXUvS8M+lr/OvriO25EZQX+I7rBr5THvt1I4T78XHGiB8CTue/2yVv2k+FXWe3uyhO/mM1Z0HR5vrTdR0oCRaoHgbBDi4pHW6Fe7hGdRAhxlvEsrlD9L2AYTzs4tLFrHmVjv375OY4StqNvkqSBsMFt7v0NiaSa4WpQfRWFhzEyDrbNhxf/Ydd/0L7WqrPoateNgG/aRNbZ2wXodufrNp6cOnnTNqxTbUZJzrzWbzPxTUsr0=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"}}');var i=n(74848),a=n(28453),o=n(33617),s=n.n(o),l=n(17543),d=n.n(l),p=n(86013),m=n.n(p),c=n(63723),u=n.n(c),h=(n(18766),n(79329),n(9303));const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWl1uHDcSvkqFL7KF1owkW9ndeYpjexNhjUiwZAQLjTBhd9dMU2aTHZI9o85ggH3IDfYGOVpOsiiyf6UZ/SR5WwOGLLGLrGL9seoj18zxhWWTK/ZOJ2WOyll2HbEUbWJE4YRWbMIuM4S3BrlDaKhgbnQODvNC0vCb81PgUuqVhUqX4DQsUKGhTwpXkDZrQ1zBTWkdFEYvRSrUol1jJlIQyjrkKeg5lIXU3BNwv8RcSHwhFLgMYa5NTjQxt/j1a9AGYqG4qV4CLtFU4ESOXg6FmJIwSRCet4KM4LJma2k1MFgQRSorKC2mnpuFhCuIsZ6dhi2XFg0I5dDMeYLAHVzt77/DuFzAp9P9/esXmXOFnYzHvChGukBlxUJJHttRovNxSoRFOn9JQpfW779T7mVPnaOpmqp/69ILEbSFkOKcl9LBksvSq4GUDiuRLpB0y0l07XUkDCie4+C7LYtCGwd4m2DhgATjrjQYgXU8LyIQSjjBpY1A5HyBo6k6GsH+PuZcyP39qfrpp5+maj1VAFNGq0/ZBKbMf56yKIwb5KlWsqJvcy4t1uO16L0p3+AtzwuJpJgpm6pNzWCqjokrMdjNNPz2HJ43GodcXhGXGx3DpXDyAVZE4ojkefwS1EN+r4lfovOCq2o3t5rgmfoMmoRi6UC6dMj3hPim3D2wRfr6PI5HRweHJwfHh8cnQ2ZfEzOHty7Wt7v51QTPY5lXQPOG/P7mlZph8vlBhg3FczheTZn2GfDgeMquO6YHpM5ANtnfhyZGM75E0AopsnNtEFzGlR8I0eoy7nxCspSRYgSLEhPKK3HVBLYP+r97exldpHqlHrBZTfE8JYYdHQ2V+A/iaHgqNMSlc/oBrp7qT7NkEdMFHQ9Cq9OUTVidYuvsvBIua44FkbKIFdzwHB0aOqnWXhw2Yb2Tg0VM0ElVcJexu8eXjm8wcaf+WGlSLIuYwZ9LYTBlE2dKjJh1laRlraBYYhHD20LqFNkkbI3ZJMOcs8mauarwlM4ItWARowOJu/5IHZEk0vdHcZYcZ0XMNpvrwBat+1anFS2VaOVQOfqVF4UUiVfK+MaS6Osez07cK0apm5RxHTWihD2Sqgxp1gm0fnpN2MnMjeEVqcth3h/fsYDRtIn7O+729yZJdOkUV45topDZH1SRJ+gvcKOxfxTQKsHAD3G90QgxIhEXmVaPUB8dv6J/r46Ivj4O/7hOHpeuzm8zz68Jkt6UWGuJXPXneB/bRE3oPLx+nQpjfcs2m4j50+leFPXCY3YR/GDW7H3zrGmeyVzLFA1F60OS0YYtqnR21xG6Ld+tLYWFNr7vFJG2wETMK1hl6DI0fnjFlQO/epdIlfPUQdoRUL06LJWEpVPHlDhlIzid+6IrfNH0x0CEHi1wlYLSsOf5zWzpHWJvXP8d67Ta62Za4AZrmQWmrQieuK1zLayElCQ3VZqj6cALiG0TRQ27bQof6vBtaZ3OwbOpJ/nisK3woE46I3jLFQiVyDLFupQmhVMdCut14wIz7xmbDazXZEs0M3L5zSbqBojXYMBHYRgxmKBYDma1Q9hNbMd6U/G2EKaaUT0SBupyqC+AWCihFrPS1OsoTcSje27Y2ejJGrynsNp2tMj/le5IsFN1ZlI0T4jh0zlY9CG4Rw68FwHlu6AjYayrIzM4fi26/7pL33UjIqsRvG8j3ZaxJSrVrNdFkjNisUCDKdQUfnIEVEgA8iQLOcJLxecU5MS9MLgUurSNeBm3QDqTSFVZaKJqjY3g27ZIi6CnHcoWg72PtoQz9aOX+m299Dte9Q8ZVeYxmns69T0sta71LEh5ZYmb70/pA5dJ6bvFYHggw1M6q3Rp2ka3f/K2nFr5jk4oThSPJZ5dnj/B0rQhOAgZM9R1wQZhDTi7PIclGjGvy5gRfLKtnRrD8wEJJDpFWAoeTB/BKhNJRtqvICekAJW3V0jv3m5dE+8PTTiA+wKlwm6VKAonDAVt6UXbtjCkwmDiZOUdSJcOeJoKms4lWIeFHW07uoMSLnX5lJh5RJMcFqVIvaVL0yZzNDbqQScEl5gyockW0tI0cELttESZoLWdnhqtEFFv/QhQ2TCdw5xbhyaCUnmUw5QFRUOzJN4WaASqBLeqoJfyHk+6dEx7kEKHA7lAY7Wi/kmbBVfil+AgpJlMW6r3Mi4DaZ0mLMRIUlF0D5NYg7z8/utvrJNrZ3V6X7DAgaepQWsfkdC3dsGdqBM0WFD200OJaD0039yFhEg675KzXKetm9qne9A5mlw42+ZEp0lqQIkBcbNlkgG3Xa61faDHIz82oi1RRenRI13QfvFWWEfKbeAjsSv6PiLpMenJ4JEyihnyKFX1w6eVy+k7y/lKUNgw2q/etnoaIXSPW5Ka85xXLYBGa9eoISrKPCmcv/unh/tIILIcoXrexZr9U3fRy6Jh+r0Tk5dOzwzmQj3tzLwIh4Y3otNt2JdO59yJBJql7Ahq0qBup/tRnMOLRlUUHUuhzcut6grLzbRKcCbUzOOkjx9CP/hh8gZ/+sToVoiqL1tjtHC0hgaWZFtlqGCgk95JSZseSHmyux2Z9fsRX8z53mXYvPsBW2hlQ4d2fHhI/w0300LXDZ5ry4TS47yUsvqKRU9vxR9uDxu44blAQXYjjn+5TZbH5z5jiYUqjfzjXerjnfi2xvIOLkuSDKV42lZqDLw08sDpA9rLQRvoftmevYWSQuGsMeAs1cms2T3R5WgtX2wN9odkaM3tS7+hrR9hTy62idjrbV506gssj/apPV8YtAmSmsUmA1KybNB8bUBp1+aghoRL7bOry+pak7AWP9O7+V/mj2iMNs/V3rlEbqm1dmXR7SQs/JgGXx8ezpJOiSdblKiWXIrUXxtd6s+o/sLw27ndbnN99i6wJ1Fvc9nBO0wEIv+dDXbbHw+btJiURrjKo5O3B7wQB+H75OqaML8cXaYJ5yy09RITTDlh42GqG697uW7DaFmzbDBPH4VtYFmu0ljf3r9g4oUYLwl2ujtj63XUTmosD543wTq+EGrx8KzrTlMXZM1gsIG+umxXiH8hRUFtjj5VDfZmyOmsJQOQk3zsgNX3jal7COhVA2b2EcsWsLyHQraMG6SxBRp7aGIPTOzD0g3418f+agy5hfcGGJ53kg5gY2wIogV8+g4oxNgQ4mgmtW17mLWt9zw6GXR9tWj99qVBvPvl/KCmvltS7yxvd1S3NYNQxZHod+qn+vv2soW6VqHm2rtLHZZnBSqCK31QL4/ulTI/okx0aKmpumvIf//1Nz+jiUEv31d0KXJWGij0Cs28lD61zyXeCqptiB5z/61DKpHnEq2Vlb8cXvir71QshKOWsW6eEl7wWEhBqYrIdOjVe9nOjuDHDuvcM/7OGpcoKcO11aFadK3qSpvPc8JMI+AQ05Uy9SuoMq6S0BqFgPMlPlehnS6MoOTuDEktgmxaOcMTBzlXfOFr9GigpRQlIU4WjI6pL7dalqHzdFxIbQIq4Tfkb7n8XdZ7ukIxCDRKSIbBjPxjWbefNgrtv/VxR1tQKcTo3wfwxIkEfZ9QKqmTzwFPKqWEQruA8VBl2peRpjvDlfUvBAIQUtugVVjdFGMQcH//k0Wy8AehPtsJXXwdwFXrTD9ibIXD7lZ/tVrdy28vh3O+E+77MoaPWGgrnDZVN3shXFbGPif2F2n/CCt91zyd6OW8bo1UJ3bLwwKd2HGGshhfoCMPseM356f+bH0Jv//nv/ABuVGQ6VXw1qQ0KKvulQZpLlg+qK09GsMrg9JlpPEkOF8N1tkAXt/J38OwMzhHj0bZwaMQXoh6+atGTCDp/8w26ZAmL+YBMm8SEy/E1qbbocnt2fwCzVIkTdG6w8JjTzxmEZMiQWWxVye8+e78Ayzh1eiQRb1D8QnWHn84ffv+h4v3JA1FVtDY0ehwdOjvtbR1OVc9Vlvf4PRuNAeq710tfnnA8+UBz5cHPF8e8Hx5wPPlAc9f9oCn7tPIouNCcqF6WFHob6/uQHksYpP+m53riGXUD0+u2HpNue8TXUvS8M+lr/OvriO25EZQX+I7rBr5THvt1I4T78XHGiB8CTue/2yVv2k+FXWe3uyhO/mM1Z0HR5vrTdR0oCRaoHgbBDi4pHW6Fe7hGdRAhxlvEsrlD9L2AYTzs4tLFrHmVjv375OY4StqNvkqSBsMFt7v0NiaSa4WpQfRWFhzEyDrbNhxf/Ydd/0L7WqrPoateNgG/aRNbZ2wXodufrNp6cOnnTNqxTbUZJzrzWbzPxTUsr0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,j={},b=[];function y(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,i.jsx)(s(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,i.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"7",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"8",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"9",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(m(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_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}}, {{note}}.",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}}, {{note}}.",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},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},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},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},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,i.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:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},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 x(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.1cb53b0f.js b/assets/js/2c586be5.1cb53b0f.js deleted file mode 100644 index be2639e5b..000000000 --- a/assets/js/2c586be5.1cb53b0f.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:()=>y,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>x});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":"eJztPNlyG0eSv5LTMRGyOA2QgChZy6eRJa2Hs1qRYVLh2CU5dKE7gS6xu6pdVQ0QZiBiH+YP9g/m0/wlG1lHHzgI6hgPHQs9SOg6s7Iys/LUXWTYREdHF9EbmVQFCqOjqzhKUSeKl4ZLER1F5xnCa4XMIIRR8Or0GFiey5mGSqPSYCRMUKCiUQJnkIb1YDSHUskpT7mYQMoMgxk3GYyYxheHgCKRKaYw5jn2L8WlOOflEXwoc8lSmMtKwembf69Xo22o7WJv7w2Oqgl8ON7bu/omM6bUR/v7rCz7skSh+UTkbKT7iSz2UxpYpuOnMcwyVEirQsIEINM8nwNLU5jxdIJGx2AyFJDIcg6JlCrlghnUMZRsgiCqYoRKx8BECoVUCFwAA4UsnfeM7FUa4a9nJ+9hLFXBTB9O80rH9XYpV5iYfO6WNxnWp3qiAza0UVxMYijYDWGLG/i54skNHVujSOlfmvjq9Njiam/vrCpLqQym8KM7wtHeHvV8h7mcAVNoxyeyKKSAkilWoLHXlTFjuxX+XHGFqbsUlucBF0eXogd7e2Ze4tHeHhyLlCeEDLsgtYIc+7F9N5SQREPPSkz4mPuhLdSBFDDLeJJZnMyYu88yZ4kDU6EuMTF8it2Fb2OY08JvUMgAQSYV/0UKw3J7HVNUhicsb18bAUhDtWHKEDpLyYUJrX4H+C9/PXR79lI8XRFoKSGr4ML2aIQpyyvUHqpZDBlB9QOWCrUldb8uIVKkkCGfZBv3Y+nHSpvOwlBpArMNhd8r3JJFL1q0jVmuEfi4g8uC3WBrN5CWh1neh+/mkOKYVbmJgRPFGVVhH95LA6wsc56wUY5EuUDMw0ylsGdv2ZODB0Swwt7xqeVo1MAg5eMxKmJO6rRL+DkBOqKzRgRYzjEZEyDF0kUnMpdqlYRscxePkEhhUJg+vJoynlvg3WE1cJHkVYowyllyE8MorzAGhalj3DmS2Iq9EKIhwLTHucUPaMyJCqUg+IX023MN2kOV9uE847rhJ+oMqLabcN3GqufasaSdCQWBxQALxvPYIi6Gj3IEhpscY2LYkol5TPISYzB4a0byNoYkw+TG/lIs5RJGlTFSuIOlSpapnAmPy7EURvNf1nBk6Pl0jA5jOIzhRQwvYxgcxDAYxjA4jGHwIobByxiGBzEMhzEMD2MYvnBgDV96XLMawW0ABkOHZfP7wS7J3XdcW84mgalrGTzryOBBH/b2am6itp9++ulS3F0KgMuImOsyOoLLqB5yGcWuj2Qm9Q389y19PBt+6z/n9Pli+NJ/zuzQwaH/zOhzOLgUC7/hpRhaSAwrynugoO6vCoH/8kREbXZTagvyjBpJEMWhg+6qAw91LNpneUZn4YIbznK9+ThhxCM6UQPSyqEO6VCWXDefyHY/ouO04aEeKyZdlxWrra7A8BaK4crpn/f9y7L58G7bR3P2FjhfdvQXdHQSTeckmjafv5ZejwgJyzB9GSa+7VsFwErmzXjwAx4RFroQfRkOXhIO6FHajADqfUSnb4FDHf6Fd30Hh73B897wYHjYwQDZRm5AUfTStDefz78G9kjn8duTyhM0VKfZkVU6VrJYY35Y66AZ5XUi+zuo7P9Jivoo6LCYkt1nDYugsdQWX1vLNjJl8yfaLRWm1soZjW9Us3kLTNtFcFjrN8kkTzzwNCaoZCMy8PqEg57F5H6a7rcwSY1p2iuK3lIjffYs4luNRdFP0/7SyJXbcY0FpGkMq81r29MUiqLY0OzaLyOrUv0bkb7XxDZTvx/wWzFAQ+fdje9lDvIHSJHbva2Rtp47lp6QjAvf4UkFlgYonFQ5U3hL1qbmUrjRX59zAuM0+rq1Tq1hZ21/hwr45sTr5E89UdMRugtQy/Z5KyejRV5BUmkjC1A4wVsomTGohF1synKeMmug9WwD3rKiJMV+/2+Xl+mf/rhv3QpkuRugm4CUTzh5d/b/dvGq999Xa0ZUZYkqYRohR9pJx4Am6cNFhnnZOJhms1l/9kwnmZS58y591ArH7u9rOfp4bcEt+0yXT9ed1JFGy4wn0lm24jWaDsaYhjBzjSFvaczy0ODAvqHeirnnEfUjHtE7sgQSdTqfCHVfXEYFs2oGkTI2v6XJUF1GV/UcZ7pjumXu1QOYNeMp5myE+WrXgxmtfRZPsi3EUEfBRe1usPAexK1OdrvU6foWaxjYnbjNfuGlCPwXUAw518Hh0sVXe7b3SFk/oUC0rscRQphAXt0gHr6UzGvAHkbnTtT4y9myBY0DO7D2BobdtuzQuZg2YmiNggteVEXt1hzXqwaUFV5laOOLZpKzPOzQvt2VHdjtlh3Ih7h5g0sxsO6H4La4R6H0Ix6RMFgC6X4+/Rwx0XmIv9ILup0Bw7HaDLjm3aWh7sWtmU9v5r4+nND7Ra5UN4mcY0mCpSFH2peyZg3yg58g62pqu882U1571COivjVg/ZMp0I/7baiwfbzfESV2wH4wNTpnYcEm91jUtvsR0Z+HZ+lyoziSJYVXuRTHaXQUJTYiG0KIUWyXRm2+k+k8OrqLvDuffnpnOU3d/6gppnsX6STDgtGvABJFgSkKG8XWI41KR3Fk/TsUEiZ8RUeRHH3EhHYrFYFjOGpaw847ugujXBgzir21Hx1FLr4ZxZHX1eumOgBcpuNoETa8b6m6pVlK2x91PJXWoUjhZy7znqYulqLgn7XSm9YK9mwFnsvXkvoMvmFz3VrXvfTRcvCd5hAfJH4WpGyuibUq7ZSyhOVJlZPnAG9Lrua1G8O6D1r0UcNb71TDO3i+aC69AYkpxeZRHHGDRbt9AxEo+ek3l6AkzFhf8qfO/ShxhPhn30DWmL14VnwyFB8lwgjtpZeZFJ88fzB8NhgOng2GtIIPAn0+Hl3vKgRdwnhF4S5Mg6Lea+K2MdjYSX8bjYbx9thsgtuJ8XxTPL8VRtSZrPKUAnTIVN+G1T87Y6NL3/Vz1N9CzYs4ut1+mFtIZC8kC8A3OY6NcwNAIpVA9bTtMXw0hxseHi7iaL79ePPf5fG+pcubbT/djzbLoslA+VfA+uzlIo6y7bD+pc4D+RcCe/hi0byuS8rD9Uim8+sgtxbbBoaHgsaNZZ6iIoVkVV41ooYkDOUvXS/L+ZGUOTKxRtB0EgB8phnphaQSepf5LENSqxt10a7eaKhegXTQUlIBLnk0uSZFUFV4GfXheNzSd62vYDkHIYy1+QBCwhO737WurBh/su+/CUdP2rlWlP7ShAoCCHYwGCzK3CYrzXieE9z0rveh/mM1vxqTBEB4LsPG25+K186Tajf0k7qZPuB1xz68ZqLO9uhmVcDdXU0GljoWC7i7o1tFdU2P7mIRNw20V6fBvquuRWGCfNqZVTdhM7Fua011Ks41qTiuwUff2gDwieBicl0pvw5pgotFf4Ugm9t6MAZXEOZvkRb5f4U7AuxYnKgU1QO4+XjszDgJT4iAn8TO525xxJU2nkcdC3jQXYBtA759JgVZf29rntfVSNMoEdZreMooPpkgZTn6EXayz0tClmROWlio2JjY3WYuKpxyWekAXsZ0rYanNII7FuJi0rVCW9ixaWPts/fXsbOgRKaT89MH4NLayD0nnZyB6U7p1oCT81PKheRjb+/14YOuMRFQyzpDgOwvmHIW8qVqlW7u3JgoLEacKO0krvZ9FmIPVgFKuV4LUeykObFFnTm8snCTLEtXJCtDWbrcp4Bpg6Xu4NFCUSPyXFYPocotmGQwqWyw19BLHcSljQw1uYxcaKMq58KFtFIhfdOTBY1MUOsGTwErNKi1fgwotJvOYMy0QRVDJThhXlXkQamXxNsSFUeR4FoUKHSoIx7eLte6iYEffnjnU6TDGQJTjogD3cKYQlVaqrGcUCeshptbPvpa2eEF2HYA6dG2aaXee1+i0lIApYOqCRP8F0fC1hCRmqy4jOVuqBcVFConeIjDu8AEFevXv/+jBddGU3QVMLcDS1OKW26B0HrQHMGT515hSRJQdiGi9VD9eVn3I+gs01wXMq0ZST+cxk9tpFPXctFIm/WOOboUfV0lGTnVanmr4yBjtbcmdUxHoogkIdvIks6Lt1ybVsplSIxYlQ8/IOExacFgrQ/iaqJ5MW8zeA2XT+1slrN6Ie+m69ba7wovsMrIa4UFFw97p9puSCNrQVAZWTDDEwhL6X43CZsyxRu+LuCbABpR45RL9XQDq9Jy11IkeM3FNU5RPcCue19HhKwnaIRmhijasAUkueesSZSdUW1DByet18mmg7ehfL7FDHB2QuM89G8Z5fBLoZ0nY3hwQP90D1DXkPhFifpIUoyrPJ//IYof7rm8343imtebJvf5RbKPfPjLbTIdnkbeK9YVpZ/ozfks1xbNWXZsbRDo9x7FG5SVyqlAhc7Sq5nJLtu6Yy5yLvA6XOB1KpPrcHoaV6DWXS/Rg2Cor9uqWN273rI9kdgijg7XUdGZLNBkVvbQujMlqW6mzJFyOIyaA5swLoBsK/UViQqVkup+Y/fTILsPBYcHB9eDGgnPV5FwLGxiga3GOpc3KH7bk7a3N257AvW2sITqHviIu0G2P+octt3uDqkxqRQ38+jo4i667bGS91z/0cXV4opI0GSSgh+l1BZiZrLoKNpfiYVoVFPry764c3xTs4JmIqXo/4p/hZV8fzqIFvHyjLXemI2jsep92gRt2ISLyf2zrhrcnNH9uSvqYKiRTyX/DyQB5S+gPSqOONFNhoxeREI5kcUPTeTobbjcENNZF6ZpLnE58BLiLp1QyvILtiY4sj42MnjeikpchACDjRnUIYN1UYD66MGvX7v1W576lqP+oiHy2iceXOID60seHh5ap+u3A+udfPbSOv4OXywsWTZOsCjqOrpsiG/ZXRNFXedDmFQb1H5WYxW6eHPHvPFNXXU/rFSr1x0dd1nF3ahubtA2/ZZLWlUNyDplhuJKXIylJU9PMyclijMy+EhsTAerrl3ME1nUdT1h+K9//4edEWjNQvUHivKeVApKOUM1rlx90DjHW04aD43HwvY13kNkRY5a53Mg82piK1ZtgiCZlt54SVjJRjznJAxpmHTRtJY81X34sfE/PlEuX3KKOcnQWmekitfw/s2kuhmTHzMGBiMq9SOrAUXGROIMFMfgVtGm8lQy/krFNVUwKoKaO9ikMIolBgom2MRqynEHSynm5PvRoOSI7Hct88pZqIbxXCoXN7QHsiF9Gyp/e1tSl3VLk2mnMCOqmHozVcfOTeB419fAjsgjUxIsPEGrrVcil1SuSp6dKs+hlMZ5W0hfbcNI041iQpPq4EOV/g5qhHkLErWvufqgkW74HRc3rsSqBxc1Mf2II80NdlM1lyn7aXfO99z8pRpRAafU3Eg1b2ZPuMmqkZXB7UXqD7fS96HiuSVjmzVSmeg1fnyZ6H3KKt0/Q0MUovdfnR7b1/sp/Po//wvvkCkBmZw5ak0qhfm8Ka62xcf25h3a6sfX+ihYRRXMxhKpmAS3GWEwipffiy7bKRyjjRd3a7lZyf3yFwFM6ObEfvoxSQ0gKmbOeR3EESv5WtOXanD1yfgM1ZQnQa3dcMP7dvB+FEc5T1BobGkir74/fQdTeNY/iOLWI/yA295/d/z67fuztwQNcZbD2KB/0D+wwVOpTcFEa6ulcvllGdfKzthV1++q63fV9bvq+l11/e+m/ntXXb+rrt9V1++q63fV9bvq+n8eEnbV9bvq+l11/a66flddv6uu31XX76rrd9X1u+r6XXX9rrp+V12/q67fVdfvqut31fVft7reZwCRVrhf5oyLVs6lyzO7WK65v4qjjBLRji6iuzuKMX6guhlq/rmy6S8XV3E0ZYqTJ93msMUh9Ypyjm6Qkn9eu8BA75z2jx2522D4UuoeZY65Ga/std87tp0rd3pydh7FUSh0KmRKcxSb0f8ZwGYua8hj05ZxM1t/mTMxqWwKVOTWXLiM6qybanZjU838j1YmFRPzFoTdHDR3DPqbDrV2wt2dS2NbLOrxrmvjDI/YMJru72qxWPwfpFGscw==","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),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"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:"eJztPNlyG0eSv5LTMRGyOA2QgChZy6eRJa2Hs1qRYVLh2CU5dKE7gS6xu6pdVQ0QZiBiH+YP9g/m0/wlG1lHHzgI6hgPHQs9SOg6s7Iys/LUXWTYREdHF9EbmVQFCqOjqzhKUSeKl4ZLER1F5xnCa4XMIIRR8Or0GFiey5mGSqPSYCRMUKCiUQJnkIb1YDSHUskpT7mYQMoMgxk3GYyYxheHgCKRKaYw5jn2L8WlOOflEXwoc8lSmMtKwembf69Xo22o7WJv7w2Oqgl8ON7bu/omM6bUR/v7rCz7skSh+UTkbKT7iSz2UxpYpuOnMcwyVEirQsIEINM8nwNLU5jxdIJGx2AyFJDIcg6JlCrlghnUMZRsgiCqYoRKx8BECoVUCFwAA4UsnfeM7FUa4a9nJ+9hLFXBTB9O80rH9XYpV5iYfO6WNxnWp3qiAza0UVxMYijYDWGLG/i54skNHVujSOlfmvjq9Njiam/vrCpLqQym8KM7wtHeHvV8h7mcAVNoxyeyKKSAkilWoLHXlTFjuxX+XHGFqbsUlucBF0eXogd7e2Ze4tHeHhyLlCeEDLsgtYIc+7F9N5SQREPPSkz4mPuhLdSBFDDLeJJZnMyYu88yZ4kDU6EuMTF8it2Fb2OY08JvUMgAQSYV/0UKw3J7HVNUhicsb18bAUhDtWHKEDpLyYUJrX4H+C9/PXR79lI8XRFoKSGr4ML2aIQpyyvUHqpZDBlB9QOWCrUldb8uIVKkkCGfZBv3Y+nHSpvOwlBpArMNhd8r3JJFL1q0jVmuEfi4g8uC3WBrN5CWh1neh+/mkOKYVbmJgRPFGVVhH95LA6wsc56wUY5EuUDMw0ylsGdv2ZODB0Swwt7xqeVo1MAg5eMxKmJO6rRL+DkBOqKzRgRYzjEZEyDF0kUnMpdqlYRscxePkEhhUJg+vJoynlvg3WE1cJHkVYowyllyE8MorzAGhalj3DmS2Iq9EKIhwLTHucUPaMyJCqUg+IX023MN2kOV9uE847rhJ+oMqLabcN3GqufasaSdCQWBxQALxvPYIi6Gj3IEhpscY2LYkol5TPISYzB4a0byNoYkw+TG/lIs5RJGlTFSuIOlSpapnAmPy7EURvNf1nBk6Pl0jA5jOIzhRQwvYxgcxDAYxjA4jGHwIobByxiGBzEMhzEMD2MYvnBgDV96XLMawW0ABkOHZfP7wS7J3XdcW84mgalrGTzryOBBH/b2am6itp9++ulS3F0KgMuImOsyOoLLqB5yGcWuj2Qm9Q389y19PBt+6z/n9Pli+NJ/zuzQwaH/zOhzOLgUC7/hpRhaSAwrynugoO6vCoH/8kREbXZTagvyjBpJEMWhg+6qAw91LNpneUZn4YIbznK9+ThhxCM6UQPSyqEO6VCWXDefyHY/ouO04aEeKyZdlxWrra7A8BaK4crpn/f9y7L58G7bR3P2FjhfdvQXdHQSTeckmjafv5ZejwgJyzB9GSa+7VsFwErmzXjwAx4RFroQfRkOXhIO6FHajADqfUSnb4FDHf6Fd30Hh73B897wYHjYwQDZRm5AUfTStDefz78G9kjn8duTyhM0VKfZkVU6VrJYY35Y66AZ5XUi+zuo7P9Jivoo6LCYkt1nDYugsdQWX1vLNjJl8yfaLRWm1soZjW9Us3kLTNtFcFjrN8kkTzzwNCaoZCMy8PqEg57F5H6a7rcwSY1p2iuK3lIjffYs4luNRdFP0/7SyJXbcY0FpGkMq81r29MUiqLY0OzaLyOrUv0bkb7XxDZTvx/wWzFAQ+fdje9lDvIHSJHbva2Rtp47lp6QjAvf4UkFlgYonFQ5U3hL1qbmUrjRX59zAuM0+rq1Tq1hZ21/hwr45sTr5E89UdMRugtQy/Z5KyejRV5BUmkjC1A4wVsomTGohF1synKeMmug9WwD3rKiJMV+/2+Xl+mf/rhv3QpkuRugm4CUTzh5d/b/dvGq999Xa0ZUZYkqYRohR9pJx4Am6cNFhnnZOJhms1l/9kwnmZS58y591ArH7u9rOfp4bcEt+0yXT9ed1JFGy4wn0lm24jWaDsaYhjBzjSFvaczy0ODAvqHeirnnEfUjHtE7sgQSdTqfCHVfXEYFs2oGkTI2v6XJUF1GV/UcZ7pjumXu1QOYNeMp5myE+WrXgxmtfRZPsi3EUEfBRe1usPAexK1OdrvU6foWaxjYnbjNfuGlCPwXUAw518Hh0sVXe7b3SFk/oUC0rscRQphAXt0gHr6UzGvAHkbnTtT4y9myBY0DO7D2BobdtuzQuZg2YmiNggteVEXt1hzXqwaUFV5laOOLZpKzPOzQvt2VHdjtlh3Ih7h5g0sxsO6H4La4R6H0Ix6RMFgC6X4+/Rwx0XmIv9ILup0Bw7HaDLjm3aWh7sWtmU9v5r4+nND7Ra5UN4mcY0mCpSFH2peyZg3yg58g62pqu882U1571COivjVg/ZMp0I/7baiwfbzfESV2wH4wNTpnYcEm91jUtvsR0Z+HZ+lyoziSJYVXuRTHaXQUJTYiG0KIUWyXRm2+k+k8OrqLvDuffnpnOU3d/6gppnsX6STDgtGvABJFgSkKG8XWI41KR3Fk/TsUEiZ8RUeRHH3EhHYrFYFjOGpaw847ugujXBgzir21Hx1FLr4ZxZHX1eumOgBcpuNoETa8b6m6pVlK2x91PJXWoUjhZy7znqYulqLgn7XSm9YK9mwFnsvXkvoMvmFz3VrXvfTRcvCd5hAfJH4WpGyuibUq7ZSyhOVJlZPnAG9Lrua1G8O6D1r0UcNb71TDO3i+aC69AYkpxeZRHHGDRbt9AxEo+ek3l6AkzFhf8qfO/ShxhPhn30DWmL14VnwyFB8lwgjtpZeZFJ88fzB8NhgOng2GtIIPAn0+Hl3vKgRdwnhF4S5Mg6Lea+K2MdjYSX8bjYbx9thsgtuJ8XxTPL8VRtSZrPKUAnTIVN+G1T87Y6NL3/Vz1N9CzYs4ut1+mFtIZC8kC8A3OY6NcwNAIpVA9bTtMXw0hxseHi7iaL79ePPf5fG+pcubbT/djzbLoslA+VfA+uzlIo6y7bD+pc4D+RcCe/hi0byuS8rD9Uim8+sgtxbbBoaHgsaNZZ6iIoVkVV41ooYkDOUvXS/L+ZGUOTKxRtB0EgB8phnphaQSepf5LENSqxt10a7eaKhegXTQUlIBLnk0uSZFUFV4GfXheNzSd62vYDkHIYy1+QBCwhO737WurBh/su+/CUdP2rlWlP7ShAoCCHYwGCzK3CYrzXieE9z0rveh/mM1vxqTBEB4LsPG25+K186Tajf0k7qZPuB1xz68ZqLO9uhmVcDdXU0GljoWC7i7o1tFdU2P7mIRNw20V6fBvquuRWGCfNqZVTdhM7Fua011Ks41qTiuwUff2gDwieBicl0pvw5pgotFf4Ugm9t6MAZXEOZvkRb5f4U7AuxYnKgU1QO4+XjszDgJT4iAn8TO525xxJU2nkcdC3jQXYBtA759JgVZf29rntfVSNMoEdZreMooPpkgZTn6EXayz0tClmROWlio2JjY3WYuKpxyWekAXsZ0rYanNII7FuJi0rVCW9ixaWPts/fXsbOgRKaT89MH4NLayD0nnZyB6U7p1oCT81PKheRjb+/14YOuMRFQyzpDgOwvmHIW8qVqlW7u3JgoLEacKO0krvZ9FmIPVgFKuV4LUeykObFFnTm8snCTLEtXJCtDWbrcp4Bpg6Xu4NFCUSPyXFYPocotmGQwqWyw19BLHcSljQw1uYxcaKMq58KFtFIhfdOTBY1MUOsGTwErNKi1fgwotJvOYMy0QRVDJThhXlXkQamXxNsSFUeR4FoUKHSoIx7eLte6iYEffnjnU6TDGQJTjogD3cKYQlVaqrGcUCeshptbPvpa2eEF2HYA6dG2aaXee1+i0lIApYOqCRP8F0fC1hCRmqy4jOVuqBcVFConeIjDu8AEFevXv/+jBddGU3QVMLcDS1OKW26B0HrQHMGT515hSRJQdiGi9VD9eVn3I+gs01wXMq0ZST+cxk9tpFPXctFIm/WOOboUfV0lGTnVanmr4yBjtbcmdUxHoogkIdvIks6Lt1ybVsplSIxYlQ8/IOExacFgrQ/iaqJ5MW8zeA2XT+1slrN6Ie+m69ba7wovsMrIa4UFFw97p9puSCNrQVAZWTDDEwhL6X43CZsyxRu+LuCbABpR45RL9XQDq9Jy11IkeM3FNU5RPcCue19HhKwnaIRmhijasAUkueesSZSdUW1DByet18mmg7ehfL7FDHB2QuM89G8Z5fBLoZ0nY3hwQP90D1DXkPhFifpIUoyrPJ//IYof7rm8343imtebJvf5RbKPfPjLbTIdnkbeK9YVpZ/ozfks1xbNWXZsbRDo9x7FG5SVyqlAhc7Sq5nJLtu6Yy5yLvA6XOB1KpPrcHoaV6DWXS/Rg2Cor9uqWN273rI9kdgijg7XUdGZLNBkVvbQujMlqW6mzJFyOIyaA5swLoBsK/UViQqVkup+Y/fTILsPBYcHB9eDGgnPV5FwLGxiga3GOpc3KH7bk7a3N257AvW2sITqHviIu0G2P+octt3uDqkxqRQ38+jo4i667bGS91z/0cXV4opI0GSSgh+l1BZiZrLoKNpfiYVoVFPry764c3xTs4JmIqXo/4p/hZV8fzqIFvHyjLXemI2jsep92gRt2ISLyf2zrhrcnNH9uSvqYKiRTyX/DyQB5S+gPSqOONFNhoxeREI5kcUPTeTobbjcENNZF6ZpLnE58BLiLp1QyvILtiY4sj42MnjeikpchACDjRnUIYN1UYD66MGvX7v1W576lqP+oiHy2iceXOID60seHh5ap+u3A+udfPbSOv4OXywsWTZOsCjqOrpsiG/ZXRNFXedDmFQb1H5WYxW6eHPHvPFNXXU/rFSr1x0dd1nF3ahubtA2/ZZLWlUNyDplhuJKXIylJU9PMyclijMy+EhsTAerrl3ME1nUdT1h+K9//4edEWjNQvUHivKeVApKOUM1rlx90DjHW04aD43HwvY13kNkRY5a53Mg82piK1ZtgiCZlt54SVjJRjznJAxpmHTRtJY81X34sfE/PlEuX3KKOcnQWmekitfw/s2kuhmTHzMGBiMq9SOrAUXGROIMFMfgVtGm8lQy/krFNVUwKoKaO9ikMIolBgom2MRqynEHSynm5PvRoOSI7Hct88pZqIbxXCoXN7QHsiF9Gyp/e1tSl3VLk2mnMCOqmHozVcfOTeB419fAjsgjUxIsPEGrrVcil1SuSp6dKs+hlMZ5W0hfbcNI041iQpPq4EOV/g5qhHkLErWvufqgkW74HRc3rsSqBxc1Mf2II80NdlM1lyn7aXfO99z8pRpRAafU3Eg1b2ZPuMmqkZXB7UXqD7fS96HiuSVjmzVSmeg1fnyZ6H3KKt0/Q0MUovdfnR7b1/sp/Po//wvvkCkBmZw5ak0qhfm8Ka62xcf25h3a6sfX+ihYRRXMxhKpmAS3GWEwipffiy7bKRyjjRd3a7lZyf3yFwFM6ObEfvoxSQ0gKmbOeR3EESv5WtOXanD1yfgM1ZQnQa3dcMP7dvB+FEc5T1BobGkir74/fQdTeNY/iOLWI/yA295/d/z67fuztwQNcZbD2KB/0D+wwVOpTcFEa6ulcvllGdfKzthV1++q63fV9bvq+l11/e+m/ntXXb+rrt9V1++q63fV9bvq+n8eEnbV9bvq+l11/a66flddv6uu31XX76rrd9X1u+r6XXX9rrp+V12/q67fVdfvqut31fVft7reZwCRVrhf5oyLVs6lyzO7WK65v4qjjBLRji6iuzuKMX6guhlq/rmy6S8XV3E0ZYqTJ93msMUh9Ypyjm6Qkn9eu8BA75z2jx2522D4UuoeZY65Ga/std87tp0rd3pydh7FUSh0KmRKcxSb0f8ZwGYua8hj05ZxM1t/mTMxqWwKVOTWXLiM6qybanZjU838j1YmFRPzFoTdHDR3DPqbDrV2wt2dS2NbLOrxrmvjDI/YMJru72qxWPwfpFGscw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,f={},x=[];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 Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",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}}, {{note}}.",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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},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,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/2c586be5.971c43af.js b/assets/js/2c586be5.971c43af.js new file mode 100644 index 000000000..9a8025f86 --- /dev/null +++ b/assets/js/2c586be5.971c43af.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:()=>g,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/createdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocument","permalink":"/docs/API-docs/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyG0eSv5LTMRGyOA2AgChZy6eRJa2Hs1qRYVLh2CU5dKE7gS6xu6pdVU0QZiBiH+YP9g/m0/wlG1lHHzgI6hgPHQs9SOg6s7Iys/LUXWTYVEeH59EbmVQFCqOjyzhKUSeKl4ZLER1GZxnCa4XMIIRR8OrkCFiey5mGSqPSYCRMUaCiUQJnkIb1YDyHUskbnnIxhZQZBjNuMhgzjS8OAEUiU0xhwnPsX4gLccbLQ/hQ5pKlMJeVgpM3/16vRttQ2/ne3hscV1P4cLS3d/lNZkypDwcDVpZ9WaLQfCpyNtb9RBaDlAaW6eRpDLMMFdKqkDAByDTP58DSFGY8naLRMZgMBSSynEMipUq5YAZ1DCWbIoiqGKPSMTCRQiEVAhfAQCFL5z0je5VG+Ovp8XuYSFUw04eTvNJxvV3KFSYmn7vlTYb1qZ7ogA1tFBfTGAp2TdjiBn6ueHJNx9YoUvqXJr46ObK42ts7rcpSKoMp/OiOcLi3Rz3fYS5nwBTa8YksCimgZIoVaOx1ZczYboU/V1xh6i6F5XnAxeGF6MHenpmXeLi3B0ci5Qkhwy5IrSAnfmzfDSUk0dDTEhM+4X5oC3UgBcwynmQWJzPm7rPMWeLAVKhLTAy/we7CtzHMaeE3KGSAIJOK/yKFYbm9jhtUhicsb18bAUhDtWHKEDpLyYUJrX4H+C9/PXR79lI8XRFoKSGr4ML2aIQblleoPVSzGDKC6gcsFWpL6n5dQqRIIUM+zTbux9KPlTadhaHSBGYbCr9XuCWLXrRom7BcI/BJB5cFu8bWbiAtD7O8D9/NIcUJq3ITAyeKM6rCPryXBlhZ5jxh4xyJcoGYh5lKYc/esicHD4hghb3jE8vRqIFByicTVMSc1GmX8HMCdERnjQiwnGMyJkCKpYtOZC7VKgnZ5i4eIZHCoDB9eHXDeG6Bd4fVwEWSVynCOGfJdQzjvMIYFKaOcedIYiv2QoiGANMe5xY/oDEnKpSC4BfSb881aA9V2oezjOuGn6gzoNpuwnUbq55rJ5J2JhQEFgMsGM9ji7gYPsoxGG5yjIlhSybmMclLjMHgrRnL2xiSDJNr+0uxlEsYV8ZI4Q6WKlmmciY8LidSGM1/WcORoefTMTqK4SCGFzG8jGG4H8NwFMPwIIbhixiGL2MY7ccwGsUwOohh9MKBNXrpcc1qBLcBGI4cls3vB7skd99xbTmbBKauZfCsI4OHfdjbq7mJ2n766acLcXchAC4iYq6L6BAuonrIRRS7PpKZ1Df037f08Wz0rf+c0+eL0Uv/ObNDhwf+M6PP0fBCLPyGF2JkITGsKO+Bgrq/KgT+yxMRtdlNqS3IM2okQRSHDrqrDjzUsWif5RmdhQtuOMv15uOEEY/oRA1IK4c6oENZct18Itv9iI7Thod6rJh0XVastroCw1soRiunf973L8vmw7ttH83ZW+B82dFf0NFJNJ2RaNp8/lp6PSIkLMP0ZZj4tm8VACuZN+PBD3hEWOhC9GU4eEk4oEdpMwKo9xGdvgUOdfgX3vXtH/SGz3uj/dFBBwNkG7kBRdFL0958Pv8a2COdx29PKk/QUJ1mR1bpRMlijflhrYNmlNeJ7O+gsv8nKerjoMNiSnafNSyCxlJbfG0t28iUzZ9ot1SYWitnNL5RzeYtMG0XwWGt3ySTPPHA05igko3JwOsTDnoWk4M0HbQwSY1p2iuK3lIjffYs4luNRdFP0/7SyJXbcY0FpGkMq81r29MUiqLY0OzaO82Dolg9Rb8oPGxW+fo3YhKvs23mEz/gt2KVhiO6G9/LRuQ5kCK3e1tzbj0fLT02GRe+wxMVLA1QOK1ypvCW7FLNpXCjvz6PBRZrNHtrx1oT0HoJHCrgm2OvvT/15E9H6C5ALdvnrZyMFnkFSaWNLEDhFG+hZMagEnaxG5bzlFlTrmcb8JYVJZkAg79dXKR/+uPAOiDIxjdANwEpn3LyAw3+dv6q99+Xa0ZUZYkqYRohR9pJx4Am6cN5hnnZuKJms1l/9kwnmZS580N91Aon7u8rOf54ZcEt+0yXT9ed1JFGy+An0lm29zWaDsaYhjBzjclvaczy0HDfvrbe3rnnufUjHtGLswQSdTrvCXWfX0QFswoJkTI2v6XJUF1El/UcZ+RjumXu5QOYNeMp5myM+WrXgxmtbs7ZXFaev4NTq3tUT9EtvFFHwUXtt7DH2Y9bnex2qdP1Ldbwt0NImzvDkxPYM9wA5FwHz00Xne3Z3rVlHY4C0fowxwhhArmHg/T4Ui6oAXsYGzhJ5O9uyxY0DuzA2q0YdtuyQ+di2oihNQoueFEVtX90Uq8aUFZ43aONL5pJXvewQ/t2V3Zgt1t2IGfk5g0uxND6MYL/4x7N1I94RLJiCaT72fhzpEjnnf5KD+x2BgzHajPgmmeZhroHuWY+vZn7+nBMzxv5ZN0k8rIlCZaGPHJfypo1yA9+oazPqu2H20x57VGPiPrWgPVPpkA/7mu/Pp9FpO3T/44ItQP2g4nVOSULNr3Hcrfdj4g8PTxLlxvFkSwpjMulOEqjwyixkd8QqoxiuzRq851M59HhXeTDBvTTO+Vp6uCjptjxXaSTDAtGvwJIFG2maG8UW883Kh3FkfUjUeiZ8BUdRnL8ERParVQEjuGoaQ077/AujHLh0ij2XoXoMHJx1CiOvKZfN9WB5jKdRIuw4X1L1S3NUtr+qOO2tA5FJD9zmfc0dbEUbf+sld60VrBnK/BMvpbUZ/ANm+vWuk4RiJaD/DSH+CDxsyBlc02sVWmnsyUsT6qcPBR4W3I1r90l1k3Roo8a3nqnGt7h80Vz6Q1ITCk2j+KIGyza7RuIQMlPv7kEJWHG+qw/de5HiWPEP/sGsuXsxbPik6H4KBHGaC+9zKT45PnD0bPhaPhsOKIVfLDp8/Hoelch6BLGKwqrYRr0+F4TH47Bxmj622g0jLfHZlPcToxnm/IGWuFKnckqTykQiEz1bfj+szNDuvRdP0f9LdS8iKPb7Ye5hUT2QlICfJPjxDgnAiRSCVRP257JR3O40cHBIo7m2483/10e71u6vNn20/1oszmaTJd/BazPXi7iKNsO61/qfJN/IbAHLxbN67qkPFyNZTq/CnJrsW1geCho3ETmKSpSSFblVSNqSMJQntTVspwfS5kjE2sETSfRwGe0kV5IKqF3zc8yJK27URft6o2G6hVIBy0lL+CSP5RrUgRVhRdRH44mLX3XuhKWcx3CWJt3ICQ8sftd6cqK8ScD/004etLO6aI0myYkEUCwg8FgUeY2KWrG85zgpne9D/Ufq/nVmCQAwnMZNt7+VLx2fli7oZ/UzSgCrzv24TUTdVZJN3sD7u5qMrDUsVjA3R3dKqorenQXi7hpoL06DfZddS0KE+Q3nVl1EzYT67bWVKfiXJGK4xp8lK8NAJ8KLqZXlfLrkCa4WPRXCLK5rQdjcAVh/hZpkf9XuCPAjsSxSlE9gJuPJs6Mk/CECPhJ7Dz2FkdcaeN51LGAB90F8jbg22dskPX3tuZ5XY01jRJhvYanjOLTKVI2pR9hJ/v8J2RJ5qSFhYpNiN1thqTCGy4rHcDLmK7V8JRGcMdCXEy7VmgLOzY9rX32/jp2FpQwdXx28gBcWhu556STMzDdKd0acHx2QjmXfOLtvT580DUmAmpZZwiQ/QU3nIW8rFqlmzsvJwqLESdKOwmyfZ/t2INVgFKu10IUO2lObFFnKK8s3CTl0hXJylA2MPepZtpgqTt4tFDUiDyT1UOocgsmGUwrG1Q29FIHcWnjSk3OJBfaqMp5eCGtVEgT9WRBIxPUusFTwAoNaq0fAwrtpjOYMG1QxVAJTphXFXlQ6iXxtkTFUSS4FgUKHeqIh7fLtW4C4ocf3vlU7HCGwJRj4kC3MKZQlZZqLCfUibHh5paPvlZ2eAG2HUB6tG36qnful6i0FEBpp2rKBP/FkbA1RKQmKy5juRvqRQWF5Ake4vAuMEHF+vXv/2jBtdEUXQXM7cDSlKKeWyC0HjRH8OTYV1iSBJRdiGg9VH9e1v0IOss0V4VMa0bSD6fxExsn1bVcNNJm12OOrhRAV0lGTrVa3uo4yFjtrUkd05EonknINrKk8+It16aV2hkSMFblww9IeExaMFjrg7iaaF7M2wxew+VTSJvlrF7Iu2nBtfa7wgusMvJKYcHFw96pthvSyFoQVEYWzPAEwlK63032poz0hq8L+CaARtR4w6V6uoFVabkrKRK84uIKb1A9wK57XweMrCdojGaGKNqwBSS556xJyJ1RDUUHJ63Xyaadt6F8vsUMcHZC4zz0bxnVCkihnSdjtL9P/3QPUNeq+EWJ+khSTKo8n/8hih/uubzfjeKa15sm9/lFso989MttcjM6ibxXrCtKP9Gb81muLZqz7NjaINDvPYo3KCuVUyEMnaVXM5NdtnXHXORc4FW4wKtUJlfh9DSuQK27XqIHwVBft1Wxune9ZXsisUUcHayjolNZoMms7KF1Z0pSfU6ZI2WAGDUHNmVcANlW6isSFSol1f3G7qdBdh8KDvb3r4Y1Ep6vIuFI2LwDW/V1Jq9R/LYnbW9v3PYE6m1hCdU98BF3g2x/1Dlsu90dUmNSKW7m0eH5XXTbYyXvuf7D88vFJZGgySQFP0qpLcTMZNFhNFiJhWhUN9aXfX7n+KZmBc1ESskBK/4VVvLBzTBaxMsz1npjNo7GqvdpE7RhUy6m98+6bHBzSvfnrqiDoUY+lfw/kASUv4D2qDjiRDcZMnoRCeVEFj80kaO34XJDTGddmKa5xOXAS4i7dEIpyy/YmuDI+tjI8HkrKnEeAgw2ZlCHDNZFAeqjB79+7dZveepbjvrzhshrn3hwiQ+tL3l0cGCdrt8OrXfy2Uvr+Dt4sbBk2TjBoqjr6LIhvmV3TRR1nQ9hUm1Q+1mNVejC0R3zxjd11f2wUq1ed3TcZRV3o7q5Qdv0Wy5pVTUg65QZiitxMZGWPD3NHJcoTsngI7FxM1x17WKeyKKuHwrDf/37P+yMQGsWqj9QlPe4UlDKGapJ5eqQJjnectJ4aDwWtq/xHiIrctQ6nwOZV1NbGWvTC8m09MZLwko25jknYUjDpIumteSp7sOPjf/xiXLZljeYkwytdUaqrA3v30yq6wn5MWNgMKaSQrIaUGRMJM5AcQxuFW0qgyXjr1RcU6WkIqi5g00Ko1hioGCCTa2mHHewlGJOvh8NSo7Jftcyr5yFahjPpXJxQ3sgG9K3ofK3tyV1Wbc0mXYKM6KKG2+m6ti5CRzv+lrbMXlkSoKFJ2i19UrkkspiybNT5TmU0jhvC+mrbRhpulFMaFIdfKjS30GNMG9Bova1XR800g2/4+LalXL14Lwmph9xrLnBbqLnMmU/7c75npu/VGMqFJWaG6nmzewpN1k1tjK4vUj94Vb6PlRWt2Rss0YqE73Gjy8TPaCc1MEpGqIQPXh1cmRf76fw6//8L7xDpgRkcuaoNakU5vOmiNsWOdubd2irH1/ro2AVVUobS6RiGtxmhMEoXn4vumyncII2XtytGWcl98ufBzChm1H76cckNYComDnndRBHrORrTV+q9dXHk1NUNzwJau2GGx7YwYMojnKeoNDY0kRefX/yDm7gWX8/iluP8ANue/Du6PXb96dvCRriLIexYX+/v2+Dp1KbgonWVktl+csyrpWdsavi31Xx76r4d1X8uyr+302d+a6Kf1fFv6vi31Xx76r4d1X8/zwk7Kr4d1X8uyr+XRX/rop/V8W/q+LfVfHvqvh3Vfy7Kv5dFf/jkRW7Kv7HUhy9q+L/LShwV8W/q+L/8ip+n2lEOuWgzBkXrdxOl892vlzbfxlHGSW8HZ5Hd3cUy/xA9TnU/HNl02zOL+PohilOHnubKxeHFC/KbbpGSjJ67QIQvTPaP3bcYIPuSymClKHmZryy137v2HZO3snx6VkUR6GgqpApzVFsRv83AZu57CSPTVsuzmydZ87EtLKpVpFbc+Eyt7NuStu1TWnzP1oZW0zMWxB2c93cMehvOtTaCXd3Ll1usajHu66NMzxiw2i6v8vFYvF/0CHs+w==","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),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const 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:"eJztPNlyG0eSv5LTMRGyOA2AgChZy6eRJa2Hs1qRYVLh2CU5dKE7gS6xu6pdVU0QZiBiH+YP9g/m0/wlG1lHHzgI6hgPHQs9SOg6s7Iys/LUXWTYVEeH59EbmVQFCqOjyzhKUSeKl4ZLER1GZxnCa4XMIIRR8OrkCFiey5mGSqPSYCRMUaCiUQJnkIb1YDyHUskbnnIxhZQZBjNuMhgzjS8OAEUiU0xhwnPsX4gLccbLQ/hQ5pKlMJeVgpM3/16vRttQ2/ne3hscV1P4cLS3d/lNZkypDwcDVpZ9WaLQfCpyNtb9RBaDlAaW6eRpDLMMFdKqkDAByDTP58DSFGY8naLRMZgMBSSynEMipUq5YAZ1DCWbIoiqGKPSMTCRQiEVAhfAQCFL5z0je5VG+Ovp8XuYSFUw04eTvNJxvV3KFSYmn7vlTYb1qZ7ogA1tFBfTGAp2TdjiBn6ueHJNx9YoUvqXJr46ObK42ts7rcpSKoMp/OiOcLi3Rz3fYS5nwBTa8YksCimgZIoVaOx1ZczYboU/V1xh6i6F5XnAxeGF6MHenpmXeLi3B0ci5Qkhwy5IrSAnfmzfDSUk0dDTEhM+4X5oC3UgBcwynmQWJzPm7rPMWeLAVKhLTAy/we7CtzHMaeE3KGSAIJOK/yKFYbm9jhtUhicsb18bAUhDtWHKEDpLyYUJrX4H+C9/PXR79lI8XRFoKSGr4ML2aIQblleoPVSzGDKC6gcsFWpL6n5dQqRIIUM+zTbux9KPlTadhaHSBGYbCr9XuCWLXrRom7BcI/BJB5cFu8bWbiAtD7O8D9/NIcUJq3ITAyeKM6rCPryXBlhZ5jxh4xyJcoGYh5lKYc/esicHD4hghb3jE8vRqIFByicTVMSc1GmX8HMCdERnjQiwnGMyJkCKpYtOZC7VKgnZ5i4eIZHCoDB9eHXDeG6Bd4fVwEWSVynCOGfJdQzjvMIYFKaOcedIYiv2QoiGANMe5xY/oDEnKpSC4BfSb881aA9V2oezjOuGn6gzoNpuwnUbq55rJ5J2JhQEFgMsGM9ji7gYPsoxGG5yjIlhSybmMclLjMHgrRnL2xiSDJNr+0uxlEsYV8ZI4Q6WKlmmciY8LidSGM1/WcORoefTMTqK4SCGFzG8jGG4H8NwFMPwIIbhixiGL2MY7ccwGsUwOohh9MKBNXrpcc1qBLcBGI4cls3vB7skd99xbTmbBKauZfCsI4OHfdjbq7mJ2n766acLcXchAC4iYq6L6BAuonrIRRS7PpKZ1Df037f08Wz0rf+c0+eL0Uv/ObNDhwf+M6PP0fBCLPyGF2JkITGsKO+Bgrq/KgT+yxMRtdlNqS3IM2okQRSHDrqrDjzUsWif5RmdhQtuOMv15uOEEY/oRA1IK4c6oENZct18Itv9iI7Thod6rJh0XVastroCw1soRiunf973L8vmw7ttH83ZW+B82dFf0NFJNJ2RaNp8/lp6PSIkLMP0ZZj4tm8VACuZN+PBD3hEWOhC9GU4eEk4oEdpMwKo9xGdvgUOdfgX3vXtH/SGz3uj/dFBBwNkG7kBRdFL0958Pv8a2COdx29PKk/QUJ1mR1bpRMlijflhrYNmlNeJ7O+gsv8nKerjoMNiSnafNSyCxlJbfG0t28iUzZ9ot1SYWitnNL5RzeYtMG0XwWGt3ySTPPHA05igko3JwOsTDnoWk4M0HbQwSY1p2iuK3lIjffYs4luNRdFP0/7SyJXbcY0FpGkMq81r29MUiqLY0OzaO82Dolg9Rb8oPGxW+fo3YhKvs23mEz/gt2KVhiO6G9/LRuQ5kCK3e1tzbj0fLT02GRe+wxMVLA1QOK1ypvCW7FLNpXCjvz6PBRZrNHtrx1oT0HoJHCrgm2OvvT/15E9H6C5ALdvnrZyMFnkFSaWNLEDhFG+hZMagEnaxG5bzlFlTrmcb8JYVJZkAg79dXKR/+uPAOiDIxjdANwEpn3LyAw3+dv6q99+Xa0ZUZYkqYRohR9pJx4Am6cN5hnnZuKJms1l/9kwnmZS580N91Aon7u8rOf54ZcEt+0yXT9ed1JFGy+An0lm29zWaDsaYhjBzjclvaczy0HDfvrbe3rnnufUjHtGLswQSdTrvCXWfX0QFswoJkTI2v6XJUF1El/UcZ+RjumXu5QOYNeMp5myM+WrXgxmtbs7ZXFaev4NTq3tUT9EtvFFHwUXtt7DH2Y9bnex2qdP1Ldbwt0NImzvDkxPYM9wA5FwHz00Xne3Z3rVlHY4C0fowxwhhArmHg/T4Ui6oAXsYGzhJ5O9uyxY0DuzA2q0YdtuyQ+di2oihNQoueFEVtX90Uq8aUFZ43aONL5pJXvewQ/t2V3Zgt1t2IGfk5g0uxND6MYL/4x7N1I94RLJiCaT72fhzpEjnnf5KD+x2BgzHajPgmmeZhroHuWY+vZn7+nBMzxv5ZN0k8rIlCZaGPHJfypo1yA9+oazPqu2H20x57VGPiPrWgPVPpkA/7mu/Pp9FpO3T/44ItQP2g4nVOSULNr3Hcrfdj4g8PTxLlxvFkSwpjMulOEqjwyixkd8QqoxiuzRq851M59HhXeTDBvTTO+Vp6uCjptjxXaSTDAtGvwJIFG2maG8UW883Kh3FkfUjUeiZ8BUdRnL8ERParVQEjuGoaQ077/AujHLh0ij2XoXoMHJx1CiOvKZfN9WB5jKdRIuw4X1L1S3NUtr+qOO2tA5FJD9zmfc0dbEUbf+sld60VrBnK/BMvpbUZ/ANm+vWuk4RiJaD/DSH+CDxsyBlc02sVWmnsyUsT6qcPBR4W3I1r90l1k3Roo8a3nqnGt7h80Vz6Q1ITCk2j+KIGyza7RuIQMlPv7kEJWHG+qw/de5HiWPEP/sGsuXsxbPik6H4KBHGaC+9zKT45PnD0bPhaPhsOKIVfLDp8/Hoelch6BLGKwqrYRr0+F4TH47Bxmj622g0jLfHZlPcToxnm/IGWuFKnckqTykQiEz1bfj+szNDuvRdP0f9LdS8iKPb7Ye5hUT2QlICfJPjxDgnAiRSCVRP257JR3O40cHBIo7m2483/10e71u6vNn20/1oszmaTJd/BazPXi7iKNsO61/qfJN/IbAHLxbN67qkPFyNZTq/CnJrsW1geCho3ETmKSpSSFblVSNqSMJQntTVspwfS5kjE2sETSfRwGe0kV5IKqF3zc8yJK27URft6o2G6hVIBy0lL+CSP5RrUgRVhRdRH44mLX3XuhKWcx3CWJt3ICQ8sftd6cqK8ScD/004etLO6aI0myYkEUCwg8FgUeY2KWrG85zgpne9D/Ufq/nVmCQAwnMZNt7+VLx2fli7oZ/UzSgCrzv24TUTdVZJN3sD7u5qMrDUsVjA3R3dKqorenQXi7hpoL06DfZddS0KE+Q3nVl1EzYT67bWVKfiXJGK4xp8lK8NAJ8KLqZXlfLrkCa4WPRXCLK5rQdjcAVh/hZpkf9XuCPAjsSxSlE9gJuPJs6Mk/CECPhJ7Dz2FkdcaeN51LGAB90F8jbg22dskPX3tuZ5XY01jRJhvYanjOLTKVI2pR9hJ/v8J2RJ5qSFhYpNiN1thqTCGy4rHcDLmK7V8JRGcMdCXEy7VmgLOzY9rX32/jp2FpQwdXx28gBcWhu556STMzDdKd0acHx2QjmXfOLtvT580DUmAmpZZwiQ/QU3nIW8rFqlmzsvJwqLESdKOwmyfZ/t2INVgFKu10IUO2lObFFnKK8s3CTl0hXJylA2MPepZtpgqTt4tFDUiDyT1UOocgsmGUwrG1Q29FIHcWnjSk3OJBfaqMp5eCGtVEgT9WRBIxPUusFTwAoNaq0fAwrtpjOYMG1QxVAJTphXFXlQ6iXxtkTFUSS4FgUKHeqIh7fLtW4C4ocf3vlU7HCGwJRj4kC3MKZQlZZqLCfUibHh5paPvlZ2eAG2HUB6tG36qnful6i0FEBpp2rKBP/FkbA1RKQmKy5juRvqRQWF5Ake4vAuMEHF+vXv/2jBtdEUXQXM7cDSlKKeWyC0HjRH8OTYV1iSBJRdiGg9VH9e1v0IOss0V4VMa0bSD6fxExsn1bVcNNJm12OOrhRAV0lGTrVa3uo4yFjtrUkd05EonknINrKk8+It16aV2hkSMFblww9IeExaMFjrg7iaaF7M2wxew+VTSJvlrF7Iu2nBtfa7wgusMvJKYcHFw96pthvSyFoQVEYWzPAEwlK63032poz0hq8L+CaARtR4w6V6uoFVabkrKRK84uIKb1A9wK57XweMrCdojGaGKNqwBSS556xJyJ1RDUUHJ63Xyaadt6F8vsUMcHZC4zz0bxnVCkihnSdjtL9P/3QPUNeq+EWJ+khSTKo8n/8hih/uubzfjeKa15sm9/lFso989MttcjM6ibxXrCtKP9Gb81muLZqz7NjaINDvPYo3KCuVUyEMnaVXM5NdtnXHXORc4FW4wKtUJlfh9DSuQK27XqIHwVBft1Wxune9ZXsisUUcHayjolNZoMms7KF1Z0pSfU6ZI2WAGDUHNmVcANlW6isSFSol1f3G7qdBdh8KDvb3r4Y1Ep6vIuFI2LwDW/V1Jq9R/LYnbW9v3PYE6m1hCdU98BF3g2x/1Dlsu90dUmNSKW7m0eH5XXTbYyXvuf7D88vFJZGgySQFP0qpLcTMZNFhNFiJhWhUN9aXfX7n+KZmBc1ESskBK/4VVvLBzTBaxMsz1npjNo7GqvdpE7RhUy6m98+6bHBzSvfnrqiDoUY+lfw/kASUv4D2qDjiRDcZMnoRCeVEFj80kaO34XJDTGddmKa5xOXAS4i7dEIpyy/YmuDI+tjI8HkrKnEeAgw2ZlCHDNZFAeqjB79+7dZveepbjvrzhshrn3hwiQ+tL3l0cGCdrt8OrXfy2Uvr+Dt4sbBk2TjBoqjr6LIhvmV3TRR1nQ9hUm1Q+1mNVejC0R3zxjd11f2wUq1ed3TcZRV3o7q5Qdv0Wy5pVTUg65QZiitxMZGWPD3NHJcoTsngI7FxM1x17WKeyKKuHwrDf/37P+yMQGsWqj9QlPe4UlDKGapJ5eqQJjnectJ4aDwWtq/xHiIrctQ6nwOZV1NbGWvTC8m09MZLwko25jknYUjDpIumteSp7sOPjf/xiXLZljeYkwytdUaqrA3v30yq6wn5MWNgMKaSQrIaUGRMJM5AcQxuFW0qgyXjr1RcU6WkIqi5g00Ko1hioGCCTa2mHHewlGJOvh8NSo7Jftcyr5yFahjPpXJxQ3sgG9K3ofK3tyV1Wbc0mXYKM6KKG2+m6ti5CRzv+lrbMXlkSoKFJ2i19UrkkspiybNT5TmU0jhvC+mrbRhpulFMaFIdfKjS30GNMG9Bova1XR800g2/4+LalXL14Lwmph9xrLnBbqLnMmU/7c75npu/VGMqFJWaG6nmzewpN1k1tjK4vUj94Vb6PlRWt2Rss0YqE73Gjy8TPaCc1MEpGqIQPXh1cmRf76fw6//8L7xDpgRkcuaoNakU5vOmiNsWOdubd2irH1/ro2AVVUobS6RiGtxmhMEoXn4vumyncII2XtytGWcl98ufBzChm1H76cckNYComDnndRBHrORrTV+q9dXHk1NUNzwJau2GGx7YwYMojnKeoNDY0kRefX/yDm7gWX8/iluP8ANue/Du6PXb96dvCRriLIexYX+/v2+Dp1KbgonWVktl+csyrpWdsavi31Xx76r4d1X8uyr+302d+a6Kf1fFv6vi31Xx76r4d1X8/zwk7Kr4d1X8uyr+XRX/rop/V8W/q+LfVfHvqvh3Vfy7Kv5dFf/jkRW7Kv7HUhy9q+L/LShwV8W/q+L/8ip+n2lEOuWgzBkXrdxOl892vlzbfxlHGSW8HZ5Hd3cUy/xA9TnU/HNl02zOL+PohilOHnubKxeHFC/KbbpGSjJ67QIQvTPaP3bcYIPuSymClKHmZryy137v2HZO3snx6VkUR6GgqpApzVFsRv83AZu57CSPTVsuzmydZ87EtLKpVpFbc+Eyt7NuStu1TWnzP1oZW0zMWxB2c93cMehvOtTaCXd3Ll1usajHu66NMzxiw2i6v8vFYvF/0CHs+w==",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 Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",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}}, {{note}}.",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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},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,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/a9f09360.8ac14f3d.js b/assets/js/a9f09360.8ac14f3d.js deleted file mode 100644 index a17ed88be..000000000 --- a/assets/js/a9f09360.8ac14f3d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9lyGzmSv4KpmAi3NUVKpGW3V0/jtr09mvVaipYcHbuShg1WJVmwqoBqAEWKrWDEPswf7B/Mp/WXbGQCqIOHJB/To46lH2QWzkQiM5HnbWT51ERHF9EblVQFSGuiqzhKwSRalFYoGR1F5xmwN5pPLAuD2KvTY8bzXM0Nqwxow6xiU5CguQUmYc7SsBwbL1ip1UykQk5Zyi1nc2EzxtmYG3hxyEAmKoWUTUQO/Ut5Kc9FecQ+lLniKVuoSrPTN/9er4cbYdvF3t4bGFdT9uF4b+/qm8za0hzt7/Oy7KsSpBFTmfOx6Seq2E9xYJlOnsZsnoEGXJUlXDLgRuQLxtOUzUU6BWtiZjOQLFHlgiVK6VRIbsHErORTYLIqxqBNzLhMWaE0MCEZZxp4uuhZ1asMsL+enbxnE6ULbvvsNK9MXG+XCg2JzRdueZtBfaonJmDDWC3kNGYFv0Z8Cct+rkRyjcc2IFP8Hye+Oj0mXO3tnVVlqbSFlP3ojnC0t4c930Gu5oxroPGJKgolWck1L8DShWXcUreGnyuhIfXXkucBF0eXssf29uyihKO9PXYsU5EgMmhBbGVq4sf23VBEEg49KyERE+GHtlDHlGTzTCQZ4WTO3X2WOU8cmBpMCYkVM+gufBOzBS78BqQKEGRKi1+UtDyn65iBtiLhefvaEEAcaizXFtFZKiFtaPU7sP/y14O3R5fi6QpBSxFZhZDUY4DNeF6B8VDNY5YhVD9AqcEQsft1EZEyZRmIabZ1P55+rIztLMwqg2C2ofB7hVsi9AKhbcJzA0xMOrgs+DW0dmOKmJjnffbdgqUw4VVuYyaQ4qyuoM/eK8t4WeYi4eMckHIZMg+3lYYe3bInBw+I5AXd8SnxNBjGWSomE9DInNhJS/g5ATqks0YIEOfYjEum5MpFJypXep2EqLmLR5YoaUHaPns14yIn4N1hDRMyyasU2DjnyXXMxnkFMdOQOsZdAAqu2NE7DWHceJwTfpiBHKlQSYRfKr+9MMx4qNI+O8+EafgJOwOqaRNh2lj1XDtRuDOiILAYg4KLPCbExeyjGjMrbA4xMmzJ5SJGiQkxs3Bjx+omZkkGyTX90jwVio0ra5V0B0u1KlM1lx6XEyWtEb9s4MjQ8+kYHcbsMGYvYvYyZoODmA2GMRscxmzwImaDlzEbHsRsOIzZ8DBmwxcOrOHLOIj8gOA2AIOhw7L9/WAX5e47YYizUWCaWgbPOzJ40Gd7ezU3YdtPP/10KW8vJWOXETLXZXTELqN6yGUUuz6Umdg38N83+PFs+K3/XODni+FL/zmnoYND/5nh53BwKZd+w0s5JEgsL8o7oMDurwqB//JEhG20KbYFeYaNKIji0IF31YEHO5btszzDswgprOC52X6cMOIRnagBae1Qh3goItftJ6LuR3ScNjzYQ2LSdZFYbXUFhicohmunf973L8v2w7ttH83ZW+B82dFf4NFRNJ2jaNp+/lp6PSIkrML0ZZj4tk8KAEnm7XjwAx4RFroQfRkOXiIO8FHajgDsfUSnb4GDHf6Fd30Hh73B897wYHjYwQDaRm5AUfTStLdYLL4G9lDn8dujyhM0VKfZoV060arYYH6QddCM8joR/Q4q+3+ioj4OOiykaPeRYRE0ltria2vZVqV88cS4pcLUWjnD8Y1qtmiBSV0IB1m/SaZE4oHHMUElG6OB10cc9AiT+2m638IkNqZpryh6K4342SPEtxqLop+m/ZWRa7fjGguWpjFbb97YnqasKIotza79MiKV6t+Q9L0mtp36/YDfigEaOu9ufCdzoD9AyZz2JiNtM3esPCGZkL7DkwpbGaBhWuVcww1am0Yo6UZ/fc4JjNPo62SdkmFHtr9DBfvmxOvkTz1R4xG6C2DL/fPWToaLvGJJZawqmIYp3LCSWwta0mIznouUk4HWowa44UWJiv3+3y4v0z/9cZ/cCmi5W4Y3wVIxFejd2f/bxavef19tGFGVJeiEG2A54E4mZmCTPrvIIC8bB9N8Pu/Pn5kkUyp33qWPRsPE/R2p8ccRgVv2uSmfbjqpI42WGY+ks2rFG7AdjHHDwswNhjzRGPHQ4IDeUG/F3PGI+hGP6B1ZAQk7nU8Euy8uo4KTmoGkDM1vZTPQl9FVPceZ7pDeM/fqAcyaiRRyPoZ8vevBjNY+iyfZFmKwoxCydjcQvAdxq5PfrHS6vuUGBnYnbrNfeCkC/wUUs1yY4HDp4qs923ukyE8oAcj1OAYWJqBfN4iHLyXzGrCH0bkTNf5y7tkCxzEaWHsDw2737NC5mDZicI1CSFFURe3WnNSrBpQVXmVo4wtnors87NC+3bUd+M09O6APcfsGl3JA7ofgtrhDofQjHpEwWAHpbj79HDHReYi/0gt6PwOGY7UZcMO7i0Pdi1szn9nOfX12gu8XulLdJHSOJQmUFh1pX8qaNcgPfoLI1eTcZ9+R+2w75bWdbI+I+jaA9U+mQD/ut6HC9vF+R5TYAfvB1OichQWf3mFRU/cjoj8Pz8rlRnGkSgywCiWP0+goSjEkGyKIUUwrg7HfqXQRHd1G3puPP72vHGfufzQY072NTJJBwfFXgAijwBiEjeKInDoYCEYkRUeRGn+EBPcoNcJgBRicSaOPbsMoF7uMYm/iR0eRC2pGceQV9LqpjvqW6SRahg3vWqpuaZYy9KMOouI6GB78zGXe49TlSuz7s1Z601qBzlbAuXqtsM/CG74wrXXd8x6thtxxDhJ/4mexlC8M8lNlnCaW8DypcnQXwE0p9KL2XZDPoEUVNbz1TjW8g+fLmGIPoNsgca35IoojYaFot28hAq0+/eYSUIgZciB/6tyPCsYAf/YNaILRxfPik6H4qICNgS69zJT85PmD4bPBcPBsMMQVfOTn8/Hoetch6BLGK4xxQRq0814TrI0ZBUz699FoGE/H5lO4nxjPtwXxW7FDk6kqTzEqB1z3KZb+2WkaXfqu36D+PdS8jKOb+w9zwxLVCxkC7JscJtbZ/ixRWoJ+2nYTPprDDQ8Pl3G0uP94i9/l8b7Fy5vff7ofKbWiSTv5V8D67OUyjrL7Yf1LnfzxLwT28MWyeV2jRAO3EB6H0Vili1GQW8v7BoaHAsdNVJ6CRi1kXV41ogYlDCYtjVbl/FipHLjcIGg6UX+fYIbKIOqB3k8+zwB16UZHpNUbtdRrjQ5azCSAFTemMKj96Qouoz47nrSUXHIQrCYehLGUBCAVe0L7jUxFYvzJvv9GHD1pJ1hhzksTHwgg0GBmoShzylCaizxHuPFd77P6H6l7NSYRgPBcho3vfypeO/cpbegnddN7mNcY++w1l3WKRzeVgt3e1mRA1LFcsttbvFXQI3x0l8u4acC9Og30rroWDQmIWWdW3QTNxLqtNdWpOCNUcVyDD7m1ARBTKeR0VGm/DmqCy2V/jSCb23owBtcQ5m8RF/l/hTsE7Fie6BT0A7j5eOJsN8WeIAE/iZ2jnXAktLGeRx0LeNBdVG0Lvn36BJp8b2ueN9XY4CgZ1mt4ymoxnQKmNvoRNNknIwFPMictCCo+QXandEUNM6EqE8DLuKnV8BRHCMdCQk67pmcLO5Qr1j57fxM7S8xeOjk/fQAuyTDuOenkrEp3SrcGOzk/xQRIMfFWXp99MDUmAmp5ZwhD+4vNBA9JUrVKt3C+S5CEESdKO9mqfZ962GPrAKXCbIQodtIc2aJOGF5buMmQxStSlcXUXOHzvoyF0nTwSFDUiDxX1UOo8h5McjatKMJr8aUO4pLCQU0Co5DG6sr5bVla6ZCz6ckCRyZgTIOngBUc1Fo/ZiCNm87ZhBsLOmaVFIh5XaHbpF4SbkrQAmQCG1GgwaEOefh+udbNBvzwwzufFx3OEJhyjBzoFoaUVSVRDXFCnaUabm716Btlhxdg9wOIjzblknqXfQnaKMkwB1RPuRS/OBImQ0QZtOIynruhXlRgfBzhQQ7vAhNUrF///o8WXFtN0XXA3A48TTFYeQ+E5DZzBI/ueg0lSkDVhQjXA/3nVd0PoSOmGRUqrRnJPJzGTym8aWq5aBWlukMOLjPfVEmGnrRa3po4yFjjrUkT45EwDInItqrE88KNMLaVZxmyIdblww+AeExaMJD1gVyNNC8XbQav4fL5nM1ypBeKbo5urf2u8QKvrBppKIR82DvV9j1aVQuCyqqCW5GwsJTpdzOvMT284euCfRNAQ2qcCaWfbmFVXG6kZAIjIUcwA/0Au+59HQYiT9AY7BxAtmELSHLPWZMdO8eChg5OWq8T5YC3oXzeNgM6HkanM5GZ0HgM/VOGeftKGufIGB4c4H9d+OvKEW9aIPGhoJhUeb74QxQ/3F15txelhlZsNE7u8oxkH8Xwl5tkNjxFztsiSO9cwBtylc6xGgQlS68mYmLoFm6FzIWEEaF4lKpkpMGMhgcHowHieBlHh5vQeKYKsBnxHiJzrhUWi5Q5YOKC1QvGp1xIhraF/opYBa2VvtvY+zTINmAi0NDosIOE5+tIOJYUTacipHN1DfK3PWl7e+u2R1BvCiIY98BFwg2i/qhz2Ha7O6SBpNLCLqKji9vopsdL0XP9RxdXy6s4QsQq9PiXyhDE3GbRUbS/GgAwoGfkyr24deRbU6ThMsWI95p7gZdifzaIlvHqjI3OiK2joep92gRj+VTI6d2zrhrUnOH1uRvqIKhxtpbiPwC9rR7/7VFxJJBsMuD4ICDGkSp+aMIlb8PdhpDGpihFc4ercYcQduhEElYF+IbYwObQwOB5yyl/Efzr5DKvPeabnOD10YNbu/ZqtxzVLT/1RUPjtUs4eIQH5EodHh6Sz/HbATnnnr0kv9fhiyVRZeMDiqKun4fCWqveiijq2t5hUm1P+lmNUeRirB3t3jd1td2wUq1ddlS8VQ1vq7a1RdnyW64oFTUgm95yDKsIOVFEnp5mTkqQZ2jvoNSYDdY9m5AnqqhrWcLwX//+D5oRaI2g+gNGNk8qzUo1Bz2pXE3MJIcbgQ8+joeC+hrnGfAiB2PyBUPrYkp1mpQUh5aV190TXvKxyAXKQhymXDCpJU5Nn/3YuN+eaJcjOIMcRWitMmGdZ3ju50pfT9CNF2PFJ5a3odIMMuMycfq5Y3DSM7EkE22fUguDVXsaoRYONiWt5ollBZd8Sopi3MFSCjm6PgzTaozmq1F55Qw0y0WutAub0YEojE3h4bc3JXaRVxYtGw0ZUsXMW2kmdlay411f9zlGh0SJsIgESFmtZK6wRBMdG1Wes1JZ52xAda0NI063mkuDWoSP1Pk7qBHmDSgwvs7ogwG84XdCXruyoh67qInpRxgbYaGbnrhK2U+7c74X9i/VGIsWlRFW6UUzeypsVo1JBrcXqT/cSt+HOt+WjG3WSFViNrixVWL2MZNy/wwsUojZf3V6TI/3U/br//wvewdcS5apuaPWpNKQL5qSYiq4pZt3aKvfXjLReYVVu5aIVE6D1wgxGMWr70WX7TRMgMKl3QpmXgq//EUAk3XzQD/9mKgFIBVz57sN4oiXYqPlh3Wn5mRyBnomkqBdbrnhfRq8H8VRLhKQBlqKyKvvT9+xGXvWP4ji1iP8gNvef3f8+u37s7cIDXKWw9igf9A/oNihMrbgsrVVt0Z8VcS1MhJ2FeW7ivJdRfmuonxXUf77qXneVZTvKsp3FeW7ivJdRfmuovyfh4RdRfmuonxXUb6rKN9VlO8qyncV5buK8l1F+a6ifFdRvqso31WU7yrKdxXlu4ryXUX5160o9xlAqBXulzkXspX66NLMLlbqzK/iKMM0tKOL6PYWQ4wfsGoEm3+uKPvl4iqOZlwLdKRTBlscMq8w5egaMPfntYsL9M5x+9hRO8XCVxL3MHHMzXhFt37n2Ham3OnJ2XkUR6HMp1ApztF8jnXyfO6ShjwyqYiZU/VhzuW0ogyoyK25dPnEWTfT7JoyzfyPViIVl4sWhN0UNHcM/IuH2jjh9tZlsS2X9XjXtXWGR2wYjdd3tVwu/w+vF00v","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"}}');var o=t(74848),s=t(28453),r=t(33617),a=t.n(r),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const f={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9lyGzmSv4KpmAi3NUVKpGW3V0/jtr09mvVaipYcHbuShg1WJVmwqoBqAEWKrWDEPswf7B/Mp/WXbGQCqIOHJB/To46lH2QWzkQiM5HnbWT51ERHF9EblVQFSGuiqzhKwSRalFYoGR1F5xmwN5pPLAuD2KvTY8bzXM0Nqwxow6xiU5CguQUmYc7SsBwbL1ip1UykQk5Zyi1nc2EzxtmYG3hxyEAmKoWUTUQO/Ut5Kc9FecQ+lLniKVuoSrPTN/9er4cbYdvF3t4bGFdT9uF4b+/qm8za0hzt7/Oy7KsSpBFTmfOx6Seq2E9xYJlOnsZsnoEGXJUlXDLgRuQLxtOUzUU6BWtiZjOQLFHlgiVK6VRIbsHErORTYLIqxqBNzLhMWaE0MCEZZxp4uuhZ1asMsL+enbxnE6ULbvvsNK9MXG+XCg2JzRdueZtBfaonJmDDWC3kNGYFv0Z8Cct+rkRyjcc2IFP8Hye+Oj0mXO3tnVVlqbSFlP3ojnC0t4c930Gu5oxroPGJKgolWck1L8DShWXcUreGnyuhIfXXkucBF0eXssf29uyihKO9PXYsU5EgMmhBbGVq4sf23VBEEg49KyERE+GHtlDHlGTzTCQZ4WTO3X2WOU8cmBpMCYkVM+gufBOzBS78BqQKEGRKi1+UtDyn65iBtiLhefvaEEAcaizXFtFZKiFtaPU7sP/y14O3R5fi6QpBSxFZhZDUY4DNeF6B8VDNY5YhVD9AqcEQsft1EZEyZRmIabZ1P55+rIztLMwqg2C2ofB7hVsi9AKhbcJzA0xMOrgs+DW0dmOKmJjnffbdgqUw4VVuYyaQ4qyuoM/eK8t4WeYi4eMckHIZMg+3lYYe3bInBw+I5AXd8SnxNBjGWSomE9DInNhJS/g5ATqks0YIEOfYjEum5MpFJypXep2EqLmLR5YoaUHaPns14yIn4N1hDRMyyasU2DjnyXXMxnkFMdOQOsZdAAqu2NE7DWHceJwTfpiBHKlQSYRfKr+9MMx4qNI+O8+EafgJOwOqaRNh2lj1XDtRuDOiILAYg4KLPCbExeyjGjMrbA4xMmzJ5SJGiQkxs3Bjx+omZkkGyTX90jwVio0ra5V0B0u1KlM1lx6XEyWtEb9s4MjQ8+kYHcbsMGYvYvYyZoODmA2GMRscxmzwImaDlzEbHsRsOIzZ8DBmwxcOrOHLOIj8gOA2AIOhw7L9/WAX5e47YYizUWCaWgbPOzJ40Gd7ezU3YdtPP/10KW8vJWOXETLXZXTELqN6yGUUuz6Umdg38N83+PFs+K3/XODni+FL/zmnoYND/5nh53BwKZd+w0s5JEgsL8o7oMDurwqB//JEhG20KbYFeYaNKIji0IF31YEHO5btszzDswgprOC52X6cMOIRnagBae1Qh3goItftJ6LuR3ScNjzYQ2LSdZFYbXUFhicohmunf973L8v2w7ttH83ZW+B82dFf4NFRNJ2jaNp+/lp6PSIkrML0ZZj4tk8KAEnm7XjwAx4RFroQfRkOXiIO8FHajgDsfUSnb4GDHf6Fd30Hh73B897wYHjYwQDaRm5AUfTStLdYLL4G9lDn8dujyhM0VKfZoV060arYYH6QddCM8joR/Q4q+3+ioj4OOiykaPeRYRE0ltria2vZVqV88cS4pcLUWjnD8Y1qtmiBSV0IB1m/SaZE4oHHMUElG6OB10cc9AiT+2m638IkNqZpryh6K4342SPEtxqLop+m/ZWRa7fjGguWpjFbb97YnqasKIotza79MiKV6t+Q9L0mtp36/YDfigEaOu9ufCdzoD9AyZz2JiNtM3esPCGZkL7DkwpbGaBhWuVcww1am0Yo6UZ/fc4JjNPo62SdkmFHtr9DBfvmxOvkTz1R4xG6C2DL/fPWToaLvGJJZawqmIYp3LCSWwta0mIznouUk4HWowa44UWJiv3+3y4v0z/9cZ/cCmi5W4Y3wVIxFejd2f/bxavef19tGFGVJeiEG2A54E4mZmCTPrvIIC8bB9N8Pu/Pn5kkUyp33qWPRsPE/R2p8ccRgVv2uSmfbjqpI42WGY+ks2rFG7AdjHHDwswNhjzRGPHQ4IDeUG/F3PGI+hGP6B1ZAQk7nU8Euy8uo4KTmoGkDM1vZTPQl9FVPceZ7pDeM/fqAcyaiRRyPoZ8vevBjNY+iyfZFmKwoxCydjcQvAdxq5PfrHS6vuUGBnYnbrNfeCkC/wUUs1yY4HDp4qs923ukyE8oAcj1OAYWJqBfN4iHLyXzGrCH0bkTNf5y7tkCxzEaWHsDw2737NC5mDZicI1CSFFURe3WnNSrBpQVXmVo4wtnors87NC+3bUd+M09O6APcfsGl3JA7ofgtrhDofQjHpEwWAHpbj79HDHReYi/0gt6PwOGY7UZcMO7i0Pdi1szn9nOfX12gu8XulLdJHSOJQmUFh1pX8qaNcgPfoLI1eTcZ9+R+2w75bWdbI+I+jaA9U+mQD/ut6HC9vF+R5TYAfvB1OichQWf3mFRU/cjoj8Pz8rlRnGkSgywCiWP0+goSjEkGyKIUUwrg7HfqXQRHd1G3puPP72vHGfufzQY072NTJJBwfFXgAijwBiEjeKInDoYCEYkRUeRGn+EBPcoNcJgBRicSaOPbsMoF7uMYm/iR0eRC2pGceQV9LqpjvqW6SRahg3vWqpuaZYy9KMOouI6GB78zGXe49TlSuz7s1Z601qBzlbAuXqtsM/CG74wrXXd8x6thtxxDhJ/4mexlC8M8lNlnCaW8DypcnQXwE0p9KL2XZDPoEUVNbz1TjW8g+fLmGIPoNsgca35IoojYaFot28hAq0+/eYSUIgZciB/6tyPCsYAf/YNaILRxfPik6H4qICNgS69zJT85PmD4bPBcPBsMMQVfOTn8/Hoetch6BLGK4xxQRq0814TrI0ZBUz699FoGE/H5lO4nxjPtwXxW7FDk6kqTzEqB1z3KZb+2WkaXfqu36D+PdS8jKOb+w9zwxLVCxkC7JscJtbZ/ixRWoJ+2nYTPprDDQ8Pl3G0uP94i9/l8b7Fy5vff7ofKbWiSTv5V8D67OUyjrL7Yf1LnfzxLwT28MWyeV2jRAO3EB6H0Vili1GQW8v7BoaHAsdNVJ6CRi1kXV41ogYlDCYtjVbl/FipHLjcIGg6UX+fYIbKIOqB3k8+zwB16UZHpNUbtdRrjQ5azCSAFTemMKj96Qouoz47nrSUXHIQrCYehLGUBCAVe0L7jUxFYvzJvv9GHD1pJ1hhzksTHwgg0GBmoShzylCaizxHuPFd77P6H6l7NSYRgPBcho3vfypeO/cpbegnddN7mNcY++w1l3WKRzeVgt3e1mRA1LFcsttbvFXQI3x0l8u4acC9Og30rroWDQmIWWdW3QTNxLqtNdWpOCNUcVyDD7m1ARBTKeR0VGm/DmqCy2V/jSCb23owBtcQ5m8RF/l/hTsE7Fie6BT0A7j5eOJsN8WeIAE/iZ2jnXAktLGeRx0LeNBdVG0Lvn36BJp8b2ueN9XY4CgZ1mt4ymoxnQKmNvoRNNknIwFPMictCCo+QXandEUNM6EqE8DLuKnV8BRHCMdCQk67pmcLO5Qr1j57fxM7S8xeOjk/fQAuyTDuOenkrEp3SrcGOzk/xQRIMfFWXp99MDUmAmp5ZwhD+4vNBA9JUrVKt3C+S5CEESdKO9mqfZ962GPrAKXCbIQodtIc2aJOGF5buMmQxStSlcXUXOHzvoyF0nTwSFDUiDxX1UOo8h5McjatKMJr8aUO4pLCQU0Co5DG6sr5bVla6ZCz6ckCRyZgTIOngBUc1Fo/ZiCNm87ZhBsLOmaVFIh5XaHbpF4SbkrQAmQCG1GgwaEOefh+udbNBvzwwzufFx3OEJhyjBzoFoaUVSVRDXFCnaUabm716Btlhxdg9wOIjzblknqXfQnaKMkwB1RPuRS/OBImQ0QZtOIynruhXlRgfBzhQQ7vAhNUrF///o8WXFtN0XXA3A48TTFYeQ+E5DZzBI/ueg0lSkDVhQjXA/3nVd0PoSOmGRUqrRnJPJzGTym8aWq5aBWlukMOLjPfVEmGnrRa3po4yFjjrUkT45EwDInItqrE88KNMLaVZxmyIdblww+AeExaMJD1gVyNNC8XbQav4fL5nM1ypBeKbo5urf2u8QKvrBppKIR82DvV9j1aVQuCyqqCW5GwsJTpdzOvMT284euCfRNAQ2qcCaWfbmFVXG6kZAIjIUcwA/0Au+59HQYiT9AY7BxAtmELSHLPWZMdO8eChg5OWq8T5YC3oXzeNgM6HkanM5GZ0HgM/VOGeftKGufIGB4c4H9d+OvKEW9aIPGhoJhUeb74QxQ/3F15txelhlZsNE7u8oxkH8Xwl5tkNjxFztsiSO9cwBtylc6xGgQlS68mYmLoFm6FzIWEEaF4lKpkpMGMhgcHowHieBlHh5vQeKYKsBnxHiJzrhUWi5Q5YOKC1QvGp1xIhraF/opYBa2VvtvY+zTINmAi0NDosIOE5+tIOJYUTacipHN1DfK3PWl7e+u2R1BvCiIY98BFwg2i/qhz2Ha7O6SBpNLCLqKji9vopsdL0XP9RxdXy6s4QsQq9PiXyhDE3GbRUbS/GgAwoGfkyr24deRbU6ThMsWI95p7gZdifzaIlvHqjI3OiK2joep92gRj+VTI6d2zrhrUnOH1uRvqIKhxtpbiPwC9rR7/7VFxJJBsMuD4ICDGkSp+aMIlb8PdhpDGpihFc4ercYcQduhEElYF+IbYwObQwOB5yyl/Efzr5DKvPeabnOD10YNbu/ZqtxzVLT/1RUPjtUs4eIQH5EodHh6Sz/HbATnnnr0kv9fhiyVRZeMDiqKun4fCWqveiijq2t5hUm1P+lmNUeRirB3t3jd1td2wUq1ddlS8VQ1vq7a1RdnyW64oFTUgm95yDKsIOVFEnp5mTkqQZ2jvoNSYDdY9m5AnqqhrWcLwX//+D5oRaI2g+gNGNk8qzUo1Bz2pXE3MJIcbgQ8+joeC+hrnGfAiB2PyBUPrYkp1mpQUh5aV190TXvKxyAXKQhymXDCpJU5Nn/3YuN+eaJcjOIMcRWitMmGdZ3ju50pfT9CNF2PFJ5a3odIMMuMycfq5Y3DSM7EkE22fUguDVXsaoRYONiWt5ollBZd8Sopi3MFSCjm6PgzTaozmq1F55Qw0y0WutAub0YEojE3h4bc3JXaRVxYtGw0ZUsXMW2kmdlay411f9zlGh0SJsIgESFmtZK6wRBMdG1Wes1JZ52xAda0NI063mkuDWoSP1Pk7qBHmDSgwvs7ogwG84XdCXruyoh67qInpRxgbYaGbnrhK2U+7c74X9i/VGIsWlRFW6UUzeypsVo1JBrcXqT/cSt+HOt+WjG3WSFViNrixVWL2MZNy/wwsUojZf3V6TI/3U/br//wvewdcS5apuaPWpNKQL5qSYiq4pZt3aKvfXjLReYVVu5aIVE6D1wgxGMWr70WX7TRMgMKl3QpmXgq//EUAk3XzQD/9mKgFIBVz57sN4oiXYqPlh3Wn5mRyBnomkqBdbrnhfRq8H8VRLhKQBlqKyKvvT9+xGXvWP4ji1iP8gNvef3f8+u37s7cIDXKWw9igf9A/oNihMrbgsrVVt0Z8VcS1MhJ2FeW7ivJdRfmuonxXUf77qXneVZTvKsp3FeW7ivJdRfmuovyfh4RdRfmuonxXUb6rKN9VlO8qyncV5buK8l1F+a6ifFdRvqso31WU7yrKdxXlu4ryXUX5160o9xlAqBXulzkXspX66NLMLlbqzK/iKMM0tKOL6PYWQ4wfsGoEm3+uKPvl4iqOZlwLdKRTBlscMq8w5egaMPfntYsL9M5x+9hRO8XCVxL3MHHMzXhFt37n2Ham3OnJ2XkUR6HMp1ApztF8jnXyfO6ShjwyqYiZU/VhzuW0ogyoyK25dPnEWTfT7JoyzfyPViIVl4sWhN0UNHcM/IuH2jjh9tZlsS2X9XjXtXWGR2wYjdd3tVwu/w+vF00v",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={},y=[];function j(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:"Draft Document"}),"\n",(0,o.jsx)(a(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,o.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a 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:'"mm/dd/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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,o.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",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}}, {{note}}.",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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"draftdocument_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:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.afadc0af.js b/assets/js/a9f09360.afadc0af.js new file mode 100644 index 000000000..2db777c28 --- /dev/null +++ b/assets/js/a9f09360.afadc0af.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9lyG0eSv5LTMRGyOA2AgChZy6eRJa2Hs1qRYVLh2CU5cKE7gS6xu6pdVU0QZiBiH+YP9g/m0/wlG1lHHzhI6hgPHQs9UOg6s7Iys/K8jQyb6ejwPHojk6pAYXR0GUcp6kTx0nAposPoLEN4o9jUQBgEr06OgOW5nGuoNCoNRsIMBSpmEATOIQ3LwWQBpZLXPOViBikzDObcZMBgwjS+OAAUiUwxhSnPsX8hLsQZLw/hQ5lLlsJCVgpO3vx7vR5tRG3ne3tvcFLN4MPR3t7lN5kxpT4cDFhZ9mWJQvOZyNlE9xNZDFIaWKbTpzHMM1RIq0LCBCDTPF8AS1OY83SGRsdgMhSQyHIBiZQq5YIZ1DGUbIYgqmKCSsfARAqFVAhcAAOFLF30jOxVGuGvp8fvYSpVwUwfTvJKx/V2KVeYmHzhljcZ1qd6ogM2tFFczGIo2BXhixv4ueLJFR1bo0jpf5r46uTI4mpv77QqS6kMpvCjO8Lh3h71fIe5nANTaMcnsiikgJIpVqCxF5YxY7sV/lxxham/ljwPuDi8ED3Y2zOLEg/39uBIpDwhZNgFqRXk1I/tu6GEJBp6WmLCp9wPbaEOpIB5xpPM4mTO3H2WOUscmAp1iYnh19hd+CaGBS38BoUMEGRS8V+kMCy313GNyvCE5e1rIwBpqDZMGUJnKbkwodXvAP/lr4duz16KpysCLSVkFVzYHo1wzfIKtYdqHkNGUP2ApUJtid2vS4gUKWTIZ9nW/Vj6sdKmszBUmsBsQ+H3Crdk0YsWbVOWawQ+7eCyYFfY2g2kZWKW9+G7BaQ4ZVVuYuBEcUZV2If30gAry5wnbJIjUS4Q8zBTKezZW/bk4AERrLB3fGJ5GjUwSPl0ioqYkzrtEn5OgI7orBEClnNMxgRIsXLRicylWich29zFIyRSGBSmD6+uGc8t8O6wGrhI8ipFmOQsuYphklcYg8LUMe4CSXDFjt7tEGDa49ziBzTmRIVSEPxC+u25Bu2hSvtwlnHd8BN1BlTbTbhuY9Vz7VTSzoSCwGKABeN5bBEXw0c5AcNNjjExbMnEIiaJiTEYvDETeRNDkmFyZX8plnIJk8oYKdzBUiXLVM6Fx+VUCqP5Lxs4MvR8OkZHMRzE8CKGlzEM92MYjmIYHsQwfBHD8GUMo/0YRqMYRgcxjF44sEYv4yDyA4LbAAxHDsvm94NdkrvvuLacTQJT1zJ43pHBwz7s7dXcRG0//fTThbi9EAAXETHXRXQIF1E95CKKXR/JTOob+u8b+ng2+tZ/Lujzxeil/5zbocMD/5nR52h4IZZ+wwsxspAYVpR3QEHdXxUC/+WJiNrsptQW5Bk1kiCKQwfdVQce6li2z/KMzsIFN5zlevtxwohHdKIGpLVDHdChLLluP5HtfkTHacNDPVZMui4rVltdgeEtFKO10z/v+5dl++Hdto/m7C1wvuzoL+joJJrOSDRtP38tvR4RElZh+jJMfNu3CoCVzNvx4Ac8Iix0IfoyHLwkHNCjtB0B1PuITt8Chzr8C+/69g96w+e90f7ooIMBso3cgKLopWlvsVh8DeyRzuO3J5UnaKhOsyO7dKpkscH8sNZBM8rrRPZ3UNn/kxT1SdBhMSW7zxoWQWOpLb62lm1kyhZPtFsqTK2VMxrfqGaLFpi2i+Cw1m+SSZ544GlMUMkmZOD1CQc9i8lBmg5amKTGNO0VRW+lkT57FvGtxqLop2l/ZeTa7bjGAtI0hvXmje1pCkVRbGl27Z3mQVGsn6JfFB42q3z9GzGJ19m284kf8FuxSsMR3Y3vZCPyHEiR272tObeZj1Yem4wL3+GJClYGKJxVOVN4Q3ap5lK40V+fxwKLNZq9tWOtCWi9BA4V8M2x196fevKnI3QXoJb7562djBZ5BUmljSxA4QxvoGTGoBJ2sWuW85RZU65nG/CGFSWZAIO/XVykf/rjwDogyMY3QDcBKZ9x8gMN/nb+qvfflxtGVGWJKmEaIUfaSceAJunDeYZ52bii5vN5f/5MJ5mUufNDfdQKp+7vWE4+ji24ZZ/p8ummkzrSaBn8RDqr9r5G08EY0xBmbjD5LY1ZHhru29fW2zt3PLd+xCN6cVZAok7nPaHu84uoYFYhIVLG5rc0GaqL6LKe44x8TO+Ze/kAZs14ijmbYL7e9WBGq5tztpCV5+/g1Ooe1VN0C2/UUXBR+y3scfbjVie7Wel0fcsN/O0Q0ubO8OQE9gw3ADnXwXPTRWd7tndtWYejQLQ+zAlCmEAO4iA9vpQLasAexgZOEvm7u2cLGgd2YO1WDLvds0PnYtqIoTUKLnhRFbV/dFqvGlBWeN2jjS+aSX73sEP7dtd2YDf37EDOyO0bXIih9WME/8cdmqkf8YhkxQpId7Px50iRzjv9lR7Y+xkwHKvNgBueZRrqHuSa+fR27uvDMT1v5JN1k8jLliRYGvLIfSlr1iA/+IWyPivnh/vO+uG2U17bW/eIqG8DWP9kCvTjvvbr81lE2j7974hQO2A/mFidU7Jgszssd9v9iMjTw7NyuVEcyZICuVyKozQ6jFIK/YZIZRTblVGb72S6iA5vIx81oJ/eJ08zBx81xY5vI51kWDD6FSCiaDMFe6M4ss4jCjgTkqLDSE4+YkJ7lIpgMBw1zbSjD2/DKBcjjWLvSogOIxc8jeLIq/d1Ux1dLtNptAwb3rVU3dIspe2POlhL61AY8jOXeU9Tlysx9s9a6U1rBXu2As/ka0l9Bt+whW6t617/aDW0T3OI+BM/C1K20MRPlXaKWsLypMrJLYE3JVeL2kdifRMtqqjhrXeq4R0+X8Y2xoGqDRJTii2iOOIGi3b7FiJQ8tNvLkFJmLGO6k+d+1HiBPHPvoEMOHvxrPhkKD5KhAnaSy8zKT55/nD0bDgaPhuOaAUfYfp8PLredQi6hPGKYmmYBuW91wSFY7CBmf59NBrG22OzGd5PjGfbkgVaMUqdySpPKfqHTPVtzP6z00G69F2/Qf17qHkZRzf3H+YGEtkLmQjwTY5T4zwHkEglUD1tuyMfzeFGBwfLOFrcf7zF7/J439Llze8/3Y82haNJb/lXwPrs5TKOsvth/UudZPIvBPbgxbJ5XaNEITMYHofxRKaLcZBby/sGhoeCxk1lnqIiLWRdXjWihiQMJUeNV+X8RMocmdggaDrZBT6RjZRB0gO9P36eIanajY5oV2/UUq81OmgpYwFXnKBck/anKryI+nA0bSm51n+wmuAQxtpkAyHhid1vrCsrxp8M/Dfh6Ek7kYtya5o4RADBDgaDRZnbTKg5z3OCm971PtT/rLpXY5IACM9l2Pj+p+K1c77aDf2kbhoReI2xD6+ZqFNJuikbcHtbk4GljuUSbm/pVlGN6dFdLuOmgfbqNNh31bUoTJBfd2bVTdhMrNtaU52KMyYVxzX40F4bAD4TXMzGlfLrkCa4XPbXCLK5rQdjcA1h/hZpkf9XuCPAjsSxSlE9gJuPps52k/CECPhJ7Nz0FkdcaeN51LGAB91F77bg26dpkMn3tuZ5XU00jRJhvYanjOKzGVIKpR9hJ/ukJ2RJ5qSFhYpNid1tWqTCay4rHcDLmK7V8JRGcMdCXMy6pmcLOzYnrX32/iZ2FpQldXx28gBcWsO456STsyrdKd0acHx2QomWfOqtvD580DUmAmpZZwiQ/QXXnIVkrFqlWzjXJgqLESdKO1mxfZ/i2IN1gFKuN0IUO2lObFEnJq8t3GTi0hXJylAKMPf5ZdpgqTt4tFDUiDyT1UOo8h5MMphVNpJs6KUO4tIGk5pESS60UZVz60JaqZAb6smCRiaodYOngBUa1Fo/BhTaTWcwZdqgiqESnDCvKnKb1EviTYmKo0hwIwoUOtQRD98v17pZhx9+eOfzr8MZAlNOiAPdwphCVVqqsZxQZ8OGm1s9+kbZ4QXY/QDSo21zVr1Hv0SlpQDKNVUzJvgvjoStISI1WXEZy91QLyooDk/wEId3gQkq1q9//0cLrq2m6DpgbgeWphTqvAdC6zZzBE/efIUlSUDZhYjWQ/XnVd2PoLNMMy5kWjOSfjiNn9jgqK7lopE2pR5zdBUAukoy8qTV8lbHQcZqb03qmI5EQUxCtpElnRdvuDatfM6QdbEuH35AwmPSgsFaH8TVRPNi0WbwGi6fN9osZ/VC3s0FrrXfNV5glZFjhQUXD3un2r5HI2tBUBlZMMMTCEvpfjfDm9LQG74u4JsAGlHjNZfq6RZWpeXGUiQ45mKM16geYNe9r6NE1hM0QTNHFG3YApLcc9Zk4c6pcKKDk9brZHPN21A+b5sBHQ+j05msmdB4DP1TRvUBUmjnyBjt79N/XfjrChVvWhDxkaCYVnm++EMUP9xdebcXpYaWbzRO7vKMZB/56Jeb5Hp0Qpy3RZDeuYA35CqVU9UJSZZeTcSWoVu45SLnAscWxeNUJmOFejza3x8PCcfLODrYhMZTWaDJLO8RMudKUlFKmSOlPRi1ADZjXADZFuorYhWVkupuY+/TINuAiUBD44MOEp6vI+FI2GC7LXY6k1coftuTtrc3bnsC9aawBOMeuIi7QbY/6hy23e4OqTGpFDeL6PD8NrrpsZL3XP/h+eXyMo4IsZI8/qXUFmJmsugwGqwGADSqa+vKPb915FtTpGYipYD4mnuBlXxwPYyW8eqMjc6IraOx6n3aBG3YjIvZ3bMuG9Sc0vW5G+ogqHG2lvw/kLytHv/tUXHEiWwyZPQgEMaJKn5owiVvw92GkMamKEVzh6txhxB26EQSVgX4htjA5tDA8HnLKX8e/OvWZV57zDc5weujB7d27dVuOapbfurzhsZrl3DwCA+tK3V0cGB9jt8OrXPu2Uvr9zp4sbRU2fiAoqjr57FhrVVvRRR1be8wqbYn/azGKHIh2I5275u62m5YqdYuOyreqoa3Vdvaomz5LVeUihqQTW85hVW4mEpLnp5mjksUp2TvkNS4Hq57NjFPZFHXzIThv/79H3ZGoDUL1R8osnlcKSjlHNW0crU30xxvOD34NB4L29c4z5AVOWqdL4Csi5mtB7UpdWRZed09YSWb8JyTLKRh0gWTWuJU9+HHxv32RLkMw2vMSYTWKhPVk4bnfi7V1ZTceDFVllIZHSnNKDImEqefOwa3eiaVfpLtUyquqTpQEdTcwSaFUSwxUDDBZlZRjDtYSjEn14cGJSdkvmqZV85AM4znUrmwmT2QDWPb8PDbm5K6rFeWLBuFGVHFtbfSdOysZMe7vr50Qg6JkmDhCVpltRK5pFJQcmxUeQ6lNM7ZQOpaG0aabhQTmrQIH6nzd1AjzBtQqH090weNdMPvuLhy5Us9OK+J6UecaG6wm9y4StlPu3O+5+Yv1YSKI6XmRqpFM3vGTVZNrAxuL1J/uJW+D/XELRnbrJHKRG9wY8tEDygPc3CKhihED16dHNnH+yn8+j//C++QKQGZnDtqTSqF+aIpXbaFvfbmHdrqt9ea6Kyi6mBjiVTMgteIMBjFq+9Fl+0UTtGGS7uV0qzkfvnzACZ0s0g//ZikBRAVM+e7DeKIlXyj5Uf1rfp4eorqmidBu9xywwM7eBDFUc4TFBpbisir70/ewTU86+9HcesRfsBtD94dvX77/vQtQUOc5TA27O/3923sUGpTMNHaqluLviriWhkJu8r1XeX6rnJ9V7m+q1z//dRW7yrXd5Xru8r1XeX6rnJ9V7n+z0PCrnJ9V7m+q1zfVa7vKtd3leu7yvVd5fqucn1Xub6rXN9Vrj8eWbGrXH8sBcG7yvXfggJ3leu7yvUvr1z3mUakUw7KnHHRSrF06WznK/Xsl3GUUbrb4Xl0e0uhzA9UnULNP1c2y+b8Mo6umeLksLeZcnHI8KLUpiukHKPXLv7QO6PtY8cMNua+kiBICWpuxit763eObWfknRyfnkVxFMqJCpnSHMXmVI/P5i45ySPTFkszW+WYMzGrbKZV5NZcurzlrJvRdmUz2vyPVsIWE4sWhN1UN3cM+kuH2jjh9tZlyy2X9XjXtXWGR2wYTdd3uVwu/w9U/423","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9lyG0eSv5LTMRGyOA2AgChZy6eRJa2Hs1qRYVLh2CU5cKE7gS6xu6pdVU0QZiBiH+YP9g/m0/wlG1lHHzhI6hgPHQs9UOg6s7Iys/K8jQyb6ejwPHojk6pAYXR0GUcp6kTx0nAposPoLEN4o9jUQBgEr06OgOW5nGuoNCoNRsIMBSpmEATOIQ3LwWQBpZLXPOViBikzDObcZMBgwjS+OAAUiUwxhSnPsX8hLsQZLw/hQ5lLlsJCVgpO3vx7vR5tRG3ne3tvcFLN4MPR3t7lN5kxpT4cDFhZ9mWJQvOZyNlE9xNZDFIaWKbTpzHMM1RIq0LCBCDTPF8AS1OY83SGRsdgMhSQyHIBiZQq5YIZ1DGUbIYgqmKCSsfARAqFVAhcAAOFLF30jOxVGuGvp8fvYSpVwUwfTvJKx/V2KVeYmHzhljcZ1qd6ogM2tFFczGIo2BXhixv4ueLJFR1bo0jpf5r46uTI4mpv77QqS6kMpvCjO8Lh3h71fIe5nANTaMcnsiikgJIpVqCxF5YxY7sV/lxxham/ljwPuDi8ED3Y2zOLEg/39uBIpDwhZNgFqRXk1I/tu6GEJBp6WmLCp9wPbaEOpIB5xpPM4mTO3H2WOUscmAp1iYnh19hd+CaGBS38BoUMEGRS8V+kMCy313GNyvCE5e1rIwBpqDZMGUJnKbkwodXvAP/lr4duz16KpysCLSVkFVzYHo1wzfIKtYdqHkNGUP2ApUJtid2vS4gUKWTIZ9nW/Vj6sdKmszBUmsBsQ+H3Crdk0YsWbVOWawQ+7eCyYFfY2g2kZWKW9+G7BaQ4ZVVuYuBEcUZV2If30gAry5wnbJIjUS4Q8zBTKezZW/bk4AERrLB3fGJ5GjUwSPl0ioqYkzrtEn5OgI7orBEClnNMxgRIsXLRicylWich29zFIyRSGBSmD6+uGc8t8O6wGrhI8ipFmOQsuYphklcYg8LUMe4CSXDFjt7tEGDa49ziBzTmRIVSEPxC+u25Bu2hSvtwlnHd8BN1BlTbTbhuY9Vz7VTSzoSCwGKABeN5bBEXw0c5AcNNjjExbMnEIiaJiTEYvDETeRNDkmFyZX8plnIJk8oYKdzBUiXLVM6Fx+VUCqP5Lxs4MvR8OkZHMRzE8CKGlzEM92MYjmIYHsQwfBHD8GUMo/0YRqMYRgcxjF44sEYv4yDyA4LbAAxHDsvm94NdkrvvuLacTQJT1zJ43pHBwz7s7dXcRG0//fTThbi9EAAXETHXRXQIF1E95CKKXR/JTOob+u8b+ng2+tZ/Lujzxeil/5zbocMD/5nR52h4IZZ+wwsxspAYVpR3QEHdXxUC/+WJiNrsptQW5Bk1kiCKQwfdVQce6li2z/KMzsIFN5zlevtxwohHdKIGpLVDHdChLLluP5HtfkTHacNDPVZMui4rVltdgeEtFKO10z/v+5dl++Hdto/m7C1wvuzoL+joJJrOSDRtP38tvR4RElZh+jJMfNu3CoCVzNvx4Ac8Iix0IfoyHLwkHNCjtB0B1PuITt8Chzr8C+/69g96w+e90f7ooIMBso3cgKLopWlvsVh8DeyRzuO3J5UnaKhOsyO7dKpkscH8sNZBM8rrRPZ3UNn/kxT1SdBhMSW7zxoWQWOpLb62lm1kyhZPtFsqTK2VMxrfqGaLFpi2i+Cw1m+SSZ544GlMUMkmZOD1CQc9i8lBmg5amKTGNO0VRW+lkT57FvGtxqLop2l/ZeTa7bjGAtI0hvXmje1pCkVRbGl27Z3mQVGsn6JfFB42q3z9GzGJ19m284kf8FuxSsMR3Y3vZCPyHEiR272tObeZj1Yem4wL3+GJClYGKJxVOVN4Q3ap5lK40V+fxwKLNZq9tWOtCWi9BA4V8M2x196fevKnI3QXoJb7562djBZ5BUmljSxA4QxvoGTGoBJ2sWuW85RZU65nG/CGFSWZAIO/XVykf/rjwDogyMY3QDcBKZ9x8gMN/nb+qvfflxtGVGWJKmEaIUfaSceAJunDeYZ52bii5vN5f/5MJ5mUufNDfdQKp+7vWE4+ji24ZZ/p8ummkzrSaBn8RDqr9r5G08EY0xBmbjD5LY1ZHhru29fW2zt3PLd+xCN6cVZAok7nPaHu84uoYFYhIVLG5rc0GaqL6LKe44x8TO+Ze/kAZs14ijmbYL7e9WBGq5tztpCV5+/g1Ooe1VN0C2/UUXBR+y3scfbjVie7Wel0fcsN/O0Q0ubO8OQE9gw3ADnXwXPTRWd7tndtWYejQLQ+zAlCmEAO4iA9vpQLasAexgZOEvm7u2cLGgd2YO1WDLvds0PnYtqIoTUKLnhRFbV/dFqvGlBWeN2jjS+aSX73sEP7dtd2YDf37EDOyO0bXIih9WME/8cdmqkf8YhkxQpId7Px50iRzjv9lR7Y+xkwHKvNgBueZRrqHuSa+fR27uvDMT1v5JN1k8jLliRYGvLIfSlr1iA/+IWyPivnh/vO+uG2U17bW/eIqG8DWP9kCvTjvvbr81lE2j7974hQO2A/mFidU7Jgszssd9v9iMjTw7NyuVEcyZICuVyKozQ6jFIK/YZIZRTblVGb72S6iA5vIx81oJ/eJ08zBx81xY5vI51kWDD6FSCiaDMFe6M4ss4jCjgTkqLDSE4+YkJ7lIpgMBw1zbSjD2/DKBcjjWLvSogOIxc8jeLIq/d1Ux1dLtNptAwb3rVU3dIspe2POlhL61AY8jOXeU9Tlysx9s9a6U1rBXu2As/ka0l9Bt+whW6t617/aDW0T3OI+BM/C1K20MRPlXaKWsLypMrJLYE3JVeL2kdifRMtqqjhrXeq4R0+X8Y2xoGqDRJTii2iOOIGi3b7FiJQ8tNvLkFJmLGO6k+d+1HiBPHPvoEMOHvxrPhkKD5KhAnaSy8zKT55/nD0bDgaPhuOaAUfYfp8PLredQi6hPGKYmmYBuW91wSFY7CBmf59NBrG22OzGd5PjGfbkgVaMUqdySpPKfqHTPVtzP6z00G69F2/Qf17qHkZRzf3H+YGEtkLmQjwTY5T4zwHkEglUD1tuyMfzeFGBwfLOFrcf7zF7/J439Llze8/3Y82haNJb/lXwPrs5TKOsvth/UudZPIvBPbgxbJ5XaNEITMYHofxRKaLcZBby/sGhoeCxk1lnqIiLWRdXjWihiQMJUeNV+X8RMocmdggaDrZBT6RjZRB0gO9P36eIanajY5oV2/UUq81OmgpYwFXnKBck/anKryI+nA0bSm51n+wmuAQxtpkAyHhid1vrCsrxp8M/Dfh6Ek7kYtya5o4RADBDgaDRZnbTKg5z3OCm971PtT/rLpXY5IACM9l2Pj+p+K1c77aDf2kbhoReI2xD6+ZqFNJuikbcHtbk4GljuUSbm/pVlGN6dFdLuOmgfbqNNh31bUoTJBfd2bVTdhMrNtaU52KMyYVxzX40F4bAD4TXMzGlfLrkCa4XPbXCLK5rQdjcA1h/hZpkf9XuCPAjsSxSlE9gJuPps52k/CECPhJ7Nz0FkdcaeN51LGAB91F77bg26dpkMn3tuZ5XU00jRJhvYanjOKzGVIKpR9hJ/ukJ2RJ5qSFhYpNid1tWqTCay4rHcDLmK7V8JRGcMdCXMy6pmcLOzYnrX32/iZ2FpQldXx28gBcWsO456STsyrdKd0acHx2QomWfOqtvD580DUmAmpZZwiQ/QXXnIVkrFqlWzjXJgqLESdKO1mxfZ/i2IN1gFKuN0IUO2lObFEnJq8t3GTi0hXJylAKMPf5ZdpgqTt4tFDUiDyT1UOo8h5MMphVNpJs6KUO4tIGk5pESS60UZVz60JaqZAb6smCRiaodYOngBUa1Fo/BhTaTWcwZdqgiqESnDCvKnKb1EviTYmKo0hwIwoUOtQRD98v17pZhx9+eOfzr8MZAlNOiAPdwphCVVqqsZxQZ8OGm1s9+kbZ4QXY/QDSo21zVr1Hv0SlpQDKNVUzJvgvjoStISI1WXEZy91QLyooDk/wEId3gQkq1q9//0cLrq2m6DpgbgeWphTqvAdC6zZzBE/efIUlSUDZhYjWQ/XnVd2PoLNMMy5kWjOSfjiNn9jgqK7lopE2pR5zdBUAukoy8qTV8lbHQcZqb03qmI5EQUxCtpElnRdvuDatfM6QdbEuH35AwmPSgsFaH8TVRPNi0WbwGi6fN9osZ/VC3s0FrrXfNV5glZFjhQUXD3un2r5HI2tBUBlZMMMTCEvpfjfDm9LQG74u4JsAGlHjNZfq6RZWpeXGUiQ45mKM16geYNe9r6NE1hM0QTNHFG3YApLcc9Zk4c6pcKKDk9brZHPN21A+b5sBHQ+j05msmdB4DP1TRvUBUmjnyBjt79N/XfjrChVvWhDxkaCYVnm++EMUP9xdebcXpYaWbzRO7vKMZB/56Jeb5Hp0Qpy3RZDeuYA35CqVU9UJSZZeTcSWoVu45SLnAscWxeNUJmOFejza3x8PCcfLODrYhMZTWaDJLO8RMudKUlFKmSOlPRi1ADZjXADZFuorYhWVkupuY+/TINuAiUBD44MOEp6vI+FI2GC7LXY6k1coftuTtrc3bnsC9aawBOMeuIi7QbY/6hy23e4OqTGpFDeL6PD8NrrpsZL3XP/h+eXyMo4IsZI8/qXUFmJmsugwGqwGADSqa+vKPb915FtTpGYipYD4mnuBlXxwPYyW8eqMjc6IraOx6n3aBG3YjIvZ3bMuG9Sc0vW5G+ogqHG2lvw/kLytHv/tUXHEiWwyZPQgEMaJKn5owiVvw92GkMamKEVzh6txhxB26EQSVgX4htjA5tDA8HnLKX8e/OvWZV57zDc5weujB7d27dVuOapbfurzhsZrl3DwCA+tK3V0cGB9jt8OrXPu2Uvr9zp4sbRU2fiAoqjr57FhrVVvRRR1be8wqbYn/azGKHIh2I5275u62m5YqdYuOyreqoa3Vdvaomz5LVeUihqQTW85hVW4mEpLnp5mjksUp2TvkNS4Hq57NjFPZFHXzIThv/79H3ZGoDUL1R8osnlcKSjlHNW0crU30xxvOD34NB4L29c4z5AVOWqdL4Csi5mtB7UpdWRZed09YSWb8JyTLKRh0gWTWuJU9+HHxv32RLkMw2vMSYTWKhPVk4bnfi7V1ZTceDFVllIZHSnNKDImEqefOwa3eiaVfpLtUyquqTpQEdTcwSaFUSwxUDDBZlZRjDtYSjEn14cGJSdkvmqZV85AM4znUrmwmT2QDWPb8PDbm5K6rFeWLBuFGVHFtbfSdOysZMe7vr50Qg6JkmDhCVpltRK5pFJQcmxUeQ6lNM7ZQOpaG0aabhQTmrQIH6nzd1AjzBtQqH090weNdMPvuLhy5Us9OK+J6UecaG6wm9y4StlPu3O+5+Yv1YSKI6XmRqpFM3vGTVZNrAxuL1J/uJW+D/XELRnbrJHKRG9wY8tEDygPc3CKhihED16dHNnH+yn8+j//C++QKQGZnDtqTSqF+aIpXbaFvfbmHdrqt9ea6Kyi6mBjiVTMgteIMBjFq+9Fl+0UTtGGS7uV0qzkfvnzACZ0s0g//ZikBRAVM+e7DeKIlXyj5Uf1rfp4eorqmidBu9xywwM7eBDFUc4TFBpbisir70/ewTU86+9HcesRfsBtD94dvX77/vQtQUOc5TA27O/3923sUGpTMNHaqluLviriWhkJu8r1XeX6rnJ9V7m+q1z//dRW7yrXd5Xru8r1XeX6rnJ9V7n+z0PCrnJ9V7m+q1zfVa7vKtd3leu7yvVd5fqucn1Xub6rXN9Vrj8eWbGrXH8sBcG7yvXfggJ3leu7yvUvr1z3mUakUw7KnHHRSrF06WznK/Xsl3GUUbrb4Xl0e0uhzA9UnULNP1c2y+b8Mo6umeLksLeZcnHI8KLUpiukHKPXLv7QO6PtY8cMNua+kiBICWpuxit763eObWfknRyfnkVxFMqJCpnSHMXmVI/P5i45ySPTFkszW+WYMzGrbKZV5NZcurzlrJvRdmUz2vyPVsIWE4sWhN1UN3cM+kuH2jjh9tZlyy2X9XjXtXWGR2wYTdd3uVwu/w9U/423",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=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)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\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","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",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}}, {{note}}.",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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"draftdocument_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:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function 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.0eaaabdc.js b/assets/js/ae010e44.0eaaabdc.js new file mode 100644 index 000000000..79b0d1479 --- /dev/null +++ b/assets/js/ae010e44.0eaaabdc.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:()=>x,contentTitle:()=>y,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":"eJztO11zGzeSf6V36qoca4ekSMuOT0+r2Lms7ryxKpIrtSdpFXCmyYGEASYARiSjYlUe9h/c693L/jT/kqvGx3CGIiU7SW10dfSDzMFHo7vRaPQX7hLLpiY5PE/eqqwuUVqTXKZJjibTvLJcyeQwOSsQDIqJ4VMJRyfHMEWJmlk0wODDd+/AFswCSjYWaGCiEY1dCAQaz+UU1AQY5AF+H/6qasiYBCaMAi4zUecIyi3GBFQaezlOuMQcZjyfojUpzAqeFWALDxO1m485t6A04LxiMoe6UhKYAYmYY96Hs4IbqLS65blDNGKD8wo1R5kRsJILpsEqB/vjz/99SiT+VdWa6P348//ARKgZcOn631co3QBWVf0LeSHPeHUIHyqhWA4LVWs4eftvDaEEldrO9/be4riewofjvb3LLwprK3M4GBAMVaEktAQbm36mykFOA6t88pxIRo0E1dPKDBcLYHmLKbZACZmqFpAppXMuaUdSqNgUQdblGLVJgThTKo1EAwONLF/0rOrVBuHfT99/CxOlS2b7cCJqkzbL5VxjZsXCgyfaI1XPDIyZwVcHYKzmcppCyW6IrdzCjzXPbohsgzKPTD06OXa82ts7ratKaYs5fO9JONzbo56vkHjMNLrxmSpLJaFimpVoURsvXdSt8ceaaycXtgAmROTF4YXswd6eXVR4uLcHxzLnmRNPAkitJIJ+bN8PJSbR0NMKMz7hYWiLdaBkkDriyYz5/awEyzyaGk2FmeW32AU8T2FBgN+iVBGDQmn+k5KWCbcdt6gtz5hobxsh6MTbMm2JnZXi0sbWsEJzcmj33KYEuSLUcmJWyaXrMQi3TNRoAlazFArC6jusNBo65REuMVLmUCCfFlvXY/l1bWwHMNSG0GxjEdaKu+TYi45tEyYMAp90eFmyG2yt1miAPny1gBwnrBY2BU4SZ3WNffhWWTp5gmekaEhy3ZlmttbYc7scxCEgIlnp9vhkpQNyPpmgpsNJnQ5EmBOxIznzSoPIcyfHFkyCkmsbnSmh9H0Rcs1dPkKmpHWa7+iWceGQ98SaRv2NBctuUhiLGlPQmPuDu0Ah1Cz18u6GkILzPHf8IbVMUqgk4S9VWJ4bMAGrRhHG80SdjbKlRbhpczWc2omilYkF8YgBloyL1DEuhWs1BsutwJQObMXkIoWcWUzB4tyO1TyFrMDsZqzmgV8TJa3hP204dbHn87k2SuEghVcpvE5huJ/CcJTC8CCF4asUhq9TGO2nMBqlMDpIYfTK83T0OvCTNUxsIzAceU7ap8VB0p/vuHEnlBSfaXTprKNLh33Y22tOBbX98MMPF/LuQgJcJHRILpJDuEiaIRdJ6vtI91HfMHzP6ePF6MvwuaDPV6PX4XPmhg4PwmdBn6PhhVyGBS/kyGFiWVk9gAV1/6YYhK8gKNTmFqW2qJeokRRKGjtoPzr4UMeyTcsLooVLbjkTZjs5ccQTomiF0j2iDogoJ5LbKXLdT4icNj7U49Sd73LqsdUVD7XDYnSP+pf9cENsJ94v+2Rob6Hz60h/RaST+jkj9bOd/kZDPSEmrOP06zjxZd9d5E77budDGPCEuNDF6Nfx4DXxgC6e7Qyg3idEfQsd6gi3uO/bP+gNX/ZG+6ODDgfIx/EDyrKX573FYvFbcI/smrA8mTXR0vQWGrMIE63KDW6Es/JXo4Ld435H0/svZHCPoy2KefRBG6uk8dza1rJVOVs8Mx5UnNoYYDR+ZX4tWmi6LsLDebFZoXgWkKcx0ewak6PWJx70HCcHeT5ocZIa87xXlr21RvrsOca3Gsuyn+f9tZH3dsc3lpDnKdxv3tie51CW5ZZm395pHpTlfSr6ZRlwc/ReyH+lYxIss+0nJQz4Zx2W1ZnoLvzgQaIYgJLCre0cs80nae26KbgMHUGsYG2AxmktmMY5eZiGK+lH//anLB6ylf3uPFLnzDl/37MCvngfbPTn4QAQCV0A1PL4vHuUEZAjyGpjVQkapziHilmLWjpgt0zwnDmnrOcacM7Kigz9wd8uLvI//svAhRLIW7dAOwE5n3KK6Az+dn7U+8/LDSPqqkKdMYMgkFYyKaDN+nBeoKhWQaXZbNafvTBZoZTwEaVro3Hi/16p8fWVQ7fqM1M930SpF42W606is+65G7QdjjEDceYG593JmHNhhvvuvg1ezQMXbhjxhO6cNZSo08dBqPv8IimZM0lIlHH1W9kC9UVy2czx7jrmj8y9/ITDWvAcBRujuN/1yQetaRZsoepwvmN4qktqkOgW36ij5LKJQDhy9tNWJ5uvdfq+5Ybz7RnSPp3x0onHM+4ACG5iDKbLzvbsEKRyoUMKCJPYjhHiBBg3UvqrT0GD2KcdA6+Jwt49sgSNAzewCRA2MYGHV+hsTJsxBKPkkpd12UQ6Jw3UyLIyWB9tftHM2qCOK7R3994KbP7IChRW3L7AhRy6SAYv2fQBw9R1PyEtEfBZk+8kTVRF+RKu5HGeHCYxl5KkDiga+5XKF8nhXRJiXvQzRJRo0uDaUB7mLjFZgSWjXxEZytxMuMAkTXxmxCRp4hwkSuMQp5LDRI2vMbNJSld3RacbDcFw8w7v4igfz0/SYC4nh4kP9CdpEi6wpglQZoqM0iqfJMu44EOgmpYVKON+NIkFgkMh818I5luaulzLXP0iSG9bEBxtJZ6pN4r6LL5lC9OC6+U7WU+Y0Rw6v1mYBTlbGAoT1sarooyJrBZkeuO84nrR+AHO/m5Y0sK3WanBd/hyGTe9hdGWvdbq8zcoQ0UMcDGXz517rXCM+KfQQJaI219WfjYW1wphjG5vq0LJz54/HL0YjoYvhiOCEIKlLRhMa7ZI0oRbLM3jfPS99zHo7v8RhX4xj7dQb5WnSMHFGPuPiWIc78hmU3xc5s625a9aIXVTqFrkFKxGpvsujfSLM5RdMaZFHLX9R4R2mSbzx4mZQ6Z6MTkGXwicWG8CQ6a0RP287Vk/GeJGBwfLNFk8Tt7i/yR5X9LmzR6n7nuXVVxlXH8PXF+8XqZJ8Tiuf27ynr8jsgevlqtLNMk0MovxDrgaq3xxFfXWsj0wmhHdoeFGWNKKIkdNFsd9fbVSNTSS8vVX63p+rJRAJjcomk4yjJGuM85sJaM4hJZmBZLvs7JmHXTTmOHBhPYmCyXYcM2b54YsPV3jRdKH48mKl94QXs/HxbEuHycVPHPrXZnaqfFng/BNHHrWri2gdO8qpBZRcIPBYlkJl5yfcSEIb7q++9D8c6Zdw0lCIF6XceHHr4o3PorgFgyTupltCCZiH94w2WQ+uxlGuLtrhMBJx3IJd3e0q6iv6NJdLtNVA63VaXD3qm/RmCG/7cxqmnA1sWlrTfWWzBVZMr4hRKnbCPgSnKtaBzhk8C2X/XsCudqtT+bgPYaFXSQg/7945+qwzlStP+EwO6+z5w+Ud3q8sHsgwGBau+izJZUY5dKFn1ZFElwaq2vvCEJe61gXEguuKq0yNKYfykB6kHPjM+UFtuGngNL46QwmzFjUKdSSS4ta1xV5ifdruDr0uwWW5FX5AiZi1uMC1K1GoHo2X3vVKjeLCiACxlBuFgz8phImln6tk75R4wZJeRxB0o6uXiXEACrURkkqfVN6yiT/yQcbncWnDJnLBRN+qD8DnGL3hA8p3i4y8S77+Pd/tPDaavPfR8yvwPKcgqOPYOg8f3LxjfP/NVZiAVZ1MSJ4qP+0fskmj159/nZcecZBIVOllpLG2++j/X36r0tGLH2EcPWCqTPatkktxOIPSfrpbvnDzoNv3nwhP+QNFNd89NM8ux2d0BZtkekHAQTjpdaCiv+Ic72mHnOdt1wKLvEqsu1qtL9/NSTeLtPkYBP7TlWJtnCVLsTEmVZUFlgJpHC11QtgU8Yl0FWqf0NuotZKP2zbfB5mDzHhoMOEl/eZcCxdkNSVx56pG5T/XErby1u/PKE6L52seDWTcD/I9ScdYtvtnkiDWa25XSSH53fJvMcq3vP9h+eXy8s0IcYqCmZVyjiMmS2Sw2TQim0Z1LcUkCIITmgbOTRM5hTDvGdIs4oPbofJMl2fsdHs3joa697nTTCWTbmcPjzrcsWVU9o5vzkd3qzCChX/D6S4QmB9e1SacJKYAllOhvoyTUggvltFAr+O2xpjdJvCbi1luBZIi3G0TmhsXXVvCHZtjnUNX7ajTD6O5EJDTWRoU7CnITyGb5roTSsg04rHnK+Euwl9xMjH0IUMRgcHzrf+cuic0BevnX938Gp52XF1kqTrzrhI7bpRniRdE9N9t8wmn05ZMyMi5Oba7tyd61fn9muMtn+inKyEDWzqyun03g7vO9QoMlU2lYVx+Me//8PNiBvvlMsfKHj+vtZQqRnqSe0rFCcC55xMLhqPpetb+WzISoHGiAWQrTWlyn6fkmSisWQyVrExF5x0Eg1TPlTZUmumD9+vvL5n2mdob1GQKgNWW1UyZyk1VtJM6Ruqr6cydRhTQTGZECgLJjNvrfjTlpIhQUXwZAlWmhuqk9aENfe4KWk1yyyUTLIpEuy0w6UcBVncBrQaU2bDKFF7c9UyLpT2QVlHECWLjMtAfD2vqMsFA8jO01jQVt4Gm9VQ3WaO4A9SqLQfk99RES48Q+ft1lIoKoonn6MWAipFNwJngkylNo403WomDV3kIQ4c9qBhWDAn0YSK0A8GaYffcXnjC0B7cN4I0/c4NtxiNzm8Lo7Pu3O+4fbP9ZjKxJXhVunFavaU26IeO4XYBtJ8eEjfhJch0FJ4Kxi5ysyG6InKzIDy2INTtCQhZnB0cuwu0efw8ef/gnfItIRCzby0ZrVGsWgeofgnDm7nPduaO9A5LKymdxLWCamcRueQOJik68q7e+w0TtAF491GrpareAB/HtGEbhb+88kkrUBSzHzIIOoQVvGNCoQq/c37ySnqW55FA2/LDg/c4EGSJoJnKA22DIKjb07ewS286O8naetG/ITdHrw7fvP1t6dfEzZ0sjzHhv39/r4LWStjSyZbS52imMCpNwzWcjSNlbR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aPS7lT3vHhrtHhrtHhrtHhrtHhrtHhrtHhrtHhrtHhrtHhrtHhr97lpi60OjkEQnhTmoBOOyVTHkSzTOV8+PLtOkoOqNw/Pk7o6C7R+otpCaf6xRU+nHZZrcMs0p3OQKP9JYtUAJ+xuk1PkbHz3rndHKqVdWLnW1Vu9CRRd+xlGWYWUfHNsuMDl5f3qWpEksBi1VTnM0m9HzKTbzifnAR1eiwFyNumByWrv6gcTDpEILSgZ2qzRuXJVG+NEqQ2By0cKwW77hyaC/RNTGCXd3vgJkuWzG+66tMwJj42jaucvlcvm/Au2SlQ==","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),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzeSf6V36qoca4ekSMuOT0+r2Lms7ryxKpIrtSdpFXCmyYGEASYARiSjYlUe9h/c693L/jT/kqvGx3CGIiU7SW10dfSDzMFHo7vRaPQX7hLLpiY5PE/eqqwuUVqTXKZJjibTvLJcyeQwOSsQDIqJ4VMJRyfHMEWJmlk0wODDd+/AFswCSjYWaGCiEY1dCAQaz+UU1AQY5AF+H/6qasiYBCaMAi4zUecIyi3GBFQaezlOuMQcZjyfojUpzAqeFWALDxO1m485t6A04LxiMoe6UhKYAYmYY96Hs4IbqLS65blDNGKD8wo1R5kRsJILpsEqB/vjz/99SiT+VdWa6P348//ARKgZcOn631co3QBWVf0LeSHPeHUIHyqhWA4LVWs4eftvDaEEldrO9/be4riewofjvb3LLwprK3M4GBAMVaEktAQbm36mykFOA6t88pxIRo0E1dPKDBcLYHmLKbZACZmqFpAppXMuaUdSqNgUQdblGLVJgThTKo1EAwONLF/0rOrVBuHfT99/CxOlS2b7cCJqkzbL5VxjZsXCgyfaI1XPDIyZwVcHYKzmcppCyW6IrdzCjzXPbohsgzKPTD06OXa82ts7ratKaYs5fO9JONzbo56vkHjMNLrxmSpLJaFimpVoURsvXdSt8ceaaycXtgAmROTF4YXswd6eXVR4uLcHxzLnmRNPAkitJIJ+bN8PJSbR0NMKMz7hYWiLdaBkkDriyYz5/awEyzyaGk2FmeW32AU8T2FBgN+iVBGDQmn+k5KWCbcdt6gtz5hobxsh6MTbMm2JnZXi0sbWsEJzcmj33KYEuSLUcmJWyaXrMQi3TNRoAlazFArC6jusNBo65REuMVLmUCCfFlvXY/l1bWwHMNSG0GxjEdaKu+TYi45tEyYMAp90eFmyG2yt1miAPny1gBwnrBY2BU4SZ3WNffhWWTp5gmekaEhy3ZlmttbYc7scxCEgIlnp9vhkpQNyPpmgpsNJnQ5EmBOxIznzSoPIcyfHFkyCkmsbnSmh9H0Rcs1dPkKmpHWa7+iWceGQ98SaRv2NBctuUhiLGlPQmPuDu0Ah1Cz18u6GkILzPHf8IbVMUqgk4S9VWJ4bMAGrRhHG80SdjbKlRbhpczWc2omilYkF8YgBloyL1DEuhWs1BsutwJQObMXkIoWcWUzB4tyO1TyFrMDsZqzmgV8TJa3hP204dbHn87k2SuEghVcpvE5huJ/CcJTC8CCF4asUhq9TGO2nMBqlMDpIYfTK83T0OvCTNUxsIzAceU7ap8VB0p/vuHEnlBSfaXTprKNLh33Y22tOBbX98MMPF/LuQgJcJHRILpJDuEiaIRdJ6vtI91HfMHzP6ePF6MvwuaDPV6PX4XPmhg4PwmdBn6PhhVyGBS/kyGFiWVk9gAV1/6YYhK8gKNTmFqW2qJeokRRKGjtoPzr4UMeyTcsLooVLbjkTZjs5ccQTomiF0j2iDogoJ5LbKXLdT4icNj7U49Sd73LqsdUVD7XDYnSP+pf9cENsJ94v+2Rob6Hz60h/RaST+jkj9bOd/kZDPSEmrOP06zjxZd9d5E77budDGPCEuNDF6Nfx4DXxgC6e7Qyg3idEfQsd6gi3uO/bP+gNX/ZG+6ODDgfIx/EDyrKX573FYvFbcI/smrA8mTXR0vQWGrMIE63KDW6Es/JXo4Ld435H0/svZHCPoy2KefRBG6uk8dza1rJVOVs8Mx5UnNoYYDR+ZX4tWmi6LsLDebFZoXgWkKcx0ewak6PWJx70HCcHeT5ocZIa87xXlr21RvrsOca3Gsuyn+f9tZH3dsc3lpDnKdxv3tie51CW5ZZm395pHpTlfSr6ZRlwc/ReyH+lYxIss+0nJQz4Zx2W1ZnoLvzgQaIYgJLCre0cs80nae26KbgMHUGsYG2AxmktmMY5eZiGK+lH//anLB6ylf3uPFLnzDl/37MCvngfbPTn4QAQCV0A1PL4vHuUEZAjyGpjVQkapziHilmLWjpgt0zwnDmnrOcacM7Kigz9wd8uLvI//svAhRLIW7dAOwE5n3KK6Az+dn7U+8/LDSPqqkKdMYMgkFYyKaDN+nBeoKhWQaXZbNafvTBZoZTwEaVro3Hi/16p8fWVQ7fqM1M930SpF42W606is+65G7QdjjEDceYG593JmHNhhvvuvg1ezQMXbhjxhO6cNZSo08dBqPv8IimZM0lIlHH1W9kC9UVy2czx7jrmj8y9/ITDWvAcBRujuN/1yQetaRZsoepwvmN4qktqkOgW36ij5LKJQDhy9tNWJ5uvdfq+5Ybz7RnSPp3x0onHM+4ACG5iDKbLzvbsEKRyoUMKCJPYjhHiBBg3UvqrT0GD2KcdA6+Jwt49sgSNAzewCRA2MYGHV+hsTJsxBKPkkpd12UQ6Jw3UyLIyWB9tftHM2qCOK7R3994KbP7IChRW3L7AhRy6SAYv2fQBw9R1PyEtEfBZk+8kTVRF+RKu5HGeHCYxl5KkDiga+5XKF8nhXRJiXvQzRJRo0uDaUB7mLjFZgSWjXxEZytxMuMAkTXxmxCRp4hwkSuMQp5LDRI2vMbNJSld3RacbDcFw8w7v4igfz0/SYC4nh4kP9CdpEi6wpglQZoqM0iqfJMu44EOgmpYVKON+NIkFgkMh818I5luaulzLXP0iSG9bEBxtJZ6pN4r6LL5lC9OC6+U7WU+Y0Rw6v1mYBTlbGAoT1sarooyJrBZkeuO84nrR+AHO/m5Y0sK3WanBd/hyGTe9hdGWvdbq8zcoQ0UMcDGXz517rXCM+KfQQJaI219WfjYW1wphjG5vq0LJz54/HL0YjoYvhiOCEIKlLRhMa7ZI0oRbLM3jfPS99zHo7v8RhX4xj7dQb5WnSMHFGPuPiWIc78hmU3xc5s625a9aIXVTqFrkFKxGpvsujfSLM5RdMaZFHLX9R4R2mSbzx4mZQ6Z6MTkGXwicWG8CQ6a0RP287Vk/GeJGBwfLNFk8Tt7i/yR5X9LmzR6n7nuXVVxlXH8PXF+8XqZJ8Tiuf27ynr8jsgevlqtLNMk0MovxDrgaq3xxFfXWsj0wmhHdoeFGWNKKIkdNFsd9fbVSNTSS8vVX63p+rJRAJjcomk4yjJGuM85sJaM4hJZmBZLvs7JmHXTTmOHBhPYmCyXYcM2b54YsPV3jRdKH48mKl94QXs/HxbEuHycVPHPrXZnaqfFng/BNHHrWri2gdO8qpBZRcIPBYlkJl5yfcSEIb7q++9D8c6Zdw0lCIF6XceHHr4o3PorgFgyTupltCCZiH94w2WQ+uxlGuLtrhMBJx3IJd3e0q6iv6NJdLtNVA63VaXD3qm/RmCG/7cxqmnA1sWlrTfWWzBVZMr4hRKnbCPgSnKtaBzhk8C2X/XsCudqtT+bgPYaFXSQg/7945+qwzlStP+EwO6+z5w+Ud3q8sHsgwGBau+izJZUY5dKFn1ZFElwaq2vvCEJe61gXEguuKq0yNKYfykB6kHPjM+UFtuGngNL46QwmzFjUKdSSS4ta1xV5ifdruDr0uwWW5FX5AiZi1uMC1K1GoHo2X3vVKjeLCiACxlBuFgz8phImln6tk75R4wZJeRxB0o6uXiXEACrURkkqfVN6yiT/yQcbncWnDJnLBRN+qD8DnGL3hA8p3i4y8S77+Pd/tPDaavPfR8yvwPKcgqOPYOg8f3LxjfP/NVZiAVZ1MSJ4qP+0fskmj159/nZcecZBIVOllpLG2++j/X36r0tGLH2EcPWCqTPatkktxOIPSfrpbvnDzoNv3nwhP+QNFNd89NM8ux2d0BZtkekHAQTjpdaCiv+Ic72mHnOdt1wKLvEqsu1qtL9/NSTeLtPkYBP7TlWJtnCVLsTEmVZUFlgJpHC11QtgU8Yl0FWqf0NuotZKP2zbfB5mDzHhoMOEl/eZcCxdkNSVx56pG5T/XErby1u/PKE6L52seDWTcD/I9ScdYtvtnkiDWa25XSSH53fJvMcq3vP9h+eXy8s0IcYqCmZVyjiMmS2Sw2TQim0Z1LcUkCIITmgbOTRM5hTDvGdIs4oPbofJMl2fsdHs3joa697nTTCWTbmcPjzrcsWVU9o5vzkd3qzCChX/D6S4QmB9e1SacJKYAllOhvoyTUggvltFAr+O2xpjdJvCbi1luBZIi3G0TmhsXXVvCHZtjnUNX7ajTD6O5EJDTWRoU7CnITyGb5roTSsg04rHnK+Euwl9xMjH0IUMRgcHzrf+cuic0BevnX938Gp52XF1kqTrzrhI7bpRniRdE9N9t8wmn05ZMyMi5Oba7tyd61fn9muMtn+inKyEDWzqyun03g7vO9QoMlU2lYVx+Me//8PNiBvvlMsfKHj+vtZQqRnqSe0rFCcC55xMLhqPpetb+WzISoHGiAWQrTWlyn6fkmSisWQyVrExF5x0Eg1TPlTZUmumD9+vvL5n2mdob1GQKgNWW1UyZyk1VtJM6Ruqr6cydRhTQTGZECgLJjNvrfjTlpIhQUXwZAlWmhuqk9aENfe4KWk1yyyUTLIpEuy0w6UcBVncBrQaU2bDKFF7c9UyLpT2QVlHECWLjMtAfD2vqMsFA8jO01jQVt4Gm9VQ3WaO4A9SqLQfk99RES48Q+ft1lIoKoonn6MWAipFNwJngkylNo403WomDV3kIQ4c9qBhWDAn0YSK0A8GaYffcXnjC0B7cN4I0/c4NtxiNzm8Lo7Pu3O+4fbP9ZjKxJXhVunFavaU26IeO4XYBtJ8eEjfhJch0FJ4Kxi5ysyG6InKzIDy2INTtCQhZnB0cuwu0efw8ef/gnfItIRCzby0ZrVGsWgeofgnDm7nPduaO9A5LKymdxLWCamcRueQOJik68q7e+w0TtAF491GrpareAB/HtGEbhb+88kkrUBSzHzIIOoQVvGNCoQq/c37ySnqW55FA2/LDg/c4EGSJoJnKA22DIKjb07ewS286O8naetG/ITdHrw7fvP1t6dfEzZ0sjzHhv39/r4LWStjSyZbS52imMCpNwzWcjSNlbR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aLR7aPS7lT3vHhrtHhrtHhrtHhrtHhrtHhrtHhrtHhrtHhrtHhrtHhr97lpi60OjkEQnhTmoBOOyVTHkSzTOV8+PLtOkoOqNw/Pk7o6C7R+otpCaf6xRU+nHZZrcMs0p3OQKP9JYtUAJ+xuk1PkbHz3rndHKqVdWLnW1Vu9CRRd+xlGWYWUfHNsuMDl5f3qWpEksBi1VTnM0m9HzKTbzifnAR1eiwFyNumByWrv6gcTDpEILSgZ2qzRuXJVG+NEqQ2By0cKwW77hyaC/RNTGCXd3vgJkuWzG+66tMwJj42jaucvlcvm/Au2SlQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,x={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"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:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",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}}, {{note}}.",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.13adcb02.js b/assets/js/ae010e44.13adcb02.js deleted file mode 100644 index df198d38c..000000000 --- a/assets/js/ae010e44.13adcb02.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6685],{73320:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>j,contentTitle:()=>x,default:()=>f,frontMatter:()=>u,metadata:()=>t,toc:()=>y});const t=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":"eJztO11zGzeSf6V3aqsca4ekSMuOj0+r2Lms7ryxKpIrlRO1CjjT5EDCABMAI5JRsSoP+w/2dfclP82/5KoBzHCGIkUrSW10dfSDzMFHo7vRaPQX7iLLpiYaXkRvVVLmKK2JLuMoRZNoXliuZDSMzjMEg2Ji+FTC8ekJTFGiZhYNMPjwzTuwGbOAko0FGphoRGMXAoHGczkFNQEGaYDfhe9UCQmTwIRRwGUiyhRBucWYgEJjJ8UJl5jCjKdTtCaGWcaTDGzmYaJ28zHlFpQGnBdMplAWSgIzIBFTTLtwnnEDhVa3PHWIVtjgvEDNUSYELOeCabDKwf740z/PiMTvVKmJ3o8//QsmQs2AS9f/vkDpBrCi6I7kSJ7zYggfCqFYCgtVajh9+581oQSV2i4ODt7iuJzCh5ODg8vPMmsLM+z1CIYqUBJago1NN1F5L6WBRTp5TiSjRoLqaWWGiwWwtMEUm6GERBULSJTSKZe0IzEUbIogy3yM2sRAnMmVRqKBgUaWLjpWdUqD8F9n77+GidI5s104FaWJ6+VSrjGxYuHBE+0VVc8MjJnBV0dgrOZyGkPOboit3MIPJU9uiGyDMq2Yenx64nh1cHBWFoXSFlP41pMwPDigni+QeMw0uvGJynMloWCa5WhRGy9d1K3xh5JrJxc2AyZExYvhSHbg4MAuChweHMCJTHnixJMAUiuJoB/b9UOJSTT0rMCET3gY2mAdKBmkjngyY34/C8ESj6ZGU2Bi+S22Ac9jWBDgtyhVhUGmNP9RScuE245b1JYnTDS3jRB04m2ZtsTOQnFpq9awQn1yaPfcpgS5ItRSYlbOpesxCLdMlGgCVrMYMsLqGyw0GjrlFVxipEwhQz7Ntq7H0uvS2BZgKA2h2cQirFXtkmMvOrZNmDAIfNLiZc5usLFarQG68MUCUpywUtgYOEmc1SV24Wtl6eQJnpCiIcl1Z5rZUmPH7XIQh4CIZLnb49OVDkj5ZIKaDid1OhBhToUdyZlXGkSeOzk2YxKUXNvoRAml74uQa27zERIlrdN8x7eMC4e8J9bU6m8sWHITw1iUGIPG1B/cBQqhZrGXdzeEFJznueMPqWWSQiUJf6nC8tyACVjVirA6T9RZK1tahJsmV8OpnShamVhQHTHAnHERO8bFcK3GYLkVGNOBLZhcxJAyizFYnNuxmseQZJjcjNU88GuipDX8xw2nrup5PNcGMRzF8CqG1zH0D2PoD2LoH8XQfxVD/3UMg8MYBoMYBkcxDF55ng5eB36ymolNBPoDz0n7tDhI+vMdN+6EkuIztS6dtXRpvwsHB/WpoLbvv/9+JO9GEmAU0SEZRUMYRfWQURT7PtJ91NcP33P6eDH4PHwu6PPV4HX4nLmh/aPwmdHnoD+Sy7DgSA4cJpblxQNYUPdvikH4CoJCbW5Raqv0EjWSQomrDtqPFj7UsWzS8oJo4ZJbzoTZTk414glRtELpHlFHRJQTye0Uue4nRE4TH+px6s53OfXY6KoOtcNicI/6l91wQ2wn3i/7ZGhvoPPrSH9FpJP6OSf1s53+WkM9ISas4/TrOPF5113kTvtu50MY8IS40Mbo1/HgNfGALp7tDKDeJ0R9Ax3qCLe47zs86vRfdgaHg6MWB8jH8QPyvJOmncVi8Vtwj+yasDyZNZWl6S00ZhEmWuUb3Ahn5a9GBbvH/a5M77+SwT2ubFFMKx+0tkpqz61pLVuVssUz40FVU2sDjMavzK9FA03XRXg4LzbJFE8C8jSmMrvG5Kh1iQcdx8lemvYanKTGNO3keWetkT47jvGNxjzvpml3beS93fGNOaRpDPebN7anKeR5vqXZt48iZ1L9B4l+sLa2S38Y8O86ACs5by/84OEgv15J4dZ2ztbm07F2hWRcho4gKrA2QOO0FEzjnLxGw5X0o3/7k1MdnJVN7rxM56A5H96zAj57H+zu50GoiYQ2AGrZPe8eZQTkGJLSWJWDxinOoWDWopYO2C0TPGXO0eq4BpyzvCDjvfe30Sj90x97LjxAHrgF2glI+ZRTlKb3t4vjzv9cbhhRFgXqhBkEgbSSiQFt0oWLDEWxChTNZrPu7IVJMqWEjxJdG40T//dKja+vHLpFl5ni+SZKvWg03HESnXVv3KBtcYwZqGZucMidjLkz1D90d2jwVB64RMOIJ3SPrKFEnT62Qd0XoyhnzswgUcbVb2Uz1KPosp7jXXBMd8y9/ITDmvEUBRujuN/1yQetSUsQ2QZjqCPnsg4bOHwP40Ynm691+r7lhgPsKW4ev+qmqM5fxWIQ3FSBkza/mrNDZMnF+yiKS3I5RqgmwLgWw18t5jVinybnXtWEzdmxBI0DN7CO6tWO/MMrtDamyRiCkXPJ8zKvw5OTGmrFsjyYDE1+0czSoK5WaO7uvRXYfMcKFAvcvsBI9l34geds+oA16bqfkBoI+KzJdxRHqqAkB1fyJI2GUZUAiWIHFI39QqWLaHgXhUAV/QxhIJrUuzaUPLmLTJJhzuhXhQylWyZcYBRHPp1hojhyXg3lXohT0TBS42tMbBTT3VxQxBgNwXDzhnfVKB+Ej+Jg40bDyEfnozgKN1TdBCgTRZZkkU6iZbXgQ6DqlhUo437U2QCCQ3HuXwjma5q6XEs3/SJIbxsQHG05nqs3ivosvmUL04Dr5Ttaz3LRHDq/SZgFKVsYiu2VxquihImkFGQv47zgelEb785orlnSwLdeqca3/3JZbXoDoy17rdXjNyhBRQxwgZLHzr1WOEb8c2ggU8PtL8sfjcW1Qhij29siU/LR8/uDF/1B/0V/QBBChLMBg2nNFlEccYu52c1H33sfg/b+H1O8FtPqFuqskgsxuMBgd5coVuMd2WyKu2XufFvSqREHN5kqRUoRZmS663I/vzit2BZjWsRR290htMs4mu8mZg6J6lQZLfhM4MR6GxcSpSXq5013+MkQNzg6WsbRYjd5i/+T5H1OmzfbTd23LhW4SpP+Hri+eL2Mo2w3rn+pk5W/I7JHr5arSzRKNDKL1R1wNVbp4qrSW8vmwMqMaA8NN8KSVhQparI47uurlaqhkZRkv1rX82OlBDK5QdG0MliMdJ1xZisZxSEeNMuQnJuVNeugm9oMDya0N1koK4Zr7jo3ZOnpEkdRF04mK156Q3g9iVaNdUk0qeCZW+/KlE6NP+uFb+LQs2ZBAOVoV3GwCgU3GCzmhXAZ9RkXgvCm67sL9T9n2tWcJASq67JaePdV8caHCdyCYVI7HQ3BROzCGybrdGU7LQh3d7UQOOlYLuHujnYV9RVdustlvGqgtVoN7l71LRoT5LetWXUTribWbY2p3pK5IkvGN4TQchMBXzdzVeoAhwy+5bJ7TyBXu/XJHLzHsLCLBOT/F+9c8dS5KvUnHGbndXb8gfJOjxd2DwQYTEsXMrakEiu5dPGlVWUDl8bq0juCkJa6KuaoqqQKrRI0phtqNzqQcuPT2xk24ceA0vjpDCbMWNQxlJJLi1qXBXmJ9wuvWvS7BZbkVfmqI2LWbgFqlxBQEZovmGrUiFUKoAKMoUYsGPh1+UpVr7VO+kaNGyRlN4KkHV2RSYgBFKiNklSvpvSUSf6jjyY6i08ZMpczJvxQfwY4BdwJH1K8bWSqu+zj339u4LXV5r+PmF+BpSlFP3dg6Dx/cvGN8/81FmIBVrUxInio/7x+yUY7rz5/O64846CQqbxKSePt98HhIf3XJqOqV4Rw9YIpE9q2SSnE4g9R/Olu+cPOg2/efCE/5A1k13zw4zy5HZzSFm2R6QcBBOOl1IIq9ohznbqIcp23XAou8api29Xg8PCqT7xdxtHRJvadqRxt5spTiIkzraiWrxBI8WirF8CmjEugq1T/htxErZV+2LZ5HGYPMeGoxYSX95lwIl2Q1NW0nqsblP9eSpvLW788oTrPnax4NRNxP8j1Ry1im+2eSINJqbldRMOLu2jeYQXv+P7hxeXyMo6IsYqCWYUyDmNms2gY9RqxLYP6lgJSBMEJbS2HhsmUYpj3DGlW8N5tP1rG6zM2mt1bR2PZedwEY9mUy+nDsy5XXDmjnfOb0+LNKqxQ8P9GiisE1jdHxREnicmQpWSoL+OIBOKbVSTwy2pbqxjdprBbQxmuBdKqOForNLauujcEuzbHuvovm1EmH0dyoaE6MrQp2FMTXoVv6uhNIyDTiMdcrIS7Dn1UkY++CxkMjo6cb/153zmhL147/+7o1fKy5epEUdudcZHadaM8itompvtumE0+X7JmRlSQ62u7dXeuX53brzHa/olyshI2sC4Gp9N727/vUKNIVF6XA1bDP/79Zzej2ninXP5AwfP3pYZCzVBPSl9WOBE452Ry0XjMXd/KZ0OWCzRGLIBsrSmV4/ucIxO1JZOwgo254KSTaJjyocqGWjNd+Hbl9T3TPgV7i4JUGbDSqpw5S6m2kmZK31BRPNWWw5iqgMmEQJkxmXhrxZ+2mAwJqlwnS7DQ3FBxsyasucdNSatZYiFnkk2RYMctLqUoyOI2oNWYMhtGidKbq5ZxobQPyjqCKFlkXAbiy3lBXS4YQHaexoy28jbYrIaKLVMEf5BCefyY/I6CcOEJOm+3lEJRJTv5HKUQUCi6ETgTZCo1caTpVjNp6CIPceCwBzXDgjmJJpRxfjBIO/yOyxtftdmBi1qYvsWx4Rbb2d91cXzenvMVt38px1TbrQy3Si9Ws6fcZuXYKcQmkPrDQ/oqPOeAhsJbwUhVYjZET1RiepSo7p2hJQkxvePTE3eJPoePP/0D3iHTEjI189KalBrFon454t8luJ33bKvvQOewsJIeN1gnpHJaOYfEwSheV97tY6dxgi4Y7zZytVzBA/iLCk1op9kfTyZpBZJi5kMGlQ5hBd+oQKg837yfnKG+5Ull4G3Z4Z4b3IviSPAEpcGGQXD81ek7uIUX3cMobtyIn7DbvXcnb778+uxLwoZOludYv3vYPXQha2VszmRjqTMUEzjzhsFajqa2kvavg/avg/avg/avg/avg/avg/avg/avg/avg/avg/avg/avg/avg363uub966D966D966D966DdDw72r4P2r4P2r4P2r4P2r4P2r4P2r4Me9TooZL5JI/YKwbhslPn4uoqL1ZuhyzjKqORieBHd3VGE/AMVBFLzDyVqqte4jKNbpjnFiFy1RlyVGlCW/QYp3/3Gh7w657Ry7LWRyzetFalQpYSfcZwkWNgHxzarQk7fn51HcVRVcOYqpTmazejNE5v5bHrgo6srYK6wXDA5LV3SP/IwqTqCMnjt0oobV1oRfjRqB5hcNDBs11x4MugvEbVxwt2dL9tYLuvxvmvrjMDYajTt3OVyufxfwpFlDQ==","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=i(74848),o=i(28453),r=i(33617),a=i.n(r),l=i(17543),d=i.n(l),c=i(86013),p=i.n(c),h=i(63723),g=i.n(h),m=(i(18766),i(79329),i(9303));const u={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:"eJztO11zGzeSf6V3aqsca4ekSMuOj0+r2Lms7ryxKpIrlRO1CjjT5EDCABMAI5JRsSoP+w/2dfclP82/5KoBzHCGIkUrSW10dfSDzMFHo7vRaPQX7iLLpiYaXkRvVVLmKK2JLuMoRZNoXliuZDSMzjMEg2Ji+FTC8ekJTFGiZhYNMPjwzTuwGbOAko0FGphoRGMXAoHGczkFNQEGaYDfhe9UCQmTwIRRwGUiyhRBucWYgEJjJ8UJl5jCjKdTtCaGWcaTDGzmYaJ28zHlFpQGnBdMplAWSgIzIBFTTLtwnnEDhVa3PHWIVtjgvEDNUSYELOeCabDKwf740z/PiMTvVKmJ3o8//QsmQs2AS9f/vkDpBrCi6I7kSJ7zYggfCqFYCgtVajh9+581oQSV2i4ODt7iuJzCh5ODg8vPMmsLM+z1CIYqUBJago1NN1F5L6WBRTp5TiSjRoLqaWWGiwWwtMEUm6GERBULSJTSKZe0IzEUbIogy3yM2sRAnMmVRqKBgUaWLjpWdUqD8F9n77+GidI5s104FaWJ6+VSrjGxYuHBE+0VVc8MjJnBV0dgrOZyGkPOboit3MIPJU9uiGyDMq2Yenx64nh1cHBWFoXSFlP41pMwPDigni+QeMw0uvGJynMloWCa5WhRGy9d1K3xh5JrJxc2AyZExYvhSHbg4MAuChweHMCJTHnixJMAUiuJoB/b9UOJSTT0rMCET3gY2mAdKBmkjngyY34/C8ESj6ZGU2Bi+S22Ac9jWBDgtyhVhUGmNP9RScuE245b1JYnTDS3jRB04m2ZtsTOQnFpq9awQn1yaPfcpgS5ItRSYlbOpesxCLdMlGgCVrMYMsLqGyw0GjrlFVxipEwhQz7Ntq7H0uvS2BZgKA2h2cQirFXtkmMvOrZNmDAIfNLiZc5usLFarQG68MUCUpywUtgYOEmc1SV24Wtl6eQJnpCiIcl1Z5rZUmPH7XIQh4CIZLnb49OVDkj5ZIKaDid1OhBhToUdyZlXGkSeOzk2YxKUXNvoRAml74uQa27zERIlrdN8x7eMC4e8J9bU6m8sWHITw1iUGIPG1B/cBQqhZrGXdzeEFJznueMPqWWSQiUJf6nC8tyACVjVirA6T9RZK1tahJsmV8OpnShamVhQHTHAnHERO8bFcK3GYLkVGNOBLZhcxJAyizFYnNuxmseQZJjcjNU88GuipDX8xw2nrup5PNcGMRzF8CqG1zH0D2PoD2LoH8XQfxVD/3UMg8MYBoMYBkcxDF55ng5eB36ymolNBPoDz0n7tDhI+vMdN+6EkuIztS6dtXRpvwsHB/WpoLbvv/9+JO9GEmAU0SEZRUMYRfWQURT7PtJ91NcP33P6eDH4PHwu6PPV4HX4nLmh/aPwmdHnoD+Sy7DgSA4cJpblxQNYUPdvikH4CoJCbW5Raqv0EjWSQomrDtqPFj7UsWzS8oJo4ZJbzoTZTk414glRtELpHlFHRJQTye0Uue4nRE4TH+px6s53OfXY6KoOtcNicI/6l91wQ2wn3i/7ZGhvoPPrSH9FpJP6OSf1s53+WkM9ISas4/TrOPF5113kTvtu50MY8IS40Mbo1/HgNfGALp7tDKDeJ0R9Ax3qCLe47zs86vRfdgaHg6MWB8jH8QPyvJOmncVi8Vtwj+yasDyZNZWl6S00ZhEmWuUb3Ahn5a9GBbvH/a5M77+SwT2ubFFMKx+0tkpqz61pLVuVssUz40FVU2sDjMavzK9FA03XRXg4LzbJFE8C8jSmMrvG5Kh1iQcdx8lemvYanKTGNO3keWetkT47jvGNxjzvpml3beS93fGNOaRpDPebN7anKeR5vqXZt48iZ1L9B4l+sLa2S38Y8O86ACs5by/84OEgv15J4dZ2ztbm07F2hWRcho4gKrA2QOO0FEzjnLxGw5X0o3/7k1MdnJVN7rxM56A5H96zAj57H+zu50GoiYQ2AGrZPe8eZQTkGJLSWJWDxinOoWDWopYO2C0TPGXO0eq4BpyzvCDjvfe30Sj90x97LjxAHrgF2glI+ZRTlKb3t4vjzv9cbhhRFgXqhBkEgbSSiQFt0oWLDEWxChTNZrPu7IVJMqWEjxJdG40T//dKja+vHLpFl5ni+SZKvWg03HESnXVv3KBtcYwZqGZucMidjLkz1D90d2jwVB64RMOIJ3SPrKFEnT62Qd0XoyhnzswgUcbVb2Uz1KPosp7jXXBMd8y9/ITDmvEUBRujuN/1yQetSUsQ2QZjqCPnsg4bOHwP40Ynm691+r7lhgPsKW4ev+qmqM5fxWIQ3FSBkza/mrNDZMnF+yiKS3I5RqgmwLgWw18t5jVinybnXtWEzdmxBI0DN7CO6tWO/MMrtDamyRiCkXPJ8zKvw5OTGmrFsjyYDE1+0czSoK5WaO7uvRXYfMcKFAvcvsBI9l34geds+oA16bqfkBoI+KzJdxRHqqAkB1fyJI2GUZUAiWIHFI39QqWLaHgXhUAV/QxhIJrUuzaUPLmLTJJhzuhXhQylWyZcYBRHPp1hojhyXg3lXohT0TBS42tMbBTT3VxQxBgNwXDzhnfVKB+Ej+Jg40bDyEfnozgKN1TdBCgTRZZkkU6iZbXgQ6DqlhUo437U2QCCQ3HuXwjma5q6XEs3/SJIbxsQHG05nqs3ivosvmUL04Dr5Ttaz3LRHDq/SZgFKVsYiu2VxquihImkFGQv47zgelEb785orlnSwLdeqca3/3JZbXoDoy17rdXjNyhBRQxwgZLHzr1WOEb8c2ggU8PtL8sfjcW1Qhij29siU/LR8/uDF/1B/0V/QBBChLMBg2nNFlEccYu52c1H33sfg/b+H1O8FtPqFuqskgsxuMBgd5coVuMd2WyKu2XufFvSqREHN5kqRUoRZmS663I/vzit2BZjWsRR290htMs4mu8mZg6J6lQZLfhM4MR6GxcSpSXq5013+MkQNzg6WsbRYjd5i/+T5H1OmzfbTd23LhW4SpP+Hri+eL2Mo2w3rn+pk5W/I7JHr5arSzRKNDKL1R1wNVbp4qrSW8vmwMqMaA8NN8KSVhQparI47uurlaqhkZRkv1rX82OlBDK5QdG0MliMdJ1xZisZxSEeNMuQnJuVNeugm9oMDya0N1koK4Zr7jo3ZOnpEkdRF04mK156Q3g9iVaNdUk0qeCZW+/KlE6NP+uFb+LQs2ZBAOVoV3GwCgU3GCzmhXAZ9RkXgvCm67sL9T9n2tWcJASq67JaePdV8caHCdyCYVI7HQ3BROzCGybrdGU7LQh3d7UQOOlYLuHujnYV9RVdustlvGqgtVoN7l71LRoT5LetWXUTribWbY2p3pK5IkvGN4TQchMBXzdzVeoAhwy+5bJ7TyBXu/XJHLzHsLCLBOT/F+9c8dS5KvUnHGbndXb8gfJOjxd2DwQYTEsXMrakEiu5dPGlVWUDl8bq0juCkJa6KuaoqqQKrRI0phtqNzqQcuPT2xk24ceA0vjpDCbMWNQxlJJLi1qXBXmJ9wuvWvS7BZbkVfmqI2LWbgFqlxBQEZovmGrUiFUKoAKMoUYsGPh1+UpVr7VO+kaNGyRlN4KkHV2RSYgBFKiNklSvpvSUSf6jjyY6i08ZMpczJvxQfwY4BdwJH1K8bWSqu+zj339u4LXV5r+PmF+BpSlFP3dg6Dx/cvGN8/81FmIBVrUxInio/7x+yUY7rz5/O64846CQqbxKSePt98HhIf3XJqOqV4Rw9YIpE9q2SSnE4g9R/Olu+cPOg2/efCE/5A1k13zw4zy5HZzSFm2R6QcBBOOl1IIq9ohznbqIcp23XAou8api29Xg8PCqT7xdxtHRJvadqRxt5spTiIkzraiWrxBI8WirF8CmjEugq1T/htxErZV+2LZ5HGYPMeGoxYSX95lwIl2Q1NW0nqsblP9eSpvLW788oTrPnax4NRNxP8j1Ry1im+2eSINJqbldRMOLu2jeYQXv+P7hxeXyMo6IsYqCWYUyDmNms2gY9RqxLYP6lgJSBMEJbS2HhsmUYpj3DGlW8N5tP1rG6zM2mt1bR2PZedwEY9mUy+nDsy5XXDmjnfOb0+LNKqxQ8P9GiisE1jdHxREnicmQpWSoL+OIBOKbVSTwy2pbqxjdprBbQxmuBdKqOForNLauujcEuzbHuvovm1EmH0dyoaE6MrQp2FMTXoVv6uhNIyDTiMdcrIS7Dn1UkY++CxkMjo6cb/153zmhL147/+7o1fKy5epEUdudcZHadaM8itompvtumE0+X7JmRlSQ62u7dXeuX53brzHa/olyshI2sC4Gp9N727/vUKNIVF6XA1bDP/79Zzej2ninXP5AwfP3pYZCzVBPSl9WOBE452Ry0XjMXd/KZ0OWCzRGLIBsrSmV4/ucIxO1JZOwgo254KSTaJjyocqGWjNd+Hbl9T3TPgV7i4JUGbDSqpw5S6m2kmZK31BRPNWWw5iqgMmEQJkxmXhrxZ+2mAwJqlwnS7DQ3FBxsyasucdNSatZYiFnkk2RYMctLqUoyOI2oNWYMhtGidKbq5ZxobQPyjqCKFlkXAbiy3lBXS4YQHaexoy28jbYrIaKLVMEf5BCefyY/I6CcOEJOm+3lEJRJTv5HKUQUCi6ETgTZCo1caTpVjNp6CIPceCwBzXDgjmJJpRxfjBIO/yOyxtftdmBi1qYvsWx4Rbb2d91cXzenvMVt38px1TbrQy3Si9Ws6fcZuXYKcQmkPrDQ/oqPOeAhsJbwUhVYjZET1RiepSo7p2hJQkxvePTE3eJPoePP/0D3iHTEjI189KalBrFon454t8luJ33bKvvQOewsJIeN1gnpHJaOYfEwSheV97tY6dxgi4Y7zZytVzBA/iLCk1op9kfTyZpBZJi5kMGlQ5hBd+oQKg837yfnKG+5Ull4G3Z4Z4b3IviSPAEpcGGQXD81ek7uIUX3cMobtyIn7DbvXcnb778+uxLwoZOludYv3vYPXQha2VszmRjqTMUEzjzhsFajqa2kvavg/avg/avg/avg/avg/avg/avg/avg/avg/avg/avg/avg/avg363uub966D966D966D966DdDw72r4P2r4P2r4P2r4P2r4P2r4P2r4Me9TooZL5JI/YKwbhslPn4uoqL1ZuhyzjKqORieBHd3VGE/AMVBFLzDyVqqte4jKNbpjnFiFy1RlyVGlCW/QYp3/3Gh7w657Ry7LWRyzetFalQpYSfcZwkWNgHxzarQk7fn51HcVRVcOYqpTmazejNE5v5bHrgo6srYK6wXDA5LV3SP/IwqTqCMnjt0oobV1oRfjRqB5hcNDBs11x4MugvEbVxwt2dL9tYLuvxvmvrjMDYajTt3OVyufxfwpFlDQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.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:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},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}}, {{note}}.",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}}, {{note}}.",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)(g(),{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 f(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.2cfac16d.js b/assets/js/bbdfc22d.2cfac16d.js new file mode 100644 index 000000000..36b99121e --- /dev/null +++ b/assets/js/bbdfc22d.2cfac16d.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:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,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":"eJztO+1yHDeOr4LtuirHup6RNJYdn36dk/gS3/liVyxX6k7SKpxuzDStbrJDsjWaqKbqfuwb7Bvso+VJtgCSPd3zIckft6tUzR9pmgRJAARIAARuEiemNjk+TU6wqkvh0CbnaZKjzYysndQqOU5OCoTYDd8aFNQOL96+AlGWemahsWgsOA0ZdSJkjXW6kr+JcYng4sQpzAqZFWDRXCEIC+OywdpI5SxMtIEpKjTCSTWFXGdNhdQxk66A2mCOE6kwB+tMk7nGoB3C+1orsE2WobWTpmxX8mhIrVJwBTKiBl1jlAUBjZK/Ngh7exH6QuZ7e+AK4SATCsZI5ORETUAIO+iMBfVpxRPbGjM5kQQc5hqeqTN1IutjeF+XWuQw142Bt9/9RzsFzUttp3t73+G4mcL7V3t7518VztX2eH9f1PVQ16isnKpSjO0w09V+ToB1PnlMHESDNCvjisLKcg4iz2Em8yk6yxQryHQ9h0xrk0vlWV+LKYJqqjEam4JQOVTaIEgFAgyKfD5wetBYhP989+ZH2o5KuCG8LRubtsvl0mDmyrmfnjgQqXrkOfPsiPZHqmkKlbikjZQOfm1kdklkW1TM1rAnzKu9vXdNXWvjMIefPQnHe3vU8w2WegbCIMNnuqq0gloYUaFjaaMNo26DvzbSYO5FRZRl5MXxmRrQPs9rPN7bg1cqlxkxgyekVtCTADv0oMQkAn0XNtaDdlhHO++FmHgyE34/61JkHk2DJBNOXmF/4usU5jTxd6h0xKDQRv6mlRMlb8cVGiczUXa3jRBkQXPCsF7UWioXW8MK8D9he2j3eFOCXBFqOTGrkop7LMKVKBu0AatZCgVh9RPWBi3Ld5iXGKlyKFBOi63rifxDY11vYmgsodnFIqwVd4nZi8y2iSgtgpz0eFmJS+ysBpoPIVEO4Zs55DgRTelSkCRxzjQ4hB+1A1HXpcz4tKGDhJRH0Bkx4F0O4hAQUaLiPX5r9JXMkY6EXE4maEg5qZOnCGMidiRnNQ8g8lhzXCEUaLWy0ZkutVkXIW7u8xEyrRwqN4QXV0KWjLwn1oJUWdnkCONSZJcpn5MpGMy94s6RTt3UyzuD0GHqec78AYslSaFWhL/SYXlplyfWEE4KaZf6RJ2R1byItF2uBq2daFqZWBBVDLASskyZcSl80GNw0pWYksLWQs1TyIXDFBxeu7G+TiErMLvkX0bkUsO4cY4OalozN7rO9UwFXk60clb+tkEjY8/Hc3SUwlEKz1J4nsLhQQqHoxQOj1I4fJbC4fMURgcpjEYpjI5SGD3zaI2eB16LlsFdBA5Hnsvuj8NdOndfS8uaTQembc/gWe8MPhzC3l6rTdT2yy+/nKmbMwVwlpBynSXHcJa0IGdJ6vvozKS+w/B9TR9PRl+Hzzl9Phs9D58zBj08Cp8FfY4Oz9QiLHimRoyJE1V9CxbU/UUxCF9BiKiNF6W2eJ5RIx1EaeygverhQx2LLi1PiBappJOitNvJiRAPiKIlSmtEHRFRLK7bKeLuB0ROFx/q4WPSd/Gx2umKCs9YjNaofzoMN8t24v2yD4b2DjqfR/ozIp2OphM6mrbT355eD4gJqzh9Hie+HrIBwCfzdj4EgAfEhT5Gn8eD58QDupS2M4B6HxD1HXSoI9zwvu/gaHD4dDA6GB31OEC+kQeoqkGeD+bz+ZfgHtk8YXkyeaKF6i07ckMnRlcb3A/2DpZQwSbi39Fk/28y1MfRhsWc/L6+Bxs9vq6V7XQu5o+snyoObY0zgl+aZvMOmtxFeLD3mxVaZgF5gokm2ZgcvCHxYMCc3M/z/Q4nqTHPB1U1WGmkzwEzvtNYVcM8H65Aru2Ob6wgz1NYb97YnudQVdWWZt/ea96vqnUqhlUVcGPj69+GHH5gm227ngSAf5SqLDWiv/CtakSRA61KXpvduc16tHLZFFKFjiBUsAJgcNqUwuA1+aVWauWhv7yORRVbWvbsx7ILyFECzwr46k2w3h8H8ScS+hNQy93j1iijSV6EgBkYnOI11MI5NIonuxKlzH28bcANeC2qmlyA/T+fneX/+i/7HIAgH98B7QTkciopDrT/59MXg/893wDR1DWaTFiEEmklmwK6bAinBZb1MhQ1m82Gsyc2K7QufRzqgzU48X8v9PjDBaNbD4WtH2+i1ItGx+En0Vn19y26HseEhThyg8vPMsY6dHjAt23wd265bgPEA7pxVlCiTh89oe7Ts6QSbJCQKOPyt3YFmrPkvB3jnXzM7xh7fg9lLWSOpRhjud51b0Vrm0sx103Q7xjU6pMaJLrDN+qopGrjFkzOQdrpFNcrnb5vsUG/PUO62hmvnKiecQeglDZGbvrs7I4OoS0OOCr0oeExQhwA41ZKP1sLWsTupwb+JAp7d8cSBAcM2IYV42p3rNDbmC5jaI5KKlk1VRsfnbSzRpZVwfbo8otG0qNBXKG7u2sriOs7Vghh+y0LnKlDjmPE+MctlmmAeEBnxQpKt6vxp5wivXv6C12wdytgJKurgBuuZQL1F3KrfHa79g3hDV1vFJP1gyjKlmVYO4rIfa5qtijf+4bimFU3Drdd8rpQD0j6NqD1/yyBAe5L3z6fJKRd6v9AgtpD+97C6oOSlZje4rlz9wMSz4DPyuYmaaJrfkjW6lWeHCf+UTo+0SYpT43WfaPzeXJ8k4RnA/oZgvI0dP+Dpcfvm8RmBVaCfkWU6Ll8IkuaiiLfaGySJhxHordz4ldynOjxB8xckpKPU5MgoqU5eNzxTYTyz6VJGqIKyXHi31GTNAmWftsEqDJNvnudT5JFXPC2qdqW5VSWf7Tv1TQPvUh+4jQ8dLGSLvBJM3VnWCzZupxMGCPmyWpmQnyKjH6kH9e+tZTzqCTSkSq072MMlqSJdFh1V9myaUZ/PKcz1EQJx5g/dixvi6g+ek0aVxdafdLA8PSzgef35JLvXV+4v2Uv6JEL82hVD5avtSnwi8nwLomJ8EytmHbX9Dbi2pon217xO4+HttBNmdOzHAoz5Mf0T87T4FQYUWYNZ6O0l0OPshbVlrLDRZpc303MNWR6EFME4KsSJ8679JBpo9A87sYJHwxxo6OjRZrM7yZv/ock72vavNnd1P3MuRXLvJN/Bq5Pni/SpLgb1x/a7I9/IrJHzxbLu27lKr8Y63x+Ec+txV2A8VIhOMpFeqXemBxNhxFjrUsUao0TrybeutLwiEyRR6kPpPGjvTQ2Xigwk2UJBjOkBCCOr8ezCoLN4V/0ITykklH2khrYWLTN2BKUivNZP+EYwRk5nSIlOQUIHhzSElBwUp0K4T0xoYwDTlwyeCV1YyN6hbCcOVAi2aOuQOlzZaSa9o3DDnc4a6RL+7C7O9RCl5yiPIY3J2/vwUs2XQfgijYnwlPp54A3J28pFUpOghk2hPe25URkreiBAJlFcCVFTJdoz/a5Dz6gYo5oJraXtzYMSUgDWEcol3YjRqnPeqQ8jTbvcW3iZa4cbZFuHCXpyZABYh3WtsdHxqJl5Ilu7iOVd3BSwLThtx5HKhvzojjcu0xlksonVLLjkzcmZm8FsSBIyq5c8ilyhYA686eAyvrhAibCOjQppVoS501Djk07JV7XaCSqDDeywKBn3UVjNtpNfR7084Le//Q6ZEhGGqJSjkkD/cSYQ1Oz1LAmtPlqcedWSV8zlEg70FxsM9DWTQ/OKgsxtxqN1QooG8xMhZK/eRFmi0RbhDEWovSg4aiglzLChzS8j0w8a3//y986eG21ONcR8yuIPKfHiDswZMfWCzxZ3AZrOgF1HyOaD82/r14ChB0rzUWl81aR7P1l/C0/X9j2XHSak16xRJ+Wa5usIAO/PW9tGs9YG8xKmxJJ9MzA6bu6JnrxWlrXybiK76Lr58NPSHzMOjiwGUJaTTKv5l0Fb/EKmV3L6TgvTPaz9dprcE0XROP0hcFKqvvdU93ogNPtQdA4XQknM4hT2WE/B5MSRZd6XcFXETWSxiupzeMtqkrTXWiV4YVUF3iF5h4G3o9tHDcXcxJuN0NUXdwik/x1tsyTm1Fqc48nnduJs0G7WD69wx7wBsPSpw93GaXwamW9SzM6OKB/K5rTSzOnk61NQS/nf0rS+wcUbvenfDOFMNZ1ealy3xSjH2ytqqwgLavQ2r5LtGHIHQR0+SZVKRVeRKZcjA4OLp4S5xZpcrSJOe90ha5glaLDdGY0ZYPXJdJ7ozNzEFMhFdDy5gvyCo3R5naqPw6z25hwdHBwcdgy4ek6E14pfuXiyoMTfYnqH0tpd3nnlydUryu+Fvy9lUgPxP1Jj9huuyfSYtYY6ebJ8elNcj0QtRz4/uPT88U5SZ0rNIXaam0ZY+GK5DjZX4u8cekHxXVObxK+35PoO1ihcnqKWvMfRC33rw6TRbo6YqO3sRUam8HHDbBOTKWa3j7qfMmbd7R/fot6HFpGU2r5X0jhlLABXag0kSQ3BQo66InlJBY/LeOUL+PmxgjipqDgchNXw3wxytcL3K0ezBtCcZ1I3GkMg3Fkqw1sJUuCkjb4RD/bcNLpUlTbyE0M3BxyxGN0dMShga8P2Yd+8pzd06Nni3PP4I6rxpHgrr/h3x96hnNo6huSSbJiuPWsp1Xjaashs8WOCUuu3NctIpuuyacL2vSJZgkJ2/amRvWOXAnS3KvD9egBlpmu2oTxCP77X/7GI6KZwVj9icL6bxoDtZ6hofIoSgKflHgt6S4leKy4z3KElF8QRFWitRQ2VQ6nvvaJ8knIaQlmcSZqMZalpPOIwLTP8uocaXYIPxdIzzzU9cj49JorLOkYa62RTpUXzLS5nFAlWQoCxlRDQvYoqkKozJu+XsfYhKO6J3IraiMtlcYYwlp63LRyRmQOKqHElG2wtMelHEtJBxAYPSbP0Oqy8b6PE7LUxj/uM0H8hsNvIy+va+riyAc5DQYLkoqr4ADZ1DugXn1CcdWYfP2acJEZsh3YqFJTHRTFDJqyhFo778eTJdTFkYY7I5SlqIjHJe5By7Dgm6ANyfzvLdIOv5bq0ufuD+C0FaafcWylw35mz6pkP+6P+V66H5oxVQZpK5028+XoqXRFM+ZjsDtJ++Fn+j7WznWOueUcuc7shlCRzuw+JSHtv0NHEmL3X7x9xRfoY/j9//4Kr1EYBYWeeWnNGoPlfFmmx1VtvPOebe39x96vaKg0zrGQqmkMyBAHk3T1yO6rncEJGmK+7VUFilqG6U8jmtBPofp4MukmJikWGRsK8TgStdzoVFFxl30zeYfmSmYYbq8tO7zPwPtJmpQyQ2WxYwy8+P7ta7iCJ8ODJO3cg/fY7f3Xr759+eO7l4QNaZbn2OHwYHjA8XltXSVUZ6lvfYnoyfJqWnk9au2kXd3pru50V3e6qzvd1Z3u6k53dae7utNd3emu7nSNqF3d6a7udFd3uqs73dWd7upOd3Wnu7rTXd3pru50V3e6qzvd1Z3u6k53dae7utNd3emu7nRXd7qrO/2i4chtdachz4lsyv26FJIT60Ieu8+JO12tRj1Pk4KS5o5Pk5sbest8b8rFgpp/bThP6PQ8Ta6EkRSx53y7NKaJUWbVJc7pTd0/QAxOaP3UawNnDaykGVKWmx/xgrf9VthuXt/bN+9OkjQZh4rZSuc0xogZVdOKmU+vCtzkgknBtVClUNOGE70SP+fCJzUX/bS4S06LCz86+WJCzTsY9vPlPBn0l4jaOODmxqfcLRYtvO/aOiIwNkLT/p0vFou/A/N0Thg=","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),l=t(33617),a=t.n(l),o=t(17543),d=t.n(o),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:"eJztO+1yHDeOr4LtuirHup6RNJYdn36dk/gS3/liVyxX6k7SKpxuzDStbrJDsjWaqKbqfuwb7Bvso+VJtgCSPd3zIckft6tUzR9pmgRJAARIAARuEiemNjk+TU6wqkvh0CbnaZKjzYysndQqOU5OCoTYDd8aFNQOL96+AlGWemahsWgsOA0ZdSJkjXW6kr+JcYng4sQpzAqZFWDRXCEIC+OywdpI5SxMtIEpKjTCSTWFXGdNhdQxk66A2mCOE6kwB+tMk7nGoB3C+1orsE2WobWTpmxX8mhIrVJwBTKiBl1jlAUBjZK/Ngh7exH6QuZ7e+AK4SATCsZI5ORETUAIO+iMBfVpxRPbGjM5kQQc5hqeqTN1IutjeF+XWuQw142Bt9/9RzsFzUttp3t73+G4mcL7V3t7518VztX2eH9f1PVQ16isnKpSjO0w09V+ToB1PnlMHESDNCvjisLKcg4iz2Em8yk6yxQryHQ9h0xrk0vlWV+LKYJqqjEam4JQOVTaIEgFAgyKfD5wetBYhP989+ZH2o5KuCG8LRubtsvl0mDmyrmfnjgQqXrkOfPsiPZHqmkKlbikjZQOfm1kdklkW1TM1rAnzKu9vXdNXWvjMIefPQnHe3vU8w2WegbCIMNnuqq0gloYUaFjaaMNo26DvzbSYO5FRZRl5MXxmRrQPs9rPN7bg1cqlxkxgyekVtCTADv0oMQkAn0XNtaDdlhHO++FmHgyE34/61JkHk2DJBNOXmF/4usU5jTxd6h0xKDQRv6mlRMlb8cVGiczUXa3jRBkQXPCsF7UWioXW8MK8D9he2j3eFOCXBFqOTGrkop7LMKVKBu0AatZCgVh9RPWBi3Ld5iXGKlyKFBOi63rifxDY11vYmgsodnFIqwVd4nZi8y2iSgtgpz0eFmJS+ysBpoPIVEO4Zs55DgRTelSkCRxzjQ4hB+1A1HXpcz4tKGDhJRH0Bkx4F0O4hAQUaLiPX5r9JXMkY6EXE4maEg5qZOnCGMidiRnNQ8g8lhzXCEUaLWy0ZkutVkXIW7u8xEyrRwqN4QXV0KWjLwn1oJUWdnkCONSZJcpn5MpGMy94s6RTt3UyzuD0GHqec78AYslSaFWhL/SYXlplyfWEE4KaZf6RJ2R1byItF2uBq2daFqZWBBVDLASskyZcSl80GNw0pWYksLWQs1TyIXDFBxeu7G+TiErMLvkX0bkUsO4cY4OalozN7rO9UwFXk60clb+tkEjY8/Hc3SUwlEKz1J4nsLhQQqHoxQOj1I4fJbC4fMURgcpjEYpjI5SGD3zaI2eB16LlsFdBA5Hnsvuj8NdOndfS8uaTQembc/gWe8MPhzC3l6rTdT2yy+/nKmbMwVwlpBynSXHcJa0IGdJ6vvozKS+w/B9TR9PRl+Hzzl9Phs9D58zBj08Cp8FfY4Oz9QiLHimRoyJE1V9CxbU/UUxCF9BiKiNF6W2eJ5RIx1EaeygverhQx2LLi1PiBappJOitNvJiRAPiKIlSmtEHRFRLK7bKeLuB0ROFx/q4WPSd/Gx2umKCs9YjNaofzoMN8t24v2yD4b2DjqfR/ozIp2OphM6mrbT355eD4gJqzh9Hie+HrIBwCfzdj4EgAfEhT5Gn8eD58QDupS2M4B6HxD1HXSoI9zwvu/gaHD4dDA6GB31OEC+kQeoqkGeD+bz+ZfgHtk8YXkyeaKF6i07ckMnRlcb3A/2DpZQwSbi39Fk/28y1MfRhsWc/L6+Bxs9vq6V7XQu5o+snyoObY0zgl+aZvMOmtxFeLD3mxVaZgF5gokm2ZgcvCHxYMCc3M/z/Q4nqTHPB1U1WGmkzwEzvtNYVcM8H65Aru2Ob6wgz1NYb97YnudQVdWWZt/ea96vqnUqhlUVcGPj69+GHH5gm227ngSAf5SqLDWiv/CtakSRA61KXpvduc16tHLZFFKFjiBUsAJgcNqUwuA1+aVWauWhv7yORRVbWvbsx7ILyFECzwr46k2w3h8H8ScS+hNQy93j1iijSV6EgBkYnOI11MI5NIonuxKlzH28bcANeC2qmlyA/T+fneX/+i/7HIAgH98B7QTkciopDrT/59MXg/893wDR1DWaTFiEEmklmwK6bAinBZb1MhQ1m82Gsyc2K7QufRzqgzU48X8v9PjDBaNbD4WtH2+i1ItGx+En0Vn19y26HseEhThyg8vPMsY6dHjAt23wd265bgPEA7pxVlCiTh89oe7Ts6QSbJCQKOPyt3YFmrPkvB3jnXzM7xh7fg9lLWSOpRhjud51b0Vrm0sx103Q7xjU6pMaJLrDN+qopGrjFkzOQdrpFNcrnb5vsUG/PUO62hmvnKiecQeglDZGbvrs7I4OoS0OOCr0oeExQhwA41ZKP1sLWsTupwb+JAp7d8cSBAcM2IYV42p3rNDbmC5jaI5KKlk1VRsfnbSzRpZVwfbo8otG0qNBXKG7u2sriOs7Vghh+y0LnKlDjmPE+MctlmmAeEBnxQpKt6vxp5wivXv6C12wdytgJKurgBuuZQL1F3KrfHa79g3hDV1vFJP1gyjKlmVYO4rIfa5qtijf+4bimFU3Drdd8rpQD0j6NqD1/yyBAe5L3z6fJKRd6v9AgtpD+97C6oOSlZje4rlz9wMSz4DPyuYmaaJrfkjW6lWeHCf+UTo+0SYpT43WfaPzeXJ8k4RnA/oZgvI0dP+Dpcfvm8RmBVaCfkWU6Ll8IkuaiiLfaGySJhxHordz4ldynOjxB8xckpKPU5MgoqU5eNzxTYTyz6VJGqIKyXHi31GTNAmWftsEqDJNvnudT5JFXPC2qdqW5VSWf7Tv1TQPvUh+4jQ8dLGSLvBJM3VnWCzZupxMGCPmyWpmQnyKjH6kH9e+tZTzqCTSkSq072MMlqSJdFh1V9myaUZ/PKcz1EQJx5g/dixvi6g+ek0aVxdafdLA8PSzgef35JLvXV+4v2Uv6JEL82hVD5avtSnwi8nwLomJ8EytmHbX9Dbi2pon217xO4+HttBNmdOzHAoz5Mf0T87T4FQYUWYNZ6O0l0OPshbVlrLDRZpc303MNWR6EFME4KsSJ8679JBpo9A87sYJHwxxo6OjRZrM7yZv/ock72vavNnd1P3MuRXLvJN/Bq5Pni/SpLgb1x/a7I9/IrJHzxbLu27lKr8Y63x+Ec+txV2A8VIhOMpFeqXemBxNhxFjrUsUao0TrybeutLwiEyRR6kPpPGjvTQ2Xigwk2UJBjOkBCCOr8ezCoLN4V/0ITykklH2khrYWLTN2BKUivNZP+EYwRk5nSIlOQUIHhzSElBwUp0K4T0xoYwDTlwyeCV1YyN6hbCcOVAi2aOuQOlzZaSa9o3DDnc4a6RL+7C7O9RCl5yiPIY3J2/vwUs2XQfgijYnwlPp54A3J28pFUpOghk2hPe25URkreiBAJlFcCVFTJdoz/a5Dz6gYo5oJraXtzYMSUgDWEcol3YjRqnPeqQ8jTbvcW3iZa4cbZFuHCXpyZABYh3WtsdHxqJl5Ilu7iOVd3BSwLThtx5HKhvzojjcu0xlksonVLLjkzcmZm8FsSBIyq5c8ilyhYA686eAyvrhAibCOjQppVoS501Djk07JV7XaCSqDDeywKBn3UVjNtpNfR7084Le//Q6ZEhGGqJSjkkD/cSYQ1Oz1LAmtPlqcedWSV8zlEg70FxsM9DWTQ/OKgsxtxqN1QooG8xMhZK/eRFmi0RbhDEWovSg4aiglzLChzS8j0w8a3//y986eG21ONcR8yuIPKfHiDswZMfWCzxZ3AZrOgF1HyOaD82/r14ChB0rzUWl81aR7P1l/C0/X9j2XHSak16xRJ+Wa5usIAO/PW9tGs9YG8xKmxJJ9MzA6bu6JnrxWlrXybiK76Lr58NPSHzMOjiwGUJaTTKv5l0Fb/EKmV3L6TgvTPaz9dprcE0XROP0hcFKqvvdU93ogNPtQdA4XQknM4hT2WE/B5MSRZd6XcFXETWSxiupzeMtqkrTXWiV4YVUF3iF5h4G3o9tHDcXcxJuN0NUXdwik/x1tsyTm1Fqc48nnduJs0G7WD69wx7wBsPSpw93GaXwamW9SzM6OKB/K5rTSzOnk61NQS/nf0rS+wcUbvenfDOFMNZ1ealy3xSjH2ytqqwgLavQ2r5LtGHIHQR0+SZVKRVeRKZcjA4OLp4S5xZpcrSJOe90ha5glaLDdGY0ZYPXJdJ7ozNzEFMhFdDy5gvyCo3R5naqPw6z25hwdHBwcdgy4ek6E14pfuXiyoMTfYnqH0tpd3nnlydUryu+Fvy9lUgPxP1Jj9huuyfSYtYY6ebJ8elNcj0QtRz4/uPT88U5SZ0rNIXaam0ZY+GK5DjZX4u8cekHxXVObxK+35PoO1ihcnqKWvMfRC33rw6TRbo6YqO3sRUam8HHDbBOTKWa3j7qfMmbd7R/fot6HFpGU2r5X0jhlLABXag0kSQ3BQo66InlJBY/LeOUL+PmxgjipqDgchNXw3wxytcL3K0ezBtCcZ1I3GkMg3Fkqw1sJUuCkjb4RD/bcNLpUlTbyE0M3BxyxGN0dMShga8P2Yd+8pzd06Nni3PP4I6rxpHgrr/h3x96hnNo6huSSbJiuPWsp1Xjaashs8WOCUuu3NctIpuuyacL2vSJZgkJ2/amRvWOXAnS3KvD9egBlpmu2oTxCP77X/7GI6KZwVj9icL6bxoDtZ6hofIoSgKflHgt6S4leKy4z3KElF8QRFWitRQ2VQ6nvvaJ8knIaQlmcSZqMZalpPOIwLTP8uocaXYIPxdIzzzU9cj49JorLOkYa62RTpUXzLS5nFAlWQoCxlRDQvYoqkKozJu+XsfYhKO6J3IraiMtlcYYwlp63LRyRmQOKqHElG2wtMelHEtJBxAYPSbP0Oqy8b6PE7LUxj/uM0H8hsNvIy+va+riyAc5DQYLkoqr4ADZ1DugXn1CcdWYfP2acJEZsh3YqFJTHRTFDJqyhFo778eTJdTFkYY7I5SlqIjHJe5By7Dgm6ANyfzvLdIOv5bq0ufuD+C0FaafcWylw35mz6pkP+6P+V66H5oxVQZpK5028+XoqXRFM+ZjsDtJ++Fn+j7WznWOueUcuc7shlCRzuw+JSHtv0NHEmL3X7x9xRfoY/j9//4Kr1EYBYWeeWnNGoPlfFmmx1VtvPOebe39x96vaKg0zrGQqmkMyBAHk3T1yO6rncEJGmK+7VUFilqG6U8jmtBPofp4MukmJikWGRsK8TgStdzoVFFxl30zeYfmSmYYbq8tO7zPwPtJmpQyQ2WxYwy8+P7ta7iCJ8ODJO3cg/fY7f3Xr759+eO7l4QNaZbn2OHwYHjA8XltXSVUZ6lvfYnoyfJqWnk9au2kXd3pru50V3e6qzvd1Z3u6k53dae7utNd3emu7nSNqF3d6a7udFd3uqs73dWd7upOd3Wnu7rTXd3pru50V3e6qzvd1Z3u6k53dae7utNd3emu7nRXd7qrO/2i4chtdachz4lsyv26FJIT60Ieu8+JO12tRj1Pk4KS5o5Pk5sbest8b8rFgpp/bThP6PQ8Ta6EkRSx53y7NKaJUWbVJc7pTd0/QAxOaP3UawNnDaykGVKWmx/xgrf9VthuXt/bN+9OkjQZh4rZSuc0xogZVdOKmU+vCtzkgknBtVClUNOGE70SP+fCJzUX/bS4S06LCz86+WJCzTsY9vPlPBn0l4jaOODmxqfcLRYtvO/aOiIwNkLT/p0vFou/A/N0Thg=",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,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:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\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 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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.666e8e27.js b/assets/js/bbdfc22d.666e8e27.js deleted file mode 100644 index 97185f055..000000000 --- a/assets/js/bbdfc22d.666e8e27.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":"eJztO9tyHLeOv4LTtVWOtT0jaSw7Xj2tk3gT73pjVyxXalfSUTjdmGla3WSHZGs0UU3VPpw/2D84n5Yv2QJI9nTPRZIvm6NUzYutaYIkAAIgAAI3iRNTmxyfJidY1aVwaJPzNMnRZkbWTmqVHCcnBUIchm8NCvoOL96+AlGWemahsWgsOA0ZDSJkjXW6kr+JcYng4sIpzAqZFWDRXCEIC+OywdpI5SxMtIEpKjTCSTWFXGdNhTQwk66A2mCOE6kwB+tMk7nGoB3C+1orsE2WobWTpmx38mhIrVJwBTKiBl1jlAUBjZK/Ngh7exH6QuZ7e+AK4SATCsZI5ORETUAIO+iMBY1pxQvbGjM5kQQc1hqeqTN1IutjeF+XWuQw142Bt9/9W7sErUvfTvf2vsNxM4X3r/b2zr8qnKvt8f6+qOuhrlFZOVWlGNthpqv9nADrfPKYOIgGaVXGFYWV5RxEnsNM5lN0lilWkOl6DpnWJpfKs74WUwTVVGM0NgWhcqi0QZAKBBgU+Xzg9KCxCP/+7s2PdByVcEN4WzY2bbfLpcHMlXO/PHEgUvXIc+bZEZ2PVNMUKnFJBykd/NrI7JLItqiYreFMmFd7e++autbGYQ4/exKO9/Zo5Bss9QyEQYbPdFVpBbUwokLH0kYHRsMGf22kwdyLiijLyIvjMzWgc57XeLy3B69ULjNiBi9IX0FPAuzQgxKTCPRdOFgP2mEdnbwXYuLJTPjzrEuReTQNkkw4eYX9ha9TmNPC36HSEYNCG/mbVk6UfBxXaJzMRNk9NkKQBc0Jw3pRa6lc/Bp2gP8Kx0Onx4cS5IpQy4lZlVQ8YhGuRNmgDVjNUigIq5+wNmhZvsO6xEiVQ4FyWmzdT+QfGut6C0NjCc0uFmGveErMXmS2TURpEeSkx8tKXGJnN9BshEQ5hG/mkONENKVLQZLEOdPgEH7UDkRdlzJja0OGhJRHkI0Y8CkHcQiIKFHxGb81+krmSCYhl5MJGlJOGuQlwpyIHclZzROIPNYcVwgFWq0cdKZLbdZFiD/3+QiZVg6VG8KLKyFLRt4Ta0GqrGxyhHEpssuU7WQKBnOvuHMkq5t6eWcQMqae58wfsFiSFGpF+Csdtpd2abGGcFJIu9QnGoys5k2k7XI1aO1E087EgqhigJWQZcqMS+GDHoOTrsSUFLYWap5CLhym4PDajfV1ClmB2SX/ZUQuNYwb58hQ05650XWuZyrwcqKVs/K3DRoZRz6eo6MUjlJ4lsLzFA4PUjgcpXB4lMLhsxQOn6cwOkhhNEphdJTC6JlHa/Q88Fq0DO4icDjyXHZ/Hu6S3X0tLWs2GUzb2uBZzwYfDmFvr9Um+vbLL7+cqZszBXCWkHKdJcdwlrQgZ0nqx8hm0thh+H1NP56Mvg4/5/Tz2eh5+Dlj0MOj8LOgn6PDM7UIG56pEWPiRFXfggUNf1EMwq8gRPSNN6Vv0Z7RRzJEaRygs+rhQwOLLi1PiBappJOitNvJiRAPiKIlSmtEHRFRLK7bKeLhB0ROFx8aYTPph9isdoaiwjMWozXqnw7DzbKdeL/tg6G9g87nkf6MSCfTdEKmaTv9rfV6QExYxenzOPH1kB0Atszb+RAAHhAX+hh9Hg+eEw/oUtrOABp9QNR30KGBcMP7sYOjweHTwehgdNTjAMVGHqCqBnk+mM/nX4J75POE7cnliR6q9+woDJ0YXW0IPzg6WEIFn4j/ji77f5KjPo4+LOYU9/Uj2Bjxdb1sp3Mxf2T9UnFq65wR/NI1m3fQ5CHCg6PfrNAyC8gTTHTJxhTgDYkHA+bkfp7vdzhJH/N8UFWDlY/0c8CM73ysqmGeD1cg107Hf6wgz1NY/7zxe55DVVVbPvvvZwm7VP8y5KQCe2LbpT8A/FEKsJTz/sa3KgflA7QqeW8O0jZrx8oVUkgVBoKowAqAwWlTCoPXFG1aqZWH/vKaExVn6a9zdMqBHcf+nhXw1Zvgkz8OQk0k9BegL3fPW6OMFnkR0mBgcIrXUAvn0Che7EqUMvdZtAF/wGtR1eTY7//17Cz/53/a57QCRe4O6CQgl1NJ2Z39v56+GPz3+QaIpq7RZMIilEg72RTQZUM4LbCslwmm2Ww2nD2xWaF16bNLH6zBif/3Qo8/XDC69VDY+vEmSr1odMJ4Ep3VKN6i63FMWIgzNwTyLGOsQ4cHfIeGKOaWSzRAPKB7ZAUlGvQ5ERo+PUsqwW4GiTIu/9auQHOWnLdzfOiO+R1zz++hrIXMsRRjLNeH7q1oXVqCyHYYQwOVVG26gfE9SDuD4npl0I8tNiiwp7irfvGmiPoXWQyltDHh0udXd3bISHGeUKHP6I4R4gQYt2L42WLeInY/OfemJhzOHVsQHDBgmw2Mu92xQ+9guoyhNSqpZNVUbVpz0q4aWVYFl6HLL5pJuf64Q/d013YQ13fsELLtWzY4U4ecfohpi1scygDxgIzBCkq36+mnmIneRfyFbtC7FTCS1VXADfcugfobt1U+u137hvCG7i9KpfpJlBzLMqwdJdI+VzVblO99BXGqqZs+2y55XagHJH0b0Pp/lsAA98dIYZe8P5Ek9tC+tzT6ZGElprdE1Dz8gOQv4LNyuEma6JofeLV6lSfHiX8sjk+nScpLo3Xf6HyeHN8kIZ1Pf4ZkOU3d/2DpUfomsVmBlaC/Ikr0jD2RJS1FGWk0NkkTzu/QmzbxKzlO9PgDZi5JKUqp6c0NLa3B845vIpR/xkzSEO0nx4l/30zSJPjq7SdAlWmKqet8kizihrct1X5ZLmX5j/Ydmdahl8JPXIanLlae8T9ppe4KiyVbl4sJY8Q8Wa0YiE+EMRL089o3kHIelUQ6UoX23YrBkjSRDqvuLlsOzeiP53SGmijh3O/HzuVjEdVH70nz6kKrT5oYnmQ28PyeXPKj6xv3j+wFPT5hHt3mwfIVNQV+yRjeJTERnqkV0+6e3glc2/Nk2+t651HPFropc3ouQ2GG/Mj9yfUTXKIiyqzhKpH2cuhR1qLaUna4SJPru4m5hkwP4tM9fFXixPmgHDJtFJrH3fzdgyFudHS0SJP53eTN/5TkfU2HN7ubup+55mFZD/KPwPXJ80WaFHfj+kNblfEPRPbo2WJ5161c5Rdjnc8vot1a3AUYLxWCoxqhV+qNydF0GDHWukSh1jjxauK9Kw2PyBV5lPpUGD+mS2PjhQIzWZZgMEMqzOG8d7RVEHwO/9IO4YGTnLKX9IGdRduMLUGpuJ71C44RnJHTKVLxUYDgyaFcAAUXu6mQoBMTqgTggiKDV1I3NqJXCMsv+iWSP+oKlL6GRapp3znscIerObq0D7unQ1/oklNUX/Dm5O09eMmu6wBc0dYqeCr9GvDm5C2VKMlJcMOG8N62nIisFT0QILcIrqSIZQytbZ/77AIq5ohmYnv1ZMNQHDSAdYRyaTdilPpqRKqfaOsR1xZe1rDREenGUfGcDJUZ1mFte3xkLFpGnujmPlJ5BycFTBt+g3GksrFeiRO2yxIjqXyhIwc+eWNiVVUQC4KkqsclnyJXCKizfgqorJ8uYCKsQ5NSCSRx3jQU2LRL4nWNRqLKcCMLDHrWXTRmo9/U50G/Xuf9T69D5WKkISrlmDTQL4w5NDVLDWtCW0cWT26V9DVHibQDzcU2B23d9eBqr5BUq9FYrYCqtMxUKPmbF2H2SLRFGGMhSg8aTAW9YBE+pOF9ZKKt/f1vf+/gtdXjXEfM7yDynJ4T7sCQA1sv8ORxG6zJAuo+RrQemn9dvQQIO1aai0rnrSLZ+8v4W36AsK1ddJqLUbFEXy5rm6wgB7+1tzaNNtYGt9KmRBI9FHBZra6JXryW1nUqoeJ75bp9+AmJj1kHB3ZDSKtJ5tW8q+AtXqHiarkc12vJfhVdew2u6YJonL4wWEl1v3uqmx1wujUEjdOVcDKDuJQd9msjqYBzqdcVfBVRI2m8kto83qKqtNyFVhleSHWBV2ju4eD92CZqczEn4XYzRNXFLTLJX2fL+rUZlRz3eNK5nbhKs4vl0zv8Ae8wLGP6cJdRaa1W1oc0o4MD+m9Fc3rl32TZ2tLwcv6XJL1/QuH2eMp/phTGui4vVe6bYvSDrVWVFaRlFVrbD4k2TLmDgC7fpCqlwovIlIvRwcHFU+LcIk2ONjHnna7QFaxSZExnRlOVdl0ivRg6MwcxFVIBbW++IK/QGG1up/rjMLuNCUcHBxeHLROerjPhleJnLO4IONGXqP5YSrvbO789oXpd8bXg761EeiAeT3rEdr97Ii1mjZFunhyf3iTXA1HLgR8/Pj1fnJPUuUJTqq3WljEWrkiOk/21zBu3ZFBe5/Qm4fs9ibGDFSqnt6a1+EHUcv/qMFmkqzM2RhtbobEZfNwE68RUqunts86XvHlH5+ePqMehZTallv+BlE4JB9CFShNJclOgIENPLCex+GmZp3wZDzdmEDclBZeHuJrmi1m+XuJu1TBvSMV1MnGnMQ3Gma02sZUsCUra5BP92aaTTpei2mZuYuLmkDMeo6MjTg18fcgx9JPnHJ4ePVucewZ3QjXOBHfjDf/A0HOcw6e+I5kkK45bz3tadZ62OjJb/Jiw5cp93SKy6Zp8uqBDn2iWkHBsb2pU7yiUIM29OlzPHmCZ6aot5I7gv//t7zwjuhmM1V8orf+mMVDrGRpqW6Li7EmJ15LuUoLHiscsZ0j5BUFUJVpLaVPlcOp7kqgihIKW4BZnohZjWUqyRwSmffVVx6TZIfxcIL3j0NAj4wtkrrAkM9Z6I53uK5hpczmhDq8UBIypt4P8UVSFUJl3fb2OsQtH/UgUVtRGWmpZMYS19Lhp5YzIHFRCiSn7YGmPSzmWkgwQGD2myNDqsvGxjxOy1Ma/3jNB/IbDbyMvr2sa4swHBQ0GC5KKqxAA2dQHoF59QtPTmGL9mnCRGbIf2KhSU38S5QyasoRaOx/HkyfUxZGmOyOUpayIxyWeQcuwEJugDUX27y3SCb+W6tLX1A/gtBWmn3FspcN+bc6qZD/uz/leuh+aMXXsaCudNvPl7Kl0RTNmM9hdpP3hV/o+9rR1zNxyjVxndkOqSGd2n8qI9t+hIwmx+y/evuIL9DH8/j//C69RGAWFnnlpzRqD5XzZPsfdZnzynm3t/cfRr2ioZc2xkKppTMgQB5N01WT31c7gBA0x3/a69UQtw/KnEU3oF0F9PJl0E5MUi4wdhWiORC03BlXUdGXfTN6huZIZhttrywnvM/B+kialzFBZ7DgDL75/+xqu4MnwIEk79+A9Tnv/9atvX/747iVhQ5rlOXY4PBgecH5eW1cJ1dnqW9+6ebK8mlZej1o/adcPuusH3fWD7vpBd/2gu37QXT/orh901w+66wddI2rXD7rrB931g+76QXf9oLt+0F0/6K4fdNcPuusH3fWD7vpBd/2gu37QXT/orh901w/6x0nfrh/0IUrirh801h+RV7hfl0JywVuoL/e1aqerXaLnaVJQMdvxaXJzQ2+M7025WNDnXxuu3zk9T5MrYSRl0rkOLo3lW1TxdIlzeuv2DwODE9o/9eLOr/kr5X9UfeZnvOBjvxW2W2/39s27kyRNxqGTtdI5zTFiRl2uYubLngI3uZFRcI9SKdS04QKsxK+58MXGRb9c7ZLL1cIfnTouoeYdDPt1bJ4M+peI2jjh5saXwi0WLbwf2jojMDZC0/mdLxaL/wM4dQ2Q","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),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"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:"eJztO9tyHLeOv4LTtVWOtT0jaSw7Xj2tk3gT73pjVyxXalfSUTjdmGla3WSHZGs0UU3VPpw/2D84n5Yv2QJI9nTPRZIvm6NUzYutaYIkAAIgAAI3iRNTmxyfJidY1aVwaJPzNMnRZkbWTmqVHCcnBUIchm8NCvoOL96+AlGWemahsWgsOA0ZDSJkjXW6kr+JcYng4sIpzAqZFWDRXCEIC+OywdpI5SxMtIEpKjTCSTWFXGdNhTQwk66A2mCOE6kwB+tMk7nGoB3C+1orsE2WobWTpmx38mhIrVJwBTKiBl1jlAUBjZK/Ngh7exH6QuZ7e+AK4SATCsZI5ORETUAIO+iMBY1pxQvbGjM5kQQc1hqeqTN1IutjeF+XWuQw142Bt9/9W7sErUvfTvf2vsNxM4X3r/b2zr8qnKvt8f6+qOuhrlFZOVWlGNthpqv9nADrfPKYOIgGaVXGFYWV5RxEnsNM5lN0lilWkOl6DpnWJpfKs74WUwTVVGM0NgWhcqi0QZAKBBgU+Xzg9KCxCP/+7s2PdByVcEN4WzY2bbfLpcHMlXO/PHEgUvXIc+bZEZ2PVNMUKnFJBykd/NrI7JLItqiYreFMmFd7e++autbGYQ4/exKO9/Zo5Bss9QyEQYbPdFVpBbUwokLH0kYHRsMGf22kwdyLiijLyIvjMzWgc57XeLy3B69ULjNiBi9IX0FPAuzQgxKTCPRdOFgP2mEdnbwXYuLJTPjzrEuReTQNkkw4eYX9ha9TmNPC36HSEYNCG/mbVk6UfBxXaJzMRNk9NkKQBc0Jw3pRa6lc/Bp2gP8Kx0Onx4cS5IpQy4lZlVQ8YhGuRNmgDVjNUigIq5+wNmhZvsO6xEiVQ4FyWmzdT+QfGut6C0NjCc0uFmGveErMXmS2TURpEeSkx8tKXGJnN9BshEQ5hG/mkONENKVLQZLEOdPgEH7UDkRdlzJja0OGhJRHkI0Y8CkHcQiIKFHxGb81+krmSCYhl5MJGlJOGuQlwpyIHclZzROIPNYcVwgFWq0cdKZLbdZFiD/3+QiZVg6VG8KLKyFLRt4Ta0GqrGxyhHEpssuU7WQKBnOvuHMkq5t6eWcQMqae58wfsFiSFGpF+Csdtpd2abGGcFJIu9QnGoys5k2k7XI1aO1E087EgqhigJWQZcqMS+GDHoOTrsSUFLYWap5CLhym4PDajfV1ClmB2SX/ZUQuNYwb58hQ05650XWuZyrwcqKVs/K3DRoZRz6eo6MUjlJ4lsLzFA4PUjgcpXB4lMLhsxQOn6cwOkhhNEphdJTC6JlHa/Q88Fq0DO4icDjyXHZ/Hu6S3X0tLWs2GUzb2uBZzwYfDmFvr9Um+vbLL7+cqZszBXCWkHKdJcdwlrQgZ0nqx8hm0thh+H1NP56Mvg4/5/Tz2eh5+Dlj0MOj8LOgn6PDM7UIG56pEWPiRFXfggUNf1EMwq8gRPSNN6Vv0Z7RRzJEaRygs+rhQwOLLi1PiBappJOitNvJiRAPiKIlSmtEHRFRLK7bKeLhB0ROFx8aYTPph9isdoaiwjMWozXqnw7DzbKdeL/tg6G9g87nkf6MSCfTdEKmaTv9rfV6QExYxenzOPH1kB0Atszb+RAAHhAX+hh9Hg+eEw/oUtrOABp9QNR30KGBcMP7sYOjweHTwehgdNTjAMVGHqCqBnk+mM/nX4J75POE7cnliR6q9+woDJ0YXW0IPzg6WEIFn4j/ji77f5KjPo4+LOYU9/Uj2Bjxdb1sp3Mxf2T9UnFq65wR/NI1m3fQ5CHCg6PfrNAyC8gTTHTJxhTgDYkHA+bkfp7vdzhJH/N8UFWDlY/0c8CM73ysqmGeD1cg107Hf6wgz1NY/7zxe55DVVVbPvvvZwm7VP8y5KQCe2LbpT8A/FEKsJTz/sa3KgflA7QqeW8O0jZrx8oVUkgVBoKowAqAwWlTCoPXFG1aqZWH/vKaExVn6a9zdMqBHcf+nhXw1Zvgkz8OQk0k9BegL3fPW6OMFnkR0mBgcIrXUAvn0Che7EqUMvdZtAF/wGtR1eTY7//17Cz/53/a57QCRe4O6CQgl1NJ2Z39v56+GPz3+QaIpq7RZMIilEg72RTQZUM4LbCslwmm2Ww2nD2xWaF16bNLH6zBif/3Qo8/XDC69VDY+vEmSr1odMJ4Ep3VKN6i63FMWIgzNwTyLGOsQ4cHfIeGKOaWSzRAPKB7ZAUlGvQ5ERo+PUsqwW4GiTIu/9auQHOWnLdzfOiO+R1zz++hrIXMsRRjLNeH7q1oXVqCyHYYQwOVVG26gfE9SDuD4npl0I8tNiiwp7irfvGmiPoXWQyltDHh0udXd3bISHGeUKHP6I4R4gQYt2L42WLeInY/OfemJhzOHVsQHDBgmw2Mu92xQ+9guoyhNSqpZNVUbVpz0q4aWVYFl6HLL5pJuf64Q/d013YQ13fsELLtWzY4U4ecfohpi1scygDxgIzBCkq36+mnmIneRfyFbtC7FTCS1VXADfcugfobt1U+u137hvCG7i9KpfpJlBzLMqwdJdI+VzVblO99BXGqqZs+2y55XagHJH0b0Pp/lsAA98dIYZe8P5Ek9tC+tzT6ZGElprdE1Dz8gOQv4LNyuEma6JofeLV6lSfHiX8sjk+nScpLo3Xf6HyeHN8kIZ1Pf4ZkOU3d/2DpUfomsVmBlaC/Ikr0jD2RJS1FGWk0NkkTzu/QmzbxKzlO9PgDZi5JKUqp6c0NLa3B845vIpR/xkzSEO0nx4l/30zSJPjq7SdAlWmKqet8kizihrct1X5ZLmX5j/Ydmdahl8JPXIanLlae8T9ppe4KiyVbl4sJY8Q8Wa0YiE+EMRL089o3kHIelUQ6UoX23YrBkjSRDqvuLlsOzeiP53SGmijh3O/HzuVjEdVH70nz6kKrT5oYnmQ28PyeXPKj6xv3j+wFPT5hHt3mwfIVNQV+yRjeJTERnqkV0+6e3glc2/Nk2+t651HPFropc3ouQ2GG/Mj9yfUTXKIiyqzhKpH2cuhR1qLaUna4SJPru4m5hkwP4tM9fFXixPmgHDJtFJrH3fzdgyFudHS0SJP53eTN/5TkfU2HN7ubup+55mFZD/KPwPXJ80WaFHfj+kNblfEPRPbo2WJ5161c5Rdjnc8vot1a3AUYLxWCoxqhV+qNydF0GDHWukSh1jjxauK9Kw2PyBV5lPpUGD+mS2PjhQIzWZZgMEMqzOG8d7RVEHwO/9IO4YGTnLKX9IGdRduMLUGpuJ71C44RnJHTKVLxUYDgyaFcAAUXu6mQoBMTqgTggiKDV1I3NqJXCMsv+iWSP+oKlL6GRapp3znscIerObq0D7unQ1/oklNUX/Dm5O09eMmu6wBc0dYqeCr9GvDm5C2VKMlJcMOG8N62nIisFT0QILcIrqSIZQytbZ/77AIq5ohmYnv1ZMNQHDSAdYRyaTdilPpqRKqfaOsR1xZe1rDREenGUfGcDJUZ1mFte3xkLFpGnujmPlJ5BycFTBt+g3GksrFeiRO2yxIjqXyhIwc+eWNiVVUQC4KkqsclnyJXCKizfgqorJ8uYCKsQ5NSCSRx3jQU2LRL4nWNRqLKcCMLDHrWXTRmo9/U50G/Xuf9T69D5WKkISrlmDTQL4w5NDVLDWtCW0cWT26V9DVHibQDzcU2B23d9eBqr5BUq9FYrYCqtMxUKPmbF2H2SLRFGGMhSg8aTAW9YBE+pOF9ZKKt/f1vf+/gtdXjXEfM7yDynJ4T7sCQA1sv8ORxG6zJAuo+RrQemn9dvQQIO1aai0rnrSLZ+8v4W36AsK1ddJqLUbFEXy5rm6wgB7+1tzaNNtYGt9KmRBI9FHBZra6JXryW1nUqoeJ75bp9+AmJj1kHB3ZDSKtJ5tW8q+AtXqHiarkc12vJfhVdew2u6YJonL4wWEl1v3uqmx1wujUEjdOVcDKDuJQd9msjqYBzqdcVfBVRI2m8kto83qKqtNyFVhleSHWBV2ju4eD92CZqczEn4XYzRNXFLTLJX2fL+rUZlRz3eNK5nbhKs4vl0zv8Ae8wLGP6cJdRaa1W1oc0o4MD+m9Fc3rl32TZ2tLwcv6XJL1/QuH2eMp/phTGui4vVe6bYvSDrVWVFaRlFVrbD4k2TLmDgC7fpCqlwovIlIvRwcHFU+LcIk2ONjHnna7QFaxSZExnRlOVdl0ivRg6MwcxFVIBbW++IK/QGG1up/rjMLuNCUcHBxeHLROerjPhleJnLO4IONGXqP5YSrvbO789oXpd8bXg761EeiAeT3rEdr97Ii1mjZFunhyf3iTXA1HLgR8/Pj1fnJPUuUJTqq3WljEWrkiOk/21zBu3ZFBe5/Qm4fs9ibGDFSqnt6a1+EHUcv/qMFmkqzM2RhtbobEZfNwE68RUqunts86XvHlH5+ePqMehZTallv+BlE4JB9CFShNJclOgIENPLCex+GmZp3wZDzdmEDclBZeHuJrmi1m+XuJu1TBvSMV1MnGnMQ3Gma02sZUsCUra5BP92aaTTpei2mZuYuLmkDMeo6MjTg18fcgx9JPnHJ4ePVucewZ3QjXOBHfjDf/A0HOcw6e+I5kkK45bz3tadZ62OjJb/Jiw5cp93SKy6Zp8uqBDn2iWkHBsb2pU7yiUIM29OlzPHmCZ6aot5I7gv//t7zwjuhmM1V8orf+mMVDrGRpqW6Li7EmJ15LuUoLHiscsZ0j5BUFUJVpLaVPlcOp7kqgihIKW4BZnohZjWUqyRwSmffVVx6TZIfxcIL3j0NAj4wtkrrAkM9Z6I53uK5hpczmhDq8UBIypt4P8UVSFUJl3fb2OsQtH/UgUVtRGWmpZMYS19Lhp5YzIHFRCiSn7YGmPSzmWkgwQGD2myNDqsvGxjxOy1Ma/3jNB/IbDbyMvr2sa4swHBQ0GC5KKqxAA2dQHoF59QtPTmGL9mnCRGbIf2KhSU38S5QyasoRaOx/HkyfUxZGmOyOUpayIxyWeQcuwEJugDUX27y3SCb+W6tLX1A/gtBWmn3FspcN+bc6qZD/uz/leuh+aMXXsaCudNvPl7Kl0RTNmM9hdpP3hV/o+9rR1zNxyjVxndkOqSGd2n8qI9t+hIwmx+y/evuIL9DH8/j//C69RGAWFnnlpzRqD5XzZPsfdZnzynm3t/cfRr2ioZc2xkKppTMgQB5N01WT31c7gBA0x3/a69UQtw/KnEU3oF0F9PJl0E5MUi4wdhWiORC03BlXUdGXfTN6huZIZhttrywnvM/B+kialzFBZ7DgDL75/+xqu4MnwIEk79+A9Tnv/9atvX/747iVhQ5rlOXY4PBgecH5eW1cJ1dnqW9+6ebK8mlZej1o/adcPuusH3fWD7vpBd/2gu37QXT/orh901w+66wddI2rXD7rrB931g+76QXf9oLt+0F0/6K4fdNcPuusH3fWD7vpBd/2gu37QXT/orh901w/6x0nfrh/0IUrirh801h+RV7hfl0JywVuoL/e1aqerXaLnaVJQMdvxaXJzQ2+M7025WNDnXxuu3zk9T5MrYSRl0rkOLo3lW1TxdIlzeuv2DwODE9o/9eLOr/kr5X9UfeZnvOBjvxW2W2/39s27kyRNxqGTtdI5zTFiRl2uYubLngI3uZFRcI9SKdS04QKsxK+58MXGRb9c7ZLL1cIfnTouoeYdDPt1bJ4M+peI2jjh5saXwi0WLbwf2jojMDZC0/mdLxaL/wM4dQ2Q",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)(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:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},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/runtime~main.f90e32ae.js b/assets/js/runtime~main.fa074b84.js similarity index 95% rename from assets/js/runtime~main.f90e32ae.js rename to assets/js/runtime~main.fa074b84.js index f96ed10c5..06e3a04c0 100644 --- a/assets/js/runtime~main.f90e32ae.js +++ b/assets/js/runtime~main.fa074b84.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({157:"8001f939",291:"4f7a2d40",490:"ce589067",539:"cfb1e6eb",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",3891:"8e4d0438",3976:"0e384e19",4134:"393be207",4212:"621db11d",4317:"0028a090",4469:"52d5c0f9",4553:"451a5132",4584:"f82cd581",4813:"6875c492",4948:"bfe4b778",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5378:"38e3d9c8",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5772:"28b19cd2",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6382:"5c04ee3b",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6685:"ae010e44",6743:"e226bb09",6792:"4d665321",6887:"reactPlayerFacebook",6969:"14eb3368",7068:"e92d0461",7098:"a7bd4aaa",7315:"f0ff4a36",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7605:"770b40a9",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7910:"e4f5c862",8025:"5e90a9b3",8046:"6621d3c0",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:"4d88e708",490:"a197b5a8",539:"ddb32cf1",560:"1a361da4",724:"5668387e",746:"8736e4d6",841:"e3d7f949",849:"cda9e948",850:"3ac080ec",962:"4682dbdb",1019:"e5a454ea",1179:"955bead1",1235:"e0fce024",1381:"b30f8ee5",1440:"5dc69857",1463:"6c989e27",1519:"5a4dcd6c",1640:"d2ce80bf",1688:"358a7ccb",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2089:"11b02d02",2131:"d7f2b515",2223:"85cab8cc",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"20d5e3cf",3213:"8ac14f3d",3249:"d6c50b29",3276:"00ab24d9",3381:"dfcbba2f",3392:"a7951473",3451:"b02fe1ab",3605:"b00e16a9",3637:"ffa80471",3694:"4d710693",3841:"cf1c6a97",3844:"666e8e27",3891:"ef6c3502",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"3fbeff72",4469:"4cc28061",4553:"5eff7d00",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"c60c5a5d",4952:"b71d3026",5013:"b10f6f78",5277:"6e628336",5305:"760fdd56",5378:"69204c41",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5772:"6d63629e",5939:"59375399",5970:"91dc704f",6007:"690277f8",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c63bec71",6382:"24d5c460",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"49c57187",6653:"fdbc0c47",6685:"13adcb02",6743:"a3fe848c",6792:"3e8376ec",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b64a0c73",7098:"c920e4e4",7315:"b92fe796",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7605:"3eecd250",7627:"df6df631",7643:"4bb958af",7696:"6ededead",7757:"8c5bade9",7910:"65b14ba4",8025:"18e81984",8046:"eb383529",8097:"43a7d9e8",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8209:"b9e31ef1",8211:"21256d76",8446:"594ab8ca",8462:"d040ed86",8472:"27c9c261",8503:"45b8fe0a",8609:"6bdc8628",8669:"f39cb8ab",8672:"a786571b",8734:"1f259505",8737:"f138d21c",8790:"bb7f0628",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9180:"b5c8d3ca",9190:"dd359a70",9241:"77521554",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9426:"4597631d",9441:"5f0a0588",9599:"1cb53b0f",9611:"ed784bfd",9647:"2f22c378",9858:"c1033d93",9938:"74d6bcf5",9979:"84827225",9983:"0a9d5bbe"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325","8001f939":"157","4f7a2d40":"291",ce589067:"490",cfb1e6eb:"539","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","8e4d0438":"3891","0e384e19":"3976","393be207":"4134","621db11d":"4212","0028a090":"4317","52d5c0f9":"4469","451a5132":"4553",f82cd581:"4584","6875c492":"4813",bfe4b778:"4948","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","38e3d9c8":"5378","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","28b19cd2":"5772","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353","5c04ee3b":"6382",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",ae010e44:"6685",e226bb09:"6743","4d665321":"6792",reactPlayerFacebook:"6887","14eb3368":"6969",e92d0461:"7068",a7bd4aaa:"7098",f0ff4a36:"7315",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570","770b40a9":"7605",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757",e4f5c862:"7910","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","1f73ca32":"8211",reactPlayerYouTube:"8446","3217192f":"8462","13fdae3b":"8472","012b45bf":"8503","925b3f96":"8609","05632a52":"8669","8a725248":"8672",reactPlayerPreview:"8734","7661071f":"8737","2304e9ae":"8790",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","8a855f99":"9180","6cb65baf":"9190","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","38ec836e":"9426","377084eb":"9441","2c586be5":"9599","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858","7b076186":"9938",reactPlayerSoundCloud:"9979",ada7accb:"9983"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({157:"8001f939",291:"4f7a2d40",490:"ce589067",539:"cfb1e6eb",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",3891:"8e4d0438",3976:"0e384e19",4134:"393be207",4212:"621db11d",4317:"0028a090",4469:"52d5c0f9",4553:"451a5132",4584:"f82cd581",4813:"6875c492",4948:"bfe4b778",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5378:"38e3d9c8",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5772:"28b19cd2",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6382:"5c04ee3b",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6685:"ae010e44",6743:"e226bb09",6792:"4d665321",6887:"reactPlayerFacebook",6969:"14eb3368",7068:"e92d0461",7098:"a7bd4aaa",7315:"f0ff4a36",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7605:"770b40a9",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7910:"e4f5c862",8025:"5e90a9b3",8046:"6621d3c0",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:"4d88e708",490:"a197b5a8",539:"ddb32cf1",560:"1a361da4",724:"5668387e",746:"8736e4d6",841:"e3d7f949",849:"cda9e948",850:"3ac080ec",962:"4682dbdb",1019:"e5a454ea",1179:"955bead1",1235:"e0fce024",1381:"b30f8ee5",1440:"5dc69857",1463:"6c989e27",1519:"5a4dcd6c",1640:"d2ce80bf",1688:"358a7ccb",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2089:"11b02d02",2131:"d7f2b515",2223:"85cab8cc",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"20d5e3cf",3213:"afadc0af",3249:"d6c50b29",3276:"00ab24d9",3381:"dfcbba2f",3392:"a7951473",3451:"b02fe1ab",3605:"b00e16a9",3637:"ffa80471",3694:"4d710693",3841:"cf1c6a97",3844:"2cfac16d",3891:"ef6c3502",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"957b6a0a",4469:"4cc28061",4553:"5eff7d00",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"c60c5a5d",4952:"b71d3026",5013:"b10f6f78",5277:"6e628336",5305:"760fdd56",5378:"69204c41",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5772:"2d4415d2",5939:"59375399",5970:"91dc704f",6007:"690277f8",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c63bec71",6382:"24d5c460",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"49c57187",6653:"fdbc0c47",6685:"0eaaabdc",6743:"a3fe848c",6792:"3e8376ec",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b64a0c73",7098:"c920e4e4",7315:"b92fe796",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7605:"3eecd250",7627:"df6df631",7643:"4bb958af",7696:"6ededead",7757:"8c5bade9",7910:"65b14ba4",8025:"18e81984",8046:"eb383529",8097:"43a7d9e8",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8209:"b9e31ef1",8211:"21256d76",8446:"594ab8ca",8462:"d040ed86",8472:"27c9c261",8503:"45b8fe0a",8609:"6bdc8628",8669:"f39cb8ab",8672:"a786571b",8734:"1f259505",8737:"f138d21c",8790:"bb7f0628",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9180:"b5c8d3ca",9190:"dd359a70",9241:"77521554",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9426:"4597631d",9441:"5f0a0588",9599:"971c43af",9611:"ed784bfd",9647:"2f22c378",9858:"c1033d93",9938:"74d6bcf5",9979:"84827225",9983:"0a9d5bbe"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325","8001f939":"157","4f7a2d40":"291",ce589067:"490",cfb1e6eb:"539","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","8e4d0438":"3891","0e384e19":"3976","393be207":"4134","621db11d":"4212","0028a090":"4317","52d5c0f9":"4469","451a5132":"4553",f82cd581:"4584","6875c492":"4813",bfe4b778:"4948","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","38e3d9c8":"5378","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","28b19cd2":"5772","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353","5c04ee3b":"6382",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",ae010e44:"6685",e226bb09:"6743","4d665321":"6792",reactPlayerFacebook:"6887","14eb3368":"6969",e92d0461:"7068",a7bd4aaa:"7098",f0ff4a36:"7315",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570","770b40a9":"7605",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757",e4f5c862:"7910","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","1f73ca32":"8211",reactPlayerYouTube:"8446","3217192f":"8462","13fdae3b":"8472","012b45bf":"8503","925b3f96":"8609","05632a52":"8669","8a725248":"8672",reactPlayerPreview:"8734","7661071f":"8737","2304e9ae":"8790",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","8a855f99":"9180","6cb65baf":"9190","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","38ec836e":"9426","377084eb":"9441","2c586be5":"9599","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858","7b076186":"9938",reactPlayerSoundCloud:"9979",ada7accb:"9983"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index 93a70fc2e..b6ace46db 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 2a7b74547..361ddc8d5 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 b8cec65c5..2ea73e469 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 279339823..326839a65 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 1ff613907..a35d018bc 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 1d34cb9f9..e1c5b4167 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 473f8cc3f..fd75b2646 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 2a3c49c7e..910497ad4 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 b984b5471..84197e891 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 f071b85db..74e86df2c 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 8df358545..f04065d73 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 22cb0f3ca..19ecf869c 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 408367762..8ba656a30 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 caebb233b..8bbfeff69 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -70,7 +70,9 @@
  • "mmm dd, yyyy",
  • "mmmm dd, yyyy",
  • "dd mmm, yyyy",
    • -
  • "dd mmmm, yyy".
    • +
  • "dd mmmm, yyy",
    • +
  • "dd/mm/yyyy",
    • +
  • "dd.mm.yyyy".
    • @@ -87,7 +89,7 @@
    1. 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,
        "layout": "vertical",
        "validation": {
          "minselections": 0,
          "maxselections": 0
        }
      }
    }
    • values: Provide options for the checkbox list.
    • selectedvalues: Provide values that need to be selected by default (Optional).
      • @@ -108,7 +110,7 @@
      1. 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,
          "layout": "vertical"
        }
      }
      • 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).
        • diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index db8c29992..62f9c9b56 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 9409dd96f..2e6091d8d 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 b3af46125..d2da4dbdd 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -70,7 +70,9 @@
      • "mmm dd, yyyy",
      • "mmmm dd, yyyy",
      • "dd mmm, yyyy",
        • -
      • "dd mmmm, yyy".
        • +
      • "dd mmmm, yyy",
        • +
      • "dd/mm/yyyy",
        • +
      • "dd.mm.yyyy".
    @@ -87,7 +89,7 @@
    1. 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,
        "layout": "vertical",
        "validation": {
          "minselections": 0,
          "maxselections": 0
        }
      }
    }
    • values: Provide options for the checkbox list.
    • selectedvalues: Provide values that need to be selected by default (Optional).
      • @@ -108,7 +110,7 @@
      1. 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,
          "layout": "vertical"
        }
      }
      • 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).
        • diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 521de8b86..725061e78 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 72a04ebc1..8663a7610 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 a2629fb15..6176e0ff0 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 87ed39331..fe72368e1 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 62a2acdae..038418847 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 c922ede7c..e63d74878 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + @@ -70,7 +70,9 @@
      • "mmm dd, yyyy",
      • "mmmm dd, yyyy",
      • "dd mmm, yyyy",
        • -
      • "dd mmmm, yyy".
        • +
      • "dd mmmm, yyy",
        • +
      • "dd/mm/yyyy",
        • +
      • "dd.mm.yyyy".
    @@ -87,7 +89,7 @@
    1. 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,
        "layout": "vertical",
        "validation": {
          "minselections": 0,
          "maxselections": 0
        }
      }
    }
    • values: Provide options for the checkbox list.
    • selectedvalues: Provide values that need to be selected by default (Optional).
      • @@ -108,7 +110,7 @@
      1. 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,
          "layout": "vertical"
        }
      }
      • 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).
        • diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 5d2b2cc05..6413b95c5 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -72,7 +72,9 @@
      • "mmm dd, yyyy",
      • "mmmm dd, yyyy",
      • "dd mmm, yyyy",
        • -
      • "dd mmmm, yyy".
        • +
      • "dd mmmm, yyy",
        • +
      • "dd/mm/yyyy",
        • +
      • "dd.mm.yyyy".
    @@ -89,7 +91,7 @@
    1. 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,
        "layout": "vertical",
        "validation": {
          "minselections": 0,
          "maxselections": 0
        }
      }
    }
    • values: Provide options for the checkbox list.
    • selectedvalues: Provide values that need to be selected by default (Optional).
      • @@ -110,7 +112,7 @@
      1. 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,
          "layout": "vertical"
        }
      }
      • 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).
        • diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index 2038eb519..1108950bc 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 003c5fcef..433e8b76f 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 64f4ad447..626580065 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 c236ef903..1a118b349 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 2cffee43d..f7decde24 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 bb2213a3b..537e25f0c 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 6e3f1dbf9..945f3db0a 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 580ed1c77..cd40c4aef 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 b084c05ad..5a71e05af 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 909cf06e1..c13f58d33 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 d470b5f95..965a70510 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 3d53eef33..b231b8c9d 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/revokedocument/index.html b/docs/API-docs/revokedocument/index.html index 03e29c7e3..cea26d43c 100644 --- a/docs/API-docs/revokedocument/index.html +++ b/docs/API-docs/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index b56ba9916..4b306ae19 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 8ce6d9118..91737aec5 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + @@ -70,7 +70,9 @@
      • "mmm dd, yyyy",
      • "mmmm dd, yyyy",
      • "dd mmm, yyyy",
        • -
      • "dd mmmm, yyy".
        • +
      • "dd mmmm, yyy",
        • +
      • "dd/mm/yyyy",
        • +
      • "dd.mm.yyyy".
    @@ -87,7 +89,7 @@
    1. 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,
        "layout": "vertical",
        "validation": {
          "minselections": 0,
          "maxselections": 0
        }
      }
    }
    • values: Provide options for the checkbox list.
    • selectedvalues: Provide values that need to be selected by default (Optional).
      • diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index e9d62fb55..7e1bf163e 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 1763f9b5f..583ee8bf0 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 9878ec616..4e5e46c1f 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 681c30d0f..95273d8c2 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 33aab249a..c213a8698 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 2fa0b3eb3..184de7fb5 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/documents/index.html b/docs/category/documents/index.html index 4c9dfc7cf..d60e9e8f3 100644 --- a/docs/category/documents/index.html +++ b/docs/category/documents/index.html @@ -5,7 +5,7 @@ Documents | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 2972b617d..206adba0d 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 fd6a964f9..9c5cc67f9 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 c7941d1e9..e9ffe7d49 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/settings/index.html b/docs/category/settings/index.html index 136b1269f..36abea0b4 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 2f728414c..cc08e73c5 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 3e2dcdaa5..1dc250231 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 e0a2fd467..be7d079d5 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 ece8b0b02..f16684267 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 a77aa7aa3..23c91b338 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 ff28ec6c6..89cb5ff5b 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 48b9fe9eb..e8e328883 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 9b3061730..b34046df1 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/edit-document-before-sending/index.html b/docs/help/New-Document/edit-document-before-sending/index.html index 987cdd434..4c475144e 100644 --- a/docs/help/New-Document/edit-document-before-sending/index.html +++ b/docs/help/New-Document/edit-document-before-sending/index.html @@ -5,7 +5,7 @@ Editing Your Document Before Sending | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index cdfc9356a..28f094bcd 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 4d170c4a2..4536e027d 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 40fd54c00..9de20da15 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 bea191e10..5c568c35c 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 873573d66..0b6fa9a9f 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 bc5b73031..d5462d7fa 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 5da7b7dc5..bdb3f65fc 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 ccde5d44d..4450583f6 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 547e9a718..10cfc085e 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 acc3ec99c..16c191ae9 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 63031ea1b..b45f077b8 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 b311ac065..bf6cfdb07 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 dee2e66c1..a005e93c7 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 ee60dfdf4..37d0f562f 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 4fc357841..7757ca357 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/APIToken/index.html b/docs/help/Settings/APIToken/index.html index 744d4241e..b540d6ef0 100644 --- a/docs/help/Settings/APIToken/index.html +++ b/docs/help/Settings/APIToken/index.html @@ -5,7 +5,7 @@ API Token | OpenSign™ - + diff --git a/docs/help/Settings/Custom-email-templates/index.html b/docs/help/Settings/Custom-email-templates/index.html index a821e5a11..d7c2383ef 100644 --- a/docs/help/Settings/Custom-email-templates/index.html +++ b/docs/help/Settings/Custom-email-templates/index.html @@ -5,7 +5,7 @@ Custom email templates | OpenSign™ - + diff --git a/docs/help/Settings/Preferences/index.html b/docs/help/Settings/Preferences/index.html index eed9afd09..081e231ac 100644 --- a/docs/help/Settings/Preferences/index.html +++ b/docs/help/Settings/Preferences/index.html @@ -5,7 +5,7 @@ Preferences | OpenSign™ - + diff --git a/docs/help/Settings/SecurityManagement/index.html b/docs/help/Settings/SecurityManagement/index.html index 3cae05e35..cb59c8526 100644 --- a/docs/help/Settings/SecurityManagement/index.html +++ b/docs/help/Settings/SecurityManagement/index.html @@ -5,7 +5,7 @@ Security | OpenSign™ - + diff --git a/docs/help/Settings/Teams/index.html b/docs/help/Settings/Teams/index.html index cd2cc5104..4758c927f 100644 --- a/docs/help/Settings/Teams/index.html +++ b/docs/help/Settings/Teams/index.html @@ -5,7 +5,7 @@ Manage Teams | OpenSign™ - + diff --git a/docs/help/Settings/Webhook/index.html b/docs/help/Settings/Webhook/index.html index fdd2570ae..4bcac67f8 100644 --- a/docs/help/Settings/Webhook/index.html +++ b/docs/help/Settings/Webhook/index.html @@ -5,7 +5,7 @@ Webhook | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index 159ef68a4..02dd981b4 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 3d9f2b428..e25a64d0a 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 d265fe60e..0ef272f64 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 ef0afc31f..73b4041e3 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 39b6023db..d8082926f 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 316c46a1e..5f95d244e 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 3794583b8..dac7e9dfe 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 2aec67f45..8edde407b 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 e6d91666b..c43087ac9 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 c4dec44ca..658cc61fa 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 25cdc50a2..5077ba654 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 510abd079..529857e22 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 8141dca21..ae497fadb 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 551410750..ee3090809 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/azure-vm-setup/index.html b/docs/self-host/guides/azure-vm-setup/index.html index b1ffdcefb..9342781e1 100644 --- a/docs/self-host/guides/azure-vm-setup/index.html +++ b/docs/self-host/guides/azure-vm-setup/index.html @@ -5,7 +5,7 @@ OpenSign Deployment Guide on Azure VM via command-line | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index d76720e52..48d3b169f 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 ba6d98788..304d19c3b 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 63c299fee..873f8abc0 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 6e7be4a1a..59ae5266a 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 0c3f8dffc..00f493925 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 ea5210df4..9d7eafbe1 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +