From 33b55a0e437877bb8a51eb343fcc12f6905bc0bf Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 12 Nov 2024 06:56:45 +0000 Subject: [PATCH] deploy: 937390fca0544ebf6fbf33ddc16642d70ca50942 --- 404.html | 2 +- assets/js/0028a090.8d7a1e93.js | 1 - assets/js/0028a090.f6d4feec.js | 1 + assets/js/2c586be5.e2b36df1.js | 1 - assets/js/2c586be5.e8abf1d2.js | 1 + assets/js/bbdfc22d.dd1f5b80.js | 1 - assets/js/bbdfc22d.e7b67797.js | 1 + ...n.d67131c6.js => runtime~main.ebbd1254.js} | 2 +- blog/archive/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 | 28 +++++++++---------- .../createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/createfolder/index.html | 2 +- docs/API-docs/createtemplate/index.html | 25 +++++++++-------- 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/drafttemplate/index.html | 25 +++++++++-------- docs/API-docs/folderlist/index.html | 2 +- docs/API-docs/get-template/index.html | 2 +- docs/API-docs/get-user/index.html | 2 +- docs/API-docs/get-webhook/index.html | 2 +- docs/API-docs/getcontact/index.html | 2 +- docs/API-docs/getdocument/index.html | 2 +- docs/API-docs/getdocumentlist/index.html | 2 +- docs/API-docs/getfolder/index.html | 2 +- docs/API-docs/gettemplatelist/index.html | 2 +- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/resendrequestmail/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 2 +- docs/API-docs/update-document/index.html | 2 +- docs/API-docs/update-template/index.html | 2 +- docs/API-docs/updatefolder/index.html | 2 +- docs/category/cloud-storage/index.html | 2 +- .../create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- .../index.html | 2 +- docs/category/reports/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- .../REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/index.html | 2 +- .../enforce-email-verification/index.html | 2 +- .../navigate-between-pages/index.html | 2 +- .../request-signatures/index.html | 2 +- .../New-Document/sign-yourself/index.html | 2 +- .../create-document/index.html | 2 +- .../OpenSign™ Drive/list-grid-view/index.html | 2 +- .../organize-documents/index.html | 2 +- .../rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/contactbook/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- .../Settings/disabledocumentid/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- .../help/Templates/create-template/index.html | 2 +- docs/help/Templates/embed-template/index.html | 2 +- docs/help/Templates/publicTemplate/index.html | 2 +- docs/help/Templates/quick-send/index.html | 2 +- docs/help/Templates/use-template/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- .../One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/cloud-storage/s3/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- .../docker/upgrade-deployment/index.html | 2 +- .../self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- .../guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 98 files changed, 131 insertions(+), 131 deletions(-) delete mode 100644 assets/js/0028a090.8d7a1e93.js create mode 100644 assets/js/0028a090.f6d4feec.js delete mode 100644 assets/js/2c586be5.e2b36df1.js create mode 100644 assets/js/2c586be5.e8abf1d2.js delete mode 100644 assets/js/bbdfc22d.dd1f5b80.js create mode 100644 assets/js/bbdfc22d.e7b67797.js rename assets/js/{runtime~main.d67131c6.js => runtime~main.ebbd1254.js} (97%) diff --git a/404.html b/404.html index e671f480f..ebd84d1f9 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.8d7a1e93.js b/assets/js/0028a090.8d7a1e93.js deleted file mode 100644 index 01928c589..000000000 --- a/assets/js/0028a090.8d7a1e93.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztO9ty27iSv9KHL5moKNlynEyi2traTJLJKBPH2di5Wq4MSLZE2CTAAKBlxqW3/ZLzaedLthogSEqWL5k9teNTR3lwRKDR6BuA7kbjIjBspoPRUXCIeZExgzo4DoMEdax4YbgUwSg4TBF8NzxXbGq4mMHTt2NAwaIMNZQalQYjIVZIQHGpjcz5d+oF4zGHoFGd0VimIcpKLBQXRsNUKpihQMUs4kTGZY7UMecmhUJhglMuMAFtVBmbUqEewPtCCtBlHKPW0zJzM3MpQE6BNXOGYFK0pCo0pRIaGJSCfysRej0ZnWBsxkmvBz8lqPlMMIMJEeeHf+XJ/RDmKY9TiJmACInVhDitCcYOuRGjPinsnLrAmE85AdfIBvA0STjRyLKsCoFBr1eqrNcDrqFQ8ownmPjZ5HRKImVWtMCFQTVlMVpZIWERMzuNRw5MJDBlMc+4WRYjJFwbxaOSZh5MxEQc8mIE74tMsgQqWSp4+/zXFtxIoLajXu85RuUM3o97veOfUmMKPdraYkUxkAUKklbGIj2IZb6VEGCRTK2sUCFhtfJCpnlWAUsSmPNkhkZbhQiIZVFBLKVKuHCmUbAZgijzCJUOLTe5VAhcAAOFLKn6RvZLjfDqYP8NiSFnZgBvs1KHzXQJVxibrHLoSTyeq3tOO492yYa4mIWQs1OSEjfwreTxKbGtUVjV1iZjZdXrHZRFIRUZxkfHwqjXo55fMJNzYAotfCzzXAoomGI5GrsaUmZst8JvJVeYOHNmWeZlMSI0fej1TFXgqNeDsUh4TOJwqq0KJGt20AMHSmIi0IPavBxoR3hkf86ESCpz5jRaZGQ8BKqQLNPwM1xGfB5CRYifo5CeglQq/l0KwzKrkDNUhscs6yqOCLTmbpiyZldILoxvrWeAz7WCSH9WLbVlEWkJiSvnwvZohDOWlahrquYhpETVOywUarvKarwkSpFAinyWXjkfS05KbZYQQ6n92vFU1HN5PVnxohXblGUagU+XZJmzU+zMBrJwa3oAv1SQ4JSVmQmBk80ZVeIA3kgDrCgyHtv9kJaw22xKhX2r5dogakIEy62O37o9gXaBhNN+QMuTOi2KeoynjizNbSLEnl07JmUCpFhRdCwzqQj9ig3Z9mVBQiyFQWEG8PSM8cxS77jVwEWclQlClLH4NLTbeQiKNjBSS4VZJuehM3kLYrdVK3QrINCYkRlKQQwIWU/Pdbtx1uvvNddWv7RwdLMW50trcSKGA+j1Gqna5j/++GMiLiYCYBKQlCfBaBI0IJMgBNdHi2cSjIYh1A3nk2AED3Z+9gAVfT/aeey/5/Q9HO7675S+d4YTsagn3bHEGJYX1xBC3f98IvxnrSZqtDNTmzdwaiTLdLDUQ0ZFrQ1Z1LFoGXpADHHBDWeZvponD3H32GopW+FslzjDnPHsarZs993jyZPle+wKcl12xV3i9eGg3VyuYNVhv2uc1lTdmtFHxOiJjMBwk13DbQNy91juknZrvn8e2P09L5iorua6Brh7PLeE3Zrjx8Rxwsw1Sqbeu8drTZXvqE9F17e92x8+7O9s7+x2IJzH6wDyvJ8k/aqqbisrsJKh07+eyJ7/tX/hjmWKIaZK5mucR+vbtVC1i2B/e4drj9ysCJswhvz25SjIe+xdH8nIhFX3tEPlh9ZuioNvXd2qQ6btIjps9BKnksc18QTjPZSIHPQBCaFPEk629va2OjJzjf0894IE30rffSvjbmueD5JksAq7pIpOaw5JEsKa9vUdSQJ5nl/V7jpIoRPxhCze4LmJ5PnVRl8D3D27bwlba/orO33KRd1RWwesACiclRlTeE7hgeZSWO5/ZAdZWRR+TbDGUbVhg/W4Xbxt6Yef9muv/35tr0TqMgJquXncJQ66SBTO8NzicBkVIoYnNs8RUvIjJa+akatNTr8UWdWG0PYrZgWn8C1DY2wrmniwTMREDLftuZFifHqtUXmIu2dVHcp8p4v2qPtoEuSsPuODKba/pUlRTYLjZoyLSTDpjIV1g+G4Y4AsIUkTsI0WW/JSnmDGIszavqutskt3reGOFKgj56KJmSxt234q28vOV3rrzsUae3f8dQ3N75neXL1AIePaB47L0umOriNrm/EQ6PJjEYIfAFGz56+zfyfATtRNWl4NujWaZcKYBj90TeBtxe0XZq2GG2YgOLCATVLDT3bVBDULS5rpyoVw5FzwvMyb7My0weolltdnZ1dcNJIyf36GrnYvzcDOb5ihTl1eMcFEDG30nChZJHIu7AYA632pGuTu7QAdyv4vO8DSYVTD/dBRcvPS8pR2l9aaA4hA3dHTLCt99boawD5t95TscYO4BhbHWBhMVvb7oc1OKJZwCVFpjBRX7/hdqLun8xXq/iK9kxBup/kuvX+V9idi6JI5uUskX5XJya2O75rGa7LWnWxQ/5uIIAxkYS+TpBgnwShI6MrKX5QEoZ0JtflFJlUwugjqJCf9rLO0NHLrRNPl10Wg4xRzRr88hXRdNuUZoaJ0IiodhIEN1unujGQYjAJ3uRSE5LkWlDhHTTjsuNGFh3K3EUFYh3fBKHDXFEEY4DnLCwKumwBFLCm0sigWfsbrcDUtLS5tfzTXRoSH8v1/Eo0duli5L/xTmLoYFq1cW2RMKVYFq1eTPtHvwwM3rknJZ5U/5bkhj6FJPluwIAy4wbw7yxVaU/LHJR2jJE5slu5Hx1q1sPyH56RxRSrFnxpYp9TXyPyWUnK9lydeVtlTClcw8U5jv70LCcFmnwc3WYyHt9yyWXdO5wNdmvPwqjuyzl2HTmWZJXRRg0wN7FXVn74HtVfhLItLezXbbOZLnDWkNpwNF2FwfjMz5xDLvr+Ag58ynBooiwIVxFIJVPe7eZw7w9zO7u4iDKqb2av+Jdn7mZQ3v5m7j/bmsr3V/StoffB4EQbpzbT+1tyt/oXE7j5atGdd4OpLmvKMSCbVV79vLW4C9IcKwdFd/1jsqwRVRxCRlBkycUkS46kLQCXcI9fkXp1dIR6mXGl/oMCcZxkojJGu123+0+9VUDsdYM8DqO+jKHZ9QQ3WudNlpAlKeHzaIYwQjOKzGVIRQQ3BXQ2JvV9FFqdUvGAcVWxq0DmchcIzLkvtyUuZpkKFIkPyH02K3N1EczFbDnE70rFXsl3eB13tUAsdcrYOaP/w7S1kaWPvPpiU6/qcdlw6HLB/+JYKDfi09sMG8F43kvCiZUsgQH4RnHHmhBu2e3vlgmsUViLSMrtUFzKor/j7cJmghOu1FIVtxq2pe7qEuK1FIRXJ0lARTF38A9pgoZfkaKloBHkoy9tY5Q2SZDArbS7e0JL1VQc2C9gWCnDhiqpsoJKUytdG1GZBkFRh1crJS4WAOvhDQKHdcAZTpg2qkCqtSPKqpECkQYnnBSqOIsY1Irh+Cbs13vrhtflRTYsU2nkhO9vb9N+KA+DLpBzSpFM5llV/C8LbBwHXu0C+pGydG9R6ML+kO7/pQuRxSi5Mqdb6hy349dtrN7jZwupVGr2M+T5/NX7/fTx8w8d6LN49jJ+NH41Pi08fnr16MsDq1TDe+VB92vlgPn/M9PhE8vi3V+kX8UFHzx6Wnz99UZ8/jdXnj+8M+/jwaSRSEb38lcfVw5NoZ5u/fvZq+8vH4Tx6+ev2lw9Pii8W+a/bX05Pt+P8zbNIPCWY4vOn/+b7Jy8e7H1/8X3v8MX53vfsyYC9+Xby7Dx+snf64lH/y1j19/aj30++meLdw+TBm0/80WPcw4/icPt1HHStgYuMC/zqVf3V8v2VlL2wRrG7Tu0HMkeTktHNaU3OlaTSryJDRoVIqgI2Y1wAiU79E60AlZLqep3+GGXXCWJ3e/vrsBHCw8tCGAubU7ZVkIfyFMX/L6fd6Y2bnkg9z63Vuygn4A7I9gdLzHbbHZMa41JxUwWjo4vgvM8K3nf9o6PjxXEYkGAlxf2F1JZiZtJgFGytpgGoGNXGmEcXbg02C00zkVDa99JiYwXfOhsGi3B1xNqleSW0NmzGxax/7ajjltMD0oYT+BK/baBW8N+RIrVanF2oMOBkBSky8nVIgKTkd20O5IVXlc9OrE04tDpZTSH4DMJSUmD1rFoT5nei/CMfYtuouQmag5ajoAls6WcTqh61ltdEhT4oHNpoamd314YdPw+tf/7gsXV9dx8tjp2EO26gzTp1fRl3abN0KPuDmouptAqohbJfoDggJ4DM/Gx42e/HLJY5+vJSD/6P//m7HeHdBrsK/wb7pYJCzlFRZbOt7M3wnNOxS8DW/dA2rWFvRlieodaU6xAGZ64omc/svZ8/c2NWsIhqg6najwsj3dV5Z+nrAXxMkfKi1HVPuSvQM8xouUMmpS2XNRJYaWTeLXyGuVSnUyKJapojqq9ETU4j+iEoUiZiSl06ew5BKqDyYPIOCsU1AuM5Advy5umUx5wQ0yalWGwgZ4LNkCYLbfxBUih8daSSETl5Wmalc2OoRhPROBZt6nQAz8lttIxTY4KG8QwT58Ho0HmQ9Z5Vlx9H5K0XND2PUbd1EBmeobLr1/n/ZZZBIY3zySlY6uqWEBnFhKYIxxHkVdOIr3ax7BwJqwZAWVo6H8i9JAPIuDilYuE+HDVm9hEjzQ22sdd8Pr+0l9xfHvOSm7SMQGEh23Ez22h3nu7w5uM+rXxUud6fHlD1fuw9kivm3LLAW/URw2J7xPj1zAr+X6sDaLvPeIxCY+dAePry7Ws4gweD7SDs7J63IHjr9fjZizcHLwgv7e9u/Q0H24NtmzCS2uRMdKayLxqaBw6rK7eTH948hNg8hNg8hNg8hNg8hNg8hNg8hNg8hNg8hLgbPG0eQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQvwbP4SoL8fJ6doqMsZFp+DI1UUcrTyPOA6DlOomRkfBxQVdFbxX2WJBzd9KVFR0cRwGZ0xxSoLakovQ1xbQbfwpVsEoeObSpf1Dmj50hmiv/1YqTag0wo14arV0LWy3tOPt/sFhEAZR/YQjlwmNUWxOzzvYPBgF5PzalyBWwLaIn9n63IyJWWkLBAKHl0oiWGnS5XqKU1tPUf/o1BkwUXWoXC60cKzQX2Js7YD/oCu437H6zwbc9Vw5oJathyYNHi8Wi/8F+DKKLQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztO9ty27iSv9KHL5moKNlynEyi2traTJLJKBPH2di5Wq4MSLZE2CTAAKBlxqW3/ZLzaedLthogSEqWL5k9teNTR3lwRKDR6BuA7kbjIjBspoPRUXCIeZExgzo4DoMEdax4YbgUwSg4TBF8NzxXbGq4mMHTt2NAwaIMNZQalQYjIVZIQHGpjcz5d+oF4zGHoFGd0VimIcpKLBQXRsNUKpihQMUs4kTGZY7UMecmhUJhglMuMAFtVBmbUqEewPtCCtBlHKPW0zJzM3MpQE6BNXOGYFK0pCo0pRIaGJSCfysRej0ZnWBsxkmvBz8lqPlMMIMJEeeHf+XJ/RDmKY9TiJmACInVhDitCcYOuRGjPinsnLrAmE85AdfIBvA0STjRyLKsCoFBr1eqrNcDrqFQ8ownmPjZ5HRKImVWtMCFQTVlMVpZIWERMzuNRw5MJDBlMc+4WRYjJFwbxaOSZh5MxEQc8mIE74tMsgQqWSp4+/zXFtxIoLajXu85RuUM3o97veOfUmMKPdraYkUxkAUKklbGIj2IZb6VEGCRTK2sUCFhtfJCpnlWAUsSmPNkhkZbhQiIZVFBLKVKuHCmUbAZgijzCJUOLTe5VAhcAAOFLKn6RvZLjfDqYP8NiSFnZgBvs1KHzXQJVxibrHLoSTyeq3tOO492yYa4mIWQs1OSEjfwreTxKbGtUVjV1iZjZdXrHZRFIRUZxkfHwqjXo55fMJNzYAotfCzzXAoomGI5GrsaUmZst8JvJVeYOHNmWeZlMSI0fej1TFXgqNeDsUh4TOJwqq0KJGt20AMHSmIi0IPavBxoR3hkf86ESCpz5jRaZGQ8BKqQLNPwM1xGfB5CRYifo5CeglQq/l0KwzKrkDNUhscs6yqOCLTmbpiyZldILoxvrWeAz7WCSH9WLbVlEWkJiSvnwvZohDOWlahrquYhpETVOywUarvKarwkSpFAinyWXjkfS05KbZYQQ6n92vFU1HN5PVnxohXblGUagU+XZJmzU+zMBrJwa3oAv1SQ4JSVmQmBk80ZVeIA3kgDrCgyHtv9kJaw22xKhX2r5dogakIEy62O37o9gXaBhNN+QMuTOi2KeoynjizNbSLEnl07JmUCpFhRdCwzqQj9ig3Z9mVBQiyFQWEG8PSM8cxS77jVwEWclQlClLH4NLTbeQiKNjBSS4VZJuehM3kLYrdVK3QrINCYkRlKQQwIWU/Pdbtx1uvvNddWv7RwdLMW50trcSKGA+j1Gqna5j/++GMiLiYCYBKQlCfBaBI0IJMgBNdHi2cSjIYh1A3nk2AED3Z+9gAVfT/aeey/5/Q9HO7675S+d4YTsagn3bHEGJYX1xBC3f98IvxnrSZqtDNTmzdwaiTLdLDUQ0ZFrQ1Z1LFoGXpADHHBDWeZvponD3H32GopW+FslzjDnPHsarZs993jyZPle+wKcl12xV3i9eGg3VyuYNVhv2uc1lTdmtFHxOiJjMBwk13DbQNy91juknZrvn8e2P09L5iorua6Brh7PLeE3Zrjx8Rxwsw1Sqbeu8drTZXvqE9F17e92x8+7O9s7+x2IJzH6wDyvJ8k/aqqbisrsJKh07+eyJ7/tX/hjmWKIaZK5mucR+vbtVC1i2B/e4drj9ysCJswhvz25SjIe+xdH8nIhFX3tEPlh9ZuioNvXd2qQ6btIjps9BKnksc18QTjPZSIHPQBCaFPEk629va2OjJzjf0894IE30rffSvjbmueD5JksAq7pIpOaw5JEsKa9vUdSQJ5nl/V7jpIoRPxhCze4LmJ5PnVRl8D3D27bwlba/orO33KRd1RWwesACiclRlTeE7hgeZSWO5/ZAdZWRR+TbDGUbVhg/W4Xbxt6Yef9muv/35tr0TqMgJquXncJQ66SBTO8NzicBkVIoYnNs8RUvIjJa+akatNTr8UWdWG0PYrZgWn8C1DY2wrmniwTMREDLftuZFifHqtUXmIu2dVHcp8p4v2qPtoEuSsPuODKba/pUlRTYLjZoyLSTDpjIV1g+G4Y4AsIUkTsI0WW/JSnmDGIszavqutskt3reGOFKgj56KJmSxt234q28vOV3rrzsUae3f8dQ3N75neXL1AIePaB47L0umOriNrm/EQ6PJjEYIfAFGz56+zfyfATtRNWl4NujWaZcKYBj90TeBtxe0XZq2GG2YgOLCATVLDT3bVBDULS5rpyoVw5FzwvMyb7My0weolltdnZ1dcNJIyf36GrnYvzcDOb5ihTl1eMcFEDG30nChZJHIu7AYA632pGuTu7QAdyv4vO8DSYVTD/dBRcvPS8pR2l9aaA4hA3dHTLCt99boawD5t95TscYO4BhbHWBhMVvb7oc1OKJZwCVFpjBRX7/hdqLun8xXq/iK9kxBup/kuvX+V9idi6JI5uUskX5XJya2O75rGa7LWnWxQ/5uIIAxkYS+TpBgnwShI6MrKX5QEoZ0JtflFJlUwugjqJCf9rLO0NHLrRNPl10Wg4xRzRr88hXRdNuUZoaJ0IiodhIEN1unujGQYjAJ3uRSE5LkWlDhHTTjsuNGFh3K3EUFYh3fBKHDXFEEY4DnLCwKumwBFLCm0sigWfsbrcDUtLS5tfzTXRoSH8v1/Eo0duli5L/xTmLoYFq1cW2RMKVYFq1eTPtHvwwM3rknJZ5U/5bkhj6FJPluwIAy4wbw7yxVaU/LHJR2jJE5slu5Hx1q1sPyH56RxRSrFnxpYp9TXyPyWUnK9lydeVtlTClcw8U5jv70LCcFmnwc3WYyHt9yyWXdO5wNdmvPwqjuyzl2HTmWZJXRRg0wN7FXVn74HtVfhLItLezXbbOZLnDWkNpwNF2FwfjMz5xDLvr+Ag58ynBooiwIVxFIJVPe7eZw7w9zO7u4iDKqb2av+Jdn7mZQ3v5m7j/bmsr3V/StoffB4EQbpzbT+1tyt/oXE7j5atGdd4OpLmvKMSCbVV79vLW4C9IcKwdFd/1jsqwRVRxCRlBkycUkS46kLQCXcI9fkXp1dIR6mXGl/oMCcZxkojJGu123+0+9VUDsdYM8DqO+jKHZ9QQ3WudNlpAlKeHzaIYwQjOKzGVIRQQ3BXQ2JvV9FFqdUvGAcVWxq0DmchcIzLkvtyUuZpkKFIkPyH02K3N1EczFbDnE70rFXsl3eB13tUAsdcrYOaP/w7S1kaWPvPpiU6/qcdlw6HLB/+JYKDfi09sMG8F43kvCiZUsgQH4RnHHmhBu2e3vlgmsUViLSMrtUFzKor/j7cJmghOu1FIVtxq2pe7qEuK1FIRXJ0lARTF38A9pgoZfkaKloBHkoy9tY5Q2SZDArbS7e0JL1VQc2C9gWCnDhiqpsoJKUytdG1GZBkFRh1crJS4WAOvhDQKHdcAZTpg2qkCqtSPKqpECkQYnnBSqOIsY1Irh+Cbs13vrhtflRTYsU2nkhO9vb9N+KA+DLpBzSpFM5llV/C8LbBwHXu0C+pGydG9R6ML+kO7/pQuRxSi5Mqdb6hy349dtrN7jZwupVGr2M+T5/NX7/fTx8w8d6LN49jJ+NH41Pi08fnr16MsDq1TDe+VB92vlgPn/M9PhE8vi3V+kX8UFHzx6Wnz99UZ8/jdXnj+8M+/jwaSRSEb38lcfVw5NoZ5u/fvZq+8vH4Tx6+ev2lw9Pii8W+a/bX05Pt+P8zbNIPCWY4vOn/+b7Jy8e7H1/8X3v8MX53vfsyYC9+Xby7Dx+snf64lH/y1j19/aj30++meLdw+TBm0/80WPcw4/icPt1HHStgYuMC/zqVf3V8v2VlL2wRrG7Tu0HMkeTktHNaU3OlaTSryJDRoVIqgI2Y1wAiU79E60AlZLqep3+GGXXCWJ3e/vrsBHCw8tCGAubU7ZVkIfyFMX/L6fd6Y2bnkg9z63Vuygn4A7I9gdLzHbbHZMa41JxUwWjo4vgvM8K3nf9o6PjxXEYkGAlxf2F1JZiZtJgFGytpgGoGNXGmEcXbg02C00zkVDa99JiYwXfOhsGi3B1xNqleSW0NmzGxax/7ajjltMD0oYT+BK/baBW8N+RIrVanF2oMOBkBSky8nVIgKTkd20O5IVXlc9OrE04tDpZTSH4DMJSUmD1rFoT5nei/CMfYtuouQmag5ajoAls6WcTqh61ltdEhT4oHNpoamd314YdPw+tf/7gsXV9dx8tjp2EO26gzTp1fRl3abN0KPuDmouptAqohbJfoDggJ4DM/Gx42e/HLJY5+vJSD/6P//m7HeHdBrsK/wb7pYJCzlFRZbOt7M3wnNOxS8DW/dA2rWFvRlieodaU6xAGZ64omc/svZ8/c2NWsIhqg6najwsj3dV5Z+nrAXxMkfKi1HVPuSvQM8xouUMmpS2XNRJYaWTeLXyGuVSnUyKJapojqq9ETU4j+iEoUiZiSl06ew5BKqDyYPIOCsU1AuM5Advy5umUx5wQ0yalWGwgZ4LNkCYLbfxBUih8daSSETl5Wmalc2OoRhPROBZt6nQAz8lttIxTY4KG8QwT58Ho0HmQ9Z5Vlx9H5K0XND2PUbd1EBmeobLr1/n/ZZZBIY3zySlY6uqWEBnFhKYIxxHkVdOIr3ax7BwJqwZAWVo6H8i9JAPIuDilYuE+HDVm9hEjzQ22sdd8Pr+0l9xfHvOSm7SMQGEh23Ez22h3nu7w5uM+rXxUud6fHlD1fuw9kivm3LLAW/URw2J7xPj1zAr+X6sDaLvPeIxCY+dAePry7Ws4gweD7SDs7J63IHjr9fjZizcHLwgv7e9u/Q0H24NtmzCS2uRMdKayLxqaBw6rK7eTH948hNg8hNg8hNg8hNg8hNg8hNg8hNg8hNg8hLgbPG0eQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQmweQvwbP4SoL8fJ6doqMsZFp+DI1UUcrTyPOA6DlOomRkfBxQVdFbxX2WJBzd9KVFR0cRwGZ0xxSoLakovQ1xbQbfwpVsEoeObSpf1Dmj50hmiv/1YqTag0wo14arV0LWy3tOPt/sFhEAZR/YQjlwmNUWxOzzvYPBgF5PzalyBWwLaIn9n63IyJWWkLBAKHl0oiWGnS5XqKU1tPUf/o1BkwUXWoXC60cKzQX2Js7YD/oCu437H6zwbc9Vw5oJathyYNHi8Wi/8F+DKKLQ==",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"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.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,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.f6d4feec.js b/assets/js/0028a090.f6d4feec.js new file mode 100644 index 000000000..d98de8cb6 --- /dev/null +++ b/assets/js/0028a090.f6d4feec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),r=(s(62316),s(51039)),l=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),p=s(9472),m=s(85162);const h={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:"eJztW91y27iSfpU+vMlERcmS4ngS1dbWZpJMxpkkzibOr+3KQGRLhE0CDABaVlK6O0+yj7ZPstX4ISlZspPJqRNvlW5sEWgA3R8aQHej8TUybKqj0VF0iEWZM4M6OomjFHWieGm4FNEoOswQQjU8UmxiuJjCg5f7gIKNc9RQaVQajIREIREllTay4F+oFkzoOQaN6pzaMg3jvMJScWE0TKSCKQpUzHacyqQqkCpm3GRQKkxxwgWmoI2qElMp1D14U0oBukoS1HpS5W5kLgXICbB6zBhMhpZVhaZSQgODSvDPFUKnI8enmJj9tNOBX1LUfCqYwZSYC80/8fR2DLOMJxkkTMAYSdSUJPUMY4vdMaM6KeyYusSETzgR+8568CBNOfHI8nweA4NOp1J5pwNcQ6nkOU8xDaPJyYQgZRZa4MKgmrAELVZIvYipHSZ0DkykMGEJz7lZhhFSro3i44pG7h2LY3HIyxG8KXPJUpjLSsHLR7835EYClR11Oo9wXE3hzX6nc/JLZkypRzs7rCx7skRBaOVsrHuJLHZSIizTicUKFVKvFi9kmudzYGkKM55O0Wg7IQISWc4hkVKlXDjVKNkUQVTFGJWOrTSFVAhcAAOFLJ13jexWGuHp64MXBEPBTA9e5pWO6+FSrjAx+dx1T/AEqW652dnbJR3iYhpDwc4IJW7gc8WTMxJbo7BT61XGYtXpvK7KUipSjHdOhFGnQzW/YS5nwBRa+kQWhRRQMsUKNHY1ZMzYaoWfK64wderM8jxgMaJuutDpmHmJo04H9kXKE4LDTe28RNJmR91zpAQTkb726uVIW+CR/jkVIlRmzM1omZPyEKlC0kzDz3G544sY5tTxIxQycJBJxb9IYVhuJ+QcleEJy9sTRwxadTdMWbUrJRcmlPoR4IOfIJo/Oy1es4i1lOAquLA1GuGc5RVqz9Ushoy4eoWlQm1Xme+XoBQpZMin2cbxWHpaabPUMVQ6rJ3AhR8rzJOFFy1sE5ZrBD5ZwrJgZ9gaDWTp1nQPfptDihNW5SYGTjpnVIU9eCENsLLMeWL3Q1rCbrOpFHbtLHuF8IwIVtg5fun2BNoFUk77AS1PqrRd+DaBO9I0t4mQeHbtmIwJkGJlohOZS0Xdr+iQLV8GEhIpDArTgwfnjOeWeyetBi6SvEoRxjlLzmK7ncegaAOjaZljnstZ7FTektht1YJuAQKNOamhFCSAkH54rpuNs3eY0cYYVhTVBajtGFy3UfXrdiJpYIIgLDLAgvE8tsDFcCrHYLjJMaYlWzIxjyF1BwVemLG8iCHJMDmzvxRLuYRxZYwUTq5UyTKVM+Gx1PzLmtVIpd8P5DCG3Rj2YrgXw6Afw2AYw2A3hsFeDIN7MQz7MQyHMQx3YxjuOXaG9zzErMHVDz4YOmBNC1C42YjSbvuMa7uaaZvU9c47W9p5j8WgZ8H3a8gW//XXX8fi67EAOI5oTR1Ho+OoJjmOYnB1tFUeR6NBDL7g4jgawZ3hr4FgTt97hKz7ntH3gGbCfWf0PRwci4UfdGiZMawor2CEqv/1TIRPr0tUaEemsrCdUSHtQ46WamjeqLRmiyoWjUB3SCAuuOEs15tlChQ3T6yGsxXJdkkyq72bxbLVN0+mwFaosfulq7L7a6uKtgDLxHBF/Lu95nTZIL0b8KYJ77n6Edn3SPZ6r9oMQE1y81Bos/YjUPzas2aA3as3A+EJbh4MDWM/AsI9AoHOqc0IUO3NE99zFSr8ue/q+rvdwd3usD/cbVE4X8kRFEU3Tbvz+fwH4AMLFpk/fmxrTHpj1dl45JBOlCzWeCLWUWiovJlkfwfr/TnZ7GOsfWJyApdd6uD+tQ1uI1M2v6VdV6Gpt9McfWOpzVts2iriw7rCSSZ54pknmmCljcnb6xEIXQI93Xn+fKcFoyvsFkXAFkIpfXct7O3SouilaW+Vdml2WqUFpGkMa8rXV6QpFEWxqdxV0NF4LO7TIvBm2uZ14Alu3lJoGFu7GlZOjYwLX+G1A1YIFE6rnCm8IF9Tcyms9D+4z6ysk7BMGoPduqXWo3PxHCsS/HLgDfPbXoWJ++UOqOT6dpeEaneicIoXtg8XsSNmeGrjaDEF1zLy2liw/6XI502Ixn4lrOQUHsjRGFuKJuktM3EsBn174Hgn4IoTx1PcPEVrcRYqXTSBqo+Oo4J5eyGaYPNbmgzVcXTSKIn1eTFttYV1jeGkpZMsJaSJ2EYjGvYynmLOxpg3dd+lqG1R/KS3gKGKgovaTbfs9sPotpZdrNT6ysWaJeBEbute2FmDBgeMIec6xCqWAWu39sEcG2QT6EKyY4TQAMb1ybBuSThMW4EemvjVOI9Gs8wY0xCaron12BkIa9XPzDUjEB1YwjqOFgbbNIAXYWlm2rhQHwUXvKiKOiA4qXsNiBX+hG3DRS0p2BxGaM/upRHYxTUj+Gj5hgGOxcC68MH5t3sCrDfCPMnN2xRanP3IprB0ZHm67z5wvn+5Be7by23NOUWk7oSql5revNZ6cECnAsUcXSOKKCUJloaiT0sLcWDDJu140OaDoU118/Rghbufrgu1KhAu36YMbRF+lkIci4ELPBXuimNT1Kmw037TlMCztXLyRXEkS3uvKcV+Go2ilG5Pw51dFNuuUZvfZDqPRl8jHyamnz4QSy13TjXdw36NdJJhwehXYIlubic8p64o1olKR3FkYwR0jUugRaPI3XNGMdm9Jd3hoKY+bLvR10DlLsai2PuL0ShyN2ZRHOEFK0oi9kWAIpHkmNkuFmHEq/qqS5q+tP1R32BSP3T19De7sU0XK1fXf6undg+LBtemM6YUm0ert+Thzik4F65dHWDP5+H054YsiSZeT2RRHHGDRXuUDbOm5PcjnaAkSWwI8Xvb2mlhxXePSe3KTIq/1dDH+9dg/o0oudrLAy9P2QPybDANxmS3uZaLwYbGe9dpTKC30rJpe0xnG10a83DTdW3rtkhnsspTuotBpnr21vRvX8nbrAyWJ5XNEqh37yXJalZryQaLOLq4XpgLSGQ33AXDLzlODFRliQoSqQSq2+0o0I0Rbri7u4ij+fXizf9fivcrTd7seune2Uv0JsHgZ/B6594ijrLref2jvub/iczu7i2asy5yqU51ptBYpvNPYd9aXEcYDhWio7STfXGgUlQtIMZS5sjEJST2J84xlXCLbJFbPhBjb2q50uFAgRnPc1CYIGV6uFtpv1eBNzrcNS74yzLyaR9TgbXmdDXWRCVCf9p1OEYwik+nSPksnoK7dCZ7D40sySiPxjiu2ISumW2GisJzLisd2MuYttfFOZLBaDLkLimCi+my69tCx2YHtGXvtWeHSuiQsylpB4cvvwFL65N3wWT1RbiT0vUBB4cvKeeFT7wd1oM3ukYiQMuWSIDsIjjnLNyR13v73DndKCwi0gq7lKLU89kmXbjMUMr1Wo7iJjhXp+Bd6rhJi6IpkpWhfCyfhwbaYKmXcLRc1EAeyupbtPIaJBlMKxvJN7RkQwKMDRg2OStcuPw+65mklQppOl4tiJKS/RqcAipE1Oo/BhTaNWcwYdqgiinpj5BXFXkedZd4UaLiKBJcA8HVS9it8cYO9+pH6VVSaGeFDPt9+rdiAISMPddp2kpizOf/iOJvdwKuNoFCduM6M6ixYH7Lhn/oUhRJRiZMpdbahw351dtr27nZwfnTbPwk4Qf86f6bL/uDF3xf74tXd5OH+3v7Z+X7tw+f3u/h/OkgGb6dvx++NR/e5Xr/VPLkj6fZR/FWjx/erT68/6g+vN9XH969Muzd3QdjkYnxk995Mr97Oh72+bOHT/sf3w1m4ye/9z++vV9+tJ3/3v94dtZPihcPx+IB0ZQf3v83Pzh9fOf5l8dfnh8+vnj+Jb/fYy8+nz68SO4/P3u81/24r7rPD8Z/nn425au76Z0X7/nePXyO78Rh/1kStbWBi5wL/BSm+pOV+xNN9sIqxe66aX8tCzSZTaOhNTlTkrIQyxwZ5cSpObAp4wIIOvUv1AJUSqqr5/T7OLsKiN1+/9OgBuHuZRD2hY0124TcQ3mG4t8raXt444YnVi8Kq/XOy4m4I7L10ZKw7XInpMakUtzMo9HR1+iiy0redfWjo5PFSRwRsJL8/lJqyzEzWTSKdlbDAJQXbX3Mo69uDdYLTTORUjj40mJjJd85H0SLeLXF2qW5kVobNuVi2r2y1Ukj6WuaDQf4kryNo1byP5E8NQ9nmyqOOGlBhoxsHQKQJvlVEwN5HKYqRCfWBhyaOVkNIYQIwlJQYPWsWuPmt7z8o+BiW6+5dpqjRqKodmzpZ+2qHjWaV3uFwSkcWG9quLtr3Y5fB9Y+v3PPmr67e4sTh3DLDLRhprYt4+53lg7lcFBzMZF2AjwoByWK12QEkJqfDy7b/Zgnsqjz+wL5//7zf2yLYDbYVfgPOKgUlHKGipLsbZJ5jhecjl0ituaHtmENe2PCihy1pliHMDh1+fF8aq8Iw5mbsJKNKU2d0iW5MNJdvLeWvu7BuwwpNkpVt5S7LT3HnJY75FLazG0jgVVGFu0cfJhJdTYhlii9fkypvqjJaMTQBEXGREKxSqfPMUgFlKlO1kGpuEZgvCBim2k/mfCEU8e0SSmWGCiYYFOkwWLrfxAKZUjUVXJMRp6WeeXMGEoXRjRORBsr7cEjMhut4FSYomE8x9RZMDp2FqTfs3wm/Jis9ZKG5wnqJosix3NUdv06+7/KcyilcTY5OUvtuaWOjGJCk4fjGApTU8PnTSw7RsrmPaCwLJ0PZF6SAuRcnFHeeheOajV7h2PNDTa+12w2u7SX3F5u84SbrBqDwlI27aa20O487eb1x21a+agKfTB5TQ9JkmCRbBhzxxLv+COGJfaICeuZlfy/VhvQdp/zBIXG1oHw4MnLZ3AOd3r9KG7tnt/A8M6z/YePX7x+TP3S/u7W36DX7/VtwEhqUzDRGso+rqnf2qyu3FZ8ePsmZ/smZ/smZ/smZ/smZ/smZ/smZ/smZ/smZ/smZ/smZ/sm598o/PZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzs81xLZvcrZvcrZvcrZvcq58k+PzNMg+2ylzxkUr982l6BytvNQ5iaOMUnhGR9HXr3Rr9UbliwUVf65QUf7PSRydM8UpSmuzf+KQ5kKJIWc4j0bRQxdw7h7S8LFTRnsTvZL0RFk6rsUDOy1X0razjF4evD6M4mjsXxMVMqU2is3opRGbRaOITGf7KMkiat+TMJsqnjMxrWyuSuT6pewcVplsObXnzKb2+B+tlBcm5i0ul3N+nCj0lwRb2+A/6Db4T5z/Z03uajY28NgGaprBk8Vi8X+DUCtx",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW91y27iSfpU+vMlERcmS4ngS1dbWZpJMxpkkzibOr+3KQGRLhE0CDABaVlK6O0+yj7ZPstX4ISlZspPJqRNvlW5sEWgA3R8aQHej8TUybKqj0VF0iEWZM4M6OomjFHWieGm4FNEoOswQQjU8UmxiuJjCg5f7gIKNc9RQaVQajIREIREllTay4F+oFkzoOQaN6pzaMg3jvMJScWE0TKSCKQpUzHacyqQqkCpm3GRQKkxxwgWmoI2qElMp1D14U0oBukoS1HpS5W5kLgXICbB6zBhMhpZVhaZSQgODSvDPFUKnI8enmJj9tNOBX1LUfCqYwZSYC80/8fR2DLOMJxkkTMAYSdSUJPUMY4vdMaM6KeyYusSETzgR+8568CBNOfHI8nweA4NOp1J5pwNcQ6nkOU8xDaPJyYQgZRZa4MKgmrAELVZIvYipHSZ0DkykMGEJz7lZhhFSro3i44pG7h2LY3HIyxG8KXPJUpjLSsHLR7835EYClR11Oo9wXE3hzX6nc/JLZkypRzs7rCx7skRBaOVsrHuJLHZSIizTicUKFVKvFi9kmudzYGkKM55O0Wg7IQISWc4hkVKlXDjVKNkUQVTFGJWOrTSFVAhcAAOFLJ13jexWGuHp64MXBEPBTA9e5pWO6+FSrjAx+dx1T/AEqW652dnbJR3iYhpDwc4IJW7gc8WTMxJbo7BT61XGYtXpvK7KUipSjHdOhFGnQzW/YS5nwBRa+kQWhRRQMsUKNHY1ZMzYaoWfK64wderM8jxgMaJuutDpmHmJo04H9kXKE4LDTe28RNJmR91zpAQTkb726uVIW+CR/jkVIlRmzM1omZPyEKlC0kzDz3G544sY5tTxIxQycJBJxb9IYVhuJ+QcleEJy9sTRwxadTdMWbUrJRcmlPoR4IOfIJo/Oy1es4i1lOAquLA1GuGc5RVqz9Ushoy4eoWlQm1Xme+XoBQpZMin2cbxWHpaabPUMVQ6rJ3AhR8rzJOFFy1sE5ZrBD5ZwrJgZ9gaDWTp1nQPfptDihNW5SYGTjpnVIU9eCENsLLMeWL3Q1rCbrOpFHbtLHuF8IwIVtg5fun2BNoFUk77AS1PqrRd+DaBO9I0t4mQeHbtmIwJkGJlohOZS0Xdr+iQLV8GEhIpDArTgwfnjOeWeyetBi6SvEoRxjlLzmK7ncegaAOjaZljnstZ7FTektht1YJuAQKNOamhFCSAkH54rpuNs3eY0cYYVhTVBajtGFy3UfXrdiJpYIIgLDLAgvE8tsDFcCrHYLjJMaYlWzIxjyF1BwVemLG8iCHJMDmzvxRLuYRxZYwUTq5UyTKVM+Gx1PzLmtVIpd8P5DCG3Rj2YrgXw6Afw2AYw2A3hsFeDIN7MQz7MQyHMQx3YxjuOXaG9zzErMHVDz4YOmBNC1C42YjSbvuMa7uaaZvU9c47W9p5j8WgZ8H3a8gW//XXX8fi67EAOI5oTR1Ho+OoJjmOYnB1tFUeR6NBDL7g4jgawZ3hr4FgTt97hKz7ntH3gGbCfWf0PRwci4UfdGiZMawor2CEqv/1TIRPr0tUaEemsrCdUSHtQ46WamjeqLRmiyoWjUB3SCAuuOEs15tlChQ3T6yGsxXJdkkyq72bxbLVN0+mwFaosfulq7L7a6uKtgDLxHBF/Lu95nTZIL0b8KYJ77n6Edn3SPZ6r9oMQE1y81Bos/YjUPzas2aA3as3A+EJbh4MDWM/AsI9AoHOqc0IUO3NE99zFSr8ue/q+rvdwd3usD/cbVE4X8kRFEU3Tbvz+fwH4AMLFpk/fmxrTHpj1dl45JBOlCzWeCLWUWiovJlkfwfr/TnZ7GOsfWJyApdd6uD+tQ1uI1M2v6VdV6Gpt9McfWOpzVts2iriw7rCSSZ54pknmmCljcnb6xEIXQI93Xn+fKcFoyvsFkXAFkIpfXct7O3SouilaW+Vdml2WqUFpGkMa8rXV6QpFEWxqdxV0NF4LO7TIvBm2uZ14Alu3lJoGFu7GlZOjYwLX+G1A1YIFE6rnCm8IF9Tcyms9D+4z6ysk7BMGoPduqXWo3PxHCsS/HLgDfPbXoWJ++UOqOT6dpeEaneicIoXtg8XsSNmeGrjaDEF1zLy2liw/6XI502Ixn4lrOQUHsjRGFuKJuktM3EsBn174Hgn4IoTx1PcPEVrcRYqXTSBqo+Oo4J5eyGaYPNbmgzVcXTSKIn1eTFttYV1jeGkpZMsJaSJ2EYjGvYynmLOxpg3dd+lqG1R/KS3gKGKgovaTbfs9sPotpZdrNT6ysWaJeBEbute2FmDBgeMIec6xCqWAWu39sEcG2QT6EKyY4TQAMb1ybBuSThMW4EemvjVOI9Gs8wY0xCaron12BkIa9XPzDUjEB1YwjqOFgbbNIAXYWlm2rhQHwUXvKiKOiA4qXsNiBX+hG3DRS0p2BxGaM/upRHYxTUj+Gj5hgGOxcC68MH5t3sCrDfCPMnN2xRanP3IprB0ZHm67z5wvn+5Be7by23NOUWk7oSql5revNZ6cECnAsUcXSOKKCUJloaiT0sLcWDDJu140OaDoU118/Rghbufrgu1KhAu36YMbRF+lkIci4ELPBXuimNT1Kmw037TlMCztXLyRXEkS3uvKcV+Go2ilG5Pw51dFNuuUZvfZDqPRl8jHyamnz4QSy13TjXdw36NdJJhwehXYIlubic8p64o1olKR3FkYwR0jUugRaPI3XNGMdm9Jd3hoKY+bLvR10DlLsai2PuL0ShyN2ZRHOEFK0oi9kWAIpHkmNkuFmHEq/qqS5q+tP1R32BSP3T19De7sU0XK1fXf6undg+LBtemM6YUm0ert+Thzik4F65dHWDP5+H054YsiSZeT2RRHHGDRXuUDbOm5PcjnaAkSWwI8Xvb2mlhxXePSe3KTIq/1dDH+9dg/o0oudrLAy9P2QPybDANxmS3uZaLwYbGe9dpTKC30rJpe0xnG10a83DTdW3rtkhnsspTuotBpnr21vRvX8nbrAyWJ5XNEqh37yXJalZryQaLOLq4XpgLSGQ33AXDLzlODFRliQoSqQSq2+0o0I0Rbri7u4ij+fXizf9fivcrTd7seune2Uv0JsHgZ/B6594ijrLref2jvub/iczu7i2asy5yqU51ptBYpvNPYd9aXEcYDhWio7STfXGgUlQtIMZS5sjEJST2J84xlXCLbJFbPhBjb2q50uFAgRnPc1CYIGV6uFtpv1eBNzrcNS74yzLyaR9TgbXmdDXWRCVCf9p1OEYwik+nSPksnoK7dCZ7D40sySiPxjiu2ISumW2GisJzLisd2MuYttfFOZLBaDLkLimCi+my69tCx2YHtGXvtWeHSuiQsylpB4cvvwFL65N3wWT1RbiT0vUBB4cvKeeFT7wd1oM3ukYiQMuWSIDsIjjnLNyR13v73DndKCwi0gq7lKLU89kmXbjMUMr1Wo7iJjhXp+Bd6rhJi6IpkpWhfCyfhwbaYKmXcLRc1EAeyupbtPIaJBlMKxvJN7RkQwKMDRg2OStcuPw+65mklQppOl4tiJKS/RqcAipE1Oo/BhTaNWcwYdqgiinpj5BXFXkedZd4UaLiKBJcA8HVS9it8cYO9+pH6VVSaGeFDPt9+rdiAISMPddp2kpizOf/iOJvdwKuNoFCduM6M6ixYH7Lhn/oUhRJRiZMpdbahw351dtr27nZwfnTbPwk4Qf86f6bL/uDF3xf74tXd5OH+3v7Z+X7tw+f3u/h/OkgGb6dvx++NR/e5Xr/VPLkj6fZR/FWjx/erT68/6g+vN9XH969Muzd3QdjkYnxk995Mr97Oh72+bOHT/sf3w1m4ye/9z++vV9+tJ3/3v94dtZPihcPx+IB0ZQf3v83Pzh9fOf5l8dfnh8+vnj+Jb/fYy8+nz68SO4/P3u81/24r7rPD8Z/nn425au76Z0X7/nePXyO78Rh/1kStbWBi5wL/BSm+pOV+xNN9sIqxe66aX8tCzSZTaOhNTlTkrIQyxwZ5cSpObAp4wIIOvUv1AJUSqqr5/T7OLsKiN1+/9OgBuHuZRD2hY0124TcQ3mG4t8raXt444YnVi8Kq/XOy4m4I7L10ZKw7XInpMakUtzMo9HR1+iiy0redfWjo5PFSRwRsJL8/lJqyzEzWTSKdlbDAJQXbX3Mo69uDdYLTTORUjj40mJjJd85H0SLeLXF2qW5kVobNuVi2r2y1Ukj6WuaDQf4kryNo1byP5E8NQ9nmyqOOGlBhoxsHQKQJvlVEwN5HKYqRCfWBhyaOVkNIYQIwlJQYPWsWuPmt7z8o+BiW6+5dpqjRqKodmzpZ+2qHjWaV3uFwSkcWG9quLtr3Y5fB9Y+v3PPmr67e4sTh3DLDLRhprYt4+53lg7lcFBzMZF2AjwoByWK12QEkJqfDy7b/Zgnsqjz+wL5//7zf2yLYDbYVfgPOKgUlHKGipLsbZJ5jhecjl0ituaHtmENe2PCihy1pliHMDh1+fF8aq8Iw5mbsJKNKU2d0iW5MNJdvLeWvu7BuwwpNkpVt5S7LT3HnJY75FLazG0jgVVGFu0cfJhJdTYhlii9fkypvqjJaMTQBEXGREKxSqfPMUgFlKlO1kGpuEZgvCBim2k/mfCEU8e0SSmWGCiYYFOkwWLrfxAKZUjUVXJMRp6WeeXMGEoXRjRORBsr7cEjMhut4FSYomE8x9RZMDp2FqTfs3wm/Jis9ZKG5wnqJosix3NUdv06+7/KcyilcTY5OUvtuaWOjGJCk4fjGApTU8PnTSw7RsrmPaCwLJ0PZF6SAuRcnFHeeheOajV7h2PNDTa+12w2u7SX3F5u84SbrBqDwlI27aa20O487eb1x21a+agKfTB5TQ9JkmCRbBhzxxLv+COGJfaICeuZlfy/VhvQdp/zBIXG1oHw4MnLZ3AOd3r9KG7tnt/A8M6z/YePX7x+TP3S/u7W36DX7/VtwEhqUzDRGso+rqnf2qyu3FZ8ePsmZ/smZ/smZ/smZ/smZ/smZ/smZ/smZ/smZ/smZ/smZ/sm598o/PZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzvZNzs81xLZvcrZvcrZvcrZvcq58k+PzNMg+2ylzxkUr982l6BytvNQ5iaOMUnhGR9HXr3Rr9UbliwUVf65QUf7PSRydM8UpSmuzf+KQ5kKJIWc4j0bRQxdw7h7S8LFTRnsTvZL0RFk6rsUDOy1X0razjF4evD6M4mjsXxMVMqU2is3opRGbRaOITGf7KMkiat+TMJsqnjMxrWyuSuT6pewcVplsObXnzKb2+B+tlBcm5i0ul3N+nCj0lwRb2+A/6Db4T5z/Z03uajY28NgGaprBk8Vi8X+DUCtx",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"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.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,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"size:"})," Specifies the size 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 size of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "size": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.e2b36df1.js b/assets/js/2c586be5.e2b36df1.js deleted file mode 100644 index 207f3fa5b..000000000 --- a/assets/js/2c586be5.e2b36df1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),l=s(58219),r=(s(62316),s(51039)),t=s.n(r),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztO9ty4zaWv3IGL512UbTldneyqq2t6XRnZ72TxK5pp1JblsuByCMRbRJgANAyx6W3+ZL5tP2SrYMLScmS7c5OTby16oe2CBwA5wbg3HDPLF8YNrlkH1XWVCitYVcJy9FkWtRWKMkm7KJA+KCRW4QIBe/PT4GXpVoaaAxqA1bBAiVqgpK4hDzOB7MWaq1uRS7kAnJuOSyFLWDGDb47AZSZyjGHuSgxncqpvBD1BH6qS8VzaFWj4fzjv3ez0TLUdnlw8BFnzQJ+Oj04uPqqsLY2k8NDXtepqlEasZAln5k0U9VhToB1Pn+dwLJAjTQrZFwCciPKFniew1LkC7QmAVughEzVLWRK6VxIbtEkUPMFgmyqGWqTAJc5VEojCAkcNPK8HVk1agzCf346+xHmSlfcpnBeNibplsuFxsyWrZ/eFthR9cpEbhirhVwkUPEb4paw8Gsjshsi26DM6S8NfH9+6nh1cPCpqWulLebwsydhcnBAPd9iqZbANTr4TFWVklBzzSu0TlwFt65b46+N0Jh7ofCyjLyYTOUIDg5sW+Pk4ABOZS4yYoabkFpBzQNs6kGJSQT6qcZMzEUAHbAOlIRlIbLC8WTJvTzrkmceTY2mxsyKW1yf+C6Blib+iFJFDAqlxV+VtLx04rhFbUXGy6HYCEECNZZrS+yslZA2toYV4L+CeEh6TihBrwi1nJhVCel6DMItLxs0AatlAgVh9ResNRqn6mFeYqTMoUCxKHaux/PPjbFrE0NjCM0hFmGtKCXHXnRsm/PSIIj5Gi8rfoOD1UC5PczLFL5tIcc5b0qbgCCNs7rBFH5UFnhdlyLjsxJJc4E2D7eNxpGTclCHgIjklZPxudvRaIBDLuZz1LQ5qdNNEcZE7EjP+iPA7RxbcAlKbgg6U6XSNP2GDrn2dUZCpqRFaVN4f8tF6bD31BoQMiubHGFW8uwmgVnZYAIac79zW6RzKwmnEIEAN4HpjkFgsCQ1VJIIkCosLwyYgFUedt/3wjj50rYx3U5cru3EqRyncHDQcdU1//LLL1N5P5UAU0ZcnrLJlHUgU5aA76PNM2WTcQKh4W7KJvDm+OsI0NL3u+Nv4veSvsfjk/hd0PfxeCpXYVFi84/KOiG+t1AiJxIk9mInQrtTgaSJPCtcN+oU3hOpHehcYJkbJ+BMVXVTGqVbOvEDK9OpPHbUW17Vj1BO3f94quNn0AtqdCtTW6SQGmkreFjqIS2m1g4t6lj1HHxDBAkprOCl2U1ThHh5ZPWYbVB2QpRhxUW5myzX/fJoimjFHrdlfZfb4g9ofZv2p9kOUv3sL43SgNWzCX1HhH5WM7DClo9Q24G8PJKHqD2b7q9Td6FUNZftbqoDwMujuUfs2RR/QxTn3D4iZOp9ebQGrGJHuDt839HJaPx2dHx0fDKA8Aa2B6iqUZ6P2rZ9Lq+guwfDQs7gCAaNtwPIiZlrVW2xVp0x2UMFm8T9jhbeD2TXzaLJgzm5Cc4OjdZD5yAMjTKrct6+Mn6qODTYRR6+t63bAZqui/BwzlJWKJEF5AkmmkQz8gdSYsKIOJwf/vDD4YBnvnFUVZGREFvpe+R4PGytqjTP003YNVEMWivI8wS2tG/vyHOoqmpXu+8ggU7lv5DGW7yzM3W3W+kDwMvT+x6xraq/cdIXQoaOoB2wAaBx0ZRc4x35I0Yo6aj/khNkY1PEPcE7y9j5Kc4odF6gxx++Ogtuxuugr4Tq+gTU8vS4BxQMJ9G4wDs3R9YYqypCRuScZkjANFlBZryLSZCXoWTZ9h67+8p4LchfLNFa14o2S9eRmMrxkbs3CsxuHlWqCPHytGqAWez07iV1X05ZxcMdz+bY/1a2QD1lV90Y7wRhPhgL2wbD1UABeU6cJmDnnvboFSLHks+w7Pt2a+UQ7yDhAReooxKyc9IcbkdxKdfL7zZ6Q+dqi757+oaKFs/MqK6RoVAKEz3Vde4MRwdX3gVYJKKL2cwQ4oCBc7RN/z0DB24+SXnTyzdo1xHjBuLQLZ6+Y3fcmEEMT6xAcOAAuyhKXGzXAoGENckM+UJzVEKKqqm6cNC8mzVyrAp355BdNJKCjHGFoXQfrMDvnliBYi+7F5jKsXPXc63qXC2lOwBguy0VQF7eCTDA7H9zAqxdRgHu8avky/dWRHW4t7bcQATq755uX5ndGyuFMzrvKarhBwkDPMuwtphvHPhjF57QPBcKZo21Su4+8odQL0/oG9j9cwXfyZ2Y8DzJD/H93aTvYzmVD1zvCuRUTsIvTd4RrWcbdyxhqqYEjVDyNGcTlrmcTkxCsMQti8Z+q/KWTe5ZiLDSzxAipqGHnw1lhe6ZyQqsOP2K6FIeifI4LGE+XGhYwpzjTkklYiibMDX7jBmtVmtCxwo0NIcbN7mPUD4RwpLg6rEJ8xkSljC841VNwGwjhVTnc7aKCz42VdfST2Xcjy4jQ/OsJcF+02wfBzOsEkbJi984E0VsPW0VXqgPihotfuStGUzo7zy2mb6jMbRbsjAKct4a2hSN8dZJxsusKcmZxLta6LbzbJ1HOdCPDtFupQ7R8dtVL/QeJa41b1nChMVq2L5DCbT6csllqIgzLgD4pWM/K5wh/jE0ULbQyYlXX4zFZ4UwQyejulDyi8ePj9+Mj8dvxsc0Q0gg/HY++t6HGKwrxnvylTCPFuuoj+sn4ELf6VPKGeEd2XyBTyvjxa6M4CCzYwrVlDmlpZDr1CXmfnPOd12/u4skfUKbVwm7e5qYO8jUKKYb4asS5xaaukYNmdIS9ethEOnFEHd8crJKWPs0ee3/SfK+JuEtn6buZ5en7XPYvweub75ZJax4Gtf/6DLJvyOyJ+9W/e26YTxcz1TeXsdza/UUYLwoCG6uyhw1GSQPz6v+qKEThiogrjfP+ZlSJXK55aARpi94iLUq5OOSAx2iqMsCyfbtXV83e29bBnfbY5vCxSBH3JmWU0YW2pSlcDofWKrOa15DYQDr8tBSwSu33rVp3DH+6jB8E49eDas1KL/aR48jCg4YLFZ16codlqIsCW+611Po/jnLr+MkIRCvy7jw01fFBx9xcwuGQeu1AhBsxxQ+cNkl4IkdcxVDcnB/36mB047VCu7vSaqor+nSXa2SvoHWWmtw96pv0ZihuF0b1TVhP7BrGwz1Js41mTi+ISRahgiIhRRycd3ocrVKH6hhL6Nn8+0Bm4LsaJL/BxwjdE7lmc5RP2Pnns59gEvBK1LWVyF66zgjtLFhP3p1Dwj7/MoOLod8N8XGvuv2t2lmhqBknK/fP1aLxQKp+iFAuMGhYMQXQ9AwhxWf09Z2dU4ab4VqTESv4KYzuXOCEH67CLlYD6ENuONqTIa0p9u2rqRil7OL82fw0sX2Rv4k8o6mp9LPAWcX51Q5JebBt0vhJ9NxIrKWr4EA+VpwK7hnbtKbb60P3qF0HPHH5lqZWxpqlkbwEKFcmK0YJX1Ev6szfDBxX1pHIlKNpZo+4d18MBZrs8ZHh0XHyAvVPEcrn+Akh0Xjcn2WbuV4NLosQ1/5JKSxuvGBS8gbHYu9gloQZIbG9HyKXCGgwfwJoDR+OIc5NxZ1Ao0UxHndUJyjmxLvatQCZYZbWPD4Le2v8d63D+pHRXpKGu9oHB8d0Z91VnVFomFSSs4QXfOmLNs/sOT5gYXHvRzfvN1yeMxtKT6L47/eZbfH53Q4NfqL3cZoZTW6pLpP4vWoU3LnRA44K2QpJF5Htl0fHx1dj4m3q4SdbGPfJ1WhLUh4S2LiUiuqCK2pUovOphb4ggsJdOfrfyA3UWulHzfCvgyzx5hwssaEtw+ZcCpd7sfVGV+oG5T/XEqHy1u/PKF6Vzld8QECJjyQ62drxA7bPZEGs0YL27LJ5T27G/FajHz/5PJqdZUwYqyioFytjMOY24JN2OGDGJ1BfetiLJf3XnU7bTRc5pSfeWD381oc3o7ZKtkcsdVL2AltLF8IuRg9OuqqJ/UTicNzfI3gPqhRiz8jRTUCP4dQCROkBgVyMhqIgyTlv/QByu+irGLocFs0sJfJZnxv83jfErGLAbu1GNz2ENz47SD4dRnjWC401UWmtgWbOtJj+KiLHg0CQoN40GWvs13oJUZexi5kcXxy4nz7r8fOCX7zjfMvT96tnJb1vhZj6/6UizJvegWMrVu7cVBny4VRvUHiM7trN2u8bYWcKyf8IJGzGuUnuslpj92OH/rnWGbKRy7p+ovg//23v7sRUZLuCPgDnDUaarVEPW98Qfi8xDtBd+fgpUL0/pBXJRpTtkBX5sK9WcjFwhUHxIsz4zWfiVLQoUFgykdDB+eOSeHn3n98pX2dxC2WdNZAqZQr4bcKeGNV5daIF+NS6Zs5oZQAhxlVfaMhyw/jEJQFlxm5oH4vJaA00JMFuuJrLQwCFxUBuwLd+Vxkwt24SlrNMwsVl3yBtFji4gTEhTrWbGs1I0vNqLLxtghVjiNaT6JLr6TwkWw/R7iLAqPlosTcmyEm8WZg0OXwJGJGJndNy4sMTV8sVeItand2eCO+KUuolfWGNTnKQ9nSRFZzaegCDhHoIJqOfcFOcmvkvE2B8rZ0OZGNSApQCnnjHzBcdmr2M86MsNjHSJbL5YNz7PX6mD8JWzQz0FirftzCNbpTbzi8+3hNhwTqypzNP6G+FVk0GXaseeiAD8P9xr07Hg8NXos/bg6gu6YUGUqDg9vo/Z/Ov4dbeJMesWRwcj8D4cPvTz989+On72heulv8/hunR+mRC+wqYysuB0ttPAba3LqDzNH+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dDvSun+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dBjb4dC4pnsr8O65EIOimd8tcLl5ouiq4QVVM4wuWT395Sl+InqA6n51wY11UJcJeyWa0ERWFcJkcSMP6W6b5Byzh98rHZ0QesnXiddYmyjAIQKFvyI905gj8IOKy7Ozz5dsITFgs5K5TRG8yW9iOJLNmFkCLvXU47b7qEKdxXmJZeLxmXfmZ+XChV4Y4v1KocbV+UQfgyS+Fy2AyzXyx88KfQ/EbZ1wL9SIu3P2P5bB+57dg4IvI3QJMKr1Wr1P5fHXwA=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztO9ty4zaWv3IGL512UbTldneyqq2t6XRnZ72TxK5pp1JblsuByCMRbRJgANAyx6W3+ZL5tP2SrYMLScmS7c5OTby16oe2CBwA5wbg3HDPLF8YNrlkH1XWVCitYVcJy9FkWtRWKMkm7KJA+KCRW4QIBe/PT4GXpVoaaAxqA1bBAiVqgpK4hDzOB7MWaq1uRS7kAnJuOSyFLWDGDb47AZSZyjGHuSgxncqpvBD1BH6qS8VzaFWj4fzjv3ez0TLUdnlw8BFnzQJ+Oj04uPqqsLY2k8NDXtepqlEasZAln5k0U9VhToB1Pn+dwLJAjTQrZFwCciPKFniew1LkC7QmAVughEzVLWRK6VxIbtEkUPMFgmyqGWqTAJc5VEojCAkcNPK8HVk1agzCf346+xHmSlfcpnBeNibplsuFxsyWrZ/eFthR9cpEbhirhVwkUPEb4paw8Gsjshsi26DM6S8NfH9+6nh1cPCpqWulLebwsydhcnBAPd9iqZbANTr4TFWVklBzzSu0TlwFt65b46+N0Jh7ofCyjLyYTOUIDg5sW+Pk4ABOZS4yYoabkFpBzQNs6kGJSQT6qcZMzEUAHbAOlIRlIbLC8WTJvTzrkmceTY2mxsyKW1yf+C6Blib+iFJFDAqlxV+VtLx04rhFbUXGy6HYCEECNZZrS+yslZA2toYV4L+CeEh6TihBrwi1nJhVCel6DMItLxs0AatlAgVh9ResNRqn6mFeYqTMoUCxKHaux/PPjbFrE0NjCM0hFmGtKCXHXnRsm/PSIIj5Gi8rfoOD1UC5PczLFL5tIcc5b0qbgCCNs7rBFH5UFnhdlyLjsxJJc4E2D7eNxpGTclCHgIjklZPxudvRaIBDLuZz1LQ5qdNNEcZE7EjP+iPA7RxbcAlKbgg6U6XSNP2GDrn2dUZCpqRFaVN4f8tF6bD31BoQMiubHGFW8uwmgVnZYAIac79zW6RzKwmnEIEAN4HpjkFgsCQ1VJIIkCosLwyYgFUedt/3wjj50rYx3U5cru3EqRyncHDQcdU1//LLL1N5P5UAU0ZcnrLJlHUgU5aA76PNM2WTcQKh4W7KJvDm+OsI0NL3u+Nv4veSvsfjk/hd0PfxeCpXYVFi84/KOiG+t1AiJxIk9mInQrtTgaSJPCtcN+oU3hOpHehcYJkbJ+BMVXVTGqVbOvEDK9OpPHbUW17Vj1BO3f94quNn0AtqdCtTW6SQGmkreFjqIS2m1g4t6lj1HHxDBAkprOCl2U1ThHh5ZPWYbVB2QpRhxUW5myzX/fJoimjFHrdlfZfb4g9ofZv2p9kOUv3sL43SgNWzCX1HhH5WM7DClo9Q24G8PJKHqD2b7q9Td6FUNZftbqoDwMujuUfs2RR/QxTn3D4iZOp9ebQGrGJHuDt839HJaPx2dHx0fDKA8Aa2B6iqUZ6P2rZ9Lq+guwfDQs7gCAaNtwPIiZlrVW2xVp0x2UMFm8T9jhbeD2TXzaLJgzm5Cc4OjdZD5yAMjTKrct6+Mn6qODTYRR6+t63bAZqui/BwzlJWKJEF5AkmmkQz8gdSYsKIOJwf/vDD4YBnvnFUVZGREFvpe+R4PGytqjTP003YNVEMWivI8wS2tG/vyHOoqmpXu+8ggU7lv5DGW7yzM3W3W+kDwMvT+x6xraq/cdIXQoaOoB2wAaBx0ZRc4x35I0Yo6aj/khNkY1PEPcE7y9j5Kc4odF6gxx++Ogtuxuugr4Tq+gTU8vS4BxQMJ9G4wDs3R9YYqypCRuScZkjANFlBZryLSZCXoWTZ9h67+8p4LchfLNFa14o2S9eRmMrxkbs3CsxuHlWqCPHytGqAWez07iV1X05ZxcMdz+bY/1a2QD1lV90Y7wRhPhgL2wbD1UABeU6cJmDnnvboFSLHks+w7Pt2a+UQ7yDhAReooxKyc9IcbkdxKdfL7zZ6Q+dqi757+oaKFs/MqK6RoVAKEz3Vde4MRwdX3gVYJKKL2cwQ4oCBc7RN/z0DB24+SXnTyzdo1xHjBuLQLZ6+Y3fcmEEMT6xAcOAAuyhKXGzXAoGENckM+UJzVEKKqqm6cNC8mzVyrAp355BdNJKCjHGFoXQfrMDvnliBYi+7F5jKsXPXc63qXC2lOwBguy0VQF7eCTDA7H9zAqxdRgHu8avky/dWRHW4t7bcQATq755uX5ndGyuFMzrvKarhBwkDPMuwtphvHPhjF57QPBcKZo21Su4+8odQL0/oG9j9cwXfyZ2Y8DzJD/H93aTvYzmVD1zvCuRUTsIvTd4RrWcbdyxhqqYEjVDyNGcTlrmcTkxCsMQti8Z+q/KWTe5ZiLDSzxAipqGHnw1lhe6ZyQqsOP2K6FIeifI4LGE+XGhYwpzjTkklYiibMDX7jBmtVmtCxwo0NIcbN7mPUD4RwpLg6rEJ8xkSljC841VNwGwjhVTnc7aKCz42VdfST2Xcjy4jQ/OsJcF+02wfBzOsEkbJi984E0VsPW0VXqgPihotfuStGUzo7zy2mb6jMbRbsjAKct4a2hSN8dZJxsusKcmZxLta6LbzbJ1HOdCPDtFupQ7R8dtVL/QeJa41b1nChMVq2L5DCbT6csllqIgzLgD4pWM/K5wh/jE0ULbQyYlXX4zFZ4UwQyejulDyi8ePj9+Mj8dvxsc0Q0gg/HY++t6HGKwrxnvylTCPFuuoj+sn4ELf6VPKGeEd2XyBTyvjxa6M4CCzYwrVlDmlpZDr1CXmfnPOd12/u4skfUKbVwm7e5qYO8jUKKYb4asS5xaaukYNmdIS9ethEOnFEHd8crJKWPs0ee3/SfK+JuEtn6buZ5en7XPYvweub75ZJax4Gtf/6DLJvyOyJ+9W/e26YTxcz1TeXsdza/UUYLwoCG6uyhw1GSQPz6v+qKEThiogrjfP+ZlSJXK55aARpi94iLUq5OOSAx2iqMsCyfbtXV83e29bBnfbY5vCxSBH3JmWU0YW2pSlcDofWKrOa15DYQDr8tBSwSu33rVp3DH+6jB8E49eDas1KL/aR48jCg4YLFZ16codlqIsCW+611Po/jnLr+MkIRCvy7jw01fFBx9xcwuGQeu1AhBsxxQ+cNkl4IkdcxVDcnB/36mB047VCu7vSaqor+nSXa2SvoHWWmtw96pv0ZihuF0b1TVhP7BrGwz1Js41mTi+ISRahgiIhRRycd3ocrVKH6hhL6Nn8+0Bm4LsaJL/BxwjdE7lmc5RP2Pnns59gEvBK1LWVyF66zgjtLFhP3p1Dwj7/MoOLod8N8XGvuv2t2lmhqBknK/fP1aLxQKp+iFAuMGhYMQXQ9AwhxWf09Z2dU4ab4VqTESv4KYzuXOCEH67CLlYD6ENuONqTIa0p9u2rqRil7OL82fw0sX2Rv4k8o6mp9LPAWcX51Q5JebBt0vhJ9NxIrKWr4EA+VpwK7hnbtKbb60P3qF0HPHH5lqZWxpqlkbwEKFcmK0YJX1Ev6szfDBxX1pHIlKNpZo+4d18MBZrs8ZHh0XHyAvVPEcrn+Akh0Xjcn2WbuV4NLosQ1/5JKSxuvGBS8gbHYu9gloQZIbG9HyKXCGgwfwJoDR+OIc5NxZ1Ao0UxHndUJyjmxLvatQCZYZbWPD4Le2v8d63D+pHRXpKGu9oHB8d0Z91VnVFomFSSs4QXfOmLNs/sOT5gYXHvRzfvN1yeMxtKT6L47/eZbfH53Q4NfqL3cZoZTW6pLpP4vWoU3LnRA44K2QpJF5Htl0fHx1dj4m3q4SdbGPfJ1WhLUh4S2LiUiuqCK2pUovOphb4ggsJdOfrfyA3UWulHzfCvgyzx5hwssaEtw+ZcCpd7sfVGV+oG5T/XEqHy1u/PKF6Vzld8QECJjyQ62drxA7bPZEGs0YL27LJ5T27G/FajHz/5PJqdZUwYqyioFytjMOY24JN2OGDGJ1BfetiLJf3XnU7bTRc5pSfeWD381oc3o7ZKtkcsdVL2AltLF8IuRg9OuqqJ/UTicNzfI3gPqhRiz8jRTUCP4dQCROkBgVyMhqIgyTlv/QByu+irGLocFs0sJfJZnxv83jfErGLAbu1GNz2ENz47SD4dRnjWC401UWmtgWbOtJj+KiLHg0CQoN40GWvs13oJUZexi5kcXxy4nz7r8fOCX7zjfMvT96tnJb1vhZj6/6UizJvegWMrVu7cVBny4VRvUHiM7trN2u8bYWcKyf8IJGzGuUnuslpj92OH/rnWGbKRy7p+ovg//23v7sRUZLuCPgDnDUaarVEPW98Qfi8xDtBd+fgpUL0/pBXJRpTtkBX5sK9WcjFwhUHxIsz4zWfiVLQoUFgykdDB+eOSeHn3n98pX2dxC2WdNZAqZQr4bcKeGNV5daIF+NS6Zs5oZQAhxlVfaMhyw/jEJQFlxm5oH4vJaA00JMFuuJrLQwCFxUBuwLd+Vxkwt24SlrNMwsVl3yBtFji4gTEhTrWbGs1I0vNqLLxtghVjiNaT6JLr6TwkWw/R7iLAqPlosTcmyEm8WZg0OXwJGJGJndNy4sMTV8sVeItand2eCO+KUuolfWGNTnKQ9nSRFZzaegCDhHoIJqOfcFOcmvkvE2B8rZ0OZGNSApQCnnjHzBcdmr2M86MsNjHSJbL5YNz7PX6mD8JWzQz0FirftzCNbpTbzi8+3hNhwTqypzNP6G+FVk0GXaseeiAD8P9xr07Hg8NXos/bg6gu6YUGUqDg9vo/Z/Ov4dbeJMesWRwcj8D4cPvTz989+On72heulv8/hunR+mRC+wqYysuB0ttPAba3LqDzNH+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dDvSun+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dD+7dBjb4dC4pnsr8O65EIOimd8tcLl5ouiq4QVVM4wuWT395Sl+InqA6n51wY11UJcJeyWa0ERWFcJkcSMP6W6b5Byzh98rHZ0QesnXiddYmyjAIQKFvyI905gj8IOKy7Ozz5dsITFgs5K5TRG8yW9iOJLNmFkCLvXU47b7qEKdxXmJZeLxmXfmZ+XChV4Y4v1KocbV+UQfgyS+Fy2AyzXyx88KfQ/EbZ1wL9SIu3P2P5bB+57dg4IvI3QJMKr1Wr1P5fHXwA=",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:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.e8abf1d2.js b/assets/js/2c586be5.e8abf1d2.js new file mode 100644 index 000000000..dcee511b2 --- /dev/null +++ b/assets/js/2c586be5.e8abf1d2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztW+FyGzeSfpXe+eNYNaREWnZ8rKurdezcnm6TSLVWKnUlqhRwpknCmgEmAEYUo+K/fZJ9tHuSq24AM0OKlKx4a6PU0T8sDtAAuj80gO5G4y5xYmaT0UXyQWd1icrZ5DJNcrSZkZWTWiWj5HyO8N6gcAiRCt6dnYAoCr2wUFs0FpyGGSo0RKVwAXnsDyZLqIy+kblUM8iFE7CQbg4TYfHNMaDKdI45TGWB/bEaq3NZjeDHqtAih6WuDZx9+M+mNxqGyi4ODj7gpJ7BjycHB5dfzZ2r7OjwUFRVX1eorJypQkxsP9PlYU6EVT59mcJijgapV8iEAhRWFksQeQ4Lmc/Q2RTcHBVkulpCprXJpRIObQqVmCGoupygsSkIlUOpDYJUIMCgyJc9p3u1Rfjvj6c/wFSbUrg+nBW1TZvhcmkwc8XSd+/m2Ej1wkY0rDNSzVIoxTWhJR38UsvsmsS2qHL6Sw3fnZ0wVgcHH+uq0sZhDj95EUYHB1TzDRZ6AcIg02e6LLWCShhRouPpmgvH1QZ/qaXB3E+KKIqIxWisenBw4JYVjg4O4ETlMiMwuEMqBT0NtH1PSiAR6ccKMzmVgbQDHWgFi7nM5ozJQvj5rAqReTYN2gozJ29wvePbFJbU8QdUOnIw10b+qpUTBU/HDRonM1F0p40YJFLrhHEEZ6WlcrE0jAD/E6aHZo8nJegVsZYTWKVUXGMRbkRRow1cLVKYE1d/w8qgZVUP/RKQKoc5ytl853gi/1Rbt9Yx1JbY7HIRxoqzxPAiwzYVhUWQ0zUsS3GNndFA8xoWRR++WUKOU1EXLgVJGudMjX34QTsQVVXITEwKJM0FWjzC1QZ7PMtBHQIjSpQ8x2e8otGCgFxOp2hocVIldxHaRO5Iz9otgFeOmwsFWm1MdKYLbaj7DR3i8nUgIdPKoXJ9eHcjZMHce2ktSJUVdY4wKUR2ncKkqDEFg7lfuUukfSsNuxCRgLABdAYILBakhlqRAEqH4aUFG7jK+3A+l7ZdUFQZseZBpO3CGpbtVNPIhEFcY4ClkEXKyKXwSU/ASVdgSiu2EmqZ0oaJKTi8dRN9m0I2x+yafxmRSw2T2jmtvGC50VWuFyqAaeWvW5YjlT4dyWEKxym8SeFtCoOjFAbDFAbHKQzepDB4m8LwKIXhMIXhcQrDN56d4duAsWiBDYMPhh5Z98dBlDbb76Tl5Uy7pG023sXaxjtWgz6DHxYRF//8889jdTdWAOOEFtU4GY2ThmScpODraK8cJ6NBCqHgdpyM4NXw60iwpO83hKz/XtD3gGbCf8/pezgYq1UYdMjMOFFWDzBC1f98JuJn0CUq5JGpLO5nVEgbkaelGpo3Km3YoopVK9ArEkgq6aQo7G6ZIsXzE6vlbEOyY5KMtXe3WFz9/GSKbMUa3jB9FW+wnSraApiJ4Yb4r/vt8bJDej/gcxM+cPUlsr8h2Zu9ajcADcnzQ6HL2pdA8XWf7QDeq3cDEQieHwwtY18CwlsCgc6p3QhQ7fMTP3AVK8K57+uOjnuD173h0fC4Q+FdJU9Qlr087y2Xyy+ADxgsMn/C2GxNBmvVG3nkoU6NLre4IuwptFTBTOLf0Xz/noz2SbRnMScfkO2qaMg03l/X4nY6F8sX1ncVmwY7zdO3ltqywyZXER/sCWdzLbPAPNFEK21Czl6fQOgR6Pnh998fdmD0hb2yjNhCLKXvHsPeLS3Lfp73N2nXZqdTWkKep7ClfHtFnkNZlrvKfQUdjWP1b7QIgpm2ex0Egue3FFrGtq6GjVNjLlWoCNoBGwQGZ3UhDN6Ss2mlViz9F+4zG+skLpPWYGe/lF069vq9SPDVaTDMXwYVJu7XO6CSx9vdE6rbicEZ3nIfWW2dLokZmQvqIQVbZ3Ny20S0/7Uqlm2Ehr8yUUmKDxToHJeiy/rrTIzV4IgPnOAEPHDiBIrnp2gdzmKlDydQ9cU4KUWwF5Iptr+1m6MZJ5etkrDTi3mnLWxrDJcdnRQ5IU3EHI5o2ZvLHAsxwaKte5KidkUJk94BhipKqRo/ndk9iqNzrbjdqA2Vqy1LwIvc1b24s0YNjhhDIW0MVqwD1m0dojkcY1OIHLabIMQGFBGNC2zLkvCYdiI9NPGbgR6Lbp0xYSE23RLs4RmIazXMzCMjEB0wYRNIi4PtGiCIsDYzXVyoj1IqWdZlExGcNr1GxMpwwnbhopYUZ44jdGf33gji9pERKPy2e4CxGrALH51/3hNguxEWSJ7fptDh7Es2hbUjK9A9+cB5+nKL3HeX25Zzikj9CdUsNbt7rfXhlE4FCjr6RhRRyjKsHEWf1hbigMMm3XjQ7oOhS/X89GCDu99dFxpVIFw+Txm6IvxeCjFWAx94Kv0dx66oU8nT/tyUILC1cfIlaaIrurCTWp3kySjJ+I4vXkolKfeN1n2j82UyuktCnJh+hkgsNT38ZOmW8C6x2RxLQb8iT3SvSPd6ScrBTjQ2SRMOEtAlI6GWjBI9+YQZjVYZYsdJtNQHtxvdRSp/MZakwWFMRom/MUvSBG9FWRFxsnGlWOXTZBUHfKirpqTtyvKP5oaO+lm7FP1NvX3o9LBKE7rM+o09/UBNWbYSz/V7TYUOP4il7XToD8Bk8zqX2tCiyEIryMXSku7X1psqmSiyuiD/E28raZaNM8xOaEc/GkabkRpGB69X7aS3LAljxDJJE+mw7JbvUAKjnz5zGWpChkOST237SeME8c+hgG6PeZ5E+WQuPmmECfIcVXOtntx+MHw1GA5eDYbUQ7hh+O04+tr7HKwrxjvypTCP5muvvQlMgYPx/ceUM9Kz2GKGjyvj+a4b4s79lJ3rusjp9geF6fNF7W/OAVjX7+a86D+izas0uX1cmFvIdC9eP8NXBU4d1FWFBjJtFJqX3bjTsxFueHy8SpPl4+It/5DifU2Tt3hcup/43r7Nafg9eH31dpUm88d5/a8ms+B3ZPb4zao9XTeMh6uJzpdXcd9aPUYYDwqim+oiR0MGyf39qt1qaIehjJirzX1+onWBQm3ZaNZul0PuEjm85E2HwOtijmT1tn4w996akMH39tzSjTVuRMqkJXPQ1DhO+nAy7Rik7EJvXnBHWr5sVhpe8HhXtuZt/MVh+CaMXnSzdyihog04RxaYGByWVcHpLwtZFMQ3net9aP6x5dcgSQzE4zIO/PhR8d5H5HjA0Gg9dwSC7diH90I1aQTrV/Zwd9eoAWvHagV3dzSraK7o0F2t0raAxlor4HPVlxjMUN6stWqKsG3YlHWaehPnikwcXxBucLoMyJmSanZVm2K16t9Tw3aOPhu3ezCFuaNO/h8gRuycqFOTo/mMlXsy9dEuDS9IWV+E6C4jI411YT16dQ8Mh1SX7SiHG3gKlH3brG9bTyxRqdhfu36ckbMZUo5coODGIbkFRTb3OwNzJaa0tDnvzeCN1LWN7M2FbUzunCikXy5SzdbjaR10OOeoK3t/29JVlBFzen72GVhyoK/ndyLvTXopfR9wen5GmXRyGny7PvxoGyQitGKNBMjXghspYuJNY74tfSQPFSPit821tMd+yGHrwX2Gcmm3cpS2Ef8m7/Rex22qJU2Rrh3leMqQS2QdVnYNR+aiAfJc15+jlY8gKWBW8/Wgo1M5bo18C9Fmwkllnal9FBPy2sTkv6AWRJmhtS1OERUi6vSfAirrmwuYCuvQpFArScibmsIZTZd4W6GRqDLcAsHDp7Q/xlvfPqgfJW1qZb2jMTw6oj/rUDVJw6FTurwhuaZ1USz/lKSfH1h42Mvxxdsth4fclvknOfz1NrsZntHmVJsnu43RyqpNQXnAhHWvUXJ2IjvISlVIhVcRtqvh0dHVgLBdpcnxNvg+6hLdnHPcCMSF0ZQhXBUoKGPVLEHMhFRAZ775J6KJxmjzsBH2NM4eAuF4DYTX90E4UXwRxHnn5/oa1b9W0u7wzg9PrN6WrCs+QJBIT8T1yZqw3XIvpMWsNtItk9HFXXLbE5Xs+frRxeXqMk0IWE1BuUpb5li4eTJKDu/F6CyaG46xXNx51W200QqV02XNPbtfVPLwZpCs0s0WW72EndTWiZlUs96DrS5bUT/SdHjE1wRugxqV/CtSVCPg2aVKE0lqMEdBRgMhSLP8tzZA+W2cqxg63BYNbOdkM763ub1vidjFgN1aDG57CG7wuhP8uohxLA5NNZGpbcGmRvQYPmqiR52AUCcedNHqbBN6iZGXAYcshsfH7Nt/PWAn+NVb9i+P36xYy1pfK0nW/SkOJW96BUmybu3GRo0tF1q1Bom/+V07WeNpK9VU8+SHGTmtUH2kk5zW2M3gvn+ORabLJvM3kv/v3//BLeJM8hbwJzitDVR6gWZa+/ThaYG3ks7OzsuV6P2hKAu0tlgCHZkzfsOSyxknD8SDMxOVmMhC0qZBZNpHQzv7ju3DT63/+ML4PIobLGivgUJrftLhNIja6ZLHiAfjQpvrKbGUgoAJvQJAS5Yfxiao5kJl5IL6tZSCNkBPWOiIr4y0CEKWREymBk6nMpN84mrljMgclEKJGdJgKccJCIUq5vAbPSFLzeqi9rYIvSRAdF5EvkXpwwey/VhwjgKjE7LA3JshNvVmYNDl8ERmQiZ3RcPLDG2bX1XgDRreO7wRXxcFVNp5w5oc5e7cUkfOCGXpAA4R6DA1DXzBTuIxcrHsA13Y0OFENiIpQCHVtX/QctGo2U84sdJhGyNZLBb39rGX623+It28noDBSrftZlzIu163efPxkjYJNKU9nX5EcyOzaDLsGPOQiQ/D+Sa8Ox43DVHJP282oLOmkBkqi53T6N1fzr6DG3jVP0rSzs79GQwffnfy/tsfPn5L/dLZ4tffoH/UP+LArrauFKoz1MbjsM2l27k52r8l278l278l278l278l++O8fNq/Jdu/Jdu/Jdu/Jdu/Jdu/Jdu/JftXJvbv35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35I9u7dkIRGB7LPDqhBSdZKpfPbKxeYLs8s0mVN6y+giubujW6sfKV+Uin+p0VBuzGWa3AgjKUzLmTFpzACh1IdrpByE9z7i3Dun8VOvjXxRupEQRAksvsU7npcHabsZOGenH8+TNIkJvqXOqY0RC3ohJxbJKCHbmV/TMaT8cEnwi4NCqFnN2RiJ75cSV0Tt5utZL9ec9RJ+dJI6hFp2uFxPh/Gi0P8k2NYG/04Xq3/F5X805L5mZ4OAbaSmKbxcrVb/B7GYp00=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW+FyGzeSfpXe+eNYNaREWnZ8rKurdezcnm6TSLVWKnUlqhRwpknCmgEmAEYUo+K/fZJ9tHuSq24AM0OKlKx4a6PU0T8sDtAAuj80gO5G4y5xYmaT0UXyQWd1icrZ5DJNcrSZkZWTWiWj5HyO8N6gcAiRCt6dnYAoCr2wUFs0FpyGGSo0RKVwAXnsDyZLqIy+kblUM8iFE7CQbg4TYfHNMaDKdI45TGWB/bEaq3NZjeDHqtAih6WuDZx9+M+mNxqGyi4ODj7gpJ7BjycHB5dfzZ2r7OjwUFRVX1eorJypQkxsP9PlYU6EVT59mcJijgapV8iEAhRWFksQeQ4Lmc/Q2RTcHBVkulpCprXJpRIObQqVmCGoupygsSkIlUOpDYJUIMCgyJc9p3u1Rfjvj6c/wFSbUrg+nBW1TZvhcmkwc8XSd+/m2Ej1wkY0rDNSzVIoxTWhJR38UsvsmsS2qHL6Sw3fnZ0wVgcHH+uq0sZhDj95EUYHB1TzDRZ6AcIg02e6LLWCShhRouPpmgvH1QZ/qaXB3E+KKIqIxWisenBw4JYVjg4O4ETlMiMwuEMqBT0NtH1PSiAR6ccKMzmVgbQDHWgFi7nM5ozJQvj5rAqReTYN2gozJ29wvePbFJbU8QdUOnIw10b+qpUTBU/HDRonM1F0p40YJFLrhHEEZ6WlcrE0jAD/E6aHZo8nJegVsZYTWKVUXGMRbkRRow1cLVKYE1d/w8qgZVUP/RKQKoc5ytl853gi/1Rbt9Yx1JbY7HIRxoqzxPAiwzYVhUWQ0zUsS3GNndFA8xoWRR++WUKOU1EXLgVJGudMjX34QTsQVVXITEwKJM0FWjzC1QZ7PMtBHQIjSpQ8x2e8otGCgFxOp2hocVIldxHaRO5Iz9otgFeOmwsFWm1MdKYLbaj7DR3i8nUgIdPKoXJ9eHcjZMHce2ktSJUVdY4wKUR2ncKkqDEFg7lfuUukfSsNuxCRgLABdAYILBakhlqRAEqH4aUFG7jK+3A+l7ZdUFQZseZBpO3CGpbtVNPIhEFcY4ClkEXKyKXwSU/ASVdgSiu2EmqZ0oaJKTi8dRN9m0I2x+yafxmRSw2T2jmtvGC50VWuFyqAaeWvW5YjlT4dyWEKxym8SeFtCoOjFAbDFAbHKQzepDB4m8LwKIXhMIXhcQrDN56d4duAsWiBDYMPhh5Z98dBlDbb76Tl5Uy7pG023sXaxjtWgz6DHxYRF//8889jdTdWAOOEFtU4GY2ThmScpODraK8cJ6NBCqHgdpyM4NXw60iwpO83hKz/XtD3gGbCf8/pezgYq1UYdMjMOFFWDzBC1f98JuJn0CUq5JGpLO5nVEgbkaelGpo3Km3YoopVK9ArEkgq6aQo7G6ZIsXzE6vlbEOyY5KMtXe3WFz9/GSKbMUa3jB9FW+wnSraApiJ4Yb4r/vt8bJDej/gcxM+cPUlsr8h2Zu9ajcADcnzQ6HL2pdA8XWf7QDeq3cDEQieHwwtY18CwlsCgc6p3QhQ7fMTP3AVK8K57+uOjnuD173h0fC4Q+FdJU9Qlr087y2Xyy+ADxgsMn/C2GxNBmvVG3nkoU6NLre4IuwptFTBTOLf0Xz/noz2SbRnMScfkO2qaMg03l/X4nY6F8sX1ncVmwY7zdO3ltqywyZXER/sCWdzLbPAPNFEK21Czl6fQOgR6Pnh998fdmD0hb2yjNhCLKXvHsPeLS3Lfp73N2nXZqdTWkKep7ClfHtFnkNZlrvKfQUdjWP1b7QIgpm2ex0Egue3FFrGtq6GjVNjLlWoCNoBGwQGZ3UhDN6Ss2mlViz9F+4zG+skLpPWYGe/lF069vq9SPDVaTDMXwYVJu7XO6CSx9vdE6rbicEZ3nIfWW2dLokZmQvqIQVbZ3Ny20S0/7Uqlm2Ehr8yUUmKDxToHJeiy/rrTIzV4IgPnOAEPHDiBIrnp2gdzmKlDydQ9cU4KUWwF5Iptr+1m6MZJ5etkrDTi3mnLWxrDJcdnRQ5IU3EHI5o2ZvLHAsxwaKte5KidkUJk94BhipKqRo/ndk9iqNzrbjdqA2Vqy1LwIvc1b24s0YNjhhDIW0MVqwD1m0dojkcY1OIHLabIMQGFBGNC2zLkvCYdiI9NPGbgR6Lbp0xYSE23RLs4RmIazXMzCMjEB0wYRNIi4PtGiCIsDYzXVyoj1IqWdZlExGcNr1GxMpwwnbhopYUZ44jdGf33gji9pERKPy2e4CxGrALH51/3hNguxEWSJ7fptDh7Es2hbUjK9A9+cB5+nKL3HeX25Zzikj9CdUsNbt7rfXhlE4FCjr6RhRRyjKsHEWf1hbigMMm3XjQ7oOhS/X89GCDu99dFxpVIFw+Txm6IvxeCjFWAx94Kv0dx66oU8nT/tyUILC1cfIlaaIrurCTWp3kySjJ+I4vXkolKfeN1n2j82UyuktCnJh+hkgsNT38ZOmW8C6x2RxLQb8iT3SvSPd6ScrBTjQ2SRMOEtAlI6GWjBI9+YQZjVYZYsdJtNQHtxvdRSp/MZakwWFMRom/MUvSBG9FWRFxsnGlWOXTZBUHfKirpqTtyvKP5oaO+lm7FP1NvX3o9LBKE7rM+o09/UBNWbYSz/V7TYUOP4il7XToD8Bk8zqX2tCiyEIryMXSku7X1psqmSiyuiD/E28raZaNM8xOaEc/GkabkRpGB69X7aS3LAljxDJJE+mw7JbvUAKjnz5zGWpChkOST237SeME8c+hgG6PeZ5E+WQuPmmECfIcVXOtntx+MHw1GA5eDYbUQ7hh+O04+tr7HKwrxjvypTCP5muvvQlMgYPx/ceUM9Kz2GKGjyvj+a4b4s79lJ3rusjp9geF6fNF7W/OAVjX7+a86D+izas0uX1cmFvIdC9eP8NXBU4d1FWFBjJtFJqX3bjTsxFueHy8SpPl4+It/5DifU2Tt3hcup/43r7Nafg9eH31dpUm88d5/a8ms+B3ZPb4zao9XTeMh6uJzpdXcd9aPUYYDwqim+oiR0MGyf39qt1qaIehjJirzX1+onWBQm3ZaNZul0PuEjm85E2HwOtijmT1tn4w996akMH39tzSjTVuRMqkJXPQ1DhO+nAy7Rik7EJvXnBHWr5sVhpe8HhXtuZt/MVh+CaMXnSzdyihog04RxaYGByWVcHpLwtZFMQ3net9aP6x5dcgSQzE4zIO/PhR8d5H5HjA0Gg9dwSC7diH90I1aQTrV/Zwd9eoAWvHagV3dzSraK7o0F2t0raAxlor4HPVlxjMUN6stWqKsG3YlHWaehPnikwcXxBucLoMyJmSanZVm2K16t9Tw3aOPhu3ezCFuaNO/h8gRuycqFOTo/mMlXsy9dEuDS9IWV+E6C4jI411YT16dQ8Mh1SX7SiHG3gKlH3brG9bTyxRqdhfu36ckbMZUo5coODGIbkFRTb3OwNzJaa0tDnvzeCN1LWN7M2FbUzunCikXy5SzdbjaR10OOeoK3t/29JVlBFzen72GVhyoK/ndyLvTXopfR9wen5GmXRyGny7PvxoGyQitGKNBMjXghspYuJNY74tfSQPFSPit821tMd+yGHrwX2Gcmm3cpS2Ef8m7/Rex22qJU2Rrh3leMqQS2QdVnYNR+aiAfJc15+jlY8gKWBW8/Wgo1M5bo18C9Fmwkllnal9FBPy2sTkv6AWRJmhtS1OERUi6vSfAirrmwuYCuvQpFArScibmsIZTZd4W6GRqDLcAsHDp7Q/xlvfPqgfJW1qZb2jMTw6oj/rUDVJw6FTurwhuaZ1USz/lKSfH1h42Mvxxdsth4fclvknOfz1NrsZntHmVJsnu43RyqpNQXnAhHWvUXJ2IjvISlVIhVcRtqvh0dHVgLBdpcnxNvg+6hLdnHPcCMSF0ZQhXBUoKGPVLEHMhFRAZ775J6KJxmjzsBH2NM4eAuF4DYTX90E4UXwRxHnn5/oa1b9W0u7wzg9PrN6WrCs+QJBIT8T1yZqw3XIvpMWsNtItk9HFXXLbE5Xs+frRxeXqMk0IWE1BuUpb5li4eTJKDu/F6CyaG46xXNx51W200QqV02XNPbtfVPLwZpCs0s0WW72EndTWiZlUs96DrS5bUT/SdHjE1wRugxqV/CtSVCPg2aVKE0lqMEdBRgMhSLP8tzZA+W2cqxg63BYNbOdkM763ub1vidjFgN1aDG57CG7wuhP8uohxLA5NNZGpbcGmRvQYPmqiR52AUCcedNHqbBN6iZGXAYcshsfH7Nt/PWAn+NVb9i+P36xYy1pfK0nW/SkOJW96BUmybu3GRo0tF1q1Bom/+V07WeNpK9VU8+SHGTmtUH2kk5zW2M3gvn+ORabLJvM3kv/v3//BLeJM8hbwJzitDVR6gWZa+/ThaYG3ks7OzsuV6P2hKAu0tlgCHZkzfsOSyxknD8SDMxOVmMhC0qZBZNpHQzv7ju3DT63/+ML4PIobLGivgUJrftLhNIja6ZLHiAfjQpvrKbGUgoAJvQJAS5Yfxiao5kJl5IL6tZSCNkBPWOiIr4y0CEKWREymBk6nMpN84mrljMgclEKJGdJgKccJCIUq5vAbPSFLzeqi9rYIvSRAdF5EvkXpwwey/VhwjgKjE7LA3JshNvVmYNDl8ERmQiZ3RcPLDG2bX1XgDRreO7wRXxcFVNp5w5oc5e7cUkfOCGXpAA4R6DA1DXzBTuIxcrHsA13Y0OFENiIpQCHVtX/QctGo2U84sdJhGyNZLBb39rGX623+It28noDBSrftZlzIu163efPxkjYJNKU9nX5EcyOzaDLsGPOQiQ/D+Sa8Ox43DVHJP282oLOmkBkqi53T6N1fzr6DG3jVP0rSzs79GQwffnfy/tsfPn5L/dLZ4tffoH/UP+LArrauFKoz1MbjsM2l27k52r8l278l278l278l278l++O8fNq/Jdu/Jdu/Jdu/Jdu/Jdu/Jdu/JftXJvbv35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35Lt35I9u7dkIRGB7LPDqhBSdZKpfPbKxeYLs8s0mVN6y+giubujW6sfKV+Uin+p0VBuzGWa3AgjKUzLmTFpzACh1IdrpByE9z7i3Dun8VOvjXxRupEQRAksvsU7npcHabsZOGenH8+TNIkJvqXOqY0RC3ohJxbJKCHbmV/TMaT8cEnwi4NCqFnN2RiJ75cSV0Tt5utZL9ec9RJ+dJI6hFp2uFxPh/Gi0P8k2NYG/04Xq3/F5X805L5mZ4OAbaSmKbxcrVb/B7GYp00=",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:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"size:"})," Specifies the size 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 size of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "size": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.dd1f5b80.js b/assets/js/bbdfc22d.dd1f5b80.js deleted file mode 100644 index 745963510..000000000 --- a/assets/js/bbdfc22d.dd1f5b80.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={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:"eJztG2tvI7fxr0z2y+WMlWz5nEsqFEUvjybXPHyIfQgKy7hQuyMt411yj+RaVgx96y/pT+svKWZI7q5kyfYlReMCyoeLlhwO50VyXr5NnJjbZHyRnGNVl8KhTS7TJEebGVk7qVUyTs4LhDgNXxgUNA6v3rwGUZZ6YaGxaCw4DRlNImSNdbqSv4ppieAi4hQWhcwKsGiuEYSFadlgbaRyFmbawBwVGuGkmkOus6ZCmlhIV0BtMMeZVJiDdabJXGPQDuFtrRXYJsvQ2llTtjt5MqRWKbgCmVCDrjHKgoBGyfcNwsFBhH4n84MDcIVwkAkFUyR2cuImEIQ9cqaC5rRixLbGTM4kAQdcw4maqHNZj+FtXWqRw1I3Bt58+bcWBeGlsYuDgy9x2szh7euDg8uPC+dqOz48FHU91DUqK+eqFFM7zHR1mBNgnc+ekwTRIGFlWlFYWS5B5DksZD5HZ5ljBZmul5BpbXKpvOhrMUdQTTVFY1MQKodKGwSpQIBBkS8HTg8ai/D3s9MfSB2VcEN4UzY2bbfLpcHMlUuPniQQuXrmJfPyhPQj1TyFSlyRIqWD943Mrohti4rFGnTCsjo4OGvqWhuHOfzkWRgfHNDM51jqBQiDDJ/pqtIKamFEhY6tjRRG0wbfN9Jg7k1FlGWUxZjQDEjTyxrHBwfwWuUyI3EwShoFPQvQQw9KYiLQs6BaD9oTHunemzFJZSG8RutSZJ5Qg2QVTl7jOuKbFJaE+EtUOlJQaCN/1cqJkhVyjcbJTJR9xRGBbGpOGD4ZtZbKxdGwA/wjKIj0x2oJlkWk5SSuSiqesQjXomzQBqoWKRRE1Y9YG7Rs4QEviVLlUKCcFzv3E/kvjXVriKGxRGafirBX1BOLF1lsM1FaBDlbk2UlrrC3G2i+hkQ5hM+XkONMNKVLQZLNOdPgEH7QDkRdlzLj+4auEjo+gm6JAWs5GEQgRImKdfzG6GuZI10KuZzN0NDxpElGEdZE6sjSal5A7PHZcYVQoNWGojNdakPoN2yIx9cFCZlWDpUbwqtrIUum3nNrQaqsbHKEaSmyq5SvyhQM5v7sLpEu3tSbPIPQfeqFzgICiyWZoVbEgNJhe2m7Syucv++kZf3SwbHtWVysncWJGg3h4KCVKg///PPPE3U7UQCThKQ8ScaTpAWZJCn4OTo8k2Q8SiEM3EySMbw4/jQCLOn75fFn8XtB36PRSfwu6Pt4NFGrsOkxE+NEVd9DCE3/94mIn0FNNMg701g0cBoky/SwNENGRaMtWTSx6hh6QQxJJZ0Upd3NU4R4emx1lG1wdkKcYSVkuZstnn56PEWy4gyfID/FJ+4Or58Mu8tlB6se+1PjNFD1aEZfEqO/6Ck46cp7uG1Bnh7LfdIezfenQ77fq1qo5W6uA8DT47kj7NEcf0Yc58Ldo2SafXq8BqriRHgV/dzRyWD0yeD46PikB+E9Xg9QVYM8HyyXy8fKClgy9PqHjfj9D/6Ff5YpjJgZXW1xHtm366CCi8C/o8P1PblZ0+iBYE5++3oEEj32vo/kdC6Wz6xHFZcGN8XDd67uskcmTxEdHL1khZZZIJ5goocyJQd9SEIYkITzw++/P+zJzA8OqioKEuIofQ9Yxv3Rqhrm+XATdk0VvdEK8jyFLePbJ/IcqqraNe4nSKET9achh4Y3bqpvdht9AHh6dt8RttX0N276QqowEawDNgAMzptSGLyh8MBKrZj7D7lBNg5FPBOidVQ5bGCPm4MyTz98fBq8/ufBXonUdQQ08vC6Oxz0kRic4w3j8BkLIkbmIXVgm6wgr5pzHOT0a1UuuxCavzJRSwrfSnSOR9Flw3UiJmp0xO9GgdnVvUYVIZ6eVfUoi5M+2qPpi0lSifDGJzPsfmtXoJkkl+0aH5Ng3lsL2xbDZc8ARU6SJmCOFjvyCpljKaZYdnO7rbJPd9BwTwo0UUnVxkxM21HcimfFzcZsmFxtsXfPX9/Q4p0ZzTUKFEppY+C4Lp3+6hBZc8ZDoc9NTRHiApi2d/42+/cC7EXdpOXNoNuiWydMWIhLtwTeLO54MIMaHtiB4IAB26RG3GzXBoGFNc305UI4Kqlk1VRtdmbWYo0Sq8Lb2RcXraSkZdyhr907O4ibB3YIacMdG0zUiKPn3Og61wvFFwBs96UCyNO7AXqU/Z4bYO0xCnAf9JQ8fLQipf2jteUBIlD/9LTHyu4+V0M4peuekj1+kbQgsgxrh/nGfT/i7IQRudQwbZzTaveN34d6ejrfoO4P0jsJ4XGa79P7R2l/okY+mVP5RPKuTE7FOn5qGg9kbXvZIPw3UUma6JoLNVq9zpNx4os+sQSSpLwVWve5zpfJ+DYJWU76GdK0tPTwF0vFpdvEZgVWgn5FEqkcNZMloaJ8IhqbpAlH61SbIiEm40RPf8HMJSm5rjVlztESDl43vo1QvhyRpCG+S8aJr1MkaYI3oqoJOAwBqkxTbMUoVnHH+3C1Ix0uyz/aghDhoYT/b0TDS1cb9bjfhKmPYdXJtUMmjBHLZLP0FzP9MT7w69qcfLmMz7x05DK02WcGS9JEOqz6u+zQmtEfLukMNXHCaboPXctqEdUH70nr6kKr37Qw5NS3yPyRUvKzdzdeV9krilcwj17joCuGpMDp5+FDFhPhmVsx7+/pnaA7e57vKpL1ih220E2ZU6UGhRlyreo3F0K51izKrOFyb3ubr3HWktpyNlqlyc3DzNxApgexAgcflzhz0NQ1Gsi0UWie9xM5T4a545OTVZosH2Zv+X/J3qekvMXD3P3EpcuurPtH0Pris1WaFA/T+k1bXP0DiT15uereuo23/N1U58t38d5aPQQYHxWCo2L/a3VqcjQ9QUy1LlGoO5J4PfMRqIZn5Js8C+kV4mEmjY0PCixkWYLBDKm+zgnQeFdBcDqA3wMIBSkKXr+iAfbubDO1BKUiPusRThGckfM5UhdBgODFocCKgrtWqO5OVImZQ+9x1gavpW5sJK8QljoV6hLJgXQFSl+Klmq+HuP2pMM12T7vw752aIQeOUXF4dPzN4+QJQffA3CFtOGd9lx6HHB6/oY6DeQs+GFDeGtbSUTRijUQIL8IrqXwwk27u33po2tULBHNzK41hgxDjX8AdwnKpd1KUdql3NrGojuIu2YUUpFuHHXBSO+VgHVY2zU5MhWtIM918xirfECSAuYNJ+MdHdnYdsBpwK5TQCrfscSRSt6Y2BwRzIIgqX2pk1OUCgH18KeAyvrlAmbCOjQp9TKR5E1DkUiLEm9qNBJVhltEcP8R9me888OD+VFTi1bWeyHHR0f0vw0HYK31iohp27LK5UdJ+vgg4H4XyA9T2HHXDeo8mM+L429sraqsIBemQmvXvZgtSx5goC83qUqp8F0Uyrvjo6N3n5DkVmlysk04Z7pCV5BqFmS5C6OpQ6ouUVC/jlmCmAupgLY3/0VZoTHa3M/1h1F2nxBOjo7ejVohfHJXCK8Vp165G+9cX6H633La39757YnUm4pjBx8LJNID8Xyyxmx/3DNpMWuMdMtkfHGb3AxELQd+fnxxubokq3OFpvC41pYpFq5IxsnhnWiZ2yEpFLu4TRpTJuMkPvdWqJzSo3eefFHLw+tRsko3V2x1EHZCWyfmUs0H96667Fg9I3V4ia8x3MUztfwWKaAJ8uxDpYkkMyhQkEtAEiQt/9ilCr6KuopB/Na4vFPKZqQdA+212HnzSt8SDfeC4YsYiXJw2caWScdR0sZ/9LON6C4602uDpxg7jTjoOD45Ye/80xG7sS8+Yw/x5OXq0ku45y1xdqb/5PvixtrbFd8zqWaaFRCEclqjOqO3kuz8enTXPcYy0xXGNswI/u9//otXxNeVj+FHcNoYqPUCDXXXUt/ZrMQbSa9Tr/mXon+uIIiqRGspJaAczn3jrJxzfSw+TZmoxVSWkg4ugWlfYu6dfTuEnwqk/CFNPTO+VHiNJZ13KLXmtlKnQTROV/3mXFhoczUjklIQMKU+RLTkW2FcgqoQKqMUn7fnFLQBaqOlR7Q20iIIWREwPeY4m8lMEmK6pYzIHFRCiTnSZim76SSFOnYRGj0lX8jqsvGvPfUyIjrPIqcYh/AleVfMOA3m6IQsMfcPvU29oxUurdCmOyWntqbtZYa26xco8RoNn1/vJjdlCbV23nWlmKKvW0LkjFCWAgFPUFRNK77gifAeuVgOgbKZ9ECQF0YGUEp1RU21A7hozewnnFrpsAtRFovFnbvk+fqar6UrmikYrHW3bs6DfPP0l7cfz+nko6ns6ewMzbXMMFxkO/Y8ZODD8MaIjN+YeJ5FLf+6uYDu+1JmqCz2XoRXX7/5Dq7hxfAoSXu35yMIPvzu9Rdf/XD2FeGl+92fv9HwaHjEeRVtXSVUb6svfO/8eXefbWT92sdy35C/b8jfN+TvG/L3Dfn7hvx9Q/7vK3nuG/L3DflPjtN9Q/6+IX/fkL9vyN835O8b8vcN+fuG/H1D/r4hf9+Qv2/I3zfk7xvy9w35+4b8Ow35ofhMTtdhXQrJ3QtcrroNjQcXm236l2lSUGfC+CK5vaVawVtTrlY0/L5BQ20Nl2lyLYykLCg3NaSxeE/l7itcUs3K50sH57R/6i2R62sbvRzUe+BXvGI13Qvbb554c3p2nqTJNPwpQaVzWmPEgv7MQCyScULeL/9JAkuYm8kF94mWQs0brsAnHi/1HIjGFesNC1fcsBB+9Ar5Qi17VK53MnhW6F9ibOuCP1OR61tc/qUF9zM7FwTZRmhS4eVqtfoP6RrOUA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztG2tvI7fxr0z2y+WMlWz5nEsqFEUvjybXPHyIfQgKy7hQuyMt411yj+RaVgx96y/pT+svKWZI7q5kyfYlReMCyoeLlhwO50VyXr5NnJjbZHyRnGNVl8KhTS7TJEebGVk7qVUyTs4LhDgNXxgUNA6v3rwGUZZ6YaGxaCw4DRlNImSNdbqSv4ppieAi4hQWhcwKsGiuEYSFadlgbaRyFmbawBwVGuGkmkOus6ZCmlhIV0BtMMeZVJiDdabJXGPQDuFtrRXYJsvQ2llTtjt5MqRWKbgCmVCDrjHKgoBGyfcNwsFBhH4n84MDcIVwkAkFUyR2cuImEIQ9cqaC5rRixLbGTM4kAQdcw4maqHNZj+FtXWqRw1I3Bt58+bcWBeGlsYuDgy9x2szh7euDg8uPC+dqOz48FHU91DUqK+eqFFM7zHR1mBNgnc+ekwTRIGFlWlFYWS5B5DksZD5HZ5ljBZmul5BpbXKpvOhrMUdQTTVFY1MQKodKGwSpQIBBkS8HTg8ai/D3s9MfSB2VcEN4UzY2bbfLpcHMlUuPniQQuXrmJfPyhPQj1TyFSlyRIqWD943Mrohti4rFGnTCsjo4OGvqWhuHOfzkWRgfHNDM51jqBQiDDJ/pqtIKamFEhY6tjRRG0wbfN9Jg7k1FlGWUxZjQDEjTyxrHBwfwWuUyI3EwShoFPQvQQw9KYiLQs6BaD9oTHunemzFJZSG8RutSZJ5Qg2QVTl7jOuKbFJaE+EtUOlJQaCN/1cqJkhVyjcbJTJR9xRGBbGpOGD4ZtZbKxdGwA/wjKIj0x2oJlkWk5SSuSiqesQjXomzQBqoWKRRE1Y9YG7Rs4QEviVLlUKCcFzv3E/kvjXVriKGxRGafirBX1BOLF1lsM1FaBDlbk2UlrrC3G2i+hkQ5hM+XkONMNKVLQZLNOdPgEH7QDkRdlzLj+4auEjo+gm6JAWs5GEQgRImKdfzG6GuZI10KuZzN0NDxpElGEdZE6sjSal5A7PHZcYVQoNWGojNdakPoN2yIx9cFCZlWDpUbwqtrIUum3nNrQaqsbHKEaSmyq5SvyhQM5v7sLpEu3tSbPIPQfeqFzgICiyWZoVbEgNJhe2m7Syucv++kZf3SwbHtWVysncWJGg3h4KCVKg///PPPE3U7UQCThKQ8ScaTpAWZJCn4OTo8k2Q8SiEM3EySMbw4/jQCLOn75fFn8XtB36PRSfwu6Pt4NFGrsOkxE+NEVd9DCE3/94mIn0FNNMg701g0cBoky/SwNENGRaMtWTSx6hh6QQxJJZ0Upd3NU4R4emx1lG1wdkKcYSVkuZstnn56PEWy4gyfID/FJ+4Or58Mu8tlB6se+1PjNFD1aEZfEqO/6Ck46cp7uG1Bnh7LfdIezfenQ77fq1qo5W6uA8DT47kj7NEcf0Yc58Ldo2SafXq8BqriRHgV/dzRyWD0yeD46PikB+E9Xg9QVYM8HyyXy8fKClgy9PqHjfj9D/6Ff5YpjJgZXW1xHtm366CCi8C/o8P1PblZ0+iBYE5++3oEEj32vo/kdC6Wz6xHFZcGN8XDd67uskcmTxEdHL1khZZZIJ5goocyJQd9SEIYkITzw++/P+zJzA8OqioKEuIofQ9Yxv3Rqhrm+XATdk0VvdEK8jyFLePbJ/IcqqraNe4nSKET9achh4Y3bqpvdht9AHh6dt8RttX0N276QqowEawDNgAMzptSGLyh8MBKrZj7D7lBNg5FPBOidVQ5bGCPm4MyTz98fBq8/ufBXonUdQQ08vC6Oxz0kRic4w3j8BkLIkbmIXVgm6wgr5pzHOT0a1UuuxCavzJRSwrfSnSOR9Flw3UiJmp0xO9GgdnVvUYVIZ6eVfUoi5M+2qPpi0lSifDGJzPsfmtXoJkkl+0aH5Ng3lsL2xbDZc8ARU6SJmCOFjvyCpljKaZYdnO7rbJPd9BwTwo0UUnVxkxM21HcimfFzcZsmFxtsXfPX9/Q4p0ZzTUKFEppY+C4Lp3+6hBZc8ZDoc9NTRHiApi2d/42+/cC7EXdpOXNoNuiWydMWIhLtwTeLO54MIMaHtiB4IAB26RG3GzXBoGFNc305UI4Kqlk1VRtdmbWYo0Sq8Lb2RcXraSkZdyhr907O4ibB3YIacMdG0zUiKPn3Og61wvFFwBs96UCyNO7AXqU/Z4bYO0xCnAf9JQ8fLQipf2jteUBIlD/9LTHyu4+V0M4peuekj1+kbQgsgxrh/nGfT/i7IQRudQwbZzTaveN34d6ejrfoO4P0jsJ4XGa79P7R2l/okY+mVP5RPKuTE7FOn5qGg9kbXvZIPw3UUma6JoLNVq9zpNx4os+sQSSpLwVWve5zpfJ+DYJWU76GdK0tPTwF0vFpdvEZgVWgn5FEqkcNZMloaJ8IhqbpAlH61SbIiEm40RPf8HMJSm5rjVlztESDl43vo1QvhyRpCG+S8aJr1MkaYI3oqoJOAwBqkxTbMUoVnHH+3C1Ix0uyz/aghDhoYT/b0TDS1cb9bjfhKmPYdXJtUMmjBHLZLP0FzP9MT7w69qcfLmMz7x05DK02WcGS9JEOqz6u+zQmtEfLukMNXHCaboPXctqEdUH70nr6kKr37Qw5NS3yPyRUvKzdzdeV9krilcwj17joCuGpMDp5+FDFhPhmVsx7+/pnaA7e57vKpL1ih220E2ZU6UGhRlyreo3F0K51izKrOFyb3ubr3HWktpyNlqlyc3DzNxApgexAgcflzhz0NQ1Gsi0UWie9xM5T4a545OTVZosH2Zv+X/J3qekvMXD3P3EpcuurPtH0Pris1WaFA/T+k1bXP0DiT15uereuo23/N1U58t38d5aPQQYHxWCo2L/a3VqcjQ9QUy1LlGoO5J4PfMRqIZn5Js8C+kV4mEmjY0PCixkWYLBDKm+zgnQeFdBcDqA3wMIBSkKXr+iAfbubDO1BKUiPusRThGckfM5UhdBgODFocCKgrtWqO5OVImZQ+9x1gavpW5sJK8QljoV6hLJgXQFSl+Klmq+HuP2pMM12T7vw752aIQeOUXF4dPzN4+QJQffA3CFtOGd9lx6HHB6/oY6DeQs+GFDeGtbSUTRijUQIL8IrqXwwk27u33po2tULBHNzK41hgxDjX8AdwnKpd1KUdql3NrGojuIu2YUUpFuHHXBSO+VgHVY2zU5MhWtIM918xirfECSAuYNJ+MdHdnYdsBpwK5TQCrfscSRSt6Y2BwRzIIgqX2pk1OUCgH18KeAyvrlAmbCOjQp9TKR5E1DkUiLEm9qNBJVhltEcP8R9me888OD+VFTi1bWeyHHR0f0vw0HYK31iohp27LK5UdJ+vgg4H4XyA9T2HHXDeo8mM+L429sraqsIBemQmvXvZgtSx5goC83qUqp8F0Uyrvjo6N3n5DkVmlysk04Z7pCV5BqFmS5C6OpQ6ouUVC/jlmCmAupgLY3/0VZoTHa3M/1h1F2nxBOjo7ejVohfHJXCK8Vp165G+9cX6H633La39757YnUm4pjBx8LJNID8Xyyxmx/3DNpMWuMdMtkfHGb3AxELQd+fnxxubokq3OFpvC41pYpFq5IxsnhnWiZ2yEpFLu4TRpTJuMkPvdWqJzSo3eefFHLw+tRsko3V2x1EHZCWyfmUs0H96667Fg9I3V4ia8x3MUztfwWKaAJ8uxDpYkkMyhQkEtAEiQt/9ilCr6KuopB/Na4vFPKZqQdA+212HnzSt8SDfeC4YsYiXJw2caWScdR0sZ/9LON6C4602uDpxg7jTjoOD45Ye/80xG7sS8+Yw/x5OXq0ku45y1xdqb/5PvixtrbFd8zqWaaFRCEclqjOqO3kuz8enTXPcYy0xXGNswI/u9//otXxNeVj+FHcNoYqPUCDXXXUt/ZrMQbSa9Tr/mXon+uIIiqRGspJaAczn3jrJxzfSw+TZmoxVSWkg4ugWlfYu6dfTuEnwqk/CFNPTO+VHiNJZ13KLXmtlKnQTROV/3mXFhoczUjklIQMKU+RLTkW2FcgqoQKqMUn7fnFLQBaqOlR7Q20iIIWREwPeY4m8lMEmK6pYzIHFRCiTnSZim76SSFOnYRGj0lX8jqsvGvPfUyIjrPIqcYh/AleVfMOA3m6IQsMfcPvU29oxUurdCmOyWntqbtZYa26xco8RoNn1/vJjdlCbV23nWlmKKvW0LkjFCWAgFPUFRNK77gifAeuVgOgbKZ9ECQF0YGUEp1RU21A7hozewnnFrpsAtRFovFnbvk+fqar6UrmikYrHW3bs6DfPP0l7cfz+nko6ns6ewMzbXMMFxkO/Y8ZODD8MaIjN+YeJ5FLf+6uYDu+1JmqCz2XoRXX7/5Dq7hxfAoSXu35yMIPvzu9Rdf/XD2FeGl+92fv9HwaHjEeRVtXSVUb6svfO/8eXefbWT92sdy35C/b8jfN+TvG/L3Dfn7hvx9Q/7vK3nuG/L3DflPjtN9Q/6+IX/fkL9vyN835O8b8vcN+fuG/H1D/r4hf9+Qv2/I3zfk7xvy9w35+4b8Ow35ofhMTtdhXQrJ3QtcrroNjQcXm236l2lSUGfC+CK5vaVawVtTrlY0/L5BQ20Nl2lyLYykLCg3NaSxeE/l7itcUs3K50sH57R/6i2R62sbvRzUe+BXvGI13Qvbb554c3p2nqTJNPwpQaVzWmPEgv7MQCyScULeL/9JAkuYm8kF94mWQs0brsAnHi/1HIjGFesNC1fcsBB+9Ar5Qi17VK53MnhW6F9ibOuCP1OR61tc/qUF9zM7FwTZRmhS4eVqtfoP6RrOUA==",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"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.e7b67797.js b/assets/js/bbdfc22d.e7b67797.js new file mode 100644 index 000000000..ed1537abf --- /dev/null +++ b/assets/js/bbdfc22d.e7b67797.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={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:"eJztW21vIzeS/iuV/jIZoyVbGmcyJywWO3m57Owm8SD2IDhYxoTqLqkZd5Mdkm1ZMfTtfsn9tPslhyqS3S1Zsmcyi40P0BdbTRbJqodv9ca7xImFTSaXyQVWdSkc2uQqTXK0mZG1k1olk+SiQIjV8LVBQeXw+u0bEGWplxYai8aC05BRJULWWKcr+buYlQgudpzCspBZARbNDYKwMCsbrI1UzsJcG1igQiOcVAvIddZUSBVL6QqoDeY4lwpzsM40mWsM2iG8q7UC22QZWjtvynYkz4bUKgVXIDNq0DVGWRDQKPlbg3B0FKnfy/zoCFwhHGRCwQxJnJykCQxhj52ZoDqtuGNbYybnkohDX8OpmqoLWU/gXV1qkcNKNwbefvOfbRfUL5VdHh19g7NmAe/eHB1dfV44V9vJ8bGo66GuUVm5UKWY2WGmq+OcCOt8/pwQRIPUK/OKwspyBSLPYSnzBTrLEivIdL2CTGuTS+Whr8UCQTXVDI1NQagcKm0QpAIBBkW+Gjg9aCzCP87PfqTpqIQbwtuysWk7XC4NZq5c+e4JgSjVM4/My1OaH6kWKVTimiZSOvitkdk1iW1RMaxhThiro6Pzpq61cZjDz16EydER1XyFpV6CMMj0ma4qraAWRlToeLXRhFG1wd8aaTD3S0WUZcRiQt0MaKZXNU6OjuCNymVGcHCXVAp6HqiHnpRgItLzMLWetAcezb1fxoTKUvgZrUuReUYN0qpw8gY3O75NYUUdf4NKRw4KbeTvWjlR8oTcoHEyE2V/4ohBXmpOGN4ZtZbKxdIwAvxXmCCaP56WsLKItZzgqqTiGotwI8oGbeBqmUJBXP2EtUHLKzz0S1CqHAqUi2LveCL/tbFuo2NoLLHZ5yKMFeeJ4UWGbS5KiyDnG1hW4hp7o4HmY0iUQ/hqBTnORVO6FCStOWcaHMKP2oGo61JmfN7QUULbR9ApMeBZDgsiMKJExXP81ugbmSMdCrmcz9HQ9qRK7iK0idzRSqu5AYnHe8cVQoFWWxOd6VIb6n5rDXH5JpCQaeVQuSG8vhGyZO69tBakysomR5iVIrtO+ahMwWDu9+4K6eBN/ZJnEjpPPegMEFgsaRlqRQIoHYaXtju0hheFtN2OoroINY8hbR/VsG/nmgYmCOImA6yELFMGLoVf9QycdCWmtGVroVYp5MJhCg5v3UzfppAVmF3zLyNyqWHWOEdHNY2ZG13neqkCllb+vmM3UunHAzlO4TSFlym8SmF0ksJonMLoNIXRyxRGr1IYn6QwHqcwPk1h/NKzM34VIBYdrmHw0dgD63qAwtNGlE7b76Xl3UzHpG1P3uXGyTtVoyGDH/YQF//yyy9TdTdVANOE9tQ0mUyTlmSapODr6KicJpNRCqHgdppM4MX4y0iwou+XhKz/XtL3iGbCfxf0PR5N1ToMOmZmnKjqBxih6n89E/EzrCUq5JGpLB5nVEjnkKelGpo3Km3Zoop1J9ALEkgq6aQo7X6ZIsXTE6vjbEuyU5KMV+9+sbj66ckU2Yo1fF76Kj5fe1V0BDAT4y3xvxh2t8se6f2AT034wNWnyP6SZG/Pqv0AtCRPD4U+a58CxZdDVgP4rN4PRCB4ejB0jH0KCK8IBLqn9iNAtU9P/MBVrAj3vq87OR2MvhiMT8anPQpvK3mCqhrk+WC1Wn0CfMBgkfoTxmZlMiirXscjm3RudLXDEmFDoaMKahL/jtr7D6Szz6I6izkZgZvmbDT/+gq307lYPbO+q9g06GmevtPUVj02uYr4YFM4K7TMAvNEE7W0GVl7QwJhQKDnxz/8cNyD0RcOqipiC7GUvgcMe7+0qoZ5Ptym3ZidXmkFeZ7CjvLdFXkOVVXtK/cVdDVO1X8M2c/Aatr+fRAInt5W6BjbuRu2bo1CqlARVgdsERhcNKUweEu2ppVasfSfeM5s7ZO4TTqFnc1StujY6PciwednQTF/HpYwcb/ZAZU83u6eUP1ODC7wlvvwHjFiRubBNWWbrCCrTUT9X6ty1blo+CsTtST3QInOcSm6bLjJxFSNTvjCCUbAAzdOoHh6C63HWaz03gSqvpwmlQj6QjLH7rd2BZppctUtErZ5Me+1hV2N4aq3JkVOSBMxeyM69gqZYylmWHZ1H7VQ+6KESe8BQxWVVK2ZzuyexNG5Vtxu1YbK9Y4t4EXur714ssYVHDGGUtroq9gErN86OHPYyabQu0NnCLEBzNqbYdeW8Jj2HD008dt+HotukzFhITbd4evhGYh7NczMIyMQHTBh60eLg+0bIIiwMTN9XKiPSipZNVXrEJy3vUbEqnDD9uGiluQnjyP0Z/feCOL2kRGCp3rPAFM1YhM+Gv98JsBuJSyQPL1DocfZpxwKG1dWoPvoC+fjt1vkvr/ddtxTROpvqHar2f17bQhndCuQz9E3Io9SlmHtyPu0sRFH7Dbp+4P2Xwx9qqe3Dra4+9PXQrsUCJcPWwx9Ef6sBTFVI+94qnyIY5/XqeJpf2qLILC1dfMlaaJrjhlq9SZPJomPP8ZoXJJy32jdVzpfJZO7JPiJ6WfwxFLT418txTnvEpsVWAn6FXmiyOhcltQVOTvR2CRN2ElAYVJCLZkkevYrZi5JSfGtKYiDlvrgdpO7SOUjY0kaDMZkkviQWZImeCuqmohDEaDKNFlm3MU6jvhQX21J15flH21skvqh2NMf7IabrrdCw3+op34P6w7XrjNhjFgl21HoGHSK1oVv13rYy1W8/qUjVaJz2BNZkibSYdUfZc+sGf3xSGeoSRL2IX5sW54WUX30mNSuLrT6Qw2Dw38H5h+Ikq+9P/DmlL0m0wbzqE0OurhcCuwbHz62YiI9SysW/TG9cnRvzIt98dpeuMgWuilzCsagMEMOm/7hmDynPYgyazjzoD2+NyRrWW0lG63T5PZxYW4h04MYDIbPS5w7aOoaDWTaKDTP+26gJyPc+PR0nSarx8Vb/b8U70uavOXj0v3MUfQuw+DP4PXFq3WaFI/z+vc2zv8nMnv6ct3ddVt3+fuZzlfv47m1fowwXipER3knb9SZydH0gJhpXaJQ95B4M/eWqYZnpIw8C54YDtVKY+OFAktZlmAwQ0r18GHpcFZBUDp8HBdCtIyM2m+pgNU528wsUanYn/UdzhCckYsFUkJLoODGIRCNghOoKAWEuBJzijNziorBG6kbG9krhOV4cYmkMboCpc+KkGqxafv20OH0gL7sw/7sUAldcoqi12cXbz8ASzbKB+CKNhLupfR9wNnFW0p6kfOghw3hnW2RiNCKDRIgvQhupIhB8vZsX3mrGxUjolnYjRylYUg3GcB9hnJpd3KUdt65NsftXsddXhRNkW4cJWTJEPe3Dmu7gSNz0QJ5oZsPWZWPIClg0bAr39GWjRkw7DHsklak8slzbJrkjYl5OmFZECVl0nU4RVSIqNd/Cqisby5gLqxDk1JaHSFvGjI92i7xtkYjUWW4A4KHt7Df450eHpYf5VdpZb0WMj45oX9bCsBGFiAx02YIlqvPkvTDjYCHVSBfTGbHfTWo02C+KsZ/t7WqsoJUmAqt3dRidjR5RIA+blKVUuH7CMr78cnJ+y8IuXWanO4C51xX6ArONqGVuzSakvXqEgWljpkViIWQCmh48y/ECo3R5mGpP46zh0A4PTl5P2pB+OI+CG8Uu2Q5MfRCX6P690raH9754YnV24ptB28LJNITcX2yIWy/3AtpMWuMdKtkcnmX3A5ELQe+fnJ5tb6iVecKTeZxrS1zLFyRTJLje9YyZ+aSKXZ5lzSmTCZJvO6tUDm5Te9d+aKWxzejZJ1ut9ipIOyltk4spFoMHmx11Yl6TtPhEd8QuLNnavlPJIMm4NmnShNJy6BAQSoBIUiz/FPnKvg2zlU04nfa5d2kbFva0dDesJ23j/Qd1nDPGL6Mligbl61tmXQSJa39Rz9bi+6yW3qt8RRtpxEbHePTU9bOvxyxGvviFWuIpy/XVx7hnrbE7pj+le/jIBt3V7zPpJprnoAAylmN6pzuSlrnN6P76jGWma7aPLhI/r///T/cIt6uvA0/g7PGQK2XaCjRmxLb5iXeSrqdennoZP1zZEFUJVpLLgHlcOFzuOWCQ2nxaspELWaylLRxiUz7AHVv79sh/Fwg+RCp6pnxUcUbLGm/Q6k1Zzg7DaJxuurnicNSm+s5sZSCgBmlxKIl3QpjE1SFUBn59Px6TkEboIxuukRrIy2CkBUR02WO87nMJHVMp5QRmYNKKLFAGixlNZ1QqGNCq9Ez0oWsLht/21NaLaLzIrJPcQjfkHbFglNhjk7IEnN/0dvUK1rh0AoZ4zNSamsaXmZou2yDEm/Q8P71anJTllBr51VXsin6c0sdOSOUJUPAMxSnpoUvaCI8Ri5WQyD3JV0QpIXRAiiluqb87gFctsvsZ5xZ6bAzUZbL5b2z5Plmm++kK5oZGKx1127BhXzy9Ju3H89p56Op7Nn8HM2NzDAcZHvGPGbi43DHiIzvmLifRS3/tt2AzvtSZqgs9m6E19+9/R5u4MXwJEl7p+cHMHz8/Zuvv/3x/Fvql853v/9Gw5PhCftVtHWVUL2hvvbPOC6682zL69deloe3IYe3IYe3IYe3IYe3IYe3IYe3IYe3IYe3IR8a0T68DTm8DTm8DYHD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25BPeRsS8iBIPzuuSyE5kYYjp3chB+Zy+8XIVZoUlCQzuUzu7ihs9c6U6zUV/9agoQybqzS5EUaSm5bza9KYR0KZF9e4ovCp9zgPLmj81K9GDvVupRVRGoxv8Zrn5UHafh7P27PziyRNZuFVS6VzamPEkl68iGUySUh35tcxDCm/axCcslwKtWg4GSTx/VL6i2hcsZk7c825M+FHL6dEqFWPy82kGi8K/SXBdjb4C8Vb/4mrv7bkvmZvg4BtpKYpvFqv1/8HL3VvlA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW21vIzeS/iuV/jIZoyVbGmcyJywWO3m57Owm8SD2IDhYxoTqLqkZd5Mdkm1ZMfTtfsn9tPslhyqS3S1Zsmcyi40P0BdbTRbJqodv9ca7xImFTSaXyQVWdSkc2uQqTXK0mZG1k1olk+SiQIjV8LVBQeXw+u0bEGWplxYai8aC05BRJULWWKcr+buYlQgudpzCspBZARbNDYKwMCsbrI1UzsJcG1igQiOcVAvIddZUSBVL6QqoDeY4lwpzsM40mWsM2iG8q7UC22QZWjtvynYkz4bUKgVXIDNq0DVGWRDQKPlbg3B0FKnfy/zoCFwhHGRCwQxJnJykCQxhj52ZoDqtuGNbYybnkohDX8OpmqoLWU/gXV1qkcNKNwbefvOfbRfUL5VdHh19g7NmAe/eHB1dfV44V9vJ8bGo66GuUVm5UKWY2WGmq+OcCOt8/pwQRIPUK/OKwspyBSLPYSnzBTrLEivIdL2CTGuTS+Whr8UCQTXVDI1NQagcKm0QpAIBBkW+Gjg9aCzCP87PfqTpqIQbwtuysWk7XC4NZq5c+e4JgSjVM4/My1OaH6kWKVTimiZSOvitkdk1iW1RMaxhThiro6Pzpq61cZjDz16EydER1XyFpV6CMMj0ma4qraAWRlToeLXRhFG1wd8aaTD3S0WUZcRiQt0MaKZXNU6OjuCNymVGcHCXVAp6HqiHnpRgItLzMLWetAcezb1fxoTKUvgZrUuReUYN0qpw8gY3O75NYUUdf4NKRw4KbeTvWjlR8oTcoHEyE2V/4ohBXmpOGN4ZtZbKxdIwAvxXmCCaP56WsLKItZzgqqTiGotwI8oGbeBqmUJBXP2EtUHLKzz0S1CqHAqUi2LveCL/tbFuo2NoLLHZ5yKMFeeJ4UWGbS5KiyDnG1hW4hp7o4HmY0iUQ/hqBTnORVO6FCStOWcaHMKP2oGo61JmfN7QUULbR9ApMeBZDgsiMKJExXP81ugbmSMdCrmcz9HQ9qRK7iK0idzRSqu5AYnHe8cVQoFWWxOd6VIb6n5rDXH5JpCQaeVQuSG8vhGyZO69tBakysomR5iVIrtO+ahMwWDu9+4K6eBN/ZJnEjpPPegMEFgsaRlqRQIoHYaXtju0hheFtN2OoroINY8hbR/VsG/nmgYmCOImA6yELFMGLoVf9QycdCWmtGVroVYp5MJhCg5v3UzfppAVmF3zLyNyqWHWOEdHNY2ZG13neqkCllb+vmM3UunHAzlO4TSFlym8SmF0ksJonMLoNIXRyxRGr1IYn6QwHqcwPk1h/NKzM34VIBYdrmHw0dgD63qAwtNGlE7b76Xl3UzHpG1P3uXGyTtVoyGDH/YQF//yyy9TdTdVANOE9tQ0mUyTlmSapODr6KicJpNRCqHgdppM4MX4y0iwou+XhKz/XtL3iGbCfxf0PR5N1ToMOmZmnKjqBxih6n89E/EzrCUq5JGpLB5nVEjnkKelGpo3Km3Zoop1J9ALEkgq6aQo7X6ZIsXTE6vjbEuyU5KMV+9+sbj66ckU2Yo1fF76Kj5fe1V0BDAT4y3xvxh2t8se6f2AT034wNWnyP6SZG/Pqv0AtCRPD4U+a58CxZdDVgP4rN4PRCB4ejB0jH0KCK8IBLqn9iNAtU9P/MBVrAj3vq87OR2MvhiMT8anPQpvK3mCqhrk+WC1Wn0CfMBgkfoTxmZlMiirXscjm3RudLXDEmFDoaMKahL/jtr7D6Szz6I6izkZgZvmbDT/+gq307lYPbO+q9g06GmevtPUVj02uYr4YFM4K7TMAvNEE7W0GVl7QwJhQKDnxz/8cNyD0RcOqipiC7GUvgcMe7+0qoZ5Ptym3ZidXmkFeZ7CjvLdFXkOVVXtK/cVdDVO1X8M2c/Aatr+fRAInt5W6BjbuRu2bo1CqlARVgdsERhcNKUweEu2ppVasfSfeM5s7ZO4TTqFnc1StujY6PciwednQTF/HpYwcb/ZAZU83u6eUP1ODC7wlvvwHjFiRubBNWWbrCCrTUT9X6ty1blo+CsTtST3QInOcSm6bLjJxFSNTvjCCUbAAzdOoHh6C63HWaz03gSqvpwmlQj6QjLH7rd2BZppctUtErZ5Me+1hV2N4aq3JkVOSBMxeyM69gqZYylmWHZ1H7VQ+6KESe8BQxWVVK2ZzuyexNG5Vtxu1YbK9Y4t4EXur714ssYVHDGGUtroq9gErN86OHPYyabQu0NnCLEBzNqbYdeW8Jj2HD008dt+HotukzFhITbd4evhGYh7NczMIyMQHTBh60eLg+0bIIiwMTN9XKiPSipZNVXrEJy3vUbEqnDD9uGiluQnjyP0Z/feCOL2kRGCp3rPAFM1YhM+Gv98JsBuJSyQPL1DocfZpxwKG1dWoPvoC+fjt1vkvr/ddtxTROpvqHar2f17bQhndCuQz9E3Io9SlmHtyPu0sRFH7Dbp+4P2Xwx9qqe3Dra4+9PXQrsUCJcPWwx9Ef6sBTFVI+94qnyIY5/XqeJpf2qLILC1dfMlaaJrjhlq9SZPJomPP8ZoXJJy32jdVzpfJZO7JPiJ6WfwxFLT418txTnvEpsVWAn6FXmiyOhcltQVOTvR2CRN2ElAYVJCLZkkevYrZi5JSfGtKYiDlvrgdpO7SOUjY0kaDMZkkviQWZImeCuqmohDEaDKNFlm3MU6jvhQX21J15flH21skvqh2NMf7IabrrdCw3+op34P6w7XrjNhjFgl21HoGHSK1oVv13rYy1W8/qUjVaJz2BNZkibSYdUfZc+sGf3xSGeoSRL2IX5sW54WUX30mNSuLrT6Qw2Dw38H5h+Ikq+9P/DmlL0m0wbzqE0OurhcCuwbHz62YiI9SysW/TG9cnRvzIt98dpeuMgWuilzCsagMEMOm/7hmDynPYgyazjzoD2+NyRrWW0lG63T5PZxYW4h04MYDIbPS5w7aOoaDWTaKDTP+26gJyPc+PR0nSarx8Vb/b8U70uavOXj0v3MUfQuw+DP4PXFq3WaFI/z+vc2zv8nMnv6ct3ddVt3+fuZzlfv47m1fowwXipER3knb9SZydH0gJhpXaJQ95B4M/eWqYZnpIw8C54YDtVKY+OFAktZlmAwQ0r18GHpcFZBUDp8HBdCtIyM2m+pgNU528wsUanYn/UdzhCckYsFUkJLoODGIRCNghOoKAWEuBJzijNziorBG6kbG9krhOV4cYmkMboCpc+KkGqxafv20OH0gL7sw/7sUAldcoqi12cXbz8ASzbKB+CKNhLupfR9wNnFW0p6kfOghw3hnW2RiNCKDRIgvQhupIhB8vZsX3mrGxUjolnYjRylYUg3GcB9hnJpd3KUdt65NsftXsddXhRNkW4cJWTJEPe3Dmu7gSNz0QJ5oZsPWZWPIClg0bAr39GWjRkw7DHsklak8slzbJrkjYl5OmFZECVl0nU4RVSIqNd/Cqisby5gLqxDk1JaHSFvGjI92i7xtkYjUWW4A4KHt7Df450eHpYf5VdpZb0WMj45oX9bCsBGFiAx02YIlqvPkvTDjYCHVSBfTGbHfTWo02C+KsZ/t7WqsoJUmAqt3dRidjR5RIA+blKVUuH7CMr78cnJ+y8IuXWanO4C51xX6ArONqGVuzSakvXqEgWljpkViIWQCmh48y/ECo3R5mGpP46zh0A4PTl5P2pB+OI+CG8Uu2Q5MfRCX6P690raH9754YnV24ptB28LJNITcX2yIWy/3AtpMWuMdKtkcnmX3A5ELQe+fnJ5tb6iVecKTeZxrS1zLFyRTJLje9YyZ+aSKXZ5lzSmTCZJvO6tUDm5Te9d+aKWxzejZJ1ut9ipIOyltk4spFoMHmx11Yl6TtPhEd8QuLNnavlPJIMm4NmnShNJy6BAQSoBIUiz/FPnKvg2zlU04nfa5d2kbFva0dDesJ23j/Qd1nDPGL6Mligbl61tmXQSJa39Rz9bi+6yW3qt8RRtpxEbHePTU9bOvxyxGvviFWuIpy/XVx7hnrbE7pj+le/jIBt3V7zPpJprnoAAylmN6pzuSlrnN6P76jGWma7aPLhI/r///T/cIt6uvA0/g7PGQK2XaCjRmxLb5iXeSrqdennoZP1zZEFUJVpLLgHlcOFzuOWCQ2nxaspELWaylLRxiUz7AHVv79sh/Fwg+RCp6pnxUcUbLGm/Q6k1Zzg7DaJxuurnicNSm+s5sZSCgBmlxKIl3QpjE1SFUBn59Px6TkEboIxuukRrIy2CkBUR02WO87nMJHVMp5QRmYNKKLFAGixlNZ1QqGNCq9Ez0oWsLht/21NaLaLzIrJPcQjfkHbFglNhjk7IEnN/0dvUK1rh0AoZ4zNSamsaXmZou2yDEm/Q8P71anJTllBr51VXsin6c0sdOSOUJUPAMxSnpoUvaCI8Ri5WQyD3JV0QpIXRAiiluqb87gFctsvsZ5xZ6bAzUZbL5b2z5Plmm++kK5oZGKx1127BhXzy9Ju3H89p56Op7Nn8HM2NzDAcZHvGPGbi43DHiIzvmLifRS3/tt2AzvtSZqgs9m6E19+9/R5u4MXwJEl7p+cHMHz8/Zuvv/3x/Fvql853v/9Gw5PhCftVtHWVUL2hvvbPOC6682zL69deloe3IYe3IYe3IYe3IYe3IYe3IYe3IYe3IYe3IR8a0T68DTm8DTm8DYHD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25DD25BPeRsS8iBIPzuuSyE5kYYjp3chB+Zy+8XIVZoUlCQzuUzu7ihs9c6U6zUV/9agoQybqzS5EUaSm5bza9KYR0KZF9e4ovCp9zgPLmj81K9GDvVupRVRGoxv8Zrn5UHafh7P27PziyRNZuFVS6VzamPEkl68iGUySUh35tcxDCm/axCcslwKtWg4GSTx/VL6i2hcsZk7c825M+FHL6dEqFWPy82kGi8K/SXBdjb4C8Vb/4mrv7bkvmZvg4BtpKYpvFqv1/8HL3VvlA==",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"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"size:"})," Specifies the size 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 size of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "size": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "size": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.d67131c6.js b/assets/js/runtime~main.ebbd1254.js similarity index 97% rename from assets/js/runtime~main.d67131c6.js rename to assets/js/runtime~main.ebbd1254.js index c27d1f67e..66c0464a1 100644 --- a/assets/js/runtime~main.d67131c6.js +++ b/assets/js/runtime~main.ebbd1254.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,f,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,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},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,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&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(f,d),f},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/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"fc71588b",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"dd1f5b80",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"1e67588d",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f3cca27d",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"05196014",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a5a4e5f7",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"8d7a1e93",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"cdd769c8",8140:"901b2f91",8141:"81bec72f",8163:"a62323e7",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"e2b36df1",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[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),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[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 f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.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:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,f,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,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},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,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&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(f,d),f},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/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"fc71588b",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"e7b67797",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"1e67588d",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f3cca27d",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"05196014",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a5a4e5f7",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"f6d4feec",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"cdd769c8",8140:"901b2f91",8141:"81bec72f",8163:"a62323e7",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"e8abf1d2",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[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),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[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 f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.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:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 5c402b224..871798e3f 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 6865f28bc..831b0a9bc 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 82a65c4c1..a29f33503 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 34d817638..ba80c4815 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 4e2971375..55bd5ce0a 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 9cf83f1f8..b11972daa 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 d189218cc..f8fe4991a 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 4d88db5ae..dbccc27ac 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 5398c4b27..a7f9863d8 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 7696a8d44..0fc58b99c 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 0dd81fccb..f679772dc 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 fd892450c..fd5b41596 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 c95651c9f..fc0fec947 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -22,16 +22,14 @@
  • w, h: Represents the width and height of the widget. You can adjust these values using the debug UI.
  • required: Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.
  • name: Provides a different name for widgets if you are providing more than one widget.
  • -
  • color: Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.
  • +
  • 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.
  • +
  • size: Specifies the size 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 size of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
  • List of all supported widgets:

    1. signature:
    {
    "type":"signature",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21
    }
    -
      -
    • Note: At least one signature is required for each signer. All signature fields are compulsory by default.
    • -
    1. stamp:
    @@ -43,23 +41,23 @@
    1. email:
    -
    {
    "type":"email",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "email",
    "color": "black"
    }
    }
    +
    {
    "type":"email",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "email",
    "color": "black",
    "size": 12
    }
    }
    1. name:
    -
    {
    "type":"name",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "name",
    "color": "black"
    }
    }
    +
    {
    "type":"name",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "name",
    "color": "black",
    "size": 12
    }
    }
    1. job title:
    -
    {
    "type":"job title",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "job title",
    "color": "black"
    }
    }
    +
    {
    "type":"job title",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "job title",
    "color": "black",
    "size": 12
    }
    }
    1. company:
    -
    {
    "type":"company",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "company",
    "color": "black"
    }
    }
    +
    {
    "type":"company",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "company",
    "color": "black",
    "size": 12
    }
    }
    1. date:
    -
    {
    "type":"date",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "date",
    "default": "04-15-2024",
    "format": "mm-dd-yyyy",
    "color": "black"
    }
    }
    +
    {
    "type":"date",
    "page":1,
    "x": 327,
    "y": 628,
    "w": 114,
    "h": 21,
    "options": {
    "required": true,
    "name": "date",
    "default": "04-15-2024",
    "format": "mm-dd-yyyy",
    "color": "black",
    "size": 12
    }
    }
    • default: Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
    • format: Specify the date format of your choice from the options below. @@ -79,7 +77,7 @@
      1. textbox:
      -
      {
      "type":"textbox",
      "page":1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "textbox",
      "default": "name",
      "hint": "provide name",
      "regularexpression":"",
      "color": "black"
      }
      }
      +
      {
      "type":"textbox",
      "page":1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "textbox",
      "default": "name",
      "hint": "provide name",
      "regularexpression":"",
      "color": "black",
      "size": 12
      }
      }
      • default: Provide a default value for the textbox (Optional).
      • hint: Provide a hint for the textbox (Optional).
      • @@ -88,7 +86,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",
        "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",
        "size": 12,
        "validation": {
        "minselections": 0,
        "maxselections": 0
        }
        }
        }
        • values: Provide options for the checkbox list.
        • selectedvalues: Provide values that need to be selected by default (Optional).
        • @@ -100,7 +98,7 @@
          1. dropdown:
          -
          {
          "type":"dropdown",
          "page":1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "dropdown",
          "values": ["male", "female", "other"],
          "default": "male",
          "color": "black"
          }
          }
          +
          {
          "type":"dropdown",
          "page":1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "dropdown",
          "values": ["male", "female", "other"],
          "default": "male",
          "color": "black",
          "size": 12
          }
          }
          • values: Provide options for the dropdown list.
          • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
          • @@ -108,7 +106,7 @@
            1. radio button:
            -
            {
            "type":"radio button",
            "page":1,
            "x": 327,
            "y": 628,
            "w": 114,
            "h": 21,
            "options": {
            "required": true,
            "name": "radio button",
            "values": ["male", "female", "other"],
            "default": "male",
            "color": "black"
            }
            }
            +
            {
            "type":"radio button",
            "page":1,
            "x": 327,
            "y": 628,
            "w": 114,
            "h": 21,
            "options": {
            "required": true,
            "name": "radio button",
            "values": ["male", "female", "other"],
            "default": "male",
            "color": "black",
            "size": 12
            }
            }
            • values: Provide options for the radio button list.
            • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
            • @@ -116,7 +114,7 @@
              1. image:
              -
              {
              "type":"image",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "image",
              "color": "black"
              }
              }
              +
              {
              "type":"image",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "image"
              }
              }

              Request

              Body

              required

                file base64required
                title stringrequired
                description string
                note string
                timeToCompleteDays number

                time to complete days is used to calculate expiry date of your document

                signers

                object[]

                required

              • Array [

              • role string
                email string
                name string
                phone string

                widgets

                object[]

              • Array [

              • type string

                Allowed values - signature, stamp.

                page number

                The page number on which the widget should appear. use our Debug UI to calculate the value.

                x number

                x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

                y number

                y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

                w number

                Width of widget. use our Debug UI to calculate the value.

                h number

                Height of widget. use our Debug UI to calculate the value.

              • ]

              • ]

              • folderId string
                send_email boolean

                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.

                email_subject string

                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}}.

                email_body string

                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}}.

                sendInOrder boolean

                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'.

                enableOTP boolean

                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.

                enableTour boolean

                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.

              Responses

              Document created successfully!

              Schema

                objectId string
                url string
              Loading...
              diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 65beaa75c..360e61d90 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 75c75e428..7edeacdbf 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 4475a83bc..729168494 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -22,7 +22,8 @@
            • w, h: Represents the width and height of the widget. You can adjust these values using the debug UI.
            • required: Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.
            • name: Provides a different name for widgets if you are providing more than one widget.
            • -
            • color: Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.
            • +
            • 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.
            • +
            • size: Specifies the size 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 size of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.

            List of all supported widgets:

              @@ -40,23 +41,23 @@
              1. email:
              -
              {
              "type":"email",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "email",
              "color": "black"
              }
              }
              +
              {
              "type":"email",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "email",
              "color": "black",
              "size": 12
              }
              }
              1. name:
              -
              {
              "type":"name",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "name",
              "color": "black"
              }
              }
              +
              {
              "type":"name",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "name",
              "color": "black",
              "size": 12
              }
              }
              1. job title:
              -
              {
              "type":"job title",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "job title",
              "color": "black"
              }
              }
              +
              {
              "type":"job title",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "job title",
              "color": "black",
              "size": 12
              }
              }
              1. company:
              -
              {
              "type":"company",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "company",
              "color": "black"
              }
              }
              +
              {
              "type":"company",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "company",
              "color": "black",
              "size": 12
              }
              }
              1. date:
              -
              {
              "type":"date",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "date",
              "default": "04-15-2024",
              "format": "mm-dd-yyyy",
              "color": "black"
              }
              }
              +
              {
              "type":"date",
              "page":1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "date",
              "default": "04-15-2024",
              "format": "mm-dd-yyyy",
              "color": "black",
              "size": 12
              }
              }
              • default: Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
              • format: Specify the date format of your choice from the options below. @@ -76,7 +77,7 @@
                1. textbox:
                -
                {
                "type":"textbox",
                "page":1,
                "x": 327,
                "y": 628,
                "w": 114,
                "h": 21,
                "options": {
                "required": true,
                "name": "textbox",
                "default": "name",
                "hint": "provide name",
                "regularexpression":"",
                "color": "black"
                }
                }
                +
                {
                "type":"textbox",
                "page":1,
                "x": 327,
                "y": 628,
                "w": 114,
                "h": 21,
                "options": {
                "required": true,
                "name": "textbox",
                "default": "name",
                "hint": "provide name",
                "regularexpression":"",
                "color": "black",
                "size": 12
                }
                }
                • default: Provide a default value for the textbox (Optional).
                • hint: Provide a hint for the textbox (Optional).
                • @@ -85,7 +86,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",
                  "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",
                  "size": 12,
                  "validation": {
                  "minselections": 0,
                  "maxselections": 0
                  }
                  }
                  }
                  • values: Provide options for the checkbox list.
                  • selectedvalues: Provide values that need to be selected by default (Optional).
                  • @@ -97,7 +98,7 @@
                    1. dropdown:
                    -
                    {
                    "type":"dropdown",
                    "page":1,
                    "x": 327,
                    "y": 628,
                    "w": 114,
                    "h": 21,
                    "options": {
                    "required": true,
                    "name": "dropdown",
                    "values": ["male", "female", "other"],
                    "default": "male",
                    "color": "black"
                    }
                    }
                    +
                    {
                    "type":"dropdown",
                    "page":1,
                    "x": 327,
                    "y": 628,
                    "w": 114,
                    "h": 21,
                    "options": {
                    "required": true,
                    "name": "dropdown",
                    "values": ["male", "female", "other"],
                    "default": "male",
                    "color": "black",
                    "size": 12
                    }
                    }
                    • values: Provide options for the dropdown list.
                    • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
                    • @@ -105,7 +106,7 @@
                      1. radio button:
                      -
                      {
                      "type":"radio button",
                      "page":1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "radio button",
                      "values": ["male", "female", "other"],
                      "default": "male",
                      "color": "black"
                      }
                      }
                      +
                      {
                      "type":"radio button",
                      "page":1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "radio button",
                      "values": ["male", "female", "other"],
                      "default": "male",
                      "color": "black",
                      "size": 12
                      }
                      }
                      • values: Provide options for the radio button list.
                      • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
                      • @@ -113,7 +114,7 @@
                        1. image:
                        -
                        {
                        "type":"image",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "image"
                        }
                        }
                        }
                        +
                        {
                        "type":"image",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "image"
                        }
                        }

                        Request

                        Body

                        required

                          file base64required
                          title stringrequired
                          note string
                          description string

                          signers

                          object[]

                          required

                          You can provide signer optionally if you it as default signer

                        • Array [

                        • role string
                          email string
                          name string
                          phone string

                          widgets

                          object[]

                        • Array [

                        • type string

                          Allowed values - signature, stamp.

                          page number

                          The page number on which the widget should appear. use our Debug UI to calculate the value.

                          x number

                          x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

                          y number

                          y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

                          w number

                          Width of widget. use our Debug UI to calculate the value.

                          h number

                          Height of widget. use our Debug UI to calculate the value.

                        • ]

                        • ]

                        • sendInOrder boolean

                          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'.

                          enableOTP boolean

                          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.

                          enableTour boolean

                          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.

                        Responses

                        Template created successfully!

                        Schema

                          objectId string
                          message string
                        Loading...
                        diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 54da2f194..d7c12710d 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 049a1a098..b65e6ac3f 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 8f12bc9bf..31b5504b6 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 a01f15e8e..c8ff0dda3 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 318d0335e..7a6cd8251 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/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index d5d1b5d32..fe5e5ed6f 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -22,7 +22,8 @@
                      • w, h: Represents the width and height of the widget. You can adjust these values using the debug UI.
                      • required: Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.
                      • name: Provides a different name for widgets if you are providing more than one widget.
                      • -
                      • color: Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.
                      • +
                      • 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.
                      • +
                      • size: Specifies the size 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 size of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.

                      List of all supported widgets:

                        @@ -40,23 +41,23 @@
                        1. email:
                        -
                        {
                        "type":"email",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "email",
                        "color": "black"
                        }
                        }
                        +
                        {
                        "type":"email",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "email",
                        "color": "black",
                        "size": 12
                        }
                        }
                        1. name:
                        -
                        {
                        "type":"name",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "name",
                        "color": "black"
                        }
                        }
                        +
                        {
                        "type":"name",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "name",
                        "color": "black",
                        "size": 12
                        }
                        }
                        1. job title:
                        -
                        {
                        "type":"job title",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "job title",
                        "color": "black"
                        }
                        }
                        +
                        {
                        "type":"job title",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "job title",
                        "color": "black",
                        "size": 12
                        }
                        }
                        1. company:
                        -
                        {
                        "type":"company",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "company",
                        "color": "black"
                        }
                        }
                        +
                        {
                        "type":"company",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "company",
                        "color": "black",
                        "size": 12
                        }
                        }
                        1. date:
                        -
                        {
                        "type":"date",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "date",
                        "default": "04-15-2024",
                        "format": "mm-dd-yyyy",
                        "color": "black"
                        }
                        }
                        +
                        {
                        "type":"date",
                        "page":1,
                        "x": 327,
                        "y": 628,
                        "w": 114,
                        "h": 21,
                        "options": {
                        "required": true,
                        "name": "date",
                        "default": "04-15-2024",
                        "format": "mm-dd-yyyy",
                        "color": "black",
                        "size": 12
                        }
                        }
                        • default: Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
                        • format: Specify the date format of your choice from the options below. @@ -76,7 +77,7 @@
                          1. textbox:
                          -
                          {
                          "type":"textbox",
                          "page":1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "textbox",
                          "default": "name",
                          "hint": "provide name",
                          "regularexpression":"",
                          "color": "black"
                          }
                          }
                          +
                          {
                          "type":"textbox",
                          "page":1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "textbox",
                          "default": "name",
                          "hint": "provide name",
                          "regularexpression":"",
                          "color": "black",
                          "size": 12
                          }
                          }
                          • default: Provide a default value for the textbox (Optional).
                          • hint: Provide a hint for the textbox (Optional).
                          • @@ -85,7 +86,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",
                            "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",
                            "size": 12,
                            "validation": {
                            "minselections": 0,
                            "maxselections": 0
                            }
                            }
                            }
                            • values: Provide options for the checkbox list.
                            • selectedvalues: Provide values that need to be selected by default (Optional).
                            • @@ -97,7 +98,7 @@
                              1. dropdown:
                              -
                              {
                              "type":"dropdown",
                              "page":1,
                              "x": 327,
                              "y": 628,
                              "w": 114,
                              "h": 21,
                              "options": {
                              "required": true,
                              "name": "dropdown",
                              "values": ["male", "female", "other"],
                              "default": "male",
                              "color": "black"
                              }
                              }
                              +
                              {
                              "type":"dropdown",
                              "page":1,
                              "x": 327,
                              "y": 628,
                              "w": 114,
                              "h": 21,
                              "options": {
                              "required": true,
                              "name": "dropdown",
                              "values": ["male", "female", "other"],
                              "default": "male",
                              "color": "black",
                              "size": 12
                              }
                              }
                              • values: Provide options for the dropdown list.
                              • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
                              • @@ -105,7 +106,7 @@
                                1. radio button:
                                -
                                {
                                "type":"radio button",
                                "page":1,
                                "x": 327,
                                "y": 628,
                                "w": 114,
                                "h": 21,
                                "options": {
                                "required": true,
                                "name": "radio button",
                                "values": ["male", "female", "other"],
                                "default": "male",
                                "color": "black"
                                }
                                }
                                +
                                {
                                "type":"radio button",
                                "page":1,
                                "x": 327,
                                "y": 628,
                                "w": 114,
                                "h": 21,
                                "options": {
                                "required": true,
                                "name": "radio button",
                                "values": ["male", "female", "other"],
                                "default": "male",
                                "color": "black",
                                "size": 12
                                }
                                }
                                • values: Provide options for the radio button list.
                                • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
                                • @@ -113,7 +114,7 @@
                                  1. image:
                                  -
                                  {
                                  "type":"image",
                                  "page":1,
                                  "x": 327,
                                  "y": 628,
                                  "w": 114,
                                  "h": 21,
                                  "options": {
                                  "required": true,
                                  "name": "image"
                                  }
                                  }
                                  }
                                  +
                                  {
                                  "type":"image",
                                  "page":1,
                                  "x": 327,
                                  "y": 628,
                                  "w": 114,
                                  "h": 21,
                                  "options": {
                                  "required": true,
                                  "name": "image"
                                  }
                                  }

                                  Request

                                  Body

                                  required

                                    file base64required
                                    title stringrequired
                                    note string
                                    description string

                                    signers

                                    object[]

                                    required

                                    You can provide signer optionally if you it as default signer

                                  • Array [

                                  • role string
                                    email string
                                    name string
                                    phone string

                                    widgets

                                    object[]

                                  • Array [

                                  • type string

                                    Allowed values - signature, stamp.

                                    page number

                                    The page number on which the widget should appear. use our Debug UI to calculate the value.

                                    x number

                                    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

                                    y number

                                    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

                                    w number

                                    Width of widget. use our Debug UI to calculate the value.

                                    h number

                                    Height of widget. use our Debug UI to calculate the value.

                                  • ]

                                  • ]

                                  • sendInOrder boolean

                                    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'.

                                    enableOTP boolean

                                    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.

                                    enableTour boolean

                                    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.

                                  Responses

                                  Template created successfully!

                                  Schema

                                    objectId string
                                    url string
                                  Loading...
                                  diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index c88b0b3d5..999f2f9bc 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 3539ced25..0bd520465 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 07bcb06a8..f309984da 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 8df44ece7..b9966719a 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 27c3b2be0..300999a6a 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 2813d9ce8..33f287d36 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 7d0bd8271..8445e50f6 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 a722545af..b4a6a0bfb 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 5b14039d3..2067e59d1 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 7bd9b7611..f3bcff0b3 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 6a51f31d7..0c53e0542 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 f5e3af523..211e1b8db 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 25a9e07f0..625bcb93e 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/update-document/index.html b/docs/API-docs/update-document/index.html index 02839c171..d88d0dd10 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 172ad2ea0..3ebe0a192 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 6aa4875c8..b01a65add 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 a92dd66ee..4964586be 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 92edb069a..d0b16088c 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 b04608aff..fd74e6f8e 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 4f704e175..9acf33a7e 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 28f38f053..4be77cd50 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 dbaf2056f..66304587e 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index 40f9026e6..564ab9c04 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index d3717589d..9dfc404b1 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 b406657c9..511fe9a99 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 af65770f2..689172b43 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 c70a8eeff..5e8d029a8 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 ea3156613..1c8aa6a85 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 dde45cf77..6cda05942 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 b3d6f4eae..456a48166 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 a8af0480f..80e3f9e88 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 357e3498f..0d8cddbc6 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index 964808269..cc0b9f78c 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 d04d6095a..676311336 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 6b5acee8b..fd17dc828 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 97ee7a4eb..5cb4ed5c0 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 265f6dd46..916a9a622 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 b23975cb6..b5ffebda0 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 484f7c8bd..436cb32db 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 8774766b3..8f8658ddf 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 08df27394..f64bc5640 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 441e5b504..4d20cae8e 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 201ee6273..351adfe29 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 1630216a4..c119ce09c 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 3c7864547..c7759f0de 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 516ef4d20..e6aac7a3b 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 f3a07c0c5..0da520ffd 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index 1c6ada113..4bd624571 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 6eeb156bf..bab1036d5 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 4262dbbf7..db3b7f6c0 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 a785a9cd7..72c9b052b 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 80c215c9d..6f3b23690 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 27af2434c..d12bea615 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 2f63ae585..e9d849ac8 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 06e69374f..25f4fa026 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 725261a1e..04035936e 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 6849eb7e9..abbe4d07b 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 d62c4012e..75429c3b3 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 d7180ed67..d3f37d325 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 a837e7e1a..4bbc8a604 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 3ebb2d3f9..bae9f43ff 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index b2086972b..860e81890 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 010d39f90..47056d501 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 d2fb27a6c..6dda90d46 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 9bb01a6db..d7e5efc03 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 1ddc0f912..b47628bc0 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 cbbcd2529..1c3209288 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +