From bc87084b597147b67217f08204ecae28cc88f68a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 13 Oct 2025 12:48:25 +0000 Subject: [PATCH] deploy: f271a113b69452bcf1a9e493444570d6c8b784b4 --- 404.html | 2 +- assets/js/02e5f5c4.60be571e.js | 1 + assets/js/02e5f5c4.ebd704b1.js | 1 - assets/js/03e06346.7bc9fb1d.js | 1 - assets/js/03e06346.8e56cf3c.js | 1 + assets/js/138cee78.27742ef4.js | 1 + assets/js/138cee78.a3f62faa.js | 1 - assets/js/18b84479.33c9f705.js | 1 + assets/js/18b84479.781d6d29.js | 1 - assets/js/19e5ad2a.e44b2367.js | 1 + assets/js/19e5ad2a.e69f4137.js | 1 - assets/js/23f866da.12d03f5a.js | 1 - assets/js/23f866da.928902d5.js | 1 + assets/js/34593b53.635276a4.js | 1 + assets/js/34593b53.a5fa9a4e.js | 1 - assets/js/4227e71a.3f44a353.js | 1 + assets/js/4227e71a.db88685e.js | 1 - assets/js/4d139b56.7e5f8810.js | 1 - assets/js/4d139b56.8d0aa3f2.js | 1 + assets/js/5144c8d4.7c000e5d.js | 1 - assets/js/5144c8d4.8aab2983.js | 1 + assets/js/58abd73c.7661f930.js | 1 + assets/js/58abd73c.cb327dba.js | 1 - assets/js/5a144266.1c2422fe.js | 1 - assets/js/5a144266.804e9e11.js | 1 + assets/js/5ce6d213.827e01c6.js | 1 + assets/js/5ce6d213.c87a9aec.js | 1 - assets/js/62b755e6.3b3ff2a4.js | 1 - assets/js/62b755e6.4db3ade4.js | 1 + assets/js/6d2e526e.4abe84c3.js | 1 - assets/js/6d2e526e.9f2d8c5b.js | 1 + assets/js/7357a3c5.53514c64.js | 1 - assets/js/7357a3c5.6005cc6b.js | 1 + assets/js/7ad5624c.04d03f97.js | 1 + assets/js/7ad5624c.5cd13f3b.js | 1 - assets/js/7ef59f7a.3dea52d8.js | 1 - assets/js/7ef59f7a.4a732e7a.js | 1 + assets/js/851f8f65.0064d4c8.js | 1 - assets/js/851f8f65.905ad68d.js | 1 + assets/js/98334e25.163938f2.js | 1 + assets/js/98334e25.740e393e.js | 1 - assets/js/9c9cb35e.575920a9.js | 1 - assets/js/9c9cb35e.ffea3fac.js | 1 + assets/js/9cd612ce.1bbc46c2.js | 1 - assets/js/9cd612ce.b75be620.js | 1 + assets/js/ac7da374.403772ac.js | 1 - assets/js/ac7da374.4a1b8c9b.js | 1 + assets/js/b2e6bd40.102fca2b.js | 1 + assets/js/b2e6bd40.57077b26.js | 1 - assets/js/b93339ed.bc214206.js | 1 + assets/js/b93339ed.d3620018.js | 1 - assets/js/c195e1f1.78cbdeaf.js | 1 - assets/js/c195e1f1.ea9e4a46.js | 1 + assets/js/c4fbe420.9177040b.js | 1 + assets/js/c4fbe420.c124b6c6.js | 1 - assets/js/c7e3ab5f.037506c8.js | 1 - assets/js/c7e3ab5f.cf9a081c.js | 1 + assets/js/d0524430.5aa106b8.js | 1 + assets/js/d0524430.6f5015ca.js | 1 - assets/js/d480dde9.2025796d.js | 1 - assets/js/d480dde9.a2cfa06b.js | 1 + assets/js/da66eb9c.717af639.js | 1 + assets/js/da66eb9c.b5f1e6c1.js | 1 - .../js/{runtime~main.1dc5766b.js => runtime~main.3e17fae5.js} | 2 +- blog/archive/index.html | 2 +- blog/authors/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/api-intro/index.html | 2 +- docs/API-docs/v1.1/contactlist/index.html | 2 +- docs/API-docs/v1.1/createcontact/index.html | 2 +- docs/API-docs/v1.1/createdocument/index.html | 2 +- docs/API-docs/v1.1/createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/v1.1/createfolder/index.html | 2 +- docs/API-docs/v1.1/createtemplate/index.html | 2 +- docs/API-docs/v1.1/delete-template/index.html | 2 +- docs/API-docs/v1.1/delete-webhook/index.html | 2 +- docs/API-docs/v1.1/deletecontact/index.html | 2 +- docs/API-docs/v1.1/deletedocument/index.html | 2 +- docs/API-docs/v1.1/deletefolder/index.html | 2 +- docs/API-docs/v1.1/draftdocument/index.html | 2 +- docs/API-docs/v1.1/drafttemplate/index.html | 2 +- docs/API-docs/v1.1/folderlist/index.html | 2 +- docs/API-docs/v1.1/get-template/index.html | 2 +- docs/API-docs/v1.1/get-user/index.html | 2 +- docs/API-docs/v1.1/get-webhook/index.html | 2 +- docs/API-docs/v1.1/getcontact/index.html | 2 +- docs/API-docs/v1.1/getcredits/index.html | 2 +- docs/API-docs/v1.1/getdocument/index.html | 2 +- docs/API-docs/v1.1/getdocumentlist/index.html | 2 +- docs/API-docs/v1.1/getfolder/index.html | 2 +- docs/API-docs/v1.1/gettemplatelist/index.html | 2 +- docs/API-docs/v1.1/index.html | 2 +- docs/API-docs/v1.1/intro/index.html | 2 +- docs/API-docs/v1.1/opensign-api-v-1-1/index.html | 2 +- docs/API-docs/v1.1/publictemplate/index.html | 2 +- docs/API-docs/v1.1/resendrequestmail/index.html | 2 +- docs/API-docs/v1.1/revokedocument/index.html | 2 +- docs/API-docs/v1.1/save-update-webhook/index.html | 2 +- docs/API-docs/v1.1/selfsign/index.html | 2 +- docs/API-docs/v1.1/update-document/index.html | 2 +- docs/API-docs/v1.1/update-template/index.html | 2 +- docs/API-docs/v1.1/updatefolder/index.html | 2 +- docs/API-docs/v1/contactlist/index.html | 2 +- docs/API-docs/v1/createcontact/index.html | 2 +- docs/API-docs/v1/createdocument/index.html | 2 +- docs/API-docs/v1/createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/v1/createfolder/index.html | 2 +- docs/API-docs/v1/createtemplate/index.html | 2 +- docs/API-docs/v1/delete-template/index.html | 2 +- docs/API-docs/v1/delete-webhook/index.html | 2 +- docs/API-docs/v1/deletecontact/index.html | 2 +- docs/API-docs/v1/deletedocument/index.html | 2 +- docs/API-docs/v1/deletefolder/index.html | 2 +- docs/API-docs/v1/draftdocument/index.html | 2 +- docs/API-docs/v1/drafttemplate/index.html | 2 +- docs/API-docs/v1/folderlist/index.html | 2 +- docs/API-docs/v1/get-template/index.html | 2 +- docs/API-docs/v1/get-user/index.html | 2 +- docs/API-docs/v1/get-webhook/index.html | 2 +- docs/API-docs/v1/getcontact/index.html | 2 +- docs/API-docs/v1/getdocument/index.html | 2 +- docs/API-docs/v1/getdocumentlist/index.html | 2 +- docs/API-docs/v1/getfolder/index.html | 2 +- docs/API-docs/v1/gettemplatelist/index.html | 2 +- docs/API-docs/v1/index.html | 2 +- docs/API-docs/v1/intro/index.html | 2 +- docs/API-docs/v1/opensign-api-v-1/index.html | 2 +- docs/API-docs/v1/resendrequestmail/index.html | 2 +- docs/API-docs/v1/revokedocument/index.html | 2 +- docs/API-docs/v1/save-update-webhook/index.html | 2 +- docs/API-docs/v1/selfsign/index.html | 2 +- docs/API-docs/v1/update-document/index.html | 2 +- docs/API-docs/v1/update-template/index.html | 2 +- docs/API-docs/v1/updatefolder/index.html | 2 +- docs/category/cloud-storage/index.html | 2 +- docs/category/create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/documents/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- docs/category/manage-docs-using-opensign-drive/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/category/user-menu/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/Max File Upload Size/index.html | 2 +- docs/help/FAQs/User Deletion/index.html | 2 +- docs/help/FAQs/index.html | 2 +- docs/help/New-Document/edit-document-before-sending/index.html | 2 +- docs/help/New-Document/enforce-email-verification/index.html | 2 +- docs/help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/New-Document/widgets/index.html | 2 +- docs/help/OpenSign™ Drive/create-document/index.html | 2 +- docs/help/OpenSign™ Drive/list-grid-view/index.html | 2 +- docs/help/OpenSign™ Drive/organize-documents/index.html | 2 +- docs/help/OpenSign™ Drive/rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/contactbook/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- docs/help/Settings/APIToken/index.html | 2 +- docs/help/Settings/Custom-email-templates/index.html | 2 +- docs/help/Settings/Preferences/index.html | 2 +- docs/help/Settings/SecurityManagement/index.html | 2 +- docs/help/Settings/Teams/index.html | 2 +- docs/help/Settings/Webhook/index.html | 2 +- docs/help/Settings/disabledocumentid/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- docs/help/Templates/create-template/index.html | 2 +- docs/help/Templates/embed-template/index.html | 2 +- docs/help/Templates/manage-templates/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/User Menu/Profile/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- docs/self-host/One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/cloud-storage/s3/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- docs/self-host/docker/upgrade-deployment/index.html | 2 +- docs/self-host/guides/azure-vm-setup/index.html | 2 +- docs/self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- docs/self-host/guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 207 files changed, 176 insertions(+), 176 deletions(-) create mode 100644 assets/js/02e5f5c4.60be571e.js delete mode 100644 assets/js/02e5f5c4.ebd704b1.js delete mode 100644 assets/js/03e06346.7bc9fb1d.js create mode 100644 assets/js/03e06346.8e56cf3c.js create mode 100644 assets/js/138cee78.27742ef4.js delete mode 100644 assets/js/138cee78.a3f62faa.js create mode 100644 assets/js/18b84479.33c9f705.js delete mode 100644 assets/js/18b84479.781d6d29.js create mode 100644 assets/js/19e5ad2a.e44b2367.js delete mode 100644 assets/js/19e5ad2a.e69f4137.js delete mode 100644 assets/js/23f866da.12d03f5a.js create mode 100644 assets/js/23f866da.928902d5.js create mode 100644 assets/js/34593b53.635276a4.js delete mode 100644 assets/js/34593b53.a5fa9a4e.js create mode 100644 assets/js/4227e71a.3f44a353.js delete mode 100644 assets/js/4227e71a.db88685e.js delete mode 100644 assets/js/4d139b56.7e5f8810.js create mode 100644 assets/js/4d139b56.8d0aa3f2.js delete mode 100644 assets/js/5144c8d4.7c000e5d.js create mode 100644 assets/js/5144c8d4.8aab2983.js create mode 100644 assets/js/58abd73c.7661f930.js delete mode 100644 assets/js/58abd73c.cb327dba.js delete mode 100644 assets/js/5a144266.1c2422fe.js create mode 100644 assets/js/5a144266.804e9e11.js create mode 100644 assets/js/5ce6d213.827e01c6.js delete mode 100644 assets/js/5ce6d213.c87a9aec.js delete mode 100644 assets/js/62b755e6.3b3ff2a4.js create mode 100644 assets/js/62b755e6.4db3ade4.js delete mode 100644 assets/js/6d2e526e.4abe84c3.js create mode 100644 assets/js/6d2e526e.9f2d8c5b.js delete mode 100644 assets/js/7357a3c5.53514c64.js create mode 100644 assets/js/7357a3c5.6005cc6b.js create mode 100644 assets/js/7ad5624c.04d03f97.js delete mode 100644 assets/js/7ad5624c.5cd13f3b.js delete mode 100644 assets/js/7ef59f7a.3dea52d8.js create mode 100644 assets/js/7ef59f7a.4a732e7a.js delete mode 100644 assets/js/851f8f65.0064d4c8.js create mode 100644 assets/js/851f8f65.905ad68d.js create mode 100644 assets/js/98334e25.163938f2.js delete mode 100644 assets/js/98334e25.740e393e.js delete mode 100644 assets/js/9c9cb35e.575920a9.js create mode 100644 assets/js/9c9cb35e.ffea3fac.js delete mode 100644 assets/js/9cd612ce.1bbc46c2.js create mode 100644 assets/js/9cd612ce.b75be620.js delete mode 100644 assets/js/ac7da374.403772ac.js create mode 100644 assets/js/ac7da374.4a1b8c9b.js create mode 100644 assets/js/b2e6bd40.102fca2b.js delete mode 100644 assets/js/b2e6bd40.57077b26.js create mode 100644 assets/js/b93339ed.bc214206.js delete mode 100644 assets/js/b93339ed.d3620018.js delete mode 100644 assets/js/c195e1f1.78cbdeaf.js create mode 100644 assets/js/c195e1f1.ea9e4a46.js create mode 100644 assets/js/c4fbe420.9177040b.js delete mode 100644 assets/js/c4fbe420.c124b6c6.js delete mode 100644 assets/js/c7e3ab5f.037506c8.js create mode 100644 assets/js/c7e3ab5f.cf9a081c.js create mode 100644 assets/js/d0524430.5aa106b8.js delete mode 100644 assets/js/d0524430.6f5015ca.js delete mode 100644 assets/js/d480dde9.2025796d.js create mode 100644 assets/js/d480dde9.a2cfa06b.js create mode 100644 assets/js/da66eb9c.717af639.js delete mode 100644 assets/js/da66eb9c.b5f1e6c1.js rename assets/js/{runtime~main.1dc5766b.js => runtime~main.3e17fae5.js} (88%) diff --git a/404.html b/404.html index 875c79c4f..e8b193e80 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/02e5f5c4.60be571e.js b/assets/js/02e5f5c4.60be571e.js new file mode 100644 index 000000000..f287d15a6 --- /dev/null +++ b/assets/js/02e5f5c4.60be571e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>S,contentTitle:()=>h,default:()=>I,frontMatter:()=>j,metadata:()=>a,toc:()=>g});const a=JSON.parse('{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.1/createfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createfolder","permalink":"/docs/API-docs/v1.1/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV1FvGzcS/itzfOlVWEuym7S4fapbpKnbIDFqFwbqCMHs7miXMZdkSa5kQRCQh/sH99TX/rT8ksOQWmklp7lzWxR9MazhzHDmmxnOt2sRsPYivxXfGFWRE7NMVORLJ22QRotcXDcEXzvCQJBU4PzyAlAps/SwMh0EA2U6n8fzsciEseSQHVxUIhfpOJ2KTDj6uSMfvjLVSuTro+sunVnIiqAgZZZg0WFLgdyDW0QmSqMD6cA+0Foly3jj5K1nR2vhy4Za5P/4Qumo4jSTtcaWONWwsiRyYYq3VAaRCes48iDJs13Sfcm6+brX9cFJXYtMzI1rMQwldI+tVaykadnHucmERUc6JPQYkMf5EptNJoIM8Udy+qZg7DZ8sM8tuI6iwFujfcrgbDp9CHHysYWzAt+VJXk/75Ra/eMxsH4cvCR+fLq2OS2a+7O3lpH7e1TguzON/umdvCT2tcXtPHzIzd7obHr22cnp9GT6xfXp5/mTf+VPPx9Pp9OfRCbuW8W2sQlzUWGIfvsS9787W/0F92yO1RJoFQWUyosHrcddt8nEkw811pVpKTRS17AkHWDpjK4zsIrQEwS3AqxRalAYyP2JnUbOGfdxkB4X2XDgpFZS05t+qt48mU7fnO5AePoQhAu9QCWr+EpemzvSf22mw+tDuv5hjWVSiufiINmhPCXpqeycDCuR367F/QlaeZLO89vZZpYJBtbwK2+NjxFjaEQuJkePvie3IOejl84pkYsmBOvzycSjrgpzPzaWtJe1Vlj4cWnaCVo5WZyOT8UmO7ZBax+lT93JY018wFrq+n/ZzfYIXXEVU6EOcNqVC638nlYi68sw1MqE5O5pCNOQZYKb44f9qnzWl/hwLw0fuofvnODqSj03MYptlV9Z0ley1rFHYhbHO/+GVGla4qUbGoLRqDd5/+9fd1ajEVSm7FrSIXbz+LV+rV91DqxZkpt3ClBXMFd0LwtF0YzaeLbjDZ6wVeS9WoHUgWrH+72StQyogAHniS3RYiGV5CFgNcPWDgZz5Mdw01BoyPHRJ44AoaIFKZ4dwC6YFgO76uOFpXF3c2YwGSAUnZeavAfSDeqSFfuSZmAcoAbSgZx10hP44DhqmWIzOjgsA7SosSb2ncEQrIqU5L4HZ4rOB/BGdTFk4PfVOKqgT0gTVT6C+Oze8hGwtDStddRw/y0I6k5W5DMoTUXgY0NwCrqCgnwAy7HIkjw77bQy5V0sIO92sIafIIkKzPwgRjYPDrXnHZhi6WuwA8w6wySBUoCj0Y+euMIvpL7z+Wj0Wp/A7a6vbqjwMtDsn/0sLZfLBzP06aHNcxm+7Qr4gazxMhi32lvXMjRdEedu6GT3I3l6Tppi/wymau+jMqV/OMYsnTSk7OSKAneIn5xfXsRX+1N4/+4/8ILQaWjMMnVr2TlSK6j7qxi5VPkE2+7RhbmJjdcw4mVqvi3t7RG8aTC8f/eLh5e0BKm3I8WpjEaXXaFkCdfUWl5JfjTKew4eehmEBgOUqKEg8A1yKy0kAoJN1krquzGc6xV0nhwsZWhiM7A82h2kwbjsyu2hQE8VGB0t+jvH+4hY3npSC/LsS5vAYVAlmVGGxpmuTrcNg9km52gulYIbWdUUYm7nVQV2K14mMQM+CIfmPBChoRWgI/Ckwxguj0ziSWetcRyFTMHPDX+qcAFIV9ZIHXwOlcN52PvP9o0e15Y0+gOiBCHu4Mi2bnYlSZO4zXgnHb/m1/1oIxy+t47m5PjCmPa+LlZu2+m2b0vgbv0jbR0ZrNEBy8hGqEWp0mr68thPZAbkWv9qfkVuIUvarsffmOhJVJ6ITChZkvY0YBznzy9fwOKz8VRkgz37fwz35MXF189eXj3jYPghTYCdjqfjaST2xocW9eCmg2/V48223jOx3/dhu93kge7DxCqUkT7FhNZb5nN7+Lk7y0TDxCi/Fes1T9WPTm02LP65I8esapaJBTqJBS/n29km60kAU6U7WnFOKeiTa76d1VWX+MQRlWQWkyzOy5Js+KjukLtdvrq6Fpkotp/kranYxuGSP9dxyUSCP+rj5opf1CxbC4W67rBm3eSTeQs/e4ek5y6Snu0/nFV/pFeDCA/ZUEqD/3JSHzRYrxOh2mx2+unoNy22wPbaXL3ZZrP5L6iA87Q=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"}}');var o=r(74848),n=r(28453),s=r(33617),l=r.n(s),i=r(17543),d=r.n(i),p=r(86013),c=r.n(p),m=r(63723),f=r.n(m),u=(r(18766),r(79329),r(9303));const j={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV1FvGzcS/itzfOlVWEuym7S4fapbpKnbIDFqFwbqCMHs7miXMZdkSa5kQRCQh/sH99TX/rT8ksOQWmklp7lzWxR9MazhzHDmmxnOt2sRsPYivxXfGFWRE7NMVORLJ22QRotcXDcEXzvCQJBU4PzyAlAps/SwMh0EA2U6n8fzsciEseSQHVxUIhfpOJ2KTDj6uSMfvjLVSuTro+sunVnIiqAgZZZg0WFLgdyDW0QmSqMD6cA+0Foly3jj5K1nR2vhy4Za5P/4Qumo4jSTtcaWONWwsiRyYYq3VAaRCes48iDJs13Sfcm6+brX9cFJXYtMzI1rMQwldI+tVaykadnHucmERUc6JPQYkMf5EptNJoIM8Udy+qZg7DZ8sM8tuI6iwFujfcrgbDp9CHHysYWzAt+VJXk/75Ra/eMxsH4cvCR+fLq2OS2a+7O3lpH7e1TguzON/umdvCT2tcXtPHzIzd7obHr22cnp9GT6xfXp5/mTf+VPPx9Pp9OfRCbuW8W2sQlzUWGIfvsS9787W/0F92yO1RJoFQWUyosHrcddt8nEkw811pVpKTRS17AkHWDpjK4zsIrQEwS3AqxRalAYyP2JnUbOGfdxkB4X2XDgpFZS05t+qt48mU7fnO5AePoQhAu9QCWr+EpemzvSf22mw+tDuv5hjWVSiufiINmhPCXpqeycDCuR367F/QlaeZLO89vZZpYJBtbwK2+NjxFjaEQuJkePvie3IOejl84pkYsmBOvzycSjrgpzPzaWtJe1Vlj4cWnaCVo5WZyOT8UmO7ZBax+lT93JY018wFrq+n/ZzfYIXXEVU6EOcNqVC638nlYi68sw1MqE5O5pCNOQZYKb44f9qnzWl/hwLw0fuofvnODqSj03MYptlV9Z0ley1rFHYhbHO/+GVGla4qUbGoLRqDd5/+9fd1ajEVSm7FrSIXbz+LV+rV91DqxZkpt3ClBXMFd0LwtF0YzaeLbjDZ6wVeS9WoHUgWrH+72StQyogAHniS3RYiGV5CFgNcPWDgZz5Mdw01BoyPHRJ44AoaIFKZ4dwC6YFgO76uOFpXF3c2YwGSAUnZeavAfSDeqSFfuSZmAcoAbSgZx10hP44DhqmWIzOjgsA7SosSb2ncEQrIqU5L4HZ4rOB/BGdTFk4PfVOKqgT0gTVT6C+Oze8hGwtDStddRw/y0I6k5W5DMoTUXgY0NwCrqCgnwAy7HIkjw77bQy5V0sIO92sIafIIkKzPwgRjYPDrXnHZhi6WuwA8w6wySBUoCj0Y+euMIvpL7z+Wj0Wp/A7a6vbqjwMtDsn/0sLZfLBzP06aHNcxm+7Qr4gazxMhi32lvXMjRdEedu6GT3I3l6Tppi/wymau+jMqV/OMYsnTSk7OSKAneIn5xfXsRX+1N4/+4/8ILQaWjMMnVr2TlSK6j7qxi5VPkE2+7RhbmJjdcw4mVqvi3t7RG8aTC8f/eLh5e0BKm3I8WpjEaXXaFkCdfUWl5JfjTKew4eehmEBgOUqKEg8A1yKy0kAoJN1krquzGc6xV0nhwsZWhiM7A82h2kwbjsyu2hQE8VGB0t+jvH+4hY3npSC/LsS5vAYVAlmVGGxpmuTrcNg9km52gulYIbWdUUYm7nVQV2K14mMQM+CIfmPBChoRWgI/Ckwxguj0ziSWetcRyFTMHPDX+qcAFIV9ZIHXwOlcN52PvP9o0e15Y0+gOiBCHu4Mi2bnYlSZO4zXgnHb/m1/1oIxy+t47m5PjCmPa+LlZu2+m2b0vgbv0jbR0ZrNEBy8hGqEWp0mr68thPZAbkWv9qfkVuIUvarsffmOhJVJ6ITChZkvY0YBznzy9fwOKz8VRkgz37fwz35MXF189eXj3jYPghTYCdjqfjaST2xocW9eCmg2/V48223jOx3/dhu93kge7DxCqUkT7FhNZb5nN7+Lk7y0TDxCi/Fes1T9WPTm02LP65I8esapaJBTqJBS/n29km60kAU6U7WnFOKeiTa76d1VWX+MQRlWQWkyzOy5Js+KjukLtdvrq6Fpkotp/kranYxuGSP9dxyUSCP+rj5opf1CxbC4W67rBm3eSTeQs/e4ek5y6Snu0/nFV/pFeDCA/ZUEqD/3JSHzRYrxOh2mx2+unoNy22wPbaXL3ZZrP5L6iA87Q=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,S={},g=[];function y(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,o.jsx)(l(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,o.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(d(),{parameters:void 0}),"\n",(0,o.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,o.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/02e5f5c4.ebd704b1.js b/assets/js/02e5f5c4.ebd704b1.js deleted file mode 100644 index a476145a3..000000000 --- a/assets/js/02e5f5c4.ebd704b1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>I,contentTitle:()=>b,default:()=>g,frontMatter:()=>P,metadata:()=>o,toc:()=>u});const o=JSON.parse('{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.1/createfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createfolder","permalink":"/docs/API-docs/v1.1/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNWM1uIzcSfpVaXrIR2pLszCRIn9YJZidOJjNC7MDAeoRBdXepmyM2yZBsyYIgIId9gz3tdR9tniQoUq0/O7PrJAj2YljFqmLVVz/8pLUIWHuR34m/G1WRE9NMVORLJ22QRotc3DQEXzvCQJBU4HJyBaiUWXpYmQ6CgTKdz+L5UGTCWHLIDq4qkYt0nE5FJhz91JEPX5lqJfL1yXUTZxayIihImSVYdNhSIPfgFpGJ0uhAOrAPtFbJMt44eu/Z0Vr4sqEW+T++UDqqOM1krbElTjWsLIlcmOI9lUFkwjqOPEjybJd0X7Nuvu51fXBS1yITM+NaDIcSusfWKlbStOzj3GTCoiMdEnoMyNN8ic0mE0GG+CE5fVcwdhs+2OcWXEdR4K3RPmVwMR4/hDj52MJZge/KkryfdUqt/vIUWD8OXhI/PV3bnBfN/cV7y8j9f1Tg2wuN/vlcToh9bXG7DI+52RtdjC8+Ozsfn42/uDn/PH/2Zf788+F4PP6HyMR9q9g2NmEuKgzRb1/i/nNnqz/hns2pWgKtooBSefGg9bjrNpl49lhjXZuWQiN1DUvSAZbO6DoDqwg9QXArwBqlBoWB3B/YaeSccR8H6WmRHQ6c1EpqetdP1btn4/G78x0Izx+CcKUXqGQVt+SNmZP+czM9vD6k6x/WWCaleC6Okj2UpyQ9lZ2TYSXyu7W4P0Mrz9J5fjfdTDPBwBre8tb4GDGGRuRidLL0PbkFOR+9nHTNEuua3DddEYO+7IKB7005T5l1TolcNCFYn49GC+lC8jT0yazpimFp2tHEIW+w17iYoxsZS3p0PhwPx2KTrU+ceNRVYe6HrORlrRUWPvpAK0eL8+H5IzZo7ZP0qTt7qokPWEtd/ze76b4k19w2qTOOCrPrD7TyO1qJrK/7oVYmJKPfEKapzgR34w/7t/lF31PHD+HhZn24WAW3k9QzE6PYttUbS/pa1jrWN2ZxSjJuSZWmJX7lQ0MwGPQmH/75n53VYACVKbuWdIjjM3yr3+o3nQNrluRmnQLUFcwU3ctCUTSjNp7tiIonbBV5r1YgdaDaMaGoZC0DKmDAeUWUaLGQSvLUsZphawcHg+uHcNtQaMjx0SeOAKGiBSkeVsAumBYDu+rjhaVx8xlTpgwQis5LTd4D6QZ1yYp9STMwDlAD6UDOOukJfHActUyxGR0clgFa1FgT+87gEKyKlORBA2eKzgfwRnUxZOCFbhxV0CekiSofQXxxb/kIWFqa1jpquP8WBHUnK/IZlKYi8LEhOAVdQUE+gOVYZEmenXZamXIeC8ijCNbwzpOowMyOYmTz4FB7fnRTLH0NdoBZZ5iVUApwMPjRE1f4ldRznw8Gb/UZ3O366pYKLwNN/9rP0nK5fDBDnx7bvJSBV84PZI2XwbjV3rqWoV8rh052H5Knl6Qp9s/BVO19VKb0D8eYpaOGlB1dU+AO8aPLyVV8Jj6FDz//C14ROg2NWaZuLTtHagV1fxUjlyqfYNtteZiZ2HgNI16m5tvy7B7B2wbDh5//7eE1LUHq7UhxKoPBpCuULOGGWstvoB8M8p70h14GocEAJWooCHyD3EoLiYBgk7WSej6ES72CzpODpQxNbAaWR7ujNBiXXbk9FOipAqOjRX/ncB8Ry1tPakGefWkTOAyqJFPY0DjT1em2w2C2yTmaSaXgVlY1hZjbZVWB3YqXScyAH4RDMx6I0NAK0BF40mEIkxOTeNJZaxxHIVPwM8PfjbgApCtrpA4+h8rhLOz9Z/tGj++kNPoRUYIQd3BkWze7kqRJ3Ga8kw7f8nY/eRGO962jGTm+MKa9r4uV23a669sSuFt/T1tHymx0wDLSH2pRqvQ0/e3UT6Qi5Fr/ZnZNbiFL2j6PvzLRo6g8EplQsiTt6YDiXL6cvILFZ8PxEYf4H4Z79Orq6xevr19wMLxIE2A9l4gsp0V9cNPRl+PTl229p36/7Zv09iUPdB9GVqGMfC0mtN5Srbvj79fTTDTMxPI7sV7zVP3o1GbD4p86ckzjpplYoJNY8ON8N91kPQlgbjanFeeUgj674dtZXXWJT5xwV2YxyeKyLMmGj+oeksXJm+sbkYli+xtAayq2cbjk3wdwyUSCf0WIL1f8Cs+ytVCo6w5r1k0+mbfw2jsmPfNIerb/cFb9kV4dRHjMhlIa/JeTetRgvU6EarPZ6aejX7XYAttrc/Wmm83mF5v5G24=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"}}');var a=r(74848),l=r(28453),n=r(33617),i=r.n(n),d=r(17543),p=r.n(d),s=r(86013),c=r.n(s),m=r(63723),j=r.n(m),f=(r(18766),r(79329),r(9303));const P={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNWM1uIzcSfpVaXrIR2pLszCRIn9YJZidOJjNC7MDAeoRBdXepmyM2yZBsyYIgIId9gz3tdR9tniQoUq0/O7PrJAj2YljFqmLVVz/8pLUIWHuR34m/G1WRE9NMVORLJ22QRotc3DQEXzvCQJBU4HJyBaiUWXpYmQ6CgTKdz+L5UGTCWHLIDq4qkYt0nE5FJhz91JEPX5lqJfL1yXUTZxayIihImSVYdNhSIPfgFpGJ0uhAOrAPtFbJMt44eu/Z0Vr4sqEW+T++UDqqOM1krbElTjWsLIlcmOI9lUFkwjqOPEjybJd0X7Nuvu51fXBS1yITM+NaDIcSusfWKlbStOzj3GTCoiMdEnoMyNN8ic0mE0GG+CE5fVcwdhs+2OcWXEdR4K3RPmVwMR4/hDj52MJZge/KkryfdUqt/vIUWD8OXhI/PV3bnBfN/cV7y8j9f1Tg2wuN/vlcToh9bXG7DI+52RtdjC8+Ozsfn42/uDn/PH/2Zf788+F4PP6HyMR9q9g2NmEuKgzRb1/i/nNnqz/hns2pWgKtooBSefGg9bjrNpl49lhjXZuWQiN1DUvSAZbO6DoDqwg9QXArwBqlBoWB3B/YaeSccR8H6WmRHQ6c1EpqetdP1btn4/G78x0Izx+CcKUXqGQVt+SNmZP+czM9vD6k6x/WWCaleC6Okj2UpyQ9lZ2TYSXyu7W4P0Mrz9J5fjfdTDPBwBre8tb4GDGGRuRidLL0PbkFOR+9nHTNEuua3DddEYO+7IKB7005T5l1TolcNCFYn49GC+lC8jT0yazpimFp2tHEIW+w17iYoxsZS3p0PhwPx2KTrU+ceNRVYe6HrORlrRUWPvpAK0eL8+H5IzZo7ZP0qTt7qokPWEtd/ze76b4k19w2qTOOCrPrD7TyO1qJrK/7oVYmJKPfEKapzgR34w/7t/lF31PHD+HhZn24WAW3k9QzE6PYttUbS/pa1jrWN2ZxSjJuSZWmJX7lQ0MwGPQmH/75n53VYACVKbuWdIjjM3yr3+o3nQNrluRmnQLUFcwU3ctCUTSjNp7tiIonbBV5r1YgdaDaMaGoZC0DKmDAeUWUaLGQSvLUsZphawcHg+uHcNtQaMjx0SeOAKGiBSkeVsAumBYDu+rjhaVx8xlTpgwQis5LTd4D6QZ1yYp9STMwDlAD6UDOOukJfHActUyxGR0clgFa1FgT+87gEKyKlORBA2eKzgfwRnUxZOCFbhxV0CekiSofQXxxb/kIWFqa1jpquP8WBHUnK/IZlKYi8LEhOAVdQUE+gOVYZEmenXZamXIeC8ijCNbwzpOowMyOYmTz4FB7fnRTLH0NdoBZZ5iVUApwMPjRE1f4ldRznw8Gb/UZ3O366pYKLwNN/9rP0nK5fDBDnx7bvJSBV84PZI2XwbjV3rqWoV8rh052H5Knl6Qp9s/BVO19VKb0D8eYpaOGlB1dU+AO8aPLyVV8Jj6FDz//C14ROg2NWaZuLTtHagV1fxUjlyqfYNtteZiZ2HgNI16m5tvy7B7B2wbDh5//7eE1LUHq7UhxKoPBpCuULOGGWstvoB8M8p70h14GocEAJWooCHyD3EoLiYBgk7WSej6ES72CzpODpQxNbAaWR7ujNBiXXbk9FOipAqOjRX/ncB8Ry1tPakGefWkTOAyqJFPY0DjT1em2w2C2yTmaSaXgVlY1hZjbZVWB3YqXScyAH4RDMx6I0NAK0BF40mEIkxOTeNJZaxxHIVPwM8PfjbgApCtrpA4+h8rhLOz9Z/tGj++kNPoRUYIQd3BkWze7kqRJ3Ga8kw7f8nY/eRGO962jGTm+MKa9r4uV23a669sSuFt/T1tHymx0wDLSH2pRqvQ0/e3UT6Qi5Fr/ZnZNbiFL2j6PvzLRo6g8EplQsiTt6YDiXL6cvILFZ8PxEYf4H4Z79Orq6xevr19wMLxIE2A9l4gsp0V9cNPRl+PTl229p36/7Zv09iUPdB9GVqGMfC0mtN5Srbvj79fTTDTMxPI7sV7zVP3o1GbD4p86ckzjpplYoJNY8ON8N91kPQlgbjanFeeUgj674dtZXXWJT5xwV2YxyeKyLMmGj+oeksXJm+sbkYli+xtAayq2cbjk3wdwyUSCf0WIL1f8Cs+ytVCo6w5r1k0+mbfw2jsmPfNIerb/cFb9kV4dRHjMhlIa/JeTetRgvU6EarPZ6aejX7XYAttrc/Wmm83mF5v5G24=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,I={},u=[];function y(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,a.jsx)(i(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(p(),{parameters:void 0}),"\n",(0,a.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,a.jsx)(j(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/03e06346.7bc9fb1d.js b/assets/js/03e06346.7bc9fb1d.js deleted file mode 100644 index b83ed8636..000000000 --- a/assets/js/03e06346.7bc9fb1d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kt2AhbPdUXRR3mxMYubWtt7Wgkho517JIcGl2V3Q2xCigDKDbbjI6Yh/mDfdrX+TR/yUYmgDr6ICmR8kgb5QeZXbgSicxEHsi8iiyfmejgOHoLeZFxCyY6jaMUTKJFYYWS0UH0dg7sqJxkImGhFzs8es54lqmFYaUBbZhVLNGATTbMxOycW2ZAXwDjhk2yEgotpDVsqjSbgQTNrZAzlqqkzAEbFsLOWaEhhamQkDJjdZnYUoMZsJ/mIBmvpmfCMFMmCRgzLbNs6ZdPY2bnDj4NttTSMM5KKX4pgfV6YfCZSHs9xmXKOOv1CtrcWamzXm/AcLvtb7iU+50tGaclxSQDGp/zJZsAM3OuIXXwc7kkpMQMJJ9kuEM7hxxR5Dfthhoxk429T7iBlClJ8AdAB+xHtYALnKz5mQlrIJuyhEupLAKQq1RMBaTMzrUqZ3Nm58Kwd69f/JEJi/2YkhmBWuIyeAJhaYc5oWQFlZCzwYk8kW9FccDeFZniKVuqUrOj7/+9HmYVw2/Hvd73MCln7N3zXu/067m1hTkYDnlRDFQBEufL+MQMEpUPU+xYpNMHMVvMQQPOSsABNwKRmyIO0xlYQxuWLFHFkiVK6VRIJKqYFXwGTJb5BLSJ3RkoDUwgcWjg6bJvVb80wP7jzauXuNGc2wE7ykoTV8ulQkNikWhwesRs2NVX7iAe7yPtCTmLWc7P8QiFZb+UIjnHbRuQKf7fUxrhqtd7UxaF0hZS9pPbwkGvhy3fQqYWjGug/onKcyVZwTXPwRLrIJtgs4ZfSlGTUZYFXBycyD7r9STP4aDXY+8cOYsUpMVD13ScdOBuwMD1t8uC+j+XqUg8RwLDr0xN210Rqdj1TQEJTum6NlCNhLmYi2ROOFxwd/5FxhO3LQ2mgMSKC2hPfBmzJU78PUgVIJgrLX5V0vKMju8CtBUJz5rHjABiV2O5JhlRKCFt+OpXYP/ljxNPmw7R0yGCliJycyGpxQC74FkJxkO1iNkcoXoNhQZD7OfnJf5N2RzEbL5zPZ6+L41tTcxK4xm9gsKvFU6V0AuEtinPDDAxbeEy5+fQWI0pkr88G7BvlyyFKS8zGzOBFGp1CQP2UlnGiyITCUdphDSAzMZRXvbplD35DNrkc6TVhUgBBWMqplPQyMzYSFP4MQE6pMuCBuD2iNPsnKTJ2kEnKlN6k4TocxuPLFHSgrQDdnjBRUbAu80aJmSSlSmwScaT85jujJhplOp4KkvAKyd2/EFd8GJxOCf8MAMZUqGSCL9Ufnm8KjxUKQp4lOeB/7AxoJoWEaaJVc/lU4UrIwoCSzLIuchiQlzM3qsJs8JmECODF1wuY5ZyCzGzcGkn6jJmyRySc/pL81QoNimtVdJtLNWqSNVCelxOlbRG/LqFI0PLh2N0L2b7MXscs6cxG49iNt6L2Xg/ZuPHMRs/jdneKGZ7ezHb24/Z3mMH1t5Tj2teIbgJwHjPYdl+OdhFOf1CGOJsFLCmktmLlsweD1ivV3ETfvv5559P5NWJZOwkQuY6iQ7YSVR1OYli14YyE9vG/vcl/ni498T/XOLPx3tP/c8FdR3v+59z/Lk3PpErv+CJ3CNILM+La6DA5nuFwP/yRITfaFH8FuQZfkRBFIcGPKsWPNiwau7lIe5FSGEFz8zu7YQen9GOapA2NrWPmyJy3b0jav6MttOEB1tITLomEquNpsDwBMXexu4fDfzNsnvzbtnPZu8NcO629ce4dRRNb1E07d5/Jb0+IySsw3Q3TDwZkAJAknk3HnyHzwgLbYjuhoOniAO8lHYjAFs/o903wMEGf8O7ttF+f/yovzfa229hAG0p1yHP+2naXy6X94E91Hn88qjyBA3VaXZo7k61yreYH2Qd1L28TkR/B5X9z6ioT4IOCynaiWRYBI2lshCbWrZVKV9+ZdxUYWilnGH/WjVbNsCkJoSDrOVkrkTigcc+QSWboEE4QBz0CZPDNB02MIkf07Sf5/21j/izT4hvfMzzQZoO1npunI77mLM0jdnm563f05Tleb7js/ve+jzM881dDPLcw0bK1zcDcsKQzrabT3yH34tVao5oL3wtG6GnAT0q2EDm3HY+Wrts5kL6Bk9UbK2DhlmZcQ2XaJcaoaTrff88Flis1uzJjvWeBAiKNfv6ldfeH3jyxy20J8AvN4/b2BlOcsiS0liVMw0zuGQFtxa0pMkueCZS55bq0we45HmBJsDwLycn6R/+eUgOCLTxrfNtpWIm0G80/MvxYf+/T7f0KIsCdMINsAxwJRMzsMmAHc8hK2rX1WKxGCwemmSuVOb8Vu+Nhqn790xN3p8RuMWAm+LBtp060mgY/Eg66/a+AdvCGDcsjNxi8hONEQ+NR3TbenvnmuvW9/iMbpw1kLDReU+w+fgkyjkpJEjKUP+t7Bz0SXRajXFGPqQ3jD29BbPORQoZn0C22XRrRqs+Z3ypSs/fwanV3qqn6AbesCEXsvJb0HZGcaORX641urbVFv52CGlyZ7hyAnuGE2CZMMFz00Znc7R3bZGDUgKQzxOd3X4Am1RUemcuqAC7HRs4SeTP7oYlsB+jjpVbMax2wwqtg2kiBufIhRR5mVf+0Wk1a0BZ7nWPJr5wJAYHwgrN091YgV/esAI6I3cvcCLH5McI/o9rNFPf4zOSFWsgXc/GHyNFWvf0PV2wNzNg2FaTAbdcy9jVXcgV85nd3Ddgr/B6Q5+sG4RetiSBwqJH7q6sWYF86xuKfFZNP9xuymv2+oyobwtYn5gCfb/7vn0+ikibu/+CCLUF9q2J1Tklcz67xnKn5s+IPD08G06IMTkj3X1xjUOO2q/fznjU2s6j9nYejz7Cumote3fjalR9rK2qZxJjDhsLoV1eZvxeRb2fE0nzO5UXpW3yApn8xO/h8g5hNRcm/EPM+jHrxWwYs69j9mDAXgMF4pIqaOfvcqFdaE7gU4ESYyZJqTGQr3mC0XAYzAbs6uqXkksr7HK1Yj12dYVvDFarATLHuVQLF7c7vhBGWIZx99rWSVVitsTpVWKGaBQNX8Ki/72PjQ89aA/Y12qNU6+1LD0KPtSU3DXsE9tXGCI60jAVWdYI5LPwKRwPBkYhg9wHj30IHxVGCicJaRWiIDyW6PUmMFUYSsKXBBiQbL4YcRqbE47N1wjuaYbSbM6Ns2TJdMbt4VMJfFbig1ovlQUX0TaFkgacMC+2AF1HpHu9tYhY6FZHxYQMG0dxMr4/983eN6OmfBk/ftQSl4/aAma0S8Bc471BMeJwEVzeUDc1OJ8EUPi+yfbrfB8mRWQ7cROIzFGfKrOUZeKcgpupMEXGl0gW4bL0UK5Hzb+bK2XqHj5w7fnMHLQD4kpjTPzBoIoP3tXvPH7ysCXtn96DM23Nvdw+jNH+cPxoeK1/ec0r+uHymrHbnBw5bm91ctSzPrrOD/yxfuD7IfyH9+kGGz/Za2lvD0d3Z4B78nY1GecGP9d9eLPuza3UZLdbOpR+N8fO3alv/1OYuGti+Mn4HsTwDkv2rpS4YbDeG+2x+7JWtxHgLczVa23UOxNoE9hPTqSP7se0HY9auto3LVXtm70mUT56dCuibC66RlknkfjPb1+9Xoz+9MNMHR4eHr58827+7N3s8PAwx9+DwWCrV2PbadMyqMP6J73+XqY7fscqg8EAUZhyyw9o+LCQsz+68fHuMQP/HOQTuVof3Ud0c4tH9e5SoOr6+1w029ynn47P78qBURypgrIclHyeRgeRyyIIr/ijmFwgYOy3Kl1GB1eRf8eJf/pXkjh0+N5gIsZVZJI55Bz/CiYcpm5MRYZToQEP2kRxRA97MI8DqS46iNTkPSQ2ijHoXKBnEAzOQeMOrkIv9949ir0aHh1EjuqjOPKh1+oTA5kofExRpNNoFRa8bqrqSz2VoT+qlAacB5+If+Q0NHS1lrryUTM1Z1jVaK0n41rzZbSeJRPehofAvhtXPX7NluFyEBZdEdWDZeoWxZGwkDdX2XFoWn04phNQuBN69PehY+lYeP7Ba+K4Yq7kRw3077I+Zuh7NTn7KHLEwd7/seWsb3k6rnVz4TapHOJrZ0iDNtyvn+3HjJ7ODm6i1NCfsMxnzTWd12xjzbe70jkar8jNnExgXhTA9YCyKj46wYcSwniWlJSuVInj1s4qUKudjVdxdHnzZi5ZovohV4R9ncHUurcdLFFagn7QfDD22Wxub39/FUfLm7e3/CK39wQPb3Hz7n6iJJs6AekfAevDp6s4mt8M649VGtA/ENj9x6v6jo1cmmOVyDhR6fIsyK3VTR3DZYb9MIntuXylU9ANREyUyoDLDUw8nzqHumJfoaXzVexeVFH2htAmXGRsge5mDQlgJhg9tAyyinldx6V2MP+iHp3xz/ADqWemnBjsJcN8xk04AWa1mM0AXea+Bw32+SnAkzlm5fl3XnwavHuFhguhShPAQz863i4ZWMqVxPhKyHhsWWMN7JC3vrn3QfN08AterpjqCa/eHt0Cl2Qq9l3CntMP3C7dHOzV2yPMiRNTr/4N2DtTYSKglre6MFTH2IXgIW+mku1L9woFnL9TuaTTZohh4LPR+mwToFSYrRDFLvcXI1lV9u/GxHWSJR6RKi2GLIRPBTIWCtPCI0FRIfKtKm9DlTdgkrNZSY9+LbJsSJCjd391TpuQLsuY7Iy01CGNz5MF9sSM3xpPASvYqTE/pvsaN5yzKTcWk3ZLKRDzukSropoSLgvQAqN9W1GgwaEOs49v1ibaCWLvXr/wqbVhD4EpJ8iBbmJIWVkQ1RAnVImL4eTWt76hKCF3gD7bpRhuqh4Uw/QukAK0URLNJKVnXIpfHQmTRoJW1gTmPHNdvahAVznCgxzeBibI2t/+9vcGXDs13U3A3Ao8TfFV6g0QkinpCB41fQ0FSkDVhgjnA/1v65cAQkdMc+YytR0jmdvT+BG9YzWVXPQhwCoEacpkjoZFJW9NHGSs8WqlIduUDFiKIRa4X7gUxjZS78ID+U358BoQj0kDBlJDkKuR5uWyyeB1aFStTUcJgqKdtlldgxu8wEurzjTkQt7unmp646yqBEFpVc6tSFiYygzaybgu5BP4OmdfB9CQGi+E0g92sCpOd6ZkAmdCnmGm/i0UvJfVg76UL5G47QJANmELSHLXWZ0wuaAiCE2cNG4nSgtuEeOjGOkuBz2DswTNFCI8uAUeez2crddjfQeLF6um1N6l4nPZSX6gKKlnR4h81mmVblHfuc0SAo3qBkUG+C4bzXg3P6KUEeS+pENzhbrugQHMNcWJq/BazkVdV8FHuOm8aDfPnRWeOI8OzoK517hOfN2eggit8kg45k+H1R1HuM2hW4XxTBFL2Xkth9M2UM8pdXZOVxAdIbqA3Tohn10tJOjf/vq/hgL57n2IGeAWdrZSiJ9nRrm83OasgaIDzTsH1QZJ+zcD24zd6z0eQYA43YOqOuQTfP5FDx9Io6KbRtVOj7b1/MnM7+tsaR+P7yzpL8jUHI9G/58t6YejL8eS3h99QZb0UwTWO+1vlia7tNutsiMEIa4f8F6B829mSl/fE337q7gKmWxDcM0Oeyv3X238ByF+g0PAeQzqYII3ZsNmCA17oxH+b00IhkJEvupSqxTTP0Xx7SMZN0j0umDT9fg6vHh6lBcyT+YkyavqTdePahKb/0p05sYj6f1rgECk/9JeIwdj2hfGlgV83Sx7PbqapyRkJiSchSM4WwsZuWPe33Ymb1QOTp9YoBG30ArLF3nFyuol4zPUjHAafY9HBFrfRMwfBtl12Ngfjc7GFRIebSLhuaQ0KyoA9ladg/x9d9pc3rrlEdTLPKslSiRcJ2qPWpttfnebNJCUWthldHB8FV32eSH6rv3g+HR1ilRo54pCi8oQxNzOo4NouBFppDpsGMc63qCbBUfP2o/lhMA+LK1if1bJudsb8VDFKBdCWzfTwLhh83JCLHOkOVLzS35xzvUQJfdwPBgNRtEqvlqbxHCZ4hudDfHOCzG8GA/GW8ZsvQ6u6Q9l/0OHGMtnQs5uGndaH8obJBxHG62jqfXXQvwJUIH1J9/sFUcCsT8HjpYtnjXS4+s6IPwsUFUI1W6LvtbUsx5PDeHUVoR0/VreEvNshDyPQ7yRQohVBDGqNxRVUb4oasTt8EcjEoc/K+X+uOafKowVdO8xKa17+/uk3T0Zkxr08ClpGPuPV6cO+Q2/NaUNNJ2v7uVRy4voP7W9alG05sVquZLWPUk7vTo7nDp+yTXnRQXINp8B2upbTXU/qmGWbUFl0ETaiMSHO4jIhyNC5P6IEPl01FKC/PbrGWpVhvSVSl0hnaSpkqDecYqEK+RUEdX7435VgHyD/mCUJ8Q1G6orZInKqwJQvV4Y8tvf/l6N6vUqi9k5wtFsflVqVqgF6GnpKkpNM7ikcow4DHJqM2TjUxIAzzMwBsPv0sKMjHVKFEcntHdzJrzgE5EJlPPu4T49221cFa78JOVzLFX5lXbZDReQ4fVQeZcapSzZQunzKdbHjBlnE8z6QP8iyDmXiXNlOhFCLjk0ldFNXGhhsOadRqiFg01Jq3liWc4ln5FPLWZNZKWQCRTsTKsJevqNykrny7ZcZEq7R5a0IXoFQ0h8dllgE+nfyLQa5kjYF96hbWIXUHDSwVdZnGDspkBYBPoZrGKlzBQWRMQYUJllrFDWxWVQzW/CiMOt5tKgbu5gCWdQIcz7msF4j807A3jCL4Q8d0W5+uy4oqufYGKEhXbK/jpzPmiP+UFYvOJeQ6GMsEov69EzYcM11pyk+uFm+iEU72xI8dsn0rwBixRihodHz0kxecB+++v/sBfAtWRztXDUmpQasmW7Tqg7eYe2Sq+gaAYvsUamJSKVsxBgCxj8ac4tuYdewgL9cI6l3MumtXquptc7YN9trd8aUoxdugqGmLgvhsoyIc8H7NCXO629Xfidxn1EudO3jdUhN5BdgGm4+yAVtlXkFFrA+M21s3dwb4dpupEMgy7fGhznpKKIGXfeKqwauiV/ppUc065eBzKlOpXmgKWaT209f7xZbXXLp5ANFNAR+2mqI3GcWLSNCuMceWsaSFvekoMQFzTtMrSF8OR0HMiStWthfDhZOwNXWp6Qwh1uUF6IrUERrNJpXk3fgL4QSbDJdnD0kDoPozjKRALe2vb31+EPRy/YxcPBqKWz3oK5hy+ef/fs5ZtnCAwKUoewoLuSXp1z2VhpjXfW77bGK76udHJXOrkrndyVTu5KJ3elk7vSyV3p5K50clc6uSud3JVO7kond6WTu9LJXenkrnRyVzKjK53clU7uSid3pZO70sld6eSudHJXOrkrndyVTu5KJ3elk7vSyV3p5K50clc6uSud3JVO7kond6WTu9LJnR+4K538YVZCVzq5K53clU7uSid3pZO70sld6eQvrXRyI7VxWGRcUK60T+l3ac7H6wWVT+NojnnQB8fR1RVS3judrVb4+ZeSsiyPT+PogmuBTygphToOCbiYTHkOmIj5nXsR2n+L68fuoCmBZS1zHDOI3YhD2vu1fZup2kev3ryN4mjiiz7nKqWKD3yByZd84ZJTGxma9O0qyriclZTdGbk5V64+1rydcHxOCcf+j0aKKCbm1hC2M5HdNvBf3NTWAVdXLpl5tar6u6adIzxiQ288v9PVavV/Vyhu4A==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),l=t(28453),r=t(33617),o=t.n(r),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kt2AhbPdUXRR3mxMYubWtt7Wgkho517JIcGl2V3Q2xCigDKDbbjI6Yh/mDfdrX+TR/yUYmgDr6ICmR8kgb5QeZXbgSicxEHsi8iiyfmejgOHoLeZFxCyY6jaMUTKJFYYWS0UH0dg7sqJxkImGhFzs8es54lqmFYaUBbZhVLNGATTbMxOycW2ZAXwDjhk2yEgotpDVsqjSbgQTNrZAzlqqkzAEbFsLOWaEhhamQkDJjdZnYUoMZsJ/mIBmvpmfCMFMmCRgzLbNs6ZdPY2bnDj4NttTSMM5KKX4pgfV6YfCZSHs9xmXKOOv1CtrcWamzXm/AcLvtb7iU+50tGaclxSQDGp/zJZsAM3OuIXXwc7kkpMQMJJ9kuEM7hxxR5Dfthhoxk429T7iBlClJ8AdAB+xHtYALnKz5mQlrIJuyhEupLAKQq1RMBaTMzrUqZ3Nm58Kwd69f/JEJi/2YkhmBWuIyeAJhaYc5oWQFlZCzwYk8kW9FccDeFZniKVuqUrOj7/+9HmYVw2/Hvd73MCln7N3zXu/067m1hTkYDnlRDFQBEufL+MQMEpUPU+xYpNMHMVvMQQPOSsABNwKRmyIO0xlYQxuWLFHFkiVK6VRIJKqYFXwGTJb5BLSJ3RkoDUwgcWjg6bJvVb80wP7jzauXuNGc2wE7ykoTV8ulQkNikWhwesRs2NVX7iAe7yPtCTmLWc7P8QiFZb+UIjnHbRuQKf7fUxrhqtd7UxaF0hZS9pPbwkGvhy3fQqYWjGug/onKcyVZwTXPwRLrIJtgs4ZfSlGTUZYFXBycyD7r9STP4aDXY+8cOYsUpMVD13ScdOBuwMD1t8uC+j+XqUg8RwLDr0xN210Rqdj1TQEJTum6NlCNhLmYi2ROOFxwd/5FxhO3LQ2mgMSKC2hPfBmzJU78PUgVIJgrLX5V0vKMju8CtBUJz5rHjABiV2O5JhlRKCFt+OpXYP/ljxNPmw7R0yGCliJycyGpxQC74FkJxkO1iNkcoXoNhQZD7OfnJf5N2RzEbL5zPZ6+L41tTcxK4xm9gsKvFU6V0AuEtinPDDAxbeEy5+fQWI0pkr88G7BvlyyFKS8zGzOBFGp1CQP2UlnGiyITCUdphDSAzMZRXvbplD35DNrkc6TVhUgBBWMqplPQyMzYSFP4MQE6pMuCBuD2iNPsnKTJ2kEnKlN6k4TocxuPLFHSgrQDdnjBRUbAu80aJmSSlSmwScaT85jujJhplOp4KkvAKyd2/EFd8GJxOCf8MAMZUqGSCL9Ufnm8KjxUKQp4lOeB/7AxoJoWEaaJVc/lU4UrIwoCSzLIuchiQlzM3qsJs8JmECODF1wuY5ZyCzGzcGkn6jJmyRySc/pL81QoNimtVdJtLNWqSNVCelxOlbRG/LqFI0PLh2N0L2b7MXscs6cxG49iNt6L2Xg/ZuPHMRs/jdneKGZ7ezHb24/Z3mMH1t5Tj2teIbgJwHjPYdl+OdhFOf1CGOJsFLCmktmLlsweD1ivV3ETfvv5559P5NWJZOwkQuY6iQ7YSVR1OYli14YyE9vG/vcl/ni498T/XOLPx3tP/c8FdR3v+59z/Lk3PpErv+CJ3CNILM+La6DA5nuFwP/yRITfaFH8FuQZfkRBFIcGPKsWPNiwau7lIe5FSGEFz8zu7YQen9GOapA2NrWPmyJy3b0jav6MttOEB1tITLomEquNpsDwBMXexu4fDfzNsnvzbtnPZu8NcO629ce4dRRNb1E07d5/Jb0+IySsw3Q3TDwZkAJAknk3HnyHzwgLbYjuhoOniAO8lHYjAFs/o903wMEGf8O7ttF+f/yovzfa229hAG0p1yHP+2naXy6X94E91Hn88qjyBA3VaXZo7k61yreYH2Qd1L28TkR/B5X9z6ioT4IOCynaiWRYBI2lshCbWrZVKV9+ZdxUYWilnGH/WjVbNsCkJoSDrOVkrkTigcc+QSWboEE4QBz0CZPDNB02MIkf07Sf5/21j/izT4hvfMzzQZoO1npunI77mLM0jdnm563f05Tleb7js/ve+jzM881dDPLcw0bK1zcDcsKQzrabT3yH34tVao5oL3wtG6GnAT0q2EDm3HY+Wrts5kL6Bk9UbK2DhlmZcQ2XaJcaoaTrff88Flis1uzJjvWeBAiKNfv6ldfeH3jyxy20J8AvN4/b2BlOcsiS0liVMw0zuGQFtxa0pMkueCZS55bq0we45HmBJsDwLycn6R/+eUgOCLTxrfNtpWIm0G80/MvxYf+/T7f0KIsCdMINsAxwJRMzsMmAHc8hK2rX1WKxGCwemmSuVOb8Vu+Nhqn790xN3p8RuMWAm+LBtp060mgY/Eg66/a+AdvCGDcsjNxi8hONEQ+NR3TbenvnmuvW9/iMbpw1kLDReU+w+fgkyjkpJEjKUP+t7Bz0SXRajXFGPqQ3jD29BbPORQoZn0C22XRrRqs+Z3ypSs/fwanV3qqn6AbesCEXsvJb0HZGcaORX641urbVFv52CGlyZ7hyAnuGE2CZMMFz00Znc7R3bZGDUgKQzxOd3X4Am1RUemcuqAC7HRs4SeTP7oYlsB+jjpVbMax2wwqtg2kiBufIhRR5mVf+0Wk1a0BZ7nWPJr5wJAYHwgrN091YgV/esAI6I3cvcCLH5McI/o9rNFPf4zOSFWsgXc/GHyNFWvf0PV2wNzNg2FaTAbdcy9jVXcgV85nd3Ddgr/B6Q5+sG4RetiSBwqJH7q6sWYF86xuKfFZNP9xuymv2+oyobwtYn5gCfb/7vn0+ikibu/+CCLUF9q2J1Tklcz67xnKn5s+IPD08G06IMTkj3X1xjUOO2q/fznjU2s6j9nYejz7Cumote3fjalR9rK2qZxJjDhsLoV1eZvxeRb2fE0nzO5UXpW3yApn8xO/h8g5hNRcm/EPM+jHrxWwYs69j9mDAXgMF4pIqaOfvcqFdaE7gU4ESYyZJqTGQr3mC0XAYzAbs6uqXkksr7HK1Yj12dYVvDFarATLHuVQLF7c7vhBGWIZx99rWSVVitsTpVWKGaBQNX8Ki/72PjQ89aA/Y12qNU6+1LD0KPtSU3DXsE9tXGCI60jAVWdYI5LPwKRwPBkYhg9wHj30IHxVGCicJaRWiIDyW6PUmMFUYSsKXBBiQbL4YcRqbE47N1wjuaYbSbM6Ns2TJdMbt4VMJfFbig1ovlQUX0TaFkgacMC+2AF1HpHu9tYhY6FZHxYQMG0dxMr4/983eN6OmfBk/ftQSl4/aAma0S8Bc471BMeJwEVzeUDc1OJ8EUPi+yfbrfB8mRWQ7cROIzFGfKrOUZeKcgpupMEXGl0gW4bL0UK5Hzb+bK2XqHj5w7fnMHLQD4kpjTPzBoIoP3tXvPH7ysCXtn96DM23Nvdw+jNH+cPxoeK1/ec0r+uHymrHbnBw5bm91ctSzPrrOD/yxfuD7IfyH9+kGGz/Za2lvD0d3Z4B78nY1GecGP9d9eLPuza3UZLdbOpR+N8fO3alv/1OYuGti+Mn4HsTwDkv2rpS4YbDeG+2x+7JWtxHgLczVa23UOxNoE9hPTqSP7se0HY9auto3LVXtm70mUT56dCuibC66RlknkfjPb1+9Xoz+9MNMHR4eHr58827+7N3s8PAwx9+DwWCrV2PbadMyqMP6J73+XqY7fscqg8EAUZhyyw9o+LCQsz+68fHuMQP/HOQTuVof3Ud0c4tH9e5SoOr6+1w029ynn47P78qBURypgrIclHyeRgeRyyIIr/ijmFwgYOy3Kl1GB1eRf8eJf/pXkjh0+N5gIsZVZJI55Bz/CiYcpm5MRYZToQEP2kRxRA97MI8DqS46iNTkPSQ2ijHoXKBnEAzOQeMOrkIv9949ir0aHh1EjuqjOPKh1+oTA5kofExRpNNoFRa8bqrqSz2VoT+qlAacB5+If+Q0NHS1lrryUTM1Z1jVaK0n41rzZbSeJRPehofAvhtXPX7NluFyEBZdEdWDZeoWxZGwkDdX2XFoWn04phNQuBN69PehY+lYeP7Ba+K4Yq7kRw3077I+Zuh7NTn7KHLEwd7/seWsb3k6rnVz4TapHOJrZ0iDNtyvn+3HjJ7ODm6i1NCfsMxnzTWd12xjzbe70jkar8jNnExgXhTA9YCyKj46wYcSwniWlJSuVInj1s4qUKudjVdxdHnzZi5ZovohV4R9ncHUurcdLFFagn7QfDD22Wxub39/FUfLm7e3/CK39wQPb3Hz7n6iJJs6AekfAevDp6s4mt8M649VGtA/ENj9x6v6jo1cmmOVyDhR6fIsyK3VTR3DZYb9MIntuXylU9ANREyUyoDLDUw8nzqHumJfoaXzVexeVFH2htAmXGRsge5mDQlgJhg9tAyyinldx6V2MP+iHp3xz/ADqWemnBjsJcN8xk04AWa1mM0AXea+Bw32+SnAkzlm5fl3XnwavHuFhguhShPAQz863i4ZWMqVxPhKyHhsWWMN7JC3vrn3QfN08AterpjqCa/eHt0Cl2Qq9l3CntMP3C7dHOzV2yPMiRNTr/4N2DtTYSKglre6MFTH2IXgIW+mku1L9woFnL9TuaTTZohh4LPR+mwToFSYrRDFLvcXI1lV9u/GxHWSJR6RKi2GLIRPBTIWCtPCI0FRIfKtKm9DlTdgkrNZSY9+LbJsSJCjd391TpuQLsuY7Iy01CGNz5MF9sSM3xpPASvYqTE/pvsaN5yzKTcWk3ZLKRDzukSropoSLgvQAqN9W1GgwaEOs49v1ibaCWLvXr/wqbVhD4EpJ8iBbmJIWVkQ1RAnVImL4eTWt76hKCF3gD7bpRhuqh4Uw/QukAK0URLNJKVnXIpfHQmTRoJW1gTmPHNdvahAVznCgxzeBibI2t/+9vcGXDs13U3A3Ao8TfFV6g0QkinpCB41fQ0FSkDVhgjnA/1v65cAQkdMc+YytR0jmdvT+BG9YzWVXPQhwCoEacpkjoZFJW9NHGSs8WqlIduUDFiKIRa4X7gUxjZS78ID+U358BoQj0kDBlJDkKuR5uWyyeB1aFStTUcJgqKdtlldgxu8wEurzjTkQt7unmp646yqBEFpVc6tSFiYygzaybgu5BP4OmdfB9CQGi+E0g92sCpOd6ZkAmdCnmGm/i0UvJfVg76UL5G47QJANmELSHLXWZ0wuaAiCE2cNG4nSgtuEeOjGOkuBz2DswTNFCI8uAUeez2crddjfQeLF6um1N6l4nPZSX6gKKlnR4h81mmVblHfuc0SAo3qBkUG+C4bzXg3P6KUEeS+pENzhbrugQHMNcWJq/BazkVdV8FHuOm8aDfPnRWeOI8OzoK517hOfN2eggit8kg45k+H1R1HuM2hW4XxTBFL2Xkth9M2UM8pdXZOVxAdIbqA3Tohn10tJOjf/vq/hgL57n2IGeAWdrZSiJ9nRrm83OasgaIDzTsH1QZJ+zcD24zd6z0eQYA43YOqOuQTfP5FDx9Io6KbRtVOj7b1/MnM7+tsaR+P7yzpL8jUHI9G/58t6YejL8eS3h99QZb0UwTWO+1vlia7tNutsiMEIa4f8F6B829mSl/fE337q7gKmWxDcM0Oeyv3X238ByF+g0PAeQzqYII3ZsNmCA17oxH+b00IhkJEvupSqxTTP0Xx7SMZN0j0umDT9fg6vHh6lBcyT+YkyavqTdePahKb/0p05sYj6f1rgECk/9JeIwdj2hfGlgV83Sx7PbqapyRkJiSchSM4WwsZuWPe33Ymb1QOTp9YoBG30ArLF3nFyuol4zPUjHAafY9HBFrfRMwfBtl12Ngfjc7GFRIebSLhuaQ0KyoA9ladg/x9d9pc3rrlEdTLPKslSiRcJ2qPWpttfnebNJCUWthldHB8FV32eSH6rv3g+HR1ilRo54pCi8oQxNzOo4NouBFppDpsGMc63qCbBUfP2o/lhMA+LK1if1bJudsb8VDFKBdCWzfTwLhh83JCLHOkOVLzS35xzvUQJfdwPBgNRtEqvlqbxHCZ4hudDfHOCzG8GA/GW8ZsvQ6u6Q9l/0OHGMtnQs5uGndaH8obJBxHG62jqfXXQvwJUIH1J9/sFUcCsT8HjpYtnjXS4+s6IPwsUFUI1W6LvtbUsx5PDeHUVoR0/VreEvNshDyPQ7yRQohVBDGqNxRVUb4oasTt8EcjEoc/K+X+uOafKowVdO8xKa17+/uk3T0Zkxr08ClpGPuPV6cO+Q2/NaUNNJ2v7uVRy4voP7W9alG05sVquZLWPUk7vTo7nDp+yTXnRQXINp8B2upbTXU/qmGWbUFl0ETaiMSHO4jIhyNC5P6IEPl01FKC/PbrGWpVhvSVSl0hnaSpkqDecYqEK+RUEdX7435VgHyD/mCUJ8Q1G6orZInKqwJQvV4Y8tvf/l6N6vUqi9k5wtFsflVqVqgF6GnpKkpNM7ikcow4DHJqM2TjUxIAzzMwBsPv0sKMjHVKFEcntHdzJrzgE5EJlPPu4T49221cFa78JOVzLFX5lXbZDReQ4fVQeZcapSzZQunzKdbHjBlnE8z6QP8iyDmXiXNlOhFCLjk0ldFNXGhhsOadRqiFg01Jq3liWc4ln5FPLWZNZKWQCRTsTKsJevqNykrny7ZcZEq7R5a0IXoFQ0h8dllgE+nfyLQa5kjYF96hbWIXUHDSwVdZnGDspkBYBPoZrGKlzBQWRMQYUJllrFDWxWVQzW/CiMOt5tKgbu5gCWdQIcz7msF4j807A3jCL4Q8d0W5+uy4oqufYGKEhXbK/jpzPmiP+UFYvOJeQ6GMsEov69EzYcM11pyk+uFm+iEU72xI8dsn0rwBixRihodHz0kxecB+++v/sBfAtWRztXDUmpQasmW7Tqg7eYe2Sq+gaAYvsUamJSKVsxBgCxj8ac4tuYdewgL9cI6l3MumtXquptc7YN9trd8aUoxdugqGmLgvhsoyIc8H7NCXO629Xfidxn1EudO3jdUhN5BdgGm4+yAVtlXkFFrA+M21s3dwb4dpupEMgy7fGhznpKKIGXfeKqwauiV/ppUc065eBzKlOpXmgKWaT209f7xZbXXLp5ANFNAR+2mqI3GcWLSNCuMceWsaSFvekoMQFzTtMrSF8OR0HMiStWthfDhZOwNXWp6Qwh1uUF6IrUERrNJpXk3fgL4QSbDJdnD0kDoPozjKRALe2vb31+EPRy/YxcPBqKWz3oK5hy+ef/fs5ZtnCAwKUoewoLuSXp1z2VhpjXfW77bGK76udHJXOrkrndyVTu5KJ3elk7vSyV3p5K50clc6uSud3JVO7kond6WTu9LJXenkrnRyVzKjK53clU7uSid3pZO70sld6eSudHJXOrkrndyVTu5KJ3elk7vSyV3p5K50clc6uSud3JVO7kond6WTu9LJnR+4K538YVZCVzq5K53clU7uSid3pZO70sld6eQvrXRyI7VxWGRcUK60T+l3ac7H6wWVT+NojnnQB8fR1RVS3judrVb4+ZeSsiyPT+PogmuBTygphToOCbiYTHkOmIj5nXsR2n+L68fuoCmBZS1zHDOI3YhD2vu1fZup2kev3ryN4mjiiz7nKqWKD3yByZd84ZJTGxma9O0qyriclZTdGbk5V64+1rydcHxOCcf+j0aKKCbm1hC2M5HdNvBf3NTWAVdXLpl5tar6u6adIzxiQ288v9PVavV/Vyhu4A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},b=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," and a ",(0,i.jsx)(n.strong,{children:"public_url"}),". The ",(0,i.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\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:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",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": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,l.R)(),...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/03e06346.8e56cf3c.js b/assets/js/03e06346.8e56cf3c.js new file mode 100644 index 000000000..11267b35d --- /dev/null +++ b/assets/js/03e06346.8e56cf3c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>j,default:()=>f,frontMatter:()=>x,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDlyvwJXOGJGvdXNboo6hhsOmzMjz8orSwwdnrBJLhddld0FsQqoAVBs9jI6Yh/2D/zk1/20+RJHJoA6+iApiRpLjpoHDbtwJRKZiTyQeR1ZPjfR4Un0Fooy5xZMdBZHKZhEi9IKJaPD6G0G7Lia5iJhoRc7On7OeJ6rhWGVAW2YVSzRgE02zMRsxi0zoC+BccOmeQWlFtIaNlOazUGC5lbIOUtVUhWADQthM1ZqSGEmJKTMWF0lttJgRuznDCTj9fRMGGaqJAFjZlWeL/3yacxs5uDTYCstDeOskuKXCthgEAafi3QwYFymjLPBoKTNnVc6HwxGDLfb/YZLud/5knFaUkxzoPEFX7IpMJNxDamDn8slISVmIPk0xx3aDApEkd+0G2rEXLb2PuUGUqYkwR8AHbE/qAVc4mTtz0xYA/mMJVxKZRGAQqViJiBlNtOqmmfMZsKwd69f/J4Ji/2YkjmBWuEyeAJhaYc5oWQNlZDz0ak8lW9FecjelbniKVuqSrPjH/+1GWYVw28ng8GPMK3m7N3zweDs28za0hzu7fGyHKkSJM6X86kZJarYS7Fjmc4exGyRgQaclYADbgQiN0UcpnOwhjYsWaLKJUuU0qmQSFQxK/kcmKyKKWgTuzNQGphA4tDA0+XQqmFlgP3bm1cvcaMFtyN2nFcmrpdLhYbEItHg9IjZsKtv3EE8PkDaE3Ies4Jf4BEKy36pRHKB2zYgU/y/pzTC1WDwpipLpS2k7Ge3hcPBAFu+h1wtGNdA/RNVFEqykmtegCXWQTbBZg2/VKIhozwPuDg8lUM2GEhewOFgwN45chYpSIuHruk46cDdgJHrb5cl9X8uU5F4jgSGX5madbsiUrHrmxISnNJ1baEaCXORiSQjHC64O/8y54nblgZTQmLFJXQnvorZEif+EaQKEGRKi78oaXlOx3cJ2oqE5+1jRgCxq7Fck4wolZA2fPUrsP/0x4mnTYfo6RBBSxG5hZDUYoBd8rwC46FaxCxDqF5DqcEQ+/l5iX9TloGYZzvX4+n7ytjOxKwyntFrKPxa4VQJvUBom/HcABOzDi4LfgGt1Zgi+cvzEft+yVKY8Sq3MRNIoVZXMGIvlWW8LHORcJRGSAPIbBzl5ZBO2ZPPqEs+x1pdihRQMKZiNgONzIyNNIUfE6BDuixpAG6POM1mJE3WDjpRudKbJESfu3hkiZIWpB2xo0sucgLebdYwIZO8SoFNc55cxHRnxEyjVMdTWQJeObHjD+qCF4vDOeGHGciRCpVE+KXyy+NV4aFKUcCjPA/8h40B1bSIMG2sei6fKVwZURBYkkHBRR4T4mL2Xk2ZFTaHGBm85HIZs5RbiJmFKztVVzFLMkgu6C/NU6HYtLJWSbexVKsyVQvpcTlT0hrxly0cGVo+HKP7MTuI2eOYPY3ZZByzyX7MJgcxmzyO2eRpzPbHMdvfj9n+Qcz2Hzuw9p96XPMawW0AJvsOy/brwS7K6RfCEGejgDW1zF50ZPZkxAaDmpvw25///OdTeX0qGTuNkLlOo0N2GtVdTqPYtaHMxLaJ/32FPx7uP/E/l/jz8f5T/3NBXScH/meGP/cnp3LlFzyV+wSJ5UV5AxTYfK8Q+F+eiPAbLYrfgjzDjyiI4tCAZ9WBBxtW7b08xL0IKazgudm9ndDjC9pRA9LGpg5wU0Suu3dEzV/QdtrwYAuJSddEYrXVFBieoNjf2P2jkb9Zdm/eLfvF7L0Fzqdt/TFuHUXTWxRNu/dfS68vCAnrMH0aJp6MSAEgybwbD77DF4SFLkSfhoOniAO8lHYjAFu/oN23wMEGf8O7tvHBcPJouD/eP+hgAG0p16Eohmk6XC6X94E91Hn88qjyBA3VaXZo7s60KraYH2QdNL28TkR/B5X931FRnwYdFlK0E8mwCBpLbSG2tWyrUr78xripwtBaOcP+jWq2bIFJTQgHWctJpkTigcc+QSWbokE4QhwMCZN7abrXwiR+TNNhUQzXPuLPISG+9bEoRmk6Wuu5cTruY8HSNGabn7d+T1NWFMWOz+575/NeUWzuYlQUHjZSvr4bkROGdLbdfOI7/Fas0nBEd+Eb2Qg9DehRwQYy57bz0dplkwnpGzxRsbUOGuZVzjVcoV1qhJKu9/3zWGCxRrMnO9Z7EiAo1uzbV157f+DJH7fQnQC/3D5uY2c4yRFLKmNVwTTM4YqV3FrQkia75LlInVtqSB/gihclmgB7fzo9TX/3j3vkgEAb3zrfVirmAv1Ge386ORr+19mWHlVZgk64AZYDrmRiBjYZsZMM8rJxXS0Wi9HioUkypXLnt3pvNMzcv+dq+v6cwC1H3JQPtu3UkUbL4EfSWbf3DdgOxrhhYeQWk59ojHhoMqbb1ts7N1y3vscXdOOsgYSNznuCzSenUcFJIUFShuZvZTPQp9FZPcYZ+ZDeMvbsDsyaiRRyPoV8s+nOjFZ/zvlSVZ6/g1Oru1VP0S28YUMhZO23oO2M41Yjv1prdG2rLfztENLmznDlBPYMJ8ByYYLnpovO9mjv2iIHpQQgnyc6u/0ANq2p9JO5oAbsbmzgJJE/u1uWwH6MOtZuxbDaLSt0DqaNGJyjEFIUVVH7R2f1rAFlhdc92vjCkRgcCCu0T3djBX51ywrojNy9wKmckB8j+D9u0Ex9jy9IVqyBdDMbf4wU6dzT93TB3s6AYVttBtxyLWNXdyHXzGd2c9+IvcLrDX2ybhB62ZIESoseuU9lzRrkO99Q5LNq++F2U1671xdEfVvA+swU6Pvd9+3zUUTa3v1XRKgdsO9MrM4pWfD5DZY7NX9B5Onh2XBCTMgZ6e6LGxxy1H7zdibjznYedbfzePwR1lVn2U83rsb1x8aqeiYx5rCxENrlVc7vVdT7OZE0f1BFWdk2L5DJT/weLu8QVnNhwt/FbBizQcz2YvZtzB6M2GugQFxSB+38XS60C80JfCpQYcwkqTQG8jVPMBoOo/mIXV//UnFphV2uVmzArq/xjcFqNULmuJBq4eJ2J5fCCMsw7t7YOqlKzJY4vUrMHhpFey9hMfzRx8b3PGgP2LdqjVNvtCw9Cj7UlNw17DPbVxgiOtYwE3neCuSz8CkcDwZGIYfCB499CB8VRgonCWkVoiA8lhgMpjBTGErClwQYkGy/GHEamxOO7dcI7mmG0izjxlmyZDrj9vCpBD4r8UGtl8qCi2ibUkkDTpiXW4BuItKDwVpELHRromJCho2jOJncn/tm/7txW75MHj/qiMtHXQEz3iVgbvDeoBhxuAgub2iaWpxPAih832T7db4PkyKynbgJROaoT1V5ynJxQcHNVJgy50ski3BZeijXo+Y/ZEqZpocPXHs+M4fdgLjSGBN/MKrjg5/qd548ediR9k/vwZm25l7uHsb4YG/yaO9G//KaV/TD5TVjdzk5ctze6eSoZ3N0vR/4Y/3A90P4D+/TDTZ5st/R3h6OP50B7snb1WacW/xc9+HNuje3Upvd7uhQ+s0cO59OfQefw8RdE8NPJvcghndYsp9KiRsG673RHrsva3UbAd7BXL3RRv1kAm0D+9mJ9NH9mLaTcUdX+66jqn233ybKR4/uRJTtRdco6zQS//H9q9eL8R9/mqujo6Ojl2/eZc/ezY+Ojgr8PRqNtno1tp02LYM6rH/S6+9luuN3rDIajRCFKbf8kIbvlXL+ezc+3j1m5J+DfCZX66P7iG5u8ah+uhSou/42F8029+nn4/NP5cAojlRJWQ5KPk+jw8hlEYRX/FFMLhAw9nuVLqPD68i/48Q//StJHLr33mAixnVkkgwKjn8FEw5TN2Yix6nQgAdtojiihz2Yx4FUFx1GavoeEhvFGHQu0TMIBuegcYfXoZd77x7FXg2PDiNH9VEc+dBr/YmBTBQ+pijTWbQKC940Vf2lmcrQH3VKA86DT8Q/choaulpLXfmomdozrBq0NpNxrfkyWs+SCW/DQ2Dfjasfv+bLcDkIi66I+sEydYviSFgo2qvsODStPhzTCSjcCT36+9CxdCy8+OA1cVyZKflRA/27rI8Z+l5Nzz+KHHGw939sOes7no5r3Vy4SypH+NoZ0qAND5tn+zGjp7Oj2yg19Ccs83l7Tec121jz7a50jtYrcpORCczLErgeUVbFRyf4UEIYz5OK0pVqcdzZWQ1qvbPJKo6ubt/MFUvUMOSKsG9zmFn3toMlSkvQD9oPxr6Yze0fHKziaHn79pZf5fae4OEtbt/dz5Rk0yQg/V/A+vDpKo6y22H9Q50G9H8I7MHjVXPHRi7NsU5knKp0eR7k1uq2juEyw36YxPZcvtIp6BYipkrlwOUGJp7PnENdsW/Q0vkmdi+qKHtDaBMuMrZAd7OGBDATjB5aBlnFvK7jUjuYf1GPzvhn+IHUM1NNDfaSYT7jJpwCs1rM54Auc9+DBvv8FOBJhll5/p0XnwXvXqnhUqjKBPDQj463Sw6WciUxvhIyHjvWWAs75K1v733UPh38gpcrpnrCq7fHd8AlmYpDl7Dn9AO3SzcHe/X2GHPixMyrfyP2ztSYCKjlnS4M1TF2KXjIm6ll+9K9QgHn71Qu6bQdYhj5bLQh2wQoFWYrRLHL/cVIVp39uzFxk2SJR6QqiyEL4VOBjIXSdPBIUNSIfKuqu1DlLZjkbF7Ro1+LLBsS5OjdX5PTJqTLMiY7I610SOPzZIE9MeO3wVPACnZqzY/pvsYN52zGjcWk3UoKxLyu0Kqop4SrErTAaN9WFGhwqMPs49u1iW6C2LvXL3xqbdhDYMopcqCbGFJWlUQ1xAl14mI4ufWtbyhKyB2gz3cphpuqB8UwvQukBG2URDNJ6TmX4i+OhEkjQStrChnPXVcvKtBVjvAgh3eBCbL217/9vQXXTk13EzC3Ak9TfJV6C4RkSjqCR01fQ4kSUHUhwvlA/8v6JYDQEdOcu0xtx0jm7jR+TO9YTS0XfQiwDkGaKsnQsKjlrYmDjDVerTRkm5IBSzHEEvcLV8LYVupdeCC/KR9eA+IxacFAaghyNdK8XLYZvAmNqrXpKEFQdNM262twgxd4ZdW5hkLIu91TbW+cVbUgqKwquBUJC1OZUTcZ14V8Al8X7NsAGlLjpVD6wQ5WxenOlUzgXMhzzNS/g4L3sn7Ql/IlErddAMg2bAFJ7jprEiYXVAShjZPW7URpwR1ifBQj3RWg53CeoJlChAd3wONggLMNBmzoYPFi1VTau1R8LjvJDxQlzewIkc86rdMtmju3XUKgVd2gzAHfZaMZ7+ZHlDKC3Jd0aK/Q1D0wgLmmOHEdXiu4aOoq+Ag3nRft5rmzwhPn0cFZMPca14lv2lMQoXUeCcf86bC64wi3OXSrMJ4rYimbNXI47QL1nFJnM7qC6AjRBezWCfnsaiFB//rX/zEUyHfvQ8wIt7CzlUL8PDfK5eW2Zw0UHWjeOag2SNq/Gdhm7N7s8QgCxOkeVNWhmOLzL3r4QBoV3TSqcXp0refPZn7fZEv7eHxvSX9FpuZkPP7/bEk/HH89lvTB+CuypJ8isN5pf7s02aXdbpUdIQhx84D3Cpx/M1f65p7o21/FdchkG4Ibdthfuf8a4z8I8VscAs5j0AQTvDEbNkNo2B+P8X9rQjAUIvJVlzqlmP4hiu8eybhFojcFm27G19Hl0+OilEWSkSSvqzfdPKpNbP4r0Zkbj6T3zwECkf5Td40CjOleGFsW8HWz7M3oap+SkLmQcB6O4HwtZOSO+WDbmbxRBTh9YoFG3EIrLF/kFSurl4zPUTPCafQ9HhFofRsxfxhkN2HjYDw+n9RIeLSJhOeS0qyoANhbdQHyt91pe3nrlkdQr4q8kSiRcJ2oPepstv3dbdJAUmlhl9HhyXV0NeSlGLr2w5Oz1RlSoc0UhRaVIYi5zaLDaG8j0kh12DCOdXIdEV/UxG+4TPHJzIa05aXYu5yMJtEqXh+zVTrf0B+q4YcOMZbPhZzfNu6swdEbPEd3VB1MNepkKf4IqE/6g2j3iiOB9JMBR0MTUY/k8bqJzz4Lhxwip9uCoc1hroc3Q3SzE7BcvyW3hCBbEciTEP6jiF4d0IuaDUV10C2KWmE0/NEKjOHPWtc+aci5jioFVXhCOuT+wQEpW08mpJU8fEoX/sHj1ZlDfsuNTK/4275Q9xCo49Tzn7pOrihacyp1PDvrjp2dTpYdPha/5JovoQZkmwmPpvNWy9mPallJW1AZFIMuIvEdDSLy4ZgQeTAmRD4dd3QSv/1mhkazIPWh1h5IRWhrCKgGnCHhCjlTRPX+uF+VIN+gexalEnHNhiYJeaKKuh7TYBCG/Pq3v9ejBoPagHV+abRiX1WalWoBela5Ak+zHK6oOiIOg4LaDJnc9CafFzkYg9FwaWFOtjPlbaNP2HsdE17yqcgFil33jp5e0bYkt6sGSekVS1V9o12ywSXkKK1rZ0+rsiRbKH0xw3KVMeNsikkY6O4DmXGZOM+iEyHkIUPLFb22pRYGS9BphFo42JS0mieWFVzyObm4YtZGVgq5QDnLtJqi492ovHKuZctFrrR780gbokcphMRnVyU2kTqMTKshQ8K+9P5lEzv/vpMOvujhFEMpJcIi0Oy3ilUyV1ifEEMyVZ6zUlkXJkGtuw0jDreaS4OqsoMlnEGNMO/6BeMdKO8M4Am/EPLC1cgaspOarn6GqREWuhn068z5oDvmJ2H/UE2xAp8ywiq9bEbPhc2qKcn59iT1DzfTT6GWZkuK3z2v5Q1YpBCzd3T8nPSEB+zXv/43ewFcS5aphaPWpNKQL7tlO93JO7TV1zwFF3iFJSstEamch3hXwODPGbfkrXkJC3SLOZZyD43WyquaweCQ/bC1nGrI+HXZIxjx4b42KcuFvBixI199tHE+4Xca9xHVR9+2VofCQH4JpuV9g1TYTs1R6ADjN9dNpsG9HaXpRm4KemAbcJzPiAJY3DmPsIjnlnSWTq5Kt5gcyJTKRppDlmo+s8388Wbx0y2fQnJOQEfsp6mPxHFi2dXxjfOrrWkgXXlL/jpc0HSrwpbCk9NJIEvWLU3x4WTt7E1peUL6b7hBeSm2xiiwaKZ5NXsD+lIkwUTawdF71HkviqNcJOCNX39/Hf10/IJdPhyNo7il192BufdePP/h2cs3zxAYFKQOYZPReDQmy04ZW3DZWmmNd9bvttajur6ScV/JuK9k3Fcy7isZ95WM+0rGfSXjvpJxX8m4r2TcVzLuKxn3lYz7SsZ9JeO+knFfwaKvZNxXMu4rGfeVjPtKxn0l476ScV/JuK9k3Fcy7isZ95WM+0rGfSXjvpJxX8m4r2TcVzLuKxn3lYz7Ssa9H7ivZPxhVkJfybivZNxXMu4rGfeVjPtKxn0l46+tknErtXGvzLmg1GWfYe+yjk/W6xufxVGGacmHJ9H1NVLeO52vVvj5l4qyLE/O4uiSa4FPKCmjOQ4JuJhMeQGYiPmDexE6fIvrx+6gKYFlLZEbM4jdiCPa+41925nTx6/evI3iaOprMBcqpQIMfIHJl3zhklNbGZr07TrKuZxXlN0ZuTlXrlxV1k04vqCEY/9HK0UUE3MbCLuZyG4b+C9uauuA62uXzLxa1f1d084RHrGhN57f2Wq1+l+WfEc1","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var s=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDlyvwJXOGJGvdXNboo6hhsOmzMjz8orSwwdnrBJLhddld0FsQqoAVBs9jI6Yh/2D/zk1/20+RJHJoA6+iApiRpLjpoHDbtwJRKZiTyQeR1ZPjfR4Un0Fooy5xZMdBZHKZhEi9IKJaPD6G0G7Lia5iJhoRc7On7OeJ6rhWGVAW2YVSzRgE02zMRsxi0zoC+BccOmeQWlFtIaNlOazUGC5lbIOUtVUhWADQthM1ZqSGEmJKTMWF0lttJgRuznDCTj9fRMGGaqJAFjZlWeL/3yacxs5uDTYCstDeOskuKXCthgEAafi3QwYFymjLPBoKTNnVc6HwxGDLfb/YZLud/5knFaUkxzoPEFX7IpMJNxDamDn8slISVmIPk0xx3aDApEkd+0G2rEXLb2PuUGUqYkwR8AHbE/qAVc4mTtz0xYA/mMJVxKZRGAQqViJiBlNtOqmmfMZsKwd69f/J4Ji/2YkjmBWuEyeAJhaYc5oWQNlZDz0ak8lW9FecjelbniKVuqSrPjH/+1GWYVw28ng8GPMK3m7N3zweDs28za0hzu7fGyHKkSJM6X86kZJarYS7Fjmc4exGyRgQaclYADbgQiN0UcpnOwhjYsWaLKJUuU0qmQSFQxK/kcmKyKKWgTuzNQGphA4tDA0+XQqmFlgP3bm1cvcaMFtyN2nFcmrpdLhYbEItHg9IjZsKtv3EE8PkDaE3Ies4Jf4BEKy36pRHKB2zYgU/y/pzTC1WDwpipLpS2k7Ge3hcPBAFu+h1wtGNdA/RNVFEqykmtegCXWQTbBZg2/VKIhozwPuDg8lUM2GEhewOFgwN45chYpSIuHruk46cDdgJHrb5cl9X8uU5F4jgSGX5madbsiUrHrmxISnNJ1baEaCXORiSQjHC64O/8y54nblgZTQmLFJXQnvorZEif+EaQKEGRKi78oaXlOx3cJ2oqE5+1jRgCxq7Fck4wolZA2fPUrsP/0x4mnTYfo6RBBSxG5hZDUYoBd8rwC46FaxCxDqF5DqcEQ+/l5iX9TloGYZzvX4+n7ytjOxKwyntFrKPxa4VQJvUBom/HcABOzDi4LfgGt1Zgi+cvzEft+yVKY8Sq3MRNIoVZXMGIvlWW8LHORcJRGSAPIbBzl5ZBO2ZPPqEs+x1pdihRQMKZiNgONzIyNNIUfE6BDuixpAG6POM1mJE3WDjpRudKbJESfu3hkiZIWpB2xo0sucgLebdYwIZO8SoFNc55cxHRnxEyjVMdTWQJeObHjD+qCF4vDOeGHGciRCpVE+KXyy+NV4aFKUcCjPA/8h40B1bSIMG2sei6fKVwZURBYkkHBRR4T4mL2Xk2ZFTaHGBm85HIZs5RbiJmFKztVVzFLMkgu6C/NU6HYtLJWSbexVKsyVQvpcTlT0hrxly0cGVo+HKP7MTuI2eOYPY3ZZByzyX7MJgcxmzyO2eRpzPbHMdvfj9n+Qcz2Hzuw9p96XPMawW0AJvsOy/brwS7K6RfCEGejgDW1zF50ZPZkxAaDmpvw25///OdTeX0qGTuNkLlOo0N2GtVdTqPYtaHMxLaJ/32FPx7uP/E/l/jz8f5T/3NBXScH/meGP/cnp3LlFzyV+wSJ5UV5AxTYfK8Q+F+eiPAbLYrfgjzDjyiI4tCAZ9WBBxtW7b08xL0IKazgudm9ndDjC9pRA9LGpg5wU0Suu3dEzV/QdtrwYAuJSddEYrXVFBieoNjf2P2jkb9Zdm/eLfvF7L0Fzqdt/TFuHUXTWxRNu/dfS68vCAnrMH0aJp6MSAEgybwbD77DF4SFLkSfhoOniAO8lHYjAFu/oN23wMEGf8O7tvHBcPJouD/eP+hgAG0p16Eohmk6XC6X94E91Hn88qjyBA3VaXZo7s60KraYH2QdNL28TkR/B5X931FRnwYdFlK0E8mwCBpLbSG2tWyrUr78xripwtBaOcP+jWq2bIFJTQgHWctJpkTigcc+QSWbokE4QhwMCZN7abrXwiR+TNNhUQzXPuLPISG+9bEoRmk6Wuu5cTruY8HSNGabn7d+T1NWFMWOz+575/NeUWzuYlQUHjZSvr4bkROGdLbdfOI7/Fas0nBEd+Eb2Qg9DehRwQYy57bz0dplkwnpGzxRsbUOGuZVzjVcoV1qhJKu9/3zWGCxRrMnO9Z7EiAo1uzbV157f+DJH7fQnQC/3D5uY2c4yRFLKmNVwTTM4YqV3FrQkia75LlInVtqSB/gihclmgB7fzo9TX/3j3vkgEAb3zrfVirmAv1Ge386ORr+19mWHlVZgk64AZYDrmRiBjYZsZMM8rJxXS0Wi9HioUkypXLnt3pvNMzcv+dq+v6cwC1H3JQPtu3UkUbL4EfSWbf3DdgOxrhhYeQWk59ojHhoMqbb1ts7N1y3vscXdOOsgYSNznuCzSenUcFJIUFShuZvZTPQp9FZPcYZ+ZDeMvbsDsyaiRRyPoV8s+nOjFZ/zvlSVZ6/g1Oru1VP0S28YUMhZO23oO2M41Yjv1prdG2rLfztENLmznDlBPYMJ8ByYYLnpovO9mjv2iIHpQQgnyc6u/0ANq2p9JO5oAbsbmzgJJE/u1uWwH6MOtZuxbDaLSt0DqaNGJyjEFIUVVH7R2f1rAFlhdc92vjCkRgcCCu0T3djBX51ywrojNy9wKmckB8j+D9u0Ex9jy9IVqyBdDMbf4wU6dzT93TB3s6AYVttBtxyLWNXdyHXzGd2c9+IvcLrDX2ybhB62ZIESoseuU9lzRrkO99Q5LNq++F2U1671xdEfVvA+swU6Pvd9+3zUUTa3v1XRKgdsO9MrM4pWfD5DZY7NX9B5Onh2XBCTMgZ6e6LGxxy1H7zdibjznYedbfzePwR1lVn2U83rsb1x8aqeiYx5rCxENrlVc7vVdT7OZE0f1BFWdk2L5DJT/weLu8QVnNhwt/FbBizQcz2YvZtzB6M2GugQFxSB+38XS60C80JfCpQYcwkqTQG8jVPMBoOo/mIXV//UnFphV2uVmzArq/xjcFqNULmuJBq4eJ2J5fCCMsw7t7YOqlKzJY4vUrMHhpFey9hMfzRx8b3PGgP2LdqjVNvtCw9Cj7UlNw17DPbVxgiOtYwE3neCuSz8CkcDwZGIYfCB499CB8VRgonCWkVoiA8lhgMpjBTGErClwQYkGy/GHEamxOO7dcI7mmG0izjxlmyZDrj9vCpBD4r8UGtl8qCi2ibUkkDTpiXW4BuItKDwVpELHRromJCho2jOJncn/tm/7txW75MHj/qiMtHXQEz3iVgbvDeoBhxuAgub2iaWpxPAih832T7db4PkyKynbgJROaoT1V5ynJxQcHNVJgy50ski3BZeijXo+Y/ZEqZpocPXHs+M4fdgLjSGBN/MKrjg5/qd548ediR9k/vwZm25l7uHsb4YG/yaO9G//KaV/TD5TVjdzk5ctze6eSoZ3N0vR/4Y/3A90P4D+/TDTZ5st/R3h6OP50B7snb1WacW/xc9+HNuje3Upvd7uhQ+s0cO59OfQefw8RdE8NPJvcghndYsp9KiRsG673RHrsva3UbAd7BXL3RRv1kAm0D+9mJ9NH9mLaTcUdX+66jqn233ybKR4/uRJTtRdco6zQS//H9q9eL8R9/mqujo6Ojl2/eZc/ezY+Ojgr8PRqNtno1tp02LYM6rH/S6+9luuN3rDIajRCFKbf8kIbvlXL+ezc+3j1m5J+DfCZX66P7iG5u8ah+uhSou/42F8029+nn4/NP5cAojlRJWQ5KPk+jw8hlEYRX/FFMLhAw9nuVLqPD68i/48Q//StJHLr33mAixnVkkgwKjn8FEw5TN2Yix6nQgAdtojiihz2Yx4FUFx1GavoeEhvFGHQu0TMIBuegcYfXoZd77x7FXg2PDiNH9VEc+dBr/YmBTBQ+pijTWbQKC940Vf2lmcrQH3VKA86DT8Q/choaulpLXfmomdozrBq0NpNxrfkyWs+SCW/DQ2Dfjasfv+bLcDkIi66I+sEydYviSFgo2qvsODStPhzTCSjcCT36+9CxdCy8+OA1cVyZKflRA/27rI8Z+l5Nzz+KHHGw939sOes7no5r3Vy4SypH+NoZ0qAND5tn+zGjp7Oj2yg19Ccs83l7Tec121jz7a50jtYrcpORCczLErgeUVbFRyf4UEIYz5OK0pVqcdzZWQ1qvbPJKo6ubt/MFUvUMOSKsG9zmFn3toMlSkvQD9oPxr6Yze0fHKziaHn79pZf5fae4OEtbt/dz5Rk0yQg/V/A+vDpKo6y22H9Q50G9H8I7MHjVXPHRi7NsU5knKp0eR7k1uq2juEyw36YxPZcvtIp6BYipkrlwOUGJp7PnENdsW/Q0vkmdi+qKHtDaBMuMrZAd7OGBDATjB5aBlnFvK7jUjuYf1GPzvhn+IHUM1NNDfaSYT7jJpwCs1rM54Auc9+DBvv8FOBJhll5/p0XnwXvXqnhUqjKBPDQj463Sw6WciUxvhIyHjvWWAs75K1v733UPh38gpcrpnrCq7fHd8AlmYpDl7Dn9AO3SzcHe/X2GHPixMyrfyP2ztSYCKjlnS4M1TF2KXjIm6ll+9K9QgHn71Qu6bQdYhj5bLQh2wQoFWYrRLHL/cVIVp39uzFxk2SJR6QqiyEL4VOBjIXSdPBIUNSIfKuqu1DlLZjkbF7Ro1+LLBsS5OjdX5PTJqTLMiY7I610SOPzZIE9MeO3wVPACnZqzY/pvsYN52zGjcWk3UoKxLyu0Kqop4SrErTAaN9WFGhwqMPs49u1iW6C2LvXL3xqbdhDYMopcqCbGFJWlUQ1xAl14mI4ufWtbyhKyB2gz3cphpuqB8UwvQukBG2URDNJ6TmX4i+OhEkjQStrChnPXVcvKtBVjvAgh3eBCbL217/9vQXXTk13EzC3Ak9TfJV6C4RkSjqCR01fQ4kSUHUhwvlA/8v6JYDQEdOcu0xtx0jm7jR+TO9YTS0XfQiwDkGaKsnQsKjlrYmDjDVerTRkm5IBSzHEEvcLV8LYVupdeCC/KR9eA+IxacFAaghyNdK8XLYZvAmNqrXpKEFQdNM262twgxd4ZdW5hkLIu91TbW+cVbUgqKwquBUJC1OZUTcZ14V8Al8X7NsAGlLjpVD6wQ5WxenOlUzgXMhzzNS/g4L3sn7Ql/IlErddAMg2bAFJ7jprEiYXVAShjZPW7URpwR1ifBQj3RWg53CeoJlChAd3wONggLMNBmzoYPFi1VTau1R8LjvJDxQlzewIkc86rdMtmju3XUKgVd2gzAHfZaMZ7+ZHlDKC3Jd0aK/Q1D0wgLmmOHEdXiu4aOoq+Ag3nRft5rmzwhPn0cFZMPca14lv2lMQoXUeCcf86bC64wi3OXSrMJ4rYimbNXI47QL1nFJnM7qC6AjRBezWCfnsaiFB//rX/zEUyHfvQ8wIt7CzlUL8PDfK5eW2Zw0UHWjeOag2SNq/Gdhm7N7s8QgCxOkeVNWhmOLzL3r4QBoV3TSqcXp0refPZn7fZEv7eHxvSX9FpuZkPP7/bEk/HH89lvTB+CuypJ8isN5pf7s02aXdbpUdIQhx84D3Cpx/M1f65p7o21/FdchkG4Ibdthfuf8a4z8I8VscAs5j0AQTvDEbNkNo2B+P8X9rQjAUIvJVlzqlmP4hiu8eybhFojcFm27G19Hl0+OilEWSkSSvqzfdPKpNbP4r0Zkbj6T3zwECkf5Td40CjOleGFsW8HWz7M3oap+SkLmQcB6O4HwtZOSO+WDbmbxRBTh9YoFG3EIrLF/kFSurl4zPUTPCafQ9HhFofRsxfxhkN2HjYDw+n9RIeLSJhOeS0qyoANhbdQHyt91pe3nrlkdQr4q8kSiRcJ2oPepstv3dbdJAUmlhl9HhyXV0NeSlGLr2w5Oz1RlSoc0UhRaVIYi5zaLDaG8j0kh12DCOdXIdEV/UxG+4TPHJzIa05aXYu5yMJtEqXh+zVTrf0B+q4YcOMZbPhZzfNu6swdEbPEd3VB1MNepkKf4IqE/6g2j3iiOB9JMBR0MTUY/k8bqJzz4Lhxwip9uCoc1hroc3Q3SzE7BcvyW3hCBbEciTEP6jiF4d0IuaDUV10C2KWmE0/NEKjOHPWtc+aci5jioFVXhCOuT+wQEpW08mpJU8fEoX/sHj1ZlDfsuNTK/4275Q9xCo49Tzn7pOrihacyp1PDvrjp2dTpYdPha/5JovoQZkmwmPpvNWy9mPallJW1AZFIMuIvEdDSLy4ZgQeTAmRD4dd3QSv/1mhkazIPWh1h5IRWhrCKgGnCHhCjlTRPX+uF+VIN+gexalEnHNhiYJeaKKuh7TYBCG/Pq3v9ejBoPagHV+abRiX1WalWoBela5Ak+zHK6oOiIOg4LaDJnc9CafFzkYg9FwaWFOtjPlbaNP2HsdE17yqcgFil33jp5e0bYkt6sGSekVS1V9o12ywSXkKK1rZ0+rsiRbKH0xw3KVMeNsikkY6O4DmXGZOM+iEyHkIUPLFb22pRYGS9BphFo42JS0mieWFVzyObm4YtZGVgq5QDnLtJqi492ovHKuZctFrrR780gbokcphMRnVyU2kTqMTKshQ8K+9P5lEzv/vpMOvujhFEMpJcIi0Oy3ilUyV1ifEEMyVZ6zUlkXJkGtuw0jDreaS4OqsoMlnEGNMO/6BeMdKO8M4Am/EPLC1cgaspOarn6GqREWuhn068z5oDvmJ2H/UE2xAp8ywiq9bEbPhc2qKcn59iT1DzfTT6GWZkuK3z2v5Q1YpBCzd3T8nPSEB+zXv/43ewFcS5aphaPWpNKQL7tlO93JO7TV1zwFF3iFJSstEamch3hXwODPGbfkrXkJC3SLOZZyD43WyquaweCQ/bC1nGrI+HXZIxjx4b42KcuFvBixI199tHE+4Xca9xHVR9+2VofCQH4JpuV9g1TYTs1R6ADjN9dNpsG9HaXpRm4KemAbcJzPiAJY3DmPsIjnlnSWTq5Kt5gcyJTKRppDlmo+s8388Wbx0y2fQnJOQEfsp6mPxHFi2dXxjfOrrWkgXXlL/jpc0HSrwpbCk9NJIEvWLU3x4WTt7E1peUL6b7hBeSm2xiiwaKZ5NXsD+lIkwUTawdF71HkviqNcJOCNX39/Hf10/IJdPhyNo7il192BufdePP/h2cs3zxAYFKQOYZPReDQmy04ZW3DZWmmNd9bvttajur6ScV/JuK9k3Fcy7isZ95WM+0rGfSXjvpJxX8m4r2TcVzLuKxn3lYz7SsZ9JeO+knFfwaKvZNxXMu4rGfeVjPtKxn0l476ScV/JuK9k3Fcy7isZ95WM+0rGfSXjvpJxX8m4r2TcVzLuKxn3lYz7Ssa9H7ivZPxhVkJfybivZNxXMu4rGfeVjPtKxn0l46+tknErtXGvzLmg1GWfYe+yjk/W6xufxVGGacmHJ9H1NVLeO52vVvj5l4qyLE/O4uiSa4FPKCmjOQ4JuJhMeQGYiPmDexE6fIvrx+6gKYFlLZEbM4jdiCPa+41925nTx6/evI3iaOprMBcqpQIMfIHJl3zhklNbGZr07TrKuZxXlN0ZuTlXrlxV1k04vqCEY/9HK0UUE3MbCLuZyG4b+C9uauuA62uXzLxa1f1d084RHrGhN57f2Wq1+l+WfEc1",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,g={},b=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," and a ",(0,s.jsx)(n.strong,{children:"public_url"}),". The ",(0,s.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.27742ef4.js b/assets/js/138cee78.27742ef4.js new file mode 100644 index 000000000..ee40c4616 --- /dev/null +++ b/assets/js/138cee78.27742ef4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>g,default:()=>X,frontMatter:()=>f,metadata:()=>n,toc:()=>P});const n=JSON.parse('{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/v1.1/createcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createcontact","permalink":"/docs/API-docs/v1.1/createcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar_label":"Create Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWM1u5MYRfpVKXxIPqPmR1g7Ck5XFYiNk4RUsGQKiFYQiWUO21OxudzfnB4MBfPAb5JRrHm2fJKgmOcMZadcWbGwSYLEYVVdV1399zY0IWHqR3orXRgfMgxd3iSjI507aII0WqbiuCF47wkDQMcH55QWgUmbpYW0aCAZoPjcuKPJerSFvuTUtIe/UQqgwQI4aWB49eFlqch7mxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkohCpaDV3SkUiHP3YkA9/NcVapJsjwy+dWciCICNllmDRYU2BHJvbWbhXxL9IB1aC1iqZxzsnD541bYTPK6qRf/GN0lHBMaMapRKJ0FgTxy2sLYlUmOyBolLr2PogybNk5Eo3PZcPTupSJGJuXI1hSKEV1lYx04Nh80lsk+6yl8tnRN92hHFualZlK6NfbMrs9Ox0djY7O52xitzUFvX6pUqMJc2ZZxUPJrsPMqgXW1LQQmy3ieiED4viPuNa2PL5PlXBNRQJ3hrt23ScTqdPS6Yv8FZlAb7Jc/J+3ii1/sNLyuTzpdCSuaJf5rmtZlm1On2wHL//83p6NTubncZ//xP1lHRlVJyH5+T33KfT07OT2fRk+ufr2Tfpq7+kX38znk6n/xCJWNVq3+iiwBAD3Zdp/3djiy9wz/aYreuPggJK5YcC/RTcxq559VxfXJmaQiV1CUvSAZbO6DIBqwg9QXBrwBKlBoWB3O/YJ+SccZ8P08ssG44NqZXUdN8PhftX0+n9bBeE2aeHAypHWKyBVtIH/2Xd/ZQNn3dsNnDs66eOXegFKlnEtX5tHkl/WZ+G14f2+qflK1umeC4OnB3SWyc95Y2TYS3S241YnaCVJ+15enu3vUsEV4xhOGGNjxZjqEQqJsfowpNbkPNRTeOUSEUVgvXpZOJRF5lZjfv5ozDzPA0naOVkMRvzTDuWQWtfxE/NyUtFfMBS6vKX5O72IbriNLaZOgjULl9o5d9p3YOc9IArEZLLpyIsyMWccXV8v8dkb/oc79LYL6Dd/nlupew2yhB0DHbEfuwfTP1+kEs9N9GDjvzekr6SpY4FFiNwDHFvSOWmJkaGoSIYjXqRjz//eyc1Gu2QaWyF8Qf9Qb9vHFizJDdvFKAuYK5oJTNFUYzqeLZDyZ6w7jCy1IFKxyC0kKUMqCIi5jmWo8VMKskdxGymxceDJvRjuKkoVBSh8x8dAUJBC1LceIBNMDUGVtXbC0vjHueM1xNAyBovNXkPpCvUOTP25ZCAcYAaSAdy1klP4INjq2Vrm9HB8fypUWNJrDuBYbAKUpJ7BpzJGh/AG9VEk4HXjnFUQO+QJip8DOKbleUjYCon2VHF+V0QlI0syCeQm4LAxwphF3QBGfkAlm2ROXlW2mhl8seYQMZrYA3PL4kKzPzARhYPDrVnUNDa0udgFzDrDAM/ag0cjX7wxBl+J/WjT0ejD/oEbnd1dUOZl4Hu/tT34XK5fNJ/Xx3KvJXhb00G35M1Xgbj1nvpUoaqyWLPDpXs/mg1vSVNsX4GHbnXUZjcPx0BTJ1UpOzkigJXiJ+cX17Ekf8VfPzpn/CO0GmozLKt1rxxpNZQ9ldx5NrMt2HbTez4jMMmVBzxvC2+7m3WR/CmwvDxp395+I6WIHXXUuzKaHTZZErmcE215UXtR6O0f3KGnrZ/QWYEvkIupYVEQLCttJL6cQzneg2NJwdLGapYDEyPcgducFz2L03I0FMBRkeJ/s7x3iKm157Ugjzr0iawGVRIfiWEypmmbG8bGtM552gulYIbWZQUom/nRQG2Iy9bMgd8YA7NuSFCRWtAR+BJhzFcHonEk8byu5kKjmmsfcMPc04A6cIaqYNPoXA4Hzysk32hx50njX6G1IYQd+FIOjW7lLSd2Hm8o44/8Fw+2iaH89bRnBxfGN3e58XKrpxu+7IErtbfUtbt46Ld6AxHuq2DVn57rCfCCnK1fz+/IreQOXWr9RMdPYnME5EIJXPSfrjnzt9evoPF2XgqksGO/hXNPXl38frNd1dv2BgepG3AZuPpeBqfWsaHGvXgpsNPM8erbbPHcf/lDzkdngi0ChOrUEYUF0Oz6QDY7dHnnbtEVAzQ0lux2XCD/uDUdsvkHxtyjO7uErFAJzHjPX97t016LMKI7ZHWHWAmHU6u+XpmV00La44gLYOpVuI8z8mGz/IOMeTl+6trkYis+wRVm4JlHC758xQuRSriV6y4BOMHJKZthEJdNlhGTBR1MnziCXqIvR4j9up+sFf9kV4PLDwEZa0b/D879azAZtPiuu12x98efVKiC2zPzem72263/wHx/A75","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var o=a(74848),r=a(28453),s=a(33617),i=a.n(s),c=a(17543),p=a.n(c),l=a(86013),d=a.n(l),m=a(63723),u=a.n(m),x=(a(18766),a(79329),a(9303));const f={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWM1u5MYRfpVKXxIPqPmR1g7Ck5XFYiNk4RUsGQKiFYQiWUO21OxudzfnB4MBfPAb5JRrHm2fJKgmOcMZadcWbGwSYLEYVVdV1399zY0IWHqR3orXRgfMgxd3iSjI507aII0WqbiuCF47wkDQMcH55QWgUmbpYW0aCAZoPjcuKPJerSFvuTUtIe/UQqgwQI4aWB49eFlqch7mxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkohCpaDV3SkUiHP3YkA9/NcVapJsjwy+dWciCICNllmDRYU2BHJvbWbhXxL9IB1aC1iqZxzsnD541bYTPK6qRf/GN0lHBMaMapRKJ0FgTxy2sLYlUmOyBolLr2PogybNk5Eo3PZcPTupSJGJuXI1hSKEV1lYx04Nh80lsk+6yl8tnRN92hHFualZlK6NfbMrs9Ox0djY7O52xitzUFvX6pUqMJc2ZZxUPJrsPMqgXW1LQQmy3ieiED4viPuNa2PL5PlXBNRQJ3hrt23ScTqdPS6Yv8FZlAb7Jc/J+3ii1/sNLyuTzpdCSuaJf5rmtZlm1On2wHL//83p6NTubncZ//xP1lHRlVJyH5+T33KfT07OT2fRk+ufr2Tfpq7+kX38znk6n/xCJWNVq3+iiwBAD3Zdp/3djiy9wz/aYreuPggJK5YcC/RTcxq559VxfXJmaQiV1CUvSAZbO6DIBqwg9QXBrwBKlBoWB3O/YJ+SccZ8P08ssG44NqZXUdN8PhftX0+n9bBeE2aeHAypHWKyBVtIH/2Xd/ZQNn3dsNnDs66eOXegFKlnEtX5tHkl/WZ+G14f2+qflK1umeC4OnB3SWyc95Y2TYS3S241YnaCVJ+15enu3vUsEV4xhOGGNjxZjqEQqJsfowpNbkPNRTeOUSEUVgvXpZOJRF5lZjfv5ozDzPA0naOVkMRvzTDuWQWtfxE/NyUtFfMBS6vKX5O72IbriNLaZOgjULl9o5d9p3YOc9IArEZLLpyIsyMWccXV8v8dkb/oc79LYL6Dd/nlupew2yhB0DHbEfuwfTP1+kEs9N9GDjvzekr6SpY4FFiNwDHFvSOWmJkaGoSIYjXqRjz//eyc1Gu2QaWyF8Qf9Qb9vHFizJDdvFKAuYK5oJTNFUYzqeLZDyZ6w7jCy1IFKxyC0kKUMqCIi5jmWo8VMKskdxGymxceDJvRjuKkoVBSh8x8dAUJBC1LceIBNMDUGVtXbC0vjHueM1xNAyBovNXkPpCvUOTP25ZCAcYAaSAdy1klP4INjq2Vrm9HB8fypUWNJrDuBYbAKUpJ7BpzJGh/AG9VEk4HXjnFUQO+QJip8DOKbleUjYCon2VHF+V0QlI0syCeQm4LAxwphF3QBGfkAlm2ROXlW2mhl8seYQMZrYA3PL4kKzPzARhYPDrVnUNDa0udgFzDrDAM/ag0cjX7wxBl+J/WjT0ejD/oEbnd1dUOZl4Hu/tT34XK5fNJ/Xx3KvJXhb00G35M1Xgbj1nvpUoaqyWLPDpXs/mg1vSVNsX4GHbnXUZjcPx0BTJ1UpOzkigJXiJ+cX17Ekf8VfPzpn/CO0GmozLKt1rxxpNZQ9ldx5NrMt2HbTez4jMMmVBzxvC2+7m3WR/CmwvDxp395+I6WIHXXUuzKaHTZZErmcE215UXtR6O0f3KGnrZ/QWYEvkIupYVEQLCttJL6cQzneg2NJwdLGapYDEyPcgducFz2L03I0FMBRkeJ/s7x3iKm157Ugjzr0iawGVRIfiWEypmmbG8bGtM552gulYIbWZQUom/nRQG2Iy9bMgd8YA7NuSFCRWtAR+BJhzFcHonEk8byu5kKjmmsfcMPc04A6cIaqYNPoXA4Hzysk32hx50njX6G1IYQd+FIOjW7lLSd2Hm8o44/8Fw+2iaH89bRnBxfGN3e58XKrpxu+7IErtbfUtbt46Ld6AxHuq2DVn57rCfCCnK1fz+/IreQOXWr9RMdPYnME5EIJXPSfrjnzt9evoPF2XgqksGO/hXNPXl38frNd1dv2BgepG3AZuPpeBqfWsaHGvXgpsNPM8erbbPHcf/lDzkdngi0ChOrUEYUF0Oz6QDY7dHnnbtEVAzQ0lux2XCD/uDUdsvkHxtyjO7uErFAJzHjPX97t016LMKI7ZHWHWAmHU6u+XpmV00La44gLYOpVuI8z8mGz/IOMeTl+6trkYis+wRVm4JlHC758xQuRSriV6y4BOMHJKZthEJdNlhGTBR1MnziCXqIvR4j9up+sFf9kV4PLDwEZa0b/D879azAZtPiuu12x98efVKiC2zPzem72263/wHx/A75",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},P=[];function b(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(i(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,o.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(p(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{title:"Body",body:{description:"Provide below parameter to create contact",content:{"application/json":{schema:{required:["email","name"],type:"object",properties:{name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"1232131321"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function X(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.a3f62faa.js b/assets/js/138cee78.a3f62faa.js deleted file mode 100644 index 2cc67823c..000000000 --- a/assets/js/138cee78.a3f62faa.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>b,default:()=>y,frontMatter:()=>u,metadata:()=>a,toc:()=>x});const a=JSON.parse('{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/v1.1/createcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createcontact","permalink":"/docs/API-docs/v1.1/createcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar_label":"Create Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWF9v3LgR/ypTvrS3kPePnbuiejo3CFKjaWKcfTBQxzBG0qxEmyJ5JLV/sFjgHvoN7ule+9HySYqhpF3t2klrtEhbIAjWI85wZvibmR+5EQFLL9Jb8drogHnw4i4RBfncSRuk0SIV1xXBa0cYCLpFcH55AaiUWXpYmwaCAZrPjQuKvFdryNvVmpaQd2YhVBggRw2sjx68LDU5D3Pj2IYDWVvjAuoAhcmbmnTwY5EIY8khe3JRiFS0ljujIhGOfmrIhz+aYi3SzZHjl84sZEGQkTJLsOiwpkCO3e083BviX6QDG0FrlczjnpMHz5Y2wucV1ci/eEfpqOCcUY1SiURorInzFtaWRCpM9kDRqHXsfZDkWTOuSjf9Kh+c1KVIxNy4GsNQQiusreJFD4bdJ7FNus1erp8Rfd8Jxrmp2ZStjH6xK7PTs9PZ2ezsdMYmclNb1OuXGjGWNJ88m3gw2X2QQb3Yk4IWYrtNRKd8CIr7jLGw5e/7owquoSjw1mjfHsfpdPoUMj3AW5MF+CbPyft5o9T6Ny+ByZeh0IoZ0S+L3FazrFqdPljO3/85nl7Nzman8d//BJ6SDkbFeXhOf7/6dHp6djKbnkx/fz37Ln31h/Tb78bT6fSvIhGrWu0LXRQYYqJ7mPZ/N7b4Cvtsj5d19VFQQKn8UKHvgttYNa+eq4srU1OopC5hSTrA0hldJmAVoScIbg1YotSgMJD7D9YJOWfcl9P0Ms+GbUNqJTXd903h/tV0ej/bJWH2+eaAyhEWa6CV9MF/3XA/58OXA5sNAvv2aWAXeoFKFnGsX5tH0l83puH2od3+KXxluyh+FwfBDuVtkJ7yxsmwFuntRqxO0MqT9nt6e7e9SwQjxjCdsMZHjzFUIhWTY3bhyS3I+WjmqB6WWJbk/tRk0evzJhj4i8kf29Aap0QqqhCsTyeThXShtTT2rVrVZNw6J5cOebK8x8Ujugn3sslsPB1PxTbZHBnxqIvMrMZ9w1OY+WgDrZwsZuPZMzpo7YvWU3PyUhUfsJS6/Gd6d/szuWLctNA4OJkdQNDKP9O6Z1XpwapESM5+RViQiyBhOP6wJ4FvelDtcNNPvN3Ae26G7UbYkOUMhtJ+zhyMmX5ySD03MYJO/MGSvpKljtiIGTjm1DekclMTU9FQEYxGvcqnv/19pzUa7ahwrL3xR/1Rf2gcWLMkN28UoC5grmglM0VRjer4bUfLPWHdkXKpA5WOWW8hSxlQRQrOjTNHi5lUkkuWl5mWkA+q3o/hpqJQUeTqv3UECAUtSHGlAzbB1BjYVO8vLI17nPMFIQGErPFSk/dAukKd88IeDgkYB6iBdCBnnfQEPjj2Wra+GR0cN7waNZbEthMYJqsgJblIwZms8QG8UU10GXjOGUcF9AFposLHJL5ZWf4ELOVDdlTx+S4IykYW5BPITUHgI0I4BF1ARj6AZV9kTp6NNlqZ/DEeIJcxWMMNU6ICMz/wkdWDQ+2ZhbS+9GewS5h1hpkmtQ6ORj964hN+J/WjT0ejj/oEbne4uqHMy0B3v+vrcLlcPqm/bw513srA7eoHssbLYNx6r13K0LekoZHdH62lt6Qp4mdQkXsbhcn90xbA0klFyk6uKDBC/OT88iLOmG/g08+/wDtCp6EyyxateeNIraHst+LMtSffpm03IuK9EZtQccbzFnzdZbDP4E2F4dPPv3p4T0uQuispDmU0umwyJXO4ptoyM/CjUdrfcUMv219ZMwJfIUNpIREQbKutpH4cw7leQ+PJwVKGKoKB5VHvIAzOy/5qCxl6KsDoqNHvOd57xPLak1qQZ1vaBHaDCsnXklA505TtbkNnuuAczaVScCOLkkKM7bwowHbiZSvmhA/coTkXRKhoDegIPOkwhssjlfilsXxRp4JzGrFv+CWAD4B0YY3UwadQOJwPbvLJHuhxyEqjnxG1KcRdOpLOzO5I2krsIt5Jxx+5Lx9Nk8N+62hOjjeMYe/PxcoOTrc9LIHR+u/Aur3NtBSC+U83ddDK74/tRB5DrvYf5lfkFjKnbrR+pqIncfFEJELJnLQfzrnzt5fvYHE2nh7wj3+huCfvLl6/eX/1hp3hRtomrOchkSLVqAc7Hb4FHY+2zZ44/pdfjjo+EWgVJlahjLQxpmbTMb7bo/eku0RUzAjTW7HZcIH+6NR2y+KfGnJMJ+8SsUAnMeM5f3u3TXouwhTxkdYdQycdTq55e16umpbWHHFoJlOtxnmekw1fXDskrZcfrq5FIrLuzas2Bes4XPJ7GC5FKuKzWRyC8cWKZRuhUJcNlpETRZtMn7iDHnKvx8i9uh8cVf9JrwceHpKyNgz+n4N6VmGzaXnddrtb3376rEaX2H41H9/ddrv9B0HQNqQ=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var s=n(74848),r=n(28453),o=n(33617),c=n.n(o),i=n(17543),p=n.n(i),l=n(86013),d=n.n(l),m=n(63723),h=n.n(m),j=(n(18766),n(79329),n(9303));const u={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWF9v3LgR/ypTvrS3kPePnbuiejo3CFKjaWKcfTBQxzBG0qxEmyJ5JLV/sFjgHvoN7ule+9HySYqhpF3t2klrtEhbIAjWI85wZvibmR+5EQFLL9Jb8drogHnw4i4RBfncSRuk0SIV1xXBa0cYCLpFcH55AaiUWXpYmwaCAZrPjQuKvFdryNvVmpaQd2YhVBggRw2sjx68LDU5D3Pj2IYDWVvjAuoAhcmbmnTwY5EIY8khe3JRiFS0ljujIhGOfmrIhz+aYi3SzZHjl84sZEGQkTJLsOiwpkCO3e083BviX6QDG0FrlczjnpMHz5Y2wucV1ci/eEfpqOCcUY1SiURorInzFtaWRCpM9kDRqHXsfZDkWTOuSjf9Kh+c1KVIxNy4GsNQQiusreJFD4bdJ7FNus1erp8Rfd8Jxrmp2ZStjH6xK7PTs9PZ2ezsdMYmclNb1OuXGjGWNJ88m3gw2X2QQb3Yk4IWYrtNRKd8CIr7jLGw5e/7owquoSjw1mjfHsfpdPoUMj3AW5MF+CbPyft5o9T6Ny+ByZeh0IoZ0S+L3FazrFqdPljO3/85nl7Nzman8d//BJ6SDkbFeXhOf7/6dHp6djKbnkx/fz37Ln31h/Tb78bT6fSvIhGrWu0LXRQYYqJ7mPZ/N7b4Cvtsj5d19VFQQKn8UKHvgttYNa+eq4srU1OopC5hSTrA0hldJmAVoScIbg1YotSgMJD7D9YJOWfcl9P0Ms+GbUNqJTXd903h/tV0ej/bJWH2+eaAyhEWa6CV9MF/3XA/58OXA5sNAvv2aWAXeoFKFnGsX5tH0l83puH2od3+KXxluyh+FwfBDuVtkJ7yxsmwFuntRqxO0MqT9nt6e7e9SwQjxjCdsMZHjzFUIhWTY3bhyS3I+WjmqB6WWJbk/tRk0evzJhj4i8kf29Aap0QqqhCsTyeThXShtTT2rVrVZNw6J5cOebK8x8Ujugn3sslsPB1PxTbZHBnxqIvMrMZ9w1OY+WgDrZwsZuPZMzpo7YvWU3PyUhUfsJS6/Gd6d/szuWLctNA4OJkdQNDKP9O6Z1XpwapESM5+RViQiyBhOP6wJ4FvelDtcNNPvN3Ae26G7UbYkOUMhtJ+zhyMmX5ySD03MYJO/MGSvpKljtiIGTjm1DekclMTU9FQEYxGvcqnv/19pzUa7ahwrL3xR/1Rf2gcWLMkN28UoC5grmglM0VRjer4bUfLPWHdkXKpA5WOWW8hSxlQRQrOjTNHi5lUkkuWl5mWkA+q3o/hpqJQUeTqv3UECAUtSHGlAzbB1BjYVO8vLI17nPMFIQGErPFSk/dAukKd88IeDgkYB6iBdCBnnfQEPjj2Wra+GR0cN7waNZbEthMYJqsgJblIwZms8QG8UU10GXjOGUcF9AFposLHJL5ZWf4ELOVDdlTx+S4IykYW5BPITUHgI0I4BF1ARj6AZV9kTp6NNlqZ/DEeIJcxWMMNU6ICMz/wkdWDQ+2ZhbS+9GewS5h1hpkmtQ6ORj964hN+J/WjT0ejj/oEbne4uqHMy0B3v+vrcLlcPqm/bw513srA7eoHssbLYNx6r13K0LekoZHdH62lt6Qp4mdQkXsbhcn90xbA0klFyk6uKDBC/OT88iLOmG/g08+/wDtCp6EyyxateeNIraHst+LMtSffpm03IuK9EZtQccbzFnzdZbDP4E2F4dPPv3p4T0uQuispDmU0umwyJXO4ptoyM/CjUdrfcUMv219ZMwJfIUNpIREQbKutpH4cw7leQ+PJwVKGKoKB5VHvIAzOy/5qCxl6KsDoqNHvOd57xPLak1qQZ1vaBHaDCsnXklA505TtbkNnuuAczaVScCOLkkKM7bwowHbiZSvmhA/coTkXRKhoDegIPOkwhssjlfilsXxRp4JzGrFv+CWAD4B0YY3UwadQOJwPbvLJHuhxyEqjnxG1KcRdOpLOzO5I2krsIt5Jxx+5Lx9Nk8N+62hOjjeMYe/PxcoOTrc9LIHR+u/Aur3NtBSC+U83ddDK74/tRB5DrvYf5lfkFjKnbrR+pqIncfFEJELJnLQfzrnzt5fvYHE2nh7wj3+huCfvLl6/eX/1hp3hRtomrOchkSLVqAc7Hb4FHY+2zZ44/pdfjjo+EWgVJlahjLQxpmbTMb7bo/eku0RUzAjTW7HZcIH+6NR2y+KfGnJMJ+8SsUAnMeM5f3u3TXouwhTxkdYdQycdTq55e16umpbWHHFoJlOtxnmekw1fXDskrZcfrq5FIrLuzas2Bes4XPJ7GC5FKuKzWRyC8cWKZRuhUJcNlpETRZtMn7iDHnKvx8i9uh8cVf9JrwceHpKyNgz+n4N6VmGzaXnddrtb3376rEaX2H41H9/ddrv9B0HQNqQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,f={},x=[];function k(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(j.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,s.jsx)(c(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,s.jsx)(j.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:void 0}),"\n",(0,s.jsx)(d(),{title:"Body",body:{description:"Provide below parameter to create contact",content:{"application/json":{schema:{required:["email","name"],type:"object",properties:{name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"1232131321"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/18b84479.33c9f705.js b/assets/js/18b84479.33c9f705.js new file mode 100644 index 000000000..ff55be753 --- /dev/null +++ b/assets/js/18b84479.33c9f705.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>P,default:()=>v,frontMatter:()=>j,metadata:()=>d,toc:()=>x});const d=JSON.parse('{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.1/deletedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletedocument","permalink":"/docs/API-docs/v1.1/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnejDEx1sgYsQMD62kYlFiSGFMkQ1LdbjQE5JA3yCnXfbR5kkVRP622PZMMdjcXu1Ws36+KVcUdC7z0LL1jb0ze1KiDZ6uECfS5kzZIo1nKbiqEN6gwIIieC86uLoArZTYetqaBYMBhbdYI3mIuC5nvWQtnamJyI8nPWcKMRcfJwoVgKRNR/8DAEma54zUGdOTdjmleI7H1DPdSsIRJ8s7yULGnLl85s5YCwWQ/Yh4uBJhi71Aw0JljCXP4UyMdCpYG12DCfNgqMuRlbRUx4KNVRiBLC648MeQV1pylOxa2NnIGJ3XJElYYV/MwpeAjj1pSZquTrDrhXrC2XZFVb4326EnPyXJJ/w4DGNLReyrAN3mO3heNUtu/sITlRgdCKt0xbq2SecRy8aMn8d1zNzskCFhHyAfZGR8Aeimgvfv/eCTn7bf2NWuTIVdn4dNCJ8uT10fHy6Pl326Ov0pP/55++dV8uVz+iyXssVYkOySVByS9QQa1/26fsXU5mzL2lJaYT1+C8drUGCqpS9gQmBtndJmAVcg9QnBb4CWXGhQP6P6HqKJzxn0anc/zrJ1ELbWSGu+HGro/XS7vj0cQTj9RS9oEKEyjxZ8b6kv2Px3Q6f3rMaAvnwd0oddcSRGb0I15QP3nxjM1Hzrzz6tVdkzxnB0EO6V3QXrMGyfDNna6xyNu5VF3nt6tqF1QpZh9l4zdMVQsZYuhpy12k87YMlLp1kPvbJxiKatCsD5dLDzXIjOPc2NRe1lqxTM/z0294FYu1sfzY9YmT2W4tZ/Fj83R54r4wEupy9+TW+3RuqaMdkk7wGxMHbfyn7hlyZCSKVc/PCrkAl1Mn9SFicJ9ot5Z1Ney1DHN0fjTIXOLKjc10jwJFcJsNoh8+OXfo9RsNg6eWJDz9/q9ftc4sGaDrmgUcC2gUPgoM4VRDOt4Nk5Wj7xW6L3agtQBS8dpEstSBq6AcKIuknPLM6kk1TGxmW7kTq6Cn8NthaFCR0d/dQgcBK5RUfkDb4KpeSBV46DcGPdQ0IxPgEPWeKnRe0BdcZ0T45CJBIwDrgF1QGed9Ag+OPJadr4ZHRzPA9Rc8xJJdwJTsAQqSeUKzmSND+CNaqLLELhUxqGAISCNKHwE8Zwms0Mgam5q67CislkjlI0U6BPIjUDw8dpSCFpAhj6AJV9kjp6UNlqZ/CEmkGYrWENdRHJFK8PURxIPjmtPc77fZ/ocjIBZZ2hIY+fgbPaDR8rwpdQPPp3N3usjuBvr6hYzLwOuvhiuwGazeVb6rw5l3srwbZPB92iNl8G47V66lKFqsnhdpkrGj07TW9QY62dyGfY6hMn989tH1EWFyi6uMVCF+MXZ1UVsvK/gw8+/wiVyp6Eym65a88ah2kI5mCLkusx3sI19EwoTC68ixPOu+GghQx8GBG8rHj78/JuH73ADUvdXikKZza6aTMkcbrC2NCb9bJbCNw7JZBhoECoeIOcaMgRfcSqlteTAwXbSSuqHOZzpLTQeHWxkqGIxED3KHYRBuOzXWMi4RwFGR4nB5nzvEdFrj2qNnnTR/MsQUEja6ELlTFN21qbO9ME5LKRScCtFiSHGdiYE2J686chxl927gwVdiFDhFrhD8KjDHK6eiMSTxlrjyAvZOV8YWuYpAaiFNVIHn4JwvAh7/cm+0HOCWRr9AqmDkI9wJL2aMSXdTewjHqnz99SUnzTyw37rsMD4iIhh7/NiZV9Od0NZAlXrf1PWNLGpa/E8LhRYc6m6ifL1Uz1xuKOr/bviGt1a5thPtY/c6EVkXrCEKZmj9jhZGs7eXl3C+vV8yZLJePwDl3txefHN+XfX5+QMNdIOsOP5cr4kkjU+1FxPLPXvuTf7B9cB1rv9OvV/ev71MzrgY1hYxWVckmLMu367uWOT52A6ffmtElYZH4hlt6M7+INTbUvknxp0tEatErbmTvKMRvndjgnp6bcYn3EfjfaL7/sX4Sv4w4/IF2MZlhBNG8iaq4a+WMIecPvkIduu2mTYRMjZjuMsz9GGieyzrfZgNXxzfnl+c84SRv30cAl6iEtQ/4MMvOja4XbU+UB/aVV7UWC36xasth35u6OPSvQxDtyE06pt2/8AT6PPnQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"}}');var s=n(74848),o=n(28453),i=n(33617),c=n.n(i),a=n(17543),l=n.n(a),r=n(86013),u=n.n(r),p=n(63723),m=n.n(p),h=(n(18766),n(79329),n(9303));const j={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnejDEx1sgYsQMD62kYlFiSGFMkQ1LdbjQE5JA3yCnXfbR5kkVRP622PZMMdjcXu1Ws36+KVcUdC7z0LL1jb0ze1KiDZ6uECfS5kzZIo1nKbiqEN6gwIIieC86uLoArZTYetqaBYMBhbdYI3mIuC5nvWQtnamJyI8nPWcKMRcfJwoVgKRNR/8DAEma54zUGdOTdjmleI7H1DPdSsIRJ8s7yULGnLl85s5YCwWQ/Yh4uBJhi71Aw0JljCXP4UyMdCpYG12DCfNgqMuRlbRUx4KNVRiBLC648MeQV1pylOxa2NnIGJ3XJElYYV/MwpeAjj1pSZquTrDrhXrC2XZFVb4326EnPyXJJ/w4DGNLReyrAN3mO3heNUtu/sITlRgdCKt0xbq2SecRy8aMn8d1zNzskCFhHyAfZGR8Aeimgvfv/eCTn7bf2NWuTIVdn4dNCJ8uT10fHy6Pl326Ov0pP/55++dV8uVz+iyXssVYkOySVByS9QQa1/26fsXU5mzL2lJaYT1+C8drUGCqpS9gQmBtndJmAVcg9QnBb4CWXGhQP6P6HqKJzxn0anc/zrJ1ELbWSGu+HGro/XS7vj0cQTj9RS9oEKEyjxZ8b6kv2Px3Q6f3rMaAvnwd0oddcSRGb0I15QP3nxjM1Hzrzz6tVdkzxnB0EO6V3QXrMGyfDNna6xyNu5VF3nt6tqF1QpZh9l4zdMVQsZYuhpy12k87YMlLp1kPvbJxiKatCsD5dLDzXIjOPc2NRe1lqxTM/z0294FYu1sfzY9YmT2W4tZ/Fj83R54r4wEupy9+TW+3RuqaMdkk7wGxMHbfyn7hlyZCSKVc/PCrkAl1Mn9SFicJ9ot5Z1Ney1DHN0fjTIXOLKjc10jwJFcJsNoh8+OXfo9RsNg6eWJDz9/q9ftc4sGaDrmgUcC2gUPgoM4VRDOt4Nk5Wj7xW6L3agtQBS8dpEstSBq6AcKIuknPLM6kk1TGxmW7kTq6Cn8NthaFCR0d/dQgcBK5RUfkDb4KpeSBV46DcGPdQ0IxPgEPWeKnRe0BdcZ0T45CJBIwDrgF1QGed9Ag+OPJadr4ZHRzPA9Rc8xJJdwJTsAQqSeUKzmSND+CNaqLLELhUxqGAISCNKHwE8Zwms0Mgam5q67CislkjlI0U6BPIjUDw8dpSCFpAhj6AJV9kjp6UNlqZ/CEmkGYrWENdRHJFK8PURxIPjmtPc77fZ/ocjIBZZ2hIY+fgbPaDR8rwpdQPPp3N3usjuBvr6hYzLwOuvhiuwGazeVb6rw5l3srwbZPB92iNl8G47V66lKFqsnhdpkrGj07TW9QY62dyGfY6hMn989tH1EWFyi6uMVCF+MXZ1UVsvK/gw8+/wiVyp6Eym65a88ah2kI5mCLkusx3sI19EwoTC68ixPOu+GghQx8GBG8rHj78/JuH73ADUvdXikKZza6aTMkcbrC2NCb9bJbCNw7JZBhoECoeIOcaMgRfcSqlteTAwXbSSuqHOZzpLTQeHWxkqGIxED3KHYRBuOzXWMi4RwFGR4nB5nzvEdFrj2qNnnTR/MsQUEja6ELlTFN21qbO9ME5LKRScCtFiSHGdiYE2J686chxl927gwVdiFDhFrhD8KjDHK6eiMSTxlrjyAvZOV8YWuYpAaiFNVIHn4JwvAh7/cm+0HOCWRr9AqmDkI9wJL2aMSXdTewjHqnz99SUnzTyw37rsMD4iIhh7/NiZV9Od0NZAlXrf1PWNLGpa/E8LhRYc6m6ifL1Uz1xuKOr/bviGt1a5thPtY/c6EVkXrCEKZmj9jhZGs7eXl3C+vV8yZLJePwDl3txefHN+XfX5+QMNdIOsOP5cr4kkjU+1FxPLPXvuTf7B9cB1rv9OvV/ev71MzrgY1hYxWVckmLMu367uWOT52A6ffmtElYZH4hlt6M7+INTbUvknxp0tEatErbmTvKMRvndjgnp6bcYn3EfjfaL7/sX4Sv4w4/IF2MZlhBNG8iaq4a+WMIecPvkIduu2mTYRMjZjuMsz9GGieyzrfZgNXxzfnl+c84SRv30cAl6iEtQ/4MMvOja4XbU+UB/aVV7UWC36xasth35u6OPSvQxDtyE06pt2/8AT6PPnQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},P=void 0,f={},x=[];function M(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(M,{...e})}):M(e)}}}]); \ No newline at end of file diff --git a/assets/js/18b84479.781d6d29.js b/assets/js/18b84479.781d6d29.js deleted file mode 100644 index 5a7d0a5f2..000000000 --- a/assets/js/18b84479.781d6d29.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>y,default:()=>O,frontMatter:()=>f,metadata:()=>o,toc:()=>I});const o=JSON.parse('{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.1/deletedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletedocument","permalink":"/docs/API-docs/v1.1/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V91u20YWfpWzc7ONQEuy47Yor9ZtjNRYNzFqFwbqCMaIPCSnGs5MZw4lC4KAXvQNetXbPlqeZHGGpETZTrbBdnuTWIfn//ebjSBZBpHeiVc2a2o0FMQsETmGzCtHyhqRipsK4RVqJIS844KzqwuQWttVgLVtgCx4rO0SITjMVKGyPWvhbc1MfkcKY5EI69BLtnCRi1TkUX/PIBLhpJc1Enr2biOMrJHZOoZ7lYtEKPbOSarEY5evvF2qHMHOf8KMLnKwxd4hstCaE4nw+HOjPOYiJd9gIgKtNRsKqnaaGfDBaZujSAupAzNkFdZSpBtBaxc5yStTikQU1teShhR8kFFLKlx1Mq9OZMjFdjtjq8FZEzCwnpPplP87DKAvR+dpDqHJMgyhaLRe/0MkIrOGOFPpRkjntMpiLic/BRbfPHWzzQQn1nPmSbXG+wQ9F9De/a8f2Hn3rXsptklfqzP6uNDJ9OTl0fH0aPrlzfEX6elX6edfjKfT6Y8iEQ+1Ztm+qJKQ9ZIivf+9fcLW1mzI2FG2zHz6XBqvbY1UKVPCipO58taUCTiNMiCQX4MspTKgJaH/C7OK3lv/8ex8mmfbQdTKaGXwvu+h+9Pp9P54l4TTj/SSsQSFbUz+94b6nP2PB3R6/3IX0OdPA7owS6lVHpfQjV2g+XvjGZqn1vzTblUtU/wuDoId0tsgA2aNV7SOm+7hSDp11H5P72a8LrhT7H5Lxu1IlUjFpN9pk81gM24Fq/TLfnc+GomVLEv03zbzGMBZQxa+s9mijbLxWqSiInIhnUyWylOraRxasaqZjzNbT6685FX0Ri4X0k+sQzM5Hk/HU7FNNo+UBGnyuX0YM1NQpdFyHqIO6dRkeTw+fkZGOvdJ/NgcfapIIFkqU/43udm+PNfcQm2XHBRp1yvSqX/jWiR9Dwy5umtVoczRx35RprBRuOuMtw7NtSpNLEs0/viq3aLObI18wKhCGI16kfe//rGTGo12ly5OwPideWfeNh6cXaEvGg3S5FBofFBzjVEM6/htd8oDylpjCHoNyhCWXvLpV6UiqYHzxGsrk07OlVY8OMxm2xs/mL0whtsKqULPn/7pESTkuETN8wayIVtLYlW7y7yyflEwqEhAwrwJymAIgKaSJmPGvhIJWA/SABpC77wKCIE8e61a36whLzOCWhpZIutOYJisHLXi+QBv500gCFY30WUgqbT1mEMfkEHMQ0ziOUMBj8DUzNbOY8Vts0QoG5VjSCCzOUKIe4JDMDnMMRA49kVlGFhpY7TNFrGAPEHgLK8tJTVjlKGPLE5emsDAogNQXQ12CXPeMirA1sHR6IeAXOFLZRYhHY3emSO42/XVLc6DIpx91o/AarV60vovDmVeK+JN8T06GxRZv95Ll4r6bTBUsvvRanqNBmP/DIZhryO3WXg6fUydVKjd5BqJOyRMzq4u4qZ/Ae9/+Q0uUXoDlV213Zo1HvUayt4UZ66tfJu23aKGwsbGqzjjWdt8jAAxUJ/B20rS+19+D/AGV6BMN1Icymh01cy1yuAGa8d3OYxGKXzjkU1STwOqJEEmDcwRQiW5lZZKggTXSmtlFmM4M2toAnpYKapiMzA9yh2EwXnZ42aYy4A5WBMlepvjvUdMrwPqJQbWxQd3joC5YghJlbdN2VobOtMF57FQWsOtykukGNtZnoPryKuWHMHz3h0seCCowjVIjxDQ0BiuHonEL41z1rMXqnW+sPx64AKgyZ1VhkIKuZcF7fUn+0bPOM3KmmdIbQrlLh1Jp2ZXknYSu4h31PE7XsqPFvnhvvVYYHy1xLD3dXGqa6e7vi2Bu/V/aWuGCLy1ZBYRDNZS6fai/Ouxnogm0NfhbXGNfqky7K7aByZ6EpknIhFaZWgCDlDK2eurS1i+HE8PTv+fGO7J5cU352+uz9kZXqRtwnoIIJwNVEszsNQ9IF/tX3gHud7s8dv/6b3Z3WjCB5o4LVVEZTHmTQen7sTg/ZkOn5qzRFQ2ELNsNjyDP3i93TL55wY947ZZIpbSKznnU86YSwX+O9+9Gz8Y7Wffd0/QF/CnX63PxtKDEMMIZCl1w79EIha4fvRy3s62SY9E2NmW4yzL0NFA9gmMPsCir84vz2/ORSJ4nx6CoEUEQd0fbOBZ1w7RUesD/8tQ7VmBzaYFWNvtjr/99EGJLsaem/M02263/wF3NPdI","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"}}');var s=n(74848),i=n(28453),a=n(33617),d=n.n(a),l=n(17543),p=n.n(l),r=n(86013),c=n.n(r),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const f={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V91u20YWfpWzc7ONQEuy47Yor9ZtjNRYNzFqFwbqCMaIPCSnGs5MZw4lC4KAXvQNetXbPlqeZHGGpETZTrbBdnuTWIfn//ebjSBZBpHeiVc2a2o0FMQsETmGzCtHyhqRipsK4RVqJIS844KzqwuQWttVgLVtgCx4rO0SITjMVKGyPWvhbc1MfkcKY5EI69BLtnCRi1TkUX/PIBLhpJc1Enr2biOMrJHZOoZ7lYtEKPbOSarEY5evvF2qHMHOf8KMLnKwxd4hstCaE4nw+HOjPOYiJd9gIgKtNRsKqnaaGfDBaZujSAupAzNkFdZSpBtBaxc5yStTikQU1teShhR8kFFLKlx1Mq9OZMjFdjtjq8FZEzCwnpPplP87DKAvR+dpDqHJMgyhaLRe/0MkIrOGOFPpRkjntMpiLic/BRbfPHWzzQQn1nPmSbXG+wQ9F9De/a8f2Hn3rXsptklfqzP6uNDJ9OTl0fH0aPrlzfEX6elX6edfjKfT6Y8iEQ+1Ztm+qJKQ9ZIivf+9fcLW1mzI2FG2zHz6XBqvbY1UKVPCipO58taUCTiNMiCQX4MspTKgJaH/C7OK3lv/8ex8mmfbQdTKaGXwvu+h+9Pp9P54l4TTj/SSsQSFbUz+94b6nP2PB3R6/3IX0OdPA7owS6lVHpfQjV2g+XvjGZqn1vzTblUtU/wuDoId0tsgA2aNV7SOm+7hSDp11H5P72a8LrhT7H5Lxu1IlUjFpN9pk81gM24Fq/TLfnc+GomVLEv03zbzGMBZQxa+s9mijbLxWqSiInIhnUyWylOraRxasaqZjzNbT6685FX0Ri4X0k+sQzM5Hk/HU7FNNo+UBGnyuX0YM1NQpdFyHqIO6dRkeTw+fkZGOvdJ/NgcfapIIFkqU/43udm+PNfcQm2XHBRp1yvSqX/jWiR9Dwy5umtVoczRx35RprBRuOuMtw7NtSpNLEs0/viq3aLObI18wKhCGI16kfe//rGTGo12ly5OwPideWfeNh6cXaEvGg3S5FBofFBzjVEM6/htd8oDylpjCHoNyhCWXvLpV6UiqYHzxGsrk07OlVY8OMxm2xs/mL0whtsKqULPn/7pESTkuETN8wayIVtLYlW7y7yyflEwqEhAwrwJymAIgKaSJmPGvhIJWA/SABpC77wKCIE8e61a36whLzOCWhpZIutOYJisHLXi+QBv500gCFY30WUgqbT1mEMfkEHMQ0ziOUMBj8DUzNbOY8Vts0QoG5VjSCCzOUKIe4JDMDnMMRA49kVlGFhpY7TNFrGAPEHgLK8tJTVjlKGPLE5emsDAogNQXQ12CXPeMirA1sHR6IeAXOFLZRYhHY3emSO42/XVLc6DIpx91o/AarV60vovDmVeK+JN8T06GxRZv95Ll4r6bTBUsvvRanqNBmP/DIZhryO3WXg6fUydVKjd5BqJOyRMzq4u4qZ/Ae9/+Q0uUXoDlV213Zo1HvUayt4UZ66tfJu23aKGwsbGqzjjWdt8jAAxUJ/B20rS+19+D/AGV6BMN1Icymh01cy1yuAGa8d3OYxGKXzjkU1STwOqJEEmDcwRQiW5lZZKggTXSmtlFmM4M2toAnpYKapiMzA9yh2EwXnZ42aYy4A5WBMlepvjvUdMrwPqJQbWxQd3joC5YghJlbdN2VobOtMF57FQWsOtykukGNtZnoPryKuWHMHz3h0seCCowjVIjxDQ0BiuHonEL41z1rMXqnW+sPx64AKgyZ1VhkIKuZcF7fUn+0bPOM3KmmdIbQrlLh1Jp2ZXknYSu4h31PE7XsqPFvnhvvVYYHy1xLD3dXGqa6e7vi2Bu/V/aWuGCLy1ZBYRDNZS6fai/Ouxnogm0NfhbXGNfqky7K7aByZ6EpknIhFaZWgCDlDK2eurS1i+HE8PTv+fGO7J5cU352+uz9kZXqRtwnoIIJwNVEszsNQ9IF/tX3gHud7s8dv/6b3Z3WjCB5o4LVVEZTHmTQen7sTg/ZkOn5qzRFQ2ELNsNjyDP3i93TL55wY947ZZIpbSKznnU86YSwX+O9+9Gz8Y7Wffd0/QF/CnX63PxtKDEMMIZCl1w79EIha4fvRy3s62SY9E2NmW4yzL0NFA9gmMPsCir84vz2/ORSJ4nx6CoEUEQd0fbOBZ1w7RUesD/8tQ7VmBzaYFWNvtjr/99EGJLsaem/M02263/wF3NPdI",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,v={},I=[];function P(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(d(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function O(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.e44b2367.js b/assets/js/19e5ad2a.e44b2367.js new file mode 100644 index 000000000..c20dc0d90 --- /dev/null +++ b/assets/js/19e5ad2a.e44b2367.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>V,contentTitle:()=>g,default:()=>T,frontMatter:()=>u,metadata:()=>i,toc:()=>x});const i=JSON.parse('{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/v1.1/contactlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/contactlist","permalink":"/docs/API-docs/v1.1/contactlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar_label":"Get Contact list","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tu5LgR/ZUKX5JtyH3xzGwQPa0xGDhGjB0j9sJAPMaAkqoluimSS5a63Wg0sA/5gzzlNZ82XxIUdWm17dmNk8UigGFbxbpfWIc7QbIMIr0T760hmVMQ94koMOReOVLWiFTcVAjdKVyqQHB2dQFYO7tBH2BrGyALHskrXCNI0Mxjl5B3GhNw3q5VoUwJEnJbO48VmqDWCGuFG+aVWoNcS6VlpnGQBGVYv+8JmbWrqUiEdegle3dRiFR0h2xWJMJJL2sk9BzVThhZo0iFVrXiU8UB/dig34pEePyxUR4LkS6lDpiIQFvN3Evra5EIfHTaFihS8g2f5hXWUqQ7UctHVTe1SN/N54mgrWMh09QZerFnOVk7VrSY75PBhbBS7lfz4Os25/t71hucNQED857O5/znuKihyXMMYdloGLIpkphLNMT80jmt8ngwewgstHvugM0eMI9p96yGVGvSY2g0jfik95IDVoR1+GX5lszVHTgDeWVKkcTUSBpThtiFqxZZ9Xj64Dglbd5fp+DBImSIMaO1VPq/kM8Qv+sI09zWrMpV1rzalbeLN4vT+MMqeGyk2b5WiXU8aKVhFQ82+0yK9Ks9KXAdXfAoCYszekn+wH06P31zspifzP94s/g2ffun9N230/l8/jeRiMc6JrQbiEJSTHTn0/DduOI3sLN/ytZdIwWSVDqMBboTsd+PiMpoZfBzP2mfecr2kePtS/N2bWukiq/ADRqCjbemTMBplAGB/BZkKZUBLQn97369QUTvrf/5PL7Os59Lwdv5/PNiSMK750m4MGupVREXyI1dofltIx2bp9b88zZQLVM8F0fBjultkAHzxivaxk3zeCKdOmnP07t7voY5sZZXVIntaqJKpGJ2vLAC+nW/rRqvRSoqIhfS2SxIU2T2cdoPsZZZ4CtlJp2arRdTvhieykjnXsWPzclrRQLJUpnyl+TuD/m55hq2ZTrK0mE9OPUX5P3QFWHM1a3MCmXBq27P30sbhbvSfHRorlVpYmGj8acQ5hZ1bmtkoEIVwmTSi3z5+78GqckECps3NRqKLTj9ZD6Zj42HiHR4U0pTwFLjo2KQ8hIKCihrjSHoLShDWHpJCIUqFUkNnCces1w6mSmtuHOZzbYYZ9T8YQq3FVKFno9+7xlVFbhGzQ0PsiFbS2JVvb+wsX611HYTEpCQNUEZDAHQVNLkzNhXIgHrQRpAQ+idVwEhkGevVeubNeQZ6NXSyBJZdwLjZBWoFbcreJs1gSBY3USXga9N67GAPiCDWISYxA8MYzxCC+XG+K9sVIEhgdwWCCEOKodgCsgwEDj2ReUYWGljtM1XsYDLRmtwlu8NJTUDyLGPLE5emsBLrfWlr8GQMOct4x9sHZxMfgjIFb5UZhXSyeSTOYG7oa9uMQuK8P4P/QhsNptnrf/Nscy5oj83GfwVnQ2KrN8epEtFVZPFcRkrGT5aTedoMPbPaBgOOgqbh+fTx9RZhdrNrpG4Q8Ls7OoiXrXfwJef/gGXKL2Bym7abs0bj3oLZW+KM9dWvk3bcFPC0sbGqzjjedt8DF4xUJ/B20rSl5/+GeB73DBwb0eKQ5lMrppMqxxusHa8R8JkksL7CCeAehpQJQlyaSBDCJXkVlorCRJcK62VWU3hzGyhCehho6iKzcD0KHcUBudlKHeATAYswJoo0ducHjxieh1QrzGwLmOJ3cBCEXd05W1TttbGznTBeVwqreFWFSVSjO2sKMB15E1L5oSP3MElDwRVuAXpEQIamsLVE5F40jhnPXuhWueXVmu74QKgKZxVhkIKhZdLOuhPDo0eUZuy5gVSm0I5pCPp1AwlaSexi3igTj/xpfzkIj++bz0u0bPBGPahLk517XTXtyVwt/4vbd2C4xagMQxoUTtvlO+e6onrHH0dPi6v0a9Vjt1W+8pEzyLzTCRCqxxNwBFMODu/uoT1m+lcJKP1+B8M9+zy4v2H768/sDN8kbYJW0zn03l8KthAtTQjS+dIw/O7gwxHyd4dENT/4VO9W/CEjzRzWqqIqWLCdh0eujt6wN8norKBmLzb8dD+4PV+z+T2zcwoqVCBbR9ezSvcjt74a6kbthmhy1d4u8f4gfWeP7xi3ojekh5wsMFW5izP0Y0NPIOrR5jv/MONSATfmcdAZxWBTvcPa++PzHak+xgBtQ7wb47pRYHdrgVR+/3A3x59VaILsOfm0tzv9/t/A7ATTaM=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"}}');var s=o(74848),a=o(28453),n=o(33617),r=o.n(n),l=o(17543),c=o.n(l),p=o(86013),d=o.n(p),m=o(63723),h=o.n(m),b=(o(18766),o(79329),o(9303));const u={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tu5LgR/ZUKX5JtyH3xzGwQPa0xGDhGjB0j9sJAPMaAkqoluimSS5a63Wg0sA/5gzzlNZ82XxIUdWm17dmNk8UigGFbxbpfWIc7QbIMIr0T760hmVMQ94koMOReOVLWiFTcVAjdKVyqQHB2dQFYO7tBH2BrGyALHskrXCNI0Mxjl5B3GhNw3q5VoUwJEnJbO48VmqDWCGuFG+aVWoNcS6VlpnGQBGVYv+8JmbWrqUiEdegle3dRiFR0h2xWJMJJL2sk9BzVThhZo0iFVrXiU8UB/dig34pEePyxUR4LkS6lDpiIQFvN3Evra5EIfHTaFihS8g2f5hXWUqQ7UctHVTe1SN/N54mgrWMh09QZerFnOVk7VrSY75PBhbBS7lfz4Os25/t71hucNQED857O5/znuKihyXMMYdloGLIpkphLNMT80jmt8ngwewgstHvugM0eMI9p96yGVGvSY2g0jfik95IDVoR1+GX5lszVHTgDeWVKkcTUSBpThtiFqxZZ9Xj64Dglbd5fp+DBImSIMaO1VPq/kM8Qv+sI09zWrMpV1rzalbeLN4vT+MMqeGyk2b5WiXU8aKVhFQ82+0yK9Ks9KXAdXfAoCYszekn+wH06P31zspifzP94s/g2ffun9N230/l8/jeRiMc6JrQbiEJSTHTn0/DduOI3sLN/ytZdIwWSVDqMBboTsd+PiMpoZfBzP2mfecr2kePtS/N2bWukiq/ADRqCjbemTMBplAGB/BZkKZUBLQn97369QUTvrf/5PL7Os59Lwdv5/PNiSMK750m4MGupVREXyI1dofltIx2bp9b88zZQLVM8F0fBjultkAHzxivaxk3zeCKdOmnP07t7voY5sZZXVIntaqJKpGJ2vLAC+nW/rRqvRSoqIhfS2SxIU2T2cdoPsZZZ4CtlJp2arRdTvhieykjnXsWPzclrRQLJUpnyl+TuD/m55hq2ZTrK0mE9OPUX5P3QFWHM1a3MCmXBq27P30sbhbvSfHRorlVpYmGj8acQ5hZ1bmtkoEIVwmTSi3z5+78GqckECps3NRqKLTj9ZD6Zj42HiHR4U0pTwFLjo2KQ8hIKCihrjSHoLShDWHpJCIUqFUkNnCces1w6mSmtuHOZzbYYZ9T8YQq3FVKFno9+7xlVFbhGzQ0PsiFbS2JVvb+wsX611HYTEpCQNUEZDAHQVNLkzNhXIgHrQRpAQ+idVwEhkGevVeubNeQZ6NXSyBJZdwLjZBWoFbcreJs1gSBY3USXga9N67GAPiCDWISYxA8MYzxCC+XG+K9sVIEhgdwWCCEOKodgCsgwEDj2ReUYWGljtM1XsYDLRmtwlu8NJTUDyLGPLE5emsBLrfWlr8GQMOct4x9sHZxMfgjIFb5UZhXSyeSTOYG7oa9uMQuK8P4P/QhsNptnrf/Nscy5oj83GfwVnQ2KrN8epEtFVZPFcRkrGT5aTedoMPbPaBgOOgqbh+fTx9RZhdrNrpG4Q8Ls7OoiXrXfwJef/gGXKL2Bym7abs0bj3oLZW+KM9dWvk3bcFPC0sbGqzjjedt8DF4xUJ/B20rSl5/+GeB73DBwb0eKQ5lMrppMqxxusHa8R8JkksL7CCeAehpQJQlyaSBDCJXkVlorCRJcK62VWU3hzGyhCehho6iKzcD0KHcUBudlKHeATAYswJoo0ducHjxieh1QrzGwLmOJ3cBCEXd05W1TttbGznTBeVwqreFWFSVSjO2sKMB15E1L5oSP3MElDwRVuAXpEQIamsLVE5F40jhnPXuhWueXVmu74QKgKZxVhkIKhZdLOuhPDo0eUZuy5gVSm0I5pCPp1AwlaSexi3igTj/xpfzkIj++bz0u0bPBGPahLk517XTXtyVwt/4vbd2C4xagMQxoUTtvlO+e6onrHH0dPi6v0a9Vjt1W+8pEzyLzTCRCqxxNwBFMODu/uoT1m+lcJKP1+B8M9+zy4v2H768/sDN8kbYJW0zn03l8KthAtTQjS+dIw/O7gwxHyd4dENT/4VO9W/CEjzRzWqqIqWLCdh0eujt6wN8norKBmLzb8dD+4PV+z+T2zcwoqVCBbR9ezSvcjt74a6kbthmhy1d4u8f4gfWeP7xi3ojekh5wsMFW5izP0Y0NPIOrR5jv/MONSATfmcdAZxWBTvcPa++PzHak+xgBtQ7wb47pRYHdrgVR+/3A3x59VaILsOfm0tzv9/t/A7ATTaM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,V={},x=[];function P(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,s.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,s.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(c(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function T(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.e69f4137.js b/assets/js/19e5ad2a.e69f4137.js deleted file mode 100644 index 01374c670..000000000 --- a/assets/js/19e5ad2a.e69f4137.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>I,contentTitle:()=>f,default:()=>j,frontMatter:()=>v,metadata:()=>i,toc:()=>F});const i=JSON.parse('{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/v1.1/contactlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/contactlist","permalink":"/docs/API-docs/v1.1/contactlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar_label":"Get Contact list","hide_title":true,"hide_table_of_contents":true,"api":"eJzNWF9v47gR/ypTvrRnKP6T3b2ifrpgsUiDbneDSw4Bmg0WlDSWGFMkjxzZMQwD99Bv0Ke+9qPtJymGlGw5yd417eFQIEii4cxw/s9P2gqSVRDzW/HWGpIFBXGXiRJD4ZUjZY2Yi+saoTuF9yoQnF1eADbOrtEH2NgWyIJH8gpXCBI089gFFJ3GDJy3K1UqU4GEwjbOY40mqBXCSuGaeaXWIFdSaZlr3EuCMqzf94Tc2uVYZMI69JKtuyjFXHSHfK3IhJNeNkjo2autMLJBMRdaNYpPFTv0Y4t+IzLh8cdWeSzFfCF1wEwE2mjmXljfiEzgg9O2RDEn3/JpUWMjxXwrGvmgmrYR8zfTaSZo41jItE2OXuxYTjaOFc2mu2xvQlgq96tZ8PU7p7s71hucNQED855Op/znOKmhLQoMYdFq2EdTZDGWaIj5pXNaFfFgch9YaPvUAJvfYxHD7lkNqXSlx9BqGvBJ7yU7rAib8MvyiczZ3XMG8spUIouhkTSk7H0Xrp7l9cPpveOQpLi/TMG9RcgRY0QbqfR/IZ8jftcRxoVtWJWrrXmxKa9nr2an8YdVcNtIs3mpEuu40SrDKu5t/pkU6RdbUuIqmuBREpZn9Jz8gft0evrqZDY9mf7xevbt/PWf5m++HU+n07+JTDw0MaBdQ5SSYqA7m/bPrSt/g3t2j9m6MVIiSaXDUKA7EbvdgKiMVgY/9532mbtsFzleP9dvV7ZBqnkErtEQrL01VQZOowwI5DcgK6kMaEnof/frNSJ6b/3Px/Fllv1cCF5Pp59n+yC8eRqEC7OSWpVxgVzbJZrf1tPh9ZSuf1oGKjHFc3Hk7JCenAxYtF7RJm6ahxPp1Ek6n9/e8RjmwFpeURWm1US1mIvJ8cIK6Ff9tnpUM2tZVej/3ObR5LOWLPzVFsvkV+u1mIuayIX5ZLJSnpKmcUhidZvz/Jlcerlotf4gV0vpJzwQJrPxdDwVvJuOlQRpytw+jPupoWUeog7p1GQ1G8+ekZHOvYgf25OXigSSlTLVL8ndHRJyxUWT6uIoLYd95NRfkBdSl/UhV7eja5Ql79YdPy9sFO5q4aNDc6UqE9MSL3+MmW5QF7ZBRkZUI4xGvciXv/9rLzUaQWmLtkFDsebHn8wn87H1EKEVr2ZpSlhofFCMip6DXQFlozEEvQFlCCsvCaFUlSKpgePEfV1IJ3OlFbcKs9kEqgbdFsZwUyPV6Pno955hXIkr1NxhIFuyjSRW1dsLa+uXC23XIQMJeRuUwRAATS1NwYx9JjKwHqQBNITeeRUQAnm2WiXbrCHPyLKRRlbIujMYBqtErbg/wNu8DQTB6jaaDDynrccSeocMYhliEN8xbvIICTsOAWfVqhJDBoUtEUKcDOyCKSHHQODYFlVgYKWt0bZYxgRyB4GzPKiU1IxYhzayOHlpAm/RZEufg33AnLcMuDAZOBr9EJAz/F6ZZZiPRp/MCdzu6+oG86AI7/7Qt8B6vX5S+t8cy5wr4knxPTobFFm/OUhXivppMFSyf0iaztFgrJ9BMxx0lLYIT7uPqZMatZtcIXGFhMnZ5UWc7d/Al5/+Ae9RegO1XadqLVqPegNVfxVHLmU+hW0/mmFhY+HVHPEiFR+jZQzUR/CmlvTlp38G+IBrflNILcWujEaXba5VAdfYOF5cYTSaw9uIX4B6GlAtCQppIEcIteRSWikJElyS1sosx3BmNtAG9LBWVMdiYHqUO3KD47JPd4BcBizBmijR3zk+WMT0JqBeYWBdxhKbgaUiruja27ZKtw2N6ZzzuFBaw40qK6To21lZguvI60TmgA/MwQU3BNW4AekRAhoaw+UjkXjSOmc9W6GS8QurtV1zAtCUzipDYQ6llws66M8OhR5horLmGVIKodyHI+vU7FOSOrHzeE8df+Kh/GiQH89bjwv0fGF0+5AXp7pyuu3LErha/5eyTmg8IULGHek1gTfKd4/1RPyAvgkfF1foV6rAbqt9paMnkXkiMqFVgSbgAJecnV++h9Wr8fRo9f8HzT15f/H23Yerd2wMD9IUsB4CCGcDNdIMbjpH2r/vdxjlKNjbA2T7P/w20C14wgeaOC1VBHExYNsOgN0efTG4y0RtAzF5u+Wm/cHr3Y7J6SU9wjIV+O7Da/oSN4OPCiupW74zQpev8HZv/wfWO37winkjXMx6wMEXJpmzokA3vOAJPj4CmefvrkUmeGYeA51lBDrdP6y9PzKbge5jBJQM4N/s07MC220CUbvdnj8dfVWic7Dn5tTc7Xa7fwNscHVO","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"}}');var n=a(74848),o=a(28453),r=a(33617),s=a.n(r),c=a(17543),l=a.n(c),p=a(86013),m=a.n(p),d=a(63723),g=a.n(d),u=(a(18766),a(79329),a(9303));const v={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNWF9v47gR/ypTvrRnKP6T3b2ifrpgsUiDbneDSw4Bmg0WlDSWGFMkjxzZMQwD99Bv0Ke+9qPtJymGlGw5yd417eFQIEii4cxw/s9P2gqSVRDzW/HWGpIFBXGXiRJD4ZUjZY2Yi+saoTuF9yoQnF1eADbOrtEH2NgWyIJH8gpXCBI089gFFJ3GDJy3K1UqU4GEwjbOY40mqBXCSuGaeaXWIFdSaZlr3EuCMqzf94Tc2uVYZMI69JKtuyjFXHSHfK3IhJNeNkjo2autMLJBMRdaNYpPFTv0Y4t+IzLh8cdWeSzFfCF1wEwE2mjmXljfiEzgg9O2RDEn3/JpUWMjxXwrGvmgmrYR8zfTaSZo41jItE2OXuxYTjaOFc2mu2xvQlgq96tZ8PU7p7s71hucNQED855Op/znOKmhLQoMYdFq2EdTZDGWaIj5pXNaFfFgch9YaPvUAJvfYxHD7lkNqXSlx9BqGvBJ7yU7rAib8MvyiczZ3XMG8spUIouhkTSk7H0Xrp7l9cPpveOQpLi/TMG9RcgRY0QbqfR/IZ8jftcRxoVtWJWrrXmxKa9nr2an8YdVcNtIs3mpEuu40SrDKu5t/pkU6RdbUuIqmuBREpZn9Jz8gft0evrqZDY9mf7xevbt/PWf5m++HU+n07+JTDw0MaBdQ5SSYqA7m/bPrSt/g3t2j9m6MVIiSaXDUKA7EbvdgKiMVgY/9532mbtsFzleP9dvV7ZBqnkErtEQrL01VQZOowwI5DcgK6kMaEnof/frNSJ6b/3Px/Fllv1cCF5Pp59n+yC8eRqEC7OSWpVxgVzbJZrf1tPh9ZSuf1oGKjHFc3Hk7JCenAxYtF7RJm6ahxPp1Ek6n9/e8RjmwFpeURWm1US1mIvJ8cIK6Ff9tnpUM2tZVej/3ObR5LOWLPzVFsvkV+u1mIuayIX5ZLJSnpKmcUhidZvz/Jlcerlotf4gV0vpJzwQJrPxdDwVvJuOlQRpytw+jPupoWUeog7p1GQ1G8+ekZHOvYgf25OXigSSlTLVL8ndHRJyxUWT6uIoLYd95NRfkBdSl/UhV7eja5Ql79YdPy9sFO5q4aNDc6UqE9MSL3+MmW5QF7ZBRkZUI4xGvciXv/9rLzUaQWmLtkFDsebHn8wn87H1EKEVr2ZpSlhofFCMip6DXQFlozEEvQFlCCsvCaFUlSKpgePEfV1IJ3OlFbcKs9kEqgbdFsZwUyPV6Pno955hXIkr1NxhIFuyjSRW1dsLa+uXC23XIQMJeRuUwRAATS1NwYx9JjKwHqQBNITeeRUQAnm2WiXbrCHPyLKRRlbIujMYBqtErbg/wNu8DQTB6jaaDDynrccSeocMYhliEN8xbvIICTsOAWfVqhJDBoUtEUKcDOyCKSHHQODYFlVgYKWt0bZYxgRyB4GzPKiU1IxYhzayOHlpAm/RZEufg33AnLcMuDAZOBr9EJAz/F6ZZZiPRp/MCdzu6+oG86AI7/7Qt8B6vX5S+t8cy5wr4knxPTobFFm/OUhXivppMFSyf0iaztFgrJ9BMxx0lLYIT7uPqZMatZtcIXGFhMnZ5UWc7d/Al5/+Ae9RegO1XadqLVqPegNVfxVHLmU+hW0/mmFhY+HVHPEiFR+jZQzUR/CmlvTlp38G+IBrflNILcWujEaXba5VAdfYOF5cYTSaw9uIX4B6GlAtCQppIEcIteRSWikJElyS1sosx3BmNtAG9LBWVMdiYHqUO3KD47JPd4BcBizBmijR3zk+WMT0JqBeYWBdxhKbgaUiruja27ZKtw2N6ZzzuFBaw40qK6To21lZguvI60TmgA/MwQU3BNW4AekRAhoaw+UjkXjSOmc9W6GS8QurtV1zAtCUzipDYQ6llws66M8OhR5horLmGVIKodyHI+vU7FOSOrHzeE8df+Kh/GiQH89bjwv0fGF0+5AXp7pyuu3LErha/5eyTmg8IULGHek1gTfKd4/1RPyAvgkfF1foV6rAbqt9paMnkXkiMqFVgSbgAJecnV++h9Wr8fRo9f8HzT15f/H23Yerd2wMD9IUsB4CCGcDNdIMbjpH2r/vdxjlKNjbA2T7P/w20C14wgeaOC1VBHExYNsOgN0efTG4y0RtAzF5u+Wm/cHr3Y7J6SU9wjIV+O7Da/oSN4OPCiupW74zQpev8HZv/wfWO37winkjXMx6wMEXJpmzokA3vOAJPj4CmefvrkUmeGYeA51lBDrdP6y9PzKbge5jBJQM4N/s07MC220CUbvdnj8dfVWic7Dn5tTc7Xa7fwNscHVO",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,I={},F=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,n.jsx)(s(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,n.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(l(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,n.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/23f866da.12d03f5a.js b/assets/js/23f866da.12d03f5a.js deleted file mode 100644 index d347b460d..000000000 --- a/assets/js/23f866da.12d03f5a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zG0dyf6WzlSpZuAVAQJSssBTV8SzHVqKTVCZVqgvJowe7DeyIuzPrmVmAMAtVfrh/kKdUJS/30/RLUt0zu9gFQVKSdT4lgR9kYj56unu6e7p7eucqcmJmo4OT6JlOqgKVs9FZHKVoEyNLJ7WKDqLjDMFiPrVypuDw9XOYoUIjHFoQ8OaHF+Ay4QCVmORoYWoQrVvmCDReqhnoKQhIA/wB/ElXkAgFIrcapEryKkXQvJjIoTTYT3EqFaawkOkMnY1hkckkA5d5mGh4PqbSgTaAl6VQKVSlViAsKMQU0wEcZ9JCafRcpoxojQ1elmgkqoSAFTIXBpxm2O9/+a8jIvFPujJE7/tf/humuV6AVNz/qkTFA0RZDk7VqTqW5QG8KXMtUljqysDrZ//SEEpQqe2k13uGk2oGb573emdfZc6V9mA4JBi6REVo5WJiB4kuhikNLNPpfSIZDRJUT6uwMl+CSFtMcRkqSHS5hERrk0pFOxJDKWYIqiomaGwMxJlCGyQaBBgU6bLvdL+yCP969OolTLUphBvA67yycbNcKg0mLl968ER7TdU9CxNh8dE+WGekmsVQiAtiq3TwUyWTCyLbokprph6+fs686vWOqrLUxmEKbz0JB70e9fwBicfCII9PdFFoBaUwokCHxnrpom6DP1XSsFy4DESe17w4OFV96PWUKPCg14M3Sv5UIcgUlZNTiYaoBEfy4CcM/Hi3LHn8c5XKhMWZEKBWEtnOUGIqDT0qMSGQfmiL1aBVkFLi4UL4/S9zkXiyDNoSEyfn2AV8GcOSAD9DpWsMMm3kz1o5kfP2zdE4mYi8vc2EIKuDE8YR+0stlatbwwqNptFu8yYGOSTUUmJuIRX3WIS5yCu0AatFDBlh9QOWBi1ZhRouMV6lkKGcZTeuJ9J3lXUdwFBZQrONRVir3lVmLzLbpiK3CHLa4WUhLrC1WmMxBvCHJaQ4FVXuYpAkoc5UOICX2pGm5jIhw8QyQMomXGWwz7scxGfQFZ/Xa5uRyukUDSkzdTKIMKfGjuTSGxkijzXNZUKBVhsbnehcm+sixM1dPkKilWNLeTgXMmfkPbG2MZeTXCQXMUzyCmMwmHpFX2Ke60Xs9YOHkEH0PGf+kBknKdSK8Fc6LC8t2IBVYzhr/aPOxjjTItK2uRq0fKppZWJBrZKAhZB5zIyL4Z2egJMux5gUvBRqGUMqHMbg8NJN9GUMSYbJxURfBn5NtXJW/rxF6+qej+faOIb9GB7F8DiG0V4Mo3EMo/0YRo9iGD2OYbwXw3gcw3g/hvEjz9Px48BP0TCxjcBo7DnpviwOkr19IS1rKBlK29jeRcf2jgbQ6zVaQW0//vjjqbo6VQCnESnJaXQAp1Ez5DSKfR/ZPuobhd+X9OPB+Ovwc0k/H40fh58LHjraDz8z+jkenapVWPBUjRkTJ4ryFiyo+7NiEH4FQaE2XpTaartEjWRQ4rqD9qODD3Ws2rQ8IFqkkk6K3N5MTj3iC6JojdI1ovaJKBbJmyni7i+InDY+1MPmznexeWx11UrNWIyvUf9wEE6Im4n3y34xtLfQ+XWkPyLSyfwck/m5mf7GQn1BTNjE6ddx4usBH+RsfW/mQxjwBXGhi9Gv48Fj4gEdPDczgHq/IOpb6FBHOMV9395+f/SwP94b73c4QDGRH1AU/TTtL5fLz8E98mvC8uTW1J6m99CEQ5gaXWwJI9jLX48Kfg//XbvefySHe1L7opjWMWvjlTSRXttbdjoVy3vWg6qnNg4YjV+7X8sWmtxFeHDUm2RaJgF5GlO7XRMK7AbEgz5zcpimwxYnqTFN+0XR32ikn31mfKuxKAZpOtgYeW13fGMBaRrD9eat7WkKRVHc0OzbO83DorhOxaAoAm5M76n6J1KT4JndrClhwG+lLGud6C58qyJRzkCrnNfmwGy7Jm0cN5lUoSOIFWwMMDircmHwkiJMK7Xyoz+/ltVKtvbfOSINOQGs3Wf46lXw0e8HBSASugCo5e551ygjIIeQVNbpAgzO8BJK4RwaxcDmIpep4KCszw14KYqSHP3hn09P09/945BTCRStO6CdgFTOJGWAhn8+Oez/+9mWEVVZokmERciRVrIxoEsGcJJhXq6TUIvFYrB4YJNM69xnoN5Zg1P/77mevDtndMuBsOX9bZR60WiF7iQ6m5G7RdfhmLBQz9wSvLOMcQgz2uPzNkQ1txy4YcQXdOZsoESdPg9C3SenUSHYJSFRxvXf2mVoTqOzZo4P1zG9Y+7ZByhrJlPMxQTz610frGhNcy6Wugr6XaenuqQGiW7xjToKqZoMBJOzF7c6xeVGp+9bbdFvz5C2dtaHTq2e9Q5ALm2dg+mysz07JKk41UgJZBLbCUI9ASaNlP5qLWgQ+zA18JYo7N0dS9A44IFNgrDJCdy+Qmdj2owhGIVUsqiKJtM5baDWLCuC99HmF82sLJp6hfbuXltBXN6xAqUVb17gVI04kyELMbvFMeXuL8hKBHyu+dgjToZ4ZtwSb3L/7eSM9jrkPOyS82jvE1yHzrK3EtryD/ZaFsUUVS4+62kfYJJUfaOLsnJeqsI5T24pW9ZavOoUrk9J/y6Gfgy9GIYxfBXD/QH8gJz0TZoEcZA2aXwaWCpIdUW5u6Qy+RImRiR084KD2QCurn6qhHLSLVcr6MHVFV2UrVYD0s8LpRc+R3wyl1Y6oDue9Wmc6sRuuRPSiR3SsT18iYt+fU03DKjdh6/0hj261fcJLPhYZ+emaX9TDyCKI13SRaPU6nkaHUT1JWQUs9ChdX/Q6TI6uIpC8pf+DKlVmjR8Z+kC8yqySYaFoL9qYaUrz6nMMYojf6VoozjiTAHdf5KSRQeRnrzDxEUx+bAlHXNoCQbPO7iqR/mLsCgOcWN0EPkbsiiOgifXNAGqRFN0VqbTaFUveBuopmUNyvIfzY0cwaG7o08E85KmrjaufD8J0rMWBKatwGNN+pijw2diaVtwvTxFmzfNNIfkJQmzIBVLS/nyyvozORF5UuUUg+JlKc2yCYg5EG1Y0sK3WanBd/RwVW96C6Mb9troj9+gBDUxgJOPHzv3ncYJ4u9DAxkA3l9RfDQW7zTCBHlvy0yrj54/Gj8YjUcPRmOCEDJIHwujNmYE4p2enH+SvKc4p/nB4LVmC2PEMooj6bCwd2+l772+dlcED+kaBtPaI+yv7wxj4Hz/4C5tqMcz58UM7xb745vuklvXWzbTVZ7SxREKM+Ar3U+uLuhqUnNUDu7Qm1UcXd5NzCUkul9fVMNXOU6dD0ch0Uahud/Ocn0xxI3391dxtLybvOX/SvK+ps1b3E3dW77hX1c//D1wffB4FUfZ3bh+39Qg/B2R3X+0Wp/jUWJQOHRYlATkfKLT5Xltt1btgbUnU59Yfmg4lFa0Yp6iIafnur1amxoaSbU255tHzUTrHIXaYmg6F9OCbJ1lT42ctJDmXWTI3nLjwDF024TEwaXzXhNdduNGZk1ailNMhafRAJ5PW744B6Wbd+P1WL4bVxru8XrntmIzfm8YfhOH7rXrgqj0Yp3erlHgwVBvAVX85DnhTR7EAJr/2LtsOEkI1Cd2vfDdR8U3PqPHC4ZJ3SoTCF7qAL4RqqlC6N72w9VVIwQsHasVXF3RrqI5p3N/tYrXDbRWp4GPdt9iMEE578xqmnA9sWlrTfXO1HnKoQo1hPO+jYAvnzuvTIBDPudqNegI5AbikLGjzzzAtJEzKqG7TnXjMvFOfzD3rzE7SAAB+X/D9yfl0+/lFlSeDMunT8qnb6mmrESve549U6lSr/kLzPMBPLHOaDV7usGCJ8PQvn0rDc4lLlhxeVfXUDZ52wAaBJyoyLK1edJCYqpEipxT2UYnWBf6cfyJlw6sw9JS7Cidr+bkkiD2/MXMIHLVJeEiKsc1dBwE1gs+EZAZnP7zvQ2e3nvKNZ0Uij8Ziqdh9HMfwGZijiDUEphwTjBq4zOE08qwmUxyYeQ0RJwxlDlS2p0CUpH4qNdztMbjOBPqwsZPJubpMYqiqSp9/5e/0ghWAy6lPdaV+QCbzvF23++tTwV4m+eBgIBZxReCjvhUmye+EVjXrUllnal8bg7SytSlenXNLO+HtYNQmdeHVFpfvJRhG34MqKyfLmAqrEMTQ6WkcmhMVZLkXC/D7YgyL7Ci+N7XoNIe3W0LugViVJLsy2dbFcP1OVADxlAxHELNpjixrt7dJH3rwRv05G4E6ZDk3FFIy5ZorFYkS9rMhAqi6h1/bSlwy0Tuh3p9lXSdSvjQ+TvYGmS9/8tfW3jdGH1eR8yvINKU7qvuwJCTsZR1tZySNVjmS3C6ixHBQ/P7TV+LsCvQzPA8oaiMdQY/QMJ7PZLxXg/6vrIuiLetfLGlq+uGeR9pS9fQiW/B/jdX4nVyIe2Uaw/ge73AOQlsUGEytB6+plwgY57GHkRrhUQoKv9j14i8EwLcXIUXgpOFYQlfl8ciztQEI0PXb349rnOldeLbaKpFubnrF1zfHlb3Au+Jo0wViFxzVaFrVdCnXaSecwljxqbAUraOMnF+nbp2WC8Umve//CfV1Nf5Udu4d1t72UPjKn+uj2xDrb21uth30PXHvBW4y1/2LvU6oxe8OCq11sr6oH+8t0f/6wpUnUQF76+nYKuElHxa5fnyH6L4w9OJt2ccfPN2L/62FEL2To5/vkzm49ekMjdYwFsBhIinMjlV+xPn+s2Gsya2eCtVLhWe12w7H+/tnY+It6s42t/GviNdoBeWBTFxQed6ozXOLEHMSOzJ/zafkZtojDa3B0Qfh9ltTNjvMOHhdSY8V3zLyd/DHOsLVL8tpe3lnV+eUL0sWFb8oRRJP4j7ow6x7XZPpMWkMtIto4OTq+iyL0rZ9/0HJ2erMzLcLtOUhC+1ZYyFy6KDaNjKyVs0c0qkE4QNiVmI2QzN99WEET6snIY/6uTCU8UC3sjsXBrnIQ2sn5ZVEw7VXxtBGvpSzC+EGdLpMhwN9gZ70Sq+2gBihUrp1vNauC9KOZyPBqMtc7amB24Zj1X/Y6dYJ2ZSze6ad7bejiMSGS8VnU1ZJ0FL+W9IWdCw5+1RcSSJ+xmKlNIKlIS1Wv2wvjr5tpan+lJj2z1Fywpv3DzUFw+du4TN03vL7cD2y4HRw3Za3ifeOZfepNK3Zccbwut8d5PubmWwWwnsdU66k5LmLHMryXyyVr4mn1unc0ecBx3v73PC8OsRZ9YePOak1f6j1VknfxNF3RwN35BuZhp+XeDcjZt3weD/oWCwGwv6sp2N2KgWsCYW6QQEm/HAjb75Vte8jsakmmq2OUFZmi8hyZqzzbqWSMY80UXzdUuv16KsmdXrNbbE7w75oq8qA6VeoJlW/nOZaY6XkoJNmoYF962TliiKHK3Nl0BR5ow9YK6PE3kTwyWiFBOZSzpfaZgOcrI+ou0A3q7TnveMvzKfY07HMomQLgTHiE18uNDmgj4OpW8sYUKlBBQ8ocqESnyc5g14TDJCX3BSDFwaaemjPUNYS4+bVs6QcBRCiRmLbdwWA0gxJy22YPSEymyszisvfE7IXBt/McoEkShaZuK3lyV1cTacTJ/BjPZ7HqJ1Sx8RpQjeNofPRCeUPCsJF0nOu9NQqVzTF52UOKvyHEpN3g2ppZ52cKTpzghlySkNd7FhDxqGhUAabQiD3likHX4h1YX/GqkPJ41cvcWJlQ67lYqbMnu/O+c76cjB+AFLbaXTZrmePZOudiLaQJofHtJ34bNmaJ2hH16dcYSOJMQOD18/Z4fwPrz/5T/gBQqjINMLL61JZTBfNl9Q++9zeec92xp/jlM1ZLuI44kXvmByaw6+zYTjmOsl8jfKXqV8YcbrapLLBI7rPHivdwDfcLTTyo13KqsyQaI0lwIElH52LtXFAA7VkiP+tQGmdp7XIYONfr3d/jPhFLQKhR9+zcEaI2ovLOZztK0Ymj7qJonOjK5mfrU2MoE4g1OKIsN3xETbYZpy6CnXXwXzV65rdHDqP87Epb854Jj/9cYU7mm+lQsJg3XSGFXKH9raA0iNmLo1/Hgt6BxUsvm/1lR/SVizIw5gmi3xmhgoblp9dLzh/3XtLUfdtCCTvd6XUgZxOqnFErolwB8v1r4egE80DlbCwSJKuTXjQ58Z21fTIzRzmdTB6Q0aPeTBwyiOcpmgstgKZg6/e/0C5g8Ge52I4QOUe/ji+Tffvjz6lpAhQ+oZVkcOHM8UQrVWOsJ8CkfeRdwoi2kCvN2jCLtHEXaPIuweRdg9irB7FGH3KMLuUYTP90nB7lGE3aMIu0cRdo8i/O2YsHsUYfcowu5RhN2jCLtHEWD3KMLuUYTdowi/1Ym7exRh9yjC7lGE3aMIu0cRdo8i7B5F+ORHEUJhGs0blrmQqlUl7MsyT9ZPJZzFUUYVmwcn0dUV3VK9oTonav6pQkPlnmdxNBdGUt6Viz3jumCQiuAukErKvvFp5P4xrRz7U5uvfDdqXKni0c84TBIs3a1j20Wlr18dHUdxVH/5VeiU5hixoKcexMJXOQUV5OpAwR+z5kLNKq7JizxMqnGkoolugeQFF0iGP1qlfVQQuMawWznpyaB/iaitE66ufPEll+D58b7rxhmBsfVo2rmz1Wr1PxYFGeY=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),m=t(63723),h=t.n(m),u=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztPF1zG0dyf6WzlSpZuAVAQJSssBTV8SzHVqKTVCZVqgvJowe7DeyIuzPrmVmAMAtVfrh/kKdUJS/30/RLUt0zu9gFQVKSdT4lgR9kYj56unu6e7p7eucqcmJmo4OT6JlOqgKVs9FZHKVoEyNLJ7WKDqLjDMFiPrVypuDw9XOYoUIjHFoQ8OaHF+Ay4QCVmORoYWoQrVvmCDReqhnoKQhIA/wB/ElXkAgFIrcapEryKkXQvJjIoTTYT3EqFaawkOkMnY1hkckkA5d5mGh4PqbSgTaAl6VQKVSlViAsKMQU0wEcZ9JCafRcpoxojQ1elmgkqoSAFTIXBpxm2O9/+a8jIvFPujJE7/tf/humuV6AVNz/qkTFA0RZDk7VqTqW5QG8KXMtUljqysDrZ//SEEpQqe2k13uGk2oGb573emdfZc6V9mA4JBi6REVo5WJiB4kuhikNLNPpfSIZDRJUT6uwMl+CSFtMcRkqSHS5hERrk0pFOxJDKWYIqiomaGwMxJlCGyQaBBgU6bLvdL+yCP969OolTLUphBvA67yycbNcKg0mLl968ER7TdU9CxNh8dE+WGekmsVQiAtiq3TwUyWTCyLbokprph6+fs686vWOqrLUxmEKbz0JB70e9fwBicfCII9PdFFoBaUwokCHxnrpom6DP1XSsFy4DESe17w4OFV96PWUKPCg14M3Sv5UIcgUlZNTiYaoBEfy4CcM/Hi3LHn8c5XKhMWZEKBWEtnOUGIqDT0qMSGQfmiL1aBVkFLi4UL4/S9zkXiyDNoSEyfn2AV8GcOSAD9DpWsMMm3kz1o5kfP2zdE4mYi8vc2EIKuDE8YR+0stlatbwwqNptFu8yYGOSTUUmJuIRX3WIS5yCu0AatFDBlh9QOWBi1ZhRouMV6lkKGcZTeuJ9J3lXUdwFBZQrONRVir3lVmLzLbpiK3CHLa4WUhLrC1WmMxBvCHJaQ4FVXuYpAkoc5UOICX2pGm5jIhw8QyQMomXGWwz7scxGfQFZ/Xa5uRyukUDSkzdTKIMKfGjuTSGxkijzXNZUKBVhsbnehcm+sixM1dPkKilWNLeTgXMmfkPbG2MZeTXCQXMUzyCmMwmHpFX2Ke60Xs9YOHkEH0PGf+kBknKdSK8Fc6LC8t2IBVYzhr/aPOxjjTItK2uRq0fKppZWJBrZKAhZB5zIyL4Z2egJMux5gUvBRqGUMqHMbg8NJN9GUMSYbJxURfBn5NtXJW/rxF6+qej+faOIb9GB7F8DiG0V4Mo3EMo/0YRo9iGD2OYbwXw3gcw3g/hvEjz9Px48BP0TCxjcBo7DnpviwOkr19IS1rKBlK29jeRcf2jgbQ6zVaQW0//vjjqbo6VQCnESnJaXQAp1Ez5DSKfR/ZPuobhd+X9OPB+Ovwc0k/H40fh58LHjraDz8z+jkenapVWPBUjRkTJ4ryFiyo+7NiEH4FQaE2XpTaartEjWRQ4rqD9qODD3Ws2rQ8IFqkkk6K3N5MTj3iC6JojdI1ovaJKBbJmyni7i+InDY+1MPmznexeWx11UrNWIyvUf9wEE6Im4n3y34xtLfQ+XWkPyLSyfwck/m5mf7GQn1BTNjE6ddx4usBH+RsfW/mQxjwBXGhi9Gv48Fj4gEdPDczgHq/IOpb6FBHOMV9395+f/SwP94b73c4QDGRH1AU/TTtL5fLz8E98mvC8uTW1J6m99CEQ5gaXWwJI9jLX48Kfg//XbvefySHe1L7opjWMWvjlTSRXttbdjoVy3vWg6qnNg4YjV+7X8sWmtxFeHDUm2RaJgF5GlO7XRMK7AbEgz5zcpimwxYnqTFN+0XR32ikn31mfKuxKAZpOtgYeW13fGMBaRrD9eat7WkKRVHc0OzbO83DorhOxaAoAm5M76n6J1KT4JndrClhwG+lLGud6C58qyJRzkCrnNfmwGy7Jm0cN5lUoSOIFWwMMDircmHwkiJMK7Xyoz+/ltVKtvbfOSINOQGs3Wf46lXw0e8HBSASugCo5e551ygjIIeQVNbpAgzO8BJK4RwaxcDmIpep4KCszw14KYqSHP3hn09P09/945BTCRStO6CdgFTOJGWAhn8+Oez/+9mWEVVZokmERciRVrIxoEsGcJJhXq6TUIvFYrB4YJNM69xnoN5Zg1P/77mevDtndMuBsOX9bZR60WiF7iQ6m5G7RdfhmLBQz9wSvLOMcQgz2uPzNkQ1txy4YcQXdOZsoESdPg9C3SenUSHYJSFRxvXf2mVoTqOzZo4P1zG9Y+7ZByhrJlPMxQTz610frGhNcy6Wugr6XaenuqQGiW7xjToKqZoMBJOzF7c6xeVGp+9bbdFvz5C2dtaHTq2e9Q5ALm2dg+mysz07JKk41UgJZBLbCUI9ASaNlP5qLWgQ+zA18JYo7N0dS9A44IFNgrDJCdy+Qmdj2owhGIVUsqiKJtM5baDWLCuC99HmF82sLJp6hfbuXltBXN6xAqUVb17gVI04kyELMbvFMeXuL8hKBHyu+dgjToZ4ZtwSb3L/7eSM9jrkPOyS82jvE1yHzrK3EtryD/ZaFsUUVS4+62kfYJJUfaOLsnJeqsI5T24pW9ZavOoUrk9J/y6Gfgy9GIYxfBXD/QH8gJz0TZoEcZA2aXwaWCpIdUW5u6Qy+RImRiR084KD2QCurn6qhHLSLVcr6MHVFV2UrVYD0s8LpRc+R3wyl1Y6oDue9Wmc6sRuuRPSiR3SsT18iYt+fU03DKjdh6/0hj261fcJLPhYZ+emaX9TDyCKI13SRaPU6nkaHUT1JWQUs9ChdX/Q6TI6uIpC8pf+DKlVmjR8Z+kC8yqySYaFoL9qYaUrz6nMMYojf6VoozjiTAHdf5KSRQeRnrzDxEUx+bAlHXNoCQbPO7iqR/mLsCgOcWN0EPkbsiiOgifXNAGqRFN0VqbTaFUveBuopmUNyvIfzY0cwaG7o08E85KmrjaufD8J0rMWBKatwGNN+pijw2diaVtwvTxFmzfNNIfkJQmzIBVLS/nyyvozORF5UuUUg+JlKc2yCYg5EG1Y0sK3WanBd/RwVW96C6Mb9troj9+gBDUxgJOPHzv3ncYJ4u9DAxkA3l9RfDQW7zTCBHlvy0yrj54/Gj8YjUcPRmOCEDJIHwujNmYE4p2enH+SvKc4p/nB4LVmC2PEMooj6bCwd2+l772+dlcED+kaBtPaI+yv7wxj4Hz/4C5tqMcz58UM7xb745vuklvXWzbTVZ7SxREKM+Ar3U+uLuhqUnNUDu7Qm1UcXd5NzCUkul9fVMNXOU6dD0ch0Uahud/Ocn0xxI3391dxtLybvOX/SvK+ps1b3E3dW77hX1c//D1wffB4FUfZ3bh+39Qg/B2R3X+0Wp/jUWJQOHRYlATkfKLT5Xltt1btgbUnU59Yfmg4lFa0Yp6iIafnur1amxoaSbU255tHzUTrHIXaYmg6F9OCbJ1lT42ctJDmXWTI3nLjwDF024TEwaXzXhNdduNGZk1ailNMhafRAJ5PW744B6Wbd+P1WL4bVxru8XrntmIzfm8YfhOH7rXrgqj0Yp3erlHgwVBvAVX85DnhTR7EAJr/2LtsOEkI1Cd2vfDdR8U3PqPHC4ZJ3SoTCF7qAL4RqqlC6N72w9VVIwQsHasVXF3RrqI5p3N/tYrXDbRWp4GPdt9iMEE578xqmnA9sWlrTfXO1HnKoQo1hPO+jYAvnzuvTIBDPudqNegI5AbikLGjzzzAtJEzKqG7TnXjMvFOfzD3rzE7SAAB+X/D9yfl0+/lFlSeDMunT8qnb6mmrESve549U6lSr/kLzPMBPLHOaDV7usGCJ8PQvn0rDc4lLlhxeVfXUDZ52wAaBJyoyLK1edJCYqpEipxT2UYnWBf6cfyJlw6sw9JS7Cidr+bkkiD2/MXMIHLVJeEiKsc1dBwE1gs+EZAZnP7zvQ2e3nvKNZ0Uij8Ziqdh9HMfwGZijiDUEphwTjBq4zOE08qwmUxyYeQ0RJwxlDlS2p0CUpH4qNdztMbjOBPqwsZPJubpMYqiqSp9/5e/0ghWAy6lPdaV+QCbzvF23++tTwV4m+eBgIBZxReCjvhUmye+EVjXrUllnal8bg7SytSlenXNLO+HtYNQmdeHVFpfvJRhG34MqKyfLmAqrEMTQ6WkcmhMVZLkXC/D7YgyL7Ci+N7XoNIe3W0LugViVJLsy2dbFcP1OVADxlAxHELNpjixrt7dJH3rwRv05G4E6ZDk3FFIy5ZorFYkS9rMhAqi6h1/bSlwy0Tuh3p9lXSdSvjQ+TvYGmS9/8tfW3jdGH1eR8yvINKU7qvuwJCTsZR1tZySNVjmS3C6ixHBQ/P7TV+LsCvQzPA8oaiMdQY/QMJ7PZLxXg/6vrIuiLetfLGlq+uGeR9pS9fQiW/B/jdX4nVyIe2Uaw/ge73AOQlsUGEytB6+plwgY57GHkRrhUQoKv9j14i8EwLcXIUXgpOFYQlfl8ciztQEI0PXb349rnOldeLbaKpFubnrF1zfHlb3Au+Jo0wViFxzVaFrVdCnXaSecwljxqbAUraOMnF+nbp2WC8Umve//CfV1Nf5Udu4d1t72UPjKn+uj2xDrb21uth30PXHvBW4y1/2LvU6oxe8OCq11sr6oH+8t0f/6wpUnUQF76+nYKuElHxa5fnyH6L4w9OJt2ccfPN2L/62FEL2To5/vkzm49ekMjdYwFsBhIinMjlV+xPn+s2Gsya2eCtVLhWe12w7H+/tnY+It6s42t/GviNdoBeWBTFxQed6ozXOLEHMSOzJ/zafkZtojDa3B0Qfh9ltTNjvMOHhdSY8V3zLyd/DHOsLVL8tpe3lnV+eUL0sWFb8oRRJP4j7ow6x7XZPpMWkMtIto4OTq+iyL0rZ9/0HJ2erMzLcLtOUhC+1ZYyFy6KDaNjKyVs0c0qkE4QNiVmI2QzN99WEET6snIY/6uTCU8UC3sjsXBrnIQ2sn5ZVEw7VXxtBGvpSzC+EGdLpMhwN9gZ70Sq+2gBihUrp1vNauC9KOZyPBqMtc7amB24Zj1X/Y6dYJ2ZSze6ad7bejiMSGS8VnU1ZJ0FL+W9IWdCw5+1RcSSJ+xmKlNIKlIS1Wv2wvjr5tpan+lJj2z1Fywpv3DzUFw+du4TN03vL7cD2y4HRw3Za3ifeOZfepNK3Zccbwut8d5PubmWwWwnsdU66k5LmLHMryXyyVr4mn1unc0ecBx3v73PC8OsRZ9YePOak1f6j1VknfxNF3RwN35BuZhp+XeDcjZt3weD/oWCwGwv6sp2N2KgWsCYW6QQEm/HAjb75Vte8jsakmmq2OUFZmi8hyZqzzbqWSMY80UXzdUuv16KsmdXrNbbE7w75oq8qA6VeoJlW/nOZaY6XkoJNmoYF962TliiKHK3Nl0BR5ow9YK6PE3kTwyWiFBOZSzpfaZgOcrI+ou0A3q7TnveMvzKfY07HMomQLgTHiE18uNDmgj4OpW8sYUKlBBQ8ocqESnyc5g14TDJCX3BSDFwaaemjPUNYS4+bVs6QcBRCiRmLbdwWA0gxJy22YPSEymyszisvfE7IXBt/McoEkShaZuK3lyV1cTacTJ/BjPZ7HqJ1Sx8RpQjeNofPRCeUPCsJF0nOu9NQqVzTF52UOKvyHEpN3g2ppZ52cKTpzghlySkNd7FhDxqGhUAabQiD3likHX4h1YX/GqkPJ41cvcWJlQ67lYqbMnu/O+c76cjB+AFLbaXTZrmePZOudiLaQJofHtJ34bNmaJ2hH16dcYSOJMQOD18/Z4fwPrz/5T/gBQqjINMLL61JZTBfNl9Q++9zeec92xp/jlM1ZLuI44kXvmByaw6+zYTjmOsl8jfKXqV8YcbrapLLBI7rPHivdwDfcLTTyo13KqsyQaI0lwIElH52LtXFAA7VkiP+tQGmdp7XIYONfr3d/jPhFLQKhR9+zcEaI2ovLOZztK0Ymj7qJonOjK5mfrU2MoE4g1OKIsN3xETbYZpy6CnXXwXzV65rdHDqP87Epb854Jj/9cYU7mm+lQsJg3XSGFXKH9raA0iNmLo1/Hgt6BxUsvm/1lR/SVizIw5gmi3xmhgoblp9dLzh/3XtLUfdtCCTvd6XUgZxOqnFErolwB8v1r4egE80DlbCwSJKuTXjQ58Z21fTIzRzmdTB6Q0aPeTBwyiOcpmgstgKZg6/e/0C5g8Ge52I4QOUe/ji+Tffvjz6lpAhQ+oZVkcOHM8UQrVWOsJ8CkfeRdwoi2kCvN2jCLtHEXaPIuweRdg9irB7FGH3KMLuUYTP90nB7lGE3aMIu0cRdo8i/O2YsHsUYfcowu5RhN2jCLtHEWD3KMLuUYTdowi/1Ym7exRh9yjC7lGE3aMIu0cRdo8i7B5F+ORHEUJhGs0blrmQqlUl7MsyT9ZPJZzFUUYVmwcn0dUV3VK9oTonav6pQkPlnmdxNBdGUt6Viz3jumCQiuAukErKvvFp5P4xrRz7U5uvfDdqXKni0c84TBIs3a1j20Wlr18dHUdxVH/5VeiU5hixoKcexMJXOQUV5OpAwR+z5kLNKq7JizxMqnGkoolugeQFF0iGP1qlfVQQuMawWznpyaB/iaitE66ufPEll+D58b7rxhmBsfVo2rmz1Wr1PxYFGeY=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,x={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/23f866da.928902d5.js b/assets/js/23f866da.928902d5.js new file mode 100644 index 000000000..9ac5c7ad6 --- /dev/null +++ b/assets/js/23f866da.928902d5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zG0eOfwU3tVWOuUNSpGXHp/K51rGzie68tiqSy7UnaZXmDMhpa6Z70t0jilGxKg/7D+7pqu5e9qf5l1wB3TOcoSjJdrxZ3x3z4Ij9gQbQABpAY/oqcmJmo73j6IVOqgKVs9FpHKVoEyNLJ7WK9qKjDMFiPrVypuDZwT7MUKERDi0IePPDS3CZcIBKTHK0MDWI1i1yBBov1Qz0FASkAf4A/qwrSIQCkVsNUiV5lSJoXkzkUBrspziVClOYy3SGzsYwz2SSgcs8TDQ8H1PpQBvAy1KoFKpSKxAWFGKK6QCOMmmhNPpCpoxojQ1elmgkqoSAFTIXBpxm2O9/+a9DIvHPujJE7/tf/humuZ6DVNz/ukTFA0RZDk7UiTqS5R68KXMtUljoysDBiz82hBJUajvu9V7gpJrBm/1e7/SrzLnS7g2HBEOXqAitXEzsINHFMKWBZTq9TySjQYLqaRVW5gsQaYspLkMFiS4XkGhtUqloR2IoxQxBVcUEjY2BOFNog0SDAIMiXfSd7lcW4V8PX7+CqTaFcAM4yCsbN8ul0mDi8oUHT7TXVN2zMBEWH+2CdUaqWQyFOCe2Sgc/VTI5J7ItqrRm6rODfeZVr3dYlaU2DlN460nY6/Wo5xskHguDPD7RRaEVlMKIAh0a66WLug3+VEnDcuEyEHle82LvRPWh11OiwL1eD94o+VOFIFNUTk4lGqISHMmDnzDw492i5PH7KpUJizMhQK0ksp2hxFQaelhiQiD90BarQasgpcTDufD7X+Yi8WQZtCUmTl5gF/BlDAsC/AKVrjHItJE/a+VEztt3gcbJROTtbSYEWR2cMI7YX2qpXN0aVmg0jXabNzHIIaGWEnMLqbjHIlyIvEIbsJrHkBFWP2Bp0JJVqOES41UKGcpZduN6In1XWdcBDJUlNNtYhLXqXWX2IrNtKnKLIKcdXhbiHFurNRZjAN8sIMWpqHIXgyQJdabCAbzSjjQ1lwkZJpYBUjbhKoN93uUgPoOu+BysbEYqp1M0pMzUySDCnBo7kktvZIg81jSXCQVarW10onNtrosQN3f5CIlWji3lswshc0beE2sbcznJRXIewySvMAaDqVf0Bea5nsdeP3gIGUTPc+YPmXGSQq0If6XD8tKCDVg1hrPWP+psjDMtIm2bq0HLp5pWJhbUKglYCJnHzLgY3ukJOOlyjEnBS6EWMaTCYQwOL91EX8aQZJicT/Rl4NdUK2flzxu0ru75eK6NY9iN4VEMj2MY7cQwGscw2o1h9CiG0eMYxjsxjMcxjHdjGD/yPB0/DvwUDRPbCIzGnpPuy+Ig2duX0rKGkqG0je2dd2zvaAC9XqMV1Pbjjz+eqKsTBXASkZKcRHtwEjVDTqLY95Hto75R+H1JPx6Mvw4/F/Tz0fhx+DnnoaPd8DOjn+PRiVqGBU/UmDFxoihvwYK6PysG4VcQFGrjRamttkvUSAYlrjtoPzr4UMeyTcsDokUq6aTI7c3k1CO+IIpWKF0japeIYpG8mSLu/oLIaeNDPWzufBebx1ZXrdSMxfga9Q8H4YS4mXi/7BdDewudX0f6IyKdzM8RmZ+b6W8s1BfEhHWcfh0nvh7wQc7W92Y+hAFfEBe6GP06HjwmHtDBczMDqPcLor6FDnWEU9z37ez2Rw/7453xbocDFBP5AUXRT9P+YrH4HNwjvyYsT25N7Wl6D004hKnRxYYwgr381ajg9/Dftev9J3K4J7UvimkdszZeSRPptb1lp1OxuGc9qHpq44DR+JX7tWihyV2EB0e9SaZlEpCnMbXbNaHAbkA86DMnh2k6bHGSGtO0XxT9tUb62WfGtxqLYpCmg7WR13bHNxaQpjFcb97YnqZQFMUNzb690zwsiutUDIoi4Mb0nqh/JjUJntnNmhIG/FbKstKJ7sK3KhLlDLTKeW0OzDZr0tpxk0kVOoJYwdoAg7MqFwYvKcK0Uis/+vNrWa1kK/+dI9KQE8DafYavXgcf/X5QACKhC4Ba7p53jTIC8gySyjpdgMEZXkIpnEOjGNiFyGUqOCjrcwNeiqIkR3/4l5OT9Pe/G3IqgaJ1B7QTkMqZpAzQ8C/Hz/r/frphRFWWaBJhEXKklWwM6JIBHGeYl6sk1Hw+H8wf2CTTOvcZqHfW4NT/e6Yn784Y3XIgbHl/E6VeNFqhO4nOeuRu0XU4JizUMzcE7yxjHMKMdvi8DVHNLQduGPEFnTlrKFGnz4NQ9/FJVAh2SUiUcfW3dhmak+i0mePDdUzvmHv6AcqayRRzMcH8etcHK1rTnIuFroJ+1+mpLqlBolt8o45CqiYDweTsxK1OcbnW6fuWG/TbM6StnfWhU6tnvQOQS1vnYLrsbM8OSSpONVICmcR2glBPgEkjpb9aCxrEPkwNvCUKe3fHEjQOeGCTIGxyArev0NmYNmMIRiGVLKqiyXROG6g1y4rgfbT5RTMri6Zeob2711YQl3esQGnFmxc4USPOZMhCzG5xTLn7C7ISAZ9rPvaIkyGeGbfEm9x/OzmjnQ45D7vkPNr5BNehs+ythLb8g52WRTFFlYvPetoHmCRVz3VRVs5LVTjnyS1ly1qLV53C9Snp38fQj6EXwzCGr2K4P4AfkJO+SZMgDtImjU8DSwWprih3l1QmX8DEiIRuXnAwG8DV1U+VUE66xXIJPbi6oouy5XJA+nmu9NzniI8vpJUO6I5ndRqnOrEb7oR0Yod0bA9f4bxfX9MNA2r34Su9Zo9u9X0CCz7W2blp2t/VA4jiSJd00Si12k+jvai+hIxiFjq07hudLqK9qygkf+nPkFqlScN3li4wryKbZFgI+qsWVrrynMocozjyV4o2iiPOFND9JylZtBfpyTtMXBSTD1vSMYeWYPC8vat6lL8Ii+IQN0Z7kb8hi+IoeHJNE6BKNEVnZTqNlvWCt4FqWlagLP/R3MgRHLo7+kQwr2jqcu3K95MgvWhBYNoKPNKkjzk6fCEWtgXXy1O0ftNMc0hekjALUrGwlC+vrD+TE5EnVU4xKF6W0iyagJgD0YYlLXyblRp8Rw+X9aa3MLphr43++A1KUBMDOPn4sXPfaZwg/iE0kAHg/RXFR2PxTiNMkPe2zLT66Pmj8YPRePRgNCYIIYP0sTBqY0Yg3unJ2SfJe4oXND8YvNZsYYxYRHEkHRb27q30vdfX7orgM7qGwbT2CPurO8MYON8/uEsb6vHMeTHDu8X+6Ka75Nb1ls10lad0cYTCDPhK95OrC7qa1ByVgzv0ZhlHl3cTcwmJ7tcX1fBVjlPnw1FItFFo7rezXF8McePd3WUcLe4mb/G/kryvafPmd1P3lm/4V9UP/whcHzxexlF2N67fNzUI/0Bkdx8tV+d4lBgUDh0WJQE5m+h0cVbbrWV7YO3J1CeWHxoOpSWtmKdoyOm5bq9WpoZGUq3N2fpRM9E6R6E2GJrOxbQgW2fZUyMnLaR55xmyt9w4cAzdNiFxcOm810SX3biWWZOW4hRT4Uk0gP1pyxfnoHT9brwey3fjSsM9Xu/MVmzG7w3Db+LQvXZdEJVerNLbNQo8GOotoIqfPCe8yYMYQPMfe5cNJwmB+sSuF777qHjuM3q8YJjUrTKB4KUO4LlQTRVC97Yfrq4aIWDpWC7h6op2Fc0ZnfvLZbxqoLU6DXy0+xaDCcqLzqymCVcTm7bWVO9MnaUcqlBDOO/bCPjyubPKBDjkcy6Xg45AriEOGTv6zANMGzmjErrrVDcuE+/0B3P/GrODBBCQ/zd8f1I+/V5uQOXJsHz6pHz6lmrKSvS659kzlSr1mj/HPB/AE+uMVrOnayx4Mgztm7fS4IXEOSsu7+oKyjpvG0CDgBMVWbY2T1pITJVIkXMq2+gE60I/jj/x0oF1WFqKHaXz1ZxcEsSev5gZRK66JFxE5biGjoPAesEnAjKD03+5t8bTe0+5ppNC8SdD8TSM3vcBbCYuEIRaABPOCUZtfIZwWhk2k0kujJyGiDOGMkdKu1NAKhIf9XqO1ngcZUKd2/jJxDw9QlE0VaXv//o3GsFqwKW0R7oyH2DTOd7u+731qQBv8zwQEDCr+ELQEZ9q88Q3Aqu6NamsM5XPzUFambpUr66Z5f2wdhAq8/qQSuuLlzJsw48BlfXTBUyFdWhiqJRUDo2pSpKc62W4HVHmBZYU3/saVNqju21Bt0CMSpJ9+WyrYrg+B2rAGCqGQ6jZFCfW1bvrpG88eIOe3I0gHZKcOwpp2RKN1YpkSZuZUEFUveOvLQVumcj9UK+vkq5TCR86fwcbg6z3f/1bC68bo8/riPkVRJrSfdUdGHIylrKullOyBst8AU53MSJ4aP6w7msRdgWaGZ4lFJWxzuAHSHivRzLe60HfV9YF8baVL7Z0dd0w7yNt6Qo68S3Y/+ZKvE4upJ1y7QF8r+d4QQIbVJgMrYevKRfImKexB9FaIRGKyv/YNSLvhAA3V+GF4GRhWMLX5bGIMzXByND1m1+P61xpnfg2mmpRbu76Bde3h9W9wHviKFMFItdcVehaFfRpF6l9LmHM2BRYytZRJs6vU9cO67lC8/6X/6Sa+jo/ahv3bmMve2hc5c/1kW2otbdWF/sOuv6YtwJ3+cvepV5l9IIXR6XWWlkf9I93duh/XYGqk6jg/fUUbJWQkk+rPF/8UxR/eDrx9oyDb97sxd+WQsjeyfHPl8nF+IBU5gYLeCuAEPFUJqdqf+Jcv9lw1sQWb6XKpcKzmm1n452dsxHxdhlHu5vYd6gL9MIyJybO6VxvtMaZBYgZiT353+YzchON0eb2gOjjMLuNCbsdJjy8zoR9xbec/D3MkT5H9dtS2l7e+eUJ1cuCZcUfSpH0g7g/6hDbbvdEWkwqI90i2ju+ii77opR93793fLo8JcPtMk1J+FJbxli4LNqLhq2cvEVzQYl0gsBC28ihFSqlS8hr0bco5fBiNBhFy3h9zsZo/ZbxWPU/dop1YibV7K55pyvuHNIO+k3q8GiVkyzlvyElJcMWtEfFkSTJyVCkFOVTTtRq9cPqJuPbenvrO4ZN1wYto7h2EVDfA3RS++uH6YZk/eZc/ehhO0vu8+Cc2m4y25uS1Q3hdfq5yT63EsqtfPIqRdzJEHPSt5XzPV7pQpNerbOrI05Ljnd3OX/39YgTXQ8ecw5p99HytJNOiaJuyoQvLNcD/18Xx3bD2G1s9n8oNuuGZr6KZi1UqQWsCQ06/vm6e36jq7zRU66DI6mmmm1OUJbmw0Q6DdhmXcvrYp7oovnYpNdrUdbM6vUaW+J3h1zD15WBUs/RTCv/9co0x0tJsR9Nw4L7VjlEFEWO1uYLoKBvxg4pl6uJvAmpElGKicwlHXc0TAc5WZ2YdgBvV1nIe8bfYF9gTqckiZAuBIdsTbg21+acvtWkTx5hQjf7FMugyoRKfNjkDXhMMkIfVFJIWhpp6Rs6Q1hLj5tWzpBwFEKJGYtt3BYDSDEnLbZg9ISqXqzOKy98TshcG39PyQSRKFpm4reXJXVxcppMn8GM9vsiBM+WvulJEbxtDl9tTiiXVRIuknxpp6FSuaYPLCmPVeU5lJqcDVJLPe3gSNOdEcqSjxiuRsMeNAwLcS3aEJW8sUg7/FKqc/9xUB+OG7l6ixMrHXYLB9dl9n53znfSfV9N6BNCbaXTZrGaPZMuqyZ8yraBND88pO/CV8bQOkM/vFjiEB1JiB0+O9hn/+w+vP/lP+AlCqMg03MvrUllMF80HzT7z2V55z3bGveKMydku4jjiRe+YHJrDr7NhOMQ6BXyJ8NepXydxEE1yWUCR3Vautfbg+ccfLRS1Z1Cp0yQKF1IAQJKPzuX6nwAz9SCA/CVAaZ2ntchg41+vd3+q90UtAp1GH7NwQojai8s5hdoWyEtfWNNEp0ZXc38am1kAnEGpxTUhc96ibZnacqRoFx9pMsfna7Qwan/VhIXPpHPIfjB2hTuaT5dC/H7KoeLKuXvXu0epEZM3Qp+vBJ0jvHY/F9rqj/sq9kRBzDNlnhNDBQ3rT5YXfP/uvaWg2BakMle7Uspgzgd12IJ3Yrcjxdrfz3PJxrHDuFgEaXcmIChr37t6+khmguZ1LHiDRo95MHDKI5ymaCy2Iotnn138BIuHgx2orjlVX+Acg9f7j//9tXht4QMGVLPsNFgZ7DDN+baukKo1kqHmE/h0LuIa1UqTby1faNg+0bB9o2C7RsF2zcKtm8UbN8o2L5R8Pkq/LdvFGzfKNi+UbB9o+Dvx4TtGwXbNwq2bxRs3yjYvlEA2zcKtm8UbN8o+K1O3O0bBds3CrZvFGzfKNi+UbB9o2D7RsEnv1EQCtNo3rDMhVStol1fJXm8erngNI4yKqDcO46uruiW6g3VOVHzTxUaqr48jaMLYSTlXbn2Mq4LBqkI7hyppOy5TyP3j2jl2J/afOW7VnJKFY9+xrMkwdLdOrZd43nw+vAoiqP6Q6xCpzTHiDm9vCDmvsopqCBXBwr+tjQXalZxTV7kYVKNIxVNdAskz7lAMvzRKu2jgsAVht3KSU8G/UtEbZxwdeWLL7kEz4/3XTfOCIytR9POnS6Xy/8BSLjyLA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztPF1zG0eOfwU3tVWOuUNSpGXHp/K51rGzie68tiqSy7UnaZXmDMhpa6Z70t0jilGxKg/7D+7pqu5e9qf5l1wB3TOcoSjJdrxZ3x3z4Ij9gQbQABpAY/oqcmJmo73j6IVOqgKVs9FpHKVoEyNLJ7WK9qKjDMFiPrVypuDZwT7MUKERDi0IePPDS3CZcIBKTHK0MDWI1i1yBBov1Qz0FASkAf4A/qwrSIQCkVsNUiV5lSJoXkzkUBrspziVClOYy3SGzsYwz2SSgcs8TDQ8H1PpQBvAy1KoFKpSKxAWFGKK6QCOMmmhNPpCpoxojQ1elmgkqoSAFTIXBpxm2O9/+a9DIvHPujJE7/tf/humuZ6DVNz/ukTFA0RZDk7UiTqS5R68KXMtUljoysDBiz82hBJUajvu9V7gpJrBm/1e7/SrzLnS7g2HBEOXqAitXEzsINHFMKWBZTq9TySjQYLqaRVW5gsQaYspLkMFiS4XkGhtUqloR2IoxQxBVcUEjY2BOFNog0SDAIMiXfSd7lcW4V8PX7+CqTaFcAM4yCsbN8ul0mDi8oUHT7TXVN2zMBEWH+2CdUaqWQyFOCe2Sgc/VTI5J7ItqrRm6rODfeZVr3dYlaU2DlN460nY6/Wo5xskHguDPD7RRaEVlMKIAh0a66WLug3+VEnDcuEyEHle82LvRPWh11OiwL1eD94o+VOFIFNUTk4lGqISHMmDnzDw492i5PH7KpUJizMhQK0ksp2hxFQaelhiQiD90BarQasgpcTDufD7X+Yi8WQZtCUmTl5gF/BlDAsC/AKVrjHItJE/a+VEztt3gcbJROTtbSYEWR2cMI7YX2qpXN0aVmg0jXabNzHIIaGWEnMLqbjHIlyIvEIbsJrHkBFWP2Bp0JJVqOES41UKGcpZduN6In1XWdcBDJUlNNtYhLXqXWX2IrNtKnKLIKcdXhbiHFurNRZjAN8sIMWpqHIXgyQJdabCAbzSjjQ1lwkZJpYBUjbhKoN93uUgPoOu+BysbEYqp1M0pMzUySDCnBo7kktvZIg81jSXCQVarW10onNtrosQN3f5CIlWji3lswshc0beE2sbcznJRXIewySvMAaDqVf0Bea5nsdeP3gIGUTPc+YPmXGSQq0If6XD8tKCDVg1hrPWP+psjDMtIm2bq0HLp5pWJhbUKglYCJnHzLgY3ukJOOlyjEnBS6EWMaTCYQwOL91EX8aQZJicT/Rl4NdUK2flzxu0ru75eK6NY9iN4VEMj2MY7cQwGscw2o1h9CiG0eMYxjsxjMcxjHdjGD/yPB0/DvwUDRPbCIzGnpPuy+Ig2duX0rKGkqG0je2dd2zvaAC9XqMV1Pbjjz+eqKsTBXASkZKcRHtwEjVDTqLY95Hto75R+H1JPx6Mvw4/F/Tz0fhx+DnnoaPd8DOjn+PRiVqGBU/UmDFxoihvwYK6PysG4VcQFGrjRamttkvUSAYlrjtoPzr4UMeyTcsDokUq6aTI7c3k1CO+IIpWKF0japeIYpG8mSLu/oLIaeNDPWzufBebx1ZXrdSMxfga9Q8H4YS4mXi/7BdDewudX0f6IyKdzM8RmZ+b6W8s1BfEhHWcfh0nvh7wQc7W92Y+hAFfEBe6GP06HjwmHtDBczMDqPcLor6FDnWEU9z37ez2Rw/7453xbocDFBP5AUXRT9P+YrH4HNwjvyYsT25N7Wl6D004hKnRxYYwgr381ajg9/Dftev9J3K4J7UvimkdszZeSRPptb1lp1OxuGc9qHpq44DR+JX7tWihyV2EB0e9SaZlEpCnMbXbNaHAbkA86DMnh2k6bHGSGtO0XxT9tUb62WfGtxqLYpCmg7WR13bHNxaQpjFcb97YnqZQFMUNzb690zwsiutUDIoi4Mb0nqh/JjUJntnNmhIG/FbKstKJ7sK3KhLlDLTKeW0OzDZr0tpxk0kVOoJYwdoAg7MqFwYvKcK0Uis/+vNrWa1kK/+dI9KQE8DafYavXgcf/X5QACKhC4Ba7p53jTIC8gySyjpdgMEZXkIpnEOjGNiFyGUqOCjrcwNeiqIkR3/4l5OT9Pe/G3IqgaJ1B7QTkMqZpAzQ8C/Hz/r/frphRFWWaBJhEXKklWwM6JIBHGeYl6sk1Hw+H8wf2CTTOvcZqHfW4NT/e6Yn784Y3XIgbHl/E6VeNFqhO4nOeuRu0XU4JizUMzcE7yxjHMKMdvi8DVHNLQduGPEFnTlrKFGnz4NQ9/FJVAh2SUiUcfW3dhmak+i0mePDdUzvmHv6AcqayRRzMcH8etcHK1rTnIuFroJ+1+mpLqlBolt8o45CqiYDweTsxK1OcbnW6fuWG/TbM6StnfWhU6tnvQOQS1vnYLrsbM8OSSpONVICmcR2glBPgEkjpb9aCxrEPkwNvCUKe3fHEjQOeGCTIGxyArev0NmYNmMIRiGVLKqiyXROG6g1y4rgfbT5RTMri6Zeob2711YQl3esQGnFmxc4USPOZMhCzG5xTLn7C7ISAZ9rPvaIkyGeGbfEm9x/OzmjnQ45D7vkPNr5BNehs+ythLb8g52WRTFFlYvPetoHmCRVz3VRVs5LVTjnyS1ly1qLV53C9Snp38fQj6EXwzCGr2K4P4AfkJO+SZMgDtImjU8DSwWprih3l1QmX8DEiIRuXnAwG8DV1U+VUE66xXIJPbi6oouy5XJA+nmu9NzniI8vpJUO6I5ndRqnOrEb7oR0Yod0bA9f4bxfX9MNA2r34Su9Zo9u9X0CCz7W2blp2t/VA4jiSJd00Si12k+jvai+hIxiFjq07hudLqK9qygkf+nPkFqlScN3li4wryKbZFgI+qsWVrrynMocozjyV4o2iiPOFND9JylZtBfpyTtMXBSTD1vSMYeWYPC8vat6lL8Ii+IQN0Z7kb8hi+IoeHJNE6BKNEVnZTqNlvWCt4FqWlagLP/R3MgRHLo7+kQwr2jqcu3K95MgvWhBYNoKPNKkjzk6fCEWtgXXy1O0ftNMc0hekjALUrGwlC+vrD+TE5EnVU4xKF6W0iyagJgD0YYlLXyblRp8Rw+X9aa3MLphr43++A1KUBMDOPn4sXPfaZwg/iE0kAHg/RXFR2PxTiNMkPe2zLT66Pmj8YPRePRgNCYIIYP0sTBqY0Yg3unJ2SfJe4oXND8YvNZsYYxYRHEkHRb27q30vdfX7orgM7qGwbT2CPurO8MYON8/uEsb6vHMeTHDu8X+6Ka75Nb1ls10lad0cYTCDPhK95OrC7qa1ByVgzv0ZhlHl3cTcwmJ7tcX1fBVjlPnw1FItFFo7rezXF8McePd3WUcLe4mb/G/kryvafPmd1P3lm/4V9UP/whcHzxexlF2N67fNzUI/0Bkdx8tV+d4lBgUDh0WJQE5m+h0cVbbrWV7YO3J1CeWHxoOpSWtmKdoyOm5bq9WpoZGUq3N2fpRM9E6R6E2GJrOxbQgW2fZUyMnLaR55xmyt9w4cAzdNiFxcOm810SX3biWWZOW4hRT4Uk0gP1pyxfnoHT9brwey3fjSsM9Xu/MVmzG7w3Db+LQvXZdEJVerNLbNQo8GOotoIqfPCe8yYMYQPMfe5cNJwmB+sSuF777qHjuM3q8YJjUrTKB4KUO4LlQTRVC97Yfrq4aIWDpWC7h6op2Fc0ZnfvLZbxqoLU6DXy0+xaDCcqLzqymCVcTm7bWVO9MnaUcqlBDOO/bCPjyubPKBDjkcy6Xg45AriEOGTv6zANMGzmjErrrVDcuE+/0B3P/GrODBBCQ/zd8f1I+/V5uQOXJsHz6pHz6lmrKSvS659kzlSr1mj/HPB/AE+uMVrOnayx4Mgztm7fS4IXEOSsu7+oKyjpvG0CDgBMVWbY2T1pITJVIkXMq2+gE60I/jj/x0oF1WFqKHaXz1ZxcEsSev5gZRK66JFxE5biGjoPAesEnAjKD03+5t8bTe0+5ppNC8SdD8TSM3vcBbCYuEIRaABPOCUZtfIZwWhk2k0kujJyGiDOGMkdKu1NAKhIf9XqO1ngcZUKd2/jJxDw9QlE0VaXv//o3GsFqwKW0R7oyH2DTOd7u+731qQBv8zwQEDCr+ELQEZ9q88Q3Aqu6NamsM5XPzUFambpUr66Z5f2wdhAq8/qQSuuLlzJsw48BlfXTBUyFdWhiqJRUDo2pSpKc62W4HVHmBZYU3/saVNqju21Bt0CMSpJ9+WyrYrg+B2rAGCqGQ6jZFCfW1bvrpG88eIOe3I0gHZKcOwpp2RKN1YpkSZuZUEFUveOvLQVumcj9UK+vkq5TCR86fwcbg6z3f/1bC68bo8/riPkVRJrSfdUdGHIylrKullOyBst8AU53MSJ4aP6w7msRdgWaGZ4lFJWxzuAHSHivRzLe60HfV9YF8baVL7Z0dd0w7yNt6Qo68S3Y/+ZKvE4upJ1y7QF8r+d4QQIbVJgMrYevKRfImKexB9FaIRGKyv/YNSLvhAA3V+GF4GRhWMLX5bGIMzXByND1m1+P61xpnfg2mmpRbu76Bde3h9W9wHviKFMFItdcVehaFfRpF6l9LmHM2BRYytZRJs6vU9cO67lC8/6X/6Sa+jo/ahv3bmMve2hc5c/1kW2otbdWF/sOuv6YtwJ3+cvepV5l9IIXR6XWWlkf9I93duh/XYGqk6jg/fUUbJWQkk+rPF/8UxR/eDrx9oyDb97sxd+WQsjeyfHPl8nF+IBU5gYLeCuAEPFUJqdqf+Jcv9lw1sQWb6XKpcKzmm1n452dsxHxdhlHu5vYd6gL9MIyJybO6VxvtMaZBYgZiT353+YzchON0eb2gOjjMLuNCbsdJjy8zoR9xbec/D3MkT5H9dtS2l7e+eUJ1cuCZcUfSpH0g7g/6hDbbvdEWkwqI90i2ju+ii77opR93793fLo8JcPtMk1J+FJbxli4LNqLhq2cvEVzQYl0gsBC28ihFSqlS8hr0bco5fBiNBhFy3h9zsZo/ZbxWPU/dop1YibV7K55pyvuHNIO+k3q8GiVkyzlvyElJcMWtEfFkSTJyVCkFOVTTtRq9cPqJuPbenvrO4ZN1wYto7h2EVDfA3RS++uH6YZk/eZc/ehhO0vu8+Cc2m4y25uS1Q3hdfq5yT63EsqtfPIqRdzJEHPSt5XzPV7pQpNerbOrI05Ljnd3OX/39YgTXQ8ecw5p99HytJNOiaJuyoQvLNcD/18Xx3bD2G1s9n8oNuuGZr6KZi1UqQWsCQ06/vm6e36jq7zRU66DI6mmmm1OUJbmw0Q6DdhmXcvrYp7oovnYpNdrUdbM6vUaW+J3h1zD15WBUs/RTCv/9co0x0tJsR9Nw4L7VjlEFEWO1uYLoKBvxg4pl6uJvAmpElGKicwlHXc0TAc5WZ2YdgBvV1nIe8bfYF9gTqckiZAuBIdsTbg21+acvtWkTx5hQjf7FMugyoRKfNjkDXhMMkIfVFJIWhpp6Rs6Q1hLj5tWzpBwFEKJGYtt3BYDSDEnLbZg9ISqXqzOKy98TshcG39PyQSRKFpm4reXJXVxcppMn8GM9vsiBM+WvulJEbxtDl9tTiiXVRIuknxpp6FSuaYPLCmPVeU5lJqcDVJLPe3gSNOdEcqSjxiuRsMeNAwLcS3aEJW8sUg7/FKqc/9xUB+OG7l6ixMrHXYLB9dl9n53znfSfV9N6BNCbaXTZrGaPZMuqyZ8yraBND88pO/CV8bQOkM/vFjiEB1JiB0+O9hn/+w+vP/lP+AlCqMg03MvrUllMF80HzT7z2V55z3bGveKMydku4jjiRe+YHJrDr7NhOMQ6BXyJ8NepXydxEE1yWUCR3Vautfbg+ccfLRS1Z1Cp0yQKF1IAQJKPzuX6nwAz9SCA/CVAaZ2ntchg41+vd3+q90UtAp1GH7NwQojai8s5hdoWyEtfWNNEp0ZXc38am1kAnEGpxTUhc96ibZnacqRoFx9pMsfna7Qwan/VhIXPpHPIfjB2hTuaT5dC/H7KoeLKuXvXu0epEZM3Qp+vBJ0jvHY/F9rqj/sq9kRBzDNlnhNDBQ3rT5YXfP/uvaWg2BakMle7Uspgzgd12IJ3Yrcjxdrfz3PJxrHDuFgEaXcmIChr37t6+khmguZ1LHiDRo95MHDKI5ymaCy2Iotnn138BIuHgx2orjlVX+Acg9f7j//9tXht4QMGVLPsNFgZ7DDN+baukKo1kqHmE/h0LuIa1UqTby1faNg+0bB9o2C7RsF2zcKtm8UbN8o2L5R8Pkq/LdvFGzfKNi+UbB9o+Dvx4TtGwXbNwq2bxRs3yjYvlEA2zcKtm8UbN8o+K1O3O0bBds3CrZvFGzfKNi+UbB9o2D7RsEnv1EQCtNo3rDMhVStol1fJXm8erngNI4yKqDcO46uruiW6g3VOVHzTxUaqr48jaMLYSTlXbn2Mq4LBqkI7hyppOy5TyP3j2jl2J/afOW7VnJKFY9+xrMkwdLdOrZd43nw+vAoiqP6Q6xCpzTHiDm9vCDmvsopqCBXBwr+tjQXalZxTV7kYVKNIxVNdAskz7lAMvzRKu2jgsAVht3KSU8G/UtEbZxwdeWLL7kEz4/3XTfOCIytR9POnS6Xy/8BSLjyLA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,f={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.635276a4.js b/assets/js/34593b53.635276a4.js new file mode 100644 index 000000000..df6638e82 --- /dev/null +++ b/assets/js/34593b53.635276a4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kt2AhZPcXqQ9RhrlYxtKSxteOVFBa1jllSw0FXZXdDrALKAIrNHkZHzMP8wT7t63yav2QjE0AdfZCURHskb/tBZqNwJBKZiURel5HlUxMdHEfPVFoVIK2J3sVRBibVorRCyeggOpoBe6qBW2ChFzt8/YLxPFdzwyoD2jCr2BQkaOwlYc6yMB8bL1ip1bnIhJyyjFvO5sLO2JgbeLDPQKYqg4xNRA7JiTyRR6I8YG/LXPGMLVSl2etnf6hnw2Ww7bjXewbjasrevuj13n01s7Y0B/0+L8tElSCNmMqcj02SqqKfYccym9yN2XwGGnBWlnLJgBuRLxjPMjYX2RSsiZmdgWSpKhcsVUpnQnILJmYlnwKTVTEGbWLGZcYKpYEJyTjTwLPFnlV7lQH2H29evWQTpQtuE/Y6r0xcL5cJDanNF256O4N6V3dMwIaxWshpzAp+htgSlv1UifQMt21AZvh/HHj4+gXhqtd7U5Wl0hYy9qPbwkGvh1++gVzNGddA/VNVFEqykmtegKXjmnFLnzX8VAkNmTsUnucBFwcnco/1epIXcNDrsbdS/FQBExlIKyYCNO6S2ZkwfkDi+ttFSf1fyEykiDwCAFuZmnS7IlKx65sSUpzSdW2hminJ5jORzgiHc+7Ov8x56ralwZSQWnEO3YkvYrbAiZ+BVAGCmdLir0pantPxnYO2IuV5+5gRQOxqLNcW0V8qIW1o9SuwP/njxNOmQ/R0iKBliNxCSPpigJ3zvALjoZrHbIZQ/QClBkOs4edFxMuMzUBMZ1vX49n7ytjOxKwyCGYbCr9WOFVCLxDaJjw3wMSkg8uCn0FrNaaI53mesG8WLIMJr3IbM4EUanUFCXupLONlmYuUj3MgGkBm47bSsEen7Mkn6ZLPa5IAYBhnmZhMQCMz40eawo8J0CFdNiKDOM3OuGRKrhx0qnKl10mImrt4ZKmSFqRN2OE5FzkB7zZrmJBpXmXAxjlPz2I2ziuImYbMMfoCUMzFXmhhF8aNxznhhxnIkQqVRPil8ssLw4yHKkvYETJKzX/4MaCaFhGmjVXP5ROFKyMKAksyKLjIY0JczN6rMbPC5hAjg5dcLmKUrxAzCxd2rC5ils4gPaO/NM+EYuPKWiXdxjKtykzNpcflRElrxF83cGT48uEYHcVsP2YPYvYoZsNBzIajmA33YzZ8ELPho5iNBjEbjWI22o/Z6IEDa/TI45rXCG4DMBw5LNsvB7sop78XhjgbBaypZfa8I7OHCev1am7Ctr/85S8n8vJEMnYSIXOdRAfsJKq7nESx+4YyE78N/e8L/HFv9ND/XODPB6NH/uecug73/c8Z/hwNT+TSL3giRwSJ5UV5BRT4+VYh8L88EWEbLYptQZ5hIwqiOHzAs+rAgx+W7b3cw70IKazgudm+ndDjM9pRA9LapvZxU0Su23dEnz+j7bThwS8kJt0nEqutT4HhCYrR2u7vJ/5m2b55t+xns/cWOJ+29Qe4dRRNRyiatu+/ll6fERJWYfo0TDxMSAEgybwdD77DZ4SFLkSfhoNHiAO8lLYjAL9+RrtvgYMf/A3vvg3294b390aD0X4HA/iWch2KYi/L9haLxW1gD3UevzyqPEFDdZodvmInWhUbnh/0Omh6eZ2I/g4q+3+ioj4OOixk+E6kh0XQWOoXYlvLtirjizvGTRWG1soZ9m9Us0ULTPqEcNBrOZ0pkXrgsU9Qycb4IEwQB3uEyX6W9VuYxMYs2yuKvZVG/LlHiG81FkWSZclKz7XTcY0Fy7KYrTdvbM8yVhTFlmbX3mnuF8X6LpKi8LCR8vU1MonX2bbzie/wa7FKwxHdha9kI7Q0KJnT2vSc28xHK5fNTEj/wRMVW+mgYVrlXMMFvkuNUNL1vn0eCyzWaPb0jvWWBAiKNfvqldfe73ryxy10J8CW68et7QwnOWRpZawqmIYpXLCSWwta0mTnPBcZp6fcHjXABS9KfAL0/3xykv3uX/tkgMA3vmV4EiwTU4F2o/6fjw/3/vvdhh5VWYJOuQGWA65kYgY2TdjxDPKyMV3N5/Nkfs+kM6VyZ7d6bzRM3L+navz+lMAtE27Ku5t26kij9eBH0ll97xuwHYxxw8LIDU9+ojHioeGAblv/3rniuvU9PqMbZwUk/OisJ/j5+CQqOCkkSMrQ/K3sDPRJ9K4e4x75kF0z9t0NmHUmMsj5GPL1TzdmtLo55wtVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi5WP7ttyA387hLS5M1w5gT3DCbBcmGC56aKzPdqbtshAKQHI5jkGFgagOTlIj0/lghqwm7GBk0T+7K5ZAvsx6libFcNq16zQOZg2YnCOQkhRVEVtH53UswaUFV73aOMLR6KVPqzQPt21FfjFNSugMXL7AidySHaMYP+4QjP1PT4jWbEC0tVs/DFSpHNP39IFez0Dhm21GXDDtYxd3YVcM5/Zzn0Je4XXG9pk3SC0sqUplBYtcp/KmjXIN76hyGbVtsNtp7x2r8+I+jaA9QtToO9327fPRxFpe/dfEKF2wL4xsTqjZMGnV7zc6fNnRJ4enjUjxJCMke6+uMIgR9+v3s5w0NnO/e52Hgw+4nXVWfbTH1eDurF5VT2X6HNYWwjf5VXOb1XU+zmRNJ+qoqxsmxfoyU/8Hi7v4FZzbsLfxWwvZr2Y9WP2VczuJuwHIEdcWjvt/F0utHPNCckyVaHPJK10vmBjzVP0hkMyTdjl5U8Vl1bYxXLJeuzyEl3/y2WCzHEm1dz57Y7PhRGWod+9eetkKjUb/PQqNX18FPVfwnwvRBr0PWh32VdqhVOvfFl6FHzoU3LbsF/4fdXrvdYwEXnecuOz0BQOB92ikEPhXcfegY/qIjmThLQKERBCJXq9MUwUOpIwjgDdkTPeOPqdvuZEYzsWgaUY6aE0m3Hj3rH0cMbNYaCEnUHhIX6pLDh/timVNOBEebkB6MYf3eut+MNCt8YnJmTYOAqT4e0Zb0ZfD9rSZfjgfkdY3u+Kl8E28XKF7QaFiMNFMHhD86nF9yR+Qvs6069yfZgUke2ETSAxR3uqyjOWizNybWbClDlfIFmEq9JDueozfzpTyjQ9vNvac5k56LrDlUaP+N2k9g5+qtV5+PBeR9Y/ugVT2opxuXsYg/3+8H7/Suvyik30w6U1Yzc5OTLb3ujkqGdzdDsr8MdagW+H8O/dphFs+HDU0d3uDT6dAW7J1tVmnGusXLdhy7o1o1Kb3W5oTvrVzDqfTn37v8QDd0UMPxzeghje8o79VEpce67eGu2x23qrbiLAGzxWr3yhfjKBtoH9xYn0/u08bIeDjq72dUdV+3rUJsr7929ElO1FVyjrJBL/9c2rH+aDP347VYeHh4cv37ydPX87PTw8LPB3kiQbbRqbTpuWQR3WB/T6e5nu+C2rJEmCKMTI6AMa3i/l9N/c+Hj7mORERnGkSgy5Fkq+yKKDiHR3CKp8FNNrF4z9RmWL6OAy8iF7+KcPiMOh/fcG47wvI5POoOD4V9DXMTIcI7OjmKLOQJsojiiGA8PE8Uijg0iN30OKq5UawbECDM5B4w4uQy8X2hzFXueKDiK3xSiOvJetbqqDwstsEi3DgldNVbc0Uxn6o37X4DwYDfyR0+BjB6foRMZ/1EzPWjPQ3go4Uviaz8HCM74wrXndazRaDcjHMcjsqR/FMr4wKDQq4y64lOdplaNeCBel0Is6VIGUwxZ91PDWK9XwDu8vm0NvQOJa80UUR8JC0W7fQgRaffjJpaAQMxQv9qFj3ysYA/zeN6BdgQ6eFx8MxXsFbAx06OVMyQ8ePxzdG46G94YjnMEH/XzoHMFGglO8V+PTj2KEDM5xvH9pf/xRuq/ra3dp8xCjaiELetdeEx4eMwrRTK5jk9CfMM+ncD0/HG1LG2hFK5sZPbZ4WQLXCUXvf3QiSZfF6gs+uYahlnF0cf1mLliq9kJOAvsqh4l1MQQsVVqCvtsOTPpsNjfa31/G0eL67S2+yO09xMObX7+7HymZo0l0+WfAeu/RMo5m18P6XZ1u8k8Edv/BsrngV/SX07HKFqdBbi2v6xjuKuw3UXkGGnWidXnViBqUMJhWdbp61YyVyoHLDYKmk2fgE+BQ/0bbr7fJzGdARvhaLafZG53fW4odtJi7ACvhUMKguqwrOIkS9mLSekGQRr+a6hD6UtqBVOwOrXdqKhLjd/r+N+LoTjsFDC2zTURiAIE6MwtFmVNO1ByNuWNy72cJq/8j5bPGJAIQbuyw8PVXxVMXhkUL+kHdhCLm1deEPeWyTirpJm+wy8uaDIg6lkt2eYmnCvoU7/3lMm4acK1OA13trkVDCuK8M6pugmZg3dYa6rSs04w8INjg7/s2AGIqhZyeVtrPg8rocpl0CHIFcLLBexxAVtOZmMoNu65VJjrpG2N/DdmeAnCS/zd4f1w++U5sAOVxv3zyuHzyI6YPluB4z6FnImTmOH8OeZ6wx8ZqJadPVlDwuO/bNx+lhnMBc2JcOtVmllXc1hMlHqY/oaBuDk8YluoqFTyn+EOtUgiuHnJr4SPeWCgNuqSEpZEuw4ueBHyqgRxLBAuvLKVL0uswLPiYs5mGyb/fWcHpnSdvEHT08D3u8ye+9wtnlpjxc2BcLhhtnGwoSjs73KTSJCbTnGsx8U/RmJU5YKwkvlR56pxpDqMBjqMZl2cmfjzWT46AF+xVCRIh+Pnv/8AeQaa/kK90BvoGQv3FxLntFLuDcuxO7OI2idyFNtaLaicJPYU4uLawjs/bQZff81r0m2pssJcM8zWi1WoxnQK65nwPGuyz4ICnM3dpEFR8ErwIJRKPqkwADwksPAgz78X1B9W1+rSwQ17B9t6TTVJdYtrcq6PXN8AlmaT2HKM4e4zbpZuDvTp6jZm39XEn7K2pMRFQyztdGFoC2LngITuv1uwXLtYNnF/Fy8W2KzPxOa97bB2gTJiNEMXuUkcJV+e1r03cpHLjEanKomtU+IRD4rIOHgmKGpFHqroJVV6DSc6mFaUWWGTfcGtSdHGTOSuksbpycX4sq3RIFvZk4cSEMQ2eAlawU2v+mIE0bjhnE24s6JhVUiDmdYVWynpKuChBC4wp2IgCDQ51KDquv6K6aahvf/jeJ/CHPQSmHCMHuokhY1VJVEOcUKdHh5Nb3fpGfdCL7+sBRN2NIiW8qbUEbZREEaf0lEsvQd17FO2pY5jx3HX1ogJdcggPcniy8e3/89//0YJrq1FkHTC3As8yjH2/BkIyTTuCx/BODSVKQNWFCOcD/fvVJwBCR0xzWqisZiRzcxp/TdHyppaLPtSgDnUwVTrDa6uWtyYOMtZ4o4IhKzSZqilWocT9woUwtpXgG9Jw1uXDD4B4TFsw0CMUuRppXi7aDN6EYKiV6eh5ILrJ4fUjaI0XeGXVqYZCyJvdU22rv1W1IKisKrgVKQtTmaSb8u9cy4GvC/ZVAA2p8VwofXcLq+J0p0qmcCrkKZyDvsHz/mUdNkw2yTHYOYBswxaQ5K6zJi17jpU3Ojhp3U5UfKANJRonC9BTOE3RQkVUBzdAYq+HU/V6bM8B4mWqqbT3z/hyGSQ8UI40syM4XheuM7qaC7ddpSRh36k5IqxWZ1DpdPMjPhlBnsVuitYKKZeY2U7PRHyp4cS1D7/gFI/ll3BhNHRYtBuvcKXOcYOzYHkHXCe+ak9BftapahxLNITVHTu4zaE5n/FcET95tdJ/7gD1grLzZ3T/0Pmhn8mtE0pmqLkE/fPf/tdQtJALQTP1U3fjV3qt8twol/rfnjWQcyD4pPs2DfTsA5M22Tm7JBIKboRsqSA9nOJBhWOKMUaYUnQVqVN0zYQ3/Zrh9BezvF5lRvVBPzsj6hdkZRwOBr9lI+q9wZdjRN0ffEFG1EcIrHd/Xy9Ntqm2G2VH8HFfPeC9AuflypW+uif6lMk+64IwNiG4YYfR0v3X2H2DEL/GFuyMxY0T279kw2YIDaPBAP/XPc5nnShYfNdUKb4TJlWeL/4lim/uQb/6DFzzZvv0VVJ99l6M/nqRno9eR947231IfeDF8lEuVhyz6mDd8py7ciueISqdY/E03MterUjQtK0zFjIXEk7DAZ5mKj0Nu1+SKmhM95a7EQz1cZOBpXvW1ywfOcLc30RFb1QBTgOa47xzNNzVqqDVC8anqMshj+tbJCrQ+jr2+zDIrkLB/mBwOqyRcH8dCS8k5Z5SpcAjdQby191pe3nrlkdQL4q8kYGRcJ3oe9TZbLvdbdJAWmlhF9HB8WV0scdLsee+Hxy/W75DErQzhUE4pTIEMbez6CDqr8XkGNDnFFNxfOn4pmYFw2WGkYRr9wMvRf98mAyjZbw6ZuN9ckV/qPY+dIixfCrk9Lpx7xocvcFzdEfVwVQjp0rxR0BB5Q+i3SuOBNLPDDi+ixH1SB4/NJFMz8MhhxijTWFDzWGuBgKFOKBOaM/qvb4hWGdzrM7wfitK5jgEvFAMSx3Csikqpd56iDOpw0xakSOtwJEmFqQTCkLRHa3gjuOGJ+o4ivACGJLqPNrfJx3z4ZCUsXuPSM/Zf7AkKm4cp1HUdY5SstSqi+/TPFZdh9XOC/Mb8sKsOGE88TSeBBeu2zGJ+6auiThQYW2S7dhFV82iW02UWyyUfskVS1wNyCYD2P2Ndic/pGVj2MCRQa3u8iOGuiI/3hsQP+4PiB8fDToavd97M0Ojl5PyXevepGC39WtUot+hEBVyokgCe8ERToxuSJLga+8wyFNV1AUTe73WIdejer1asjpCRRvQq0qzUs1BTypXgXGSw4VAKx8Og4K+NYETwIscjMkx98XClCxPVFgF3SneYJ/yko9FLlAFcKlujmUaLcIk7Mcm9OKOdtmA55Cj5lDbSbEGcdD65kqfTTCEI2acjTFLEi3lIGdcps4o764zMi6j3QcdHqUWBmvEaoRaONiUtBr5pOCST4mD4zZHsAxyFGiGaTVGn5VReeX40HKRK+2iNmlDFB9OSHx+UeInekziNaBhhlR97l0zJnauMXdT+arEY/RClgiLQKOZVaySucICwujNrPKclco6DyO+Wdsw4nCruTSoMPtAUX8GNcK81wSMNz++NYAn/L2QZ66I5R47runqRxgbYaFb4maVM+92x3wr7HfVGEvkKiOs0otm9FTYWTUmnaM9Sf3DzfRtqEHd0ihunnj6BixSiOkfvn5BOutd9vPf/od9D1xLNlNzR61ppSFfNOWuqRw0nbxDW61ykl8OxThiPHXE52+fgMEfZ9ySrfMlzNGo7FjKxZe/rsa5SNlRiMXp9Q5CHe4mPqdTksMleKKzlLPSjc6FPEvYoVyQe6e5i7CdxnW2Qfdfq3Q3x4BiJX0igFszaSAih4KB/BxMy3YNmXAuaK2qqVutDYzfXDffFfd2mGVr6aPovGjAcRZX8v1yZ3rFKtsbMk476aTdwBWQGdV1Ngcs03xim/njlSRYugnXmkL+bEBH7Kepj8Rxot9x3eqs0ivacFfekrUbF+xWU+el8OR0HMiSdWtHfThZO2sNXe4tOwCq5Rvde1jV2ryavAF9LtLweN/C0X3q3I/iKBcpeNORv78Ov339PTu/lwyiuPXGuAFz979/8fT5yzfPERgUpA5hw2SQDMjCrYwtuGyttFKvfvVua6VC7Mrb78rb78rb78rb78rb78rb78rb78rb78rb/1r1pHbl7Xfl7Xfl7bdgYlfeflfe/lOrqOzK2//mCxvtytvvytvvytvvytvvytvvytvvytvvytvvytt/EVXDd+Xtfw0K3JW335W335W335W335W335W335W374iXXXn7XXn7XXn7k9+IFXhX3n5X3n5X3n5X3n5X3n5X3v43Vd6+lTnVL3MuZCvZ3CXYHq8WvX8XRzPMwD04ji4vcZm3mB+HzT9VlMF1/C6OzrkWGC1HybtxyDXFXK0zwFTEpy74b+8I148db1N8/ErOMibLuhGHRNBX9m0nCb9+9eYoiqNQqrNQGVVH4HPM7eJzl/jWSgCjtsso53JaUfJY5OZcukJSs25u7Rnl1vo/WhlomEnaQNhNunXbwH9xUxsHXF66vF1K3XT93aetIzxiQ288v3fL5fL/ANvhY4A=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kt2AhZPcXqQ9RhrlYxtKSxteOVFBa1jllSw0FXZXdDrALKAIrNHkZHzMP8wT7t63yav2QjE0AdfZCURHskb/tBZqNwJBKZiURel5HlUxMdHEfPVFoVIK2J3sVRBibVorRCyeggOpoBe6qBW2ChFzt8/YLxPFdzwyoD2jCr2BQkaOwlYc6yMB8bL1ip1bnIhJyyjFvO5sLO2JgbeLDPQKYqg4xNRA7JiTyRR6I8YG/LXPGMLVSl2etnf6hnw2Ww7bjXewbjasrevuj13n01s7Y0B/0+L8tElSCNmMqcj02SqqKfYccym9yN2XwGGnBWlnLJgBuRLxjPMjYX2RSsiZmdgWSpKhcsVUpnQnILJmYlnwKTVTEGbWLGZcYKpYEJyTjTwLPFnlV7lQH2H29evWQTpQtuE/Y6r0xcL5cJDanNF256O4N6V3dMwIaxWshpzAp+htgSlv1UifQMt21AZvh/HHj4+gXhqtd7U5Wl0hYy9qPbwkGvh1++gVzNGddA/VNVFEqykmtegKXjmnFLnzX8VAkNmTsUnucBFwcnco/1epIXcNDrsbdS/FQBExlIKyYCNO6S2ZkwfkDi+ttFSf1fyEykiDwCAFuZmnS7IlKx65sSUpzSdW2hminJ5jORzgiHc+7Ov8x56ralwZSQWnEO3YkvYrbAiZ+BVAGCmdLir0pantPxnYO2IuV5+5gRQOxqLNcW0V8qIW1o9SuwP/njxNOmQ/R0iKBliNxCSPpigJ3zvALjoZrHbIZQ/QClBkOs4edFxMuMzUBMZ1vX49n7ytjOxKwyCGYbCr9WOFVCLxDaJjw3wMSkg8uCn0FrNaaI53mesG8WLIMJr3IbM4EUanUFCXupLONlmYuUj3MgGkBm47bSsEen7Mkn6ZLPa5IAYBhnmZhMQCMz40eawo8J0CFdNiKDOM3OuGRKrhx0qnKl10mImrt4ZKmSFqRN2OE5FzkB7zZrmJBpXmXAxjlPz2I2ziuImYbMMfoCUMzFXmhhF8aNxznhhxnIkQqVRPil8ssLw4yHKkvYETJKzX/4MaCaFhGmjVXP5ROFKyMKAksyKLjIY0JczN6rMbPC5hAjg5dcLmKUrxAzCxd2rC5ils4gPaO/NM+EYuPKWiXdxjKtykzNpcflRElrxF83cGT48uEYHcVsP2YPYvYoZsNBzIajmA33YzZ8ELPho5iNBjEbjWI22o/Z6IEDa/TI45rXCG4DMBw5LNsvB7sop78XhjgbBaypZfa8I7OHCev1am7Ctr/85S8n8vJEMnYSIXOdRAfsJKq7nESx+4YyE78N/e8L/HFv9ND/XODPB6NH/uecug73/c8Z/hwNT+TSL3giRwSJ5UV5BRT4+VYh8L88EWEbLYptQZ5hIwqiOHzAs+rAgx+W7b3cw70IKazgudm+ndDjM9pRA9LapvZxU0Su23dEnz+j7bThwS8kJt0nEqutT4HhCYrR2u7vJ/5m2b55t+xns/cWOJ+29Qe4dRRNRyiatu+/ll6fERJWYfo0TDxMSAEgybwdD77DZ4SFLkSfhoNHiAO8lLYjAL9+RrtvgYMf/A3vvg3294b390aD0X4HA/iWch2KYi/L9haLxW1gD3UevzyqPEFDdZodvmInWhUbnh/0Omh6eZ2I/g4q+3+ioj4OOixk+E6kh0XQWOoXYlvLtirjizvGTRWG1soZ9m9Us0ULTPqEcNBrOZ0pkXrgsU9Qycb4IEwQB3uEyX6W9VuYxMYs2yuKvZVG/LlHiG81FkWSZclKz7XTcY0Fy7KYrTdvbM8yVhTFlmbX3mnuF8X6LpKi8LCR8vU1MonX2bbzie/wa7FKwxHdha9kI7Q0KJnT2vSc28xHK5fNTEj/wRMVW+mgYVrlXMMFvkuNUNL1vn0eCyzWaPb0jvWWBAiKNfvqldfe73ryxy10J8CW68et7QwnOWRpZawqmIYpXLCSWwta0mTnPBcZp6fcHjXABS9KfAL0/3xykv3uX/tkgMA3vmV4EiwTU4F2o/6fjw/3/vvdhh5VWYJOuQGWA65kYgY2TdjxDPKyMV3N5/Nkfs+kM6VyZ7d6bzRM3L+navz+lMAtE27Ku5t26kij9eBH0ll97xuwHYxxw8LIDU9+ojHioeGAblv/3rniuvU9PqMbZwUk/OisJ/j5+CQqOCkkSMrQ/K3sDPRJ9K4e4x75kF0z9t0NmHUmMsj5GPL1TzdmtLo55wtVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi5WP7ttyA387hLS5M1w5gT3DCbBcmGC56aKzPdqbtshAKQHI5jkGFgagOTlIj0/lghqwm7GBk0T+7K5ZAvsx6libFcNq16zQOZg2YnCOQkhRVEVtH53UswaUFV73aOMLR6KVPqzQPt21FfjFNSugMXL7AidySHaMYP+4QjP1PT4jWbEC0tVs/DFSpHNP39IFez0Dhm21GXDDtYxd3YVcM5/Zzn0Je4XXG9pk3SC0sqUplBYtcp/KmjXIN76hyGbVtsNtp7x2r8+I+jaA9QtToO9327fPRxFpe/dfEKF2wL4xsTqjZMGnV7zc6fNnRJ4enjUjxJCMke6+uMIgR9+v3s5w0NnO/e52Hgw+4nXVWfbTH1eDurF5VT2X6HNYWwjf5VXOb1XU+zmRNJ+qoqxsmxfoyU/8Hi7v4FZzbsLfxWwvZr2Y9WP2VczuJuwHIEdcWjvt/F0utHPNCckyVaHPJK10vmBjzVP0hkMyTdjl5U8Vl1bYxXLJeuzyEl3/y2WCzHEm1dz57Y7PhRGWod+9eetkKjUb/PQqNX18FPVfwnwvRBr0PWh32VdqhVOvfFl6FHzoU3LbsF/4fdXrvdYwEXnecuOz0BQOB92ikEPhXcfegY/qIjmThLQKERBCJXq9MUwUOpIwjgDdkTPeOPqdvuZEYzsWgaUY6aE0m3Hj3rH0cMbNYaCEnUHhIX6pLDh/timVNOBEebkB6MYf3eut+MNCt8YnJmTYOAqT4e0Zb0ZfD9rSZfjgfkdY3u+Kl8E28XKF7QaFiMNFMHhD86nF9yR+Qvs6069yfZgUke2ETSAxR3uqyjOWizNybWbClDlfIFmEq9JDueozfzpTyjQ9vNvac5k56LrDlUaP+N2k9g5+qtV5+PBeR9Y/ugVT2opxuXsYg/3+8H7/Suvyik30w6U1Yzc5OTLb3ujkqGdzdDsr8MdagW+H8O/dphFs+HDU0d3uDT6dAW7J1tVmnGusXLdhy7o1o1Kb3W5oTvrVzDqfTn37v8QDd0UMPxzeghje8o79VEpce67eGu2x23qrbiLAGzxWr3yhfjKBtoH9xYn0/u08bIeDjq72dUdV+3rUJsr7929ElO1FVyjrJBL/9c2rH+aDP347VYeHh4cv37ydPX87PTw8LPB3kiQbbRqbTpuWQR3WB/T6e5nu+C2rJEmCKMTI6AMa3i/l9N/c+Hj7mORERnGkSgy5Fkq+yKKDiHR3CKp8FNNrF4z9RmWL6OAy8iF7+KcPiMOh/fcG47wvI5POoOD4V9DXMTIcI7OjmKLOQJsojiiGA8PE8Uijg0iN30OKq5UawbECDM5B4w4uQy8X2hzFXueKDiK3xSiOvJetbqqDwstsEi3DgldNVbc0Uxn6o37X4DwYDfyR0+BjB6foRMZ/1EzPWjPQ3go4Uviaz8HCM74wrXndazRaDcjHMcjsqR/FMr4wKDQq4y64lOdplaNeCBel0Is6VIGUwxZ91PDWK9XwDu8vm0NvQOJa80UUR8JC0W7fQgRaffjJpaAQMxQv9qFj3ysYA/zeN6BdgQ6eFx8MxXsFbAx06OVMyQ8ePxzdG46G94YjnMEH/XzoHMFGglO8V+PTj2KEDM5xvH9pf/xRuq/ra3dp8xCjaiELetdeEx4eMwrRTK5jk9CfMM+ncD0/HG1LG2hFK5sZPbZ4WQLXCUXvf3QiSZfF6gs+uYahlnF0cf1mLliq9kJOAvsqh4l1MQQsVVqCvtsOTPpsNjfa31/G0eL67S2+yO09xMObX7+7HymZo0l0+WfAeu/RMo5m18P6XZ1u8k8Edv/BsrngV/SX07HKFqdBbi2v6xjuKuw3UXkGGnWidXnViBqUMJhWdbp61YyVyoHLDYKmk2fgE+BQ/0bbr7fJzGdARvhaLafZG53fW4odtJi7ACvhUMKguqwrOIkS9mLSekGQRr+a6hD6UtqBVOwOrXdqKhLjd/r+N+LoTjsFDC2zTURiAIE6MwtFmVNO1ByNuWNy72cJq/8j5bPGJAIQbuyw8PVXxVMXhkUL+kHdhCLm1deEPeWyTirpJm+wy8uaDIg6lkt2eYmnCvoU7/3lMm4acK1OA13trkVDCuK8M6pugmZg3dYa6rSs04w8INjg7/s2AGIqhZyeVtrPg8rocpl0CHIFcLLBexxAVtOZmMoNu65VJjrpG2N/DdmeAnCS/zd4f1w++U5sAOVxv3zyuHzyI6YPluB4z6FnImTmOH8OeZ6wx8ZqJadPVlDwuO/bNx+lhnMBc2JcOtVmllXc1hMlHqY/oaBuDk8YluoqFTyn+EOtUgiuHnJr4SPeWCgNuqSEpZEuw4ueBHyqgRxLBAuvLKVL0uswLPiYs5mGyb/fWcHpnSdvEHT08D3u8ye+9wtnlpjxc2BcLhhtnGwoSjs73KTSJCbTnGsx8U/RmJU5YKwkvlR56pxpDqMBjqMZl2cmfjzWT46AF+xVCRIh+Pnv/8AeQaa/kK90BvoGQv3FxLntFLuDcuxO7OI2idyFNtaLaicJPYU4uLawjs/bQZff81r0m2pssJcM8zWi1WoxnQK65nwPGuyz4ICnM3dpEFR8ErwIJRKPqkwADwksPAgz78X1B9W1+rSwQ17B9t6TTVJdYtrcq6PXN8AlmaT2HKM4e4zbpZuDvTp6jZm39XEn7K2pMRFQyztdGFoC2LngITuv1uwXLtYNnF/Fy8W2KzPxOa97bB2gTJiNEMXuUkcJV+e1r03cpHLjEanKomtU+IRD4rIOHgmKGpFHqroJVV6DSc6mFaUWWGTfcGtSdHGTOSuksbpycX4sq3RIFvZk4cSEMQ2eAlawU2v+mIE0bjhnE24s6JhVUiDmdYVWynpKuChBC4wp2IgCDQ51KDquv6K6aahvf/jeJ/CHPQSmHCMHuokhY1VJVEOcUKdHh5Nb3fpGfdCL7+sBRN2NIiW8qbUEbZREEaf0lEsvQd17FO2pY5jx3HX1ogJdcggPcniy8e3/89//0YJrq1FkHTC3As8yjH2/BkIyTTuCx/BODSVKQNWFCOcD/fvVJwBCR0xzWqisZiRzcxp/TdHyppaLPtSgDnUwVTrDa6uWtyYOMtZ4o4IhKzSZqilWocT9woUwtpXgG9Jw1uXDD4B4TFsw0CMUuRppXi7aDN6EYKiV6eh5ILrJ4fUjaI0XeGXVqYZCyJvdU22rv1W1IKisKrgVKQtTmaSb8u9cy4GvC/ZVAA2p8VwofXcLq+J0p0qmcCrkKZyDvsHz/mUdNkw2yTHYOYBswxaQ5K6zJi17jpU3Ojhp3U5UfKANJRonC9BTOE3RQkVUBzdAYq+HU/V6bM8B4mWqqbT3z/hyGSQ8UI40syM4XheuM7qaC7ddpSRh36k5IqxWZ1DpdPMjPhlBnsVuitYKKZeY2U7PRHyp4cS1D7/gFI/ll3BhNHRYtBuvcKXOcYOzYHkHXCe+ak9BftapahxLNITVHTu4zaE5n/FcET95tdJ/7gD1grLzZ3T/0Pmhn8mtE0pmqLkE/fPf/tdQtJALQTP1U3fjV3qt8twol/rfnjWQcyD4pPs2DfTsA5M22Tm7JBIKboRsqSA9nOJBhWOKMUaYUnQVqVN0zYQ3/Zrh9BezvF5lRvVBPzsj6hdkZRwOBr9lI+q9wZdjRN0ffEFG1EcIrHd/Xy9Ntqm2G2VH8HFfPeC9AuflypW+uif6lMk+64IwNiG4YYfR0v3X2H2DEL/GFuyMxY0T279kw2YIDaPBAP/XPc5nnShYfNdUKb4TJlWeL/4lim/uQb/6DFzzZvv0VVJ99l6M/nqRno9eR947231IfeDF8lEuVhyz6mDd8py7ciueISqdY/E03MterUjQtK0zFjIXEk7DAZ5mKj0Nu1+SKmhM95a7EQz1cZOBpXvW1ywfOcLc30RFb1QBTgOa47xzNNzVqqDVC8anqMshj+tbJCrQ+jr2+zDIrkLB/mBwOqyRcH8dCS8k5Z5SpcAjdQby191pe3nrlkdQL4q8kYGRcJ3oe9TZbLvdbdJAWmlhF9HB8WV0scdLsee+Hxy/W75DErQzhUE4pTIEMbez6CDqr8XkGNDnFFNxfOn4pmYFw2WGkYRr9wMvRf98mAyjZbw6ZuN9ckV/qPY+dIixfCrk9Lpx7xocvcFzdEfVwVQjp0rxR0BB5Q+i3SuOBNLPDDi+ixH1SB4/NJFMz8MhhxijTWFDzWGuBgKFOKBOaM/qvb4hWGdzrM7wfitK5jgEvFAMSx3Csikqpd56iDOpw0xakSOtwJEmFqQTCkLRHa3gjuOGJ+o4ivACGJLqPNrfJx3z4ZCUsXuPSM/Zf7AkKm4cp1HUdY5SstSqi+/TPFZdh9XOC/Mb8sKsOGE88TSeBBeu2zGJ+6auiThQYW2S7dhFV82iW02UWyyUfskVS1wNyCYD2P2Ndic/pGVj2MCRQa3u8iOGuiI/3hsQP+4PiB8fDToavd97M0Ojl5PyXevepGC39WtUot+hEBVyokgCe8ERToxuSJLga+8wyFNV1AUTe73WIdejer1asjpCRRvQq0qzUs1BTypXgXGSw4VAKx8Og4K+NYETwIscjMkx98XClCxPVFgF3SneYJ/yko9FLlAFcKlujmUaLcIk7Mcm9OKOdtmA55Cj5lDbSbEGcdD65kqfTTCEI2acjTFLEi3lIGdcps4o764zMi6j3QcdHqUWBmvEaoRaONiUtBr5pOCST4mD4zZHsAxyFGiGaTVGn5VReeX40HKRK+2iNmlDFB9OSHx+UeInekziNaBhhlR97l0zJnauMXdT+arEY/RClgiLQKOZVaySucICwujNrPKclco6DyO+Wdsw4nCruTSoMPtAUX8GNcK81wSMNz++NYAn/L2QZ66I5R47runqRxgbYaFb4maVM+92x3wr7HfVGEvkKiOs0otm9FTYWTUmnaM9Sf3DzfRtqEHd0ihunnj6BixSiOkfvn5BOutd9vPf/od9D1xLNlNzR61ppSFfNOWuqRw0nbxDW61ykl8OxThiPHXE52+fgMEfZ9ySrfMlzNGo7FjKxZe/rsa5SNlRiMXp9Q5CHe4mPqdTksMleKKzlLPSjc6FPEvYoVyQe6e5i7CdxnW2Qfdfq3Q3x4BiJX0igFszaSAih4KB/BxMy3YNmXAuaK2qqVutDYzfXDffFfd2mGVr6aPovGjAcRZX8v1yZ3rFKtsbMk476aTdwBWQGdV1Ngcs03xim/njlSRYugnXmkL+bEBH7Kepj8Rxot9x3eqs0ivacFfekrUbF+xWU+el8OR0HMiSdWtHfThZO2sNXe4tOwCq5Rvde1jV2ryavAF9LtLweN/C0X3q3I/iKBcpeNORv78Ov339PTu/lwyiuPXGuAFz979/8fT5yzfPERgUpA5hw2SQDMjCrYwtuGyttFKvfvVua6VC7Mrb78rb78rb78rb78rb78rb78rb78rb78rb/1r1pHbl7Xfl7Xfl7bdgYlfeflfe/lOrqOzK2//mCxvtytvvytvvytvvytvvytvvytvvytvvytvvytt/EVXDd+Xtfw0K3JW335W335W335W335W335W335W374iXXXn7XXn7XXn7k9+IFXhX3n5X3n5X3n5X3n5X3n5X3v43Vd6+lTnVL3MuZCvZ3CXYHq8WvX8XRzPMwD04ji4vcZm3mB+HzT9VlMF1/C6OzrkWGC1HybtxyDXFXK0zwFTEpy74b+8I148db1N8/ErOMibLuhGHRNBX9m0nCb9+9eYoiqNQqrNQGVVH4HPM7eJzl/jWSgCjtsso53JaUfJY5OZcukJSs25u7Rnl1vo/WhlomEnaQNhNunXbwH9xUxsHXF66vF1K3XT93aetIzxiQ288v3fL5fL/ANvhY4A=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,j={},g=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.a5fa9a4e.js b/assets/js/34593b53.a5fa9a4e.js deleted file mode 100644 index 73fce64c4..000000000 --- a/assets/js/34593b53.a5fa9a4e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kt2AhZPcXqQ9RhrlYxtK21teORGBK1jllSw0FXZXdDrALKAIrNHkZHzMP8wT7t63yav2QjE0AdfZCURHtkb/tBZqNwJBKZiTxxFVk+NdHBSfSNSqsCpDXRuzjKwKRalFYoGR1ExzNgX2vgFljoxQ6PXjCe52puWGVAG2YVm4IEjb0kzFkW5mPjBSu1uhCZkFOWccvZXNgZG3MDj/YZyFRlkLGJyCE5lafyWJQH7G2ZK56xhao0O/rmP+rZcBlsO+n1voFxNWVvX/R6776YWVuag36fl2WiSpBGTGXOxyZJVdHPsGOZTe7HbD4DDTgrS7lkwI3IF4xnGZuLbArWxMzOQLJUlQuWKqUzIbkFE7OST4HJqhiDNjHjMmOF0sCEZJxp4Nliz6q9ygD7zzevXrKJ0gW3CTvKKxPXy2VCQ2rzhZvezqDe1T0TsGGsFnIas4KfI7aEZT9WIj3HbRuQGf4fBx4evSBc9XpvqrJU2kLGfnBbOOj18MtXkKs54xqof6qKQklWcs0LsHRcM27ps4YfK6Ehc4fC8zzg4uBU7rFeT/ICDno99laKHytgIgNpxUSAxl0yOxPGD0hcf7soqf8LmYkUkUcAYCtTk25XRCp2fVNCilO6ri1UMyXZfCbSGeFwzt35lzlP3bY0mBJSKy6gO/FlzBY48TcgVYBgprT4q5KW53R8F6CtSHnePmYEELsay7VF9JdKSBta/QrsT/448bTpED0dImgZIrcQkr4YYBc8r8B4qOYxmyFUr6HUYIg1/LyIeJmxGYjpbOt6PHtfGduZmFUGwWxD4dcKp0roBULbhOcGmJh0cFnwc2itxhTxPM8T9tWCZTDhVW5jJpBCra4gYS+VZbwsc5HycQ5EA8hs3FYa9uiUPfkkXfI5IgkAhnGWickENDIzfqQp/JgAHdJlIzKI0+yMS6bkykGnKld6nYSouYtHlippQdqEHV5wkRPwbrOGCZnmVQZsnPP0PGbjvIKYacgcoy8AxVzshRZ2Ydx4nBN+mIEcqVBJhF8qv7wwzHiosoQdI6PU/IcfA6ppEWHaWPVcPlG4MqIgsCSDgos8JsTF7L0aMytsDjEyeMnlIkb5CjGzcGnH6jJm6QzSc/pL80woNq6sVdJtLNOqzNRcelxOlLRG/HUDR4YvH47RUcz2Y/YoZk9iNhzEbDiK2XA/ZsNHMRs+idloELPRKGaj/ZiNHjmwRk88rnmN4DYAw5HDsv31YBfl9PfCEGejgDW1zJ53ZPYwYb1ezU3Y9pe//OVUXp1Kxk4jZK7T6ICdRnWX0yh231Bm4reh/32JPx6MHvufC/z5aPTE/5xT1+G+/znDn6PhqVz6BU/liCCxvCivgQI/3ykE/pcnImyjRbEtyDNsREEUhw94Vh148MOyvZcHuBchhRU8N9u3E3p8RjtqQFrb1D5uish1+47o82e0nTY8+IXEpPtEYrX1KTA8QTFa2/3DxN8s2zfvlv1s9t4C59O2/gi3jqLpGEXT9v3X0uszQsIqTJ+GiccJKQAkmbfjwXf4jLDQhejTcPAEcYCX0nYE4NfPaPctcPCDv+Hdt8H+3vDh3mgw2u9gAG0p16Eo9rJsb7FY3AX2UOfxy6PKEzRUp9mhFTvRqthgfpB10PTyOhH9HVT2P6KiPg46LGRoJ5JhETSW2kJsa9lWZXxxz7ipwtBaOcP+jWq2aIFJnxAOspbTmRKpBx77BJVsjAZhgjjYI0z2s6zfwiQ2ZtleUeytNOLPPUJ8q7EokixLVnqunY5rLFiWxWy9eWN7lrGiKLY0u/ZOc78o1neRFIWHjZSvL5FJvM62nU98h1+KVRqO6C58LRuhp0HJnNYmc24zH61cNjMh/QdPVGylg4ZplXMNl2iXGqGk6333PBZYrNHsyY71ngQIijX74pXX3u978sctdCfAlpvHre0MJzlkaWWsKpiGKVyyklsLWtJkFzwXGSdTbo8a4JIXJZoA/T+fnma/+9c+OSDQxrcMT4JlYirQb9T/88nh3n+/29CjKkvQKTfAcsCVTMzApgk7mUFeNq6r+XyezB+YdKZU7vxW742Gifv3TI3fnxG4ZcJNeX/TTh1ptAx+JJ1Ve9+A7WCMGxZGbjD5icaIh4YDum29vXPNdet7fEY3zgpI+NF5T/DzyWlUcFJIkJSh+VvZGejT6F09xhn5kN0w9t0tmHUmMsj5GPL1T7dmtLo55wtVef4OTq3uVj1Ft/CGHwoha78FbWcQtz7yy5WP7ttyA387hLS5M1w5gT3DCbBcmOC56aKzPdq7tshBKQHI5zkGFgagOzlIj0/lghqw27GBk0T+7G5YAvsx6li7FcNqN6zQOZg2YnCOQkhRVEXtH53UswaUFV73aOMLR6KXPqzQPt21FfjlDSugM3L7AqdySH6M4P+4RjP1PT4jWbEC0vVs/DFSpHNP39EFezMDhm21GXDDtYxd3YVcM5/Zzn0Je4XXG/pk3SD0sqUplBY9cp/KmjXIt76hyGfV9sNtp7x2r8+I+jaA9TNToO9317fPRxFpe/e/IkLtgH1rYnVOyYJPr7Hc6fNnRJ4enjUnxJCcke6+uMYhR9+v385w0NnOw+52Hg0+wrrqLPvpxtWgbmysqucSYw5rC6FdXuX8TkW9nxNJ82tVlJVt8wKZ/MTv4fIOYTUXJvxdzPZi1otZP2ZfxOx+wl4DBeLSOmjn73KhXWhOSJapCmMmaaXzBRtrnmI0HJJpwq6ufqy4tMIulkvWY1dXGPpfLhNkjnOp5i5ud3IhjLAM4+6NrZOp1GyI06vU9NEo6r+E+V7INOh70O6zL9QKp15rWXoUfKgpuW3Yz2xf9XpHGiYiz1thfBaawuFgWBRyKHzo2AfwUV2kYJKQViECQqpErzeGicJAEuYRYDhyxptAv9PXnGhs5yKwFDM9lGYzbpwdS4Yzbg4TJewMCg/xS2XBxbNNqaQBJ8rLDUA38ehebyUeFro1MTEhw8ZRmAzvznkz+nLQli7DRw87wvJhV7wMtomXa3w3KEQcLoLDG5pPLb4n8RPa15l+levDpIhsJ2wCiTnaU1WesVycU2gzE6bM+QLJIlyVHsrVmPnXM6VM08OHrT2XmYNuOFxpjIjfT+ro4Kd6nYePH3Rk/ZM7cKWtOJe7hzHY7w8f9q/1Lq/4RD9cWjN2m5Mjt+2tTo56Nke38wJ/rBf4bgj/wV06wYaPRx3d7cHg0xngjnxdbca5wct1F76sO3Mqtdntlu6kX8yt8+nUt/9zGLgrYvjx8A7E8BY79lMpcc1cvTPaY3dlq24iwFsYq9daqJ9MoG1gf3YifXg3hu1w0NHVvuyoal+O2kT58OGtiLK96AplnUbiv7569Xo++MO3U3V4eHj48s3b2fO308PDwwJ/J0my0aex6bRpGdRhfUKvv5fpjt+ySpIkiELMjD6g4f1STv/NjY+3j0lOZRRHqsSUa6Hkiyw6iEh3h6DKRzFZu2DsVypbRAdXkU/Zwz99QhwO7b83mOd9FZl0BgXHv4K+jpnhmJkdxZR1BtpEcUQ5HJgmjkcaHURq/B5SXK3UCI4VYHAOGndwFXq51OYo9jpXdBC5LUZx5KNsdVOdFF5mk2gZFrxuqrqlmcrQH7Vdg/NgNvBHToPGDk7RyYz/qJm+ac1AeyvgWKE1n4OFb/jCtOZ11mi0mpCPY5DZUz+KZXxhUGhUxl1wKc/TKke9EC5LoRd1qgIphy36qOGtV6rhHT5cNofegMS15osojoSFot2+hQi0+vCTS0EhZihf7EPHvlcwBvi9b0C/Ah08Lz4YivcK2Bjo0MuZkh88fjh6MBwNHwxHOINP+vnQOYKPBKd4r8ZnH8UIGVzgeG9pf/xRuq/ra3dp8xCzaiELetdekx4eM0rRTG5ik9CfMM+ncDM/HG8rG2hlK5sZGVu8LIHrhLL3P7qQpMti9QWf3MBQyzi6vHkzlyxVe6EmgX2Rw8S6HAKWKi1B328nJn02mxvt7y/jaHHz9ha/yu09xsOb37y7H6iYoyl0+WfA+uDJMo5mN8P6XV1u8k8Edv/RsrngV/SXs7HKFmdBbi1v6hjuKuw3UXkGGnWidXnViBqUMFhWdbZ61YyVyoHLDYKmU2fgC+BQ/0bfr/fJzGdATvhaLafZG53fe4odtFi7ACvpUMKguqwrOI0S9mLSsiBIo18tdQh9qexAKnaP1jszFYnxe33/G3F0r10Chp7ZJiMxgECdmYWizKkmao7O3DGF97OE1f+R8lljEgEIN3ZY+Oar4muXhkUL+kHdgiLm1deEfc1lXVTSLd5gV1c1GRB1LJfs6gpPFfQZ3vvLZdw04FqdBrraXYuGFMRFZ1TdBM3Auq011GlZZxlFQLDB3/dtAMRUCjk9q7SfB5XR5TLpEOQK4OSD9ziArKYzMZUbdl2rTHTSt8b+GrI9BeAk/2/w/rR89p3YAMrTfvnsafnsBywfLMHxnkPPRMjMcf4c8jxhT43VSk6fraDgad+3bz5KDRcC5sS4dKrNLKu4rSdKPEx/QkHdHJ4wLNVVKnhO+YdapRBCPRTWQiPeWCgNhqSEpZGuwotMAj7VQIElgoVXlsolyToMCz7lbKZh8u/3VnB679kbBB0jfE/7/Jnv/cK5JWb8AhiXC0YbJx+K0s4PN6k0ick051pMvCkaszIHzJVES5WnLpjmMBrgOJ5xeW7ip2P97Bh4wV6VIBGCn/7+D+wRZPoL+UpnoG8h1F9MXNhOsXsox+7FLm+TyF1oY72odpLQU4iDawvr+LodDPk9r0W/qcYGe8kwXyNarRbTKWBozvegwb4KDng6c5cGQcUnIYpQIvGoygTwkMCCQZj5KK4/qK7Xp4Udigq2955skuoSy+ZeHR/dApfkktpzjOL8MW6Xbg726vgIK2/r407YW1NjIqCWd7ow9ASwC8FDdV6t2S9crhu4uIqXi+1QZuJrXvfYOkCZMBshit2ljhKurmtfm7gp5cYjUpXF0KjwBYfEZR08EhQ1Io9VdRuqvAGTnE0rKi2wyL7h1qTs4qZyVkhjdeXy/FhW6VAs7MnCiQljGjwFrGCn1vwxA2nccM4m3FjQMaukQMzrCr2U9ZRwWYIWmFOwEQUaHOpQdNx8RXXLUN++/t4X8Ic9BKYcIwe6iSFjVUlUQ5xQl0eHk1vd+kZ90IvvmwFE3Y0yJbyrtQRtlEQRp/SUSy9BnT2K/tQxzHjuunpRgSE5hAc5PNlo+//093+04NrqFFkHzK3Aswxz32+AkFzTjuAxvVNDiRJQdSHC+UD/ftUEQOiIac4KldWMZG5P40eULW9quehTDepUB1OlM7y2anlr4iBjjXcqGPJCk6uachVK3C9cCmNbBb6hDGddPrwGxGPagoGMUORqpHm5aDN4k4KhVqYj80B0i8NrI2iNF3hl1ZmGQsjb3VNtr79VtSCorCq4FSkLU5mkW/LvQsuBrwv2RQANqfFCKH1/C6vidGdKpnAm5BlcgL6Fef+yThsmn+QY7BxAtmELSHLXWVOWPceXNzo4ad1O9PhAG0p0Thagp3CWooeKqA5ugcReD6fq9dieA8TLVFNpH5/xz2WQ8EA50syO4HhduK7oai7c9islCftOzRFhtTqDSqebH/HJCPIsdlO0Vki5xMp2MhPRUsOJ6xh+wSkfyy/h0mjosGg3XuFKXeAGZ8HnHXCd+Lo9BflZl6pxfKIhrO7YwW0O3fmM54r4yauV/nMHqBdUnT+j+4fOD+NMbp3wZIaaS9A//e1/DWULuRQ0U5u6G7+Stcpzo1zpf3vWQM6B4JOubRro2ScmbfJzdkkkPLgRqqWC9HCKBz0cU4wxw5Syq0idomsm2PRrjtOfzfN6nRvVJ/3snKi/Ii/jcDD4LTtRHwx+PU7U/cGvyIn6BIH14e+bpck21Xaj7Agx7usHvFfgoly50tf3xJgy+WddEsYmBDfsMFq6/xq/bxDiN/iCnbO4CWJ7SzZshtAwGgzwf93j/KaTBYt2TZWinTCp8nzxL1F8+wj69Wfgmjf7p6+T6rP3YvTXy/RidBT56GzXkPrAi+WjQqw4ZjXAusWcu3YrniEqnePjabiXvVqRoGlbZyxkLiSchQM8y1R6Fna/JFXQmO4tdysY6uMmB0v3rG9YPnKEub+Jit6oApwGNMd55+i4q1VBqxeMT1GXQx7Xd0hUoPVN7PdhkF2Hgv3B4GxYI+HhOhJeSKo9pZcCj9U5yF92p+3lrVseQb0s8kYGRsJ1ou9RZ7PtdrdJA2mlhV1EBydX0eUeL8We+35w8m75DknQzhQm4ZTKEMTczqKDqL+Wk2NAX1BOxcka3cw5OgK/q8YE9mFlFfujSs/d3ojHara5ENq6mRLjhs2qMV0mR5ojCb/kF+dc9/Gu6Q+TQTKIlvHVyiSGywxTF9cuJF6K/sUwGW4Ys/ECu6Y/VHsfOsRYPhVyetO4d82hvEHCcbTROZpGMJbiD4CS0Z98u1ccCcT+DDga4njWSI+vm9Sp54GqQlLTpjylhnpWM49C4lEnl2hVkdiQHbQ5OWj4sJWWcxIybChpps6Z2ZQGU289JLbUeS2tVJVWpkqTfNLJPaF0klY2yUnDhHXiRjA5hqSrj/b3Sal9PCTt78ETUqz2Hy2JbZpIbRR1o7FUnbUaU/y0EFk3QrYL+/yGwj4rUR9PPE3owuUHd3zwvqnrkw5UWPuAO47YVT/sVp/oFpeoX3LF9VcDssnj9nCjo8sPaTk1NnBk0OO7/Ii5tciPDwbEj/sD4scng44J4ffezNAYAqTt18o+afRthR619ncoRIWcKJLAXnCEE6O7jST4muEHeaqK+oXGXq91yPWoXq+WrI5Q0en0qtKsVHPQk8o9+TjJ4VKgWxGHQUHfmkwN4EUOxuRYbGNhSq4ueskF4zc+QpDyko9FLlDncLV1jmUatcUk7Icm1+OeduWHF5CjqlI7ZvHR46BmzpU+n2DOSMw4G2NZJrrmQc64TF0UwF1n5M1GRxNGWEotDD5KqxFq4WBT0mrkk4JLPiUOjtscwTLIUaAZptUYg2RG5ZXjQ8tFrrRLE6UNUUI6IfH5ZYmfyHrFa0DDDKn6wseCTOxice6m8s8gjzHsWSIsAr10VrFK5gpfLMbwaZXnrFTWhTTRSG7DiMOt5tKghu4zU/0Z1AjzYRow3t/51gCe8PdCnrtXM/fYSU1XP8DYCAvdN3VWOfN+d8y3wqK69RpKZYRVetGMngobVKr2JPUPN9O34dHrlkZx+0rXN2CRQkz/8OgFKcn32U9/+x/2PXAt2UzNHbWmlYZ80byvTe9P08k7tNU6LgUCUYwjxlNHfP72CRj8YcYtOVdfwhy92I6lXEL7UTXORcqOQ/JPr3cQHv5uEoI6b4C4ilKMznJWutG5kOcJO5QLiic1dxG207jONuj+a70VzjGDWUlfeeDWTBqIKIJhIL8A03KWQyZczFuraupWawPjN9ctsMW9HWbZWr0qRksacJyLl4LN3Pl68VnvDSWunfrVbqYMyIwekjYHLNN8Ypv545WqW7oJ15pCwW5AR+ynqY/EcaLfcd3q3OAr2nBX3pJ7HRfsPt/OS+HJ6SSQJes+VvXhZO3cQ3S5txwPqJZvjCfiM9rm1eQN6AuRBm/BFo7uU+d+FEe5SMH7qvz9dfjt0ffs4kEy6NhPt2Du/vcvvn7+8s1zBAYFqUNYsKPIxiu4bK208kD+6t3Wqr3Yvae/e09/957+7j393Xv6u/f0d+/p797T372n/0s9YLV7T3/3nv7uPf0tmNi9p797T/9Tn23Zvaf/m39Jafee/u49/d17+rv39Hfv6e/e09+9p797T3/3nv6v4pny3Xv6vwQF7t7T372nv3tPf/ee/u49/d17+rv39DviZfee/u49/d17+qe/ES/w7j393Xv6u/f0d+/p797T372n/5t6T79VOdUvcy5kq7rdVfSerL6y/y6OZljye3ASXV3hMm+xPg6bf6yoguvkXRxdcC0wW46qheNQa4q1WueApYhfu+S/vWNcP3a8TfnxK0XSWCzrRhwSQV/bt12VfPTqzXEUR+Ft0EJl9BwDn2NtF5+7wrdWARi1XUU5l9OKisciN+fSvVw169bWnlNtrf+jVYGGlaQNhN2iW7cN/Bc3tXHA1ZWr26XSTdfffdo6wiM29Mbze7dcLv8Pu/CLKw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kt2AhZPcXqQ9RhrlYxtK21teORGBK1jllSw0FXZXdDrALKAIrNHkZHzMP8wT7t63yav2QjE0AdfZCURHtkb/tBZqNwJBKZiTxxFVk+NdHBSfSNSqsCpDXRuzjKwKRalFYoGR1ExzNgX2vgFljoxQ6PXjCe52puWGVAG2YVm4IEjb0kzFkW5mPjBSu1uhCZkFOWccvZXNgZG3MDj/YZyFRlkLGJyCE5lafyWJQH7G2ZK56xhao0O/rmP+rZcBlsO+n1voFxNWVvX/R6776YWVuag36fl2WiSpBGTGXOxyZJVdHPsGOZTe7HbD4DDTgrS7lkwI3IF4xnGZuLbArWxMzOQLJUlQuWKqUzIbkFE7OST4HJqhiDNjHjMmOF0sCEZJxp4Nliz6q9ygD7zzevXrKJ0gW3CTvKKxPXy2VCQ2rzhZvezqDe1T0TsGGsFnIas4KfI7aEZT9WIj3HbRuQGf4fBx4evSBc9XpvqrJU2kLGfnBbOOj18MtXkKs54xqof6qKQklWcs0LsHRcM27ps4YfK6Ehc4fC8zzg4uBU7rFeT/ICDno99laKHytgIgNpxUSAxl0yOxPGD0hcf7soqf8LmYkUkUcAYCtTk25XRCp2fVNCilO6ri1UMyXZfCbSGeFwzt35lzlP3bY0mBJSKy6gO/FlzBY48TcgVYBgprT4q5KW53R8F6CtSHnePmYEELsay7VF9JdKSBta/QrsT/448bTpED0dImgZIrcQkr4YYBc8r8B4qOYxmyFUr6HUYIg1/LyIeJmxGYjpbOt6PHtfGduZmFUGwWxD4dcKp0roBULbhOcGmJh0cFnwc2itxhTxPM8T9tWCZTDhVW5jJpBCra4gYS+VZbwsc5HycQ5EA8hs3FYa9uiUPfkkXfI5IgkAhnGWickENDIzfqQp/JgAHdJlIzKI0+yMS6bkykGnKld6nYSouYtHlippQdqEHV5wkRPwbrOGCZnmVQZsnPP0PGbjvIKYacgcoy8AxVzshRZ2Ydx4nBN+mIEcqVBJhF8qv7wwzHiosoQdI6PU/IcfA6ppEWHaWPVcPlG4MqIgsCSDgos8JsTF7L0aMytsDjEyeMnlIkb5CjGzcGnH6jJm6QzSc/pL80woNq6sVdJtLNOqzNRcelxOlLRG/HUDR4YvH47RUcz2Y/YoZk9iNhzEbDiK2XA/ZsNHMRs+idloELPRKGaj/ZiNHjmwRk88rnmN4DYAw5HDsv31YBfl9PfCEGejgDW1zJ53ZPYwYb1ezU3Y9pe//OVUXp1Kxk4jZK7T6ICdRnWX0yh231Bm4reh/32JPx6MHvufC/z5aPTE/5xT1+G+/znDn6PhqVz6BU/liCCxvCivgQI/3ykE/pcnImyjRbEtyDNsREEUhw94Vh148MOyvZcHuBchhRU8N9u3E3p8RjtqQFrb1D5uish1+47o82e0nTY8+IXEpPtEYrX1KTA8QTFa2/3DxN8s2zfvlv1s9t4C59O2/gi3jqLpGEXT9v3X0uszQsIqTJ+GiccJKQAkmbfjwXf4jLDQhejTcPAEcYCX0nYE4NfPaPctcPCDv+Hdt8H+3vDh3mgw2u9gAG0p16Eo9rJsb7FY3AX2UOfxy6PKEzRUp9mhFTvRqthgfpB10PTyOhH9HVT2P6KiPg46LGRoJ5JhETSW2kJsa9lWZXxxz7ipwtBaOcP+jWq2aIFJnxAOspbTmRKpBx77BJVsjAZhgjjYI0z2s6zfwiQ2ZtleUeytNOLPPUJ8q7EokixLVnqunY5rLFiWxWy9eWN7lrGiKLY0u/ZOc78o1neRFIWHjZSvL5FJvM62nU98h1+KVRqO6C58LRuhp0HJnNYmc24zH61cNjMh/QdPVGylg4ZplXMNl2iXGqGk6333PBZYrNHsyY71ngQIijX74pXX3u978sctdCfAlpvHre0MJzlkaWWsKpiGKVyyklsLWtJkFzwXGSdTbo8a4JIXJZoA/T+fnma/+9c+OSDQxrcMT4JlYirQb9T/88nh3n+/29CjKkvQKTfAcsCVTMzApgk7mUFeNq6r+XyezB+YdKZU7vxW742Gifv3TI3fnxG4ZcJNeX/TTh1ptAx+JJ1Ve9+A7WCMGxZGbjD5icaIh4YDum29vXPNdet7fEY3zgpI+NF5T/DzyWlUcFJIkJSh+VvZGejT6F09xhn5kN0w9t0tmHUmMsj5GPL1T7dmtLo55wtVef4OTq3uVj1Ft/CGHwoha78FbWcQtz7yy5WP7ttyA387hLS5M1w5gT3DCbBcmOC56aKzPdq7tshBKQHI5zkGFgagOzlIj0/lghqw27GBk0T+7G5YAvsx6li7FcNqN6zQOZg2YnCOQkhRVEXtH53UswaUFV73aOMLR6KXPqzQPt21FfjlDSugM3L7AqdySH6M4P+4RjP1PT4jWbEC0vVs/DFSpHNP39EFezMDhm21GXDDtYxd3YVcM5/Zzn0Je4XXG/pk3SD0sqUplBY9cp/KmjXIt76hyGfV9sNtp7x2r8+I+jaA9TNToO9317fPRxFpe/e/IkLtgH1rYnVOyYJPr7Hc6fNnRJ4enjUnxJCcke6+uMYhR9+v385w0NnOw+52Hg0+wrrqLPvpxtWgbmysqucSYw5rC6FdXuX8TkW9nxNJ82tVlJVt8wKZ/MTv4fIOYTUXJvxdzPZi1otZP2ZfxOx+wl4DBeLSOmjn73KhXWhOSJapCmMmaaXzBRtrnmI0HJJpwq6ufqy4tMIulkvWY1dXGPpfLhNkjnOp5i5ud3IhjLAM4+6NrZOp1GyI06vU9NEo6r+E+V7INOh70O6zL9QKp15rWXoUfKgpuW3Yz2xf9XpHGiYiz1thfBaawuFgWBRyKHzo2AfwUV2kYJKQViECQqpErzeGicJAEuYRYDhyxptAv9PXnGhs5yKwFDM9lGYzbpwdS4Yzbg4TJewMCg/xS2XBxbNNqaQBJ8rLDUA38ehebyUeFro1MTEhw8ZRmAzvznkz+nLQli7DRw87wvJhV7wMtomXa3w3KEQcLoLDG5pPLb4n8RPa15l+levDpIhsJ2wCiTnaU1WesVycU2gzE6bM+QLJIlyVHsrVmPnXM6VM08OHrT2XmYNuOFxpjIjfT+ro4Kd6nYePH3Rk/ZM7cKWtOJe7hzHY7w8f9q/1Lq/4RD9cWjN2m5Mjt+2tTo56Nke38wJ/rBf4bgj/wV06wYaPRx3d7cHg0xngjnxdbca5wct1F76sO3Mqtdntlu6kX8yt8+nUt/9zGLgrYvjx8A7E8BY79lMpcc1cvTPaY3dlq24iwFsYq9daqJ9MoG1gf3YifXg3hu1w0NHVvuyoal+O2kT58OGtiLK96AplnUbiv7569Xo++MO3U3V4eHj48s3b2fO308PDwwJ/J0my0aex6bRpGdRhfUKvv5fpjt+ySpIkiELMjD6g4f1STv/NjY+3j0lOZRRHqsSUa6Hkiyw6iEh3h6DKRzFZu2DsVypbRAdXkU/Zwz99QhwO7b83mOd9FZl0BgXHv4K+jpnhmJkdxZR1BtpEcUQ5HJgmjkcaHURq/B5SXK3UCI4VYHAOGndwFXq51OYo9jpXdBC5LUZx5KNsdVOdFF5mk2gZFrxuqrqlmcrQH7Vdg/NgNvBHToPGDk7RyYz/qJm+ac1AeyvgWKE1n4OFb/jCtOZ11mi0mpCPY5DZUz+KZXxhUGhUxl1wKc/TKke9EC5LoRd1qgIphy36qOGtV6rhHT5cNofegMS15osojoSFot2+hQi0+vCTS0EhZihf7EPHvlcwBvi9b0C/Ah08Lz4YivcK2Bjo0MuZkh88fjh6MBwNHwxHOINP+vnQOYKPBKd4r8ZnH8UIGVzgeG9pf/xRuq/ra3dp8xCzaiELetdekx4eM0rRTG5ik9CfMM+ncDM/HG8rG2hlK5sZGVu8LIHrhLL3P7qQpMti9QWf3MBQyzi6vHkzlyxVe6EmgX2Rw8S6HAKWKi1B328nJn02mxvt7y/jaHHz9ha/yu09xsOb37y7H6iYoyl0+WfA+uDJMo5mN8P6XV1u8k8Edv/RsrngV/SXs7HKFmdBbi1v6hjuKuw3UXkGGnWidXnViBqUMFhWdbZ61YyVyoHLDYKmU2fgC+BQ/0bfr/fJzGdATvhaLafZG53fe4odtFi7ACvpUMKguqwrOI0S9mLSsiBIo18tdQh9qexAKnaP1jszFYnxe33/G3F0r10Chp7ZJiMxgECdmYWizKkmao7O3DGF97OE1f+R8lljEgEIN3ZY+Oar4muXhkUL+kHdgiLm1deEfc1lXVTSLd5gV1c1GRB1LJfs6gpPFfQZ3vvLZdw04FqdBrraXYuGFMRFZ1TdBM3Auq011GlZZxlFQLDB3/dtAMRUCjk9q7SfB5XR5TLpEOQK4OSD9ziArKYzMZUbdl2rTHTSt8b+GrI9BeAk/2/w/rR89p3YAMrTfvnsafnsBywfLMHxnkPPRMjMcf4c8jxhT43VSk6fraDgad+3bz5KDRcC5sS4dKrNLKu4rSdKPEx/QkHdHJ4wLNVVKnhO+YdapRBCPRTWQiPeWCgNhqSEpZGuwotMAj7VQIElgoVXlsolyToMCz7lbKZh8u/3VnB679kbBB0jfE/7/Jnv/cK5JWb8AhiXC0YbJx+K0s4PN6k0ick051pMvCkaszIHzJVES5WnLpjmMBrgOJ5xeW7ip2P97Bh4wV6VIBGCn/7+D+wRZPoL+UpnoG8h1F9MXNhOsXsox+7FLm+TyF1oY72odpLQU4iDawvr+LodDPk9r0W/qcYGe8kwXyNarRbTKWBozvegwb4KDng6c5cGQcUnIYpQIvGoygTwkMCCQZj5KK4/qK7Xp4Udigq2955skuoSy+ZeHR/dApfkktpzjOL8MW6Xbg726vgIK2/r407YW1NjIqCWd7ow9ASwC8FDdV6t2S9crhu4uIqXi+1QZuJrXvfYOkCZMBshit2ljhKurmtfm7gp5cYjUpXF0KjwBYfEZR08EhQ1Io9VdRuqvAGTnE0rKi2wyL7h1qTs4qZyVkhjdeXy/FhW6VAs7MnCiQljGjwFrGCn1vwxA2nccM4m3FjQMaukQMzrCr2U9ZRwWYIWmFOwEQUaHOpQdNx8RXXLUN++/t4X8Ic9BKYcIwe6iSFjVUlUQ5xQl0eHk1vd+kZ90IvvmwFE3Y0yJbyrtQRtlEQRp/SUSy9BnT2K/tQxzHjuunpRgSE5hAc5PNlo+//093+04NrqFFkHzK3Aswxz32+AkFzTjuAxvVNDiRJQdSHC+UD/ftUEQOiIac4KldWMZG5P40eULW9quehTDepUB1OlM7y2anlr4iBjjXcqGPJCk6uachVK3C9cCmNbBb6hDGddPrwGxGPagoGMUORqpHm5aDN4k4KhVqYj80B0i8NrI2iNF3hl1ZmGQsjb3VNtr79VtSCorCq4FSkLU5mkW/LvQsuBrwv2RQANqfFCKH1/C6vidGdKpnAm5BlcgL6Fef+yThsmn+QY7BxAtmELSHLXWVOWPceXNzo4ad1O9PhAG0p0Thagp3CWooeKqA5ugcReD6fq9dieA8TLVFNpH5/xz2WQ8EA50syO4HhduK7oai7c9islCftOzRFhtTqDSqebH/HJCPIsdlO0Vki5xMp2MhPRUsOJ6xh+wSkfyy/h0mjosGg3XuFKXeAGZ8HnHXCd+Lo9BflZl6pxfKIhrO7YwW0O3fmM54r4yauV/nMHqBdUnT+j+4fOD+NMbp3wZIaaS9A//e1/DWULuRQ0U5u6G7+Stcpzo1zpf3vWQM6B4JOubRro2ScmbfJzdkkkPLgRqqWC9HCKBz0cU4wxw5Syq0idomsm2PRrjtOfzfN6nRvVJ/3snKi/Ii/jcDD4LTtRHwx+PU7U/cGvyIn6BIH14e+bpck21Xaj7Agx7usHvFfgoly50tf3xJgy+WddEsYmBDfsMFq6/xq/bxDiN/iCnbO4CWJ7SzZshtAwGgzwf93j/KaTBYt2TZWinTCp8nzxL1F8+wj69Wfgmjf7p6+T6rP3YvTXy/RidBT56GzXkPrAi+WjQqw4ZjXAusWcu3YrniEqnePjabiXvVqRoGlbZyxkLiSchQM8y1R6Fna/JFXQmO4tdysY6uMmB0v3rG9YPnKEub+Jit6oApwGNMd55+i4q1VBqxeMT1GXQx7Xd0hUoPVN7PdhkF2Hgv3B4GxYI+HhOhJeSKo9pZcCj9U5yF92p+3lrVseQb0s8kYGRsJ1ou9RZ7PtdrdJA2mlhV1EBydX0eUeL8We+35w8m75DknQzhQm4ZTKEMTczqKDqL+Wk2NAX1BOxcka3cw5OgK/q8YE9mFlFfujSs/d3ojHara5ENq6mRLjhs2qMV0mR5ojCb/kF+dc9/Gu6Q+TQTKIlvHVyiSGywxTF9cuJF6K/sUwGW4Ys/ECu6Y/VHsfOsRYPhVyetO4d82hvEHCcbTROZpGMJbiD4CS0Z98u1ccCcT+DDga4njWSI+vm9Sp54GqQlLTpjylhnpWM49C4lEnl2hVkdiQHbQ5OWj4sJWWcxIybChpps6Z2ZQGU289JLbUeS2tVJVWpkqTfNLJPaF0klY2yUnDhHXiRjA5hqSrj/b3Sal9PCTt78ETUqz2Hy2JbZpIbRR1o7FUnbUaU/y0EFk3QrYL+/yGwj4rUR9PPE3owuUHd3zwvqnrkw5UWPuAO47YVT/sVp/oFpeoX3LF9VcDssnj9nCjo8sPaTk1NnBk0OO7/Ii5tciPDwbEj/sD4scng44J4ffezNAYAqTt18o+afRthR619ncoRIWcKJLAXnCEE6O7jST4muEHeaqK+oXGXq91yPWoXq+WrI5Q0en0qtKsVHPQk8o9+TjJ4VKgWxGHQUHfmkwN4EUOxuRYbGNhSq4ueskF4zc+QpDyko9FLlDncLV1jmUatcUk7Icm1+OeduWHF5CjqlI7ZvHR46BmzpU+n2DOSMw4G2NZJrrmQc64TF0UwF1n5M1GRxNGWEotDD5KqxFq4WBT0mrkk4JLPiUOjtscwTLIUaAZptUYg2RG5ZXjQ8tFrrRLE6UNUUI6IfH5ZYmfyHrFa0DDDKn6wseCTOxice6m8s8gjzHsWSIsAr10VrFK5gpfLMbwaZXnrFTWhTTRSG7DiMOt5tKghu4zU/0Z1AjzYRow3t/51gCe8PdCnrtXM/fYSU1XP8DYCAvdN3VWOfN+d8y3wqK69RpKZYRVetGMngobVKr2JPUPN9O34dHrlkZx+0rXN2CRQkz/8OgFKcn32U9/+x/2PXAt2UzNHbWmlYZ80byvTe9P08k7tNU6LgUCUYwjxlNHfP72CRj8YcYtOVdfwhy92I6lXEL7UTXORcqOQ/JPr3cQHv5uEoI6b4C4ilKMznJWutG5kOcJO5QLiic1dxG207jONuj+a70VzjGDWUlfeeDWTBqIKIJhIL8A03KWQyZczFuraupWawPjN9ctsMW9HWbZWr0qRksacJyLl4LN3Pl68VnvDSWunfrVbqYMyIwekjYHLNN8Ypv545WqW7oJ15pCwW5AR+ynqY/EcaLfcd3q3OAr2nBX3pJ7HRfsPt/OS+HJ6SSQJes+VvXhZO3cQ3S5txwPqJZvjCfiM9rm1eQN6AuRBm/BFo7uU+d+FEe5SMH7qvz9dfjt0ffs4kEy6NhPt2Du/vcvvn7+8s1zBAYFqUNYsKPIxiu4bK208kD+6t3Wqr3Yvae/e09/957+7j393Xv6u/f0d+/p797T372n/0s9YLV7T3/3nv7uPf0tmNi9p797T/9Tn23Zvaf/m39Jafee/u49/d17+rv39Hfv6e/e09+9p797T3/3nv6v4pny3Xv6vwQF7t7T372nv3tPf/ee/u49/d17+rv39DviZfee/u49/d17+qe/ES/w7j393Xv6u/f0d+/p797T372n/5t6T79VOdUvcy5kq7rdVfSerL6y/y6OZljye3ASXV3hMm+xPg6bf6yoguvkXRxdcC0wW46qheNQa4q1WueApYhfu+S/vWNcP3a8TfnxK0XSWCzrRhwSQV/bt12VfPTqzXEUR+Ft0EJl9BwDn2NtF5+7wrdWARi1XUU5l9OKisciN+fSvVw169bWnlNtrf+jVYGGlaQNhN2iW7cN/Bc3tXHA1ZWr26XSTdfffdo6wiM29Mbze7dcLv8Pu/CLKw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,y={},g=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.3f44a353.js b/assets/js/4227e71a.3f44a353.js new file mode 100644 index 000000000..9195b4979 --- /dev/null +++ b/assets/js/4227e71a.3f44a353.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5342],{30649:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>y,default:()=>P,frontMatter:()=>h,metadata:()=>n,toc:()=>x});const n=JSON.parse('{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/v1.1/get-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-template","permalink":"/docs/API-docs/v1.1/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWM1uGzkSfpVaXnYitCXZcZxZncaYDTLGBhNj7IGBdQyB3V1SM2aTHJKtHwgNzGHeYE973UfLkyyK7G61ZMU/mEWAvSQWuz6yqljF+qo2zPO5Y5Nbdo2lkdyjY3cJy9FlVhgvtGITdl0gvEcPrQicX14Al1IvHax1BV6DRW8FLhBy9FxIBzzVlQcOzmAmZiID34CH3TYOHNoFAneQygqNFco7mGkLmUXuhZpDrrOqRFpeCl+AsZjjTCjMwXlbZb6y6IYsYdqg5aTtRc4mbI6+PYMlzHDLS/RoycwNU7xENmGtOlORs4QJMtNwX7B92y/+DnrWKQ++4B4UYu7I6hRhhj4rkPaw+FslLOZs4m2FCXN+LekkJ0ojSRFcGalzZJMZl44EsgJLziYb5tcmSHor1JwlbKZtyX1cUXNW13e0vTNaOXQEOBmP6b9dVV2VZejcrJLQ+YMlLNPKo/Ikz42RIgsfRp8dgTYPtdDpZ8w8Oc7SNl7EI+My+fdxfeMKrniwesJWxz+lqnQnl3NWJ8wLT6sPt9gCXPijczmhlPZPgLoLCqI1qSRztN/KrBhUjykY9YEgWG8dsY3DRmFSXTzlosJ74yajUQuuHNphpktC66XasfsxZ4U8061WCXNirkKedGhuLV9Tgngs3dPetPop1TPUz3PYZ42QYlALSy7kk9Ip4g/NQusLU2j1xDGnb85Ojl9///aY5Jcin6P/E/bHry+LJI8rn+pV0JfP+3BVlSnaPrxb6eDHdcJWL8ScnJ7WCVu/EPWWjlq+EPT6+zphxQtBp2cUx+FZe4bPvxZKz/J5fTAXr2IeTNt4eFQqpLNDlV+oj3b3zUm1lshV/2iqDXXCQuZhfu4fj86T8cnro+Px0fjt9fHZ5PRvkzdnw/F4/E+WsFUpt9azvHkpWyXb35XJv8k5qHgq8VpXzzPfYi4sZn5a2YOJ/djd0XGBfExLnRO14PuBcuDcUHIJWHk9tVgK9eRNtZAoPdUqw6lQU1ygPZg6HXBMAbHrtn4x24+jJghPD5X0K12iL4gJLVF5WFqt5gkYidwheLsGPudCAW1j//K/q/VorX6ihrxMs37+CCWFwmnLZ6an4/H0uHPC6UMnXPdqO8x0pfJva+qh8x836HR61hn05qFBF2rBpcgDjb7W96i+rT394308/mHEiigUvrMdY/vr0UiHWWWFXwd+vTriRhzF75PbO6KuFCm6IeaBkPuCTVjHXkabHhmvGe1nFy1dDw9ER3gcV3mqV0NtUBFZkTx1VOxH3IjR4nhIVXwfw415kTxWRy+FOM/nQs2fwt1tXXVF1xlvbMdhW+JhxD+QmEdzH32ppl8pkAfGWNPvmQ7g5pY+GlRUnsIdh8P3+5oblJkukboYXyAMBi3kyx//6VCDQdeBhWgcflKf1MfKgtFLtNRocJXDTOJKpDK2hViGb11j6JCXEp2TaxDK49xSIuViLjyXQH6iJyTjhqdCCgpiEtOEttDLAzeEmwJ9gZY+/dUicMhxgZJiH+hVL3c7Rlhqez+jFjUBDmnlhELnAFXBVUaC7U0koC1wBag8WmOFQ+otSWsRddPKW555KLnic6S9E+g7K0cpKFzB6rRyHpyWVVAZqBPWFnNoDQqNY3DiO+oFLQKtZro0FgsKmwXCvBI5ugQynSPEXohMUDmk6DwY0kVkGPrPSkmd3YcLnFVSgtH0hAguqWft60hwb7lyVFijLu0ddA4zVlP7iFHBweBXh3TDH4S6d5PB4JM6gtsurm4wdcLj3XdtCiyXyweh/2oX8174n6oUfkGjnfDarrfoufBFlYZ06W/S/Yg7vUeFIX56ybDdI9eZe5h9tDoqUJrRFXqKEDc6v7wIr+4r+PL7v+ADcqug0MsYrVllUa5h3h5Fnos3H93WPZphUMErX5DHsxh8NAJA51sP3hTcf/n93w5+xiUI1aQUmTIYXFapFNl2FjIYTODHQAq7ztfFaUPGFQ0aXMEplBaCAwcT0VKo+yGcqzVQBxhnJBQMtB5wO2aQX3oTlZQ7zEGrgDg0nfEFlg7lAh3tRcUvRcBceIrowupqHk/rK9MYZ3EmpISbyJ/JtvM8p/FNWG5oNTm8pw7OKCF8gWvgFsGh8kO43IOEL5Ux2pIWIio/00QH6QJQ5UbTGGkCueUzv90/2QZ6nC5pdWApupB37kiabboriZnYWNytDj/Ro7z3kO++txZnaOnAYPb2Xoxowum2DUugaP0zYU3lml4tngU20XTPVFF+2N8nVHa0pfs4u0K7EFk7XfhKRo+C8IglTIoMlcMeYzh/f/kBFq+HY5b0yuMzknv04eLHdz9fvSNl6CGNDjsejofj0BRr50uueif1Z5H7hW2zJVL/B3PLpthTOzoykotAtZqeKNKk222fkLBJf2p5l7BCO08imw0l869W1jUt/1aFFuX2LmELbgV1ZoFL5cLR33k3gfyq5777pRlmvoLnD0APGtPSGUVcZsFlFVq4hN3jem8KW9/RqCByGtI2SpxnGRrfwz4gxzsM8/27axa6vGKXS90HLtX8Qbsf1GuXZEUF6F9ifAcBm03kaXXdycdPX0U0BrbS5KS7uq7/C5OaM8A=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"}}');var p=a(74848),l=a(28453),r=a(33617),i=a.n(r),o=a(17543),s=a.n(o),m=a(86013),c=a.n(m),d=a(63723),g=a.n(d),u=(a(18766),a(79329),a(9303));const h={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWM1uGzkSfpVaXnYitCXZcZxZncaYDTLGBhNj7IGBdQyB3V1SM2aTHJKtHwgNzGHeYE973UfLkyyK7G61ZMU/mEWAvSQWuz6yqljF+qo2zPO5Y5Nbdo2lkdyjY3cJy9FlVhgvtGITdl0gvEcPrQicX14Al1IvHax1BV6DRW8FLhBy9FxIBzzVlQcOzmAmZiID34CH3TYOHNoFAneQygqNFco7mGkLmUXuhZpDrrOqRFpeCl+AsZjjTCjMwXlbZb6y6IYsYdqg5aTtRc4mbI6+PYMlzHDLS/RoycwNU7xENmGtOlORs4QJMtNwX7B92y/+DnrWKQ++4B4UYu7I6hRhhj4rkPaw+FslLOZs4m2FCXN+LekkJ0ojSRFcGalzZJMZl44EsgJLziYb5tcmSHor1JwlbKZtyX1cUXNW13e0vTNaOXQEOBmP6b9dVV2VZejcrJLQ+YMlLNPKo/Ikz42RIgsfRp8dgTYPtdDpZ8w8Oc7SNl7EI+My+fdxfeMKrniwesJWxz+lqnQnl3NWJ8wLT6sPt9gCXPijczmhlPZPgLoLCqI1qSRztN/KrBhUjykY9YEgWG8dsY3DRmFSXTzlosJ74yajUQuuHNphpktC66XasfsxZ4U8061WCXNirkKedGhuLV9Tgngs3dPetPop1TPUz3PYZ42QYlALSy7kk9Ip4g/NQusLU2j1xDGnb85Ojl9///aY5Jcin6P/E/bHry+LJI8rn+pV0JfP+3BVlSnaPrxb6eDHdcJWL8ScnJ7WCVu/EPWWjlq+EPT6+zphxQtBp2cUx+FZe4bPvxZKz/J5fTAXr2IeTNt4eFQqpLNDlV+oj3b3zUm1lshV/2iqDXXCQuZhfu4fj86T8cnro+Px0fjt9fHZ5PRvkzdnw/F4/E+WsFUpt9azvHkpWyXb35XJv8k5qHgq8VpXzzPfYi4sZn5a2YOJ/djd0XGBfExLnRO14PuBcuDcUHIJWHk9tVgK9eRNtZAoPdUqw6lQU1ygPZg6HXBMAbHrtn4x24+jJghPD5X0K12iL4gJLVF5WFqt5gkYidwheLsGPudCAW1j//K/q/VorX6ihrxMs37+CCWFwmnLZ6an4/H0uHPC6UMnXPdqO8x0pfJva+qh8x836HR61hn05qFBF2rBpcgDjb7W96i+rT394308/mHEiigUvrMdY/vr0UiHWWWFXwd+vTriRhzF75PbO6KuFCm6IeaBkPuCTVjHXkabHhmvGe1nFy1dDw9ER3gcV3mqV0NtUBFZkTx1VOxH3IjR4nhIVXwfw415kTxWRy+FOM/nQs2fwt1tXXVF1xlvbMdhW+JhxD+QmEdzH32ppl8pkAfGWNPvmQ7g5pY+GlRUnsIdh8P3+5oblJkukboYXyAMBi3kyx//6VCDQdeBhWgcflKf1MfKgtFLtNRocJXDTOJKpDK2hViGb11j6JCXEp2TaxDK49xSIuViLjyXQH6iJyTjhqdCCgpiEtOEttDLAzeEmwJ9gZY+/dUicMhxgZJiH+hVL3c7Rlhqez+jFjUBDmnlhELnAFXBVUaC7U0koC1wBag8WmOFQ+otSWsRddPKW555KLnic6S9E+g7K0cpKFzB6rRyHpyWVVAZqBPWFnNoDQqNY3DiO+oFLQKtZro0FgsKmwXCvBI5ugQynSPEXohMUDmk6DwY0kVkGPrPSkmd3YcLnFVSgtH0hAguqWft60hwb7lyVFijLu0ddA4zVlP7iFHBweBXh3TDH4S6d5PB4JM6gtsurm4wdcLj3XdtCiyXyweh/2oX8174n6oUfkGjnfDarrfoufBFlYZ06W/S/Yg7vUeFIX56ybDdI9eZe5h9tDoqUJrRFXqKEDc6v7wIr+4r+PL7v+ADcqug0MsYrVllUa5h3h5Fnos3H93WPZphUMErX5DHsxh8NAJA51sP3hTcf/n93w5+xiUI1aQUmTIYXFapFNl2FjIYTODHQAq7ztfFaUPGFQ0aXMEplBaCAwcT0VKo+yGcqzVQBxhnJBQMtB5wO2aQX3oTlZQ7zEGrgDg0nfEFlg7lAh3tRcUvRcBceIrowupqHk/rK9MYZ3EmpISbyJ/JtvM8p/FNWG5oNTm8pw7OKCF8gWvgFsGh8kO43IOEL5Ux2pIWIio/00QH6QJQ5UbTGGkCueUzv90/2QZ6nC5pdWApupB37kiabboriZnYWNytDj/Ro7z3kO++txZnaOnAYPb2Xoxowum2DUugaP0zYU3lml4tngU20XTPVFF+2N8nVHa0pfs4u0K7EFk7XfhKRo+C8IglTIoMlcMeYzh/f/kBFq+HY5b0yuMzknv04eLHdz9fvSNl6CGNDjsejofj0BRr50uueif1Z5H7hW2zJVL/B3PLpthTOzoykotAtZqeKNKk222fkLBJf2p5l7BCO08imw0l869W1jUt/1aFFuX2LmELbgV1ZoFL5cLR33k3gfyq5777pRlmvoLnD0APGtPSGUVcZsFlFVq4hN3jem8KW9/RqCByGtI2SpxnGRrfwz4gxzsM8/27axa6vGKXS90HLtX8Qbsf1GuXZEUF6F9ifAcBm03kaXXdycdPX0U0BrbS5KS7uq7/C5OaM8A=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,f={},x=[];function F(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,p.jsx)(i(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,p.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,p.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,p.jsx)(s(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,p.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,p.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,p.jsx)(t,{...e,children:(0,p.jsx)(F,{...e})}):F(e)}}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.db88685e.js b/assets/js/4227e71a.db88685e.js deleted file mode 100644 index 024cd9a20..000000000 --- a/assets/js/4227e71a.db88685e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5342],{30649:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>p,toc:()=>b});const p=JSON.parse('{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/v1.1/get-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-template","permalink":"/docs/API-docs/v1.1/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWF9v2zgS/ypzfLmtodhOmrZ7ftpgr+gG12uDTRYFLg0MShpL3FAkl6TsGIaAfbhvcE/3eh+tn+QwpCTLjps/2EOBe2ljan7DmeEM+ZvZMM8Lx2bX7AorI7lHx24SlqPLrDBeaMVm7KpEeIceOhE4uzgHLqVeOVjrGrwGi94KXCLk6LmQDniqaw8cnMFMLEQGvgWPezUOHNolAneQyhqNFco7WGgLmUXuhSog11ldIS2vhC/BWMxxIRTm4LytM19bdGOWMG3QcrL2PGczVqDv9mAJM9zyCj1acnPDFK+QzVhnzlzkLGGC3DTcl2zf9/O/gl70xoMvuQeFmDvyOkVYoM9KJB0Wf6uFxZzNvK0xYc6vJe3kRGUkGYJ3Ruoc2WzBpSOBrMSKs9mG+bUJkt4KVbCELbStuI8rqmBNc0PqndHKoSPAyXRK/+2a6uosQ+cWtYQ+HixhmVYelSd5bowUWfgw+dURaHPfCp3+ipmnwFlS40XcMi5TfB+2N67gHQ9ez9jd8U+pqtzJRcGahHnhafW+ii3AhT/6kBNKaf8IqD+gINqQSTJH+63cikn1kIHRHgiCzTYQ2zxsDSbTxWMhKr03bjaZdODaoR1nuiK0Xqkdvx8KVqgz3VmVMCcKFeqkR3Nr+ZoKxGPlHo+m1Y+ZnqF+WsB+1QgpBrOw4kI+Kp0i/tAudLEwpVaPbHP66vXJ8cvv3xyT/ErkBfo/4H/8+rxM8njnU30X7OXFEK7qKkU7hPcrPfy4SdjdMzEnp6dNwtbPRL2hrVbPBL38vklY+UzQ6WvK43CtPSHmX0ulJ8W8OViLl7EO5l0+PCgVytmhys/VR7t756RaS+RquDW9DU3CQuVhfuYfzs6T6cnLo+Pp0fTN1fHr2elfZq9ej6fT6T9Ywu4qufWe5e1N2RnZ/a5N/k32QcVTiVe6fpr7FnNhMfPz2h4s7IfOjrYL5GNe6ZyoBd9PlAP7hieXgLXXc4uVUI+eVAeJ0nOtMpwLNccl2oOl0wOnlBC7YRs+Zvt51Cbh6aEn/VJX6EtiQitUHlZWqyIBI5E7BG/XwAsuFJAa+6f/3VuP1upH3pDnWTasH6GkUDjv+Mz8dDqdH/dBOL0fhKvB2w4LXav827p6aP+HHTqdv+4denXfoXO15FLkgUZf6VtU39af4fY+bn8/Y0UUCt/ZjrPD9eikw6y2wq8Dv7474kYcxe+z6xuirpQpuiXmgZD7ks1Yz14mmwEZbxjps8uOru/Vw4oXBdqf6jRYf1Z7DX/X2W10MVwmPTlaCuujprGLsLJOiRlMLixf1FJ+4MtbbifaoJocj6fjKWuSzZ4Sx1We6rsxCRE7kjx1QQc3YrI8Hh8fwHBjniWP9dFzIc7zQqjiMdzN9mwuKX9iiuyc0JbpGPE3JKrTJsBQqm2QSuSBojb0e6EDuE2LjwYVvYfhWMLm+43UJ5SZrpDaJl8ijEYd5Ms//9OjRqO+5QvpP/6sPquPtQWjV2ips+Eqh4XEO5HK2IdiFb71nahDXkl0Tq5BKI+FpcrNRSE8l0Bxojsr44anQgqqGhLThLYwKDw3hk8l+hItffqzReCQ4xIlFRvQM1Lttqiw0vZ2QT1xAhzS2gmFzgGqkquMBLuTSEBb4ApQebTGCofUzJLVItqmlbc881BxxQsk3QkMg5WjFFQfYHVaOw9OyzqYDNR6a4s5dA6FTjUE8S01nxaBVjNdGYslpc0SoahFji6BTOcIsfkiF1QOKToPhmwRGYaGt1ZSZ7fhAKmCwGi6swSX1CQPbSS4t1w5esmjLd0Z9AEzVlO/itHA0egXh3TC74W6dbPR6LM6gus+rz5h6oTHm++6ElitVvdS/8Uu5p3wdFP8jEY74bVdb9GF8N1tMFTS/4ia3qHCkD+DYtjqyHXm7lcfrU5KlGZyiZ4yxE3OLs7DNf8Cvvz+L3iP3Coo9Spma1ZblGsouq0ocvHkY9j6WzpMRnjtS4p4FpOPZg7ofBfBTyX3X37/t4MPuAKh2pIiV0ajizqVItsOX0ajGfwYWGjfars43si4osmGKzml0lJw4GAiWgp1O4YztQZqOeNQhpKB1gNuxw2Ky2CEk3KHOWgVEIfGQb7EyqFcoiNd9NqmCJgLTxldWl0XcbehMa1zFhdCSvgUCTv5dpbnNC8Kyy2Pp4APzMEFFYQvcQ3cIjhUfgwXe5DwpTZGW7JCROMXmvgnHQCq3GiaW80gt3zht/qTbaLHcZZWB5ZiCHkfjqRV0x9JrMTW4351/Jku5b2LfPe+tbhASxsGt7fnYkSbTtddWgJl6x9Ja+IHdGvxLNCXtl2nF+WHfT2BSqCt3MfFJdqlyLpxxlcqehKEJyxhUmSoHA4oytm7i/ewfDme7jz9TyjuyfvzH99+uHxLxtBFGgPWUQBmtPMVV4OdhsPP/Ydts2Vu/weD0vaxp/53YiQXgdu1TVjkZdfbxiRhs+GY9CZhpXaeRDYbKuZfrGwaWv6tDj3R9U3CltwKagUjeROO/s77kedXI/fdz+309AU8feJ60JmOzijiMksu69AzJuwW13tj3+aGZhOR05C1UeIsy9D4AfYeG9+htO/eXrHQVpa7XOo2cKn2D9J+0K5dkhUNoH+J8R0EbDaRpzVNLx8/fRXROthJU5Bumqb5L19YW2s=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"}}');var i=a(74848),s=a(28453),n=a(33617),l=a.n(n),r=a(17543),o=a.n(r),m=a(86013),d=a.n(m),c=a(63723),f=a.n(c),u=(a(18766),a(79329),a(9303));const h={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWF9v2zgS/ypzfLmtodhOmrZ7ftpgr+gG12uDTRYFLg0MShpL3FAkl6TsGIaAfbhvcE/3eh+tn+QwpCTLjps/2EOBe2ljan7DmeEM+ZvZMM8Lx2bX7AorI7lHx24SlqPLrDBeaMVm7KpEeIceOhE4uzgHLqVeOVjrGrwGi94KXCLk6LmQDniqaw8cnMFMLEQGvgWPezUOHNolAneQyhqNFco7WGgLmUXuhSog11ldIS2vhC/BWMxxIRTm4LytM19bdGOWMG3QcrL2PGczVqDv9mAJM9zyCj1acnPDFK+QzVhnzlzkLGGC3DTcl2zf9/O/gl70xoMvuQeFmDvyOkVYoM9KJB0Wf6uFxZzNvK0xYc6vJe3kRGUkGYJ3Ruoc2WzBpSOBrMSKs9mG+bUJkt4KVbCELbStuI8rqmBNc0PqndHKoSPAyXRK/+2a6uosQ+cWtYQ+HixhmVYelSd5bowUWfgw+dURaHPfCp3+ipmnwFlS40XcMi5TfB+2N67gHQ9ez9jd8U+pqtzJRcGahHnhafW+ii3AhT/6kBNKaf8IqD+gINqQSTJH+63cikn1kIHRHgiCzTYQ2zxsDSbTxWMhKr03bjaZdODaoR1nuiK0Xqkdvx8KVqgz3VmVMCcKFeqkR3Nr+ZoKxGPlHo+m1Y+ZnqF+WsB+1QgpBrOw4kI+Kp0i/tAudLEwpVaPbHP66vXJ8cvv3xyT/ErkBfo/4H/8+rxM8njnU30X7OXFEK7qKkU7hPcrPfy4SdjdMzEnp6dNwtbPRL2hrVbPBL38vklY+UzQ6WvK43CtPSHmX0ulJ8W8OViLl7EO5l0+PCgVytmhys/VR7t756RaS+RquDW9DU3CQuVhfuYfzs6T6cnLo+Pp0fTN1fHr2elfZq9ej6fT6T9Ywu4qufWe5e1N2RnZ/a5N/k32QcVTiVe6fpr7FnNhMfPz2h4s7IfOjrYL5GNe6ZyoBd9PlAP7hieXgLXXc4uVUI+eVAeJ0nOtMpwLNccl2oOl0wOnlBC7YRs+Zvt51Cbh6aEn/VJX6EtiQitUHlZWqyIBI5E7BG/XwAsuFJAa+6f/3VuP1upH3pDnWTasH6GkUDjv+Mz8dDqdH/dBOL0fhKvB2w4LXav827p6aP+HHTqdv+4denXfoXO15FLkgUZf6VtU39af4fY+bn8/Y0UUCt/ZjrPD9eikw6y2wq8Dv7474kYcxe+z6xuirpQpuiXmgZD7ks1Yz14mmwEZbxjps8uOru/Vw4oXBdqf6jRYf1Z7DX/X2W10MVwmPTlaCuujprGLsLJOiRlMLixf1FJ+4MtbbifaoJocj6fjKWuSzZ4Sx1We6rsxCRE7kjx1QQc3YrI8Hh8fwHBjniWP9dFzIc7zQqjiMdzN9mwuKX9iiuyc0JbpGPE3JKrTJsBQqm2QSuSBojb0e6EDuE2LjwYVvYfhWMLm+43UJ5SZrpDaJl8ijEYd5Ms//9OjRqO+5QvpP/6sPquPtQWjV2ips+Eqh4XEO5HK2IdiFb71nahDXkl0Tq5BKI+FpcrNRSE8l0Bxojsr44anQgqqGhLThLYwKDw3hk8l+hItffqzReCQ4xIlFRvQM1Lttqiw0vZ2QT1xAhzS2gmFzgGqkquMBLuTSEBb4ApQebTGCofUzJLVItqmlbc881BxxQsk3QkMg5WjFFQfYHVaOw9OyzqYDNR6a4s5dA6FTjUE8S01nxaBVjNdGYslpc0SoahFji6BTOcIsfkiF1QOKToPhmwRGYaGt1ZSZ7fhAKmCwGi6swSX1CQPbSS4t1w5esmjLd0Z9AEzVlO/itHA0egXh3TC74W6dbPR6LM6gus+rz5h6oTHm++6ElitVvdS/8Uu5p3wdFP8jEY74bVdb9GF8N1tMFTS/4ia3qHCkD+DYtjqyHXm7lcfrU5KlGZyiZ4yxE3OLs7DNf8Cvvz+L3iP3Coo9Spma1ZblGsouq0ocvHkY9j6WzpMRnjtS4p4FpOPZg7ofBfBTyX3X37/t4MPuAKh2pIiV0ajizqVItsOX0ajGfwYWGjfars43si4osmGKzml0lJw4GAiWgp1O4YztQZqOeNQhpKB1gNuxw2Ky2CEk3KHOWgVEIfGQb7EyqFcoiNd9NqmCJgLTxldWl0XcbehMa1zFhdCSvgUCTv5dpbnNC8Kyy2Pp4APzMEFFYQvcQ3cIjhUfgwXe5DwpTZGW7JCROMXmvgnHQCq3GiaW80gt3zht/qTbaLHcZZWB5ZiCHkfjqRV0x9JrMTW4351/Jku5b2LfPe+tbhASxsGt7fnYkSbTtddWgJl6x9Ja+IHdGvxLNCXtl2nF+WHfT2BSqCt3MfFJdqlyLpxxlcqehKEJyxhUmSoHA4oytm7i/ewfDme7jz9TyjuyfvzH99+uHxLxtBFGgPWUQBmtPMVV4OdhsPP/Ydts2Vu/weD0vaxp/53YiQXgdu1TVjkZdfbxiRhs+GY9CZhpXaeRDYbKuZfrGwaWv6tDj3R9U3CltwKagUjeROO/s77kedXI/fdz+309AU8feJ60JmOzijiMksu69AzJuwW13tj3+aGZhOR05C1UeIsy9D4AfYeG9+htO/eXrHQVpa7XOo2cKn2D9J+0K5dkhUNoH+J8R0EbDaRpzVNLx8/fRXROthJU5Bumqb5L19YW2s=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,g={},b=[];function j(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(o(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/4d139b56.7e5f8810.js b/assets/js/4d139b56.7e5f8810.js deleted file mode 100644 index 08bcf50f2..000000000 --- a/assets/js/4d139b56.7e5f8810.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7075],{7988:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>h,contentTitle:()=>b,default:()=>g,frontMatter:()=>m,metadata:()=>s,toc:()=>x});const s=JSON.parse('{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.1/getcredits.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcredits","permalink":"/docs/API-docs/v1.1/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztV81uI7kRfpUKL8kKbUme7CaITnEWhmNkdsaIPTAQ2zDY7FI312ySyx/9QBCwhyAPkJxyzaPNkwRFdrdaGi8miwR7yQKGLJFVxa/+WB93LPDas8UD++DRsaeCVeiFkzZIo9mC3TUIVxjga4eVDB4ubq7BYYhOe6gwcKk88NLEAKFBEJ0UX3GpeKkQgoGtiQ64ECbqsHjUj3oysYrr5054MZkM1qUWKlZYwVqGJiv6WA54gPSmcNegR3DoMQDPB/vAXQCzBOSiAY1rKKVSUtcgtkLh9FEDXG54axUu4HqZTZM1sM6sZIUezufzAb9FB63RoQGuKxIG1BXZSE6SxYzwqzk4bLnUUtdFNlpyxbXo4HnynwxnmGRhQEqmNG7CCCGFhleVeTU2NjrRcI8VeLTc8YBqC0tnWrjFEKSuPXz8299Tgu7MC+r06w9xCzcOWxnb3tAULqrqzOjB2cqANgFwY6XD5DB3CEarLUQ6zpA7XKkcryHFDkEY7WOL1TRnNZjA1Rg6FY+PLXl7nPPJJJ1z4u1kQrmVHhxaCp+m+DVUQ4Gr4WARnUMd1HZUZUvjCGuHw6HGNVfPFQ/Yw7gdl1EnACTwqFnBjEXHaeu6YgtWY+gOYwVz6K3RHj1b7Nib+Zz+HbfIbRQCvV9GBYMdVjBhdEAdSJ5bq6RIG7NvPSntmBcNtpy+ha1FtmCm/BZFYAWzjswEmY8ch20krWNbomMFw1zVbDHfF+wonJ+VPsrXZ6XHUR0J++CkrlnBlsa1PLAFSwIjZfZm/uY3Z/PfnZ3/9m4+X6S/6Xw+/wvbEwgZklAH49mhZ/s97Xz5erBHeaSyXZqoq/9duNE5415z7+DO6xB+kVBn3F9+iptu17HwTwn49Oxx2KVWUuNzX+XPBL5346tP3bjWK65kdbhlflpPxseHfDxB3bSK9DRvs0tJKO2zI1fH69lJjyI6GbZs8bBjmzNu5VneXzw87Z8K1mJoTHcnEGAeGrZgs6MbwqNbofPJxEmxrnldo/tjLBPiixgMfGPES3YrOsUWrAnB+sVstpIuZEtTn9WaWE6FaWc3ji+jUu/46oW7mbGoZ+fT+XTO9sXuxIjnuirNZkpCXtZa8dInG9zK2ep8ev6KDrf2R8ljPPuxKj7wWur6c3pPh3zcUs3ksjjKylAc3Mo/4ZYVfdLHUgWTFP0GeYUuFYjUS5OUu1J4b1HfylqntKTDT3nPPSph2sRfaARNJr3Kx7/+a9CaTKAyIraoQyr5NH/eE7Mwa3Q0EGjKLRVuJE0pUsM27flEKoIBj7xV6L3agtQBa5rrUMla0sijOCUOwy0vpZLUKSTWc6pDs/kp3DcYGnS09Uua41DhChU1GPAYTMuJIwx4YW3cy1KZtS+AQxm91Og9oG64FiTYZ6IA44BrQB3QWSc9kS1HqGXGZnRwXARoueY1ku0CxsGqUEnqD3CmjD6ANyomyEDs0TisBpKoESufgni5sbQFtCpMax02VDYrhDoSWytAmArBp4uBXNAVlOgDWMIiBSbmFbUy4iUlkDoIrKF7SnJFjGSMkdSD49rTEMtY+hwMAbPO0JhH37GMDx4pw2+lfiGy86jP4GGoq3ssvQz49Ku+Bdbr9Sel/8WxzpUMdFP8Ga3xMhi3PWjXMvS3wdjI8CNbukKNqX5GzXCwURnhP+0+Wp01qOysZ5Gzi5vrdLV/AR+//we8Re40NGadq1VER7yz7o+iyOXM57ANN3PiZDyGhiIucvE5/C6iD30E7xsePn7/Tw/vcA1Sdy1FrkwmN7FUUsAdtlbxgH4yWRCBpSNDvwah4QEE11Ai+IZTKa0kBw42ayupX6ZwoRORdZmyUzHQetI7coPiMqTbQ8kz+c0UtDtzekBE661HtUJPtmi+lgg0FKiiG2dinU8bg+mcc7iUSsG9rGoMybeLqgLbLa/zMgV8BAeX1BChwW3i3kSPp3BzopJ2orXGEQqZwS+NUmZNCUBdWSN18AuoHF+Gg/3iUOiCwiyNfmUph5AP4Sg6M0NKcid2Hg+r00SyTy7y4/vW4RIdHZjcPuTFyq6cHvqyBKrW/6asiRPQrcVFoiz0flN5ovz+1E6iD+ha/355i24lBXZT7Qc6epaEZ6xgSgrUHke05OLq5i2sfj2dH43+/6C5Z2+vv758d3tJYOgizQHrKQCzxoeW69FJ9F4fmvHAU44Cvjuwtp/f+D+/8f8P3vgdcQy4CTOruExvg9SIu47XP4xf/k8Fa4wPtLrb0Sz44NR+T8vfRXT0YHgq2Io7SeDSc6HoGSc9BF5wSz0vBFp6OKy4ipm2nryPjh4ZV5d3rGA0NI+Z7ktiut0Xst5v6e3I9jEFzgDok/j4qwq7XWbR+/0gn7d+UKNzsJemGD7t9/t/A7PxLIk=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var i=r(74848),n=r(28453),o=r(33617),a=r.n(o),d=r(17543),c=r.n(d),l=r(86013),p=r.n(l),u=r(63723),y=r.n(u),P=(r(18766),r(79329),r(9303));const m={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztV81uI7kRfpUKL8kKbUme7CaITnEWhmNkdsaIPTAQ2zDY7FI312ySyx/9QBCwhyAPkJxyzaPNkwRFdrdaGi8miwR7yQKGLJFVxa/+WB93LPDas8UD++DRsaeCVeiFkzZIo9mC3TUIVxjga4eVDB4ubq7BYYhOe6gwcKk88NLEAKFBEJ0UX3GpeKkQgoGtiQ64ECbqsHjUj3oysYrr5054MZkM1qUWKlZYwVqGJiv6WA54gPSmcNegR3DoMQDPB/vAXQCzBOSiAY1rKKVSUtcgtkLh9FEDXG54axUu4HqZTZM1sM6sZIUezufzAb9FB63RoQGuKxIG1BXZSE6SxYzwqzk4bLnUUtdFNlpyxbXo4HnynwxnmGRhQEqmNG7CCCGFhleVeTU2NjrRcI8VeLTc8YBqC0tnWrjFEKSuPXz8299Tgu7MC+r06w9xCzcOWxnb3tAULqrqzOjB2cqANgFwY6XD5DB3CEarLUQ6zpA7XKkcryHFDkEY7WOL1TRnNZjA1Rg6FY+PLXl7nPPJJJ1z4u1kQrmVHhxaCp+m+DVUQ4Gr4WARnUMd1HZUZUvjCGuHw6HGNVfPFQ/Yw7gdl1EnACTwqFnBjEXHaeu6YgtWY+gOYwVz6K3RHj1b7Nib+Zz+HbfIbRQCvV9GBYMdVjBhdEAdSJ5bq6RIG7NvPSntmBcNtpy+ha1FtmCm/BZFYAWzjswEmY8ch20krWNbomMFw1zVbDHfF+wonJ+VPsrXZ6XHUR0J++CkrlnBlsa1PLAFSwIjZfZm/uY3Z/PfnZ3/9m4+X6S/6Xw+/wvbEwgZklAH49mhZ/s97Xz5erBHeaSyXZqoq/9duNE5415z7+DO6xB+kVBn3F9+iptu17HwTwn49Oxx2KVWUuNzX+XPBL5346tP3bjWK65kdbhlflpPxseHfDxB3bSK9DRvs0tJKO2zI1fH69lJjyI6GbZs8bBjmzNu5VneXzw87Z8K1mJoTHcnEGAeGrZgs6MbwqNbofPJxEmxrnldo/tjLBPiixgMfGPES3YrOsUWrAnB+sVstpIuZEtTn9WaWE6FaWc3ji+jUu/46oW7mbGoZ+fT+XTO9sXuxIjnuirNZkpCXtZa8dInG9zK2ep8ev6KDrf2R8ljPPuxKj7wWur6c3pPh3zcUs3ksjjKylAc3Mo/4ZYVfdLHUgWTFP0GeYUuFYjUS5OUu1J4b1HfylqntKTDT3nPPSph2sRfaARNJr3Kx7/+a9CaTKAyIraoQyr5NH/eE7Mwa3Q0EGjKLRVuJE0pUsM27flEKoIBj7xV6L3agtQBa5rrUMla0sijOCUOwy0vpZLUKSTWc6pDs/kp3DcYGnS09Uua41DhChU1GPAYTMuJIwx4YW3cy1KZtS+AQxm91Og9oG64FiTYZ6IA44BrQB3QWSc9kS1HqGXGZnRwXARoueY1ku0CxsGqUEnqD3CmjD6ANyomyEDs0TisBpKoESufgni5sbQFtCpMax02VDYrhDoSWytAmArBp4uBXNAVlOgDWMIiBSbmFbUy4iUlkDoIrKF7SnJFjGSMkdSD49rTEMtY+hwMAbPO0JhH37GMDx4pw2+lfiGy86jP4GGoq3ssvQz49Ku+Bdbr9Sel/8WxzpUMdFP8Ga3xMhi3PWjXMvS3wdjI8CNbukKNqX5GzXCwURnhP+0+Wp01qOysZ5Gzi5vrdLV/AR+//we8Re40NGadq1VER7yz7o+iyOXM57ANN3PiZDyGhiIucvE5/C6iD30E7xsePn7/Tw/vcA1Sdy1FrkwmN7FUUsAdtlbxgH4yWRCBpSNDvwah4QEE11Ai+IZTKa0kBw42ayupX6ZwoRORdZmyUzHQetI7coPiMqTbQ8kz+c0UtDtzekBE661HtUJPtmi+lgg0FKiiG2dinU8bg+mcc7iUSsG9rGoMybeLqgLbLa/zMgV8BAeX1BChwW3i3kSPp3BzopJ2orXGEQqZwS+NUmZNCUBdWSN18AuoHF+Gg/3iUOiCwiyNfmUph5AP4Sg6M0NKcid2Hg+r00SyTy7y4/vW4RIdHZjcPuTFyq6cHvqyBKrW/6asiRPQrcVFoiz0flN5ovz+1E6iD+ha/355i24lBXZT7Qc6epaEZ6xgSgrUHke05OLq5i2sfj2dH43+/6C5Z2+vv758d3tJYOgizQHrKQCzxoeW69FJ9F4fmvHAU44Cvjuwtp/f+D+/8f8P3vgdcQy4CTOruExvg9SIu47XP4xf/k8Fa4wPtLrb0Sz44NR+T8vfRXT0YHgq2Io7SeDSc6HoGSc9BF5wSz0vBFp6OKy4ipm2nryPjh4ZV5d3rGA0NI+Z7ktiut0Xst5v6e3I9jEFzgDok/j4qwq7XWbR+/0gn7d+UKNzsJemGD7t9/t/A7PxLIk=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,h={},x=[];function U(e){const t={p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(P.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,i.jsx)(t.strong,{children:"plan_credits"})," and ",(0,i.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,i.jsx)(c(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(y(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{plan_credits:{type:"number",example:0},addon_credits:{type:"number",example:0},total_credits:{type:"number",example:0},renewal_date:{type:"string",format:"date",example:"2026-09-17T00:00:00.000Z"}},title:"credits_res"}}}},400:{description:"Subscription not found",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Subscription not found!"}}}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(U,{...e})}):U(e)}}}]); \ No newline at end of file diff --git a/assets/js/4d139b56.8d0aa3f2.js b/assets/js/4d139b56.8d0aa3f2.js new file mode 100644 index 000000000..58b3a31aa --- /dev/null +++ b/assets/js/4d139b56.8d0aa3f2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7075],{7988:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>C,contentTitle:()=>g,default:()=>f,frontMatter:()=>S,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.1/getcredits.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcredits","permalink":"/docs/API-docs/v1.1/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztV91uI7cVfpUT3rQRxpK8SVp0ruoGhmtkkTVqLwzUNgwO52iGMYdk+CNZEATkougDtFe97aPtkxSHnBmNvA62QYrcNIAhS+T5+c4PeT7uWOCNZ+Ude+/RsYeC1eiFkzZIo1nJblqECwzwtcNaBg9nV5fgMESnPdQYuFQeeGVigNAiiF6Kr7lUvFIIwcDWRAdcCBN1KO/1vZ7NrOL6sRcuZ7PRutRCxRpr2MjQZkUfqxEPkN4cblr0CA49BuDZsQ/cBTArQC5a0LiBSioldQNiKxTO7zXA+TPvrMISLlfZNFkD68xa1ujhdLkc8Vt00BkdWuC6JmFAXZONFCRZzAi/WoLDjkstdVNkoxVXXIsenqf4yXCGSRZGpGRK43OYIKTU8Lo2r+bGRida7rEGj5Y7HlBtYeVMB9cYgtSNhw9//0cq0I15Qp1+/Slu4cphJ2M3GJrDWV2fGD0GWxvQJgA+W+kwBcwdgtFqC5HcGQqHK5XzNZbYIQijfeywnueqBhO4mkKn5vGxo2iPaz6bJT8vop3NqLbSg0NL6dOUv5Z6KHA1OhbROdRBbSddtjKOsPY4HGrccPVY84ADjOtpG/UCQAL3mhXMWHScti5rVrIGQ++MFcyht0Z79KzcsTfLJf07PiLXUQj0fhUVjHZYwYTRAXUgeW6tkiJtLL7zpLRjXrTYcfoWthZZyUz1HYrACmYdmQkyu5ymbSKtY1ehYwXD3NWsXO4LdpTOT0of1euT0tOsToR9cFI3rGAr4zoeWMmSwESZvVm++d3J8g8np7+/WS7L9DdfLpd/ZXsCIUMS6mE8OvRsv6edL19P9qSO1LYrE3X9v0s3Omfca+EdwnkdwmcJdcb95ce46XadCv+SgF/6nqZdaiU1Pg5d/kjghzC++jiMS73mStaHW+aXjWTqPmT3BPW5U6SneZdDSkJpnx2FOl3PQXoU0cmwZeXdjj2fcCtP8n5597B/KFiHoTX9nUCAeWhZyRZHN4RHt0bnk4noFCtZG4L15WLhua4r8zw3FrWXjVa88nNhugW3crE+nZ+yffFSh1v7k+QxnvxUFR94I3XzKb2HQ3quqYS5SkdJGmvFrfwGt6wYajCVKpik1mmR1+hSvaRemaTcV+adRX0tG53qmpy/pCG3qITpEp2giTCbDSof/vbvUWs2g9qI2KEOqQPTOHhHg95s0NH9TENnpfBZ0tAgNezSnk8zPhjwyDuF3qstSB2woTELtWwkTSDKU6IU3PJKKkmNS2IDxTn0vp/DbYuhRUdbv6GxCjWuUVG/A4/BdJxG9ogXNsY9rZTZ+AI4VNFLjd4D6pZrQYJDJQowDrgG1AGdddIT93GEWmZsRgfHRYCOa94g2S5gmqwalaR2BWeq6AN4o2KCDETmjMN65GwasfYpiefPlraAVoXprMOW2maN0EQiTwUIUyP4dE4pBF1DhT6AJSxSYCJCUSsjnlIBV5H4hKFrQ3JFBGGKkdSD49rTTMlYhhqMCbPO0NRF3w/99x6pwm+lfiLuca9P4G7sq1usvAz48NvhCGw2m49a//NjnQsZ/hwr+Ata42UwbnvQbmRoY5WOy9TI+CNbukCNqX8mh+FgozbCf3z6aHXRorKLgdQtzq4u0037OXz44Z/wFrnT0JpN7lYRHdHAZnBFmcuVz2kbL8pEkXgMLWVc5OZz+H1EH4YM3rY8fPjhXx6+xQ1I3R8pCmU2u4qVkgJusLOKB/SzWUl8klyGYQ1CywMIrqFC8C2nVlpLDhxs1lZSP83hTCde6TKDpmag9aR3FAblZSy3h4pnLpoZYe9zfkBE651HtUZPtmjcVQh0R1NHt87EJnubgumDc7iSSsGtrBsMKbazugbbL2/yMiV8AgdXdCBCi9tEhYmtzuHqhUraidYaRyhkBr8ySpkNFQB1bY3UwZdQO74KB/vFodEFpVka/cpSTiEf01H0ZsaS5JPYRzyuzhPnfXGRH9+3DlfoyGEK+1AXK/t2uhvaEqhbf05b04imW4uLxCDoOaXyRPnjSztpmqPr/LvVNbq1FNhPtR850YskvGAFU1Kg9jhhCWcXV29h/cV8yYrJePwvDvfi7eXX599enxMYukhzwk7ny/mSlqzxoeN64omez+NhPNCGo4TvDiTq1yf3r0/u/4Mnd08cAz6HhVVcJqqeDuKup9l304f4Q8Fa4wOt7nY0C947td/T8vcRHfH3h4KtuZMELrH3YmCcxMufcEtnXgi0xOPXXMVMW188V444/8X5DSsYDc1jpvuUmG7/hawPW3o7sX1MgTMA+iQ+/qrCbpdZ9H4/yuetH9XoAxykKYcP+/3+P2OzBN4=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var s=r(74848),i=r(28453),d=r(33617),o=r.n(d),c=r(17543),a=r.n(c),p=r(86013),u=r.n(p),l=r(63723),h=r.n(l),m=(r(18766),r(79329),r(9303));const S={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91uI7cVfpUT3rQRxpK8SVp0ruoGhmtkkTVqLwzUNgwO52iGMYdk+CNZEATkougDtFe97aPtkxSHnBmNvA62QYrcNIAhS+T5+c4PeT7uWOCNZ+Ude+/RsYeC1eiFkzZIo1nJblqECwzwtcNaBg9nV5fgMESnPdQYuFQeeGVigNAiiF6Kr7lUvFIIwcDWRAdcCBN1KO/1vZ7NrOL6sRcuZ7PRutRCxRpr2MjQZkUfqxEPkN4cblr0CA49BuDZsQ/cBTArQC5a0LiBSioldQNiKxTO7zXA+TPvrMISLlfZNFkD68xa1ujhdLkc8Vt00BkdWuC6JmFAXZONFCRZzAi/WoLDjkstdVNkoxVXXIsenqf4yXCGSRZGpGRK43OYIKTU8Lo2r+bGRida7rEGj5Y7HlBtYeVMB9cYgtSNhw9//0cq0I15Qp1+/Slu4cphJ2M3GJrDWV2fGD0GWxvQJgA+W+kwBcwdgtFqC5HcGQqHK5XzNZbYIQijfeywnueqBhO4mkKn5vGxo2iPaz6bJT8vop3NqLbSg0NL6dOUv5Z6KHA1OhbROdRBbSddtjKOsPY4HGrccPVY84ADjOtpG/UCQAL3mhXMWHScti5rVrIGQ++MFcyht0Z79KzcsTfLJf07PiLXUQj0fhUVjHZYwYTRAXUgeW6tkiJtLL7zpLRjXrTYcfoWthZZyUz1HYrACmYdmQkyu5ymbSKtY1ehYwXD3NWsXO4LdpTOT0of1euT0tOsToR9cFI3rGAr4zoeWMmSwESZvVm++d3J8g8np7+/WS7L9DdfLpd/ZXsCIUMS6mE8OvRsv6edL19P9qSO1LYrE3X9v0s3Omfca+EdwnkdwmcJdcb95ce46XadCv+SgF/6nqZdaiU1Pg5d/kjghzC++jiMS73mStaHW+aXjWTqPmT3BPW5U6SneZdDSkJpnx2FOl3PQXoU0cmwZeXdjj2fcCtP8n5597B/KFiHoTX9nUCAeWhZyRZHN4RHt0bnk4noFCtZG4L15WLhua4r8zw3FrWXjVa88nNhugW3crE+nZ+yffFSh1v7k+QxnvxUFR94I3XzKb2HQ3quqYS5SkdJGmvFrfwGt6wYajCVKpik1mmR1+hSvaRemaTcV+adRX0tG53qmpy/pCG3qITpEp2giTCbDSof/vbvUWs2g9qI2KEOqQPTOHhHg95s0NH9TENnpfBZ0tAgNezSnk8zPhjwyDuF3qstSB2woTELtWwkTSDKU6IU3PJKKkmNS2IDxTn0vp/DbYuhRUdbv6GxCjWuUVG/A4/BdJxG9ogXNsY9rZTZ+AI4VNFLjd4D6pZrQYJDJQowDrgG1AGdddIT93GEWmZsRgfHRYCOa94g2S5gmqwalaR2BWeq6AN4o2KCDETmjMN65GwasfYpiefPlraAVoXprMOW2maN0EQiTwUIUyP4dE4pBF1DhT6AJSxSYCJCUSsjnlIBV5H4hKFrQ3JFBGGKkdSD49rTTMlYhhqMCbPO0NRF3w/99x6pwm+lfiLuca9P4G7sq1usvAz48NvhCGw2m49a//NjnQsZ/hwr+Ata42UwbnvQbmRoY5WOy9TI+CNbukCNqX8mh+FgozbCf3z6aHXRorKLgdQtzq4u0037OXz44Z/wFrnT0JpN7lYRHdHAZnBFmcuVz2kbL8pEkXgMLWVc5OZz+H1EH4YM3rY8fPjhXx6+xQ1I3R8pCmU2u4qVkgJusLOKB/SzWUl8klyGYQ1CywMIrqFC8C2nVlpLDhxs1lZSP83hTCde6TKDpmag9aR3FAblZSy3h4pnLpoZYe9zfkBE651HtUZPtmjcVQh0R1NHt87EJnubgumDc7iSSsGtrBsMKbazugbbL2/yMiV8AgdXdCBCi9tEhYmtzuHqhUraidYaRyhkBr8ySpkNFQB1bY3UwZdQO74KB/vFodEFpVka/cpSTiEf01H0ZsaS5JPYRzyuzhPnfXGRH9+3DlfoyGEK+1AXK/t2uhvaEqhbf05b04imW4uLxCDoOaXyRPnjSztpmqPr/LvVNbq1FNhPtR850YskvGAFU1Kg9jhhCWcXV29h/cV8yYrJePwvDvfi7eXX599enxMYukhzwk7ny/mSlqzxoeN64omez+NhPNCGo4TvDiTq1yf3r0/u/4Mnd08cAz6HhVVcJqqeDuKup9l304f4Q8Fa4wOt7nY0C947td/T8vcRHfH3h4KtuZMELrH3YmCcxMufcEtnXgi0xOPXXMVMW188V444/8X5DSsYDc1jpvuUmG7/hawPW3o7sX1MgTMA+iQ+/qrCbpdZ9H4/yuetH9XoAxykKYcP+/3+P2OzBN4=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,C={},b=[];function T(e){const t={p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,s.jsx)(o(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,s.jsx)(t.strong,{children:"plan_credits"})," and ",(0,s.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{plan_credits:{type:"number",example:0},addon_credits:{type:"number",example:0},total_credits:{type:"number",example:0},renewal_date:{type:"string",format:"date",example:"2026-09-17T00:00:00.000Z"}},title:"credits_res"}}}},400:{description:"Subscription not found",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Subscription not found!"}}}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.7c000e5d.js b/assets/js/5144c8d4.7c000e5d.js deleted file mode 100644 index 1cc883314..000000000 --- a/assets/js/5144c8d4.7c000e5d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7904],{8437:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>v,frontMatter:()=>g,metadata:()=>s,toc:()=>x});const s=JSON.parse('{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/v1.1/get-user.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-user","permalink":"/docs/API-docs/v1.1/get-user","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar_label":"Get your account details","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uGzcQfpUpL22EtST/JGl1ilukrtM0MWoHBuoYAXd3tMuISzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjj/8+1CkKyCGF2JVwG9uM5EiaHwypGyRozERY1wggR8Csdnp4BG5hoDzG0LZKFC4kcPdmZAFoVtDUGJJJUOfZEJ69BL1nVaipGokOI1mfAYnDUBgxgtxMFwyH/bN5+3RYEhjFsNayUiE4U1hIaYXzqnVREPBm8DCy1EKGpsJD/R3KEYCZu/xYJEJpxnNaTSlYnMRq05A3llKpGJsfWNpE0K3sjGaWb68URNDg7z+tUzscyEkQ3eV8Mzi/A9IotjI5W+r/xbiznikxWhX9iGVbnamnubcvTw0eNvDw/2Dw5ZxVubXyjS99ZS4pTFC9s4aeb3lbYOTVCViSo8SsLymD6m5FbkYHhwuLc/3Bs+vth/NDr6bvTwUX84HP4mMnHTxHimvIhSUowzJbfW760rv8A9y122lkt/gy29L5nxaHh0twNizxlLMLatKb/6/4ofvbf+n33fvXu5YbcyWhl807XwGza+c+PhXTdOzVRqVcbpcWEnaL6sJ5vXU7r+bmpUYornYsvVTXpyMmDRekVzMbpaiJs96dReOh9dXS+vM9Eg1XY17dhgSbUYiUGF1KbZF9BP0YcovzPzZrKq0P/U5tHc45Ys/GKLSfKp9VqMRE3kwmgwmCpPSVM/JLG6zXkcDM68HLdav5DTifQDbrDBfn/YH4pltthREqQpc3vT77pQyzxEHdKpwXS/v/8RGencvfix3buvSCBZKVP9m9z1bTLOuWBSTWylZF0Z0qmfcS66mb3FlQnF0a9RlrEj+X1so/CqDl46NOeqMjEt8fLdRXmJurAN8k6kGqHX60Q+/P7XWqrXg9IWbYOGYr33X5vX5mXrwdkZel510pQw1nijco1p3zbxbL1wA8pGYwh6DsoQVl4SQqkqRVIDx0mZCgrpZK604jZhNpt29EanhT5c1kg1ej762iNIKHGKmrsLZEu2kcSqOnthZv1krO0sZCAhb4MyGAKgqaUpmLHLRAbWgzSAhtA7rwJCIM9Wq2SbNeRlQdBIIytk3RlsBqtErbg/wNu8DQTB6jaaDIwqrMcSOocMYhliEJ/eOD4CpvIm8lhz2UwRqlaVGDIobIkQ4lRgF0wJOQYCx7aoAgMrbY22xSQmkDsInOUhpaQGO96ykcXJSxN4tSVbuhysA+a8ZQCDycBe71VAzvBzZSZh1Ou9Nntwta6rS8yDIrz+pmuB2Wx2p/QfbMucKOJJ8Ss6GxRZP7+VrhR102BTyfolaTpBg7F+NprhVkdpi3C3+5g6qFG7wTkSV0gYHJ+dxrn+AD68/wOeo/QGajtL1Vq0HvUcqu4qjlzKfArbeizD2MbCqzniRSo+j+9aDNRF8LKW9OH9nwFe4AyUWbUUu9LrnbW5VgVcYOO0JAy93gh+iHgCqKMB1ZKgkAZyhFBLLqWpkiDBJWmtzKQPx2YOPKphpqiOxcD0KLflBsdlne4AuQxYgjVRoruzf2sR05uAeoqBdfFyzRGwVMQVXXvbVum2TWNWznkcK63hUpUVUvTtuCzBrcizROaAb5iDY24IqnEO0iMENNSHsx2ReNI6Zz1boZLxY6u1nXEC0JTOKkNhBKWXY7rVn90WeoRtypqPkFII5Toc2UrNOiWpE1cer6n91zyUdwb59rz1OEbPF4b0GdLlxalVOV11ZQlcrZ9T1gndGpJFxCsr1M4b5cmunogd0Dfh5fgc/VQVuNpqn+joQWQeiExoVaAJuIFJjk/OnsP0sD/cWv3/obkHz09/ePri/Ckbw4M0BayDAMLZQI00GzeddB9xOx9wu0tucQvbPvvDcLWWCW9o4LRUEXZFNxcryHQlOsh0nYnaBmLSYsFt9srr5ZLJ71r0DMSuMzGVXrEFEYZl3TJnjDXBOYezKNAxIJtK3SZEsIM7t8DbydMLkQmeR9sgYhJBxOqBtXdHZr6hextdJAP4l6HORwUWiwRQlss1fzr6pMTKwY6bA3i9XC7/Bvzsgf8=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1"},"next":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"}}');var o=n(74848),r=n(28453),i=n(33617),a=n.n(i),p=n(17543),c=n.n(p),l=n(86013),d=n.n(l),u=n(63723),b=n.n(u),m=(n(18766),n(79329),n(9303));const g={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uGzcQfpUpL22EtST/JGl1ilukrtM0MWoHBuoYAXd3tMuISzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjj/8+1CkKyCGF2JVwG9uM5EiaHwypGyRozERY1wggR8Csdnp4BG5hoDzG0LZKFC4kcPdmZAFoVtDUGJJJUOfZEJ69BL1nVaipGokOI1mfAYnDUBgxgtxMFwyH/bN5+3RYEhjFsNayUiE4U1hIaYXzqnVREPBm8DCy1EKGpsJD/R3KEYCZu/xYJEJpxnNaTSlYnMRq05A3llKpGJsfWNpE0K3sjGaWb68URNDg7z+tUzscyEkQ3eV8Mzi/A9IotjI5W+r/xbiznikxWhX9iGVbnamnubcvTw0eNvDw/2Dw5ZxVubXyjS99ZS4pTFC9s4aeb3lbYOTVCViSo8SsLymD6m5FbkYHhwuLc/3Bs+vth/NDr6bvTwUX84HP4mMnHTxHimvIhSUowzJbfW760rv8A9y122lkt/gy29L5nxaHh0twNizxlLMLatKb/6/4ofvbf+n33fvXu5YbcyWhl807XwGza+c+PhXTdOzVRqVcbpcWEnaL6sJ5vXU7r+bmpUYornYsvVTXpyMmDRekVzMbpaiJs96dReOh9dXS+vM9Eg1XY17dhgSbUYiUGF1KbZF9BP0YcovzPzZrKq0P/U5tHc45Ys/GKLSfKp9VqMRE3kwmgwmCpPSVM/JLG6zXkcDM68HLdav5DTifQDbrDBfn/YH4pltthREqQpc3vT77pQyzxEHdKpwXS/v/8RGencvfix3buvSCBZKVP9m9z1bTLOuWBSTWylZF0Z0qmfcS66mb3FlQnF0a9RlrEj+X1so/CqDl46NOeqMjEt8fLdRXmJurAN8k6kGqHX60Q+/P7XWqrXg9IWbYOGYr33X5vX5mXrwdkZel510pQw1nijco1p3zbxbL1wA8pGYwh6DsoQVl4SQqkqRVIDx0mZCgrpZK604jZhNpt29EanhT5c1kg1ej762iNIKHGKmrsLZEu2kcSqOnthZv1krO0sZCAhb4MyGAKgqaUpmLHLRAbWgzSAhtA7rwJCIM9Wq2SbNeRlQdBIIytk3RlsBqtErbg/wNu8DQTB6jaaDIwqrMcSOocMYhliEJ/eOD4CpvIm8lhz2UwRqlaVGDIobIkQ4lRgF0wJOQYCx7aoAgMrbY22xSQmkDsInOUhpaQGO96ykcXJSxN4tSVbuhysA+a8ZQCDycBe71VAzvBzZSZh1Ou9Nntwta6rS8yDIrz+pmuB2Wx2p/QfbMucKOJJ8Ss6GxRZP7+VrhR102BTyfolaTpBg7F+NprhVkdpi3C3+5g6qFG7wTkSV0gYHJ+dxrn+AD68/wOeo/QGajtL1Vq0HvUcqu4qjlzKfArbeizD2MbCqzniRSo+j+9aDNRF8LKW9OH9nwFe4AyUWbUUu9LrnbW5VgVcYOO0JAy93gh+iHgCqKMB1ZKgkAZyhFBLLqWpkiDBJWmtzKQPx2YOPKphpqiOxcD0KLflBsdlne4AuQxYgjVRoruzf2sR05uAeoqBdfFyzRGwVMQVXXvbVum2TWNWznkcK63hUpUVUvTtuCzBrcizROaAb5iDY24IqnEO0iMENNSHsx2ReNI6Zz1boZLxY6u1nXEC0JTOKkNhBKWXY7rVn90WeoRtypqPkFII5Toc2UrNOiWpE1cer6n91zyUdwb59rz1OEbPF4b0GdLlxalVOV11ZQlcrZ9T1gndGpJFxCsr1M4b5cmunogd0Dfh5fgc/VQVuNpqn+joQWQeiExoVaAJuIFJjk/OnsP0sD/cWv3/obkHz09/ePri/Ckbw4M0BayDAMLZQI00GzeddB9xOx9wu0tucQvbPvvDcLWWCW9o4LRUEXZFNxcryHQlOsh0nYnaBmLSYsFt9srr5ZLJ71r0DMSuMzGVXrEFEYZl3TJnjDXBOYezKNAxIJtK3SZEsIM7t8DbydMLkQmeR9sgYhJBxOqBtXdHZr6hextdJAP4l6HORwUWiwRQlss1fzr6pMTKwY6bA3i9XC7/Bvzsgf8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,y={},x=[];function z(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,o.jsx)(a(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,o.jsx)(c(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"Joe Bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4567832123"},jobTitle:{type:"string",format:"string",example:"dev"},company:{type:"string",format:"string",example:"opensign"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"user"},title:"user"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(z,{...e})}):z(e)}}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.8aab2983.js b/assets/js/5144c8d4.8aab2983.js new file mode 100644 index 000000000..590f11e52 --- /dev/null +++ b/assets/js/5144c8d4.8aab2983.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7904],{8437:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>S,contentTitle:()=>x,default:()=>D,frontMatter:()=>g,metadata:()=>n,toc:()=>v});const n=JSON.parse('{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/v1.1/get-user.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-user","permalink":"/docs/API-docs/v1.1/get-user","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar_label":"Get your account details","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uGzcQfpUpL22EtST/JGl1ihu4rtMgMWoHBmobAXd3tMuYSzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjg/3/zsXJCsghhdijcBvbjORImh8MqRskaMxHmNcIwEfAqHpyeARuYaA8xsC2ShQuJHD3ZqQBaFbQ1BiSSVDn2RCevQS9Z1UoqRqJDiNZnwGJw1AYMYzcXecMh/mzeftUWBIYxbDSslIhOFNYSGmF86p1URDwbvAgvNRShqbCQ/0cyhGAmbv8OCRCacZzWk0pWJzEatOAN5ZSqRibH1jaR1Ct7Kxmlm+ulY3ezt5/WbF2KRCSMbfKiGFxbhR0QWx0Yq/VD5dxZzxGdLQr+wDatytTUPNuXg8ZOn3+/v7e7ts4p3Nj9XpB+spcQJixe2cdLMHiptHZqgKhNVeJSE5SF9SsmdyN5wb39nd7gzfHq++2R08MPo8ZP+cDj8TWTitonxTHkRpaQYZ0purd5bV36FexbbbC1Df40tvS+Y8WB4cL8CYs0ZSzC2rSm/+f/Aj95b/8++b9+9WLNbGa0Mvu1K+C0b37nx+L4bJ2YitSpj9zi3N2i+rifr11O6/n5qVGKK52LD1XV6cjJg0XpFMzG6nIvbHenUTjofXV4vrjPRINV22e3YYEm1GIlBhdSm3hfQT9CHKN96LUaiJnJhNBgEacrc3va7otAyD1zhA+nUYLLb3xWLbFtGOvcgfmx3HioSSFbKVP8md30XmzPOX0rRRoRWiZJO/YIz0bXQDa5MKMZNjbKMBcLvYxuFl2l57dCcqcrEpMbLt+fWBerCNsgjimqEXq8T+fj7XyupXg9KW7QNGorw61+ZK/O69eDsFD1PHmlKGGu8VbnGNP6aeLaafwFlozEEPQNlCCsvCaFUlSKpgeOkTAWFdDJXWjFqmc2mkbkG/NCHixqpRs9H33oECSVOUDPYQbZkG0msqrMXptbfjLWdhgwk5G1QBkMANLU0BTN2mcjAepAG0BB651VACOTZapVss4a8LAgaaWSFrDuD9WCVqBXDFbzN20AQrG6jycBD3nosoXPIIJYhBvHo1vERMJUHg8eaYTNBqFpVYsigsCVCiEXKLpgScgwEjm1RBQZW2hpti5uYwHGrNTjLPUNJDXa8YSOLk5cm8KRJtnQ5WAXMecv7BCYDe703ATnDL5W5CaNe78rswOUKVxeYB0V4/V1XAtPp9B70H23KHCv6uc3hV3Q2KLJ+diddKarbPJbLupLVS9J0jAYjftaK4U5HaYtwv/qYOqhRu8EZEiMkDA5PT2KbfQQfP/wBL1F6A7WdJrQWrUc9g6q7iiOXMp/CtuqSMLYReDVHvEjg8/i+xUBdBC9qSR8//BngFU5BmWVJsSu93mmba1XAOTZOS8LQ643geRzvQB0NqJYEhTSQI4RaMpQmSoIEl6S1Mjd9ODQz4M4JU0V1BAPTo9yGGxyXVboD5DJgCdZEie7O/p1FTG8C6gkG1sWzLkfAUhEjuva2rdJt68YsnfM4VlrDhSorpOjbYVmCW5KnicwBXzMHx1wQVOMMpEcIaKgPp1si8aR1znq2QiXjx1ZrO+UEoCmdVYbCCEovx3SnP7sDetyilDWfIKUQylU4sqWaVUpSJS49XlH7V9yUtxr5Zr/1OEbPF4b0VdDlxaklnC47WAKj9UtgnZZNQ7KI68NyieaJ8mxbTxzl6JvwenyGfqIKXE61z1T0IDIPRCa0KtAEXFsRDo9PX8Jkvz8U2dp4/A/FPXh58vzo1dkRG8ONNAVstz/sD+PmbgM10qzddNx9U219T20PufndFvXF32nLsUx4SwOnpYpbUHRzvtxgLkW3wVxnoraBmDSfc5m98XqxYPL7Fj3vRdeZmEiv2IK4FWXdMOeV5wZnHM6iQMf70UTqNm0EW2vgxi51fHQuMsH9aHOJuIlLxPKBtXdHZrame3O7SAbwL686nxSYz9OCslis+NPRZyWWDnbcHMDrxWLxN7mpWlQ=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1"},"next":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"}}');var i=s(74848),a=s(28453),o=s(33617),r=s.n(o),p=s(17543),c=s.n(p),d=s(86013),l=s.n(d),m=s(63723),b=s.n(m),u=(s(18766),s(79329),s(9303));const g={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uGzcQfpUpL22EtST/JGl1ihu4rtMgMWoHBmobAXd3tMuYSzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjg/3/zsXJCsghhdijcBvbjORImh8MqRskaMxHmNcIwEfAqHpyeARuYaA8xsC2ShQuJHD3ZqQBaFbQ1BiSSVDn2RCevQS9Z1UoqRqJDiNZnwGJw1AYMYzcXecMh/mzeftUWBIYxbDSslIhOFNYSGmF86p1URDwbvAgvNRShqbCQ/0cyhGAmbv8OCRCacZzWk0pWJzEatOAN5ZSqRibH1jaR1Ct7Kxmlm+ulY3ezt5/WbF2KRCSMbfKiGFxbhR0QWx0Yq/VD5dxZzxGdLQr+wDatytTUPNuXg8ZOn3+/v7e7ts4p3Nj9XpB+spcQJixe2cdLMHiptHZqgKhNVeJSE5SF9SsmdyN5wb39nd7gzfHq++2R08MPo8ZP+cDj8TWTitonxTHkRpaQYZ0purd5bV36FexbbbC1Df40tvS+Y8WB4cL8CYs0ZSzC2rSm/+f/Aj95b/8++b9+9WLNbGa0Mvu1K+C0b37nx+L4bJ2YitSpj9zi3N2i+rifr11O6/n5qVGKK52LD1XV6cjJg0XpFMzG6nIvbHenUTjofXV4vrjPRINV22e3YYEm1GIlBhdSm3hfQT9CHKN96LUaiJnJhNBgEacrc3va7otAyD1zhA+nUYLLb3xWLbFtGOvcgfmx3HioSSFbKVP8md30XmzPOX0rRRoRWiZJO/YIz0bXQDa5MKMZNjbKMBcLvYxuFl2l57dCcqcrEpMbLt+fWBerCNsgjimqEXq8T+fj7XyupXg9KW7QNGorw61+ZK/O69eDsFD1PHmlKGGu8VbnGNP6aeLaafwFlozEEPQNlCCsvCaFUlSKpgeOkTAWFdDJXWjFqmc2mkbkG/NCHixqpRs9H33oECSVOUDPYQbZkG0msqrMXptbfjLWdhgwk5G1QBkMANLU0BTN2mcjAepAG0BB651VACOTZapVss4a8LAgaaWSFrDuD9WCVqBXDFbzN20AQrG6jycBD3nosoXPIIJYhBvHo1vERMJUHg8eaYTNBqFpVYsigsCVCiEXKLpgScgwEjm1RBQZW2hpti5uYwHGrNTjLPUNJDXa8YSOLk5cm8KRJtnQ5WAXMecv7BCYDe703ATnDL5W5CaNe78rswOUKVxeYB0V4/V1XAtPp9B70H23KHCv6uc3hV3Q2KLJ+diddKarbPJbLupLVS9J0jAYjftaK4U5HaYtwv/qYOqhRu8EZEiMkDA5PT2KbfQQfP/wBL1F6A7WdJrQWrUc9g6q7iiOXMp/CtuqSMLYReDVHvEjg8/i+xUBdBC9qSR8//BngFU5BmWVJsSu93mmba1XAOTZOS8LQ643geRzvQB0NqJYEhTSQI4RaMpQmSoIEl6S1Mjd9ODQz4M4JU0V1BAPTo9yGGxyXVboD5DJgCdZEie7O/p1FTG8C6gkG1sWzLkfAUhEjuva2rdJt68YsnfM4VlrDhSorpOjbYVmCW5KnicwBXzMHx1wQVOMMpEcIaKgPp1si8aR1znq2QiXjx1ZrO+UEoCmdVYbCCEovx3SnP7sDetyilDWfIKUQylU4sqWaVUpSJS49XlH7V9yUtxr5Zr/1OEbPF4b0VdDlxaklnC47WAKj9UtgnZZNQ7KI68NyieaJ8mxbTxzl6JvwenyGfqIKXE61z1T0IDIPRCa0KtAEXFsRDo9PX8Jkvz8U2dp4/A/FPXh58vzo1dkRG8ONNAVstz/sD+PmbgM10qzddNx9U219T20PufndFvXF32nLsUx4SwOnpYpbUHRzvtxgLkW3wVxnoraBmDSfc5m98XqxYPL7Fj3vRdeZmEiv2IK4FWXdMOeV5wZnHM6iQMf70UTqNm0EW2vgxi51fHQuMsH9aHOJuIlLxPKBtXdHZrame3O7SAbwL686nxSYz9OCslis+NPRZyWWDnbcHMDrxWLxN7mpWlQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,S={},v=[];function A(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,i.jsx)(c(),{parameters:void 0}),"\n",(0,i.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"Joe Bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4567832123"},jobTitle:{type:"string",format:"string",example:"dev"},company:{type:"string",format:"string",example:"opensign"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"user"},title:"user"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function D(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(A,{...e})}):A(e)}}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.7661f930.js b/assets/js/58abd73c.7661f930.js new file mode 100644 index 000000000..431bdaa7a --- /dev/null +++ b/assets/js/58abd73c.7661f930.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8564],{73135:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>I,contentTitle:()=>w,default:()=>b,frontMatter:()=>u,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/v1.1/folderlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/folderlist","permalink":"/docs/API-docs/v1.1/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WM1uIzcSfpVaXrIR2pLsmUmwOq0RzHqdGDNG7MDAeowBu7vUzRGbZMhq/UAQkEPeIKdc99HmSRZFqqWWrUnGu9lcbHexqvhV1UdW0WtBsgpici/+YXWJXjxkosRQeOVIWSMm4rZGSGtwpQLB+fUlYOPsAn2AlW2BLHgkr3COIEGzjp3CNJksFNVg02/bEjjp0VDyd1mKTFiHXvJWl6WYiGTFPkQmnPSyQULP+NbCyAbFRDzxoBjljy36lXiM3eYfsKDLcg9IZMLjj63yWIrJVOqAmQi00hg3943IBC6dtiXul4saGykma0Erx3qBvDKVyKKBpL4El7Jx0ZnYbLIdZq0aRY+hfjYO8u0BjEYuVdM2YvJqPM46UKZtcvRi08NwOu5BCDPl/jAEn95zvHlgv8FZEzCw7tl4zL8OCxPaosAQpq2GHQFEJgprCA2xvnROqyIujD4ENlo/BZDqy1Tx7IZU2tJjaDX19KT3kgNWhE34ffuONs+tuatP83p59sFxShLf3sTsP8+NwUXH1k32mO/P9PXtmZHh1Uxd42Nf/y2y0OY9dIVHSVie0zFXe8Oz8dmLk9Pxyfjr29OvJi//Nnn11XA8Hv9LZGLZaLbd0rSUFJGSIt3/bl35J+zTE6QQ33sMYtOXK6OVwfcdxd+fjcfvT1+wziYTL49x/cY2SLUyFSzQECy8NVUGTqMMCORXICupDGhJ6P/yxx0C9N76387W85D9VhZechZ2SXj1NAmXZi61KmP3uLUzNH9upP3tKW3PUA85oZJSXBcHwfblKciAResVrWJnWp5Ip07S+uT+ga9ATqzljlZhamVUi4kYHfS3gH7eNbfWazERNZELk9EoSFPmdjm0Dk1QldEyD8PCNiPp1Gh+OjwVfLMf2kjnnqWP7clzTQLJSpnq9+we9um54RKmKh0kaX8zO/Ud8tW8rUFfa9utapTxstnw99RG421l3jo0N6oysa5x88cTwB3qwjbIQwrVCINBZ/Lx53/vrAYDKG3RNmgoMnD4zrwzb1sPccrhJiVNCVONS5VrPDoBBZSNxhD0CpQhrLwkhFJViqQGzhOfskI6mSutmLisZtnaQ4/7YQh3NVKNnpe+8DxRlThHzXwH2ZJtJLGrDi8srJ9NtV2EDCTkbVAGQwA0tTQFK3aVyHgKkwbQEHrnVUAI5Bm1StisIS8LgkYaWSH7zqCfrBK1YrqCt3kbCILVbYQMJJW2HkvoAjKIZYhJfM0ThEdgaWEb57Fm2swRqlaVGDIobIkQ4jnlEEwJOQYCx1hUgYGdtkbbYhYLOG21Bmf52lBS81zXx8jm5KUJ3MQSlq4Gu4Q5b3n0wARwMPghIFf4SplZmAwG78wJ3O94dYd5UIQPf+2OwGKxeEL9Lw9tLhT9s83he3Q2KLJ+tbeuFNVtHo9L38nuI3m6QIORP73DsPdR2iI8PX0sHdWo3egGiRkSRufXl/Gm/RI+/vQLXKH0Bmq7SGwtWo96BVW3FWcuVT6lbXdRwtRG4tWc8SKRj+dGDNRl8K6W9PGnXwO8wQUosz1SHMpgcN3mWhVwi43jNhIGgwl8E2cGoE4GVEuCQhrIEUItmUpzJUGCS9ZamdkQzs0K2tC9KZgMLI92B2FwXnblDpDLgCVYEy26PYd7RCxvAuo5BvZlLDEMLBUxo2tv2yrt1gezDc7jVGkNd6qskGJs52UJbiteJDEnvAcHp3wgqMYVSI8Q0NAQrh+ZxJXWOesZhUrgp1Zru+ACoCmdVYbCBEovp7T3n+2JHkczZc0RUUqh3KUj27rZlSSdxG3EO+nwHV/Kjy7yw/vW4xQ9bxjD3tfFqS2d7jtaArP1f6F1HD+tIVnECQIbqXTqKH9/7Cd2c/RNeDu9QT9XBW672idO9Cgqj0QmtCrQBOxNCecX11cwfzEci6zXHj/jcI+uLr95/ebmNYPhizQl7HQ4Ho7jbG4DNdL0drpA6p7R24nhINfr/fz0/36kb5s14ZJGTksVx6MY/Ho72tz3n+4PmahtIJau13z+fvB6s2FxennywFOqIHPde3t+Mrajj/ijiGa4OvYPgrnUbXqSZ0f2TUbdC/1zdLdP6b3qA394xbpx/su6mYUDTTbnRYGuv8GTgfdgarx4fSsywdfu4aw0i7PS9g/23i2ZVc/34RCVAPBPjumowXqd5rDNZqeflj5psQ2w0+b8P2w2m/8AiJlg8A==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"},"next":{"title":"v1","permalink":"/docs/API-docs/v1"}}');var s=r(74848),o=r(28453),l=r(33617),n=r.n(l),d=r(17543),a=r.n(d),p=r(86013),m=r.n(p),c=r(63723),f=r.n(c),h=(r(18766),r(79329),r(9303));const u={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WM1uIzcSfpVaXrIR2pLsmUmwOq0RzHqdGDNG7MDAeowBu7vUzRGbZMhq/UAQkEPeIKdc99HmSRZFqqWWrUnGu9lcbHexqvhV1UdW0WtBsgpici/+YXWJXjxkosRQeOVIWSMm4rZGSGtwpQLB+fUlYOPsAn2AlW2BLHgkr3COIEGzjp3CNJksFNVg02/bEjjp0VDyd1mKTFiHXvJWl6WYiGTFPkQmnPSyQULP+NbCyAbFRDzxoBjljy36lXiM3eYfsKDLcg9IZMLjj63yWIrJVOqAmQi00hg3943IBC6dtiXul4saGykma0Erx3qBvDKVyKKBpL4El7Jx0ZnYbLIdZq0aRY+hfjYO8u0BjEYuVdM2YvJqPM46UKZtcvRi08NwOu5BCDPl/jAEn95zvHlgv8FZEzCw7tl4zL8OCxPaosAQpq2GHQFEJgprCA2xvnROqyIujD4ENlo/BZDqy1Tx7IZU2tJjaDX19KT3kgNWhE34ffuONs+tuatP83p59sFxShLf3sTsP8+NwUXH1k32mO/P9PXtmZHh1Uxd42Nf/y2y0OY9dIVHSVie0zFXe8Oz8dmLk9Pxyfjr29OvJi//Nnn11XA8Hv9LZGLZaLbd0rSUFJGSIt3/bl35J+zTE6QQ33sMYtOXK6OVwfcdxd+fjcfvT1+wziYTL49x/cY2SLUyFSzQECy8NVUGTqMMCORXICupDGhJ6P/yxx0C9N76387W85D9VhZechZ2SXj1NAmXZi61KmP3uLUzNH9upP3tKW3PUA85oZJSXBcHwfblKciAResVrWJnWp5Ip07S+uT+ga9ATqzljlZhamVUi4kYHfS3gH7eNbfWazERNZELk9EoSFPmdjm0Dk1QldEyD8PCNiPp1Gh+OjwVfLMf2kjnnqWP7clzTQLJSpnq9+we9um54RKmKh0kaX8zO/Ud8tW8rUFfa9utapTxstnw99RG421l3jo0N6oysa5x88cTwB3qwjbIQwrVCINBZ/Lx53/vrAYDKG3RNmgoMnD4zrwzb1sPccrhJiVNCVONS5VrPDoBBZSNxhD0CpQhrLwkhFJViqQGzhOfskI6mSutmLisZtnaQ4/7YQh3NVKNnpe+8DxRlThHzXwH2ZJtJLGrDi8srJ9NtV2EDCTkbVAGQwA0tTQFK3aVyHgKkwbQEHrnVUAI5Bm1StisIS8LgkYaWSH7zqCfrBK1YrqCt3kbCILVbYQMJJW2HkvoAjKIZYhJfM0ThEdgaWEb57Fm2swRqlaVGDIobIkQ4jnlEEwJOQYCx1hUgYGdtkbbYhYLOG21Bmf52lBS81zXx8jm5KUJ3MQSlq4Gu4Q5b3n0wARwMPghIFf4SplZmAwG78wJ3O94dYd5UIQPf+2OwGKxeEL9Lw9tLhT9s83he3Q2KLJ+tbeuFNVtHo9L38nuI3m6QIORP73DsPdR2iI8PX0sHdWo3egGiRkSRufXl/Gm/RI+/vQLXKH0Bmq7SGwtWo96BVW3FWcuVT6lbXdRwtRG4tWc8SKRj+dGDNRl8K6W9PGnXwO8wQUosz1SHMpgcN3mWhVwi43jNhIGgwl8E2cGoE4GVEuCQhrIEUItmUpzJUGCS9ZamdkQzs0K2tC9KZgMLI92B2FwXnblDpDLgCVYEy26PYd7RCxvAuo5BvZlLDEMLBUxo2tv2yrt1gezDc7jVGkNd6qskGJs52UJbiteJDEnvAcHp3wgqMYVSI8Q0NAQrh+ZxJXWOesZhUrgp1Zru+ACoCmdVYbCBEovp7T3n+2JHkczZc0RUUqh3KUj27rZlSSdxG3EO+nwHV/Kjy7yw/vW4xQ9bxjD3tfFqS2d7jtaArP1f6F1HD+tIVnECQIbqXTqKH9/7Cd2c/RNeDu9QT9XBW672idO9Cgqj0QmtCrQBOxNCecX11cwfzEci6zXHj/jcI+uLr95/ebmNYPhizQl7HQ4Ho7jbG4DNdL0drpA6p7R24nhINfr/fz0/36kb5s14ZJGTksVx6MY/Ho72tz3n+4PmahtIJau13z+fvB6s2FxennywFOqIHPde3t+Mrajj/ijiGa4OvYPgrnUbXqSZ0f2TUbdC/1zdLdP6b3qA394xbpx/su6mYUDTTbnRYGuv8GTgfdgarx4fSsywdfu4aw0i7PS9g/23i2ZVc/34RCVAPBPjumowXqd5rDNZqeflj5psQ2w0+b8P2w2m/8AiJlg8A==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},w=void 0,I={},j=[];function x(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,s.jsx)(n(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.cb327dba.js b/assets/js/58abd73c.cb327dba.js deleted file mode 100644 index eff4fba90..000000000 --- a/assets/js/58abd73c.cb327dba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8564],{73135:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>P,contentTitle:()=>g,default:()=>I,frontMatter:()=>y,metadata:()=>r,toc:()=>b});const r=JSON.parse('{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/v1.1/folderlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/folderlist","permalink":"/docs/API-docs/v1.1/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WF9vI7cR/ypTvrQR1pLsu0sQPdUIrq5b586oHRiIzzhwd0e7PHFJhpzVHwgC8tBvkKe85qPdJymG1EorW5ec2zQvlpecGf5m5jec2V0LklUQk3vxN6tL9OIhEyWGwitHyhoxEbc1QtqDKxUIzq8vARtnF+gDrGwLZMEjeYVzBAmaZewUpklloagGm35tS+CkR0PJ3mUpMmEdeslHXZZiIpIW2xCZcNLLBgk941sLIxsUE/HEgmKUP7ToV+Ixdpt/wIIuyz0gkQmPP7TKYykmU6kDZiLQSmM83DciE7h02pa43y5qbKSYrAWtHMsF8spUIosKkvoruJSNi8bEZpPtMGvVKHoM9bNxkG8PYDRyqZq2EZNX43HWgTJtk6MXmx6G03EPQpgp97sh+PSZ480D2w3OmoCBZc/GY/45TExoiwJDmLYadgQQmSisITTE8tI5rYq4MfoQWGn9FEDKL1PFsxlS6UiPodXUk5PeS3ZYETbht/U72jw3564+zevl2QfHIUl8exOj/zwzBhcdWzfZY74/09Y/zowMr2bqGh/b+m+RhTbvoSs8SsLynI6Z2iuejc9enJyOT8Zf3Z5+OXn59eTVl8PxePy9yMSy0ay7pWkpKSIlRbr/3LryDzint5BcfO8xiE1/XRmtDL7vKP7+bDx+f/qCZTaZeHmM6ze2QaqVqWCBhmDhrakycBplQCC/AllJZUBLQv+n368I0Hvrfz1az0P2a1F4yVHYBeHV0yBcmrnUqozd49bO0PyxnvaPp3Q8Qz3khEpCcV8cONtfT04GLFqvaBU70/JEOnWS9if3D3wFcmAtd7QKUyujWkzE6KC/BfTzrrk9osxCVhX6v7d5RHzekoVvbTFLbrVei4moiVyYjEZz5SlZGoakVrf5sLDN6NrLaav1GzmfST+yDs3odDgejgW3hUMjQZoyt8shCwVVGS3zEG1Ip0bz0+HpER3p3LPksT15rkogWSlT/Zbewz4fN8yZRIuDrOxbgVP/RO4F26T3pbbtsUYZb7cNP09tVN5S4a1Dc6MqE9MSD388ctyhLmyDPBVRjTAYdCof//3LTmswgNIWbYOGIuWH78w787b1EMcq7orSlDDVuFS5xqMjV0DZaAxBr0AZwspLQihVpUhq4DhxWRfSyVxpxZXCYpa1PfSKLQzhrkaq0fPWnz2PcCXOUXOBgWzJNpLYVIcXFtbPptouQgYS8jYogyEAmlqaggW7TGQ89kkDaAi98yogBPKMWiVs1pCXBUEjjayQbWfQD1aJWnF9gLd5GwiC1W2EDCSVth5L6BwyiGWIQXzNI4tH4NXCNs5jzbSZI1StKjFkUNgSIcSLgV0wJeQYCBxjUQUGNtoabYtZTCBXEDjL95SSmgfJPkZWJy9N4K6ZsHQ52AXMecuzDiaAg8F3ATnDV8rMwmQweGdO4H7HqzvMgyJ8+EtXAovF4gn1vzjUuVDEN8W/0NmgyPrVXrtS1N0GfSO7h2TpAg1G/vSKYW+jtEV4Wn28OqpRu9ENEjMkjM6vL+PV/gV8/PEnuELpDdR2kdhatB71CqruKI5cynwK2+5mhqmNxKs54kUiHw+qGKiL4F0t6eOPPwd4gwtQZltS7MpgcN3mWhVwi43jvhUGgwl8E4cUoG4NqJYEhTSQI4RaMpXmSoIEl7S1MrMhnJsVtKF7iWEy8HrUO3CD47JLd4BcBizBmqjRnTncI+L1JqCeY2BbxhLDwFIRM7r2tq3SaX0wW+c8TpXWcKfKCin6dl6W4LbLi7TMAe/BwSkXBNW4AukRAhoawvUjlbjTOmc9o1AJ/NRqbRecADSls8pQmEDp5ZT29rM90eMsqKw5spRCKHfhyLZmdilJlbj1eLc6fMeX8qOL/PC+9ThFzwdGt/d5cWpLp/uOlsBs/V9oHedda0gWcWTBRiqdOspfH9uJ4wP6Jryd3qCfqwK3Xe0TFT2KwiORCa0KNAF7Y8n5xfUVzF8Mxwet/zOKe3R1+c3rNzevGQxfpClg3QggnA3USNM76QKpe2/fjigHsV7vB7b/91eBbbMmXNLIaaniPBadX29nqfv+t4KHTNQ2EK+u11x/33m92fByetWNE5YKMte9l91P+nb0q8FRRDNcHfsiMZe6Td8AsiPnJqXuk8DnyG7f3feiD/zgFcvGgTPrZhZ2NOmcFwW6/gFPJuyDMfXi9a3IBF+7h7PSLM5K23/YerdlVj3bh0NUAsB/2aejCut1msM2m5182vqkxtbBTprj/7DZbP4DtcuImw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"},"next":{"title":"v1","permalink":"/docs/API-docs/v1"}}');var o=i(74848),s=i(28453),a=i(33617),n=i.n(a),l=i(17543),p=i.n(l),d=i(86013),c=i.n(d),m=i(63723),f=i.n(m),h=(i(18766),i(79329),i(9303));const y={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WF9vI7cR/ypTvrQR1pLsu0sQPdUIrq5b586oHRiIzzhwd0e7PHFJhpzVHwgC8tBvkKe85qPdJymG1EorW5ec2zQvlpecGf5m5jec2V0LklUQk3vxN6tL9OIhEyWGwitHyhoxEbc1QtqDKxUIzq8vARtnF+gDrGwLZMEjeYVzBAmaZewUpklloagGm35tS+CkR0PJ3mUpMmEdeslHXZZiIpIW2xCZcNLLBgk941sLIxsUE/HEgmKUP7ToV+Ixdpt/wIIuyz0gkQmPP7TKYykmU6kDZiLQSmM83DciE7h02pa43y5qbKSYrAWtHMsF8spUIosKkvoruJSNi8bEZpPtMGvVKHoM9bNxkG8PYDRyqZq2EZNX43HWgTJtk6MXmx6G03EPQpgp97sh+PSZ480D2w3OmoCBZc/GY/45TExoiwJDmLYadgQQmSisITTE8tI5rYq4MfoQWGn9FEDKL1PFsxlS6UiPodXUk5PeS3ZYETbht/U72jw3564+zevl2QfHIUl8exOj/zwzBhcdWzfZY74/09Y/zowMr2bqGh/b+m+RhTbvoSs8SsLynI6Z2iuejc9enJyOT8Zf3Z5+OXn59eTVl8PxePy9yMSy0ay7pWkpKSIlRbr/3LryDzint5BcfO8xiE1/XRmtDL7vKP7+bDx+f/qCZTaZeHmM6ze2QaqVqWCBhmDhrakycBplQCC/AllJZUBLQv+n368I0Hvrfz1az0P2a1F4yVHYBeHV0yBcmrnUqozd49bO0PyxnvaPp3Q8Qz3khEpCcV8cONtfT04GLFqvaBU70/JEOnWS9if3D3wFcmAtd7QKUyujWkzE6KC/BfTzrrk9osxCVhX6v7d5RHzekoVvbTFLbrVei4moiVyYjEZz5SlZGoakVrf5sLDN6NrLaav1GzmfST+yDs3odDgejgW3hUMjQZoyt8shCwVVGS3zEG1Ip0bz0+HpER3p3LPksT15rkogWSlT/Zbewz4fN8yZRIuDrOxbgVP/RO4F26T3pbbtsUYZb7cNP09tVN5S4a1Dc6MqE9MSD388ctyhLmyDPBVRjTAYdCof//3LTmswgNIWbYOGIuWH78w787b1EMcq7orSlDDVuFS5xqMjV0DZaAxBr0AZwspLQihVpUhq4DhxWRfSyVxpxZXCYpa1PfSKLQzhrkaq0fPWnz2PcCXOUXOBgWzJNpLYVIcXFtbPptouQgYS8jYogyEAmlqaggW7TGQ89kkDaAi98yogBPKMWiVs1pCXBUEjjayQbWfQD1aJWnF9gLd5GwiC1W2EDCSVth5L6BwyiGWIQXzNI4tH4NXCNs5jzbSZI1StKjFkUNgSIcSLgV0wJeQYCBxjUQUGNtoabYtZTCBXEDjL95SSmgfJPkZWJy9N4K6ZsHQ52AXMecuzDiaAg8F3ATnDV8rMwmQweGdO4H7HqzvMgyJ8+EtXAovF4gn1vzjUuVDEN8W/0NmgyPrVXrtS1N0GfSO7h2TpAg1G/vSKYW+jtEV4Wn28OqpRu9ENEjMkjM6vL+PV/gV8/PEnuELpDdR2kdhatB71CqruKI5cynwK2+5mhqmNxKs54kUiHw+qGKiL4F0t6eOPPwd4gwtQZltS7MpgcN3mWhVwi43jvhUGgwl8E4cUoG4NqJYEhTSQI4RaMpXmSoIEl7S1MrMhnJsVtKF7iWEy8HrUO3CD47JLd4BcBizBmqjRnTncI+L1JqCeY2BbxhLDwFIRM7r2tq3SaX0wW+c8TpXWcKfKCin6dl6W4LbLi7TMAe/BwSkXBNW4AukRAhoawvUjlbjTOmc9o1AJ/NRqbRecADSls8pQmEDp5ZT29rM90eMsqKw5spRCKHfhyLZmdilJlbj1eLc6fMeX8qOL/PC+9ThFzwdGt/d5cWpLp/uOlsBs/V9oHedda0gWcWTBRiqdOspfH9uJ4wP6Jryd3qCfqwK3Xe0TFT2KwiORCa0KNAF7Y8n5xfUVzF8Mxwet/zOKe3R1+c3rNzevGQxfpClg3QggnA3USNM76QKpe2/fjigHsV7vB7b/91eBbbMmXNLIaaniPBadX29nqfv+t4KHTNQ2EK+u11x/33m92fByetWNE5YKMte9l91P+nb0q8FRRDNcHfsiMZe6Td8AsiPnJqXuk8DnyG7f3feiD/zgFcvGgTPrZhZ2NOmcFwW6/gFPJuyDMfXi9a3IBF+7h7PSLM5K23/YerdlVj3bh0NUAsB/2aejCut1msM2m5182vqkxtbBTprj/7DZbP4DtcuImw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,P={},b=[];function w(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,o.jsx)(n(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(p(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,o.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(w,{...e})}):w(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a144266.1c2422fe.js b/assets/js/5a144266.1c2422fe.js deleted file mode 100644 index d97803172..000000000 --- a/assets/js/5a144266.1c2422fe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4232],{38483:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>J,frontMatter:()=>x,metadata:()=>o,toc:()=>b});const o=JSON.parse('{"id":"API-docs/v1.1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/v1.1/gettemplatelist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/gettemplatelist","permalink":"/docs/API-docs/v1.1/gettemplatelist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar_label":"Get Template list","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWEtv5DYS/isVXjZpyN1tj8eT9ClGMHCMdWaMtQMD6zEalFQtcZoiGZLqBwwBOew/yCnX/WnzSxZFPVry20mQw17sFlkf68Eq8iveMs8zx2bX7BILI7lHx24ilqJLrDBeaMVm7DJHOEEPrQicCefh+PwUuJR67WCrS/AaLHorcIXAQZKEXgBfcSF5LBF8u/4YLnPhYFGqhNbnUvgtGKtXIkUHXIFeoV0JXAe8lDtkBKh4LIXKoHRoHelMcq0dwsLqAnAjnKfZDgHrHBUkFnkYT3VSFqi8G7OIaYOWkwWnKZuxDH2LIttZxAy3vECPlsJzyxQvkM2YFIWgWUGB+aVEu2URs/hLKSymbLbg0mHEnN9Kkl5oW7CI4cZInSKbeVvSbJJjwdnslhV8I4qyYLO302nE/NYQSJVFjJZVhOOFoYX2p1XUmeCWwvxlFjyuc1rd0LrOaOXQkezBdEr/hsnhyiRB5xalhC6iLGKJVh6VJ3lujBRJmJh8dgS6vW+Ajj9jEsJuaRkvapUWXSl9T45by8lh4bFwz+PrYdrhTtJ5K1TGohAa7vsjne9ss/9jrAp3cJ5RTLzwNHp/iR3AhR9d5hFKaf8MqJWGIFqRSTJF+3e5VefTUwbW9kAQrHaB6AyfNwaT6eK5EOXeGzebTFow1fA40QWh9VoN/H4qWKGcdWtVxJzIVKjSP5okVj9neoL6ZQH7rBFiDGZhwYV8VjpG/L4ZaGNhcq2eUXP49uhg/8237/ZJfi3SDP2f8L+efV0medz4WG+CvTzD+0dJD96N7M6zKmKbV2IODg+riG1fiXpHqtavBL35topY/krQ4RHlcTgWXxDzx1LpRTGvHqzFi7oO5m0+PCkVytmhSk/VRzs8c2KtJXLVV023RhWxUHmYHvuns/NgevBmb3+6N313uX80O/xu9vZoPJ1O/80itinkznuWNidla2T7XZr0b9ET6ARe6vJl7ltMhcXEz0v7YGE/tXekLrCleaFTsWjuQ/e03nCXE7D0em6xEOrZnWohtfRcqwTnQs1xRTzhgYTuXffV3bD1L7O7eTTMLqGkUDhv2cL8YDqdHzV5ejh9e581nKoVlyINJPJSL1F99ddxBrRWP3OX9NX7Wv1990UtFObZwNn+eO2kw6S0wm8DVdzscSP26vnZ9Q3xqAJ9rhueGbilz9mMTe5QTod21fLNYbwu1jzL0P5YxsHm49Jr+Ekny9qxkI/d/boS1tcrjV0Ny8uYLpfJueWLUsoPfLXkdqINqsn+eDqeMmKXw0UcV2msN2MSogtW8tiFNbgRk9X+eP8BDDfmVfJY7r0W4jzPhMqew93sduSCsqZOjMG+7C5LI/6JdFs2296Xalh2jjywnIq+FzqAm2T4aFDRkRq2JSi/2z1doUx0gdSs+BxhNGohX/7z3w41GnXNSUj68Sf1SX0sLRi9RkvkmqsUFhI3gpopgmER5rruyyEvJDontyCUx8wSV0pFJjyXQHGiDijhhsdCCqoVEtOEttArNzeGqxx9jpam/mGpm0txhZJKDOgkKobNFKy1XS6oD4yAQ1w6odA5QJVzlZBguxMRaEv9HSqP1ljhEJy3ZLWobdPKW554KLjiGdLaEfSDlaIUVB9gdVw6D07LMpgMngupLabQOqQQUxeC+J46H4tAo4kujMWc0maFkJXUcUaQ6BSh5u/kgkohRufBkC0iwdBmlkrqZBk2kCoIjKaTSnBJTWrfRoJ7y5Wjy6C2pd2DLmDGamqZsDZwNPrZIe3wmVBLNxuNPqk9uO7y6gpjJzzefN2WwHq9vpf63wwxJ8LTSfEvNNoJr+12h86Eb0+D/iLdR73SCSoM+dMrht0aqU7c/eqj0UmO0kwu0FOGuMnx+Wk43L+BL7/+BmfIrYJcr+tsTUqLcgtZq4oiV+98HbbubIaFDomXU8STOvmo30Xn2whe5dx/+fV3Bx9wDUI1JUWujEbnZSxF0j1euNFoBj8EItN7J/A595BwBTGCyzml0kpw4GBqtBRqOYZjtQ0vD7AWPg/JQOMBN3CD4rJ7bICYO0xBq4BodY53FtF44VCu0NFaSnsyA1PhKaNzq8us1tY3pnHO4kJICVc15yPfjtMUTDPcUEEKeM8cXFBB+By3wC2CQ+XHcH4HEmZKY7QlK0Rt/EIThaENQJUaLZR3M0gtX/jd+tEu0euHF60eGKpDyLtwRM0yvcceimTj8e7x6BMdyncO8uF5a3GBlhQGt3f7YkSTTtdtWgJl659Ja2IFdGrxJJCWpuOjG+X7u+sEAoG2cB8XF/S8lbQd8SMVPQnCExYxKRJUDnvE5Pjk/AxWb8bTwdX/guKenJ3+8P7DxXsyhg7SOmAtBWBGO19w1dM0ePVrSMog2rc70vZ/+kzYsATqvSZGchGoYNMA1DTumg1o3E3Ecu08jd/eUun/bGVV0XD9WBfInXDk7e65bonb3uPiisuyaRoelW1eAXeiN/RhBckG1hm1tIUU1pjjJEHTV3CPZg+46sn7Sxaaj3xIl5aBLjU/aPV2Sm17aw95VG0A/SWfHgTc3tZUrKo6+XrqUUTjYCtNe3NTVdX/AIe387U=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"}}');var n=a(74848),s=a(28453),i=a(33617),l=a.n(i),r=a(17543),m=a.n(r),p=a(86013),d=a.n(p),c=a(63723),u=a.n(c),h=(a(18766),a(79329),a(9303));const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWEtv5DYS/isVXjZpyN1tj8eT9ClGMHCMdWaMtQMD6zEalFQtcZoiGZLqBwwBOew/yCnX/WnzSxZFPVry20mQw17sFlkf68Eq8iveMs8zx2bX7BILI7lHx24ilqJLrDBeaMVm7DJHOEEPrQicCefh+PwUuJR67WCrS/AaLHorcIXAQZKEXgBfcSF5LBF8u/4YLnPhYFGqhNbnUvgtGKtXIkUHXIFeoV0JXAe8lDtkBKh4LIXKoHRoHelMcq0dwsLqAnAjnKfZDgHrHBUkFnkYT3VSFqi8G7OIaYOWkwWnKZuxDH2LIttZxAy3vECPlsJzyxQvkM2YFIWgWUGB+aVEu2URs/hLKSymbLbg0mHEnN9Kkl5oW7CI4cZInSKbeVvSbJJjwdnslhV8I4qyYLO302nE/NYQSJVFjJZVhOOFoYX2p1XUmeCWwvxlFjyuc1rd0LrOaOXQkezBdEr/hsnhyiRB5xalhC6iLGKJVh6VJ3lujBRJmJh8dgS6vW+Ajj9jEsJuaRkvapUWXSl9T45by8lh4bFwz+PrYdrhTtJ5K1TGohAa7vsjne9ss/9jrAp3cJ5RTLzwNHp/iR3AhR9d5hFKaf8MqJWGIFqRSTJF+3e5VefTUwbW9kAQrHaB6AyfNwaT6eK5EOXeGzebTFow1fA40QWh9VoN/H4qWKGcdWtVxJzIVKjSP5okVj9neoL6ZQH7rBFiDGZhwYV8VjpG/L4ZaGNhcq2eUXP49uhg/8237/ZJfi3SDP2f8L+efV0medz4WG+CvTzD+0dJD96N7M6zKmKbV2IODg+riG1fiXpHqtavBL35topY/krQ4RHlcTgWXxDzx1LpRTGvHqzFi7oO5m0+PCkVytmhSk/VRzs8c2KtJXLVV023RhWxUHmYHvuns/NgevBmb3+6N313uX80O/xu9vZoPJ1O/80itinkznuWNidla2T7XZr0b9ET6ARe6vJl7ltMhcXEz0v7YGE/tXekLrCleaFTsWjuQ/e03nCXE7D0em6xEOrZnWohtfRcqwTnQs1xRTzhgYTuXffV3bD1L7O7eTTMLqGkUDhv2cL8YDqdHzV5ejh9e581nKoVlyINJPJSL1F99ddxBrRWP3OX9NX7Wv1990UtFObZwNn+eO2kw6S0wm8DVdzscSP26vnZ9Q3xqAJ9rhueGbilz9mMTe5QTod21fLNYbwu1jzL0P5YxsHm49Jr+Ekny9qxkI/d/boS1tcrjV0Ny8uYLpfJueWLUsoPfLXkdqINqsn+eDqeMmKXw0UcV2msN2MSogtW8tiFNbgRk9X+eP8BDDfmVfJY7r0W4jzPhMqew93sduSCsqZOjMG+7C5LI/6JdFs2296Xalh2jjywnIq+FzqAm2T4aFDRkRq2JSi/2z1doUx0gdSs+BxhNGohX/7z3w41GnXNSUj68Sf1SX0sLRi9RkvkmqsUFhI3gpopgmER5rruyyEvJDontyCUx8wSV0pFJjyXQHGiDijhhsdCCqoVEtOEttArNzeGqxx9jpam/mGpm0txhZJKDOgkKobNFKy1XS6oD4yAQ1w6odA5QJVzlZBguxMRaEv9HSqP1ljhEJy3ZLWobdPKW554KLjiGdLaEfSDlaIUVB9gdVw6D07LMpgMngupLabQOqQQUxeC+J46H4tAo4kujMWc0maFkJXUcUaQ6BSh5u/kgkohRufBkC0iwdBmlkrqZBk2kCoIjKaTSnBJTWrfRoJ7y5Wjy6C2pd2DLmDGamqZsDZwNPrZIe3wmVBLNxuNPqk9uO7y6gpjJzzefN2WwHq9vpf63wwxJ8LTSfEvNNoJr+12h86Eb0+D/iLdR73SCSoM+dMrht0aqU7c/eqj0UmO0kwu0FOGuMnx+Wk43L+BL7/+BmfIrYJcr+tsTUqLcgtZq4oiV+98HbbubIaFDomXU8STOvmo30Xn2whe5dx/+fV3Bx9wDUI1JUWujEbnZSxF0j1euNFoBj8EItN7J/A595BwBTGCyzml0kpw4GBqtBRqOYZjtQ0vD7AWPg/JQOMBN3CD4rJ7bICYO0xBq4BodY53FtF44VCu0NFaSnsyA1PhKaNzq8us1tY3pnHO4kJICVc15yPfjtMUTDPcUEEKeM8cXFBB+By3wC2CQ+XHcH4HEmZKY7QlK0Rt/EIThaENQJUaLZR3M0gtX/jd+tEu0euHF60eGKpDyLtwRM0yvcceimTj8e7x6BMdyncO8uF5a3GBlhQGt3f7YkSTTtdtWgJl659Ja2IFdGrxJJCWpuOjG+X7u+sEAoG2cB8XF/S8lbQd8SMVPQnCExYxKRJUDnvE5Pjk/AxWb8bTwdX/guKenJ3+8P7DxXsyhg7SOmAtBWBGO19w1dM0ePVrSMog2rc70vZ/+kzYsATqvSZGchGoYNMA1DTumg1o3E3Ecu08jd/eUun/bGVV0XD9WBfInXDk7e65bonb3uPiisuyaRoelW1eAXeiN/RhBckG1hm1tIUU1pjjJEHTV3CPZg+46sn7Sxaaj3xIl5aBLjU/aPV2Sm17aw95VG0A/SWfHgTc3tZUrKo6+XrqUUTjYCtNe3NTVdX/AIe387U=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},b=[];function j(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,n.jsx)(l(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(m(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,n.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}},title:"inline_response_200_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function J(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a144266.804e9e11.js b/assets/js/5a144266.804e9e11.js new file mode 100644 index 000000000..a84341170 --- /dev/null +++ b/assets/js/5a144266.804e9e11.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4232],{38483:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>w,contentTitle:()=>f,default:()=>y,frontMatter:()=>h,metadata:()=>i,toc:()=>x});const i=JSON.parse('{"id":"API-docs/v1.1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/v1.1/gettemplatelist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/gettemplatelist","permalink":"/docs/API-docs/v1.1/gettemplatelist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar_label":"Get Template list","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWEtvIzcS/iu1vGQjtKW2x+PJ6hQjGDjGGhlj7cBAPIbA7i6pOWaTDMnWA0IDOew/2NNe96fNL1kU+ym/ZG+CHPZiq8n6WA9WkV9xyzxfODa9ZddYGMk9OnYXsQxdaoXxQis2Zdc5whl6aEXgQjgPp5fnwKXUKwcbXYLXYNFbgUsEDpIk9Bz4kgvJE4ng2/XHcJ0LB/NSpbQ+l8JvwFi9FBk64Ar0Eu1S4CrgpeyREaDiiRRqAaVD60hnmmvtEOZWF4Br4TzNdghY5aggtcjDeKbTskDl3ZhFTBu0nCw4z9iULdC3KLKdRcxwywv0aCk8W6Z4gWzKpCgEzQoKzK8l2g2LmMVfS2ExY9M5lw4j5vxGkvRc24JFDNdG6gzZ1NuSZtMcC86mW1bwtSjKgk3fx3HE/MYQSJVFgpZVhOOFoYUO4yrqTHD3wvxhFjyvM67uaF1ntHLoSPYojunfbnK4Mk3RuXkpoYsoi1iqlUflSZ4bI0UaJiZfHIG2jw3QyRdMQ9gtLeNFrdKiK6UfyHFrOTksPBZuP74eph3uJJ23Qi1YFELD/XCk852tD39MVOGOLhcUEy88jT5eoge48KPLPEIp7feAWmkIohWZJDO0f5ZbdT69ZGBtDwTBqg9EZ/isMZhMF/tClHtv3HQyacFUw+NUF4TWK7Xj90vBCuWsW6si5sRChSr9X5PE6n2mp6hfF7AvGiHBYBYWXMi90gni981AGwuTa7VHzfH7k6PDd999OCT5lcgW6H+H//Xs2zLJ49oneh3s5Qt8fJQM4N1If55VEVu/EXN0fFxFbPNG1AdStXoj6N13VcTyN4KOTyiPw7H4ipg/l0qvinn1ZC1e1XUwa/PhRalQzg5Vdq4+2d0zJ9FaIldD1XRrVBELlYfZqX85O4/io3cHh/FB/OH68GR6/Lfp+5NxHMe/sIitC9l7z7LmpGyNbL9Lk/0pegKdwGtdvs59i5mwmPpZaZ8s7Jf2jtQFtjQrdCbmzX3oXtYb7nICll7PLBZC7d2pFlJLz7RKcSbUDJfEE55I6MF1Xz0M2/Aye5hHu9kllBQKZy1bmB3F8eykydPj+P1j1nCullyKLJDIa32P6i9/HGdAa/Weu2So3tfqH7svaqEwz3acHY7XTjpMSyv8JlDF9QE34qCen97eEY8q0Oe64ZmBW/qcTdnkAeV0aJct3ww51t2Zjqss0euxNqjovpM8cXRfTLgRk+XhmC6ChxhuzJvksTx4K8R5vhBqsQ931wfoijax3qedMPV3lxF/R7q8ml0YSjWkN0ceSEdF33MdwM3efDKo6IQLOxuUP2xmblCmukDqHXyOMBq1kK///E+HGo26XiHk4Piz+qw+lRaMXqElrstVBnOJa0G9DcGwCHNdM+SQFxKdkxsQyuPCEnXJxEJ4LoHiRA1Jyg1PhBSUuiSmCW1hkP1uDDc5+hwtTX1jqbnKcImSMh7oYCh2extYaXs/p7YsAg5J6YRC5wBVzlVKgu1ORKAttVuoPFpjhUNw3pLVorZNK2956qHgii+Q1o5gGKwMpaB0BauT0nlwWpbBZPBcSG0xg9YhhZi5EMSP1IhYBBpNdWEs5pQ2S4RFSQ1gBKnOEGo6TS6oDBJ0HgzZIlIMXV+ppE7vwwbOSynBaDo4BJfUMw5tJLi3XDk6m2tb2j3oAmaspg4GawNHo58d0g5fCHXvpqPRZ3UAt11e3WDihMe7v7YlsFqtHqX+t7uYM+F/LBP4BxrthNd206MXwudlEspluEj3Ua90hgpD/gyKoV8j06l7XH00OslRmskVesoQNzm9PA9n7bfw9bd/wQVyqyDXqzpb09Ki3MCiVUWRq3e+Dlt3VMJch8TLKeJpnXzUfqLzbQRvcu6//vZvBz/hCoRqSopcGY0uy0SKtHtLcKPRFH4IvGLQtvuce0i5ggTB5ZxSaSk4cDA1Wgp1P4ZTtQkPAbASPg/JQOMBt+MGxaXv/SHhDjPQKiBanePeIhovHMolOlpLaU9mYCY8ZXRudbmotQ2NaZyzOBdSwk1Nwci30ywD0ww3zIwCPjAH51QQPscNcIvgUPkxXD6AhJnSGG3JClEbP9fEKGgDUGVGC+XdFDLL575fP+oTvX4H0eqJoTqEvAtH1CwzeHuhSDYe9285n+lQfnCQ7563FudoSWFwu98XI5p0um3TEihbf09a0yVNpxZPA4doGjC6Ub5/uE64z9EW7tP8il6b0rZBfaaiJ0F4wiImRYrK4YAnnJ5dXsDy3Thm0eB6fEVxTy7Of/j409VHMoYO0jpgh+N4HIe+SjtfcDXQtPMI13CGnWhvew71f/pq17AEaoUmRnIRmFnDx2tWdct2WNVdxHLtPI1vt1T6P1tZVTRcv50R18qEI2/717N73Aze+pZclg2Hf1a2eZTrRe/owwqSDSQwamkLKawxp2mKZqjgEevdoY5nH69Z6AXyXbp0H+hS84NWb6fUZrD2Lo+qDaC/5NOTgO22pmJV1cnXU88iGgdbadqbu6qq/gvXu8wK","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"}}');var l=a(74848),o=a(28453),s=a(33617),n=a.n(s),p=a(17543),m=a.n(p),r=a(86013),d=a.n(r),c=a(63723),g=a.n(c),u=(a(18766),a(79329),a(9303));const h={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWEtvIzcS/iu1vGQjtKW2x+PJ6hQjGDjGGhlj7cBAPIbA7i6pOWaTDMnWA0IDOew/2NNe96fNL1kU+ym/ZG+CHPZiq8n6WA9WkV9xyzxfODa9ZddYGMk9OnYXsQxdaoXxQis2Zdc5whl6aEXgQjgPp5fnwKXUKwcbXYLXYNFbgUsEDpIk9Bz4kgvJE4ng2/XHcJ0LB/NSpbQ+l8JvwFi9FBk64Ar0Eu1S4CrgpeyREaDiiRRqAaVD60hnmmvtEOZWF4Br4TzNdghY5aggtcjDeKbTskDl3ZhFTBu0nCw4z9iULdC3KLKdRcxwywv0aCk8W6Z4gWzKpCgEzQoKzK8l2g2LmMVfS2ExY9M5lw4j5vxGkvRc24JFDNdG6gzZ1NuSZtMcC86mW1bwtSjKgk3fx3HE/MYQSJVFgpZVhOOFoYUO4yrqTHD3wvxhFjyvM67uaF1ntHLoSPYojunfbnK4Mk3RuXkpoYsoi1iqlUflSZ4bI0UaJiZfHIG2jw3QyRdMQ9gtLeNFrdKiK6UfyHFrOTksPBZuP74eph3uJJ23Qi1YFELD/XCk852tD39MVOGOLhcUEy88jT5eoge48KPLPEIp7feAWmkIohWZJDO0f5ZbdT69ZGBtDwTBqg9EZ/isMZhMF/tClHtv3HQyacFUw+NUF4TWK7Xj90vBCuWsW6si5sRChSr9X5PE6n2mp6hfF7AvGiHBYBYWXMi90gni981AGwuTa7VHzfH7k6PDd999OCT5lcgW6H+H//Xs2zLJ49oneh3s5Qt8fJQM4N1If55VEVu/EXN0fFxFbPNG1AdStXoj6N13VcTyN4KOTyiPw7H4ipg/l0qvinn1ZC1e1XUwa/PhRalQzg5Vdq4+2d0zJ9FaIldD1XRrVBELlYfZqX85O4/io3cHh/FB/OH68GR6/Lfp+5NxHMe/sIitC9l7z7LmpGyNbL9Lk/0pegKdwGtdvs59i5mwmPpZaZ8s7Jf2jtQFtjQrdCbmzX3oXtYb7nICll7PLBZC7d2pFlJLz7RKcSbUDJfEE55I6MF1Xz0M2/Aye5hHu9kllBQKZy1bmB3F8eykydPj+P1j1nCullyKLJDIa32P6i9/HGdAa/Weu2So3tfqH7svaqEwz3acHY7XTjpMSyv8JlDF9QE34qCen97eEY8q0Oe64ZmBW/qcTdnkAeV0aJct3ww51t2Zjqss0euxNqjovpM8cXRfTLgRk+XhmC6ChxhuzJvksTx4K8R5vhBqsQ931wfoijax3qedMPV3lxF/R7q8ml0YSjWkN0ceSEdF33MdwM3efDKo6IQLOxuUP2xmblCmukDqHXyOMBq1kK///E+HGo26XiHk4Piz+qw+lRaMXqElrstVBnOJa0G9DcGwCHNdM+SQFxKdkxsQyuPCEnXJxEJ4LoHiRA1Jyg1PhBSUuiSmCW1hkP1uDDc5+hwtTX1jqbnKcImSMh7oYCh2extYaXs/p7YsAg5J6YRC5wBVzlVKgu1ORKAttVuoPFpjhUNw3pLVorZNK2956qHgii+Q1o5gGKwMpaB0BauT0nlwWpbBZPBcSG0xg9YhhZi5EMSP1IhYBBpNdWEs5pQ2S4RFSQ1gBKnOEGo6TS6oDBJ0HgzZIlIMXV+ppE7vwwbOSynBaDo4BJfUMw5tJLi3XDk6m2tb2j3oAmaspg4GawNHo58d0g5fCHXvpqPRZ3UAt11e3WDihMe7v7YlsFqtHqX+t7uYM+F/LBP4BxrthNd206MXwudlEspluEj3Ua90hgpD/gyKoV8j06l7XH00OslRmskVesoQNzm9PA9n7bfw9bd/wQVyqyDXqzpb09Ki3MCiVUWRq3e+Dlt3VMJch8TLKeJpnXzUfqLzbQRvcu6//vZvBz/hCoRqSopcGY0uy0SKtHtLcKPRFH4IvGLQtvuce0i5ggTB5ZxSaSk4cDA1Wgp1P4ZTtQkPAbASPg/JQOMBt+MGxaXv/SHhDjPQKiBanePeIhovHMolOlpLaU9mYCY8ZXRudbmotQ2NaZyzOBdSwk1Nwci30ywD0ww3zIwCPjAH51QQPscNcIvgUPkxXD6AhJnSGG3JClEbP9fEKGgDUGVGC+XdFDLL575fP+oTvX4H0eqJoTqEvAtH1CwzeHuhSDYe9285n+lQfnCQ7563FudoSWFwu98XI5p0um3TEihbf09a0yVNpxZPA4doGjC6Ub5/uE64z9EW7tP8il6b0rZBfaaiJ0F4wiImRYrK4YAnnJ5dXsDy3Thm0eB6fEVxTy7Of/j409VHMoYO0jpgh+N4HIe+SjtfcDXQtPMI13CGnWhvew71f/pq17AEaoUmRnIRmFnDx2tWdct2WNVdxHLtPI1vt1T6P1tZVTRcv50R18qEI2/717N73Aze+pZclg2Hf1a2eZTrRe/owwqSDSQwamkLKawxp2mKZqjgEevdoY5nH69Z6AXyXbp0H+hS84NWb6fUZrD2Lo+qDaC/5NOTgO22pmJV1cnXU88iGgdbadqbu6qq/gvXu8wK",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,w={},x=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,l.jsx)(n(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(m(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,l.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}},title:"inline_response_200_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.827e01c6.js b/assets/js/5ce6d213.827e01c6.js new file mode 100644 index 000000000..3677e2d96 --- /dev/null +++ b/assets/js/5ce6d213.827e01c6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3460],{78912:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>x,default:()=>g,frontMatter:()=>f,metadata:()=>a,toc:()=>v});const a=JSON.parse('{"id":"API-docs/v1.1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","source":"@site/docs/API-docs/v1.1/update-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-template","permalink":"/docs/API-docs/v1.1/update-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar_label":"Update Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzFWN1uG7sRfpUpb5oIa0lJnBxUV3Vz0sRokAixjaB1DIG7O6vlMZfkIbmSBWOBc9E36FVv+2h5kmLI3dXqJ07Sc9reGDJ3Zji/nG/mnnm+dGx2zS6xMpJ7dOwmYTm6zArjhVZsxi5LhCuTc4/QUcHZ/BxQ8VSig42uwWuodC6KDXCVQx2pfYmQo+dCOtAFcHAGM1GIDHwrZ8wSpg1aTled52zGImt3D0uY4ZZX6NGSmvdM8QrZjHUCFiJnCROkpuG+ZPu6n/9IN5MiHQf4kntQiLkjrVNstSU5Fn+uhcWczbytMWHObyTd5kRlJCmDd0bqHNms4NIRQVZixdnsnvmNCZTeCrVkCSu0rbjfnjTNTZSPzv9J5xvi2VV1bvVK5AgpSr2G3mxSsvNnFyN4xD1I5M6DVjig7Qx4zBKWaeVRebqIGyNFFpw8+cnRbfeHquv0J8w8edxSSLxAR1+jw79uIDmHBzfNmAs/en1ZkzCl/XeLmZOJCBZXAtchsZxYKvClcJDrrK7IvGYv5N93RZ8VQxkN8cgcLWXkobwtN1HGKnh/OR+QplpL5OogGymr4CQaoMMhrIWUbSXB+8s5rNBShYRYjeHKoXWRxmKGYoXAd0gg0znCSnDAiguZwLoUWUkJv4Gqdh5QtTnUug57z40hJDGcwKFCuXBHNUqAS6nXQi2hDqodEwy5sJh5uYG18KWuPfA8F8TOJTiPxo2HXgxa9I681LX99Z7ksKxFjjl4XVsotA1aonUJmFBmZIFQzts6I2YHeU3RDXYQKf02Vmfo3NZPnVeIaCA/AVQusnMouPNoE6iVIM/b2njMe5F4Z9AKVBkedUFw7iI8pK3D3bf7Yo62Et51llJoeJ4DSqSgOHB1VgKP37mvLboEhBJecOkScJ5XxiWgLXi8o3cFvDb0eOKdcJ6UX4t8id6B+FIefUCqkWygQ2F1FaJPvlGbYSL0enm9J+6Sgipc2z4KXksPKy7r4z4rhDz6sOz66K+6hopv2ujHEKbc4YtTQEU1lMP8xz8DCSOFLBrJs0jW268VDl+TyH7wHliM6b+orfy6XhexI2K09urDW1iXaLHPQ7Qxr1N6BqNgpP4aKp9u9V3W9tW3n74HGvLa64XFSqgcv6XWLtCHIFGaed2XWO11xb3IoBPlxtCSxoTwelgxFTzqgpliyVdC28dHAxrFLbTKcCHUAldoNwMtVV2laA+UfBeOKV9zvnGQol8jqqFuXVppJTfQdkTSbV2igh2fEJXbGr2j5fOmSZgXfqd7LAZwZJFSd2+aJpjijFYuNtKn0+lh0+8BVQtCqEopakUt5eZ3v10Xj8df62fc5U/fuPnpG0N50qp05h9mejp9+uzkyfRk+sPlkxez0z/Mnr8YT6fTv7GE3VVyCyFY3kKBznvx/8GBUFIoXHReWzydThfPWleeHvNeCxC6ol5xKXIoBMoc6E73GzoQrdX2PwQwD+j3kPlkcmf86QOpo7SHQtcq/3+be0yjhw08XfzQm/j80MRzFV1G08alvkX1v7Bwa8/weh+vJ1V3s1pEovCd7Rg7PI9GOsxqK/wmTDJ3J9yIk/h9dn1D80GFvtQ0BZk6KEwTzYxNutdlcj94ZxpG8uyqG4xCu2Gl98bNJhPHVZ7qu7E2qKghSJ66caarCTdisnoyfsKaZJ+HG/Nd9FiffC+L83wp1PJrfDdbV11QOGPEdhzWx40b8RfcsKSLx5CqnQxL5NTpKAKUJR+2U9irLtZ9OPdHl25y+bZh5ACaHRsvhtMFYzsTRDtWDqFwe3QUGrbfIgRibB980Mles285jvfY5w05rNDBu20avzeoLshQKoIQnX0bP6LMdIUdjhuNOpbPf/9XzzUa9U6Ko80n9Um9ry0YvUZb1DJ4tJB4J6gnh/VCFb71+wWHvJLonNwAQeulDX4VS+FprGhBT8YNT4UUVOVEponbwuChcGP4WKIv0dKn31saFnJcoaTHoUc1arkFVGttbwup1y4BDmnthELnAFXJVUaEXaoG8MxVHLmMFQ7BeUtai6ibVt7yzEPFFV8G9JvA0Fk5SkH1DFanNLs5Les4ndAORdswb0SDwv4iOPEVrSQsAp0SJLRYUl2t2hHFJXFEjHlNJqgcUnQeDOkiMgwIvFZSZ7chgAQ9wGh6YwWXhKiGOhK7t1w5agRRly4GvcNa5IlRwdHoyiFF+K1Qt242Gn1SJ3Dd59VHTJ3wePOoeyPW6/XB2/B4l+e18G/qFD6g0U54bTdb7qXwZZ2G92QopP8nSnqNCkP+DF6LrYxcZ+7weaLTSYnSTC7QU4a4ydn8PLSlx/D5l3/AW+RWQanXMVuz2qLcwLK7ijwXIx/d1neVMJ/y2pfk8SwmX7sp6jz4seT+8y//dPAO1zR/xZIiU0ajeZ1KkfWrOTcazeClxd2FUVh6ZVzRIOFKTqlESwMOJnJLoW7HcKY2Ya4Pg3tIBjoPfDtmhJevC7cLg1QeJsbBnm281SjAf4dyhY5kETpIETAXBHh9aXW9jLcNlWmNs1jQ/PMxzp5k21meg2mPu5GURo2tOljoOEJtgFsEF6bK+R5L+FIboy1p0c60he7WG6hyo4Xybga55YXfyk+2iZ6Rm8Na5OAoupD37khaMX1IYiW2Fven40/UH/Y63e57a7FASxcGs7dxMaJNp+suLYGy9dekNeEZerV4FuBWWDHFlvvHfTkB+qCt3PviAu1KZNi2/S9U9CQQT1jCpMhQuWEPPns9fwurZ+MpSwb44RuKe/L2/OWrdxevSBl6SKPDnoyn4ykdGe18xdXgpr219n5vu9+Czf/2FrxFM7R7mRjJRcCS7Qoh4sBrNgAls+EC/CZhpXaeSO7vqRivrGwaOv65Do39+iZhK24FaRrAYjuX5z0g+KLZjz50K2X4vl36UYM6zKYIsIWdTkQpt7jZW+o3N03SATfSOFK8jHqdXJKcrYSDOYCQZ+Q4yzI0/kHaIfCeX12yhKXtgr4Ku35m+ZqwFV9HZeO+MUDScHbPJFfLmi+JNops4pql3MWptwGntj/IqKPu2AWw0Qr6SzYdZbi/jxi4aXr6+OmLHK1fO2qKzU3TNP8Gdp4xQA==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"}}');var n=i(74848),o=i(28453),s=i(33617),p=i.n(s),d=i(17543),l=i.n(d),r=i(86013),c=i.n(r),m=i(63723),u=i.n(m),h=(i(18766),i(79329),i(9303));const f={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWN1uG7sRfpUpb5oIa0lJnBxUV3Vz0sRokAixjaB1DIG7O6vlMZfkIbmSBWOBc9E36FVv+2h5kmLI3dXqJ07Sc9reGDJ3Zji/nG/mnnm+dGx2zS6xMpJ7dOwmYTm6zArjhVZsxi5LhCuTc4/QUcHZ/BxQ8VSig42uwWuodC6KDXCVQx2pfYmQo+dCOtAFcHAGM1GIDHwrZ8wSpg1aTled52zGImt3D0uY4ZZX6NGSmvdM8QrZjHUCFiJnCROkpuG+ZPu6n/9IN5MiHQf4kntQiLkjrVNstSU5Fn+uhcWczbytMWHObyTd5kRlJCmDd0bqHNms4NIRQVZixdnsnvmNCZTeCrVkCSu0rbjfnjTNTZSPzv9J5xvi2VV1bvVK5AgpSr2G3mxSsvNnFyN4xD1I5M6DVjig7Qx4zBKWaeVRebqIGyNFFpw8+cnRbfeHquv0J8w8edxSSLxAR1+jw79uIDmHBzfNmAs/en1ZkzCl/XeLmZOJCBZXAtchsZxYKvClcJDrrK7IvGYv5N93RZ8VQxkN8cgcLWXkobwtN1HGKnh/OR+QplpL5OogGymr4CQaoMMhrIWUbSXB+8s5rNBShYRYjeHKoXWRxmKGYoXAd0gg0znCSnDAiguZwLoUWUkJv4Gqdh5QtTnUug57z40hJDGcwKFCuXBHNUqAS6nXQi2hDqodEwy5sJh5uYG18KWuPfA8F8TOJTiPxo2HXgxa9I681LX99Z7ksKxFjjl4XVsotA1aonUJmFBmZIFQzts6I2YHeU3RDXYQKf02Vmfo3NZPnVeIaCA/AVQusnMouPNoE6iVIM/b2njMe5F4Z9AKVBkedUFw7iI8pK3D3bf7Yo62Et51llJoeJ4DSqSgOHB1VgKP37mvLboEhBJecOkScJ5XxiWgLXi8o3cFvDb0eOKdcJ6UX4t8id6B+FIefUCqkWygQ2F1FaJPvlGbYSL0enm9J+6Sgipc2z4KXksPKy7r4z4rhDz6sOz66K+6hopv2ujHEKbc4YtTQEU1lMP8xz8DCSOFLBrJs0jW268VDl+TyH7wHliM6b+orfy6XhexI2K09urDW1iXaLHPQ7Qxr1N6BqNgpP4aKp9u9V3W9tW3n74HGvLa64XFSqgcv6XWLtCHIFGaed2XWO11xb3IoBPlxtCSxoTwelgxFTzqgpliyVdC28dHAxrFLbTKcCHUAldoNwMtVV2laA+UfBeOKV9zvnGQol8jqqFuXVppJTfQdkTSbV2igh2fEJXbGr2j5fOmSZgXfqd7LAZwZJFSd2+aJpjijFYuNtKn0+lh0+8BVQtCqEopakUt5eZ3v10Xj8df62fc5U/fuPnpG0N50qp05h9mejp9+uzkyfRk+sPlkxez0z/Mnr8YT6fTv7GE3VVyCyFY3kKBznvx/8GBUFIoXHReWzydThfPWleeHvNeCxC6ol5xKXIoBMoc6E73GzoQrdX2PwQwD+j3kPlkcmf86QOpo7SHQtcq/3+be0yjhw08XfzQm/j80MRzFV1G08alvkX1v7Bwa8/weh+vJ1V3s1pEovCd7Rg7PI9GOsxqK/wmTDJ3J9yIk/h9dn1D80GFvtQ0BZk6KEwTzYxNutdlcj94ZxpG8uyqG4xCu2Gl98bNJhPHVZ7qu7E2qKghSJ66caarCTdisnoyfsKaZJ+HG/Nd9FiffC+L83wp1PJrfDdbV11QOGPEdhzWx40b8RfcsKSLx5CqnQxL5NTpKAKUJR+2U9irLtZ9OPdHl25y+bZh5ACaHRsvhtMFYzsTRDtWDqFwe3QUGrbfIgRibB980Mles285jvfY5w05rNDBu20avzeoLshQKoIQnX0bP6LMdIUdjhuNOpbPf/9XzzUa9U6Ko80n9Um9ry0YvUZb1DJ4tJB4J6gnh/VCFb71+wWHvJLonNwAQeulDX4VS+FprGhBT8YNT4UUVOVEponbwuChcGP4WKIv0dKn31saFnJcoaTHoUc1arkFVGttbwup1y4BDmnthELnAFXJVUaEXaoG8MxVHLmMFQ7BeUtai6ibVt7yzEPFFV8G9JvA0Fk5SkH1DFanNLs5Les4ndAORdswb0SDwv4iOPEVrSQsAp0SJLRYUl2t2hHFJXFEjHlNJqgcUnQeDOkiMgwIvFZSZ7chgAQ9wGh6YwWXhKiGOhK7t1w5agRRly4GvcNa5IlRwdHoyiFF+K1Qt242Gn1SJ3Dd59VHTJ3wePOoeyPW6/XB2/B4l+e18G/qFD6g0U54bTdb7qXwZZ2G92QopP8nSnqNCkP+DF6LrYxcZ+7weaLTSYnSTC7QU4a4ydn8PLSlx/D5l3/AW+RWQanXMVuz2qLcwLK7ijwXIx/d1neVMJ/y2pfk8SwmX7sp6jz4seT+8y//dPAO1zR/xZIiU0ajeZ1KkfWrOTcazeClxd2FUVh6ZVzRIOFKTqlESwMOJnJLoW7HcKY2Ya4Pg3tIBjoPfDtmhJevC7cLg1QeJsbBnm281SjAf4dyhY5kETpIETAXBHh9aXW9jLcNlWmNs1jQ/PMxzp5k21meg2mPu5GURo2tOljoOEJtgFsEF6bK+R5L+FIboy1p0c60he7WG6hyo4Xybga55YXfyk+2iZ6Rm8Na5OAoupD37khaMX1IYiW2Fven40/UH/Y63e57a7FASxcGs7dxMaJNp+suLYGy9dekNeEZerV4FuBWWDHFlvvHfTkB+qCt3PviAu1KZNi2/S9U9CQQT1jCpMhQuWEPPns9fwurZ+MpSwb44RuKe/L2/OWrdxevSBl6SKPDnoyn4ykdGe18xdXgpr219n5vu9+Czf/2FrxFM7R7mRjJRcCS7Qoh4sBrNgAls+EC/CZhpXaeSO7vqRivrGwaOv65Do39+iZhK24FaRrAYjuX5z0g+KLZjz50K2X4vl36UYM6zKYIsIWdTkQpt7jZW+o3N03SATfSOFK8jHqdXJKcrYSDOYCQZ+Q4yzI0/kHaIfCeX12yhKXtgr4Ku35m+ZqwFV9HZeO+MUDScHbPJFfLmi+JNops4pql3MWptwGntj/IqKPu2AWw0Qr6SzYdZbi/jxi4aXr6+OmLHK1fO2qKzU3TNP8Gdp4xQA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,b={},v=[];function F(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(l(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"template_template_id_body"}}}}}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Template not found!"}},title:"inline_response_404_7"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.c87a9aec.js b/assets/js/5ce6d213.c87a9aec.js deleted file mode 100644 index c5b9e2a6f..000000000 --- a/assets/js/5ce6d213.c87a9aec.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3460],{78912:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>v,contentTitle:()=>f,default:()=>x,frontMatter:()=>b,metadata:()=>a,toc:()=>y});const a=JSON.parse('{"id":"API-docs/v1.1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","source":"@site/docs/API-docs/v1.1/update-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-template","permalink":"/docs/API-docs/v1.1/update-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar_label":"Update Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzFWV9v3LgR/ypTvjQx5N1Nzsmh+1Q3lybGpckithG0jrGgpNGKZ4rkkdSuFwsB99Bv0Ke+9qPlkxRDSlrtnzhJ79q+GDY1M5x/nPnNeMM8Xzg2vWFXWBnJPTp2m7AcXWaF8UIrNmVXJcK1yblH6KjgfHYBqHgq0cFa1+A1VDoXxRq4yqGO1L5EyNFzIR3oAjg4g5koRAa+lTNiCdMGLaerLnI2ZZG1u4clzHDLK/RoSc0NU7xCNmWdgLnIWcIEqWm4L9m+7hc/0M2kSMcBvuQeFGLuSOsUW21JjsWfa2ExZ1Nva0yY82tJtzlRGUnK4L2ROkc2Lbh0RJCVWHE23TC/NoHSW6EWLGGFthX325OmuY3y0fk/6XxNPLuqzqxeihwhRalX0JtNSnb+7GIEj7gHidx50AoHtJ0Bj1nCMq08Kk8XcWOkyIKTxz85um1zqLpOf8LMk8cthcQLdPQ1OvzLBpJzeHDTlLnwS68vaxKmtP9mMTMyEcHiUuAqJJYTCwW+FA5yndUVmdfshfzbruizYiijIR6Zo6WMPJS35SbK+AreXc0GpKnWErk6yEbKKjiNBuhwCCshZfuS4N3VDJZo6YWEWI3g2qF1kcZihmKJwHdIINM5wlJwwIoLmcCqFFlJCb+GqnYeULU51LoOe8+NICQxnMKhQrlwRzVKgEupV0ItoA6qHRMMubCYebmGlfClrj3wPBfEziU4j8aNhl4MWvSOvNK1/fWe5LCoRY45eF1bKLQNWqJ1CZjwzMgCoZy3dUbMDvKaohvsIFL63VidoXNbP3VeIaKB/ARQucjOoeDOo02gVoI8b2vjMe9F4r1BK1BleNQFwbnzUEhbh7uv98UMbSW86yyl0PA8B5RIQXHg6qwEHr9zX1t0CQglvODSJeA8r4xLQFvweE91Bbw2VDzxXjhPyq9EvkDvQHwuj94jvZFsoENhdRWiT75R62Ei9Hp5vSfuioIqXNs+Cl5LD0su6+M+K4Q8Wlh2ffRXXUPF1230YwhT7vD5GaCiN5TD7Ic/AwkjhSwaybNI1tuvFQ6rSWQ/qAcWY/rPayu/rNdl7IgYrb1+/wZWJVrs8xBtzOuUymAUjNRfw8unW32Xtf3r20/fAw157fXcYiVUjl/z1i7RhyBRmnndP7Ha64p7kUEnyo2gJY0J4fXwxVTwqAtmiiVfCm0fHw1oFDfXKsO5UHNcol0PtFR1laI9UPJtOKZ8zfnaQYp+haiGunVppZVcQ9sRSbdViQp2fEJUbmv0jpbPmiZhXvid7jEfwJF5St29aZpgijNaudhIn04mh02/B1QtCKFXSlErainXv/vtung8/lI/4y5/+trNzl4bypNWpXP/MNPTydPvTp9MTiffXz15Pj37w/TZ89FkMvkbS9h9JbcQguUtFOi8F/8eHAglhcJ557X508lk/l3ryrNj3msBQveol1yKHAqBMge60/2GDkRrtf0PAcwD+j1kPpncGX/2QOoo7aHQtcr/3+Ye0+hhA8/m3/cmPjs08UJFl9G0caXvUP0vLNzaM7zex+tJ1d2sFpEofGc7xg7Po5EOs9oKvw6TzP0pN+I0fp/e3NJ8UKEvNU1Bpg4K00QzZeOuuow3gzrTMJJnl91gtFezV3yxQPu6ToP257XX8Bed3UUTQ2tipffGTcfjpbA+Shq5yFbW6SjT1XhmORWit3x5x+1YG1TjJ6PJaMKaZLMnxHGVp/p+RETUgSRPXZDBjRgvn4yeHOHhxnwTPdan38riPF8ItfgS3+02NpeUPzFFdiLUJwo34kdcs6RLgCFVO4qWyKm1UsgpLd9vx76XXXL1+bM/K3Wj0tdNPwdY8Ng8MxxnGNsZWdo5doi926OjWLT9FjEXY/toh0720EXLcbypP2vIYYUO3m3fzTuD6pIMpbwN0dm38QPKTFfYAceTk47l09//1XOdnPROirPUR/VRvastGL1CW9QyeLSQeC8IBIR9RhW+9QsNh7yS6JxcA2H5hQ1+FQvhaY5pUVbGDU+FFFRWiEwTt4VBZXIj+FCiL9HSp99bmk5yXKKkatTDKLXYIriVtneF1CuXAIe0dkKhc4Cq5Cojwi5VA1rnKs54xgqH4LwlrUXUTStveeah4oovAtxOYOisHKWgAgJWpzQsOi3rOA7R0kbbMOBEg8LCJDjxJe1ALAKdEga1WNK7WrYzkUviTBrzmkxQOaToPBjSRWQYIH+tpM7uQgCpxIDRVNQFlwThhjoSu7dcOeo8UZcuBr3DWqiLUcGTk2uHFOE3Qt256cnJR3UKN31efcDUCY+3j7oasVqtDmrD412eV8JTKX2PRjvhtV1vuRfCd+VyKKT/I0p6hQpD/gyqxVZGrjN3WJ7odFyiNONL9JQhbnw+uwh98DF8+uUf8Aa5VVDqVczWrLYo17DoriLPxchHt/VtLAzEvPYleTyLydeupjoPfii5//TLPx28xRUNfPFJkSknJ7M6lSLrd4Hu5GQKLyzubqjCli3jiiYXV3JKJdpScDCRWwp1N4JztQ6LhLApCMlA54Fvx4xQ+bpwuzC55WFEHSz2RluNwrzhUC7RkSyCIykC5oIQti+trhfxtqEyrXEWCxq4PsRhl2w7z3Mw7XE3A9Nss1UHCx1ntjVwi+DCGDvbYwlfamO0JS3aIbrQ3T4FVW60UN5NIbe88Fv5yTbRM3Jz2MMcHEUX8t4dSSumD0l8ia3F/enoI/WHvU63W28tFmjpwmD2Ni5GtOl006UlULb+mrQmAEVVi2cB34WdVmy5f9yXE7AW2sq9Ky7RLkWGbdv/zIseB+IxS5gUGSo37MHnr2ZvYPndaLKDjb7icY/fXLx4+fbyJSlDhTQ6rMNIzGjnK64GN+3t0fd722aLbv/ba/cWzdCyZ2wkFwG8tjuLCDxv2ACUTIcb99uEldp5Itls6DFeW9k0dPxzHRr7zW3CltwK0jSi07gIyHtA8FmzH73vdtjwbcv7owZ1mE0RYAtLpIhS7nC991+E5rZJOuBGGkeKF1Gv0yuSs5VwMHgQ8owc51mGxj9IO0T6s+srlrC0/Y9AFf65wCxfEbbiq6hsXHAGSBrONkxytaj5gmijyCbudcpdnHoXcGr7Cxl11B27ADZaQT/JpqMMm03EwE3T08dPn+Vo/dpRU2xum6b5N8K5WOs=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"}}');var n=i(74848),o=i(28453),p=i(33617),s=i.n(p),l=i(17543),r=i.n(l),d=i(86013),c=i.n(d),m=i(63723),u=i.n(m),h=(i(18766),i(79329),i(9303));const b={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWV9v3LgR/ypTvjQx5N1Nzsmh+1Q3lybGpckithG0jrGgpNGKZ4rkkdSuFwsB99Bv0Ke+9qPlkxRDSlrtnzhJ79q+GDY1M5x/nPnNeMM8Xzg2vWFXWBnJPTp2m7AcXWaF8UIrNmVXJcK1yblH6KjgfHYBqHgq0cFa1+A1VDoXxRq4yqGO1L5EyNFzIR3oAjg4g5koRAa+lTNiCdMGLaerLnI2ZZG1u4clzHDLK/RoSc0NU7xCNmWdgLnIWcIEqWm4L9m+7hc/0M2kSMcBvuQeFGLuSOsUW21JjsWfa2ExZ1Nva0yY82tJtzlRGUnK4L2ROkc2Lbh0RJCVWHE23TC/NoHSW6EWLGGFthX325OmuY3y0fk/6XxNPLuqzqxeihwhRalX0JtNSnb+7GIEj7gHidx50AoHtJ0Bj1nCMq08Kk8XcWOkyIKTxz85um1zqLpOf8LMk8cthcQLdPQ1OvzLBpJzeHDTlLnwS68vaxKmtP9mMTMyEcHiUuAqJJYTCwW+FA5yndUVmdfshfzbruizYiijIR6Zo6WMPJS35SbK+AreXc0GpKnWErk6yEbKKjiNBuhwCCshZfuS4N3VDJZo6YWEWI3g2qF1kcZihmKJwHdIINM5wlJwwIoLmcCqFFlJCb+GqnYeULU51LoOe8+NICQxnMKhQrlwRzVKgEupV0ItoA6qHRMMubCYebmGlfClrj3wPBfEziU4j8aNhl4MWvSOvNK1/fWe5LCoRY45eF1bKLQNWqJ1CZjwzMgCoZy3dUbMDvKaohvsIFL63VidoXNbP3VeIaKB/ARQucjOoeDOo02gVoI8b2vjMe9F4r1BK1BleNQFwbnzUEhbh7uv98UMbSW86yyl0PA8B5RIQXHg6qwEHr9zX1t0CQglvODSJeA8r4xLQFvweE91Bbw2VDzxXjhPyq9EvkDvQHwuj94jvZFsoENhdRWiT75R62Ei9Hp5vSfuioIqXNs+Cl5LD0su6+M+K4Q8Wlh2ffRXXUPF1230YwhT7vD5GaCiN5TD7Ic/AwkjhSwaybNI1tuvFQ6rSWQ/qAcWY/rPayu/rNdl7IgYrb1+/wZWJVrs8xBtzOuUymAUjNRfw8unW32Xtf3r20/fAw157fXcYiVUjl/z1i7RhyBRmnndP7Ha64p7kUEnyo2gJY0J4fXwxVTwqAtmiiVfCm0fHw1oFDfXKsO5UHNcol0PtFR1laI9UPJtOKZ8zfnaQYp+haiGunVppZVcQ9sRSbdViQp2fEJUbmv0jpbPmiZhXvid7jEfwJF5St29aZpgijNaudhIn04mh02/B1QtCKFXSlErainXv/vtung8/lI/4y5/+trNzl4bypNWpXP/MNPTydPvTp9MTiffXz15Pj37w/TZ89FkMvkbS9h9JbcQguUtFOi8F/8eHAglhcJ557X508lk/l3ryrNj3msBQveol1yKHAqBMge60/2GDkRrtf0PAcwD+j1kPpncGX/2QOoo7aHQtcr/3+Ye0+hhA8/m3/cmPjs08UJFl9G0caXvUP0vLNzaM7zex+tJ1d2sFpEofGc7xg7Po5EOs9oKvw6TzP0pN+I0fp/e3NJ8UKEvNU1Bpg4K00QzZeOuuow3gzrTMJJnl91gtFezV3yxQPu6ToP257XX8Bed3UUTQ2tipffGTcfjpbA+Shq5yFbW6SjT1XhmORWit3x5x+1YG1TjJ6PJaMKaZLMnxHGVp/p+RETUgSRPXZDBjRgvn4yeHOHhxnwTPdan38riPF8ItfgS3+02NpeUPzFFdiLUJwo34kdcs6RLgCFVO4qWyKm1UsgpLd9vx76XXXL1+bM/K3Wj0tdNPwdY8Ng8MxxnGNsZWdo5doi926OjWLT9FjEXY/toh0720EXLcbypP2vIYYUO3m3fzTuD6pIMpbwN0dm38QPKTFfYAceTk47l09//1XOdnPROirPUR/VRvastGL1CW9QyeLSQeC8IBIR9RhW+9QsNh7yS6JxcA2H5hQ1+FQvhaY5pUVbGDU+FFFRWiEwTt4VBZXIj+FCiL9HSp99bmk5yXKKkatTDKLXYIriVtneF1CuXAIe0dkKhc4Cq5Cojwi5VA1rnKs54xgqH4LwlrUXUTStveeah4oovAtxOYOisHKWgAgJWpzQsOi3rOA7R0kbbMOBEg8LCJDjxJe1ALAKdEga1WNK7WrYzkUviTBrzmkxQOaToPBjSRWQYIH+tpM7uQgCpxIDRVNQFlwThhjoSu7dcOeo8UZcuBr3DWqiLUcGTk2uHFOE3Qt256cnJR3UKN31efcDUCY+3j7oasVqtDmrD412eV8JTKX2PRjvhtV1vuRfCd+VyKKT/I0p6hQpD/gyqxVZGrjN3WJ7odFyiNONL9JQhbnw+uwh98DF8+uUf8Aa5VVDqVczWrLYo17DoriLPxchHt/VtLAzEvPYleTyLydeupjoPfii5//TLPx28xRUNfPFJkSknJ7M6lSLrd4Hu5GQKLyzubqjCli3jiiYXV3JKJdpScDCRWwp1N4JztQ6LhLApCMlA54Fvx4xQ+bpwuzC55WFEHSz2RluNwrzhUC7RkSyCIykC5oIQti+trhfxtqEyrXEWCxq4PsRhl2w7z3Mw7XE3A9Nss1UHCx1ntjVwi+DCGDvbYwlfamO0JS3aIbrQ3T4FVW60UN5NIbe88Fv5yTbRM3Jz2MMcHEUX8t4dSSumD0l8ia3F/enoI/WHvU63W28tFmjpwmD2Ni5GtOl006UlULb+mrQmAEVVi2cB34WdVmy5f9yXE7AW2sq9Ky7RLkWGbdv/zIseB+IxS5gUGSo37MHnr2ZvYPndaLKDjb7icY/fXLx4+fbyJSlDhTQ6rMNIzGjnK64GN+3t0fd722aLbv/ba/cWzdCyZ2wkFwG8tjuLCDxv2ACUTIcb99uEldp5Itls6DFeW9k0dPxzHRr7zW3CltwK0jSi07gIyHtA8FmzH73vdtjwbcv7owZ1mE0RYAtLpIhS7nC991+E5rZJOuBGGkeKF1Gv0yuSs5VwMHgQ8owc51mGxj9IO0T6s+srlrC0/Y9AFf65wCxfEbbiq6hsXHAGSBrONkxytaj5gmijyCbudcpdnHoXcGr7Cxl11B27ADZaQT/JpqMMm03EwE3T08dPn+Vo/dpRU2xum6b5N8K5WOs=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,v={},y=[];function g(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(s(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(r(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"template_template_id_body"}}}}}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Template not found!"}},title:"inline_response_404_7"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.3b3ff2a4.js b/assets/js/62b755e6.3b3ff2a4.js deleted file mode 100644 index 1924bbda3..000000000 --- a/assets/js/62b755e6.3b3ff2a4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9350],{30456:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>f,frontMatter:()=>x,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/v1.1/getdocumentlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocumentlist","permalink":"/docs/API-docs/v1.1/getdocumentlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar_label":"Get Document list from status","hide_title":true,"hide_table_of_contents":true,"api":"eJztWV9vGzkO/yo89eFaY2I7idPu+WmDbi+Xu14bNCkKXBsYmhnao0YjzUoaO0ZgYB/uG+zTvt5H6yc5UJq/iZPG3UWf9qWNJZIiqR8pknPDHF9YNv3IftJJmaNyll1GLEWbGFE4oRWbsidPnkC9DRfrAu30k3qHzghcInCQwjrQc0hrERBziyloBW5d4Cf1Se0PYTD4yfC5ayTZ6WDwSQEA7LVr4DLugBuEpDQGlZNrEApSz2kdd6UdkrwDkneq9s6MXhi09pukFhWzl3hIEl/qvJDoMH2MvIwvEWJEBbZMErR2Xkq5hqSRsRIuAy4lGPy5FAZTsGKhuCsNhjMndOar68LvPfZErOi5Sr1JSoPUaoEGuNdCxBK99CPvc0ykULsalNZc8RpchlBaNMNPikVMF2g44eI0ZVO2QFdfOoGARazghufo0BCobpjiObIpS3VCSGAREwSogruM3UbZRYYeLn0kOQ2mQhqLWO1INnWmxIhZt5Yk3wryOYsYXhdSp8imcy4tESQZ5pxNb5g/f8qsM0ItiFKVOeHeQ8srVsOBRay5wyDSH0n6Bq+wy80mamyTIheutuznEs26p2itSKXpXJu8q2dlR6Nmzq9FTpodjcdRrbQq8xgN2xAf95ZO98cdFeyVKP4wDe4/c7y5JLm20MqiJdqD8Zj+619kGw3QoMX7VDlUjuh5UUiR+I3RZ0tMN3cV0PFnTDykDIlxIhxp0JbSdei4MZwMFg5z+3X+sEzovYsJcg13PZTUtrO/n4irg8M4e/9P8slc0OJuEjLnCjsdjaqV0shhonOS5oTbXZz1f1CokAil3c4SConcok9KTcR547RM0XwvVwYM7yYhaAieddM6kNVWzCoTNhHTK9Wz5VHyP2ufCImfvOOz2bcCzujtd9uelqB+yBFb1cKcC/lV6hjxx2qhxlqRafWVYyZHzw/2D394sU/0K5Eu0P0O+8Pubv53eO1ife315Qu8m5Y67M1Kmxs3EbvekedgMtlEbL0j1ws6arUj0+EPm4hlOzJNnhOWfYp9hM+/JaYan2+6EeUwLyR3ODsPcTCr8fAglQ9Kiyo9VW9NP5fEWkvkqns0vUCbiCUGucP02D2MzoPxweHe/nhv/OJi//l08rfp0fPheDz+D4vYdS5b61nKHbJucqh+l0X6Xc5BxWOJF7p8nPkGU2EwcbPSbA3sh+6OjuNS6tUs16mYV2+rffhcXxeQ3vXlia2ZvIuQhhCEBa3kGviSC0l2wipD5YvFOgkTTXWnMDc6Bw61hKFXuHR6ZjAX6j6E9OuKc3RUDpK76P/gXiApOXcigVqUHUJF6i2kP1JhPbHLMIenKc55KR3EmPGl0ObZcJtbgriZVgnOhJrhkuqqLUHbV/KNX/Y1LF9biNGtqKDu6HaRCdu6L1RCjf96PiEq2xrd03JMEXYLh50n/PaD2A9XoaiOndWl3OxgPJ5NqsCfjCd3S7p3WGjjQGnXXvhf/riaDo3RW9/oFnvbNXjIqMl4MjtqjDq6a9SpWnIpUjg+O4ULfYXq+1rUPd6F4+/eqQhEfp/1jO2uByMtJqURbu0br+s9Xoi9sD/9eEmVe44u01XX5js1l7EpG3UbuNFN1altGMkzy7qPuxWJK75YoPlHGXvtj0un4d86uQom+vzVVLtLYVyQNLSBLStjKkZGZ4ZTx/yGL6+4GekC1Wh/OB6OGXU2fSGWqzTW10MiooJM8th6GbwQo+X+cH8LDy+Kneix3NuVxTq+EGrxNb7L9m7OCT8BIr0baourQvwLqbqqANClqjq8DLmvbTf0e649cwWLtwUqeoL9tfjDb+enDygTnfukSLl6MKhZvvz3fw3XYNAkcQ9/P054Wxoo9AoNNXY0fJhLvKZhg2fD3O9ZWOuShFvkuURr/aTF4cJwh5CKhXBc+o5DqAUkvOCxkIKihsg0cRvoBJ4dwocMXYaGtv5qaNyU4hIlBVuT+9WifXRW2lzNpV7ZCDjEpRWKxkOoMq4SIqxvIgJtgCtA5dAURlAj5AxpLYJuWjnDEwc5V3yBJDuCrrNSlILiA4yOS+vAall6lcFxITWNaGqDFGIaJj6vqOs2CLRKQwaDGcFmibAoRYo2gkSnCKG3IxNUCjFaBwXpIhL0E5FSSZ1c+QukCIJCU84SXNK709WR2J3hylLxEHSp76BxWGE0tevVSGoweG+Rbvi1UFdhVrQHHxtcfcDYCoeXT+sQWK1Wd6D/rM9zIhxlCsrgVjht1i33Qrg6G3SFND+CpBNU6PHTCYZWRqoTezf6aHWUoSxG5+gIIXZ0fHbq0/wz+PLLr/AauVGQ6VVAa1IalGtY1EeR58LNB7c1WRrm2gMvI48nAXw0a0Hrag9+yLj78stvFt7giuaMIaTIlMHgrIylSOCiKoTsYDCFl75IaoqjahqXcAUxgs04QWkpOHAoArcU6moIx2rtB3NhzkhgoHXP1zOj1993Z7NZe+aw1cgXSRblEi3Johc3RsBUUB3nMqPLRTitq0xlnMG5kBI+hB6BbDtOUyiq5ap18AVZqw7OKSBchms/zrSo3BDObrH4nbKgGgBT8qnHvqaSly4AVVpoQcPNalTcyI9aoPtaVGi1Zaka1TbuiCoxzZWESKwsblbDSPRWIu/nW4NzNHSgN7u9l0JUcPpYwxIIrb8H1lQfUNbiiS9fqgkBvSg/3pbjSwk0uX07P0ezFEk9n7onokeeeMQiJkWCymKnRDk+OXsNy8PhuPf0PyK4R69PX756c/6KlKFEGhxWlwCs0NblXHVOOsH260H46ODbivBZ4PZLd9OWcn9+wPjzA0bzAaOqs2jaMSokF76srlruUBJ/ZLe+aUzrzxeXEcu0dURyc0MQeW/kZkPLYeruK+XQarZz9ytcd74SLLksq479XtpqnN+SXtIPI4h2+xn3Iv/pu+rmnsFjvq9sdU5dmap1V6la2do3m0uaaoXSlHQMu8dJgkXX7jtNVa8zOXl1wfxgIOuXxFe+JK7+IOlbderXykEB+pdcvZXh5iaU25tNQx+27uWoDKypyUGXm83m/3NNJwQ=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"}}');var s=n(74848),o=n(28453),r=n(33617),l=n.n(r),a=n(17543),c=n.n(a),p=n(86013),d=n.n(p),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWV9vGzkO/yo89eFaY2I7idPu+WmDbi+Xu14bNCkKXBsYmhnao0YjzUoaO0ZgYB/uG+zTvt5H6yc5UJq/iZPG3UWf9qWNJZIiqR8pknPDHF9YNv3IftJJmaNyll1GLEWbGFE4oRWbsidPnkC9DRfrAu30k3qHzghcInCQwjrQc0hrERBziyloBW5d4Cf1Se0PYTD4yfC5ayTZ6WDwSQEA7LVr4DLugBuEpDQGlZNrEApSz2kdd6UdkrwDkneq9s6MXhi09pukFhWzl3hIEl/qvJDoMH2MvIwvEWJEBbZMErR2Xkq5hqSRsRIuAy4lGPy5FAZTsGKhuCsNhjMndOar68LvPfZErOi5Sr1JSoPUaoEGuNdCxBK99CPvc0ykULsalNZc8RpchlBaNMNPikVMF2g44eI0ZVO2QFdfOoGARazghufo0BCobpjiObIpS3VCSGAREwSogruM3UbZRYYeLn0kOQ2mQhqLWO1INnWmxIhZt5Yk3wryOYsYXhdSp8imcy4tESQZ5pxNb5g/f8qsM0ItiFKVOeHeQ8srVsOBRay5wyDSH0n6Bq+wy80mamyTIheutuznEs26p2itSKXpXJu8q2dlR6Nmzq9FTpodjcdRrbQq8xgN2xAf95ZO98cdFeyVKP4wDe4/c7y5JLm20MqiJdqD8Zj+619kGw3QoMX7VDlUjuh5UUiR+I3RZ0tMN3cV0PFnTDykDIlxIhxp0JbSdei4MZwMFg5z+3X+sEzovYsJcg13PZTUtrO/n4irg8M4e/9P8slc0OJuEjLnCjsdjaqV0shhonOS5oTbXZz1f1CokAil3c4SConcok9KTcR547RM0XwvVwYM7yYhaAieddM6kNVWzCoTNhHTK9Wz5VHyP2ufCImfvOOz2bcCzujtd9uelqB+yBFb1cKcC/lV6hjxx2qhxlqRafWVYyZHzw/2D394sU/0K5Eu0P0O+8Pubv53eO1ife315Qu8m5Y67M1Kmxs3EbvekedgMtlEbL0j1ws6arUj0+EPm4hlOzJNnhOWfYp9hM+/JaYan2+6EeUwLyR3ODsPcTCr8fAglQ9Kiyo9VW9NP5fEWkvkqns0vUCbiCUGucP02D2MzoPxweHe/nhv/OJi//l08rfp0fPheDz+D4vYdS5b61nKHbJucqh+l0X6Xc5BxWOJF7p8nPkGU2EwcbPSbA3sh+6OjuNS6tUs16mYV2+rffhcXxeQ3vXlia2ZvIuQhhCEBa3kGviSC0l2wipD5YvFOgkTTXWnMDc6Bw61hKFXuHR6ZjAX6j6E9OuKc3RUDpK76P/gXiApOXcigVqUHUJF6i2kP1JhPbHLMIenKc55KR3EmPGl0ObZcJtbgriZVgnOhJrhkuqqLUHbV/KNX/Y1LF9biNGtqKDu6HaRCdu6L1RCjf96PiEq2xrd03JMEXYLh50n/PaD2A9XoaiOndWl3OxgPJ5NqsCfjCd3S7p3WGjjQGnXXvhf/riaDo3RW9/oFnvbNXjIqMl4MjtqjDq6a9SpWnIpUjg+O4ULfYXq+1rUPd6F4+/eqQhEfp/1jO2uByMtJqURbu0br+s9Xoi9sD/9eEmVe44u01XX5js1l7EpG3UbuNFN1altGMkzy7qPuxWJK75YoPlHGXvtj0un4d86uQom+vzVVLtLYVyQNLSBLStjKkZGZ4ZTx/yGL6+4GekC1Wh/OB6OGXU2fSGWqzTW10MiooJM8th6GbwQo+X+cH8LDy+Kneix3NuVxTq+EGrxNb7L9m7OCT8BIr0baourQvwLqbqqANClqjq8DLmvbTf0e649cwWLtwUqeoL9tfjDb+enDygTnfukSLl6MKhZvvz3fw3XYNAkcQ9/P054Wxoo9AoNNXY0fJhLvKZhg2fD3O9ZWOuShFvkuURr/aTF4cJwh5CKhXBc+o5DqAUkvOCxkIKihsg0cRvoBJ4dwocMXYaGtv5qaNyU4hIlBVuT+9WifXRW2lzNpV7ZCDjEpRWKxkOoMq4SIqxvIgJtgCtA5dAURlAj5AxpLYJuWjnDEwc5V3yBJDuCrrNSlILiA4yOS+vAall6lcFxITWNaGqDFGIaJj6vqOs2CLRKQwaDGcFmibAoRYo2gkSnCKG3IxNUCjFaBwXpIhL0E5FSSZ1c+QukCIJCU84SXNK709WR2J3hylLxEHSp76BxWGE0tevVSGoweG+Rbvi1UFdhVrQHHxtcfcDYCoeXT+sQWK1Wd6D/rM9zIhxlCsrgVjht1i33Qrg6G3SFND+CpBNU6PHTCYZWRqoTezf6aHWUoSxG5+gIIXZ0fHbq0/wz+PLLr/AauVGQ6VVAa1IalGtY1EeR58LNB7c1WRrm2gMvI48nAXw0a0Hrag9+yLj78stvFt7giuaMIaTIlMHgrIylSOCiKoTsYDCFl75IaoqjahqXcAUxgs04QWkpOHAoArcU6moIx2rtB3NhzkhgoHXP1zOj1993Z7NZe+aw1cgXSRblEi3Johc3RsBUUB3nMqPLRTitq0xlnMG5kBI+hB6BbDtOUyiq5ap18AVZqw7OKSBchms/zrSo3BDObrH4nbKgGgBT8qnHvqaSly4AVVpoQcPNalTcyI9aoPtaVGi1Zaka1TbuiCoxzZWESKwsblbDSPRWIu/nW4NzNHSgN7u9l0JUcPpYwxIIrb8H1lQfUNbiiS9fqgkBvSg/3pbjSwk0uX07P0ezFEk9n7onokeeeMQiJkWCymKnRDk+OXsNy8PhuPf0PyK4R69PX756c/6KlKFEGhxWlwCs0NblXHVOOsH260H46ODbivBZ4PZLd9OWcn9+wPjzA0bzAaOqs2jaMSokF76srlruUBJ/ZLe+aUzrzxeXEcu0dURyc0MQeW/kZkPLYeruK+XQarZz9ytcd74SLLksq479XtpqnN+SXtIPI4h2+xn3Iv/pu+rmnsFjvq9sdU5dmap1V6la2do3m0uaaoXSlHQMu8dJgkXX7jtNVa8zOXl1wfxgIOuXxFe+JK7+IOlbderXykEB+pdcvZXh5iaU25tNQx+27uWoDKypyUGXm83m/3NNJwQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,y={},g=[{value:"Document Types:",id:"document-types",level:3}];function j(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,s.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,s.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(c(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:0}},xml:{name:"document"},title:"document"}}},title:"inline_response_200_4"}}}},404:{description:"Report not available!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Report not available!"}},title:"inline_response_404_5"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.4db3ade4.js b/assets/js/62b755e6.4db3ade4.js new file mode 100644 index 000000000..455b620e2 --- /dev/null +++ b/assets/js/62b755e6.4db3ade4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9350],{30456:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/v1.1/getdocumentlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocumentlist","permalink":"/docs/API-docs/v1.1/getdocumentlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar_label":"Get Document list from status","hide_title":true,"hide_table_of_contents":true,"api":"eJztWc1uGzkSfpVa5rCJ0JZkW05mdRojk/V6NkiM2EGATQyB3V1SM2aTPSRbsmA0MId9gznNdR8tT7Iosv9ky46VGeQ0l8Qi658fi1XVN8zxhWXTj+wnnZQ5KmfZZcRStIkRhRNasSl78uQJNNtwsS7QTj+pd+iMwCUCBymsAz2HtBEBMbeYglbg1gV+Up/U/hAGg58Mn7tWkp0OBp8UAMBetwYu4w64QUhKY1A5uQahIPWc1nFX2iHJOyB5p2rvzOiFQWu/SWpRM3uJhyTxpc4LiQ7Tx8jL+BIhRlRgyyRBa+ellGtIWhkr4TLgUoLBX0phMAUrFoq70mDQOSGdr64Lv/dYjVjTc5V6l5QGqdUCDXBvhYgleulHPuaYSKF2dShtuOI1uAyhtGiGnxSLmC7QcMLFacqmbIGuOXQCAYtYwQ3P0aEhUN0wxXNkU5bqhJDAIiYIUAV3GbuNsosMPVw2keQ0mBppLGJNINnUmRIjZt1aknwrKOYsYnhdSJ0im865tESQZJhzNr1hXv+UWWeEWhClKnPCvYeWN6yBA4tYe4ZBpFdJ9oaosMuqilrfpMiFazz7pUSz3jC0MaS2dK5N3rez9qM1M+fXIifLjsbjqDFalXmMhlXEx72n0/1xzwR7JYo/zYL7dY6rS5JrC60sWqI9GI/pv82D7G4DtGjxMVUOlSN6XhRSJH5j9NkS081dA3T8GRMPKUNinAgqDdpSuh4dN4aTw8Jhbr/OH5YJvXcxQaHhbgMlje/snyfi6uAwzt7/TDGZC1rcTULmXGGno1G9Uho5THRO0pxwu4uz/g+6KiRCabezhEIit+iTUnvjvHNapmi+VygDhneTECwEz1p1AWSNF7PahSpieqU2fHmU/M/aJ0Lip+j4bPatgDN6+9l22hLUDwViq1mYcyG/Sh0j/lgvNFgrMq2+omZy9Pxg//CHF/tEvxLpAt0f8D/s7hZ/h9cu1tfeXr7Au2mpx96udLmxitj1jjwHk0kVsfWOXC9I1WpHpsMfqohlOzJNnhOWfYp9RMy/5U61Ma/6N8phXkjucHYe7sGswcODVP5SWlTpqXprNnNJrLVErvqq6QWqIpYY5A7TY/cwOg/GB4d7++O98YuL/efTyT+mR8+H4/H4Pyxi17nsvGcpd8j6yaH+XRbpd9GDiscSL3T5OPcNpsJg4mal2XqxHzo7Usel1KtZrlMxr99W+7BeXxeQ3c3hia2ZvI+QlhCEBa3kGviSC0l+wipD5YvFJgkTTX2mMDc6Bw6NhKE3uHR6ZjAX6j6EbNYV5+ioHKRw0f8hvEBScu5EAo0oO4Sa1HtIf6TCemKXYQ5PU5zzUjqIMeNLoc2z4bawBHEzrRKcCTXDJdVVWy7tppFv/LKvYfnaQoxuRQV1z7aLTNgufKESauO3EROisp3TG1aO6YbdwmHvCb/9IG5eV6Gojp01pdzsYDyeTeqLPxlP7pZ077DQxoHSrjvwv/15NR0ao7e+0R32tlvwkFOT8WR21Dp1dNepU7XkUqRwfHYKF/oK1ff1qK/eBfV3z1QEIr/PNpztrwcnLSalEW7tG6/rPV6IvbA//XhJlXuOLtN11+Y7NZexKRv1G7jRTd2pVYzkmWXTx/mc1Fawlqs01tdDXaCi+kjy2FJ9MeKFGC33h1Q43ObhRbETPZZ7u7JYxxdCLb7Gd9mF6pyOM5zYRsC6WqcQ/0Yqdurz6FPVDVeG3JeaFf2ea89cn9LbAhW9iP6MvfLb6eIDykTnPkdR6hwMGpYv//1fyzUYtDnVo9F3929LA4VeoaE+i2YBc4nX1Pt7Nsz9noW1Lkm4RZ5LtNYPPhwuDHcIqVgIx6VvAIRaQMILHgspCMREponbQO8e2CF8yNBlaGjr74amPykuURL221SsFt0bsNLmai71ykbAIS6tUDStQZVxlRBhcxIRaANcASqHpjCC+hJnyGoRbNPKGZ44yLniCyTZEfSDlaIUBFcwOi6tA6tl6U0Gx4XUNDFpHFKIaRjAvKIm2CDQKvX8BjOCzRJhUYoUbQSJThFCq0UuqBRitA4KskUk6AcUpZI6ufIHSCMgKDSlEMElPQN9G4ndGa4sveXBluYM2oAVRlP3XE+IBoP3FumEXwt1FUY3e/CxxdUHjK1wePm0uQKr1eoO9J9t8pwI968yBkqoVjht1h33QrisjP116QtpfwRJJ6jQ46d3GToZqU7s3dtHq6MMZTE6R0cIsaPjs1OfdZ/Bl19/g9fIjYJMrwJak9KgXMOiUUWRCycfwtYmTZhrD7yMIp4E8NHoA61rIvgh4+7Lr79beIMrGvuFK0WuDAZnZSxFAhd1XWIHgym89DVLW6vUw7GEK4gRbMYJSkvBgUMRuKVQV0M4Vms/JwtjPwIDrXu+DTc22u3+qDTrdA47i3zNYlEu0ZIsegBjBEwFlVUuM7pcBG19Y2rnDM6FlPAhlOzk23GaQlEv15W8r486c3BOF8JluPbTRYvKDeHsFovfKQt6kjGlmHrsa6pA6QBQpYUWNGusJ7et/KgDui8NhVZblurJaRuOqBbTHkm4ibXH7WqYUN5K5Jv51uAcDSn0bnfnUogaTh8bWAKh9Y/Amp5rylo88dVE3bDTi/LjbTn+ZUeT27fzczRLkTTjontu9MgTj1jEpEhQWexVDMcnZ69heTgcs6j3PD7ico9en7589eb8FRlDiTQEbH84Ho59H66ty7nqaTrBbpgfvgH4Kj9M6W+/dDddZfXX94S/vie03xPqOouGD6NCcuGr3LoDDhXqR3brE8O0+ZpwGbFMW0ckNzcEkfdGVhUthyE4Fa5159eNwa9w3RvaL7ks6wb6Xtp6ut6RXtIPI4h2u457kf/0XX1yz+Axnzu2BqepTNW6b1RjbBOb6pKGTKE0JRvD7nGSYNH3+06Ps9EonLy6YL5PzzZL4itfEtd/kPStNm3WysEA+pdCvZXh5iaU21XV0oetezlqBxtqCtBlVVX/B91O/0o=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"}}');var i=n(74848),r=n(28453),a=n(33617),l=n.n(a),o=n(17543),p=n.n(o),c=n(86013),d=n.n(c),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1uGzkSfpVa5rCJ0JZkW05mdRojk/V6NkiM2EGATQyB3V1SM2aTPSRbsmA0MId9gznNdR8tT7Iosv9ky46VGeQ0l8Qi658fi1XVN8zxhWXTj+wnnZQ5KmfZZcRStIkRhRNasSl78uQJNNtwsS7QTj+pd+iMwCUCBymsAz2HtBEBMbeYglbg1gV+Up/U/hAGg58Mn7tWkp0OBp8UAMBetwYu4w64QUhKY1A5uQahIPWc1nFX2iHJOyB5p2rvzOiFQWu/SWpRM3uJhyTxpc4LiQ7Tx8jL+BIhRlRgyyRBa+ellGtIWhkr4TLgUoLBX0phMAUrFoq70mDQOSGdr64Lv/dYjVjTc5V6l5QGqdUCDXBvhYgleulHPuaYSKF2dShtuOI1uAyhtGiGnxSLmC7QcMLFacqmbIGuOXQCAYtYwQ3P0aEhUN0wxXNkU5bqhJDAIiYIUAV3GbuNsosMPVw2keQ0mBppLGJNINnUmRIjZt1aknwrKOYsYnhdSJ0im865tESQZJhzNr1hXv+UWWeEWhClKnPCvYeWN6yBA4tYe4ZBpFdJ9oaosMuqilrfpMiFazz7pUSz3jC0MaS2dK5N3rez9qM1M+fXIifLjsbjqDFalXmMhlXEx72n0/1xzwR7JYo/zYL7dY6rS5JrC60sWqI9GI/pv82D7G4DtGjxMVUOlSN6XhRSJH5j9NkS081dA3T8GRMPKUNinAgqDdpSuh4dN4aTw8Jhbr/OH5YJvXcxQaHhbgMlje/snyfi6uAwzt7/TDGZC1rcTULmXGGno1G9Uho5THRO0pxwu4uz/g+6KiRCabezhEIit+iTUnvjvHNapmi+VygDhneTECwEz1p1AWSNF7PahSpieqU2fHmU/M/aJ0Lip+j4bPatgDN6+9l22hLUDwViq1mYcyG/Sh0j/lgvNFgrMq2+omZy9Pxg//CHF/tEvxLpAt0f8D/s7hZ/h9cu1tfeXr7Au2mpx96udLmxitj1jjwHk0kVsfWOXC9I1WpHpsMfqohlOzJNnhOWfYp9RMy/5U61Ma/6N8phXkjucHYe7sGswcODVP5SWlTpqXprNnNJrLVErvqq6QWqIpYY5A7TY/cwOg/GB4d7++O98YuL/efTyT+mR8+H4/H4Pyxi17nsvGcpd8j6yaH+XRbpd9GDiscSL3T5OPcNpsJg4mal2XqxHzo7Usel1KtZrlMxr99W+7BeXxeQ3c3hia2ZvI+QlhCEBa3kGviSC0l+wipD5YvFJgkTTX2mMDc6Bw6NhKE3uHR6ZjAX6j6EbNYV5+ioHKRw0f8hvEBScu5EAo0oO4Sa1HtIf6TCemKXYQ5PU5zzUjqIMeNLoc2z4bawBHEzrRKcCTXDJdVVWy7tppFv/LKvYfnaQoxuRQV1z7aLTNgufKESauO3EROisp3TG1aO6YbdwmHvCb/9IG5eV6Gojp01pdzsYDyeTeqLPxlP7pZ077DQxoHSrjvwv/15NR0ao7e+0R32tlvwkFOT8WR21Dp1dNepU7XkUqRwfHYKF/oK1ff1qK/eBfV3z1QEIr/PNpztrwcnLSalEW7tG6/rPV6IvbA//XhJlXuOLtN11+Y7NZexKRv1G7jRTd2pVYzkmWXTx/mc1Fawlqs01tdDXaCi+kjy2FJ9MeKFGC33h1Q43ObhRbETPZZ7u7JYxxdCLb7Gd9mF6pyOM5zYRsC6WqcQ/0Yqdurz6FPVDVeG3JeaFf2ea89cn9LbAhW9iP6MvfLb6eIDykTnPkdR6hwMGpYv//1fyzUYtDnVo9F3929LA4VeoaE+i2YBc4nX1Pt7Nsz9noW1Lkm4RZ5LtNYPPhwuDHcIqVgIx6VvAIRaQMILHgspCMREponbQO8e2CF8yNBlaGjr74amPykuURL221SsFt0bsNLmai71ykbAIS6tUDStQZVxlRBhcxIRaANcASqHpjCC+hJnyGoRbNPKGZ44yLniCyTZEfSDlaIUBFcwOi6tA6tl6U0Gx4XUNDFpHFKIaRjAvKIm2CDQKvX8BjOCzRJhUYoUbQSJThFCq0UuqBRitA4KskUk6AcUpZI6ufIHSCMgKDSlEMElPQN9G4ndGa4sveXBluYM2oAVRlP3XE+IBoP3FumEXwt1FUY3e/CxxdUHjK1wePm0uQKr1eoO9J9t8pwI968yBkqoVjht1h33QrisjP116QtpfwRJJ6jQ46d3GToZqU7s3dtHq6MMZTE6R0cIsaPjs1OfdZ/Bl19/g9fIjYJMrwJak9KgXMOiUUWRCycfwtYmTZhrD7yMIp4E8NHoA61rIvgh4+7Lr79beIMrGvuFK0WuDAZnZSxFAhd1XWIHgym89DVLW6vUw7GEK4gRbMYJSkvBgUMRuKVQV0M4Vms/JwtjPwIDrXu+DTc22u3+qDTrdA47i3zNYlEu0ZIsegBjBEwFlVUuM7pcBG19Y2rnDM6FlPAhlOzk23GaQlEv15W8r486c3BOF8JluPbTRYvKDeHsFovfKQt6kjGlmHrsa6pA6QBQpYUWNGusJ7et/KgDui8NhVZblurJaRuOqBbTHkm4ibXH7WqYUN5K5Jv51uAcDSn0bnfnUogaTh8bWAKh9Y/Amp5rylo88dVE3bDTi/LjbTn+ZUeT27fzczRLkTTjontu9MgTj1jEpEhQWexVDMcnZ69heTgcs6j3PD7ico9en7589eb8FRlDiTQEbH84Ho59H66ty7nqaTrBbpgfvgH4Kj9M6W+/dDddZfXX94S/vie03xPqOouGD6NCcuGr3LoDDhXqR3brE8O0+ZpwGbFMW0ckNzcEkfdGVhUthyE4Fa5159eNwa9w3RvaL7ks6wb6Xtp6ut6RXtIPI4h2u457kf/0XX1yz+Axnzu2BqepTNW6b1RjbBOb6pKGTKE0JRvD7nGSYNH3+06Ps9EonLy6YL5PzzZL4itfEtd/kPStNm3WysEA+pdCvZXh5iaU21XV0oetezlqBxtqCtBlVVX/B91O/0o=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,y={},j=[{value:"Document Types:",id:"document-types",level:3}];function g(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(p(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:0}},xml:{name:"document"},title:"document"}}},title:"inline_response_200_4"}}}},404:{description:"Report not available!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Report not available!"}},title:"inline_response_404_5"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.4abe84c3.js b/assets/js/6d2e526e.4abe84c3.js deleted file mode 100644 index 1de480eba..000000000 --- a/assets/js/6d2e526e.4abe84c3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5752],{50839:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>v,contentTitle:()=>f,default:()=>j,frontMatter:()=>x,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/v1.1/revokedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/revokedocument","permalink":"/docs/API-docs/v1.1/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WFFv4zYS/itzfLmuodhONm1xerp0u9gGt7cbbFIEuKwRUNJYYk2RLEnZMQwBfbh/cE/32p+2v+QwpCTLTjbXxfX6ktjkzHDm48zwG++Y56Vj6R37XudNjco7tkhYgS63wnihFUvZTYXwAdd6hVB0UnBxdQlcSr1xsNUNeA02SjiDuViKfC+6tLomITssuSlLmDZoOZ1wWbCURe1egCXMcMtr9GjJux1TvEaWsl7gXhQsYYK8M9xX7NjlK6vXokDQ2U+Y+8sC9HLv0OAsS5jFnxthsWCptw0mzPmtpIOcqI0kAXwwUhfI0iWXjgTyCmvO0h3zWxMkvRWqZAlbaltzP17BBx6spMxUZ1l1xl3B2nYRT0Xnv9PFlizlWnmKOt0xbowUecBl9pOjWHaPj4xREUiWUPQCHe1a5J3GsWt7R1jbJswLH74cgd62tGnRGa1cNHk2n9O/Q3D7VOlQLMA1eY7OLRspt39iye8VT395z0f03QMBa34wL1nwPrh04Z9XOpufvTw5nZ/Mv705/SY9/0v69TfT+Xz+D5awh1qSbp9w3CMbQRa/t8diXT49wrbD9PwpGK91jb4SqoQNgbmxWpUJGIncIXi7BV5yoUByj/Z3RBWt1fZ5dL7Ms3FGCSWFwvs+h+7P5/P70wGE82dySWkPS92o4o8N9anznw/o/P7lENDXjwO6VGsuRREa5I1eofpj4xkf7+Pxj7NVRKGwzw6CHa/HIB3mjRV+G7rwwwk34iTup3cLamWUKZo6uNEu9m1fsZTN+q4y2416dsvIoF33Xf2oIDa8LNH+0GTB/YvGa/i7zlcxxsZKlrLKe+PS2WwtrI+Wpi6qVU02zXU9u7KcGtE7vl5xO9MG1ex0Op/OWZvsjow4ropMP0xJyIlSSZ65YIMbMVufTk+f0OHGfJE8NidfquI8L4Uq/5veYn8515RAMUcOrmjIFG7E33DLkj4DxlLdO1ohL9CGbKG8/LB/ol732bV/YhiljVBLHc7o0ue9QXUtShVuL/h4/Czfosx1jfQC+wphMulVPv3z10FrMhme6lAm04/qo3rfWDB6g3bZSOCqgKXEB5FJDGpYh72BizjktUTn5BaE8lha7hEKUQrPJRCc1NtybngmpKDqIjEdScqoQN0Ubiv0FVra+rNF4FDgGiUVJfDG65p7MjVQi422qyWxogQ4ZI0TCp0DVBVXOQn2F5aAtsAVoPJojRUOwXlLXovom1be8txDzRUvkWwnMAarQCmojMDqrHEenJZNcBk8F1JbLKAPSCEWLoD4mriMRaDVXNfGYkXZtUYoG1GgSyDXBYIL100hqAIydB4M+SJydGS0UVLnq3CBVGhgNPU2wSWRrLGPpO4tV46YUccAuzsYADNWE3XA6OBk8qNDuuG3Qq1cOpl8VCdwN+TVLWZOeFx81VfKZrN5VCEvDnXeCE8N5QMa7YTXdrvXLoXvm8bYyPAlWnqDCkP+jGpmb6PQuXtcpLQ6q1Ca2TV6yhA3u7i6DM/BC/j0y7/gLXKroNKbmK15Y1FuoeyPIuTizUfYhm4OSx0SryLE85h8HZnsEbytuP/0y78dvMMNCNWVFIUymVw1mRQ53GBt6PF2k0kKryzSkb5fA19xDzlXkCG4ilMqrQUHDiZqS6FWU7hQW2gcWtgIX4VkoPWgdxAG4bIn/pBxhwVoFTT6M6d7j2i9dijX6MgWvcoZAhbCU0ZXVjdlPG3sTBecxaWQEm5FUaIPsV0UBZhueROXCfCRO7ikgvAVboFbBIfKT+HqSCXsNMZoS16I6PxS0/hDF4CqMFoo71IoLF/6vf1kn+g5wSy0emIpQsgHOJLOzHAlsRK7iIfV6Ufq3Uf9/rDfWlxiGLtC2Pt7MaJLp7s+LYGy9X9Ja3oQqGvxPNAcrLmQ8eH567GdQDnQ1u798hrtWuTYPX6fqehZEJ6xhEmRo3I4ojIXb67ewvrldH7AEH5Dcc/eXr56/e76NTlDjTQC1jOFwGZqrkYndRPw9/sR9QDr0RT3fxqYu6fc44OfGclFoG4h5l3Huu7YaIBOx7PyImEV8bP0ju12VIM/Wtm2tPxzg5bI3SJha24Fz+gpJ2omHH0uhsH3s9F+9aGboV/Abx67n4yl5yqKiMqayyYMrAlb4fZo9G8XbdITFnI2SryKLp3ckJ29hUeMmxhX1LjIczT+Wdkxxb16f33DEpZ1Y3sdfhdglm/ohwS+id7qAFEcyGltxyRXZcNLko02iWNREz8kaKtA0LoPFNWTeBwytxgG/aWgnlTY7SL5a9tBPm59VqMDtpemy1m0bfsf9lBkQA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"}}');var s=t(74848),i=t(28453),c=t(33617),r=t.n(c),a=t(17543),l=t.n(a),d=t(86013),p=t.n(d),m=t(63723),u=t.n(m),h=(t(18766),t(79329),t(9303));const x={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WFFv4zYS/itzfLmuodhONm1xerp0u9gGt7cbbFIEuKwRUNJYYk2RLEnZMQwBfbh/cE/32p+2v+QwpCTLTjbXxfX6ktjkzHDm48zwG++Y56Vj6R37XudNjco7tkhYgS63wnihFUvZTYXwAdd6hVB0UnBxdQlcSr1xsNUNeA02SjiDuViKfC+6tLomITssuSlLmDZoOZ1wWbCURe1egCXMcMtr9GjJux1TvEaWsl7gXhQsYYK8M9xX7NjlK6vXokDQ2U+Y+8sC9HLv0OAsS5jFnxthsWCptw0mzPmtpIOcqI0kAXwwUhfI0iWXjgTyCmvO0h3zWxMkvRWqZAlbaltzP17BBx6spMxUZ1l1xl3B2nYRT0Xnv9PFlizlWnmKOt0xbowUecBl9pOjWHaPj4xREUiWUPQCHe1a5J3GsWt7R1jbJswLH74cgd62tGnRGa1cNHk2n9O/Q3D7VOlQLMA1eY7OLRspt39iye8VT395z0f03QMBa34wL1nwPrh04Z9XOpufvTw5nZ/Mv705/SY9/0v69TfT+Xz+D5awh1qSbp9w3CMbQRa/t8diXT49wrbD9PwpGK91jb4SqoQNgbmxWpUJGIncIXi7BV5yoUByj/Z3RBWt1fZ5dL7Ms3FGCSWFwvs+h+7P5/P70wGE82dySWkPS92o4o8N9anznw/o/P7lENDXjwO6VGsuRREa5I1eofpj4xkf7+Pxj7NVRKGwzw6CHa/HIB3mjRV+G7rwwwk34iTup3cLamWUKZo6uNEu9m1fsZTN+q4y2416dsvIoF33Xf2oIDa8LNH+0GTB/YvGa/i7zlcxxsZKlrLKe+PS2WwtrI+Wpi6qVU02zXU9u7KcGtE7vl5xO9MG1ex0Op/OWZvsjow4ropMP0xJyIlSSZ65YIMbMVufTk+f0OHGfJE8NidfquI8L4Uq/5veYn8515RAMUcOrmjIFG7E33DLkj4DxlLdO1ohL9CGbKG8/LB/ol732bV/YhiljVBLHc7o0ue9QXUtShVuL/h4/Czfosx1jfQC+wphMulVPv3z10FrMhme6lAm04/qo3rfWDB6g3bZSOCqgKXEB5FJDGpYh72BizjktUTn5BaE8lha7hEKUQrPJRCc1NtybngmpKDqIjEdScqoQN0Ubiv0FVra+rNF4FDgGiUVJfDG65p7MjVQi422qyWxogQ4ZI0TCp0DVBVXOQn2F5aAtsAVoPJojRUOwXlLXovom1be8txDzRUvkWwnMAarQCmojMDqrHEenJZNcBk8F1JbLKAPSCEWLoD4mriMRaDVXNfGYkXZtUYoG1GgSyDXBYIL100hqAIydB4M+SJydGS0UVLnq3CBVGhgNPU2wSWRrLGPpO4tV46YUccAuzsYADNWE3XA6OBk8qNDuuG3Qq1cOpl8VCdwN+TVLWZOeFx81VfKZrN5VCEvDnXeCE8N5QMa7YTXdrvXLoXvm8bYyPAlWnqDCkP+jGpmb6PQuXtcpLQ6q1Ca2TV6yhA3u7i6DM/BC/j0y7/gLXKroNKbmK15Y1FuoeyPIuTizUfYhm4OSx0SryLE85h8HZnsEbytuP/0y78dvMMNCNWVFIUymVw1mRQ53GBt6PF2k0kKryzSkb5fA19xDzlXkCG4ilMqrQUHDiZqS6FWU7hQW2gcWtgIX4VkoPWgdxAG4bIn/pBxhwVoFTT6M6d7j2i9dijX6MgWvcoZAhbCU0ZXVjdlPG3sTBecxaWQEm5FUaIPsV0UBZhueROXCfCRO7ikgvAVboFbBIfKT+HqSCXsNMZoS16I6PxS0/hDF4CqMFoo71IoLF/6vf1kn+g5wSy0emIpQsgHOJLOzHAlsRK7iIfV6Ufq3Uf9/rDfWlxiGLtC2Pt7MaJLp7s+LYGy9X9Ja3oQqGvxPNAcrLmQ8eH567GdQDnQ1u798hrtWuTYPX6fqehZEJ6xhEmRo3I4ojIXb67ewvrldH7AEH5Dcc/eXr56/e76NTlDjTQC1jOFwGZqrkYndRPw9/sR9QDr0RT3fxqYu6fc44OfGclFoG4h5l3Huu7YaIBOx7PyImEV8bP0ju12VIM/Wtm2tPxzg5bI3SJha24Fz+gpJ2omHH0uhsH3s9F+9aGboV/Abx67n4yl5yqKiMqayyYMrAlb4fZo9G8XbdITFnI2SryKLp3ckJ29hUeMmxhX1LjIczT+Wdkxxb16f33DEpZ1Y3sdfhdglm/ohwS+id7qAFEcyGltxyRXZcNLko02iWNREz8kaKtA0LoPFNWTeBwytxgG/aWgnlTY7SL5a9tBPm59VqMDtpemy1m0bfsf9lBkQA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,v={},b=[];function k(e){const o={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,s.jsx)(r(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(o.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document revoked successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},revokedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"revoke"},title:"revoke"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.9f2d8c5b.js b/assets/js/6d2e526e.9f2d8c5b.js new file mode 100644 index 000000000..9a1fb7970 --- /dev/null +++ b/assets/js/6d2e526e.9f2d8c5b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5752],{50839:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>y,default:()=>x,frontMatter:()=>v,metadata:()=>n,toc:()=>g});const n=JSON.parse('{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/v1.1/revokedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/revokedocument","permalink":"/docs/API-docs/v1.1/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnOZDAxdpAxxg4MrMcwKKkkMaZIhqS63WgIyCFvkFOu+2jzJIsiJbW67XEy2GwudqtYVaz6qlg/W+Z55Vh6w77Vedug8o7dJqxAl1thvNCKpeyqRniPK32PUPRccHZxDlxKvXaw0S14DTZyOIO5KEW+Yy2tbojJjiQ3ZwnTBi2nG84LlrIoPTCwhBlueYMeLVm3ZYo3yFI2MNyJgiVMkHWG+5odmnxh9UoUCDr7EXN/XoAudwaNxrKEWfypFRYLlnrbYsKc30i6yInGSGLAByN1gSwtuXTEkNfYcJZumd+YwOmtUBVLWKltw/2Ugg88aEmZqU+y+oS7gnXdbbwVnf9GFxvSlGvlyet0y7gxUuQBl8WPjnzZPr4yekUgWULRC3R0apH3Eoem7QxhXZcwL3z4OAC96+jQojNauajyZLmkf/vgDqnSo1iAa/McnStbKTd/Y8mf5c8QvOc9+uaBgDXfmZcsWB9MOvPPC50sT14eHS+Plv+4Ov4qPf1n+uVX8+Vy+W+WsIdGkuyQcNwjm0AWv7tDtj6fHmHbY3r6FIyXukFfC1XBmsBcW62qBIxE7hC83QCvuFAguUf7J6KK1mr7PDqfZ9k0o4SSQuHdkEN3p8vl3fEIwukzuaS0h1K3qvhrXX3q/ucdOr17OTr05WOHztWKS1GEAnml71H9tf5Mr/fx+sfZKiJTOGd7zk7p0UmHeWuF34Qq/HDEjTiK5+nNLZUyyhRNFdxoF+u2r1nKFkNVWWwnNbtjpNCuhqreWslSVntvXLpYOK6KTD/MtUHlRKUkz9w8182CG7FYHc+PWZccynBjPosf26PPFXGeV0JVvyd3u8PqkuIZQ7aH2Bg4bsS/cMOSISBTrr6t1cgLtCF4lCbvdx3j9RDsXcVnFEWhSh3u6KP5zqC6FJUKuRBsPOyS1yhz3SA1RF8jzGaDyMdf/jNKzWZj5wxZO/+gPqh3rQWj12jLVgJXBZQSH0QmMYhhE87G0cAhbyQ6JzcglMfKco9QiEp4LoHgpFKTc8MzIQUlO7HpODNM3oubw3WNvkZLR3+3CBwKXKGkNwK89brhnlSNnX6t7X1JQ0oCHLLWCYXOAaqaq5wYh4AloC1wBag8WmOFQ3DektUi2qaVtzz30HDFKyTdCUzBKlAKymqwOmudB6dlG0wGz4XUFgsYHFKIhQsgvqbRwiIQNdeNsVhTdq0QqlYU6BLIdYHgQrjJBVVAhs6DIVtEjo6Utkrq/D4EkBowGE2lRnBJM8/URhL3litHg0o/kPUxGAEzVlMnx2jgbPaDQ4rwW6HuXTqbfVBHcDPm1TVmTni8/WJ4Kev1+tELebEv80b479oM3qPRTnhtNzvpSvi6zcKrmioZP6KmN6gw5M/kzex0FDp3jx8pURc1SrO4RE8Z4hZnF+ehOr+Ajz//Cm+RWwW1XsdszVuLcgPVcBUhFyMfYRuLK5Q6JF5NiOcx+frZbkDwuub+48+/Ofge1yBU/6TIldnsos2kyOEKG0O91M1mKbyySFf6gQa+5h5yriBDcDWnVFoJDhxMlJZC3c/hTG2gdWhhLXwdkoHoQW7PDcJlN4dDxh0WoFWQGO6c7ywieuNQrtCRLmqSGQIWwlNG11a3VbxtakzvnMVSSAnXoqjQB9/OigJMT15HMgE+MQdLehC+xg1wi+BQ+TlcHIiEk9YYbckKEY0vNW0jFABUhdFCeZdCYXnpd/qTXaLnBLPQ6glShJCPcCS9mjEk8SX2Ho/U+Qeq3Qf1fr/eWiwxbEHB7V1cjOjT6WZIS6Bs/V/SmhoCVS2eh6kDGy5kbDxfH+oJEwDaxr0rL9GuRI598/vEi14E5gVLmBQ5KoeTyeLszcVbWL2cL1ky6aJ/4HEv3p6/ev395WsyhgppBOx4vpwviUTDRcPV5KZ+If12tzHuYT1Zqv5P+2vfyj0++IWRXIRJKvi87YegGzbZZ9Pp6nqbsJrGpfSGbbf0Bn+wsuuI/FOLlmat24StuBU8o1Z+s2WFcPS7GPfQT3r7xft+pX0Bf3gLftKXYVZRNKisuGzD/piwe9wcbOLdbZcMAwsZGzleRZOOrkjPTsOjAZgmrihxludo/LO804nz4t3lFUtY1m/RTVjTmeVr2uv5OlqrA0RxPybalkmuqpZXxBt10oxFRXx/QLsPA1r/g7x6Eo/9yS26QX/JqScFtts4/HXdyB+PPinRAztwU3Buu677LzAfPJU=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"}}');var c=o(74848),s=o(28453),i=o(33617),r=o.n(i),d=o(17543),u=o.n(d),l=o(86013),a=o.n(l),p=o(63723),m=o.n(p),h=(o(18766),o(79329),o(9303));const v={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnOZDAxdpAxxg4MrMcwKKkkMaZIhqS63WgIyCFvkFOu+2jzJIsiJbW67XEy2GwudqtYVaz6qlg/W+Z55Vh6w77Vedug8o7dJqxAl1thvNCKpeyqRniPK32PUPRccHZxDlxKvXaw0S14DTZyOIO5KEW+Yy2tbojJjiQ3ZwnTBi2nG84LlrIoPTCwhBlueYMeLVm3ZYo3yFI2MNyJgiVMkHWG+5odmnxh9UoUCDr7EXN/XoAudwaNxrKEWfypFRYLlnrbYsKc30i6yInGSGLAByN1gSwtuXTEkNfYcJZumd+YwOmtUBVLWKltw/2Ugg88aEmZqU+y+oS7gnXdbbwVnf9GFxvSlGvlyet0y7gxUuQBl8WPjnzZPr4yekUgWULRC3R0apH3Eoem7QxhXZcwL3z4OAC96+jQojNauajyZLmkf/vgDqnSo1iAa/McnStbKTd/Y8mf5c8QvOc9+uaBgDXfmZcsWB9MOvPPC50sT14eHS+Plv+4Ov4qPf1n+uVX8+Vy+W+WsIdGkuyQcNwjm0AWv7tDtj6fHmHbY3r6FIyXukFfC1XBmsBcW62qBIxE7hC83QCvuFAguUf7J6KK1mr7PDqfZ9k0o4SSQuHdkEN3p8vl3fEIwukzuaS0h1K3qvhrXX3q/ucdOr17OTr05WOHztWKS1GEAnml71H9tf5Mr/fx+sfZKiJTOGd7zk7p0UmHeWuF34Qq/HDEjTiK5+nNLZUyyhRNFdxoF+u2r1nKFkNVWWwnNbtjpNCuhqreWslSVntvXLpYOK6KTD/MtUHlRKUkz9w8182CG7FYHc+PWZccynBjPosf26PPFXGeV0JVvyd3u8PqkuIZQ7aH2Bg4bsS/cMOSISBTrr6t1cgLtCF4lCbvdx3j9RDsXcVnFEWhSh3u6KP5zqC6FJUKuRBsPOyS1yhz3SA1RF8jzGaDyMdf/jNKzWZj5wxZO/+gPqh3rQWj12jLVgJXBZQSH0QmMYhhE87G0cAhbyQ6JzcglMfKco9QiEp4LoHgpFKTc8MzIQUlO7HpODNM3oubw3WNvkZLR3+3CBwKXKGkNwK89brhnlSNnX6t7X1JQ0oCHLLWCYXOAaqaq5wYh4AloC1wBag8WmOFQ3DektUi2qaVtzz30HDFKyTdCUzBKlAKymqwOmudB6dlG0wGz4XUFgsYHFKIhQsgvqbRwiIQNdeNsVhTdq0QqlYU6BLIdYHgQrjJBVVAhs6DIVtEjo6Utkrq/D4EkBowGE2lRnBJM8/URhL3litHg0o/kPUxGAEzVlMnx2jgbPaDQ4rwW6HuXTqbfVBHcDPm1TVmTni8/WJ4Kev1+tELebEv80b479oM3qPRTnhtNzvpSvi6zcKrmioZP6KmN6gw5M/kzex0FDp3jx8pURc1SrO4RE8Z4hZnF+ehOr+Ajz//Cm+RWwW1XsdszVuLcgPVcBUhFyMfYRuLK5Q6JF5NiOcx+frZbkDwuub+48+/Ofge1yBU/6TIldnsos2kyOEKG0O91M1mKbyySFf6gQa+5h5yriBDcDWnVFoJDhxMlJZC3c/hTG2gdWhhLXwdkoHoQW7PDcJlN4dDxh0WoFWQGO6c7ywieuNQrtCRLmqSGQIWwlNG11a3VbxtakzvnMVSSAnXoqjQB9/OigJMT15HMgE+MQdLehC+xg1wi+BQ+TlcHIiEk9YYbckKEY0vNW0jFABUhdFCeZdCYXnpd/qTXaLnBLPQ6glShJCPcCS9mjEk8SX2Ho/U+Qeq3Qf1fr/eWiwxbEHB7V1cjOjT6WZIS6Bs/V/SmhoCVS2eh6kDGy5kbDxfH+oJEwDaxr0rL9GuRI598/vEi14E5gVLmBQ5KoeTyeLszcVbWL2cL1ky6aJ/4HEv3p6/ev395WsyhgppBOx4vpwviUTDRcPV5KZ+If12tzHuYT1Zqv5P+2vfyj0++IWRXIRJKvi87YegGzbZZ9Pp6nqbsJrGpfSGbbf0Bn+wsuuI/FOLlmat24StuBU8o1Z+s2WFcPS7GPfQT3r7xft+pX0Bf3gLftKXYVZRNKisuGzD/piwe9wcbOLdbZcMAwsZGzleRZOOrkjPTsOjAZgmrihxludo/LO804nz4t3lFUtY1m/RTVjTmeVr2uv5OlqrA0RxPybalkmuqpZXxBt10oxFRXx/QLsPA1r/g7x6Eo/9yS26QX/JqScFtts4/HXdyB+PPinRAztwU3Buu677LzAfPJU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,k={},g=[];function f(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,c.jsx)(r(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,c.jsx)(t.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,c.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,c.jsx)(u(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,c.jsx)(a(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,c.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document revoked successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},revokedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"revoke"},title:"revoke"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.53514c64.js b/assets/js/7357a3c5.53514c64.js deleted file mode 100644 index ed90c611f..000000000 --- a/assets/js/7357a3c5.53514c64.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1665],{13980:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>G,frontMatter:()=>u,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/v1.1/getfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getfolder","permalink":"/docs/API-docs/v1.1/getfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar_label":"Get Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WM1u5LgRfpUKL9lpyN1tr2eT9CnGYuJ1Mpkx1l4YiKdhUFJJ4jRFcslStxsNAXvIG+SUax5tniQoqqX+sWcSJ4u52BbJKn71/9EbQbIMYnYv/mR1jl7ME5FjyLxypKwRM3FbIVwiQbcPF9dXILW2qwBr2wBZ8Ehe4RIhR5JKB5CpbQgkBIeZKlQGRRQdi0RYh16y4qtczESJ1G2JRDjpZY2EnsFshJE1ipnoth9ULhKhGI2TVIljiDb9iBld5WALGBR6/LlRHnMxI99gIgKtNasMqnYaRSLw0Wmbo5gVUgc+kFVYSzHbCFq7eJK8MqVIRGF9LWl/BR9l1DIT7ofTtMrOKpeKtp3ztcFZEzCworPplH8dog1NlmEIRaNhcIdIRGYNoSE+L53TKosbk4+BhTZP0XVGs+c8qyHVXdn74sV2VKdp9Xj20Yk22br9XYzBy9QYXPUhaGNQ0VCXOS+H9OczI8PrhbrGY13/K7LQpHvoMo+SML+g51TtBM+mZ9+enE5Ppr+7Pf1udv6H2evvxtPp9G8iEY+1ZtltsuaSIlJSpPe/G5d/hXv2FrZV4zGItuWN8+fy8MbWSJUyJazQEKy8NWUCTqMMCOTXIEupDGhJ6H/z6yUoem/9lz3xMmT7liujlcGHvggfzqfTh9PBCedPndC5CowlKGxj8vFXMPRLWfoUz5fNO3/4/WDe66fmXZml1CqPXfvWLtB83UDuX0/d9Qz1MJ1VdyjuiwNj99c7IwNmjVe0jjPi8UQ6ddLtz+7n3H05b+x2tMShQpWYiUnn1clmGCetYF1+2Y+bo8pYybJE/0OTRuQXDVn4q80WnXmN12ImKiIXZpPJUnnqNI1DJ1Y16Tiz9eTay6LR+p1cLqSfWIdmcjqejqeiTTZHSoI0eWofx3woqNJomYaoQzo1WZ6OT5+Rkc696Dw2Jy8VCSRLZcr/JDffxeWGc6dLj4PoDEkinfoLrkXSB3//1HbEVyhjg275u7BReJsS7x2aG1WaGJZ4+TEVuEOd2RqZl1CFMBr1Ip/+/q9BajSC3GZNjYZi6o8/mA/mfePB2RV6HszS5FBofFSpxiiGddwbSE9AWWsMQa9BGcLSS0LIValIamA/cffKpJOp0oorho9ZlvawV3RhDHcVUoWet37rESTkuETNhQayIVtLYlU9XlhZvyiYfiUgIW2CMhgCoKmkyfhgH4kErAdpAA2hd14FhECeUasOmzXkZUZQSyNLZN0J7DsrR624PsDbtAkEweomQgZmedZjDr1BBjEP0YlvmFN5BF7NbO08Vpw2S4SyUTmGBDKbI4TYINgEk0OKgcAxFpVhYKWN0TZbxAByBYGz3K+U1Ezw9jGyOHlpArfUDksfg8FhzlumW9gBHI1+CsgRfqvMIsxGow/mBO6HvLrDNCjC+Td9CaxWqyep/+pQ5lIRd4of0dmgyPr1TrpU1HeDfSXDR6fpEg3G/Nkrhp2O3GbhafXx6qRC7SY3SJwhYXJxfRVb/Cv49Ms/4C1Kb6Cyqy5bs8ajXkPZX8We6yLfuW3o0FDYmHgVezzrko+pNAbqPXhXSfr0yz8DvMMVKLMtKTZlNLpuUq0yuMXa8XgOo9EMvo88C6hfA6okQSYNpAihkpxKSyVBguuktTKLMVyYNTQBPawUVTEZeD3KHZjBfhnCHSCVAXOwJkr0d453iHi9DqiXGFgXT9oUAXNFnNGVt03Z3bYPZmucx0JpDXcqL5GibRd5Dm67vOqW2eF7cLDggqAK1yA9QkBDY7g+Eok7jXPWMwrVgS8sv7M4AGhyZ5WhMIPcy4J2+pNdokc6q6x5ZqlzoRzckWzVDCHpKnFr8bA6/sBN+aiRH/ZbjwV6vjCavYuLU9t0uu/TEjhb/5+0jpTdGpJZpC5YS6W7ifLHYz2RRqCvw/viBv1SZbidap+p6Ek8PBGJ0CpDE3CPnlxcXr+F5bfj6cHo/y+Ke/L26vs3727eMBhupJ3DegognA1US7N30+6VfTzWNjvO9uu+x7dTmfCRJk5LFQlYtHKzJU/3YnhRz3av8XkiKhuItzcbrrifvG5bXv65Qc/0bJ6IpfRKpjy4mWGpwH/nw3P7swZ+8+P25f4Knn3YP4u5pxeGucVS6oa/RCIWuD74N0I7b5OeYTCsbv8iy9DRnuQTXnxALi/f3IpEcJM8ZDaLyGy2f7D2Z1EdUp4OAP9k/vWswGbTsaa2Hc53W5+V2BrYn2YXzdu2/TfudEHy","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"}}');var r=o(74848),p=o(28453),n=o(33617),a=o.n(n),d=o(17543),s=o.n(d),l=o(86013),c=o.n(l),f=o(63723),h=o.n(f),m=(o(18766),o(79329),o(9303));const u={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WM1u5LgRfpUKL9lpyN1tr2eT9CnGYuJ1Mpkx1l4YiKdhUFJJ4jRFcslStxsNAXvIG+SUax5tniQoqqX+sWcSJ4u52BbJKn71/9EbQbIMYnYv/mR1jl7ME5FjyLxypKwRM3FbIVwiQbcPF9dXILW2qwBr2wBZ8Ehe4RIhR5JKB5CpbQgkBIeZKlQGRRQdi0RYh16y4qtczESJ1G2JRDjpZY2EnsFshJE1ipnoth9ULhKhGI2TVIljiDb9iBld5WALGBR6/LlRHnMxI99gIgKtNasMqnYaRSLw0Wmbo5gVUgc+kFVYSzHbCFq7eJK8MqVIRGF9LWl/BR9l1DIT7ofTtMrOKpeKtp3ztcFZEzCworPplH8dog1NlmEIRaNhcIdIRGYNoSE+L53TKosbk4+BhTZP0XVGs+c8qyHVXdn74sV2VKdp9Xj20Yk22br9XYzBy9QYXPUhaGNQ0VCXOS+H9OczI8PrhbrGY13/K7LQpHvoMo+SML+g51TtBM+mZ9+enE5Ppr+7Pf1udv6H2evvxtPp9G8iEY+1ZtltsuaSIlJSpPe/G5d/hXv2FrZV4zGItuWN8+fy8MbWSJUyJazQEKy8NWUCTqMMCOTXIEupDGhJ6H/z6yUoem/9lz3xMmT7liujlcGHvggfzqfTh9PBCedPndC5CowlKGxj8vFXMPRLWfoUz5fNO3/4/WDe66fmXZml1CqPXfvWLtB83UDuX0/d9Qz1MJ1VdyjuiwNj99c7IwNmjVe0jjPi8UQ6ddLtz+7n3H05b+x2tMShQpWYiUnn1clmGCetYF1+2Y+bo8pYybJE/0OTRuQXDVn4q80WnXmN12ImKiIXZpPJUnnqNI1DJ1Y16Tiz9eTay6LR+p1cLqSfWIdmcjqejqeiTTZHSoI0eWofx3woqNJomYaoQzo1WZ6OT5+Rkc696Dw2Jy8VCSRLZcr/JDffxeWGc6dLj4PoDEkinfoLrkXSB3//1HbEVyhjg275u7BReJsS7x2aG1WaGJZ4+TEVuEOd2RqZl1CFMBr1Ip/+/q9BajSC3GZNjYZi6o8/mA/mfePB2RV6HszS5FBofFSpxiiGddwbSE9AWWsMQa9BGcLSS0LIValIamA/cffKpJOp0oorho9ZlvawV3RhDHcVUoWet37rESTkuETNhQayIVtLYlU9XlhZvyiYfiUgIW2CMhgCoKmkyfhgH4kErAdpAA2hd14FhECeUasOmzXkZUZQSyNLZN0J7DsrR624PsDbtAkEweomQgZmedZjDr1BBjEP0YlvmFN5BF7NbO08Vpw2S4SyUTmGBDKbI4TYINgEk0OKgcAxFpVhYKWN0TZbxAByBYGz3K+U1Ezw9jGyOHlpArfUDksfg8FhzlumW9gBHI1+CsgRfqvMIsxGow/mBO6HvLrDNCjC+Td9CaxWqyep/+pQ5lIRd4of0dmgyPr1TrpU1HeDfSXDR6fpEg3G/Nkrhp2O3GbhafXx6qRC7SY3SJwhYXJxfRVb/Cv49Ms/4C1Kb6Cyqy5bs8ajXkPZX8We6yLfuW3o0FDYmHgVezzrko+pNAbqPXhXSfr0yz8DvMMVKLMtKTZlNLpuUq0yuMXa8XgOo9EMvo88C6hfA6okQSYNpAihkpxKSyVBguuktTKLMVyYNTQBPawUVTEZeD3KHZjBfhnCHSCVAXOwJkr0d453iHi9DqiXGFgXT9oUAXNFnNGVt03Z3bYPZmucx0JpDXcqL5GibRd5Dm67vOqW2eF7cLDggqAK1yA9QkBDY7g+Eok7jXPWMwrVgS8sv7M4AGhyZ5WhMIPcy4J2+pNdokc6q6x5ZqlzoRzckWzVDCHpKnFr8bA6/sBN+aiRH/ZbjwV6vjCavYuLU9t0uu/TEjhb/5+0jpTdGpJZpC5YS6W7ifLHYz2RRqCvw/viBv1SZbidap+p6Ek8PBGJ0CpDE3CPnlxcXr+F5bfj6cHo/y+Ke/L26vs3727eMBhupJ3DegognA1US7N30+6VfTzWNjvO9uu+x7dTmfCRJk5LFQlYtHKzJU/3YnhRz3av8XkiKhuItzcbrrifvG5bXv65Qc/0bJ6IpfRKpjy4mWGpwH/nw3P7swZ+8+P25f4Knn3YP4u5pxeGucVS6oa/RCIWuD74N0I7b5OeYTCsbv8iy9DRnuQTXnxALi/f3IpEcJM8ZDaLyGy2f7D2Z1EdUp4OAP9k/vWswGbTsaa2Hc53W5+V2BrYn2YXzdu2/TfudEHy",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,y={},g=[];function I(e){const t={p:"p",...(0,p.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,r.jsx)(a(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,r.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(s(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function G(e={}){const{wrapper:t}={...(0,p.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.6005cc6b.js b/assets/js/7357a3c5.6005cc6b.js new file mode 100644 index 000000000..f6a9ef0b3 --- /dev/null +++ b/assets/js/7357a3c5.6005cc6b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1665],{13980:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>g,default:()=>k,frontMatter:()=>m,metadata:()=>o,toc:()=>x});const o=JSON.parse('{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/v1.1/getfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getfolder","permalink":"/docs/API-docs/v1.1/getfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar_label":"Get Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uI7kRfpUKL9kR2pLs9WwSnWIsJl5nBzPG2gsD8QgGu7u6m2M2ySWrJQuCgD3kDXLKNY82TxIU+0ct2zOJk8VcbDXJKn5V9dUPt4JkGcTiVvzF6hy9WCYix5B55UhZIxbiukI4R4J2H84uL0BqbdcBNrYBsuCRvMIVQo4klQ4gU9sQSAgOM1WoDIooOhWJsA69ZMUXuViIEqndEolw0ssaCT2D2QojaxQL0W7fqVwkQjEaJ6kSjyHa9CNmdJGDLWBQ6PGXRnnMxYJ8g4kItNGsMqjaaRSJwAenbY5iUUgd+EBWYS3FYito4+JJ8sqUIhGF9bWk8Qo+yKhlIdwPx2mVnVQuFbvdkq8NzpqAgRWdzOf87xBtaLIMQygaDYM7RCIyawgN8XnpnFZZ3Jh9DCy0fYquNZo951kNqfbK3hcvtqM6TquHk49O7JLO7e9iDF6mxuC6D8EuBhUNtcx5OaS/nhgZXt+rS3ys639FFpp0hC7zKAnzM3pO1V7wZH7y7dHx/Gj+h+vj7xanf1q8/m46n8//JhLxUGuW7ciaS4pISZEefzcu/wr3jBa6rPEYxG7HG6fP8fDK1kiVMiWs0RCsvTVlAk6jDAjkNyBLqQxoSeh/99sRFL23/sueeBmyseXKaGXwrk/Cu9P5/O54cMLpUye0rgJjCQrbmHz6FQz9Ekuf4vmyead3fxzMe/3UvAuzklrlsWpf23s0XzeQ4+upvZ6hHtJZtYfivjgwdrzeGhkwa7yiTewRD0fSqaN2f3G75OrLvLFda4lNhSqxELPWq7Pt0E52gnX5Vd9uGq/FQlRELixmsyBNntqHqXVogiqNlmmYZraeSadmq+Ppsdglj2Wkcy86j83RS0UCyVKZ8j/JLfduuuJQttE6cNYQM+nUj7gRSR+L8amu41YoY73c8Xdho3AXofcOzZUqTYxvvPxxZ75BndkaeUygCmEy6UU+/f1fg9RkArnNmhoNRSZOP5gP5n3jwdk1eu6T0uRQaHxQqcYohnXcG2aQgLLWGILegDKEpZeEkKtSkdTAfuJikkknU6UVE5iPWZb2MMqBMIWbCqlCz1u/9wgSclyhZt6DbMjWklhVjxfW1t8XPA0lICFtgjIYAqCppMn4YB+JBKwHaQANoXdeBYRAnlGrFps15GVGUEsjS2TdCYydlaNWTFfwNm0CQbC6iZCBhy7rMYfeIIOYh+jENzzieARezWztPFZMmxVC2agcQwKZzRFCzFc2weSQYiBwjEVlGFhpY7TN7mMAi0ZrcJbLh5Ka560xRhYnL03gCtdi6WMwOMx5y9MPtgAnk58DcoTfKnMfFpPJB3MEtwOvbjANinD5TZ8C6/X6CfVfHcqcK/qhSeEndDYosn6zly4VVU0a02WsZPhoNZ2jwcifUTLsdeQ2C0+zj1dnFWo3u0JihoTZ2eVFrLiv4NOv/4C3KL2Byq5btmaNR72Bsr+KPddGvnXbUDChsJF4FXs8a8nHky0G6j14U0n69Os/A7zDNSjTpRSbMplcNqlWGVxj7bhbhslkAd/HsQeoXwOqJEEmDaQIoZJMpZWSIMG10lqZ+ymcmQ00AT2sFVWRDLwe5Q7MYL8M4Q6QyoA5WBMl+june0S8XgfUKwysixtfioC5ImZ05W1TtreNwXTGeSyU1nCj8hIp2naW5+C65XW7zA4fwcGCE4Iq3ID0CAENTeHykUjcaZyznlGoFnxh+dnDAUCTO6sMhQXkXha015/siR6nS2XNM0utC+XgjqRTM4SkzcTO4mF1+oGL8qNCflhvPRbo+cJo9j4uTnV0uu1pCczW/4fWcYK2hmQWJwmspdJtR/nzYz2xq6Ovw/viCv1KZdh1tc9k9CwenolEaJWhCTiaFs7OL9/C6tvpXCSj9vhfJPfs7cX3b95dvWEwXEhbhx1P59N5fF7YQLU0o5v2j97HbW27H6F+2+dx15UJH2jmtFRxHopWbrtZ5lYMD9zF/nG8TERlA/H2dssZ97PXux0v/9Kg52lpmYiV9Eqm3LhvtyJXgX/nw+v3swZ+81P3kH4Fz76zn8XcjxeGZ4uV1A1/iUTc4+bgVb9b7pJ+wmBY7f5ZlqGjkeSTMfVg1jt/cy0SwUXycLK5j5NN94O1P4vqcORpAfBfnr+eFdhu26lptxvOt1uflegM7E+zi5a73e7f5nsaRw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"}}');var s=n(74848),i=n(28453),a=n(33617),d=n.n(a),l=n(17543),r=n.n(l),p=n(86013),c=n.n(p),f=n(63723),h=n.n(f),u=(n(18766),n(79329),n(9303));const m={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uI7kRfpUKL9kR2pLs9WwSnWIsJl5nBzPG2gsD8QgGu7u6m2M2ySWrJQuCgD3kDXLKNY82TxIU+0ct2zOJk8VcbDXJKn5V9dUPt4JkGcTiVvzF6hy9WCYix5B55UhZIxbiukI4R4J2H84uL0BqbdcBNrYBsuCRvMIVQo4klQ4gU9sQSAgOM1WoDIooOhWJsA69ZMUXuViIEqndEolw0ssaCT2D2QojaxQL0W7fqVwkQjEaJ6kSjyHa9CNmdJGDLWBQ6PGXRnnMxYJ8g4kItNGsMqjaaRSJwAenbY5iUUgd+EBWYS3FYito4+JJ8sqUIhGF9bWk8Qo+yKhlIdwPx2mVnVQuFbvdkq8NzpqAgRWdzOf87xBtaLIMQygaDYM7RCIyawgN8XnpnFZZ3Jh9DCy0fYquNZo951kNqfbK3hcvtqM6TquHk49O7JLO7e9iDF6mxuC6D8EuBhUNtcx5OaS/nhgZXt+rS3ys639FFpp0hC7zKAnzM3pO1V7wZH7y7dHx/Gj+h+vj7xanf1q8/m46n8//JhLxUGuW7ciaS4pISZEefzcu/wr3jBa6rPEYxG7HG6fP8fDK1kiVMiWs0RCsvTVlAk6jDAjkNyBLqQxoSeh/99sRFL23/sueeBmyseXKaGXwrk/Cu9P5/O54cMLpUye0rgJjCQrbmHz6FQz9Ekuf4vmyead3fxzMe/3UvAuzklrlsWpf23s0XzeQ4+upvZ6hHtJZtYfivjgwdrzeGhkwa7yiTewRD0fSqaN2f3G75OrLvLFda4lNhSqxELPWq7Pt0E52gnX5Vd9uGq/FQlRELixmsyBNntqHqXVogiqNlmmYZraeSadmq+Ppsdglj2Wkcy86j83RS0UCyVKZ8j/JLfduuuJQttE6cNYQM+nUj7gRSR+L8amu41YoY73c8Xdho3AXofcOzZUqTYxvvPxxZ75BndkaeUygCmEy6UU+/f1fg9RkArnNmhoNRSZOP5gP5n3jwdk1eu6T0uRQaHxQqcYohnXcG2aQgLLWGILegDKEpZeEkKtSkdTAfuJikkknU6UVE5iPWZb2MMqBMIWbCqlCz1u/9wgSclyhZt6DbMjWklhVjxfW1t8XPA0lICFtgjIYAqCppMn4YB+JBKwHaQANoXdeBYRAnlGrFps15GVGUEsjS2TdCYydlaNWTFfwNm0CQbC6iZCBhy7rMYfeIIOYh+jENzzieARezWztPFZMmxVC2agcQwKZzRFCzFc2weSQYiBwjEVlGFhpY7TN7mMAi0ZrcJbLh5Ka560xRhYnL03gCtdi6WMwOMx5y9MPtgAnk58DcoTfKnMfFpPJB3MEtwOvbjANinD5TZ8C6/X6CfVfHcqcK/qhSeEndDYosn6zly4VVU0a02WsZPhoNZ2jwcifUTLsdeQ2C0+zj1dnFWo3u0JihoTZ2eVFrLiv4NOv/4C3KL2Byq5btmaNR72Bsr+KPddGvnXbUDChsJF4FXs8a8nHky0G6j14U0n69Os/A7zDNSjTpRSbMplcNqlWGVxj7bhbhslkAd/HsQeoXwOqJEEmDaQIoZJMpZWSIMG10lqZ+ymcmQ00AT2sFVWRDLwe5Q7MYL8M4Q6QyoA5WBMl+june0S8XgfUKwysixtfioC5ImZ05W1TtreNwXTGeSyU1nCj8hIp2naW5+C65XW7zA4fwcGCE4Iq3ID0CAENTeHykUjcaZyznlGoFnxh+dnDAUCTO6sMhQXkXha015/siR6nS2XNM0utC+XgjqRTM4SkzcTO4mF1+oGL8qNCflhvPRbo+cJo9j4uTnV0uu1pCczW/4fWcYK2hmQWJwmspdJtR/nzYz2xq6Ovw/viCv1KZdh1tc9k9CwenolEaJWhCTiaFs7OL9/C6tvpXCSj9vhfJPfs7cX3b95dvWEwXEhbhx1P59N5fF7YQLU0o5v2j97HbW27H6F+2+dx15UJH2jmtFRxHopWbrtZ5lYMD9zF/nG8TERlA/H2dssZ97PXux0v/9Kg52lpmYiV9Eqm3LhvtyJXgX/nw+v3swZ+81P3kH4Fz76zn8XcjxeGZ4uV1A1/iUTc4+bgVb9b7pJ+wmBY7f5ZlqGjkeSTMfVg1jt/cy0SwUXycLK5j5NN94O1P4vqcORpAfBfnr+eFdhu26lptxvOt1uflegM7E+zi5a73e7f5nsaRw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,j={},x=[];function y(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,s.jsx)(d(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(r(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.04d03f97.js b/assets/js/7ad5624c.04d03f97.js new file mode 100644 index 000000000..8a6969ffd --- /dev/null +++ b/assets/js/7ad5624c.04d03f97.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[33],{82903:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>C,contentTitle:()=>x,default:()=>Q,frontMatter:()=>h,metadata:()=>o,toc:()=>g});const o=JSON.parse('{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/v1.1/getcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcontact","permalink":"/docs/API-docs/v1.1/getcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar_label":"Get Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WF9v4zYS/ypzfGnXUPwnm7aonhosFmnQRTfYpAjQrBFQ0lhiQpEsObJjGAb60G9wT/d6H20/yWEoyZaTbO9yLRYIEns4M/zN/2E2gmQZRHoj3lhDMqcg5okoMOReOVLWiFRcVQhnSNBxwOnFOUit7SrA2jZAFjySV7hEKJCk0gFkZhsCCcFhrhYqh7yVHYtEWIdesurzQqSiROrORCKc9LJGQs+INsLIGkUquvNbVYhEKEbkJFXiMUyb3WFO5wXYBexVevytUR4LkZJvMBGB1pqVBlU7jSIR+OC0LVCkC6kDM+QV1lKkG0FrFznJK1OKRCysryUNKfggo5ZUuB9nWZUfVy4T2+2crw3OmoCBFR1Pp/znEG5o8hxDWDQadh4RSTQWDTG/dE6rPB5M7gILbZ6ia61m33lWQ6q9snfGi+2oZln1cHznxDbp/P8yBXcWIUNkcayl0v+HfIb4Q0cY57ZmVa6y5sVQTmavZ8fxh1XktnbSrF+qxDo0QZWGVdzZ7JYU6RcjKXAZIXiUhMUpPSe/5z6eHr8+mk2Ppt9dzb5NT75Pv/l2PJ1OfxWJeKijQ7vCKCRFR3eYdt8bV3yBe7aP2bqi63rAUKAvx+2WpU6eK4dLWyNVypSwQkOw8taUCTiNMiCQX4MspTKgJaH/x99XJ+i99X/uppch2w7MVkYrg7d9L7g9mU5vZzsnnDx1Qt9hjSVY2MYUX9bSZ67/c3NObo935nzz1Jxzs5RaFXFgXNl7NF/WnOH11F7/NGlVyxTPxYGxQ3prZMC88YrWcTg9HEmnjtrz9GbOTZ/zxHZDLU4zqkQqJl32Tzb7QbYVrM0v+0nXeC1SURG5kE4mQZoisw/jvvdomQXuhBPp1GQ5G3M/eywjnXsRPzZHLxUJJEtlyv8mN9876pKD2cbrwF27qEmnfsK16EfNAVc36yuUBfoYOWUWNgp3MXrv0Fyq0sQIx8sf7wTXqHNbI+8oVCGMRr3Ipz/+vZMajaCweVOjoZiL44/mo3nfeHB2hZ4HtDQFLDQ+qExjFMM6nu0WoICy1hiCXoMyhKWXhFCoUpHUwH7i9pFLJzOlFacws1mW9jCogjCG6wqpQs9HX3kECQUuUXPmg2zI1pJYVY8XVtbfL3gVS0BC1gRlMARAU0mTM2MfiQSsB2kADaF3XgWEQJ5RqxabNeS59mtpZImsO4GhswrUitMVvM2aQBCsbiJk4G5vPRbQG2QQixCd+JZ3K4/AVJ6/HitOmyVC2agCQwK5LRBCrFg2wRSQYSBwjEXlGFhpY7TN72MAF43W4Cw3ECU1b3pDjCxOXprAs7jF0sdg5zDnLa9d2AIcjX4JyBF+p8x9SEejj+YIbnZ5dY1ZUITzr/sSWK1WT1L/1aHMmaIfmww+oLNBkfXrvXSpqGqyWC5DJbsvraYzNBjzZ1AMex2FzcPT6mPqpELtJpdInCFhcnpxHnvuK/j0+z/hHUpvoLKrNlvzxqNeQ9lfxZ5rI9+6bdcyYWFj4lXs8bxNPl6pMVDvwetK0qff/xXgZ1yBMl1JsSmj0UWTaZXDFdaO52MYjVJ4E7cgoJ4GVEmCXBrIEEIlOZWWSoIE10prZe7HcGrW0AT0sFJUxWRgepQ7MIP9sgt3gEwGLMCaKNHfOd4jYnodUC8xsC4efRkCFoo4oytvm7K9bQimM87jQmkN16ookaJtp0UBriOvWjI7fAAHF1wQVOEapEcIaGgMF49E4knjnPWMQrXgF5bfXBwANIWzylBIofByQXv9yT7R47KprHmG1LpQ7tyRdGp2IWkrsbN4Rx1/5Kb8qJEf9luPC/R8YTR7HxenunS66dMSOFv/Slq3O327V/I+0D42eKL88FhPnOvo6/B+cYl+qXLsptpnKnoSmSciEVrlaAIO9oXTs4t3sHw9nopkMB7/h+KevDt/8/bny7cMhhtp67DZeDqexheODVRLM7hp8OR+PNc2+y3q736dd4OZ8IEmTksVl6Jo6KZbaG7E/nWdDt7m80RUNhAzbDZcdr94vd0y+bcGPS9N80QspVcy4+l9sxGFCvy52L29P2vk1x+6Z/wreP6Z/yzsfskwvGEspW74m0jEPa4P/62wnW+TftFgYC3DaZ6jo4Hok331YOk7e3slEsG98nDBuY8LTveBtT8L63DzaQHwb17DnhXYbNrlabvd8bdHn5XoDOy52Ufz7Xb7H90WRuY=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"}}');var a=n(74848),s=n(28453),i=n(33617),p=n.n(i),c=n(17543),r=n.n(c),l=n(86013),d=n.n(l),m=n(63723),b=n.n(m),y=(n(18766),n(79329),n(9303));const h={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WF9v4zYS/ypzfGnXUPwnm7aonhosFmnQRTfYpAjQrBFQ0lhiQpEsObJjGAb60G9wT/d6H20/yWEoyZaTbO9yLRYIEns4M/zN/2E2gmQZRHoj3lhDMqcg5okoMOReOVLWiFRcVQhnSNBxwOnFOUit7SrA2jZAFjySV7hEKJCk0gFkZhsCCcFhrhYqh7yVHYtEWIdesurzQqSiROrORCKc9LJGQs+INsLIGkUquvNbVYhEKEbkJFXiMUyb3WFO5wXYBexVevytUR4LkZJvMBGB1pqVBlU7jSIR+OC0LVCkC6kDM+QV1lKkG0FrFznJK1OKRCysryUNKfggo5ZUuB9nWZUfVy4T2+2crw3OmoCBFR1Pp/znEG5o8hxDWDQadh4RSTQWDTG/dE6rPB5M7gILbZ6ia61m33lWQ6q9snfGi+2oZln1cHznxDbp/P8yBXcWIUNkcayl0v+HfIb4Q0cY57ZmVa6y5sVQTmavZ8fxh1XktnbSrF+qxDo0QZWGVdzZ7JYU6RcjKXAZIXiUhMUpPSe/5z6eHr8+mk2Ppt9dzb5NT75Pv/l2PJ1OfxWJeKijQ7vCKCRFR3eYdt8bV3yBe7aP2bqi63rAUKAvx+2WpU6eK4dLWyNVypSwQkOw8taUCTiNMiCQX4MspTKgJaH/x99XJ+i99X/uppch2w7MVkYrg7d9L7g9mU5vZzsnnDx1Qt9hjSVY2MYUX9bSZ67/c3NObo935nzz1Jxzs5RaFXFgXNl7NF/WnOH11F7/NGlVyxTPxYGxQ3prZMC88YrWcTg9HEmnjtrz9GbOTZ/zxHZDLU4zqkQqJl32Tzb7QbYVrM0v+0nXeC1SURG5kE4mQZoisw/jvvdomQXuhBPp1GQ5G3M/eywjnXsRPzZHLxUJJEtlyv8mN9876pKD2cbrwF27qEmnfsK16EfNAVc36yuUBfoYOWUWNgp3MXrv0Fyq0sQIx8sf7wTXqHNbI+8oVCGMRr3Ipz/+vZMajaCweVOjoZiL44/mo3nfeHB2hZ4HtDQFLDQ+qExjFMM6nu0WoICy1hiCXoMyhKWXhFCoUpHUwH7i9pFLJzOlFacws1mW9jCogjCG6wqpQs9HX3kECQUuUXPmg2zI1pJYVY8XVtbfL3gVS0BC1gRlMARAU0mTM2MfiQSsB2kADaF3XgWEQJ5RqxabNeS59mtpZImsO4GhswrUitMVvM2aQBCsbiJk4G5vPRbQG2QQixCd+JZ3K4/AVJ6/HitOmyVC2agCQwK5LRBCrFg2wRSQYSBwjEXlGFhpY7TN72MAF43W4Cw3ECU1b3pDjCxOXprAs7jF0sdg5zDnLa9d2AIcjX4JyBF+p8x9SEejj+YIbnZ5dY1ZUITzr/sSWK1WT1L/1aHMmaIfmww+oLNBkfXrvXSpqGqyWC5DJbsvraYzNBjzZ1AMex2FzcPT6mPqpELtJpdInCFhcnpxHnvuK/j0+z/hHUpvoLKrNlvzxqNeQ9lfxZ5rI9+6bdcyYWFj4lXs8bxNPl6pMVDvwetK0qff/xXgZ1yBMl1JsSmj0UWTaZXDFdaO52MYjVJ4E7cgoJ4GVEmCXBrIEEIlOZWWSoIE10prZe7HcGrW0AT0sFJUxWRgepQ7MIP9sgt3gEwGLMCaKNHfOd4jYnodUC8xsC4efRkCFoo4oytvm7K9bQimM87jQmkN16ookaJtp0UBriOvWjI7fAAHF1wQVOEapEcIaGgMF49E4knjnPWMQrXgF5bfXBwANIWzylBIofByQXv9yT7R47KprHmG1LpQ7tyRdGp2IWkrsbN4Rx1/5Kb8qJEf9luPC/R8YTR7HxenunS66dMSOFv/Slq3O327V/I+0D42eKL88FhPnOvo6/B+cYl+qXLsptpnKnoSmSciEVrlaAIO9oXTs4t3sHw9nopkMB7/h+KevDt/8/bny7cMhhtp67DZeDqexheODVRLM7hp8OR+PNc2+y3q736dd4OZ8IEmTksVl6Jo6KZbaG7E/nWdDt7m80RUNhAzbDZcdr94vd0y+bcGPS9N80QspVcy4+l9sxGFCvy52L29P2vk1x+6Z/wreP6Z/yzsfskwvGEspW74m0jEPa4P/62wnW+TftFgYC3DaZ6jo4Hok331YOk7e3slEsG98nDBuY8LTveBtT8L63DzaQHwb17DnhXYbNrlabvd8bdHn5XoDOy52Ufz7Xb7H90WRuY=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,C={},g=[];function v(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,a.jsx)(p(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,a.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(r(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function Q(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.5cd13f3b.js b/assets/js/7ad5624c.5cd13f3b.js deleted file mode 100644 index f8e5c34e3..000000000 --- a/assets/js/7ad5624c.5cd13f3b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[33],{82903:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>f,default:()=>y,frontMatter:()=>g,metadata:()=>a,toc:()=>I});const a=JSON.parse('{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/v1.1/getcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcontact","permalink":"/docs/API-docs/v1.1/getcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar_label":"Get Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WNtuIzcS/ZVavmxGaOvicbJYPcUYDBxjZ2eM2IGB9QgGu7vUTZtNMmS1ZEFoIA/5gzzlNZ82X7Iodrdu1mTXSTCAIUtkVfFUsS6ney1IFkFM78Qba0hmFMQsETmGzCtHyhoxFTclwgUSdBJwfnUJUmu7DLCyNZAFj+QVLhByJKl0AJnamkBCcJipucoga3WHIhHWoZds+jIXU1EgdXsiEU56WSGhZ0RrYWSFYiq6/XuVi0QoRuQkleIQpk0fMKPLHOwctiY9/lgrj7mYkq8xEYFWmo0GVTmNIhH45LTNUUznUgcWyEqspJiuBa1clCSvTCESMbe+krS7gk8yWpkK990kLbPT0qWiaWZ8bHDWBAxs6HQ85n/7cEOdZRjCvNawiYhIorNoiOWlc1plcWP0EFhp/Rxd6zXHzrMZUu2RfTBe7Ec5Scun0wcnmqSL/8sMPFiEFJHVsZJK/wH9FPHbbmGY2YpNudKaF0M5m7yenMY/NpHZykmzeqkR69AEVRg28WDTe1KkX4wkx0WE4FES5ud0TH8rfTo+fX0yGZ+M/3Ez+WZ69s/p198Mx+Pxf0QinqoY0K4wckkx0B2mze/a5V/gnOZQrCu6rgfsKvTl2DSsdXasHK5thVQqU8ASDcHSW1Mk4DTKgEB+BbKQyoCWhP5vf12doPfW/36YXoas2XFbGa0M3ve94P5sPL6fbIJw9jwIfYc1lmBua5N/WU+PHP/77pzdn27c+fq5O5dmIbXK48C4sY9ovqw7u8dTe/zzpFWtUNwXe87urrdOBsxqr2gVh9PTiXTqpN2f3s246XOe2G6oxWlGpZiKUZf9o/V2kDWCrflFP+kOamEpiwL9d3UasZ/XZOHfNntsHay9FlNRErkwHY0WylNraRhatbJOuW2Orryc11q/l4tH6Ufcx0aT4Xg4Fk2yPjASpMlT+zTsm52WaYg2pFOjxWQ4OaIjnXuRPNYnL1UJJAtliv+lN9vezDVnT5sge/ezSRPp1L9wJfrZtifVkYsSZY4+pooycxuVu6T44NBcq8LEa4mHH5KQW9SZrZBJEZUIg0Gv8unn3zZagwHkNqsrNBSTf/jRfDQfag/OLtEzI5Amh7nGJ5VqjGpYxb0N4wooK40h6BUoQ1h4SQi5KhRJDRwn7leZdDJVWnHNsJhlbQ87ZReGcFsileh56+8eQUKOC9RcaiBrspUkNtXjhaX1j3PmfglISOugDIYAaEppMhbsbyIB60EaQEPonVcBIZBn1KrFZg15bjaVNLJAtp3AbrBy1IrrA7xN60AQrK4jZODxYj3m0DtkEPMQg/iWyZxH4FUe+B5LTpsFQlGrHEMCmc0RQmwR7ILJIcVA4BiLyjCw0dpomz3GC+QKAme5YympmVruYmR18tIEHv4tlv4ONgFz3jLPwxbgYPBDQL7hd8o8hulg8NGcwN0mr24xDYpw9lVfAsvl8lnqv9rXuVDEneJ7dDYosn611S4U9d1g18jmR2vpAg3G/Nkphq2N3GbhefXx6qhE7UbXSJwhYXR+dRmb/Cv49NMv8A6lN1DaZZutWe1Rr6Doj+LItTffhm3To2FuY+KVHPGsTT7m8Bioj+BtKenTT78GeI9LUKYrKXZlMLiqU60yuMHK8UAOg8EU3kTaBdSvAZWSIJMGUoRQSk6lhZIgwbXaWpnHIZybFdQBPSwVlTEZeD3q7bnBcdlcd4BUBszBmqjRnzncIuL1KqBeYGBbPGtTBMwVcUaX3tZFe9oumM45j3OlNdyqvECKvp3nObhuedkuc8B34OCcC4JKXIH0CAENDeHqQCXu1M5ZzyhUC35u+SGPLwBN7qwyFKaQezmnrf1km+iR3Sprjiy1IZSbcCSdmc2VtJXYebxZHX7kpnzQyPf7rcc5ej4wur29F6e6dLrr0xI4W/9MWrcPES2RZQLSPt3wRPn20E4kEuir8GF+jX6hMuym2mcqehSFRyIRWmVoAu4QlPOLq3eweD0c743+/6O4R+8u37x9f/2WwXAjbQPWUwDhbKBKmp2Tdp7xD+faekvb/urXAd1gJnyikdNSRRYWHV13DOpObB/npzsvA2aJKG0gFlivuex+8LppePnHGj2ztFkiFtIrmfL0ZpqlAn/PNw/7n3Xyq++79wav4Ph7haOwe5JhmGEspK75l0jEI67232M0sybpiQYDawXOswwd7ag+I8h7LPPi7Y1IBPfKfYLzGAlO94WtH4W1z3xaAPzJNOyownrdkqem2ci3W5/V6BzspTlGs6Zp/gtUB26R","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"}}');var o=n(74848),c=n(28453),i=n(33617),s=n.n(i),r=n(17543),p=n.n(r),l=n(86013),d=n.n(l),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const g={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WNtuIzcS/ZVavmxGaOvicbJYPcUYDBxjZ2eM2IGB9QgGu7vUTZtNMmS1ZEFoIA/5gzzlNZ82X7Iodrdu1mTXSTCAIUtkVfFUsS6ney1IFkFM78Qba0hmFMQsETmGzCtHyhoxFTclwgUSdBJwfnUJUmu7DLCyNZAFj+QVLhByJKl0AJnamkBCcJipucoga3WHIhHWoZds+jIXU1EgdXsiEU56WSGhZ0RrYWSFYiq6/XuVi0QoRuQkleIQpk0fMKPLHOwctiY9/lgrj7mYkq8xEYFWmo0GVTmNIhH45LTNUUznUgcWyEqspJiuBa1clCSvTCESMbe+krS7gk8yWpkK990kLbPT0qWiaWZ8bHDWBAxs6HQ85n/7cEOdZRjCvNawiYhIorNoiOWlc1plcWP0EFhp/Rxd6zXHzrMZUu2RfTBe7Ec5Scun0wcnmqSL/8sMPFiEFJHVsZJK/wH9FPHbbmGY2YpNudKaF0M5m7yenMY/NpHZykmzeqkR69AEVRg28WDTe1KkX4wkx0WE4FES5ud0TH8rfTo+fX0yGZ+M/3Ez+WZ69s/p198Mx+Pxf0QinqoY0K4wckkx0B2mze/a5V/gnOZQrCu6rgfsKvTl2DSsdXasHK5thVQqU8ASDcHSW1Mk4DTKgEB+BbKQyoCWhP5vf12doPfW/36YXoas2XFbGa0M3ve94P5sPL6fbIJw9jwIfYc1lmBua5N/WU+PHP/77pzdn27c+fq5O5dmIbXK48C4sY9ovqw7u8dTe/zzpFWtUNwXe87urrdOBsxqr2gVh9PTiXTqpN2f3s246XOe2G6oxWlGpZiKUZf9o/V2kDWCrflFP+kOamEpiwL9d3UasZ/XZOHfNntsHay9FlNRErkwHY0WylNraRhatbJOuW2Orryc11q/l4tH6Ufcx0aT4Xg4Fk2yPjASpMlT+zTsm52WaYg2pFOjxWQ4OaIjnXuRPNYnL1UJJAtliv+lN9vezDVnT5sge/ezSRPp1L9wJfrZtifVkYsSZY4+pooycxuVu6T44NBcq8LEa4mHH5KQW9SZrZBJEZUIg0Gv8unn3zZagwHkNqsrNBSTf/jRfDQfag/OLtEzI5Amh7nGJ5VqjGpYxb0N4wooK40h6BUoQ1h4SQi5KhRJDRwn7leZdDJVWnHNsJhlbQ87ZReGcFsileh56+8eQUKOC9RcaiBrspUkNtXjhaX1j3PmfglISOugDIYAaEppMhbsbyIB60EaQEPonVcBIZBn1KrFZg15bjaVNLJAtp3AbrBy1IrrA7xN60AQrK4jZODxYj3m0DtkEPMQg/iWyZxH4FUe+B5LTpsFQlGrHEMCmc0RQmwR7ILJIcVA4BiLyjCw0dpomz3GC+QKAme5YympmVruYmR18tIEHv4tlv4ONgFz3jLPwxbgYPBDQL7hd8o8hulg8NGcwN0mr24xDYpw9lVfAsvl8lnqv9rXuVDEneJ7dDYosn611S4U9d1g18jmR2vpAg3G/Nkphq2N3GbhefXx6qhE7UbXSJwhYXR+dRmb/Cv49NMv8A6lN1DaZZutWe1Rr6Doj+LItTffhm3To2FuY+KVHPGsTT7m8Bioj+BtKenTT78GeI9LUKYrKXZlMLiqU60yuMHK8UAOg8EU3kTaBdSvAZWSIJMGUoRQSk6lhZIgwbXaWpnHIZybFdQBPSwVlTEZeD3q7bnBcdlcd4BUBszBmqjRnzncIuL1KqBeYGBbPGtTBMwVcUaX3tZFe9oumM45j3OlNdyqvECKvp3nObhuedkuc8B34OCcC4JKXIH0CAENDeHqQCXu1M5ZzyhUC35u+SGPLwBN7qwyFKaQezmnrf1km+iR3Sprjiy1IZSbcCSdmc2VtJXYebxZHX7kpnzQyPf7rcc5ej4wur29F6e6dLrr0xI4W/9MWrcPES2RZQLSPt3wRPn20E4kEuir8GF+jX6hMuym2mcqehSFRyIRWmVoAu4QlPOLq3eweD0c743+/6O4R+8u37x9f/2WwXAjbQPWUwDhbKBKmp2Tdp7xD+faekvb/urXAd1gJnyikdNSRRYWHV13DOpObB/npzsvA2aJKG0gFlivuex+8LppePnHGj2ztFkiFtIrmfL0ZpqlAn/PNw/7n3Xyq++79wav4Ph7haOwe5JhmGEspK75l0jEI67232M0sybpiQYDawXOswwd7ag+I8h7LPPi7Y1IBPfKfYLzGAlO94WtH4W1z3xaAPzJNOyownrdkqem2ci3W5/V6BzspTlGs6Zp/gtUB26R",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,b={},I=[];function P(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,o.jsx)(s(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(p(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,o.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.3dea52d8.js b/assets/js/7ef59f7a.3dea52d8.js deleted file mode 100644 index 932b9caa7..000000000 --- a/assets/js/7ef59f7a.3dea52d8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4865],{84605:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>b,default:()=>j,frontMatter:()=>f,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.1/getdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocument","permalink":"/docs/API-docs/v1.1/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WV9vGzkO/yo8vdzWmNjOn7Z7ftpgr5fNXa8NNikCXBoYmhnao0YjaSWNHcMwsA/3DfZpX++j9ZMcKM2Mx46b1N1uXxJbIimSIqkf6SXzfOrY6Ib9XWdVico7dpuwHF1mhfFCKzZiVwXCGXpoSOD04hxQ8VSig4WuwGuw6K3AGUKOngvpgKe68sDBGczERGSQ19x9ljBt0HKSfp6zEZuibzZZwgy3vESPltRaMsVLZCPWEIxFzhImSC3DfcG2ddXpB8z8eQ560urLEmbxl0pYzNnI2woT5vxCklgnSiORJQzvjdQ5stGES0cEWYElZ6Ml8wsTKL0VasoSNtG25L67gvc8SBkx89NhWmRHhUnZanVLxzqjlUNHgo6GQ/q3qa+rsgydm1QSWqewhGVaedJ8tGTcGCmysDH44Ihp+VC7aDZ5z5IYL+KRznNfuX2tEOrAWD216BxbJa1L9xXzjzNxd3ScFu/+SVImghb3k1B4b9xoMKhXKiv7mS5JWkY2TsgtXyy0I6Ij2Au/v54ufKAIJxFK76+UkcgdghNT1SZK8JqWOdqnL/rr3FHMtf0kRA0hsK7WDlwnbG0CBdJcbdjyWfI/aIQUkfjJO6EstBK4tXxB9cBj6Z72ktW773Z9Wob6MUfsVAtLLuST1CniD/VCE2um0OqJY06evzg6PP7+5SHRz0U+Rf8H7I+7+/nf471P9X3Ql0+77KoqU7Rd9nalZT9cJex+T56jk5NVwhZ7cr2ko+Z7Mh1/v0pYsSfTyQuK5VDAP8PnX5JTrc9X3YzyWBrJPY4vYx6Mm3h4lCokpUOVn6u3drOWpFpL5Kp7NL2OVF4tco/5qX88Oo+GR8cHh8OD4curwxejk7+Nnr/oD4fD/7CE3ZdybT3LqU53i0P9vTL5NzkngpUrXX2e+RZzYTHz48ruTOzH7o6O41Lq+bjUeXxftgJlx7kBdBBjlQs/9nazoOyZ5V9cj2YC57jzCfmKVxGK+J97yI5XaC58EcHQuOvjQNokjHhCqw4hCAdayQXwGReSYgvmBSrwBbbPN9HUeQQTq0vg0EjohyCpvB5bLIV6Miub8IjUY60yHAs1xhnanWWyZRySgVsue+AR9qi/6iJ0sgu8XuoSfSHUFOZk8NxqNU2gxjLeLoBPuVBAJtu/fD1Ui9bqnThifVf7adaNGKGkUDhukPv4ZDgcH7ZOOHnohLYrUtrDRFcq/7am7jr/cYNOxsetQc8fGnSuZlyKPHR5V/oO1be1p3u8j8c/jGIRicI+2zC2ux6NdJhVVvhFaCfvD7gRB3F/dHNLTRpFiq770NB/+oKN2KBJhcGy03uuGMmzs6Y73cqHOZ9O0f5UpUH708pr+LfO7qKJ4TFp24+ZsD5K6rvIVlQpVeLBheWTSso3fHbH7UAbVIPD/rA/ZKtkuSXEcZWn+r5PRFRYJU9dkMGNGMwO+4c7eLgxe9FjdbAvi/N8KtT0Kb7b9d1cUvzEENm4ofUbaMS/kB7BOgC6VPU8oEAeGo0VfZ/owFyHxVuDivBQuJZw+Pbc4BplpkukUQYV8V6vYfn43/+1XL1eW91D+Pffq/fqbWXB6Dla6uG5ymEi8V7QkxDGJGXYa+ckDnkp0Tm5AKE8Ti33CLmYCs9laP+oZmXc8FRIQVlDZJq4LXQSz/XhukBfoKWtv1oEDjnOUFKyAT0tJfckqn2N5treTaSeuwQ4pJUTCp0DVAVXGRE2N5GAtsAVoPJojRXUlXpLWouom1be8sxDyRWfIslOoOusHKWg/ACr08p5cFpWQWWgwZC2mENjkELMXXDiKxq/WARazXRpLBYUNjOEaSVydAlkOkeIjTaZoHJI0XkwpIvI0JHQSkmd3YULpAwCo6lmCS5pGtTVkdi95coRkou6NHfQOsxYTZMZjAr2eu8c0g2/FurOjXq99+oAbtq4usbUCY+33zUpMJ/PH4T+s02eM+GpUvyMRjvhtV2suafCN9WgK6T9EiWdocIQP51kWMvIdeYeZh+tDgqUZnCJniLEDU4vzkOZfwYff/0NXiO3Cgo9j9GaVRblAqbNUeS5ePPRbW2VhokOgVeQx7MYfDR1Q+cbD14X3H/89XcHb3AOQtUpRab0ehdVKkUGVzVCcr3eCH4M6KlFTQ58wT1kXEGK4ApOoTQTHDiYyC2FuuvDqVpA5dACgZgQDLQe+DbM2Bi2OEi5wxx0BHEtUltrROulQzlDR7LotU0RMBcE8HxhdTWNp3WVqY2zOBFSwnVs2Mi20zwHUy/XfRw5vKMOTighfIEL4BbB0egULrZYwk5ljLakhYjKTzT1H3QBqHKjhfJuBLnlE7+Wn6wDPYBUodWOpejCNXBNajHtlcRMrC1uV/vvqShvFfLNemtxgpYODGav78WIOpxumrAEitY/EtZhXqiV55nvtEf0ovywLSdACbSlezu5RDsTWTMw/ERGDwLxgCVMigyVww5EOT27eA2z4/5w4+n/jOQevD7/8dWby1ehJUProsMaCMCMdr7kqnNSdza//bAt18jtT5jj148zzSsGRnIRsFjdNEccdcM6o/1Rd4p/m7BCO08kyyUl3zsrVyta/qUKfc3NbcJm3ArSL4It4ehz3g7pP2npdz/X8/5n8IkfBHZq3mANRUBjxmUVGvqE3eFi6yeI1S0NjiLgINUixWmWofEd3gdQeQNvnr26YqEPLDaBzl0AOvUHkr5Tr00EFBWgvwTHdjIslxFErVYtfdz6JEdtYENNTrpdrVb/Bwe0E8k=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"}}');var a=o(74848),i=o(28453),r=o(33617),p=o.n(r),s=o(17543),c=o.n(s),m=o(86013),l=o.n(m),d=o(63723),u=o.n(d),g=(o(18766),o(79329),o(9303));const f={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WV9vGzkO/yo8vdzWmNjOn7Z7ftpgr5fNXa8NNikCXBoYmhnao0YjaSWNHcMwsA/3DfZpX++j9ZMcKM2Mx46b1N1uXxJbIimSIqkf6SXzfOrY6Ib9XWdVico7dpuwHF1mhfFCKzZiVwXCGXpoSOD04hxQ8VSig4WuwGuw6K3AGUKOngvpgKe68sDBGczERGSQ19x9ljBt0HKSfp6zEZuibzZZwgy3vESPltRaMsVLZCPWEIxFzhImSC3DfcG2ddXpB8z8eQ560urLEmbxl0pYzNnI2woT5vxCklgnSiORJQzvjdQ5stGES0cEWYElZ6Ml8wsTKL0VasoSNtG25L67gvc8SBkx89NhWmRHhUnZanVLxzqjlUNHgo6GQ/q3qa+rsgydm1QSWqewhGVaedJ8tGTcGCmysDH44Ihp+VC7aDZ5z5IYL+KRznNfuX2tEOrAWD216BxbJa1L9xXzjzNxd3ScFu/+SVImghb3k1B4b9xoMKhXKiv7mS5JWkY2TsgtXyy0I6Ij2Au/v54ufKAIJxFK76+UkcgdghNT1SZK8JqWOdqnL/rr3FHMtf0kRA0hsK7WDlwnbG0CBdJcbdjyWfI/aIQUkfjJO6EstBK4tXxB9cBj6Z72ktW773Z9Wob6MUfsVAtLLuST1CniD/VCE2um0OqJY06evzg6PP7+5SHRz0U+Rf8H7I+7+/nf471P9X3Ql0+77KoqU7Rd9nalZT9cJex+T56jk5NVwhZ7cr2ko+Z7Mh1/v0pYsSfTyQuK5VDAP8PnX5JTrc9X3YzyWBrJPY4vYx6Mm3h4lCokpUOVn6u3drOWpFpL5Kp7NL2OVF4tco/5qX88Oo+GR8cHh8OD4curwxejk7+Nnr/oD4fD/7CE3ZdybT3LqU53i0P9vTL5NzkngpUrXX2e+RZzYTHz48ruTOzH7o6O41Lq+bjUeXxftgJlx7kBdBBjlQs/9nazoOyZ5V9cj2YC57jzCfmKVxGK+J97yI5XaC58EcHQuOvjQNokjHhCqw4hCAdayQXwGReSYgvmBSrwBbbPN9HUeQQTq0vg0EjohyCpvB5bLIV6Miub8IjUY60yHAs1xhnanWWyZRySgVsue+AR9qi/6iJ0sgu8XuoSfSHUFOZk8NxqNU2gxjLeLoBPuVBAJtu/fD1Ui9bqnThifVf7adaNGKGkUDhukPv4ZDgcH7ZOOHnohLYrUtrDRFcq/7am7jr/cYNOxsetQc8fGnSuZlyKPHR5V/oO1be1p3u8j8c/jGIRicI+2zC2ux6NdJhVVvhFaCfvD7gRB3F/dHNLTRpFiq770NB/+oKN2KBJhcGy03uuGMmzs6Y73cqHOZ9O0f5UpUH708pr+LfO7qKJ4TFp24+ZsD5K6rvIVlQpVeLBheWTSso3fHbH7UAbVIPD/rA/ZKtkuSXEcZWn+r5PRFRYJU9dkMGNGMwO+4c7eLgxe9FjdbAvi/N8KtT0Kb7b9d1cUvzEENm4ofUbaMS/kB7BOgC6VPU8oEAeGo0VfZ/owFyHxVuDivBQuJZw+Pbc4BplpkukUQYV8V6vYfn43/+1XL1eW91D+Pffq/fqbWXB6Dla6uG5ymEi8V7QkxDGJGXYa+ckDnkp0Tm5AKE8Ti33CLmYCs9laP+oZmXc8FRIQVlDZJq4LXQSz/XhukBfoKWtv1oEDjnOUFKyAT0tJfckqn2N5treTaSeuwQ4pJUTCp0DVAVXGRE2N5GAtsAVoPJojRXUlXpLWouom1be8sxDyRWfIslOoOusHKWg/ACr08p5cFpWQWWgwZC2mENjkELMXXDiKxq/WARazXRpLBYUNjOEaSVydAlkOkeIjTaZoHJI0XkwpIvI0JHQSkmd3YULpAwCo6lmCS5pGtTVkdi95coRkou6NHfQOsxYTZMZjAr2eu8c0g2/FurOjXq99+oAbtq4usbUCY+33zUpMJ/PH4T+s02eM+GpUvyMRjvhtV2suafCN9WgK6T9EiWdocIQP51kWMvIdeYeZh+tDgqUZnCJniLEDU4vzkOZfwYff/0NXiO3Cgo9j9GaVRblAqbNUeS5ePPRbW2VhokOgVeQx7MYfDR1Q+cbD14X3H/89XcHb3AOQtUpRab0ehdVKkUGVzVCcr3eCH4M6KlFTQ58wT1kXEGK4ApOoTQTHDiYyC2FuuvDqVpA5dACgZgQDLQe+DbM2Bi2OEi5wxx0BHEtUltrROulQzlDR7LotU0RMBcE8HxhdTWNp3WVqY2zOBFSwnVs2Mi20zwHUy/XfRw5vKMOTighfIEL4BbB0egULrZYwk5ljLakhYjKTzT1H3QBqHKjhfJuBLnlE7+Wn6wDPYBUodWOpejCNXBNajHtlcRMrC1uV/vvqShvFfLNemtxgpYODGav78WIOpxumrAEitY/EtZhXqiV55nvtEf0ovywLSdACbSlezu5RDsTWTMw/ERGDwLxgCVMigyVww5EOT27eA2z4/5w4+n/jOQevD7/8dWby1ehJUProsMaCMCMdr7kqnNSdza//bAt18jtT5jj148zzSsGRnIRsFjdNEccdcM6o/1Rd4p/m7BCO08kyyUl3zsrVyta/qUKfc3NbcJm3ArSL4It4ehz3g7pP2npdz/X8/5n8IkfBHZq3mANRUBjxmUVGvqE3eFi6yeI1S0NjiLgINUixWmWofEd3gdQeQNvnr26YqEPLDaBzl0AOvUHkr5Tr00EFBWgvwTHdjIslxFErVYtfdz6JEdtYENNTrpdrVb/Bwe0E8k=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,x={},y=[];function h(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,a.jsx)(p(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,a.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(c(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},audit_trail:{type:"array",items:{type:"object",properties:{email:{type:"string",example:"joebee@example.com"},viewed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},signed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"documentwithstatus_audit_trail"}},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"documentwithstatus"},title:"documentwithstatus"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.4a732e7a.js b/assets/js/7ef59f7a.4a732e7a.js new file mode 100644 index 000000000..a7350692c --- /dev/null +++ b/assets/js/7ef59f7a.4a732e7a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4865],{84605:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>y,metadata:()=>o,toc:()=>h});const o=JSON.parse('{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.1/getdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocument","permalink":"/docs/API-docs/v1.1/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9GdtuGzf2V87ypY0wluRLkq6earSp627QGLUDA+sYAmfmzAxjDsmSHMmCIKAP+wf7tK/9tHzJ4nAuGsmKHaVpXmyJPPcbzzlaMs9zxyY37EedVCUq79htxFJ0iRXGC63YhF0VCGfooQWB04tzQMVjiQ4WugKvwaK3AmcIKXoupAMe68oDB2cwEZlIIG2whyxi2qDlRP08ZROWo28vWcQMt7xEj5bEWjLFS2QT1gJMRcoiJkgsw33BtmXV8XtM/HkKOuvkZRGz+HslLKZs4m2FEXN+IYmsE6WRyCKG90bqFNkk49IRQFJgydlkyfzCBEhvhcpZxDJtS+77J3jPA5UJMz8fxkVyVJiYrVa3xNYZrRw6InQ0HtO/TXldlSToXFZJ6IzCIpZo5UnyyZJxY6RIwsXovSOk5UPparXJepbIeFGzdJ77yu2rhVAHxurconNsFXUm3ZfMT2fi7ug4Lt7+QlQyQYf7USi8N24yGjUnlZXDRJdELSEdMzLLZxPtkegR9sLvL6cLHyjCiYTS+wtlJHKH4ESuukQJVtMyRfu0o7+Mj+pc249CLSEE1NXagOuEbVSgQJqrDV0+if57jRAjEj5ZJ5SFjgK3li+oHngs3dNWsnq3b9fcEtSPGWKnWFhyIZ+EjhG/bw7aWDOFVk+wOXn+4ujw+LuXhwQ/F2mO/i/oX9/uZ3+P9z7W90FenvfRVVXGaPvo3UmHfriK2P2eOEcnJ6uILfbEekms5nsiHX+3ilixJ9LJC4rlUMA/weafk1OdzVf9jPJYGsk9Ti/rPJi28fAoVEhKhyo9V2/sZi2JtZbIVZ81vY5UXi1yj+mpfzw6j8ZHxweH44Pxy6vDF5OTf06evxiOx+N/s4jdl3KtPUupTveLQ/O9MulX4VM3K1e6+jT1LabCYuKnld2Z2I/5jthxKfV8Wuq0fl+2AmUH39B0EGKVCj/1drOg7Jnln12PZgLnuPMJ+YKuCEX872Wy4xWaC1/UzdC0b+MA2iaMeEKqHiAIB1rJBfAZF5JiC+YFKvAFds83wTR5BJnVJXBoKQxDkFReTy2WQj2ZlW141NBTrRKcCjXFGdqdZbJDHJOCWyZ7YBH2qL2aInSyq3m91CX6Qqgc5qTw3GqVR9D0Mt4ugOdcKCCV7T++XFeL1uqdfcTaV/tJ1o8YoaRQOG079+nJeDw97Ixw8tAI3VSktIdMVyr9uqru4v+4QifT406h5w8VOlczLkUaprwrfYfq6+rTZ+9r9g+jWNRA4Z5tKNs/r5V0mFRW+EUYJ+8PuBEH9f3k5paGNIoU3cyhYf70BZuwUZsKo2Vv9lwxomdn7XQaHohupHBcpbG+H2qDiuqc5LGj4jriRoxmh0Pq4rZxuDF7wWN1sC+K8zwXKn8K73ZtqktyZ+2xDYOtnyQj/oX0JjX+6EM143mBPPT9K/qe6YDceOmNQUXtSfBxYL49xl+jTHSJtFmgmjoYtCgf/vNnhzUYdMU2ROPwnXqn3lQWjJ6jpZGaqxQyifeCKnTYWpThrltbOOSlROfkAoTymFvuEVKRC89lmMaohCTc8FhIQUFMYJqwLfTywA3hukBfoKWrbywChxRnKCn2gSp9yT2R6h6HubZ3mdRzFwGHuHJCoXOAquAqIcDWExFoC1wBKo/WWEFDorcktahl08pbnngoueI5Eu0I+sZKUQoKV7A6rpwHp2UVRAba02iLKbQKKcTUBSO+om2IRaDTRJfGYkFhM0PIK5GiiyDRKUI995IKKoUYnQdDsogEHRGtlNTJXXBgVkkJRlMJEVzScqYvI6F7y5WjxqqWpfVBZzBjNS1KsBZwMHjrkDz8Wqg7NxkM3qkDuOni6hpjJzzeftumwHw+fxD6zzZxzoT/uYrhNzTaCa/tYo2dC19UcUiXPpHuS03pDBWG+Oklw5pGqhP3MPvodFSgNKNL9BQhbnR6cR6q7jP48Md/4TVyq6DQ8zpak8qiXEDesiLL1Z6vzdYVTch0CLyCLJ7UwUdLMHS+teB1wf2HP/7n4Fecg1BNSpEqg8FFFUuRwFXTsLjBYAI/hGama2Ic+IJ7SLiCGMEVnEJpJjhwMDW2FOpuCKdqAZVDC9RThGCg84C3ocbG7sNBzB2moOueqmuc1hLReelQztARLXr8YgRMBfVbvrC6ymtufWEa5SxmQkq4rucn0u00TcE0x81YRQbviYMZJYQvcAHcIjjaZMLFFkq4qYzRlqQQtfCZpnGAHIAqNVoo7yaQWp75Nf1oHeihZxRa7TiqTbjuI6OGTOeSOhMbjbvT4TsqyluFfLPeWszQEsOg9tovRjThdNOGJVC0/pWwDus7rTxPfG9aoRfl+2064WVHW7o32SXamUja/d1HMnoUgEcsYlIkqBz2OobTs4vXMDsejlnUex4/IblHr89/ePXr5aswIaF1tcEOh+PhOCxFtPMlVz1O/VX59sO2XDdSf8NavXmcaX0wMpKL0Bo1M2zd1tyw3qZ90l+q30as0M4TyHJJyffWytWKjn+vwphxcxuxGbeC5Au9TyocfU67nflHNf32t2b9/gw+sp/fKXnbayhqNGZcVmG+jtgdLrZ+EVjd0h6nbjhItBriNEnQ+B7ug851o/07e3XFwlhWbDY6d6HRaT4Q9Z1ybXZAtQD0l9qxnQjLZd1ErVYdfH31UYxGwRaajHS7Wq3+D90I7A8=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"}}');var a=n(74848),i=n(28453),r=n(33617),s=n.n(r),p=n(17543),l=n.n(p),m=n(86013),c=n.n(m),d=n(63723),u=n.n(d),f=(n(18766),n(79329),n(9303));const y={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9GdtuGzf2V87ypY0wluRLkq6earSp627QGLUDA+sYAmfmzAxjDsmSHMmCIKAP+wf7tK/9tHzJ4nAuGsmKHaVpXmyJPPcbzzlaMs9zxyY37EedVCUq79htxFJ0iRXGC63YhF0VCGfooQWB04tzQMVjiQ4WugKvwaK3AmcIKXoupAMe68oDB2cwEZlIIG2whyxi2qDlRP08ZROWo28vWcQMt7xEj5bEWjLFS2QT1gJMRcoiJkgsw33BtmXV8XtM/HkKOuvkZRGz+HslLKZs4m2FEXN+IYmsE6WRyCKG90bqFNkk49IRQFJgydlkyfzCBEhvhcpZxDJtS+77J3jPA5UJMz8fxkVyVJiYrVa3xNYZrRw6InQ0HtO/TXldlSToXFZJ6IzCIpZo5UnyyZJxY6RIwsXovSOk5UPparXJepbIeFGzdJ77yu2rhVAHxurconNsFXUm3ZfMT2fi7ug4Lt7+QlQyQYf7USi8N24yGjUnlZXDRJdELSEdMzLLZxPtkegR9sLvL6cLHyjCiYTS+wtlJHKH4ESuukQJVtMyRfu0o7+Mj+pc249CLSEE1NXagOuEbVSgQJqrDV0+if57jRAjEj5ZJ5SFjgK3li+oHngs3dNWsnq3b9fcEtSPGWKnWFhyIZ+EjhG/bw7aWDOFVk+wOXn+4ujw+LuXhwQ/F2mO/i/oX9/uZ3+P9z7W90FenvfRVVXGaPvo3UmHfriK2P2eOEcnJ6uILfbEekms5nsiHX+3ilixJ9LJC4rlUMA/weafk1OdzVf9jPJYGsk9Ti/rPJi28fAoVEhKhyo9V2/sZi2JtZbIVZ81vY5UXi1yj+mpfzw6j8ZHxweH44Pxy6vDF5OTf06evxiOx+N/s4jdl3KtPUupTveLQ/O9MulX4VM3K1e6+jT1LabCYuKnld2Z2I/5jthxKfV8Wuq0fl+2AmUH39B0EGKVCj/1drOg7Jnln12PZgLnuPMJ+YKuCEX872Wy4xWaC1/UzdC0b+MA2iaMeEKqHiAIB1rJBfAZF5JiC+YFKvAFds83wTR5BJnVJXBoKQxDkFReTy2WQj2ZlW141NBTrRKcCjXFGdqdZbJDHJOCWyZ7YBH2qL2aInSyq3m91CX6Qqgc5qTw3GqVR9D0Mt4ugOdcKCCV7T++XFeL1uqdfcTaV/tJ1o8YoaRQOG079+nJeDw97Ixw8tAI3VSktIdMVyr9uqru4v+4QifT406h5w8VOlczLkUaprwrfYfq6+rTZ+9r9g+jWNRA4Z5tKNs/r5V0mFRW+EUYJ+8PuBEH9f3k5paGNIoU3cyhYf70BZuwUZsKo2Vv9lwxomdn7XQaHohupHBcpbG+H2qDiuqc5LGj4jriRoxmh0Pq4rZxuDF7wWN1sC+K8zwXKn8K73ZtqktyZ+2xDYOtnyQj/oX0JjX+6EM143mBPPT9K/qe6YDceOmNQUXtSfBxYL49xl+jTHSJtFmgmjoYtCgf/vNnhzUYdMU2ROPwnXqn3lQWjJ6jpZGaqxQyifeCKnTYWpThrltbOOSlROfkAoTymFvuEVKRC89lmMaohCTc8FhIQUFMYJqwLfTywA3hukBfoKWrbywChxRnKCn2gSp9yT2R6h6HubZ3mdRzFwGHuHJCoXOAquAqIcDWExFoC1wBKo/WWEFDorcktahl08pbnngoueI5Eu0I+sZKUQoKV7A6rpwHp2UVRAba02iLKbQKKcTUBSO+om2IRaDTRJfGYkFhM0PIK5GiiyDRKUI995IKKoUYnQdDsogEHRGtlNTJXXBgVkkJRlMJEVzScqYvI6F7y5WjxqqWpfVBZzBjNS1KsBZwMHjrkDz8Wqg7NxkM3qkDuOni6hpjJzzeftumwHw+fxD6zzZxzoT/uYrhNzTaCa/tYo2dC19UcUiXPpHuS03pDBWG+Oklw5pGqhP3MPvodFSgNKNL9BQhbnR6cR6q7jP48Md/4TVyq6DQ8zpak8qiXEDesiLL1Z6vzdYVTch0CLyCLJ7UwUdLMHS+teB1wf2HP/7n4Fecg1BNSpEqg8FFFUuRwFXTsLjBYAI/hGama2Ic+IJ7SLiCGMEVnEJpJjhwMDW2FOpuCKdqAZVDC9RThGCg84C3ocbG7sNBzB2moOueqmuc1hLReelQztARLXr8YgRMBfVbvrC6ymtufWEa5SxmQkq4rucn0u00TcE0x81YRQbviYMZJYQvcAHcIjjaZMLFFkq4qYzRlqQQtfCZpnGAHIAqNVoo7yaQWp75Nf1oHeihZxRa7TiqTbjuI6OGTOeSOhMbjbvT4TsqyluFfLPeWszQEsOg9tovRjThdNOGJVC0/pWwDus7rTxPfG9aoRfl+2064WVHW7o32SXamUja/d1HMnoUgEcsYlIkqBz2OobTs4vXMDsejlnUex4/IblHr89/ePXr5aswIaF1tcEOh+PhOCxFtPMlVz1O/VX59sO2XDdSf8NavXmcaX0wMpKL0Bo1M2zd1tyw3qZ90l+q30as0M4TyHJJyffWytWKjn+vwphxcxuxGbeC5Au9TyocfU67nflHNf32t2b9/gw+sp/fKXnbayhqNGZcVmG+jtgdLrZ+EVjd0h6nbjhItBriNEnQ+B7ug851o/07e3XFwlhWbDY6d6HRaT4Q9Z1ybXZAtQD0l9qxnQjLZd1ErVYdfH31UYxGwRaajHS7Wq3+D90I7A8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,g={},h=[];function j(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,a.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},audit_trail:{type:"array",items:{type:"object",properties:{email:{type:"string",example:"joebee@example.com"},viewed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},signed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"documentwithstatus_audit_trail"}},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"documentwithstatus"},title:"documentwithstatus"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.0064d4c8.js b/assets/js/851f8f65.0064d4c8.js deleted file mode 100644 index 255aab464..000000000 --- a/assets/js/851f8f65.0064d4c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kt2AhZPcXqQ5Qsc7WKoSWvrR2PxJCodcySGg66KrsbYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6IOkJNoje9sPMhuFI5HITOSJq8jyqYkOTqLnKq0KkNZE7+IoA5NqUVqhZHQQHc+APdd8YlnoxA6PXjCe52puWGVAG2YVm4IEzS0wCXOWhenYeMFKrS5EJuSUZdxyNhd2xjgbcwOP9hnIVGWQsYnIITmVp/JYlAfsbZkrnrGFqjQ7ev4f9Xy4ELad9HrPYVxN2dsXvd67L2bWluag3+dlmagSpBFTmfOxSVJV9DPsWGaT+zGbz0ADzspSLhlwI/IF41nG5iKbgjUxszOQLFXlgqVK6UxIbsHErORTYLIqxqBNzLjMWKE0MCEZZxp4ttizaq8ywP7zzauXbKJ0wW3CjvLKxPVymdCQ2nzhprczqHd1zwRsGKuFnMas4OeIL2HZj5VIz3HbBmSG/8eBh0cvCFe93puqLJW2kLEf3BYOej388jXkas64BuqfqqJQkpVc8wIsHdiMW/qs4cdKaMj8seR5wMXBqdxjvZ7kBRz0euytFD9WwEQG0oqJAI27ZHYmjB+QuP52UVL/FzITKSKPAMBWpibdrohU7PqmhBSndF1bqGZKsvlMpDPC4Zy78y9znrptaTAlpFZcQHfiy5gtcOLnIFWAYKa0+KuSlud0fBegrUh53j5mBBC7Gsu1RfSXSkgbWv0K7E/+OPG06RA9HSJoGSK3EJK+GGAXPK/AeKjmMZshVK+h1GCIOfy8iHiZsRmI6Wzrejx7XxnbmZhVBsFsQ+HXCqdK6AVC24TnBpiYdHBZ8HNorcYUMT3PE/b1gmUw4VVuYyaQQq2uIGEvlWW8LHOR8nEORAPIbNxWGvbolD35JF3yOSIZAIZxlonJBDQyM36kKfyYAB3SZSM0iNPsjEum5MpBpypXep2EqLmLR5YqaUHahB1ecJET8G6zhgmZ5lUGbJzz9Dxm47yCmGnIHKMvAAVd7PiDujBuPM4JP8xAjlSoJMIvlV9eGGY8VFnCjpFRav7DjwHVtIgwbax6Lp8oXBlREFiSQcFFHhPiYvZejZkVNocYGbzkchGjhIWYWbi0Y3UZs3QG6Tn9pXkmFBtX1irpNpZpVWZqLj0uJ0paI/66gSPDlw/H6Chm+zF7FLPHMRsOYjYcxWy4H7Pho5gNH8dsNIjZaBSz0X7MRo8cWKPHcbgiAoLbAAxHDsv214NdlNPfC0OcjQLW1DJ73pHZw4T1ejU3Ydtf/vKXU3l1Khk7jZC5TqMDdhrVXU6j2H1DmYnfhv73Jf54MPrS/1zgz0ejx/7nnLoO9/3PGf4cDU/l0i94KkcEieVFeQ0U+PlOIfC/PBFhGy2KbUGeYSMKojh8wLPqwIMflu29PMC9CCms4LnZvp3Q4zPaUQPS2qb2cVNErtt3RJ8/o+204cEvJCbdJxKrrU+B4QmK0druHyb+Ztm+ebfsZ7P3FjiftvVHuHUUTccomrbvv5ZenxESVmH6NEx8mZACQJJ5Ox58h88IC12IPg0HjxEHeCltRwB+/Yx23wIHP/gb3n0b7O8NH+6NBqP9DgbQlnIdimIvy/YWi8VdYA91Hr88qjxBQ3WaHdqxE62KDeYHWQdNL68T0d9BZf8jKurjoMNChnYiGRZBY6ktxLaWbVXGF/eMmyoMrZUz7N+oZosWmPQJ4SBrOZ0pkXrgsU9QycZoECaIgz3CZD/L+i1MYmOW7RXF3koj/twjxLcaiyLJsmSl59rpuMaCZVnM1ps3tmcZK4piS7Nr7zT3i2J9F0lReNhI+foKmcTrbNv5xHf4pVil4YjuwteyEXoalMxpbTLnNvPRymUzE9J/8ETFVjpomFY513CJdqkRSrred89jgcUazZ7sWO9JgKBYsy9eee39vid/3EJ3Amy5edzaznCSQ5ZWxqqCaZjCJSu5taAlTXbBc5FxMuX2qAEueVGiCdD/8+lp9rt/7ZMDAm18y/AkWCamAv1G/T+fHO7997sNPaqyBJ1yAywHXMnEDGyasJMZ5GXjuprP58n8gUlnSuXOb/XeaJi4f8/U+P0ZgVsm3JT3N+3UkUbL4EfSWbX3DdgOxrhhYeQGk59ojHhoOKDb1ts711y3vsdndOOsgIQfnfcEP5+cRgUnhQRJGZq/lZ2BPo3e1WOckQ/ZDWPf3YJZZyKDnI8hX/90a0arm3O+UJXn7+DU6m7VU3QLb/ihELL2W9B2BnHrI79c+ei+LTfwt0NImzvDlRPYM5wAy4UJnpsuOtujvWuLHJQSgHyeY2BhADqUg/T4VC6oAbsdGzhJ5M/uhiWwH6OOtVsxrHbDCp2DaSMG5yiEFEVV1P7RST1rQFnhdY82vnAk+unDCu3TXVuBX96wAjojty9wKofkxwj+j2s0U9/jM5IVKyBdz8YfI0U69/QdXbA3M2DYVpsBN1zL2NVdyDXzme3cl7BXeL2hT9YNQi9bmkJp0SP3qaxZg3zrG4p8Vs4P9zX54bZTXttb9xlR3wawfmYK9P3u+vb5KCJt7/5XRKgdsG9NrM4pWfDpNZY7ff6MyNPDs+aEGJIz0t0X1zjk6Pv12xkOOtt52N3Oo8FHWFedZT/duBrUjY1V9Y3EmMPaQmiXVzm/U1Hv50TSfKaKsrJtXiCTn/g9XN4hrObChL+L2V7MejHrx+yLmN1P2GugQFxaB+38XS60C80JyTJVYcwkrXS+YGPNU4yGQzJN2NXVjxWXVtjFcsl67OoKg//LZYLMcS7V3MXtTi6EEZZh3L2xdTKVmg1xepWaPhpF/Zcw3wu5Bn0P2n32hVrh1GstS4+CDzUltw37me0rDBEdaZiIPG8F8lloCseDgVHIofDBYx/CR4WRwklCWoUoCMkSvd4YJgpDSZhJgAHJGW9C/U5jc8KxnY3AUg3cKs1m3DhLlkxn3B6mStgZFD6o9VJZcBFtUyppwAnzcgPQTUS611uJiIVuTVRMyLBxFCfDu3PfjL4atOXL8NHDjrh82BUwg20C5hrvDYoRh4vg8obmU4vzSQCF9nW2X+X7MCki24mbQGSO+lSVZywX5xTczIQpc75AsgiXpYdyNWr+bKaUaXr4wLXnM3PQDYgrjTHx+0kdH/xUv/Pwywcdaf/4DpxpK+7l7mEM9vvDh/1r/csrXtEPl9eM3ebkyHF7q5Ojns3R7fzAH+sHvhvCf3CXbrDhl6OO9vZg8OkMcEferjbj3ODnugtv1p25ldrsdkuH0i/m2Pl06ttvTNzxnZm4K2L4y+EdiOEtluynUuKawXpntMfuylrdRIC3MFevtVE/mUDbwP7sRPrwbkzb4aCjq33VUdW+GrWJ8uHDWxFle9EVyjqNxH99/er1fPCHb6fq8PDw8OWbt7Nv3k4PDw8L/J0kyUavxqbTpmVQh/Upvf5epjt+yypJkiAKMTv6gIb3Szn9Nzc+3j4mOZVRHKkS066Fki+y6CDKMFE7aPJRTOYuGPu1yhbRwVXkc/bwT58RhyP77w1mel9FJp1BwfGvoK5jbjimZkdxRKkbmB6O5xgdRGr8HlJco9QIgxVgcCT1PrgKvVxGcxR7RSs6iNy+ojjywbW6qc4FL7NJtAwLXjdV3dJMZeiP2pjBeTAJ+COnQQsHp+hkxH/UTM9bM9DeCjhWaMTnYOE5X5jWvM4IjVYT8XEMcnjqR7GMLwxKisq4Wy3leVrlqAzCZSn0os5QII2wRRU1vPVKNbzDh8uYMgxBt0HiWvNFFEfCQtFu30IEWn34yaWgEDOUJvahY98rGAP83jegO4EOnhcfDMV7BWwMdOjlTMkPHj8cPRiOhg+GI5zB5/p86BzBNYJTvFfjs49ihAwucLw3rz/+KN3X9bW7tHmIybSQBWVrr8kKjxllZiY3sUnoT5jnU7iZH463VQu0kpTNjCwsXpbAdUJJ+x9dP9JlsfpWT25gqGUcXd68mUuWqr1QisC+yGFiXeoAS5WWoO+385E+m82N9veXcbS4eXuLX+X2vsTDm9+8ux+ohqOpb/lnwPrg8TKOZjfD+l1dZfJPBHb/0bK54CNyOEK4n87GKlucBbm1vKljuKuw30TlGWhUhNblVSNqUMJgNdXZ6lUzVioHLjcImk55ga98Q6UbXb7eETOfAfnea12cZm8Ufe8gdtBiyQKsZEEJgzqyruA0StiLSctsIDV+tcIh9KVqA6nYPVrvzFQkxu/1/W/E0b125Re6Y5tExAACdWYWijKnUqg5enDHFNXPElb/RxpnjUkEINzYYeGbr4pnLvuKFvSDunVEzCutCXvGZV1L0q3ZYFdXNRkQdSyX7OoKTxX0Gd77y2XcNOBanQa62l2LhhTERWdU3QTNwLqtNdRpWWcZBT6wwd/3bQDEVAo5Pau0nweV0eUy6RDkCuDkePc4gKymMzGVG3Zdq0x00rfG/hqyPQXgJP9v8P6kfPqd2ADKk3759En59AesGizB8Z5Dz0TIzHH+HPI8YU+M1UpOn66g4Enft28+Sg0XAubEuHSqzSyruK0nSjxMf0JB3RyeMCzVVSp4TmmHWqUQ4jsUzULL3VgoDUaihKWRrrCLTAI+1UDRJIKFV5aqJMkmDAs+4WymYfLv91Zweu/pGwQdA3tP+vyp7/3C+SJm/AIYlwtGGyfHidLO+TapNInJNOdaTLwBGrMyB0yRRPuUpy6G5jAa4DiecXlu4idj/fQYeMFelSARgp/+/g/sEWT6C/lKZ6BvIdRfTFy0TrF7KMfuxS5dk8hdaGO9qHaS0FOIg2sL6/hyHYz0fVOLflONDfaSYb5GtFotplPAeJzvQYN98RvwdOYuDYKKT0LooETiUZUJ4CGBBYMw88Fbf1BdV08LOxQKbO892STVJVbLvTo+ugUuyQ+15xjFOWHcLt0c7NXxERbc1sedsLemxkRALe90YegJYBeCh6K8WrNfuBQ3cMEULxfb8cvEl7rusXWAMmE2QhS7Sx0lXF3QvjZxU8GNR6Qqi/FQ4esMics6eCQoakQeq+o2VHkDJjmbVlRRYJF9w61JScVNwayQxurKpfexrNKhRtiThRMTxjR4CljBTq35YwbSuOGcTbixoGNWSYGY1xW6Jusp4bIELTCVYCMKNDjUoei4+YrqVp++ff29r9sPewhMOUYOdBNDxqqSqIY4oa6KDie3uvWN+qAX3zcDiLobJUh4/2oJ2iiJIk7pKZdegjp7FJ2oY5jx3HX1ogLjcAgPcniy0fb/6e//aMG11SmyDphbgWcZprzfACH5ox3BY1anhhIloOpChPOB/v2qCYDQEdOcFSqrGcncnsaPKEne1HLR5xfU+Q2mSmd4bdXy1sRBxhrvVDDkeib/NCUolLhfuBTGtup6Q/XNunx4DYjHtAUDGaHI1UjzctFm8CbvQq1MR+aB6NaE10bQGi/wyqozDYWQt7un2q5+q2pBUFlVcCtSFqYySbfS38WTA18X7IsAGlLjhVD6/hZWxenOlEzhTMgzuAB9C/P+ZZ0tTD7JMdg5gGzDFpDkrrOmGnuOD250cNK6nejNgQ4xPoyR7grQUzhL0UlFhAe3wGOvh7P1emzPweLFqqm0j8v4hzJIfqAoaWZHiLw6XNdyNXdu+32ShH2n5oizWqNBvdPNjyhlBHkWuylaK6RcYk07WYporOHEdey+4JSJ5Zdw6TN0XrQbr3OlLmCDs+DDDrhOfN2eggiti9Q4Ps4QVncc4TaHHn3Gc0Us5TVL/7kD1Auqy5/RFURHiPElt054LEPNJeif/va/hrKEXPKZqa3djV/JYOW5Ua7ovz1roOhA80nXPA0k7ROSNrk6uyQSntoIdVJBgDjdg56MKcaYW0pZVaRR0U0TzPo13+nP5ny9zpPqk312ftRfkaNxOBj8lv2oDwa/Hj/q/uBX5Ed9jMD6sPfN0mSbdrtRdoTY9vUD3itwga5c6et7YjCZXLQu+WITght2GC3df43rNwjxdlsn2O38XzSmCV57WzbshbAwGgzwf93TfN5JfkXLpkrRUphUeb74lyi+feT8+iOooRUbndTXyfXZezH662V6MTpCPG6xpK6dwBNipXN8rgyvr736AieNvoVbIXMh4YxQfJap9EyDORsNBmfDyB3M/iY0vlEFOA1gjsico++qVoWsXjA+RV0GaVzfIVZB65vI78Mg24CJQENn+x0kPFxHwgtJVZf0St6xOgf5y+60vbx1yyOol0XeyIBIuE70Pepstt3uNmkgrbSwi+jg5Cq63OOl2HPfD07eLd+hNm5nCpNPSmUIYm5n0UHUX81FMaAvKKvgZI1s5hxdYd9VY4L6sLKK/VGl525rROo19V4Ibd1MiXHDZtWYZOmR5siuL/nFOdd9FLX9YTJIBtEyvlqZxHCZYcbemjzmpehfDJPhhjEb5fc1/aHa+9AhxvKpkNObxr1rzuQN0o0jjc7JNApnKf4AqHH6g2/3iiOB2J8BR1MUjxrJ8XWTMvRNIKqQ1rMpU6chntXcm5B608mmWb1HN+THbE6PGT5sJaachBwTShups0Y2JYLUWw+pHXVmRytZo5Wr0aRfdLIvKKGilU9x0vBgnboQNO4hqaqj/X3S6b4ckvLz4DHpFfuPlsQ1TawyirrxSCpLWo2qfVqQqBsj2gU+fkOBj5W4hyeexnnv0mI7Xmjf1PXKBiqsvaAdV+SqJ3KrV3CLU9AvueL8qgHZ5HNCX89GV48f1TLrNzBl0GS7LIlZpciSDwbEkvsDYsnHg44S7bffzNCowqTv1uou6bRtlRb11ncoR4WcKBLCXnaEQ6PrjYT4mukDeaqK+nXCXq91zvWoXq8Wro5W0e3yqtKsVHPQk8o9dzjJ4VKgbw2HQUHfmnQF4EUOxuRYZmJhSs4eesUEgxjeTZ7yko9FLlDrcFVljmsaxcUk7Icm4eGedqV3F5CjslJ7J/HJ36BYz5U+n2DiRIyP/2JJIvqnQc64TJ0r3N1o5NJFVwuGGUotDD7IqhFq4WBT0mpklYJLPiUmjttMwTLIUaYZptUYI0VG5ZVjRctFrrTLlaQNUSo2IfGbyxI/kf2GN4GGGRL2hQ+ImNgFpNxl5Z8AHmPsr0RYBPqprGKVzBW+1osxxCrPWamsi+uhmdiGEYdbzaVBfd2nZ/ozqBHmYxVgvMfvrQE84e+FPHcvRu6xk5qufoCxERa678msMuf97phvhUWN6zWUygir9KIZPRU2aFXtSeofbqZvw5PPLaXi9lWeb8AihZj+4dELUpPvs5/+9j/se+BaspmaO2pNKw35onldmt5eppN3aKu1XIqGoSRHjKeO+PwFFDD4w4xbci++hDn6cR1LuVTuo2qci5QdhwyYXu+APSNbsJUV03n/wtVSYoiSs9KNzoU8T9ihXFBQpbmOsJ3GdbZBV2DrpWyOabxK+px7t2bSQERufAP5BZiWuxgy4QK/WlVTt1obGL+5bmkp7u0wy9YqNTFk0IDjnJwUceXO24lPWm8o7uxUbnbTRUBm9IiyOWBkDTTzxyv1pnQZrjWFUtWAjthPUx+J40S/47rVOYJXFOKuvCUHMy7Yfbycl8KT00kgS9Z9qOnDydo5SOh+JxPO36C8FBuDaviEtHk1eQP6QqTBbt/C0X3q3I/iKBcpeG+Nv78Ovz36nl08SAYdE+oWzN3//sWzb16++QaBQUHqEBZMKbLyCi5bK3Vfh1+92lpVB7u35Hdvye/ekt+9Jb97S373lvzuLfndW/K7t+R/scebdm/J796S370lvwUTu7fkd2/Jf+qDJbu35H/zbwjt3pLfvSW/e0t+95b87i353Vvyu7fkd2/J796S/1U80b17S/6XoMDdW/K7t+R3b8nv3pLfvSW/e0t+95b87i353Vvyu7fkf6N+4N1b8ru35Hdvye/ekt+9Jb97S/439ZZ8q3aqX+ZcyFaluavqPVl5Yf5dHM2w6vfgJLq6wlXeYo0cNv9YURXXybs4uuBaYLocFQzHod4Ui7XOAQu9nrnsv71jXD52rE0J8it10lgw60YcEj1f27ddmHz06s1xFEfhhcxCZfQiAZ9jcRefu+K3VgUYtV1FOZfTiqrHIjfn0r3fNOvW155Tfa3/o1WChtWkDYTdwlu3DfwXN7VxwNWVq92l8k3X333aOsIjNvTG43u3XC7/DzZDLls=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kt2AhZPcXqQ5Qsc7WKoSWvrR2PxJCodcySGg66KrsbYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6IOkJNoje9sPMhuFI5HITOSJq8jyqYkOTqLnKq0KkNZE7+IoA5NqUVqhZHQQHc+APdd8YlnoxA6PXjCe52puWGVAG2YVm4IEzS0wCXOWhenYeMFKrS5EJuSUZdxyNhd2xjgbcwOP9hnIVGWQsYnIITmVp/JYlAfsbZkrnrGFqjQ7ev4f9Xy4ELad9HrPYVxN2dsXvd67L2bWluag3+dlmagSpBFTmfOxSVJV9DPsWGaT+zGbz0ADzspSLhlwI/IF41nG5iKbgjUxszOQLFXlgqVK6UxIbsHErORTYLIqxqBNzLjMWKE0MCEZZxp4ttizaq8ywP7zzauXbKJ0wW3CjvLKxPVymdCQ2nzhprczqHd1zwRsGKuFnMas4OeIL2HZj5VIz3HbBmSG/8eBh0cvCFe93puqLJW2kLEf3BYOej388jXkas64BuqfqqJQkpVc8wIsHdiMW/qs4cdKaMj8seR5wMXBqdxjvZ7kBRz0euytFD9WwEQG0oqJAI27ZHYmjB+QuP52UVL/FzITKSKPAMBWpibdrohU7PqmhBSndF1bqGZKsvlMpDPC4Zy78y9znrptaTAlpFZcQHfiy5gtcOLnIFWAYKa0+KuSlud0fBegrUh53j5mBBC7Gsu1RfSXSkgbWv0K7E/+OPG06RA9HSJoGSK3EJK+GGAXPK/AeKjmMZshVK+h1GCIOfy8iHiZsRmI6Wzrejx7XxnbmZhVBsFsQ+HXCqdK6AVC24TnBpiYdHBZ8HNorcYUMT3PE/b1gmUw4VVuYyaQQq2uIGEvlWW8LHOR8nEORAPIbNxWGvbolD35JF3yOSIZAIZxlonJBDQyM36kKfyYAB3SZSM0iNPsjEum5MpBpypXep2EqLmLR5YqaUHahB1ecJET8G6zhgmZ5lUGbJzz9Dxm47yCmGnIHKMvAAVd7PiDujBuPM4JP8xAjlSoJMIvlV9eGGY8VFnCjpFRav7DjwHVtIgwbax6Lp8oXBlREFiSQcFFHhPiYvZejZkVNocYGbzkchGjhIWYWbi0Y3UZs3QG6Tn9pXkmFBtX1irpNpZpVWZqLj0uJ0paI/66gSPDlw/H6Chm+zF7FLPHMRsOYjYcxWy4H7Pho5gNH8dsNIjZaBSz0X7MRo8cWKPHcbgiAoLbAAxHDsv214NdlNPfC0OcjQLW1DJ73pHZw4T1ejU3Ydtf/vKXU3l1Khk7jZC5TqMDdhrVXU6j2H1DmYnfhv73Jf54MPrS/1zgz0ejx/7nnLoO9/3PGf4cDU/l0i94KkcEieVFeQ0U+PlOIfC/PBFhGy2KbUGeYSMKojh8wLPqwIMflu29PMC9CCms4LnZvp3Q4zPaUQPS2qb2cVNErtt3RJ8/o+204cEvJCbdJxKrrU+B4QmK0druHyb+Ztm+ebfsZ7P3FjiftvVHuHUUTccomrbvv5ZenxESVmH6NEx8mZACQJJ5Ox58h88IC12IPg0HjxEHeCltRwB+/Yx23wIHP/gb3n0b7O8NH+6NBqP9DgbQlnIdimIvy/YWi8VdYA91Hr88qjxBQ3WaHdqxE62KDeYHWQdNL68T0d9BZf8jKurjoMNChnYiGRZBY6ktxLaWbVXGF/eMmyoMrZUz7N+oZosWmPQJ4SBrOZ0pkXrgsU9QycZoECaIgz3CZD/L+i1MYmOW7RXF3koj/twjxLcaiyLJsmSl59rpuMaCZVnM1ps3tmcZK4piS7Nr7zT3i2J9F0lReNhI+foKmcTrbNv5xHf4pVil4YjuwteyEXoalMxpbTLnNvPRymUzE9J/8ETFVjpomFY513CJdqkRSrred89jgcUazZ7sWO9JgKBYsy9eee39vid/3EJ3Amy5edzaznCSQ5ZWxqqCaZjCJSu5taAlTXbBc5FxMuX2qAEueVGiCdD/8+lp9rt/7ZMDAm18y/AkWCamAv1G/T+fHO7997sNPaqyBJ1yAywHXMnEDGyasJMZ5GXjuprP58n8gUlnSuXOb/XeaJi4f8/U+P0ZgVsm3JT3N+3UkUbL4EfSWbX3DdgOxrhhYeQGk59ojHhoOKDb1ts711y3vsdndOOsgIQfnfcEP5+cRgUnhQRJGZq/lZ2BPo3e1WOckQ/ZDWPf3YJZZyKDnI8hX/90a0arm3O+UJXn7+DU6m7VU3QLb/ihELL2W9B2BnHrI79c+ei+LTfwt0NImzvDlRPYM5wAy4UJnpsuOtujvWuLHJQSgHyeY2BhADqUg/T4VC6oAbsdGzhJ5M/uhiWwH6OOtVsxrHbDCp2DaSMG5yiEFEVV1P7RST1rQFnhdY82vnAk+unDCu3TXVuBX96wAjojty9wKofkxwj+j2s0U9/jM5IVKyBdz8YfI0U69/QdXbA3M2DYVpsBN1zL2NVdyDXzme3cl7BXeL2hT9YNQi9bmkJp0SP3qaxZg3zrG4p8Vs4P9zX54bZTXttb9xlR3wawfmYK9P3u+vb5KCJt7/5XRKgdsG9NrM4pWfDpNZY7ff6MyNPDs+aEGJIz0t0X1zjk6Pv12xkOOtt52N3Oo8FHWFedZT/duBrUjY1V9Y3EmMPaQmiXVzm/U1Hv50TSfKaKsrJtXiCTn/g9XN4hrObChL+L2V7MejHrx+yLmN1P2GugQFxaB+38XS60C80JyTJVYcwkrXS+YGPNU4yGQzJN2NXVjxWXVtjFcsl67OoKg//LZYLMcS7V3MXtTi6EEZZh3L2xdTKVmg1xepWaPhpF/Zcw3wu5Bn0P2n32hVrh1GstS4+CDzUltw37me0rDBEdaZiIPG8F8lloCseDgVHIofDBYx/CR4WRwklCWoUoCMkSvd4YJgpDSZhJgAHJGW9C/U5jc8KxnY3AUg3cKs1m3DhLlkxn3B6mStgZFD6o9VJZcBFtUyppwAnzcgPQTUS611uJiIVuTVRMyLBxFCfDu3PfjL4atOXL8NHDjrh82BUwg20C5hrvDYoRh4vg8obmU4vzSQCF9nW2X+X7MCki24mbQGSO+lSVZywX5xTczIQpc75AsgiXpYdyNWr+bKaUaXr4wLXnM3PQDYgrjTHx+0kdH/xUv/Pwywcdaf/4DpxpK+7l7mEM9vvDh/1r/csrXtEPl9eM3ebkyHF7q5Ojns3R7fzAH+sHvhvCf3CXbrDhl6OO9vZg8OkMcEferjbj3ODnugtv1p25ldrsdkuH0i/m2Pl06ttvTNzxnZm4K2L4y+EdiOEtluynUuKawXpntMfuylrdRIC3MFevtVE/mUDbwP7sRPrwbkzb4aCjq33VUdW+GrWJ8uHDWxFle9EVyjqNxH99/er1fPCHb6fq8PDw8OWbt7Nv3k4PDw8L/J0kyUavxqbTpmVQh/Upvf5epjt+yypJkiAKMTv6gIb3Szn9Nzc+3j4mOZVRHKkS066Fki+y6CDKMFE7aPJRTOYuGPu1yhbRwVXkc/bwT58RhyP77w1mel9FJp1BwfGvoK5jbjimZkdxRKkbmB6O5xgdRGr8HlJco9QIgxVgcCT1PrgKvVxGcxR7RSs6iNy+ojjywbW6qc4FL7NJtAwLXjdV3dJMZeiP2pjBeTAJ+COnQQsHp+hkxH/UTM9bM9DeCjhWaMTnYOE5X5jWvM4IjVYT8XEMcnjqR7GMLwxKisq4Wy3leVrlqAzCZSn0os5QII2wRRU1vPVKNbzDh8uYMgxBt0HiWvNFFEfCQtFu30IEWn34yaWgEDOUJvahY98rGAP83jegO4EOnhcfDMV7BWwMdOjlTMkPHj8cPRiOhg+GI5zB5/p86BzBNYJTvFfjs49ihAwucLw3rz/+KN3X9bW7tHmIybSQBWVrr8kKjxllZiY3sUnoT5jnU7iZH463VQu0kpTNjCwsXpbAdUJJ+x9dP9JlsfpWT25gqGUcXd68mUuWqr1QisC+yGFiXeoAS5WWoO+385E+m82N9veXcbS4eXuLX+X2vsTDm9+8ux+ohqOpb/lnwPrg8TKOZjfD+l1dZfJPBHb/0bK54CNyOEK4n87GKlucBbm1vKljuKuw30TlGWhUhNblVSNqUMJgNdXZ6lUzVioHLjcImk55ga98Q6UbXb7eETOfAfnea12cZm8Ufe8gdtBiyQKsZEEJgzqyruA0StiLSctsIDV+tcIh9KVqA6nYPVrvzFQkxu/1/W/E0b125Re6Y5tExAACdWYWijKnUqg5enDHFNXPElb/RxpnjUkEINzYYeGbr4pnLvuKFvSDunVEzCutCXvGZV1L0q3ZYFdXNRkQdSyX7OoKTxX0Gd77y2XcNOBanQa62l2LhhTERWdU3QTNwLqtNdRpWWcZBT6wwd/3bQDEVAo5Pau0nweV0eUy6RDkCuDkePc4gKymMzGVG3Zdq0x00rfG/hqyPQXgJP9v8P6kfPqd2ADKk3759En59AesGizB8Z5Dz0TIzHH+HPI8YU+M1UpOn66g4Enft28+Sg0XAubEuHSqzSyruK0nSjxMf0JB3RyeMCzVVSp4TmmHWqUQ4jsUzULL3VgoDUaihKWRrrCLTAI+1UDRJIKFV5aqJMkmDAs+4WymYfLv91Zweu/pGwQdA3tP+vyp7/3C+SJm/AIYlwtGGyfHidLO+TapNInJNOdaTLwBGrMyB0yRRPuUpy6G5jAa4DiecXlu4idj/fQYeMFelSARgp/+/g/sEWT6C/lKZ6BvIdRfTFy0TrF7KMfuxS5dk8hdaGO9qHaS0FOIg2sL6/hyHYz0fVOLflONDfaSYb5GtFotplPAeJzvQYN98RvwdOYuDYKKT0LooETiUZUJ4CGBBYMw88Fbf1BdV08LOxQKbO892STVJVbLvTo+ugUuyQ+15xjFOWHcLt0c7NXxERbc1sedsLemxkRALe90YegJYBeCh6K8WrNfuBQ3cMEULxfb8cvEl7rusXWAMmE2QhS7Sx0lXF3QvjZxU8GNR6Qqi/FQ4esMics6eCQoakQeq+o2VHkDJjmbVlRRYJF9w61JScVNwayQxurKpfexrNKhRtiThRMTxjR4CljBTq35YwbSuOGcTbixoGNWSYGY1xW6Jusp4bIELTCVYCMKNDjUoei4+YrqVp++ff29r9sPewhMOUYOdBNDxqqSqIY4oa6KDie3uvWN+qAX3zcDiLobJUh4/2oJ2iiJIk7pKZdegjp7FJ2oY5jx3HX1ogLjcAgPcniy0fb/6e//aMG11SmyDphbgWcZprzfACH5ox3BY1anhhIloOpChPOB/v2qCYDQEdOcFSqrGcncnsaPKEne1HLR5xfU+Q2mSmd4bdXy1sRBxhrvVDDkeib/NCUolLhfuBTGtup6Q/XNunx4DYjHtAUDGaHI1UjzctFm8CbvQq1MR+aB6NaE10bQGi/wyqozDYWQt7un2q5+q2pBUFlVcCtSFqYySbfS38WTA18X7IsAGlLjhVD6/hZWxenOlEzhTMgzuAB9C/P+ZZ0tTD7JMdg5gGzDFpDkrrOmGnuOD250cNK6nejNgQ4xPoyR7grQUzhL0UlFhAe3wGOvh7P1emzPweLFqqm0j8v4hzJIfqAoaWZHiLw6XNdyNXdu+32ShH2n5oizWqNBvdPNjyhlBHkWuylaK6RcYk07WYporOHEdey+4JSJ5Zdw6TN0XrQbr3OlLmCDs+DDDrhOfN2eggiti9Q4Ps4QVncc4TaHHn3Gc0Us5TVL/7kD1Auqy5/RFURHiPElt054LEPNJeif/va/hrKEXPKZqa3djV/JYOW5Ua7ovz1roOhA80nXPA0k7ROSNrk6uyQSntoIdVJBgDjdg56MKcaYW0pZVaRR0U0TzPo13+nP5ny9zpPqk312ftRfkaNxOBj8lv2oDwa/Hj/q/uBX5Ed9jMD6sPfN0mSbdrtRdoTY9vUD3itwga5c6et7YjCZXLQu+WITght2GC3df43rNwjxdlsn2O38XzSmCV57WzbshbAwGgzwf93TfN5JfkXLpkrRUphUeb74lyi+feT8+iOooRUbndTXyfXZezH662V6MTpCPG6xpK6dwBNipXN8rgyvr736AieNvoVbIXMh4YxQfJap9EyDORsNBmfDyB3M/iY0vlEFOA1gjsico++qVoWsXjA+RV0GaVzfIVZB65vI78Mg24CJQENn+x0kPFxHwgtJVZf0St6xOgf5y+60vbx1yyOol0XeyIBIuE70Pepstt3uNmkgrbSwi+jg5Cq63OOl2HPfD07eLd+hNm5nCpNPSmUIYm5n0UHUX81FMaAvKKvgZI1s5hxdYd9VY4L6sLKK/VGl525rROo19V4Ibd1MiXHDZtWYZOmR5siuL/nFOdd9FLX9YTJIBtEyvlqZxHCZYcbemjzmpehfDJPhhjEb5fc1/aHa+9AhxvKpkNObxr1rzuQN0o0jjc7JNApnKf4AqHH6g2/3iiOB2J8BR1MUjxrJ8XWTMvRNIKqQ1rMpU6chntXcm5B608mmWb1HN+THbE6PGT5sJaachBwTShups0Y2JYLUWw+pHXVmRytZo5Wr0aRfdLIvKKGilU9x0vBgnboQNO4hqaqj/X3S6b4ckvLz4DHpFfuPlsQ1TawyirrxSCpLWo2qfVqQqBsj2gU+fkOBj5W4hyeexnnv0mI7Xmjf1PXKBiqsvaAdV+SqJ3KrV3CLU9AvueL8qgHZ5HNCX89GV48f1TLrNzBl0GS7LIlZpciSDwbEkvsDYsnHg44S7bffzNCowqTv1uou6bRtlRb11ncoR4WcKBLCXnaEQ6PrjYT4mukDeaqK+nXCXq91zvWoXq8Wro5W0e3yqtKsVHPQk8o9dzjJ4VKgbw2HQUHfmnQF4EUOxuRYZmJhSs4eesUEgxjeTZ7yko9FLlDrcFVljmsaxcUk7Icm4eGedqV3F5CjslJ7J/HJ36BYz5U+n2DiRIyP/2JJIvqnQc64TJ0r3N1o5NJFVwuGGUotDD7IqhFq4WBT0mpklYJLPiUmjttMwTLIUaYZptUYI0VG5ZVjRctFrrTLlaQNUSo2IfGbyxI/kf2GN4GGGRL2hQ+ImNgFpNxl5Z8AHmPsr0RYBPqprGKVzBW+1osxxCrPWamsi+uhmdiGEYdbzaVBfd2nZ/ozqBHmYxVgvMfvrQE84e+FPHcvRu6xk5qufoCxERa678msMuf97phvhUWN6zWUygir9KIZPRU2aFXtSeofbqZvw5PPLaXi9lWeb8AihZj+4dELUpPvs5/+9j/se+BaspmaO2pNKw35onldmt5eppN3aKu1XIqGoSRHjKeO+PwFFDD4w4xbci++hDn6cR1LuVTuo2qci5QdhwyYXu+APSNbsJUV03n/wtVSYoiSs9KNzoU8T9ihXFBQpbmOsJ3GdbZBV2DrpWyOabxK+px7t2bSQERufAP5BZiWuxgy4QK/WlVTt1obGL+5bmkp7u0wy9YqNTFk0IDjnJwUceXO24lPWm8o7uxUbnbTRUBm9IiyOWBkDTTzxyv1pnQZrjWFUtWAjthPUx+J40S/47rVOYJXFOKuvCUHMy7Yfbycl8KT00kgS9Z9qOnDydo5SOh+JxPO36C8FBuDaviEtHk1eQP6QqTBbt/C0X3q3I/iKBcpeG+Nv78Ovz36nl08SAYdE+oWzN3//sWzb16++QaBQUHqEBZMKbLyCi5bK3Vfh1+92lpVB7u35Hdvye/ekt+9Jb97S373lvzuLfndW/K7t+R/scebdm/J796S370lvwUTu7fkd2/Jf+qDJbu35H/zbwjt3pLfvSW/e0t+95b87i353Vvyu7fkd2/J796S/1U80b17S/6XoMDdW/K7t+R3b8nv3pLfvSW/e0t+95b87i353Vvyu7fkf6N+4N1b8ru35Hdvye/ekt+9Jb97S/439ZZ8q3aqX+ZcyFaluavqPVl5Yf5dHM2w6vfgJLq6wlXeYo0cNv9YURXXybs4uuBaYLocFQzHod4Ui7XOAQu9nrnsv71jXD52rE0J8it10lgw60YcEj1f27ddmHz06s1xFEfhhcxCZfQiAZ9jcRefu+K3VgUYtV1FOZfTiqrHIjfn0r3fNOvW155Tfa3/o1WChtWkDYTdwlu3DfwXN7VxwNWVq92l8k3X333aOsIjNvTG43u3XC7/DzZDLls=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,f={},j=[];function g(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.905ad68d.js b/assets/js/851f8f65.905ad68d.js new file mode 100644 index 000000000..eb4eb084d --- /dev/null +++ b/assets/js/851f8f65.905ad68d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPGtzGzeSfwU3dVWOuaPhQ/IjOp9rFdub+DZnq2L5UnuSVwvONElYM8AEwIjiqli1H/Yf3Kf7uj8tv+SqG8A8KFKSbSVr55gPjojBo9HobjT6dRlZPjXR/nH0XKVVAdKa6F0cZWBSLUorlIz2o6MZsOeaTywLndjB4UvG81zNDasMaMOsYlOQoLkFJmHOsjAdGy9YqdW5yIScsoxbzubCzhhnY27g4R4DmaoMMjYROSQn8kQeiXKfvS1zxTO2UJVmh8//UM+HC2Hbca/3HMbVlL192eu9+2pmbWn2+31elokqQRoxlTkfmyRVRT/DjmU2uR+z+Qw04Kws5ZIBNyJfMJ5lbC6yKVgTMzsDyVJVLliqlM6E5BZMzEo+BSarYgzaxIzLjBVKAxOScaaBZ4sdq3YqA+w/3rx+xSZKF9wm7DCvTFwvlwkNqc0Xbno7g3pX90zAhrFayGnMCn6G+BKW/VSJ9Ay3bUBm+H8ceHD4knDV672pylJpCxn70W1hv9fDL99AruaMa6D+qSoKJVnJNS/A0oHNuKXPGn6qhIbMH0ueB1zsn8gd1utJXsB+r8feSvFTBUxkIK2YCNC4S2ZnwvgBietvFyX1fykzkSLyCABsZWrS7YpIxa5vSkhxSte1hWqmJJvPRDojHM65O/8y56nblgZTQmrFOXQnvojZAid+DlIFCGZKi78qaXlOx3cO2oqU5+1jRgCxq7FcW0R/qYS0odWvwP7kjxNPmw7R0yGCliFyCyHpiwF2zvMKjIdqHrMZQvUDlBoMMYefFxEvMzYDMZ1tXI9n7ytjOxOzyiCYbSj8WuFUCb1AaJvw3AATkw4uC34GrdWYIqbnecK+WbAMJrzKbcwEUqjVFSTslbKMl2UuUj7OgWgAmY3bSsMOnbInn6RLPockA8AwzjIxmYBGZsaPNIUfE6BDumyEBnGanXHJlFw56FTlSl8lIWru4pGlSlqQNmEH51zkBLzbrGFCpnmVARvnPD2L2TivIGYaMsfoC0BBFzv+oC6MG49zwg8zkCMVKonwS+WXF4YZD1WWsCNklJr/8GNANS0iTBurnssnCldGFASWZFBwkceEuJi9V2Nmhc0hRgYvuVzEKGEhZhYu7FhdxCydQXpGf2meCcXGlbVKuo1lWpWZmkuPy4mS1oi/ruHI8OXDMTqK2V7MHsbsccyGg5gNRzEb7sVs+DBmw8cxGw1iNhrFbLQXs9FDB9bocRyuiIDgNgDDkcOy/XKwi3L6e2GIs1HAmlpmzzsye5iwXq/mJmz7y1/+ciIvTyRjJxEy10m0z06iustJFLtvKDPx29D/vsAfu6NH/ucCfz4cPfY/59R1uOd/zvDnaHgil37BEzkiSCwvymugwM93CoH/5YkI22hRbAvyDBtREMXhA55VBx78sGzvZRf3IqSwgudm83ZCj89oRw1IVza1h5sict28I/r8GW2nDQ9+ITHpPpFYbX0KDE9QjK7s/kHib5bNm3fLfjZ7b4HzaVt/iFtH0XSEomnz/mvp9RkhYRWmT8PEo4QUAJLMm/HgO3xGWOhC9Gk4eIw4wEtpMwLw62e0+xY4+MHf8O7bYG9n+GBnNBjtdTCAbynXoSh2smxnsVjcBfZQ5/HLo8oTNFSn2eE7dqJVseb5Qa+DppfXiejvoLL/Jyrq46DDQobvRHpYBI2lfiG2tWyrMr64Z9xUYWitnGH/RjVbtMCkTwgHvZbTmRKpBx77BJVsjA/CBHGwQ5jsZ1m/hUlszLKdothZacSfO4T4VmNRJFmWrPS8cjqusWBZFrOrzWvbs4wVRbGh2bV3mvtFcXUXSVF42Ej5+hqZxOtsm/nEd/i1WKXhiO7C17IRWhqUzGltes6t56OVy2YmpP/giYqtdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rHeksCBMWaffXaa+/3PfnjFroTYMvN467sDCc5YGllrCqYhilcsJJbC1rSZOc8Fxmnp9wONcAFL0p8AvT/fHKS/e5f+2SAwDe+ZXgSLBNTgXaj/p+PD3b++92aHlVZgk65AZYDrmRiBjZN2PEM8rIxXc3n82S+a9KZUrmzW703Gibu31M1fn9K4JYJN+X9dTt1pNF68CPprL73DdgOxrhhYeSaJz/RGPHQcEC3rX/vXHPd+h6f0Y2zAhJ+dNYT/Hx8EhWcFBIkZWj+VnYG+iR6V49xj3zIbhj77hbMOhMZ5HwM+dVPt2a0ujnnC1V5/g5Gre5WPUW38IYfCiFruwVtZxC3PvKLlY/u23INfzuEtLkzXDmBPcMJsFyYYLnporM92pu2yEApAcjmOQYWBqBBOUiPT+WCGrDbsYGTRP7sblgC+zHqWJsVw2o3rNA5mDZicI5CSFFURW0fndSzBpQVXvdo4wtHop0+rNA+3Ssr8IsbVkBj5OYFTuSQ7BjB/nGNZup7fEayYgWk69n4Y6RI556+owv2ZgYM22oz4JprGbu6C7lmPrOZ+xL2Gq83tMm6QWhlS1MoLVrkPpU1a5BvfUORzcrZ4b4hO9xmymtb6z4j6lsD1i9Mgb7fXd8+H0Wk7d1/QYTaAfvWxOqMkgWfXvNyp8+fEXl6eK4YIYZkjHT3xTUGOfp+/XaGg852HnS383DwEa+rzrKf/rga1I3Nq+qFRJ/DlYXwXV7l/E5FvZ8TSfOZKsrKtnmBnvzE7+HyDm415yb8Xcx2YtaLWT9mX8XsfsJ+AHLEpbXTzt/lQjvXnJAsUxX6TNJK5ws21jxFbzgk04RdXv5UcWmFXSyXrMcuL9H5v1wmyBxnUs2d3+74XBhhGfrdm7dOplKzxk+vUtPHR1H/Fcx3QqxB34N2n32lVjj12pelR8GHPiU3DfuF31foIjrUMBF53nLks9AUjgcdo5BD4Z3H3oWPCiO5k4S0ClEQgiV6vTFMFLqSMJIAHZIz3rj6ncbmhGM7GoGlGrhVms24cS9Zejrj9jBUws6g8E6tV8qC82ibUkkDTpiXa4BuPNK93opHLHRrvGJCho2jOBnenflm9PWgLV+GDx90xOWDroAZbBIw11hvUIw4XASTNzSfWpxPAii0X2X7Vb4PkyKynbgJROaoT1V5xnJxRs7NTJgy5wski3BZeihXvebPZkqZpod3XHs+M/tdh7jS6BO/n9T+wU+1Ow8f7Xak/eM7MKatmJe7hzHY6w8f9K+1L69YRT9cXjN2m5Mjw+2tTo56Nke3tQN/rB34bgh/9y7NYMNHo472tjv4dAa4I2tXm3FusHPdhTXrzsxKbXa7pUHpVzPsfDr17TVP3PGdPXFXxPCj4R2I4Q0v2U+lxCsP1jujPXZXr9V1BHiL5+q1b9RPJtA2sL84kT64m6ftcNDR1b7uqGpfj9pE+eDBrYiyvegKZZ1E4r++ef3DfPDHb6fq4ODg4NWbt7MXb6cHBwcF/k6SZK1VY91p0zKow/qQXn8v0x2/YZUkSRCFGB29T8P7pZz+mxsfbx6TnMgojlSJYddCyZdZtB9lGKgdNPkopucuGPuNyhbR/mXkY/bwTx8RhyP77w1Gel9GJp1BwfGvoK5jbDiGZkdxRKEbGB6O5xjtR2r8HlJco9QIgxVgcCT13r8MvVxEcxR7RSvaj9y+ojjyzrW6qY4FL7NJtAwLXjdV3dJMZeiP+jGD82AQ8EdOgy8cnKITEf9RMz1vzUB7K+BI4SM+BwvP+cK05nWP0Gg1EB/HIIenfhTL+MKgpKiMu9VSnqdVjsogXJRCL+oIBdIIW1RRw1uvVMM7fLCMKcIQdBskrjVfRHEkLBTt9g1EoNWHn1wKCjFDYWIfOva9gjHA730DmhPo4HnxwVC8V8DGQIdezpT84PHD0e5wNNwdjnAGH+vzoXME0whO8V6NTz+KETI4x/H+ef3xR+m+Xl27S5sHGEwLWVC2dpqo8JhRZGZyE5uE/oR5PoWb+eFoU7ZAK0jZzOiFxcsSuE4oaP+j80e6LFbf6skNDLWMo4ubN3PBUrUTUhHYVzlMrAsdYKnSEvT9djzSZ7O50d7eMo4WN29v8UVu7xEe3vzm3f1IORxNfss/A9bdx8s4mt0M63d1lsk/Edi9h8vmgo/I4Ajhfjodq2xxGuTW8qaO4a7CfhOVZ6BREboqrxpRgxIGs6lOV6+asVI5cLlG0HTSC3zmGyrdaPL1hpj5DMj2XuviNHuj6HsDsYMWUxZgJQpKGNSRdQUnUcJeTlrPBlLjVzMcQl/KNpCK3aP1Tk1FYvxe3/9GHN1rZ36hObYJRAwgUGdmoShzSoWaowV3TF79LGH1f6Rx1phEAMKNHRa++ap45qKvaEE/qJtHxLzSmrBnXNa5JN2cDXZ5WZMBUcdyyS4v8VRBn+K9v1zGTQOu1Wmgq921aEhBnHdG1U3QDKzbWkOdlnWakeMDG/x93wZATKWQ09NK+3lQGV0ukw5BrgBOhnePA8hqOhNTuWbXtcpEJ31r7F9BtqcAnOT/Dd6flE+/E2tAedIvnz4pn/6IWYMlON5z6JkImTnOn0OeJ+yJsVrJ6dMVFDzp+/b1R6nhXMCcGJdOtZllFbf1RImH6U8oqJvDE4alukoFzynsUKsUgn+HvFn4cjcWSoOeKGFppEvsoicBn2ogbxLBwitLWZL0JgwLPuFspmHy7/dWcHrv6RsEHR17T/r8qe/90tkiZvwcGJcLRhsnw4nSzvg2qTSJyTTnWkz8AzRmZQ4YIonvU546H5rDaIDjaMblmYmfjPXTI+AFe12CRAh+/vs/sEeQ6S/la52BvoVQfzlx3jrF7qEcuxe7cE0id6GN9aLaSUJPIQ6uDazj03XQ0/eiFv2mGhvsJcN8jWi1WkyngP4434MG++Q34OnMXRoEFZ8E10GJxKMqE8BDAgsPwsw7b/1BdU09LeyQK7C992SdVJeYLff66PAWuCQ71I5jFGeEcbt0c7DXR4eYcFsfd8LemhoTAbW804WhJYCdCx6S8mrNfuFC3MA5U7xcbPsvE5/qusOuApQJsxai2F3qKOHqhPYrEzcZ3HhEqrLoDxU+z5C4rINHgqJG5JGqbkOVN2CSs2lFGQUW2TfcmhRU3CTMCmmsrlx4H8sqHXKEPVk4MWFMg6eAFezUmj9mII0bztmEGws6ZpUUiHldoWmynhIuStACQwnWokCDQx2KjpuvqG726dsfvvd5+2EPgSnHyIFuYshYVRLVECfUWdHh5Fa3vlYf9OL7ZgBRd6MACW9fLUEbJVHEKT3l0ktQ9x5FI+oYZjx3Xb2oQD8cwoMcnqx9+//893+04NpoFLkKmFuBZxmGvN8AIdmjHcFjVKeGEiWg6kKE84H+/eoTAKEjpjktVFYzkrk9jR9SkLyp5aKPL6jjG0yVzvDaquWtiYOMNd6oYMj0TPZpClAocb9wIYxt5fWG7Jur8uEHQDymLRjoEYpcjTQvF20Gb+Iu1Mp09DwQ3Zzw+hF0hRd4ZdWphkLI291TbVO/VbUgqKwquBUpC1OZpJvp7/zJga8L9lUADanxXCh9fwOr4nSnSqZwKuQpnIO+xfP+VR0tTDbJMdg5gGzDFpDkrrMmG3uOBTc6OGndTlRzoEOMD2KkuwL0FE5TNFIR4cEt8Njr4Wy9HttxsHixairt/TK+UAbJDxQlzewIkVeH61yu5s5t1ydJ2HdqjjirNRrUO938iFJGkGexm6K1Qsol5rTTSxEfazhx7bsvOEVi+SVc+AydF+3G61ypc9jgLFjYAdeJr9tTEKF1khrH4gxhdccRbnNo0Wc8V8RSXrP0nztAvaS8/BldQXSE6F9y64RiGWouQf/8t/81FCXkgs9M/dpd+5UerDw3yiX9t2cNFB1oPuk+TwNJ+4CkdabOLomEUhshTyoIEKd7UMmYYoyxpRRVRRoV3TThWX/FdvqLGV+vs6T6YJ+tHfULMjQOB4Pfsh11d/Dl2FH3Bl+QHfUxAuvd3jdLk03a7VrZEXzb1w94r8A5unKlr++JzmQy0brgi3UIbthhtHT/NabfIMTbbR1nt7N/0ZjGee3fsmEvhIXRYID/657m807wK75sqhRfCpMqzxf/EsW395xffwQ1tGKtkfo6uT57L0Z/vUjPR4eIxw0vqWsn8IRY6RzLleH1tVNf4KTRt3ArZC4knBKKTzOVnmowp6PB4HQYuYPZW4fGN6oApwHMEZlztF3VqpDVC8anqMsgjes7xCpofRP5fRhkazARaOh0r4OEB1eR8FJS1iVVyTtSZyB/3Z22l7dueQT1osgbGRAJ14m+R53NttvdJg2klRZ2Ee0fX0YXO7wUO+77/vG75TvUxu1MYfBJqQxBzO0s2o/6q7EoBvQ5RRUcXzryrSnScJlhAN0V8chL0T8fJsNoGa+OWStOr+kP1c6HDjGWT4Wc3jTuXYOiN3iM7qQ6iGr0v1L8EVAB9OfQ7hVHAslnBhxfhoh5pI4fmgieF+GMQ5TNusCZ5ixXQ2FCJEwnuGX1WlsTrrI+WmX4oBUnchxCPiiKow7iWBeXUW89RFrUgRat2IlW6EQTDdEJhqD4hlZ4w3HDEnUkQVCAh6Q5jvb2SMV6NCRdZPcxXfN7D5dExI3rMIq67kHKElp1cn2az6brstn6IX5DfogVN4QnnsaW7qJUO0Zh39Q1kgYqrI2SHcvgqmFwo5Fug43OL7lii6oBWWcCQtPLWsuLH9V6Za9hyqBYdlkSgzyRJXcHxJJ7A2LJx4OOTuu338zQaKakftbaJ6mYbQ0T1ch3KEeFnCgSwl52hEOjO5KE+JWXCOSpKupigb1e65zrUb1eLVwdraIV5HWlWanmoCeVqz44yeFCoKkLh0FB35roAeBFDsbkmPVhYUq2Fyoqgj4Fb7VOecnHIheoBLgkL8c1jR5hEvZjE39wT7tMuHPIUXeojYVYgTfouXOlzyYYxxBjLV7MEERzMcgZl6mzTLsbjSysaPlAq3+phcH6qBqhFg42Ja1GVim45FNi4rjNFCyDHGWaYVqN0XFjVF45VrRc5Eq70EXaEEVGExJfXJT4iZ5TeBNomCFhn3v/hImdf8hdVr4i7xhdcSXCItBsZBWrZK6weC669Ko8Z6Wyzs2Gr7Y2jDjcai4Nqs8+WtKfQY0w7zoA4w1wbw3gCX8v5Jkr4LjDjmu6+hHGRljolndZZc773THfCvtdNcbysMoIq/SiGT0VdlaNSe1oT1L/cDN9Gyowt5SK2yddvgGLFGL6B4cvSWu9z37+2/+w74FryWZq7qg1rTTki6bYM5VCppN3aKuVTnJOoSRHjKeO+PwFFDD444xbsva9gjmaVR1Lucjqw2qci5QdhYCUXm+fPaOnWStIpVOOwqU2oseQs9KNzoU8S9iBXJCPo7mOsJ3GdbZBV2CrcDXHqFolfQi8WzNpICKruoH8HEzLeguZcH5YraqpW60NjN9cN9MT93aQZVcSJ9GC34DjbI7kAOXO+IgVptfkWnYSKbvRGyAzqmls9hkp58388Ur6J12GV5pC5mhAR+ynqY/EcaLfcd3q7LIrCnFX3pK9Fxfs1hLnpfDkdBzIknXrJn04WTt7Bd3v9KLyNygvxVofF1Z0Nq8nb0CfizQ8ozdwdJ8696M4ykUK3nji76+Dbw+/Z+e7ySCKW8+MWzB3//uXz168evMCgUFB6hA2TAbJgGy8ytiCy9ZK3WLtq1dbKwlgW9p9W9p9W9p9W9p9W9p9W9p9W9p9W9p9W9r9V6ultC3tvi3tvi3tvgET29Lu29Lun1o/ZFva/Tdf0mdb2n1b2n1b2n1b2n1b2n1b2n1b2n1b2n1b2v2LqJi9Le3+a1DgtrT7trT7trT7trT7trT7trT7trT7trT7trT7trT7b9QOvC3tvi3tvi3tvi3tvi3tvi3t/psq7d7KneqXOReylfjtkmyPVwq+v4ujGSbh7h9Hl5e4ylvMkcPmnyrK4jp+F0fnXAsMl6P83Tjkm2Ky1hlgotczF/23c4TLx461KUB+JW0ZE2bdiAOi52v7tvOED1+/OYriKBSsLFRGBQL4HJO7+Nwlv7UywKjtMsq5nFaUPRa5OZeunNKsm197Rvm1/o9WChpmkzYQdhNv3TbwX9zU2gGXly53l9I3XX/3aeMIj9jQG4/v3XK5/D/kAgaw","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var r=t(74848),i=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzGzeSfwU3dVWOuaPhQ/IjOp9rFdub+DZnq2L5UnuSVwvONElYM8AEwIjiqli1H/Yf3Kf7uj8tv+SqG8A8KFKSbSVr55gPjojBo9HobjT6dRlZPjXR/nH0XKVVAdKa6F0cZWBSLUorlIz2o6MZsOeaTywLndjB4UvG81zNDasMaMOsYlOQoLkFJmHOsjAdGy9YqdW5yIScsoxbzubCzhhnY27g4R4DmaoMMjYROSQn8kQeiXKfvS1zxTO2UJVmh8//UM+HC2Hbca/3HMbVlL192eu9+2pmbWn2+31elokqQRoxlTkfmyRVRT/DjmU2uR+z+Qw04Kws5ZIBNyJfMJ5lbC6yKVgTMzsDyVJVLliqlM6E5BZMzEo+BSarYgzaxIzLjBVKAxOScaaBZ4sdq3YqA+w/3rx+xSZKF9wm7DCvTFwvlwkNqc0Xbno7g3pX90zAhrFayGnMCn6G+BKW/VSJ9Ay3bUBm+H8ceHD4knDV672pylJpCxn70W1hv9fDL99AruaMa6D+qSoKJVnJNS/A0oHNuKXPGn6qhIbMH0ueB1zsn8gd1utJXsB+r8feSvFTBUxkIK2YCNC4S2ZnwvgBietvFyX1fykzkSLyCABsZWrS7YpIxa5vSkhxSte1hWqmJJvPRDojHM65O/8y56nblgZTQmrFOXQnvojZAid+DlIFCGZKi78qaXlOx3cO2oqU5+1jRgCxq7FcW0R/qYS0odWvwP7kjxNPmw7R0yGCliFyCyHpiwF2zvMKjIdqHrMZQvUDlBoMMYefFxEvMzYDMZ1tXI9n7ytjOxOzyiCYbSj8WuFUCb1AaJvw3AATkw4uC34GrdWYIqbnecK+WbAMJrzKbcwEUqjVFSTslbKMl2UuUj7OgWgAmY3bSsMOnbInn6RLPockA8AwzjIxmYBGZsaPNIUfE6BDumyEBnGanXHJlFw56FTlSl8lIWru4pGlSlqQNmEH51zkBLzbrGFCpnmVARvnPD2L2TivIGYaMsfoC0BBFzv+oC6MG49zwg8zkCMVKonwS+WXF4YZD1WWsCNklJr/8GNANS0iTBurnssnCldGFASWZFBwkceEuJi9V2Nmhc0hRgYvuVzEKGEhZhYu7FhdxCydQXpGf2meCcXGlbVKuo1lWpWZmkuPy4mS1oi/ruHI8OXDMTqK2V7MHsbsccyGg5gNRzEb7sVs+DBmw8cxGw1iNhrFbLQXs9FDB9bocRyuiIDgNgDDkcOy/XKwi3L6e2GIs1HAmlpmzzsye5iwXq/mJmz7y1/+ciIvTyRjJxEy10m0z06iustJFLtvKDPx29D/vsAfu6NH/ucCfz4cPfY/59R1uOd/zvDnaHgil37BEzkiSCwvymugwM93CoH/5YkI22hRbAvyDBtREMXhA55VBx78sGzvZRf3IqSwgudm83ZCj89oRw1IVza1h5sict28I/r8GW2nDQ9+ITHpPpFYbX0KDE9QjK7s/kHib5bNm3fLfjZ7b4HzaVt/iFtH0XSEomnz/mvp9RkhYRWmT8PEo4QUAJLMm/HgO3xGWOhC9Gk4eIw4wEtpMwLw62e0+xY4+MHf8O7bYG9n+GBnNBjtdTCAbynXoSh2smxnsVjcBfZQ5/HLo8oTNFSn2eE7dqJVseb5Qa+DppfXiejvoLL/Jyrq46DDQobvRHpYBI2lfiG2tWyrMr64Z9xUYWitnGH/RjVbtMCkTwgHvZbTmRKpBx77BJVsjA/CBHGwQ5jsZ1m/hUlszLKdothZacSfO4T4VmNRJFmWrPS8cjqusWBZFrOrzWvbs4wVRbGh2bV3mvtFcXUXSVF42Ej5+hqZxOtsm/nEd/i1WKXhiO7C17IRWhqUzGltes6t56OVy2YmpP/giYqtdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rHeksCBMWaffXaa+/3PfnjFroTYMvN467sDCc5YGllrCqYhilcsJJbC1rSZOc8Fxmnp9wONcAFL0p8AvT/fHKS/e5f+2SAwDe+ZXgSLBNTgXaj/p+PD3b++92aHlVZgk65AZYDrmRiBjZN2PEM8rIxXc3n82S+a9KZUrmzW703Gibu31M1fn9K4JYJN+X9dTt1pNF68CPprL73DdgOxrhhYeSaJz/RGPHQcEC3rX/vXHPd+h6f0Y2zAhJ+dNYT/Hx8EhWcFBIkZWj+VnYG+iR6V49xj3zIbhj77hbMOhMZ5HwM+dVPt2a0ujnnC1V5/g5Gre5WPUW38IYfCiFruwVtZxC3PvKLlY/u23INfzuEtLkzXDmBPcMJsFyYYLnporM92pu2yEApAcjmOQYWBqBBOUiPT+WCGrDbsYGTRP7sblgC+zHqWJsVw2o3rNA5mDZicI5CSFFURW0fndSzBpQVXvdo4wtHop0+rNA+3Ssr8IsbVkBj5OYFTuSQ7BjB/nGNZup7fEayYgWk69n4Y6RI556+owv2ZgYM22oz4JprGbu6C7lmPrOZ+xL2Gq83tMm6QWhlS1MoLVrkPpU1a5BvfUORzcrZ4b4hO9xmymtb6z4j6lsD1i9Mgb7fXd8+H0Wk7d1/QYTaAfvWxOqMkgWfXvNyp8+fEXl6eK4YIYZkjHT3xTUGOfp+/XaGg852HnS383DwEa+rzrKf/rga1I3Nq+qFRJ/DlYXwXV7l/E5FvZ8TSfOZKsrKtnmBnvzE7+HyDm415yb8Xcx2YtaLWT9mX8XsfsJ+AHLEpbXTzt/lQjvXnJAsUxX6TNJK5ws21jxFbzgk04RdXv5UcWmFXSyXrMcuL9H5v1wmyBxnUs2d3+74XBhhGfrdm7dOplKzxk+vUtPHR1H/Fcx3QqxB34N2n32lVjj12pelR8GHPiU3DfuF31foIjrUMBF53nLks9AUjgcdo5BD4Z3H3oWPCiO5k4S0ClEQgiV6vTFMFLqSMJIAHZIz3rj6ncbmhGM7GoGlGrhVms24cS9Zejrj9jBUws6g8E6tV8qC82ibUkkDTpiXa4BuPNK93opHLHRrvGJCho2jOBnenflm9PWgLV+GDx90xOWDroAZbBIw11hvUIw4XASTNzSfWpxPAii0X2X7Vb4PkyKynbgJROaoT1V5xnJxRs7NTJgy5wski3BZeihXvebPZkqZpod3XHs+M/tdh7jS6BO/n9T+wU+1Ow8f7Xak/eM7MKatmJe7hzHY6w8f9K+1L69YRT9cXjN2m5Mjw+2tTo56Nke3tQN/rB34bgh/9y7NYMNHo472tjv4dAa4I2tXm3FusHPdhTXrzsxKbXa7pUHpVzPsfDr17TVP3PGdPXFXxPCj4R2I4Q0v2U+lxCsP1jujPXZXr9V1BHiL5+q1b9RPJtA2sL84kT64m6ftcNDR1b7uqGpfj9pE+eDBrYiyvegKZZ1E4r++ef3DfPDHb6fq4ODg4NWbt7MXb6cHBwcF/k6SZK1VY91p0zKow/qQXn8v0x2/YZUkSRCFGB29T8P7pZz+mxsfbx6TnMgojlSJYddCyZdZtB9lGKgdNPkopucuGPuNyhbR/mXkY/bwTx8RhyP77w1Gel9GJp1BwfGvoK5jbDiGZkdxRKEbGB6O5xjtR2r8HlJco9QIgxVgcCT13r8MvVxEcxR7RSvaj9y+ojjyzrW6qY4FL7NJtAwLXjdV3dJMZeiP+jGD82AQ8EdOgy8cnKITEf9RMz1vzUB7K+BI4SM+BwvP+cK05nWP0Gg1EB/HIIenfhTL+MKgpKiMu9VSnqdVjsogXJRCL+oIBdIIW1RRw1uvVMM7fLCMKcIQdBskrjVfRHEkLBTt9g1EoNWHn1wKCjFDYWIfOva9gjHA730DmhPo4HnxwVC8V8DGQIdezpT84PHD0e5wNNwdjnAGH+vzoXME0whO8V6NTz+KETI4x/H+ef3xR+m+Xl27S5sHGEwLWVC2dpqo8JhRZGZyE5uE/oR5PoWb+eFoU7ZAK0jZzOiFxcsSuE4oaP+j80e6LFbf6skNDLWMo4ubN3PBUrUTUhHYVzlMrAsdYKnSEvT9djzSZ7O50d7eMo4WN29v8UVu7xEe3vzm3f1IORxNfss/A9bdx8s4mt0M63d1lsk/Edi9h8vmgo/I4Ajhfjodq2xxGuTW8qaO4a7CfhOVZ6BREboqrxpRgxIGs6lOV6+asVI5cLlG0HTSC3zmGyrdaPL1hpj5DMj2XuviNHuj6HsDsYMWUxZgJQpKGNSRdQUnUcJeTlrPBlLjVzMcQl/KNpCK3aP1Tk1FYvxe3/9GHN1rZ36hObYJRAwgUGdmoShzSoWaowV3TF79LGH1f6Rx1phEAMKNHRa++ap45qKvaEE/qJtHxLzSmrBnXNa5JN2cDXZ5WZMBUcdyyS4v8VRBn+K9v1zGTQOu1Wmgq921aEhBnHdG1U3QDKzbWkOdlnWakeMDG/x93wZATKWQ09NK+3lQGV0ukw5BrgBOhnePA8hqOhNTuWbXtcpEJ31r7F9BtqcAnOT/Dd6flE+/E2tAedIvnz4pn/6IWYMlON5z6JkImTnOn0OeJ+yJsVrJ6dMVFDzp+/b1R6nhXMCcGJdOtZllFbf1RImH6U8oqJvDE4alukoFzynsUKsUgn+HvFn4cjcWSoOeKGFppEvsoicBn2ogbxLBwitLWZL0JgwLPuFspmHy7/dWcHrv6RsEHR17T/r8qe/90tkiZvwcGJcLRhsnw4nSzvg2qTSJyTTnWkz8AzRmZQ4YIonvU546H5rDaIDjaMblmYmfjPXTI+AFe12CRAh+/vs/sEeQ6S/la52BvoVQfzlx3jrF7qEcuxe7cE0id6GN9aLaSUJPIQ6uDazj03XQ0/eiFv2mGhvsJcN8jWi1WkyngP4434MG++Q34OnMXRoEFZ8E10GJxKMqE8BDAgsPwsw7b/1BdU09LeyQK7C992SdVJeYLff66PAWuCQ71I5jFGeEcbt0c7DXR4eYcFsfd8LemhoTAbW804WhJYCdCx6S8mrNfuFC3MA5U7xcbPsvE5/qusOuApQJsxai2F3qKOHqhPYrEzcZ3HhEqrLoDxU+z5C4rINHgqJG5JGqbkOVN2CSs2lFGQUW2TfcmhRU3CTMCmmsrlx4H8sqHXKEPVk4MWFMg6eAFezUmj9mII0bztmEGws6ZpUUiHldoWmynhIuStACQwnWokCDQx2KjpuvqG726dsfvvd5+2EPgSnHyIFuYshYVRLVECfUWdHh5Fa3vlYf9OL7ZgBRd6MACW9fLUEbJVHEKT3l0ktQ9x5FI+oYZjx3Xb2oQD8cwoMcnqx9+//893+04NpoFLkKmFuBZxmGvN8AIdmjHcFjVKeGEiWg6kKE84H+/eoTAKEjpjktVFYzkrk9jR9SkLyp5aKPL6jjG0yVzvDaquWtiYOMNd6oYMj0TPZpClAocb9wIYxt5fWG7Jur8uEHQDymLRjoEYpcjTQvF20Gb+Iu1Mp09DwQ3Zzw+hF0hRd4ZdWphkLI291TbVO/VbUgqKwquBUpC1OZpJvp7/zJga8L9lUADanxXCh9fwOr4nSnSqZwKuQpnIO+xfP+VR0tTDbJMdg5gGzDFpDkrrMmG3uOBTc6OGndTlRzoEOMD2KkuwL0FE5TNFIR4cEt8Njr4Wy9HttxsHixairt/TK+UAbJDxQlzewIkVeH61yu5s5t1ydJ2HdqjjirNRrUO938iFJGkGexm6K1Qsol5rTTSxEfazhx7bsvOEVi+SVc+AydF+3G61ypc9jgLFjYAdeJr9tTEKF1khrH4gxhdccRbnNo0Wc8V8RSXrP0nztAvaS8/BldQXSE6F9y64RiGWouQf/8t/81FCXkgs9M/dpd+5UerDw3yiX9t2cNFB1oPuk+TwNJ+4CkdabOLomEUhshTyoIEKd7UMmYYoyxpRRVRRoV3TThWX/FdvqLGV+vs6T6YJ+tHfULMjQOB4Pfsh11d/Dl2FH3Bl+QHfUxAuvd3jdLk03a7VrZEXzb1w94r8A5unKlr++JzmQy0brgi3UIbthhtHT/NabfIMTbbR1nt7N/0ZjGee3fsmEvhIXRYID/657m807wK75sqhRfCpMqzxf/EsW395xffwQ1tGKtkfo6uT57L0Z/vUjPR4eIxw0vqWsn8IRY6RzLleH1tVNf4KTRt3ArZC4knBKKTzOVnmowp6PB4HQYuYPZW4fGN6oApwHMEZlztF3VqpDVC8anqMsgjes7xCpofRP5fRhkazARaOh0r4OEB1eR8FJS1iVVyTtSZyB/3Z22l7dueQT1osgbGRAJ14m+R53NttvdJg2klRZ2Ee0fX0YXO7wUO+77/vG75TvUxu1MYfBJqQxBzO0s2o/6q7EoBvQ5RRUcXzryrSnScJlhAN0V8chL0T8fJsNoGa+OWStOr+kP1c6HDjGWT4Wc3jTuXYOiN3iM7qQ6iGr0v1L8EVAB9OfQ7hVHAslnBhxfhoh5pI4fmgieF+GMQ5TNusCZ5ixXQ2FCJEwnuGX1WlsTrrI+WmX4oBUnchxCPiiKow7iWBeXUW89RFrUgRat2IlW6EQTDdEJhqD4hlZ4w3HDEnUkQVCAh6Q5jvb2SMV6NCRdZPcxXfN7D5dExI3rMIq67kHKElp1cn2az6brstn6IX5DfogVN4QnnsaW7qJUO0Zh39Q1kgYqrI2SHcvgqmFwo5Fug43OL7lii6oBWWcCQtPLWsuLH9V6Za9hyqBYdlkSgzyRJXcHxJJ7A2LJx4OOTuu338zQaKakftbaJ6mYbQ0T1ch3KEeFnCgSwl52hEOjO5KE+JWXCOSpKupigb1e65zrUb1eLVwdraIV5HWlWanmoCeVqz44yeFCoKkLh0FB35roAeBFDsbkmPVhYUq2Fyoqgj4Fb7VOecnHIheoBLgkL8c1jR5hEvZjE39wT7tMuHPIUXeojYVYgTfouXOlzyYYxxBjLV7MEERzMcgZl6mzTLsbjSysaPlAq3+phcH6qBqhFg42Ja1GVim45FNi4rjNFCyDHGWaYVqN0XFjVF45VrRc5Eq70EXaEEVGExJfXJT4iZ5TeBNomCFhn3v/hImdf8hdVr4i7xhdcSXCItBsZBWrZK6weC669Ko8Z6Wyzs2Gr7Y2jDjcai4Nqs8+WtKfQY0w7zoA4w1wbw3gCX8v5Jkr4LjDjmu6+hHGRljolndZZc773THfCvtdNcbysMoIq/SiGT0VdlaNSe1oT1L/cDN9Gyowt5SK2yddvgGLFGL6B4cvSWu9z37+2/+w74FryWZq7qg1rTTki6bYM5VCppN3aKuVTnJOoSRHjKeO+PwFFDD444xbsva9gjmaVR1Lucjqw2qci5QdhYCUXm+fPaOnWStIpVOOwqU2oseQs9KNzoU8S9iBXJCPo7mOsJ3GdbZBV2CrcDXHqFolfQi8WzNpICKruoH8HEzLeguZcH5YraqpW60NjN9cN9MT93aQZVcSJ9GC34DjbI7kAOXO+IgVptfkWnYSKbvRGyAzqmls9hkp58388Ur6J12GV5pC5mhAR+ynqY/EcaLfcd3q7LIrCnFX3pK9Fxfs1hLnpfDkdBzIknXrJn04WTt7Bd3v9KLyNygvxVofF1Z0Nq8nb0CfizQ8ozdwdJ8696M4ykUK3nji76+Dbw+/Z+e7ySCKW8+MWzB3//uXz168evMCgUFB6hA2TAbJgGy8ytiCy9ZK3WLtq1dbKwlgW9p9W9p9W9p9W9p9W9p9W9p9W9p9W9p9W9r9V6ultC3tvi3tvi3tvgET29Lu29Lun1o/ZFva/Tdf0mdb2n1b2n1b2n1b2n1b2n1b2n1b2n1b2n1b2v2LqJi9Le3+a1DgtrT7trT7trT7trT7trT7trT7trT7trT7trT7trT7b9QOvC3tvi3tvi3tvi3tvi3tvi3t/psq7d7KneqXOReylfjtkmyPVwq+v4ujGSbh7h9Hl5e4ylvMkcPmnyrK4jp+F0fnXAsMl6P83Tjkm2Ky1hlgotczF/23c4TLx461KUB+JW0ZE2bdiAOi52v7tvOED1+/OYriKBSsLFRGBQL4HJO7+Nwlv7UywKjtMsq5nFaUPRa5OZeunNKsm197Rvm1/o9WChpmkzYQdhNv3TbwX9zU2gGXly53l9I3XX/3aeMIj9jQG4/v3XK5/D/kAgaw",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,g={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,r.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,r.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,r.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,r.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,r.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,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,r.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"6",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"7",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"8",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,r.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"9",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,r.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"10",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"11",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"12",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"13",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"14",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,r.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,r.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,r.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,r.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,r.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(a(),{parameters:void 0}),"\n",(0,r.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,r.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/98334e25.163938f2.js b/assets/js/98334e25.163938f2.js new file mode 100644 index 000000000..5baaed62e --- /dev/null +++ b/assets/js/98334e25.163938f2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7024],{16460:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>k,metadata:()=>s,toc:()=>I});const s=JSON.parse('{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/v1.1/get-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-webhook","permalink":"/docs/API-docs/v1.1/get-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar_label":"Get Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vs1u20YQfpXpXtoItKSkKQroFCMwXKNGYtQOfLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZyNIlkHM7sQtppW1CzFPRI4h88qRskbMxE2FcI4EHQOcXl2A1NquYG0bIAslEqy6x8ZrkQjr0EsWv8jFTJRIvfJEeAzOmoBBzDbi2XTKX4f2rpsswxCKRsNOj0hEZg2hIeaXzmmVxYfJu8BCGxGyCmvJv2jtUMyETd9hRiIRzrMaUq3JztEBYyCvTCkSgQ+ydppJFZELs8lkbRt/0kmcNF6/6FjGma3FdpsIUhQFlNHK4Ns+uLfPptO3P4rtlnmeT58/DvJNQA/GEhS2Mfk3/1186L31X47u2PaXAmHn+zB+eBzGhVlKrfKIiRu7QPP/RjI0T615dvWh1ixnZN2GFJniuzgIdUhvgwyYNV7RWszuNuLhRDp10r7P7ubbeSJqpMp2mGaHJVViJiarHbwD+iX6EOW5F/ZYCtLkqX0YW4cmqNJomQbG0UQ6NVk+HT8V2+RYRjr3VfzYnHytSCBZKlP+ldx8n5trrl9booMM7QolnfoZ1yLpCzDkSoRi3FQoc/SxWMoUNgp3ZXnt0Fyr0sSiRuPHA+kWdWZr5NFDFcJo1It8/PWPndRoBLnNmhoNRfiN7829ed14cHaFnoeLNDkUGh9UqjGKYR3fQj/XAspaYwh6DcoQll4SQq5KRVID50mZEjLpZKq0YtQym2VpDwPghzHcVkgVen761iNIyHGJmsEOsiFbS2JVvb+wsn5RaLsKCUhIm6AMhgBoKmkyZuwrkYD1IA2gIfTOq4AQyLPXqvXNGvIyI6ilkSWy7gSGycpRK4YreJs2gSBY3USXgaTS1mMOfUAGMQ8xiWcPjp+AqZmtnceKYbNEKBuVY0ggszlCiE3KIZgcUgwEjn1RGQZW2hhts0UsYNFoDc7yzFBSgy0OfGRx8tKEwvq69aWvwS5hzlteGdg6OBq9CcgVvlRmEWaj0b05gbsdrm4xDYpw/l3fAqvV6hH0nxzKnCv6qUnhF3Q2KLJ+vZcuFVVNGttlqGT3p9V0jgYjfgbNsNeR2yw87j6mTirUbnKNxAgJk9Orizhmn8DHD7/BJUpvoLKrFq1Z41GvoexNcebayrdp201JKGwEXsUZz1rweXzfYKA+g7eVpI8ffg/wClegTNdSHMpodNWkWmVwg7XTkjCMRjN46ZFNUk8DqiRBJg2kCKGSDKWlkiDBtdJamcUYTs0aGl5HK0VVBAPTo9xBGJyXXbkDpDJgDtZEid7meO8R0+uAeomBdfGuSxEwV8SIrrxtytba0JkuOI+F0hpuVV4ixdhO8xxcR161ZE74wB0suCGowjVIjxDQ0BiujkTiS+Oc9eyFap0vLF9SXAA0ubPKUJhB7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddXzPQ/lokB/OW48FejYY2muvr4tTHZzuelgCo/XfwJr3M08tmcXzAWupdLtRXhzriascfR1eF9folyrrD7fPdPQkMk9EIrTK0AQcnAin51eXsPx+PBXJYD3+jeaeXF68PHt1fcbO8CBtE/Z0PB1PmeRsoFqagaXBIX281zb7w+mf3Nzd8iV8oInTUsVbJwaz6e6Uu93xO09EZQMxabPhZnrj9XbL5PcNer5+5olYSq9kyjv5br5N+pXNh80C15y0LEPHV9BS6qbd+0fH3sHFdH52IxLBU+fwVFjEU6H7wdr7J7Me6D68IVoH+JMPmk8KbDbtGbLd7vjbp89KdAH23JzA+Xa7/RPRNKSi","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"}}');var i=t(74848),n=t(28453),r=t(33617),p=t.n(r),l=t(17543),a=t.n(l),d=t(86013),c=t.n(d),h=t(63723),b=t.n(h),m=(t(18766),t(79329),t(9303));const k={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u20YQfpXpXtoItKSkKQroFCMwXKNGYtQOfLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZyNIlkHM7sQtppW1CzFPRI4h88qRskbMxE2FcI4EHQOcXl2A1NquYG0bIAslEqy6x8ZrkQjr0EsWv8jFTJRIvfJEeAzOmoBBzDbi2XTKX4f2rpsswxCKRsNOj0hEZg2hIeaXzmmVxYfJu8BCGxGyCmvJv2jtUMyETd9hRiIRzrMaUq3JztEBYyCvTCkSgQ+ydppJFZELs8lkbRt/0kmcNF6/6FjGma3FdpsIUhQFlNHK4Ns+uLfPptO3P4rtlnmeT58/DvJNQA/GEhS2Mfk3/1186L31X47u2PaXAmHn+zB+eBzGhVlKrfKIiRu7QPP/RjI0T615dvWh1ixnZN2GFJniuzgIdUhvgwyYNV7RWszuNuLhRDp10r7P7ubbeSJqpMp2mGaHJVViJiarHbwD+iX6EOW5F/ZYCtLkqX0YW4cmqNJomQbG0UQ6NVk+HT8V2+RYRjr3VfzYnHytSCBZKlP+ldx8n5trrl9booMM7QolnfoZ1yLpCzDkSoRi3FQoc/SxWMoUNgp3ZXnt0Fyr0sSiRuPHA+kWdWZr5NFDFcJo1It8/PWPndRoBLnNmhoNRfiN7829ed14cHaFnoeLNDkUGh9UqjGKYR3fQj/XAspaYwh6DcoQll4SQq5KRVID50mZEjLpZKq0YtQym2VpDwPghzHcVkgVen761iNIyHGJmsEOsiFbS2JVvb+wsn5RaLsKCUhIm6AMhgBoKmkyZuwrkYD1IA2gIfTOq4AQyLPXqvXNGvIyI6ilkSWy7gSGycpRK4YreJs2gSBY3USXgaTS1mMOfUAGMQ8xiWcPjp+AqZmtnceKYbNEKBuVY0ggszlCiE3KIZgcUgwEjn1RGQZW2hhts0UsYNFoDc7yzFBSgy0OfGRx8tKEwvq69aWvwS5hzlteGdg6OBq9CcgVvlRmEWaj0b05gbsdrm4xDYpw/l3fAqvV6hH0nxzKnCv6qUnhF3Q2KLJ+vZcuFVVNGttlqGT3p9V0jgYjfgbNsNeR2yw87j6mTirUbnKNxAgJk9Orizhmn8DHD7/BJUpvoLKrFq1Z41GvoexNcebayrdp201JKGwEXsUZz1rweXzfYKA+g7eVpI8ffg/wClegTNdSHMpodNWkWmVwg7XTkjCMRjN46ZFNUk8DqiRBJg2kCKGSDKWlkiDBtdJamcUYTs0aGl5HK0VVBAPTo9xBGJyXXbkDpDJgDtZEid7meO8R0+uAeomBdfGuSxEwV8SIrrxtytba0JkuOI+F0hpuVV4ixdhO8xxcR161ZE74wB0suCGowjVIjxDQ0BiujkTiS+Oc9eyFap0vLF9SXAA0ubPKUJhB7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddXzPQ/lokB/OW48FejYY2muvr4tTHZzuelgCo/XfwJr3M08tmcXzAWupdLtRXhzriascfR1eF9folyrrD7fPdPQkMk9EIrTK0AQcnAin51eXsPx+PBXJYD3+jeaeXF68PHt1fcbO8CBtE/Z0PB1PmeRsoFqagaXBIX281zb7w+mf3Nzd8iV8oInTUsVbJwaz6e6Uu93xO09EZQMxabPhZnrj9XbL5PcNer5+5olYSq9kyjv5br5N+pXNh80C15y0LEPHV9BS6qbd+0fH3sHFdH52IxLBU+fwVFjEU6H7wdr7J7Me6D68IVoH+JMPmk8KbDbtGbLd7vjbp89KdAH23JzA+Xa7/RPRNKSi",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,g={},I=[];function f(e){const o={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,i.jsx)(p(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{webhook:{type:"string",example:"https://your-webhook-url@example.com"}},title:"inline_response_200_7"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/98334e25.740e393e.js b/assets/js/98334e25.740e393e.js deleted file mode 100644 index 8a2e62234..000000000 --- a/assets/js/98334e25.740e393e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7024],{16460:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>m,contentTitle:()=>Z,default:()=>I,frontMatter:()=>u,metadata:()=>n,toc:()=>v});const n=JSON.parse('{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/v1.1/get-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-webhook","permalink":"/docs/API-docs/v1.1/get-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar_label":"Get Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vs1uGzcQfpUpL22EtVZpUxTQKUZguEbdxKgd+GALAXd3dpcRl2TIWcmCICCHvkFPvfbR8iTFcHf15yRt2qIX/QznG87PN8NZC5JVENM7cYtZbe1czBJRYMi9cqSsEVNxUyOcI0GvAKdXFyC1tktY2RbIQoUEy/6w9Vokwjr0kuEXhZiKCmkwngiPwVkTMIjpWnw7mfDX4X3XbZ5jCGWrYWtHJCK3htAQ60vntMrjQfo2MGgtQl5jI/kXrRyKqbDZW8xJJMJ5NkOqu7J3dE8xkFemEonAB9k4zaKayIVpmq5s6096xEnr9fNeZZzbRmw2iSBFEaCMVgbfDMG9+XYyefOD2GxY59nk2eMgXwf0YCxBaVtTfPXfxYfeW//56I7v/lwg7PwQxvePw7gwC6lVETlxY+do/t9I9q+n7np29aHRjDOy6UKKSvFcHIS6L++CDJi3XtFKTO/W4uFEOnXSnU/vZptZIhqk2vacZocl1WIq0uWW3gH9An2I+CNaL2VVof+xzaK7py1Z+Nnm8y4m7psd7xbKU2dpHDpY3WZMuvTKy7LV+qVczKVPrUOTPh1PxhOxSdZHRoI0RWYfxqwUVGW0zEK0IZ1KF0/HTz+Ckc59kT62J18KCSQrZaq/ws12xbhmwnScOCjJlhnSqZ9wJZKh4vtaiVCc/RplgT6yQ5nSRnDPg1cOzbWqTCxLvPx4At6izm2DPOuoRhiNBsiHX//YokYjKGzeNmgo8n18b+7Nq9aDs0v0PM2kKaDU+KAyjRGGTTwLwyANKBuNIegVKENYeUkIhaoUSQ2cJ2UqyKWTmdKK24TVLKM97HVaGMNtjVSj56OvPYKEAheoubtAtmQbSWxq8BeW1s9LbZchAQlZG5TBEABNLU3OikMlErAepAE0hN55FRACefZadb5ZQ17mBI00skK2ncB+sgrUivsDvM3aQBCsbqPLQFJp67GAISCDWISYxLMHx0fA0tw2zmPNtFkgVK0qMCSQ2wIhxKnAIZgCMgwEjn1ROQY22hpt83ksIHcQOMtDSkkNtjzwkeHkpQml9U3ny1CDbcKct/xGYefgaPQ6IFf4Upl5mI5G9+YE7ra8usUsKMLZN0MLLJfLR9R/cog5V8ST4hd0NiiyfrVDV4qGabBvZPuns3SOBiN/9pphZ6OweXjcfSxNa9QuvUZihoT09OoizvUn8OH9b3CJ0huo7bJja9561Cuohqs4c13lu7RtxzKUNhKv5oznHfk8vmsx0JDB21rSh/e/B3iJS1CmbykOZTS6ajOtcrjBxmlJGEajKbzwyFfSIAOqJUEuDWQIoZZMpYWSIMF1aK3MfAynZgUtv39LRXUkA8sj7iAMzsu23AEyGbAAayJiuHO884jlTUC9wMC2+HHNELBQxIyuvW2r7rZ9Z/rgPJZKa7hVRYUUYzstCnC9eNmJOeF77mDJDUE1rkB6hICGxnB1BIknrXPWsxeqc760vLpxAdAUzipDYQqFlyXt7Cc7ouecZmXNR0RdCuU2HUlvZluSrhP7iLfS8T0P5aNBfjhvPZbo+cLQrZdDXZzq6XQ30BKYrf+G1rwQ8NSSedxXsJFKdy/K82M7cXdA34RX5TX6hcqHTfETHZ1G5VQkQqscTcC9neT0/OoSFt+NJwdP/99o7vTy4sXZy+szdoYHaZewYQUQzgZqpNm7aW9zP37X1rtN7Z8s+f3jS/hAqdNSxeUqBrPuF6O77bY9S0RtA7FoveZmeu31ZsPidy16XrdmiVhIr2TGb/LdbJMMTzZvUnNccdLyHB2vXQup2+7dP9ouD1a087MbkQieOoerwjyuCv0Ptj4cmdWe7cMdonOAP3mh+Shgve7WkM1mq98dfRLRBzhocwJnm83mTzBVzE0=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"}}');var s=t(74848),i=t(28453),a=t(33617),c=t.n(a),r=t(17543),d=t.n(r),p=t(86013),h=t.n(p),l=t(63723),k=t.n(l),b=(t(18766),t(79329),t(9303));const u={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1uGzcQfpUpL22EtVZpUxTQKUZguEbdxKgd+GALAXd3dpcRl2TIWcmCICCHvkFPvfbR8iTFcHf15yRt2qIX/QznG87PN8NZC5JVENM7cYtZbe1czBJRYMi9cqSsEVNxUyOcI0GvAKdXFyC1tktY2RbIQoUEy/6w9Vokwjr0kuEXhZiKCmkwngiPwVkTMIjpWnw7mfDX4X3XbZ5jCGWrYWtHJCK3htAQ60vntMrjQfo2MGgtQl5jI/kXrRyKqbDZW8xJJMJ5NkOqu7J3dE8xkFemEonAB9k4zaKayIVpmq5s6096xEnr9fNeZZzbRmw2iSBFEaCMVgbfDMG9+XYyefOD2GxY59nk2eMgXwf0YCxBaVtTfPXfxYfeW//56I7v/lwg7PwQxvePw7gwC6lVETlxY+do/t9I9q+n7np29aHRjDOy6UKKSvFcHIS6L++CDJi3XtFKTO/W4uFEOnXSnU/vZptZIhqk2vacZocl1WIq0uWW3gH9An2I+CNaL2VVof+xzaK7py1Z+Nnm8y4m7psd7xbKU2dpHDpY3WZMuvTKy7LV+qVczKVPrUOTPh1PxhOxSdZHRoI0RWYfxqwUVGW0zEK0IZ1KF0/HTz+Ckc59kT62J18KCSQrZaq/ws12xbhmwnScOCjJlhnSqZ9wJZKh4vtaiVCc/RplgT6yQ5nSRnDPg1cOzbWqTCxLvPx4At6izm2DPOuoRhiNBsiHX//YokYjKGzeNmgo8n18b+7Nq9aDs0v0PM2kKaDU+KAyjRGGTTwLwyANKBuNIegVKENYeUkIhaoUSQ2cJ2UqyKWTmdKK24TVLKM97HVaGMNtjVSj56OvPYKEAheoubtAtmQbSWxq8BeW1s9LbZchAQlZG5TBEABNLU3OikMlErAepAE0hN55FRACefZadb5ZQ17mBI00skK2ncB+sgrUivsDvM3aQBCsbqPLQFJp67GAISCDWISYxLMHx0fA0tw2zmPNtFkgVK0qMCSQ2wIhxKnAIZgCMgwEjn1ROQY22hpt83ksIHcQOMtDSkkNtjzwkeHkpQml9U3ny1CDbcKct/xGYefgaPQ6IFf4Upl5mI5G9+YE7ra8usUsKMLZN0MLLJfLR9R/cog5V8ST4hd0NiiyfrVDV4qGabBvZPuns3SOBiN/9pphZ6OweXjcfSxNa9QuvUZihoT09OoizvUn8OH9b3CJ0huo7bJja9561Cuohqs4c13lu7RtxzKUNhKv5oznHfk8vmsx0JDB21rSh/e/B3iJS1CmbykOZTS6ajOtcrjBxmlJGEajKbzwyFfSIAOqJUEuDWQIoZZMpYWSIMF1aK3MfAynZgUtv39LRXUkA8sj7iAMzsu23AEyGbAAayJiuHO884jlTUC9wMC2+HHNELBQxIyuvW2r7rZ9Z/rgPJZKa7hVRYUUYzstCnC9eNmJOeF77mDJDUE1rkB6hICGxnB1BIknrXPWsxeqc760vLpxAdAUzipDYQqFlyXt7Cc7ouecZmXNR0RdCuU2HUlvZluSrhP7iLfS8T0P5aNBfjhvPZbo+cLQrZdDXZzq6XQ30BKYrf+G1rwQ8NSSedxXsJFKdy/K82M7cXdA34RX5TX6hcqHTfETHZ1G5VQkQqscTcC9neT0/OoSFt+NJwdP/99o7vTy4sXZy+szdoYHaZewYQUQzgZqpNm7aW9zP37X1rtN7Z8s+f3jS/hAqdNSxeUqBrPuF6O77bY9S0RtA7FoveZmeu31ZsPidy16XrdmiVhIr2TGb/LdbJMMTzZvUnNccdLyHB2vXQup2+7dP9ouD1a087MbkQieOoerwjyuCv0Ptj4cmdWe7cMdonOAP3mh+Shgve7WkM1mq98dfRLRBzhocwJnm83mTzBVzE0=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},Z=void 0,m={},v=[];function x(e){const o={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,s.jsx)(c(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(k(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{webhook:{type:"string",example:"https://your-webhook-url@example.com"}},title:"inline_response_200_7"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.575920a9.js b/assets/js/9c9cb35e.575920a9.js deleted file mode 100644 index c227666cf..000000000 --- a/assets/js/9c9cb35e.575920a9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>g});const s=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zGzeSfwU3dVWJucPhhyXb0b2ckngT32ZtlS1f6k7SKuBMk4Q1A0wAjChGxap92H9wT/e6Py2/5KobwHCGH5JsyVllj3lwxMFXo9Hd6A90X0eWT0x0cBIdQ1Hm3IKJzuIoA5NqUVqhZHQQHU+BhWb2jQaO39nh0SvG81zNDKsMaMOsYik2AksrY1UhfuGjHJgNE8dsNhXplBnQl8C4YaO8glILaQ0bK80mIEFzK+SEZSqtCsCGmbBTVmrIYCwkZMxYXaW20mAS9r5UkpkqTcGYcZXXKzkwhJIxs1MgQDXYSkvDOKuk+LkC1umE3uci63SYnXLLUi7ZCHA7Ge7GAwQNcEYc25SkiU0JqRgL7OznSk7lqTwW5QF7X+aKZ2yuKs2Ovv1jPQXOi99OOp1vYVRN2PtXnc7Zl1NrS3PQ6/GyTFQJ0oiJzPnIJKkqehl2LLPxE8QgaMBZCVbgRuRzxrOMzUQ2AWtox5KlqpyzVCmdCelQX/IJMFkVI9AmZlxmrFAamJCMMw08m3et6lYG2H+8e/Maj6PgNmFHeWXierlMaEhtPnfTIwbCrr5wmHm2h+cj5CRmBb/AgxSW/VyJ9AK3bUASWv2ZEK46nXdVWSptIWM/ui0cdDrY8jXkasa4BuqfqqJQkpVc8wIsURseGDZr+LkSGjJHKjzPAy4OTmWXdTqSF3DQ6bD37uBFBtLiqWkiOjsVxg9IXH87L6n/K5mJFJFHAOBXpsbtrohU7PrOE4Lr2kA1UoojesThjLvzL3Oeum1pQBqy4hLaE1/FbI4TfwtSBQimSotflLQ8p+O7BG1FyvPmMSOARJiWa+KjUglpw1e/Avsvf5x42nSIng4RtAyRWwhJLQbYJc8rMB6qWcymCNVbKDUY4gc/LyJeZmwKYjLduh7PPlTGtiZmlUEwm1D4tcKpEnqB0DbmuQEmxi1cFvwCGqsxRUKL5wn7es4yGPMqtzETSKFWV5Cw18oyXpa5SEk6IQ0gs3GUKV06ZU8+SZt8jrS6FBmgCMnEeAwamRkbaQo/JkCHdFnSANwecZqdcsmUXDnoVOVKr5MQfW7jkaVKWpA2YYeXXOQEvNusYUKmeZUBG+U8vYhJrsZMQ+YYfQ4opWPHH9QFha/DOeGHGciRCpVE+KXyywuzlHAJO0ZGqfkPGwOqaRFhmlj1XD5WuDKiILAkg4KLPCbExeyDGjErbA4xMnjJ5TxmGbcQMwtXdqSuYpZOIb2gvzTPhGKjyloU7LhmplWZqZn0uBwraY34ZQNHhpaPx+gwZnsxexazFzEb9GM2GMZssBezwbOYDV7EbNiP2XAYs+FezIbPHFjDFx7XvEZwE4DB0GHZ/n6wi3L6B2GIs1HAmlpmz1oye5CwTqfmJvz2008/ncrrU8nYaYTMdRodsNOo7nIaxa4NZSa2DfzvK/zxdPjc/5zjz2fDF/7njLoO9vzPKf4cDk7lwi94KocEieVFeQMU2PygEPhfnojwGy2K34I8w48oiOLQgGfVggcbFs29PMW9CCms4LnZvp3Q4xHtaAnS2qb2cFNErtt3RM2PaDtNeLCFxKRrIrHaaAoMT1AM13a/n/ibZfvm3bKPZu8NcO639We4dRRNxyiatu+/ll6PCAmrMN0PE88TUgBIMm/Hg+/wiLDQhuh+OHiBOMBLaTsCsPUR7b4BDjb4G9619fe6g/3usD/ca2EAbSnXoSi6Wdadz+cPgT3UefzyqPIEDdVpdmi2jrUqNpgfZB0se3mdiP4OKvufUVEfBR0WMrQT2xZvsBCbWrZVGZ9/YdxUYWitnGH/pWo2b4BJTQgHWcvpVInUA499gko2QoMwQRx0CZO9LOs1MIkfs6xbFN2Vj/izS4hvfCyKJMuSlZ5rp+M+FizLYrb+eeP3LGNFUWz57L63PveKYn0XSVF42Ej5+iohdwXpbNv5xHf4rVhlyRHthW9kI/Q0KJnT2mTObeajlctmKqRv8ETFVjpomFQ513CFdqkRSrreD89jgcWWmj3Zsd6TAEGxZl++8dr7E0/+uIX2BPjl9nFrO8NJDr2DjWmYwBUrubWgJU12yXOROf9clz7AFS9KNAF6fzk9zf7wrz1yQKCNbxmeBMvERKDfqPeXk8Puf59t6FGVJeiUG2A54EomZmDThJ1MIS+XrqvZbJbMnpp0qlTu/FYfjIax+/dcjT6cE7hlwk35ZNNOHWk0DH4knVV734BtYYwbFkZuMPmJxoiHBn26bb29c8N163s8ohtnBSRsdN4TbD45jQpOCgmSMiz/VnYK+jQ6q8c4Ix+yW8ae3YFZpyKDnI8gX2+6M6PVn3M+V5Xn7+DUam/VU3QDb9hQCFn7LWg7/bjRyK9WGl3bYgN/O4Q0uTNcOYE9wwmwXJjguWmjsznau7bIQSnBuZJHwMIANqqp9N5cUAN2NzZwksif3S1LYD9GHWu3YljtlhVaB9NEDM5RCCmKqqj9o+N61oCywuseTXzhSAwyhBWap7u2Ar+6ZQXv5t+ywKkckB8j+D9u0Ex9j0ckK1ZAupmNP0WKtO7pB7pgb2fAsK0mA264lrGru5Br5jPbuS9hb/B6Q5+sG4RetjSF0qJH7r6sWYN85xuKfFZNP9x2ymv2ekTUtwGsz0yBvt9D3z6fRKTN3f+OCLUF9p2J1TklCz65wXKn5kdEnh6eNSfEgJyR7r64wSFH7TdvZ9BvbWe/vZ1n/U+wrlrL3t+46tcfl1bVS4kxh7WF0C6vcv6got7PiaT5jSrKyjZ5gUx+4vdweYewmgsT/iFm3Zh1YtaL2Zcxe5Kwt0CBuLQO2vm7XGgXmhOSZarCmEla6XzORpqnGA2HZJKw6+ufKy6tsPPFgnXY9TXG+heLBJnjQqqZi9udXAojLMO4+9LWyVRqNsTpVWp6aBT1XsOs+62Pjfc8aE/Yl2qFU2+0LD0KPtaU3DbsM9tXGCI60jAWed4I5LPwKRwPBkYhh8IHj30IHxVGCicJaRWiIDyW6HRGMFYYSsKXBBiQnPJlqN9pbE44Nl8juPcfSrMpN86SJdMZt4dPJewUCh/Ueq0suIi2KZU04IR5uQHoZUS601mJiIVuy6iYkGHjKE4GD+e+GX7Vb8qXwbP9lrjcbwuY/jYBc4P3BsWIw0VwecOyqcH5JIDC93W2X+X7MCki24mbQGSO+lSVZywXFxTczIQpcz5HsgiXpYdyNWr+zVQps+zhA9eez8xBOyCuNMbEnyR1fPC+fufB86ctaf/iAZxpK+7l9mH093qD/d6N/uUVr+jHy2vG7nJy5Li908lRz+XR7fzAn+oHfhjCf/qQbrDB82FLe3vavz8DPJC3q8k4t/i5HsKb9WBupSa73dGh9Js5du5PfXufw8RdEcPPBw8ghrdYsvelxDWD9cFojz2UtbqJAO9grt5oo96bQJvAfnYi3X8Y03bQb+lqX7VUta+GTaLc378TUTYXXaGs00j859dv3s76f/puog4PDw9fv3s/ffl+cnh4WODvJEk2ejU2nTYtgzqsf9Lr72W647eskiQJojDjlh/Q8F4pJ//mxsfbxyT+OchncrXuP0R0c4NH9f5SoO7621w0m9ynn4/P78eBzP93KqM4UiVlBCj5KosOIpddEN7aRzG5QsDYr1U2jw6uI/+eE//0ryVxaO+DwSyG68ikUyg4/hVMOcx7GIscp0JDHrSJ4oge+GASBFJfdBCp0QdIbRRj8LlEDyEYnIPGHVyHXu7dexR7dTw6iBz1R3HkQ7D1JwYyVfiooszG0SIseNNU9ZflVIb+qBMPcB58Kv6J09DQxUrexyfN1JxhsUTrcjKuNZ9Hqykm4Y14CPC7cfUj2HweLglh0SVRP1ymblEcCQtFc5Uth6bVx2M6BYU7ocd/HzuWjoUXH70mjiunSn7SQP8+61OGflCj808iRxzs/SAbzvqOp+Na1xduk8ohvnqGLGjF3eXz/ZjRE9rkNkoN/QnLfNJc03nP1tY83pbW0XhNbqZkCvOyBK4Tyq745EQfyqXieVpROlMtlls7q0GtdzZYxNHV7Zu5YqnqhpwR9mUOY+veeLBUaQn6SfPh2KPZ3HBvbxFH89u3N/9dbu85Ht7s9t39SMk2y0SkfwSsT18s4mh6O6zf1+lA/0Bg954tlnfsigpxPlLZ/DzIrcVtHcNlhv0wme2VfKMz0A1EjJTKgcs1TLwaO8e6Yl+gxfNF7F5WURaH0CZcZGyGbmcNKWBGGD24DLKKeV3HpXgw/7IenfIv8QOpaaYaGewlw3zGTTgCZrWYTABd574HDfZ5KsApK1P69158HLx8pYZLoSoTwEN/Ot4uOaCX28VZsEnISdsqa2CHvPbNvSfN08EveLlKTGx5c3x0B1ySydh1iXtOP3C7dHOwN8dHmBsnxl79S9h7U2MioJa3ujBUx9il4CF/ppbtc/caBZzfU9FmW6GGxGelddk6QJkwGyGKXdosRrTqxNm1iZfJlnhEqrIYuhA+JchYKE0LjwRFjchjVd2FKm/BJGeTih7/WmTZkChH7/+WuW1CuoxcsjeySod0Pk8W2BPTc5d4CljBTo35YwbSuOGcjbmxoGPM1UXM6wqti3pKuCpBC4z6bUSBBoe680pv1NfaOGgnir1/+4NPsQ17CEw5Qg50E0PGqpKohjihTmAMJ7e69TVFCbkD9Pk2xXBd9aBYpneFlKCNkmguKT3hUvziSJg0ErS2RjDluevqRQW6zBEe5PA2MEHW/vq3vzfg2qrprgPmVuBZhq9Tb4GQTEpH8KjpayhRAqo2RDgf6H9fvQQQOmKa80JlNSOZu9P4Eb1nNbVc9KHAOhRpqnSKhkUtb00cZKzxaqUhG5UMWYollrhfuBLGNlLwwkP5dfnwFhCPaQMGUkOQq5Hm5bzJ4MsQqVqZjhIFRTt9s74G13iBV1adayiEvNs91fTKWVULgsqqgluRsjCVSdpJuS70E/i6YF8G0JAaL4XST7awKk53rmQK50KewyXoOyh4r+uHfRmfI3HbGYBswhaQ5K6zZeLkDHPjWzhp3E6UHtwixv0Y6a4APYHzFM0UIjy4Ax47HZyt02FdB4sXq6bS3rXic9pJfqAoWc6OEPns0zrtYnnnNksJJOx7NUOcxazMAd9noxnv5keUMoI8c0UQmiukXGL6KXl1MOcUJ67DbAWnRxN+CRfppvOi3bxyVnjqPDs4C+Zg4zrxTXsKIrTOJ+GYRx1WdxzhNoduFcZzRSxlp0s5nLWBekUptFO6gugI0RXs1gl57WomQf/61/81FNB370RMglvY2kqhfp4b5fJzm7MGig40n5CDao2k/duBTcbuzR6PIECc7kHVHYoRPgOjBxCkUdFNo5ZOj7b1/NnM75tsaR+X31nSvyNTc9Dv/zNb0k/7vx9Leq//O7KkXyCw3nl/uzTZpt1ulB0hGHHzgA8KnH8zV/rmnujbX8R16GQTgpfsMFy4/5bGfxDitzgEnMdgGUzwxmzYDKFh2O/j/1aEYKtQEZo2dRGjfP4vUXz3SMbNZ+A+Y+zkJmR9PR1+b0pZpFOn7hjTluQbhtyygSbehMyFhPOAlPNhv3++Hzl8721CzjtVgLvYZ2hNzbTCekJew7F6zvgEVRRcXj8grkDr26jq4yC7CQl7/f75oEbC/joSXknKe6LaVcfqAuRvu9Pm8tYtj6BeFfmStSPhOlF71Nps87vbpIG00sLOo4OT6+iqy0vRde0HJ2eLM6Q6O1UY4yuVIYi5nUYHUW8t5EfFwzCgdLJGNzOOLq7vqxGBfVhZxf6s0gu3N3IGREE8Xgpt3UyJccOm1Yhk5JHmSMSv+eUF1z0Uob1B0k/60SK+XpnEcJnho5k1OctL0bscJIMNYzbK5Rv6Q9X92CHG8omQk9vGnS0P5R0SjqON1tEsFclS/AlQk/Qn3+wVRwKxPwWOJiaeNdLj22Vk9mWgqhAz3RQGXVLPamAzxDVbocrV+3FD8LERezwJgT+K5dWhvGi5oagOt0VRI4CGPxohMfxZa9knS/6p40lBCR6Q9jjc2yM16/mA9JGnL+iq33u2OHPIbziQ6R1/0wvqngK13Hn+U9u9FUUr7qSWT2fVpbPVvbLFu+KXXPEi1IBsMt7RaN5oM/tRDftoAyqDStBGJL6kQUQ+7RMi9/qEyBf9ljbit7+cYalTkOJQ6w2kHDR1A1QAzpBwhRwronp/3G9KkO/QMYvyhLhmTYeEPFVFXZGp0wlDfv3b3+tRnU5tujqPNNqvbyrNSjUDjYULsdzSOIcrgU4KHAYFtRkytulVPi9yMAbj4NLCxFUlxMxt9AZ7f2PKSz4SuUA5717S0zvaxlVhEvbjFCjBYq6qL7RLN7iEHK+H2s3TqL/IZkpfjLHGY8w4G2EaBjr6QE65TJ1P0YkQ8o2hzYr+2lILg0XoNEItHGxKWs1Tywou+YScWzFrIiuDXKBgZ1qN0OVuVF45p7LlIlfavXqkDdGzFELiy6sSm0gRRqbVMEXCvvSeZRM7z76TDr7s4QiDKCXCItDgt4pVMldYoRCDMVWes1JZFyBBfbsJIw63mkuDSrKDJZxBjTDv9AXjXSfvDeAJ/yDkhauS1WUnNV39CCMjLLRz6FeZ80l7zHfC4hX3FkplhFV6vhw9ETZcY81J6h9upu9CVcuGFL97Zss7sEghpnd49IoUkyfs17/+D/sBuJZsqmaOWtNKQz5fFtCkepN08g5ttV5BYQVeYdFKS0QqJyHSFTD445Rb8tO8hhk6xBxLuadGR9UoF2ldnNR0OgeuQGmj7Gg759flj2Csh7PSjc6FvEjYoZyTd3rpdsLvNK61DYrUbCkIWpcBXUJE/lAD+SWYht8NMuEiaFpVE7daExi/uXY6De7tMMvWslPQ97oEx3mLKHTFndsIy3huSGhpZau0y8mBzKhwpDlgmeZju5w/XsmxoWjW2qeQnhPQEftpGpVgEZN+x/VX51Fb0UDa8pY8dbigadVn5aXw5HQSyJK1i1N8PFk7S1NanpLCHW5QXoqN0Qksm2nejN+BvhQpeHVsC0f3qHMviqNcpODNXn9/HX539AO7fJr0WzrrHZi798Orb16+fvcSgUFB6hAWdFfSqwsuGyt5PjleKlorr79qc2NXAHhXAHhXAHhXAHhXAHhXAPixlqjdFQDeFQDeFQDeFQDeFQDeFQD+fEjYFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQB+PLJiVwD4sdRV3RUA/i0ocFcAeFcAeFcAeFcAeFcAeFcAeFcAeFcAeFcAeFcA+J/UD7wrALwrALwrALwrALwrALwrALwrALwrAPz/oQBwIy+wV+ZcUKKxL+zlcoRPVssCn8XRFJOID06i62ukwPc6Xyzw888VpSienMXRJdcCn1JS/nEcslcxE/ECMIvxG/cytHuM68fuwCn7YyXtGtNv3YhDwsGNfZt5zkdv3h1HcTTypYsLlVHdAj7DzEU+c5mdjfRG+nYd5VxOKkqNjNycC1fladrO1r2gbF3/RyO/ErNalxC203jdNvBf3NTGAdfXLhN4saj7u6atIzxiQ288v7PFYvF/J8i1ow==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPF1zGzeSfwU3dVWJucPhhyXb0b2ckngT32ZtlS1f6k7SKuBMk4Q1A0wAjChGxap92H9wT/e6Py2/5KobwHCGH5JsyVllj3lwxMFXo9Hd6A90X0eWT0x0cBIdQ1Hm3IKJzuIoA5NqUVqhZHQQHU+BhWb2jQaO39nh0SvG81zNDKsMaMOsYik2AksrY1UhfuGjHJgNE8dsNhXplBnQl8C4YaO8glILaQ0bK80mIEFzK+SEZSqtCsCGmbBTVmrIYCwkZMxYXaW20mAS9r5UkpkqTcGYcZXXKzkwhJIxs1MgQDXYSkvDOKuk+LkC1umE3uci63SYnXLLUi7ZCHA7Ge7GAwQNcEYc25SkiU0JqRgL7OznSk7lqTwW5QF7X+aKZ2yuKs2Ovv1jPQXOi99OOp1vYVRN2PtXnc7Zl1NrS3PQ6/GyTFQJ0oiJzPnIJKkqehl2LLPxE8QgaMBZCVbgRuRzxrOMzUQ2AWtox5KlqpyzVCmdCelQX/IJMFkVI9AmZlxmrFAamJCMMw08m3et6lYG2H+8e/Maj6PgNmFHeWXierlMaEhtPnfTIwbCrr5wmHm2h+cj5CRmBb/AgxSW/VyJ9AK3bUASWv2ZEK46nXdVWSptIWM/ui0cdDrY8jXkasa4BuqfqqJQkpVc8wIsURseGDZr+LkSGjJHKjzPAy4OTmWXdTqSF3DQ6bD37uBFBtLiqWkiOjsVxg9IXH87L6n/K5mJFJFHAOBXpsbtrohU7PrOE4Lr2kA1UoojesThjLvzL3Oeum1pQBqy4hLaE1/FbI4TfwtSBQimSotflLQ8p+O7BG1FyvPmMSOARJiWa+KjUglpw1e/Avsvf5x42nSIng4RtAyRWwhJLQbYJc8rMB6qWcymCNVbKDUY4gc/LyJeZmwKYjLduh7PPlTGtiZmlUEwm1D4tcKpEnqB0DbmuQEmxi1cFvwCGqsxRUKL5wn7es4yGPMqtzETSKFWV5Cw18oyXpa5SEk6IQ0gs3GUKV06ZU8+SZt8jrS6FBmgCMnEeAwamRkbaQo/JkCHdFnSANwecZqdcsmUXDnoVOVKr5MQfW7jkaVKWpA2YYeXXOQEvNusYUKmeZUBG+U8vYhJrsZMQ+YYfQ4opWPHH9QFha/DOeGHGciRCpVE+KXyywuzlHAJO0ZGqfkPGwOqaRFhmlj1XD5WuDKiILAkg4KLPCbExeyDGjErbA4xMnjJ5TxmGbcQMwtXdqSuYpZOIb2gvzTPhGKjyloU7LhmplWZqZn0uBwraY34ZQNHhpaPx+gwZnsxexazFzEb9GM2GMZssBezwbOYDV7EbNiP2XAYs+FezIbPHFjDFx7XvEZwE4DB0GHZ/n6wi3L6B2GIs1HAmlpmz1oye5CwTqfmJvz2008/ncrrU8nYaYTMdRodsNOo7nIaxa4NZSa2DfzvK/zxdPjc/5zjz2fDF/7njLoO9vzPKf4cDk7lwi94KocEieVFeQMU2PygEPhfnojwGy2K34I8w48oiOLQgGfVggcbFs29PMW9CCms4LnZvp3Q4xHtaAnS2qb2cFNErtt3RM2PaDtNeLCFxKRrIrHaaAoMT1AM13a/n/ibZfvm3bKPZu8NcO639We4dRRNxyiatu+/ll6PCAmrMN0PE88TUgBIMm/Hg+/wiLDQhuh+OHiBOMBLaTsCsPUR7b4BDjb4G9619fe6g/3usD/ca2EAbSnXoSi6Wdadz+cPgT3UefzyqPIEDdVpdmi2jrUqNpgfZB0se3mdiP4OKvufUVEfBR0WMrQT2xZvsBCbWrZVGZ9/YdxUYWitnGH/pWo2b4BJTQgHWcvpVInUA499gko2QoMwQRx0CZO9LOs1MIkfs6xbFN2Vj/izS4hvfCyKJMuSlZ5rp+M+FizLYrb+eeP3LGNFUWz57L63PveKYn0XSVF42Ej5+iohdwXpbNv5xHf4rVhlyRHthW9kI/Q0KJnT2mTObeajlctmKqRv8ETFVjpomFQ513CFdqkRSrreD89jgcWWmj3Zsd6TAEGxZl++8dr7E0/+uIX2BPjl9nFrO8NJDr2DjWmYwBUrubWgJU12yXOROf9clz7AFS9KNAF6fzk9zf7wrz1yQKCNbxmeBMvERKDfqPeXk8Puf59t6FGVJeiUG2A54EomZmDThJ1MIS+XrqvZbJbMnpp0qlTu/FYfjIax+/dcjT6cE7hlwk35ZNNOHWk0DH4knVV734BtYYwbFkZuMPmJxoiHBn26bb29c8N163s8ohtnBSRsdN4TbD45jQpOCgmSMiz/VnYK+jQ6q8c4Ix+yW8ae3YFZpyKDnI8gX2+6M6PVn3M+V5Xn7+DUam/VU3QDb9hQCFn7LWg7/bjRyK9WGl3bYgN/O4Q0uTNcOYE9wwmwXJjguWmjsznau7bIQSnBuZJHwMIANqqp9N5cUAN2NzZwksif3S1LYD9GHWu3YljtlhVaB9NEDM5RCCmKqqj9o+N61oCywuseTXzhSAwyhBWap7u2Ar+6ZQXv5t+ywKkckB8j+D9u0Ex9j0ckK1ZAupmNP0WKtO7pB7pgb2fAsK0mA264lrGru5Br5jPbuS9hb/B6Q5+sG4RetjSF0qJH7r6sWYN85xuKfFZNP9x2ymv2ekTUtwGsz0yBvt9D3z6fRKTN3f+OCLUF9p2J1TklCz65wXKn5kdEnh6eNSfEgJyR7r64wSFH7TdvZ9BvbWe/vZ1n/U+wrlrL3t+46tcfl1bVS4kxh7WF0C6vcv6got7PiaT5jSrKyjZ5gUx+4vdweYewmgsT/iFm3Zh1YtaL2Zcxe5Kwt0CBuLQO2vm7XGgXmhOSZarCmEla6XzORpqnGA2HZJKw6+ufKy6tsPPFgnXY9TXG+heLBJnjQqqZi9udXAojLMO4+9LWyVRqNsTpVWp6aBT1XsOs+62Pjfc8aE/Yl2qFU2+0LD0KPtaU3DbsM9tXGCI60jAWed4I5LPwKRwPBkYhh8IHj30IHxVGCicJaRWiIDyW6HRGMFYYSsKXBBiQnPJlqN9pbE44Nl8juPcfSrMpN86SJdMZt4dPJewUCh/Ueq0suIi2KZU04IR5uQHoZUS601mJiIVuy6iYkGHjKE4GD+e+GX7Vb8qXwbP9lrjcbwuY/jYBc4P3BsWIw0VwecOyqcH5JIDC93W2X+X7MCki24mbQGSO+lSVZywXFxTczIQpcz5HsgiXpYdyNWr+zVQps+zhA9eez8xBOyCuNMbEnyR1fPC+fufB86ctaf/iAZxpK+7l9mH093qD/d6N/uUVr+jHy2vG7nJy5Li908lRz+XR7fzAn+oHfhjCf/qQbrDB82FLe3vavz8DPJC3q8k4t/i5HsKb9WBupSa73dGh9Js5du5PfXufw8RdEcPPBw8ghrdYsvelxDWD9cFojz2UtbqJAO9grt5oo96bQJvAfnYi3X8Y03bQb+lqX7VUta+GTaLc378TUTYXXaGs00j859dv3s76f/puog4PDw9fv3s/ffl+cnh4WODvJEk2ejU2nTYtgzqsf9Lr72W647eskiQJojDjlh/Q8F4pJ//mxsfbxyT+OchncrXuP0R0c4NH9f5SoO7621w0m9ynn4/P78eBzP93KqM4UiVlBCj5KosOIpddEN7aRzG5QsDYr1U2jw6uI/+eE//0ryVxaO+DwSyG68ikUyg4/hVMOcx7GIscp0JDHrSJ4oge+GASBFJfdBCp0QdIbRRj8LlEDyEYnIPGHVyHXu7dexR7dTw6iBz1R3HkQ7D1JwYyVfiooszG0SIseNNU9ZflVIb+qBMPcB58Kv6J09DQxUrexyfN1JxhsUTrcjKuNZ9Hqykm4Y14CPC7cfUj2HweLglh0SVRP1ymblEcCQtFc5Uth6bVx2M6BYU7ocd/HzuWjoUXH70mjiunSn7SQP8+61OGflCj808iRxzs/SAbzvqOp+Na1xduk8ohvnqGLGjF3eXz/ZjRE9rkNkoN/QnLfNJc03nP1tY83pbW0XhNbqZkCvOyBK4Tyq745EQfyqXieVpROlMtlls7q0GtdzZYxNHV7Zu5YqnqhpwR9mUOY+veeLBUaQn6SfPh2KPZ3HBvbxFH89u3N/9dbu85Ht7s9t39SMk2y0SkfwSsT18s4mh6O6zf1+lA/0Bg954tlnfsigpxPlLZ/DzIrcVtHcNlhv0wme2VfKMz0A1EjJTKgcs1TLwaO8e6Yl+gxfNF7F5WURaH0CZcZGyGbmcNKWBGGD24DLKKeV3HpXgw/7IenfIv8QOpaaYaGewlw3zGTTgCZrWYTABd574HDfZ5KsApK1P69158HLx8pYZLoSoTwEN/Ot4uOaCX28VZsEnISdsqa2CHvPbNvSfN08EveLlKTGx5c3x0B1ySydh1iXtOP3C7dHOwN8dHmBsnxl79S9h7U2MioJa3ujBUx9il4CF/ppbtc/caBZzfU9FmW6GGxGelddk6QJkwGyGKXdosRrTqxNm1iZfJlnhEqrIYuhA+JchYKE0LjwRFjchjVd2FKm/BJGeTih7/WmTZkChH7/+WuW1CuoxcsjeySod0Pk8W2BPTc5d4CljBTo35YwbSuOGcjbmxoGPM1UXM6wqti3pKuCpBC4z6bUSBBoe680pv1NfaOGgnir1/+4NPsQ17CEw5Qg50E0PGqpKohjihTmAMJ7e69TVFCbkD9Pk2xXBd9aBYpneFlKCNkmguKT3hUvziSJg0ErS2RjDluevqRQW6zBEe5PA2MEHW/vq3vzfg2qrprgPmVuBZhq9Tb4GQTEpH8KjpayhRAqo2RDgf6H9fvQQQOmKa80JlNSOZu9P4Eb1nNbVc9KHAOhRpqnSKhkUtb00cZKzxaqUhG5UMWYollrhfuBLGNlLwwkP5dfnwFhCPaQMGUkOQq5Hm5bzJ4MsQqVqZjhIFRTt9s74G13iBV1adayiEvNs91fTKWVULgsqqgluRsjCVSdpJuS70E/i6YF8G0JAaL4XST7awKk53rmQK50KewyXoOyh4r+uHfRmfI3HbGYBswhaQ5K6zZeLkDHPjWzhp3E6UHtwixv0Y6a4APYHzFM0UIjy4Ax47HZyt02FdB4sXq6bS3rXic9pJfqAoWc6OEPns0zrtYnnnNksJJOx7NUOcxazMAd9noxnv5keUMoI8c0UQmiukXGL6KXl1MOcUJ67DbAWnRxN+CRfppvOi3bxyVnjqPDs4C+Zg4zrxTXsKIrTOJ+GYRx1WdxzhNoduFcZzRSxlp0s5nLWBekUptFO6gugI0RXs1gl57WomQf/61/81FNB370RMglvY2kqhfp4b5fJzm7MGig40n5CDao2k/duBTcbuzR6PIECc7kHVHYoRPgOjBxCkUdFNo5ZOj7b1/NnM75tsaR+X31nSvyNTc9Dv/zNb0k/7vx9Leq//O7KkXyCw3nl/uzTZpt1ulB0hGHHzgA8KnH8zV/rmnujbX8R16GQTgpfsMFy4/5bGfxDitzgEnMdgGUzwxmzYDKFh2O/j/1aEYKtQEZo2dRGjfP4vUXz3SMbNZ+A+Y+zkJmR9PR1+b0pZpFOn7hjTluQbhtyygSbehMyFhPOAlPNhv3++Hzl8721CzjtVgLvYZ2hNzbTCekJew7F6zvgEVRRcXj8grkDr26jq4yC7CQl7/f75oEbC/joSXknKe6LaVcfqAuRvu9Pm8tYtj6BeFfmStSPhOlF71Nps87vbpIG00sLOo4OT6+iqy0vRde0HJ2eLM6Q6O1UY4yuVIYi5nUYHUW8t5EfFwzCgdLJGNzOOLq7vqxGBfVhZxf6s0gu3N3IGREE8Xgpt3UyJccOm1Yhk5JHmSMSv+eUF1z0Uob1B0k/60SK+XpnEcJnho5k1OctL0bscJIMNYzbK5Rv6Q9X92CHG8omQk9vGnS0P5R0SjqON1tEsFclS/AlQk/Qn3+wVRwKxPwWOJiaeNdLj22Vk9mWgqhAz3RQGXVLPamAzxDVbocrV+3FD8LERezwJgT+K5dWhvGi5oagOt0VRI4CGPxohMfxZa9knS/6p40lBCR6Q9jjc2yM16/mA9JGnL+iq33u2OHPIbziQ6R1/0wvqngK13Hn+U9u9FUUr7qSWT2fVpbPVvbLFu+KXXPEi1IBsMt7RaN5oM/tRDftoAyqDStBGJL6kQUQ+7RMi9/qEyBf9ljbit7+cYalTkOJQ6w2kHDR1A1QAzpBwhRwronp/3G9KkO/QMYvyhLhmTYeEPFVFXZGp0wlDfv3b3+tRnU5tujqPNNqvbyrNSjUDjYULsdzSOIcrgU4KHAYFtRkytulVPi9yMAbj4NLCxFUlxMxt9AZ7f2PKSz4SuUA5717S0zvaxlVhEvbjFCjBYq6qL7RLN7iEHK+H2s3TqL/IZkpfjLHGY8w4G2EaBjr6QE65TJ1P0YkQ8o2hzYr+2lILg0XoNEItHGxKWs1Tywou+YScWzFrIiuDXKBgZ1qN0OVuVF45p7LlIlfavXqkDdGzFELiy6sSm0gRRqbVMEXCvvSeZRM7z76TDr7s4QiDKCXCItDgt4pVMldYoRCDMVWes1JZFyBBfbsJIw63mkuDSrKDJZxBjTDv9AXjXSfvDeAJ/yDkhauS1WUnNV39CCMjLLRz6FeZ80l7zHfC4hX3FkplhFV6vhw9ETZcY81J6h9upu9CVcuGFL97Zss7sEghpnd49IoUkyfs17/+D/sBuJZsqmaOWtNKQz5fFtCkepN08g5ttV5BYQVeYdFKS0QqJyHSFTD445Rb8tO8hhk6xBxLuadGR9UoF2ldnNR0OgeuQGmj7Gg759flj2Csh7PSjc6FvEjYoZyTd3rpdsLvNK61DYrUbCkIWpcBXUJE/lAD+SWYht8NMuEiaFpVE7daExi/uXY6De7tMMvWslPQ97oEx3mLKHTFndsIy3huSGhpZau0y8mBzKhwpDlgmeZju5w/XsmxoWjW2qeQnhPQEftpGpVgEZN+x/VX51Fb0UDa8pY8dbigadVn5aXw5HQSyJK1i1N8PFk7S1NanpLCHW5QXoqN0Qksm2nejN+BvhQpeHVsC0f3qHMviqNcpODNXn9/HX539AO7fJr0WzrrHZi798Orb16+fvcSgUFB6hAWdFfSqwsuGyt5PjleKlorr79qc2NXAHhXAHhXAHhXAHhXAHhXAPixlqjdFQDeFQDeFQDeFQDeFQDeFQD+fEjYFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQDeFQB+PLJiVwD4sdRV3RUA/i0ocFcAeFcAeFcAeFcAeFcAeFcAeFcAeFcAeFcAeFcA+J/UD7wrALwrALwrALwrALwrALwrALwrALwrAPz/oQBwIy+wV+ZcUKKxL+zlcoRPVssCn8XRFJOID06i62ukwPc6Xyzw888VpSienMXRJdcCn1JS/nEcslcxE/ECMIvxG/cytHuM68fuwCn7YyXtGtNv3YhDwsGNfZt5zkdv3h1HcTTypYsLlVHdAj7DzEU+c5mdjfRG+nYd5VxOKkqNjNycC1fladrO1r2gbF3/RyO/ErNalxC203jdNvBf3NTGAdfXLhN4saj7u6atIzxiQ288v7PFYvF/J8i1ow==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,f={},g=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",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": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.ffea3fac.js b/assets/js/9c9cb35e.ffea3fac.js new file mode 100644 index 000000000..4e8fad054 --- /dev/null +++ b/assets/js/9c9cb35e.ffea3fac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zGzeSfwU3dVWJucMRSUu2o3s5JfElvs3Zrli+1J2k1YIzTRLWDDABMKIYFav2Yf/BPd3r/rT8kqtuAPPBD0m25Kyyxzw44uCr0ehu9Ae6ryPLpyY6PImOoShzbsFEZ3GUgUm1KK1QMjqMjmfAQjP7RgPH7+zo7SvG81zNDasMaMOsYik2AksrY1UhfuHjHJgNE8dsPhPpjBnQl8C4YeO8glILaQ2bKM2mIEFzK+SUZSqtCsCGubAzVmrIYCIkZMxYXaW20mAS9r5UkpkqTcGYSZXXKzkwhJIxszMgQDXYSkvDOKuk+LkC1uuF3uci6/WYnXHLUi7ZGHA7Ge7GAwQtcMYc25SkiU0JqZgI7OznSk7lqTwW5SF7X+aKZ2yhKs3efvtv9RQ4L3476fW+hXE1Ze9f9XpnX86sLc3h3h4vy0SVII2YypyPTZKqYi/DjmU2eYIYBA04K8EK3Ih8wXiWsbnIpmAN7ViyVJULliqlMyEd6ks+BSarYgzaxIzLjBVKAxOScaaBZ4u+Vf3KAPv3d29e43EU3CbsbV6ZuF4uExpSmy/c9IiBsKsvHGae7eP5CDmNWcEv8CCFZT9XIr3AbRuQhFZ/JoSrXu9dVZZKW8jYT24Lh70etnwNuZozroH6p6oolGQl17wAS9SGB4bNGn6uhIbMkQrP84CLw1PZZ72e5AUc9nrsvTt4kYG0eGqaiM7OhPEDEtffLkrq/0pmIkXkEQD4lalJtysiFbu+84TgurZQjZTiiB5xOOfu/Mucp25bGpCGrLiE7sRXMVvgxN+CVAGCmdLiFyUtz+n4LkFbkfK8fcwIIBGm5Zr4qFRC2vDVr8D+yx8nnjYdoqdDBC1D5BZCUosBdsnzCoyHah6zGUL1I5QaDPGDnxcRLzM2AzGdbV2PZx8qYzsTs8ogmG0o/FrhVAm9QGib8NwAE5MOLgt+Aa3VmCKhxfOEfb1gGUx4lduYCaRQqytI2GtlGS/LXKQknZAGkNk4ypQ+nbInn6RLPm+1uhQZoAjJxGQCGpkZG2kKPyZAh3RZ0gDcHnGanXHJlFw56FTlSq+TEH3u4pGlSlqQNmFHl1zkBLzbrGFCpnmVARvnPL2ISa7GTEPmGH0BKKVjxx/UBYWvwznhhxnIkQqVRPil8ssL00i4hB0jo9T8h40B1bSIMG2sei6fKFwZURBYkkHBRR4T4mL2QY2ZFTaHGBm85HIRs4xbiJmFKztWVzFLZ5Be0F+aZ0KxcWUtCnZcM9OqzNRcelxOlLRG/LKBI0PLx2N0FLP9mD2L2YuYDQcxG45iNtyP2fBZzIYvYjYaxGw0itloP2ajZw6s0QuPa14juA3AcOSwbH8/2EU5/YMwxNkoYE0ts+cdmT1MWK9XcxN++/Of/3wqr08lY6cRMtdpdMhOo7rLaRS7NpSZ2Db0v6/wx9PRc/9zgT+fjV74n3PqOtz3P2f4czQ8lUu/4KkcESSWF+UNUGDzg0Lgf3kiwm+0KH4L8gw/oiCKQwOeVQcebFi29/IU9yKksILnZvt2Qo9HtKMGpLVN7eOmiFy374iaH9F22vBgC4lJ10RitdUUGJ6gGK3t/iDxN8v2zbtlH83eW+Dcb+vPcOsomo5RNG3ffy29HhESVmG6HyaeJ6QAkGTejgff4RFhoQvR/XDwAnGAl9J2BGDrI9p9Cxxs8De8axvs94cH/dFgtN/BANpSrkNR9LOsv1gsHgJ7qPP45VHlCRqq0+zQbJ1oVWwwP8g6aHp5nYj+Dir7f6CiPg46LGRoJ3Yt3mAhtrVsqzK++MK4qcLQWjnD/o1qtmiBSU0IB1nL6UyJ1AOPfYJKNkaDMEEc9AmTe1m218IkfsyyflH0Vz7izz4hvvWxKJIsS1Z6rp2O+1iwLIvZ+ueN37OMFUWx5bP73vm8VxTru0iKwsNGytdXCbkrSGfbzie+w2/FKg1HdBe+kY3Q06BkTmuTObeZj1Yum5mQvsETFVvpoGFa5VzDFdqlRijpej88jwUWazR7smO9JwGCYs2+fOO19yee/HEL3Qnwy+3j1naGkxx5BxvTMIUrVnJrQUua7JLnInP+uT59gCtelGgC7P3p9DT7wz/vkQMCbXzL8CRYJqYC/UZ7fzo56v/32YYeVVmCTrkBlgOuZGIGNk3YyQzysnFdzefzZP7UpDOlcue3+mA0TNy/52r84ZzALRNuyiebdupIo2XwI+ms2vsGbAdj3LAwcoPJTzRGPDQc0G3r7Z0brlvf4xHdOCsgYaPznmDzyWlUcFJIkJSh+VvZGejT6Kwe44x8yG4Ze3YHZp2JDHI+hny96c6MVn/O+UJVnr+DU6u7VU/RLbxhQyFk7beg7QziViO/Wml0bcsN/O0Q0ubOcOUE9gwnwHJhguemi872aO/aIgelBOdKHgMLA9i4ptJ7c0EN2N3YwEkif3a3LIH9GHWs3YphtVtW6BxMGzE4RyGkKKqi9o9O6lkDygqve7TxhSMxyBBWaJ/u2gr86pYVvJt/ywKnckh+jOD/uEEz9T0ekaxYAelmNv4UKdK5px/ogr2dAcO22gy44VrGru5CrpnPbOe+hL3B6w19sm4QetnSFEqLHrn7smYN8p1vKPJZtf1w2ymv3esRUd8GsD4zBfp+D337fBKRtnf/OyLUDth3JlbnlCz49AbLnZofEXl6eNacEENyRrr74gaHHLXfvJ3hoLOdg+52ng0+wbrqLHt/42pQf2ysqpcSYw5rC6FdXuX8QUW9nxNJ8xtVlJVt8wKZ/MTv4fIOYTUXJvxDzPox68VsL2ZfxuxJwn4ECsSlddDO3+VCu9CckCxTFcZM0krnCzbWPMVoOCTThF1f/1xxaYVdLJesx66vMda/XCbIHBdSzV3c7uRSGGEZxt0bWydTqdkQp1ep2UOjaO81zPvf+tj4ngftCftSrXDqjZalR8HHmpLbhn1m+wpDRG81TESetwL5LHwKx4OBUcih8MFjH8JHhZHCSUJahSgIjyV6vTFMFIaS8CUBBiRnvAn1O43NCcf2awT3/kNpNuPGWbJkOuP28KmEnUHhg1qvlQUX0TalkgacMC83AN1EpHu9lYhY6NZExYQMG0dxMnw4983oq0FbvgyfHXTE5UFXwAy2CZgbvDcoRhwugssbmqYW55MACt/X2X6V78OkiGwnbgKROepTVZ6xXFxQcDMTpsz5AskiXJYeytWo+TczpUzTwweuPZ+Zw25AXGmMiT9J6vjgff3Ow+dPO9L+xQM401bcy93DGOzvDQ/2bvQvr3hFP15eM3aXkyPH7Z1Ojno2R7fzA3+qH/hhCP/pQ7rBhs9HHe3t6eD+DPBA3q4249zi53oIb9aDuZXa7HZHh9Jv5ti5P/Xtfw4Td0UMPx8+gBjeYsnelxLXDNYHoz32UNbqJgK8g7l6o416bwJtA/vZifTgYUzb4aCjq33VUdW+GrWJ8uDgTkTZXnSFsk4j8Z9fv/lxPvjjd1N1dHR09Prd+9nL99Ojo6MCfydJstGrsem0aRnUYf2TXn8v0x2/ZZUkSRCFGbf8kIbvlXL6L258vH1M4p+DfCZX68FDRDc3eFTvLwXqrr/NRbPJffr5+Px+HMj8f6cyiiNVUkaAkq+y6DBy2QXhrX0UkysEjP1aZYvo8Dry7znxT/9aEofufTCYxXAdmXQGBce/gimHeQ8TkeNUaMiDNlEc0QMfTIJA6osOIzX+AKmNYgw+l+ghBINz0LjD69DLvXuPYq+OR4eRo/4ojnwItv7EQKYKH1WU2SRahgVvmqr+0kxl6I868QDnwafinzgNDV2u5H180kztGZYNWpvJuNZ8Ea2mmIQ34iHA78bVj2DzRbgkhEWXRP1wmbpFcSQsFO1VthyaVh+P6RQU7oQe/33sWDoWXnz0mjiunCn5SQP9+6xPGfpBjc8/iRxxsPeDbDjrO56Oa11fuEsqR/jqGbKgFfeb5/sxoye0yW2UGvoTlvm0vabznq2tebwtraP1mtzMyBTmZQlcJ5Rd8cmJPpRLxfO0onSmWix3dlaDWu9suIyjq9s3c8VS1Q85I+zLHCbWvfFgqdIS9JP2w7FHs7nR/v4yjha3b2/xu9zeczy8+e27+4mSbZpEpL8HrE9fLONodjus39fpQH9HYPefLZs7dkWFOB+rbHEe5Nbyto7hMsN+mMz2Sr7RGegWIsZK5cDlGiZeTZxjXbEv0OL5InYvqyiLQ2gTLjI2R7ezhhQwI4weXAZZxbyu41I8mH9Zj075l/iB1DRTjQ32kmE+4yYcA7NaTKeArnPfgwb7PBXglJUp/XsvPglevlLDpVCVCeChPx1vlxzQy+3iLNgk5LRrlbWwQ1779t6T9ungF7xcJSa2vDl+ewdcksnYd4l7Tj9wu3RzsDfHbzE3Tky8+pew96bGREAt73RhqI6xS8FD/kwt2xfuNQo4v6eizXZCDYnPSuuzdYAyYTZCFLu0WYxo1YmzaxM3yZZ4RKqyGLoQPiXIWChNB48ERY3IY1XdhSpvwSRn04oe/1pk2ZAoR+//mtw2IV1GLtkbWaVDOp8nC+yJ6bkNngJWsFNr/piBNG44ZxNuLOgYc3UR87pC66KeEq5K0AKjfhtRoMGh7rzSG/W1Lg66iWLvf/zBp9iGPQSmHCMHuokhY1VJVEOcUCcwhpNb3fqaooTcAfp8m2K4rnpQLNO7QkrQRkk0l5Secil+cSRMGglaW2OY8dx19aICXeYID3J4F5gga3/9699acG3VdNcBcyvwLMPXqbdASCalI3jU9DWUKAFVFyKcD/S/rl4CCB0xzXmhspqRzN1p/C29ZzW1XPShwDoUaap0hoZFLW9NHGSs8WqlIRuVDFmKJZa4X7gSxrZS8MJD+XX58CMgHtMWDKSGIFcjzctFm8GbEKlamY4SBUU3fbO+Btd4gVdWnWsohLzbPdX2yllVC4LKqoJbkbIwlUm6Sbku9BP4umBfBtCQGi+F0k+2sCpOd65kCudCnsMl6DsoeK/rh30ZXyBx2zmAbMMWkOSusyZxco658R2ctG4nSg/uEONBjHRXgJ7CeYpmChEe3AGPvR7O1uuxvoPFi1VTae9a8TntJD9QlDSzI0Q++7ROu2ju3HYpgYR9r+aIs5iVOeD7bDTj3fyIUkaQZ64IQnuFlEtMPyWvDuac4sR1mK3g9GjCL+Ei3XRetJtXzgpPnWcHZ8EcbFwnvmlPQYTW+SQc86jD6o4j3ObQrcJ4roil7KyRw1kXqFeUQjujK4iOEF3Bbp2Q167mEvSvf/lfQwF9907EJLiFra0U6ue5US4/tz1roOhA8wk5qNZI2r8d2GTs3uzxCALE6R5U3aEY4zMwegBBGhXdNKpxenSt589mft9kS/u4/M6S/h2ZmsPB4B/Zkn46+P1Y0vuD35El/QKB9c7726XJNu12o+wIwYibB3xQ4PybudI390Tf/jKuQyebENyww2jp/muM/yDEb3EIOI9BE0zwxmzYDKFhNBjg/1aEYKdQEZo2dRGjfPFPUXz3SMbNZ+A+Y+zkJmR9PRt9b0pZpDOn7hjTleQbhtyygTbehMyFhPOAlPPRYHB+EDl8729CzjtVgLvY52hNzbXCekJew7F6wfgUVRRcXj8grkDr26jq4yC7CQn7g8H5sEbCwToSXknKe6LaVcfqAuRvu9P28tYtj6BeFXnD2pFwnag96my2/d1t0kBaaWEX0eHJdXTV56Xou/bDk7PlGVKdnSmM8ZXKEMTczqLDaG8t5EfFwzCgdHIdkYEfBZFnuMzwDcua2OOl2LscJsNoGa+O2Sgmb+gPVf9jhxjLp0JObxt31uDoHZ6jO6oOphq9rhR/BFTs/EG0e8WRQPqZAUeLD1GP5PFjEyh9GQ45hDA3RSWbw1yNM4YwYydyuHpdbYgFtkKBJyEOR6G1OrIWNRuK6uhXFLXiWfijFaHCn7XSe9KQcx3eCTrpkJS50f4+aT3Ph6QePH1BN+/+s+WZQ37Ln0vP6ttOSfcyp+Nd85+63qYoWvHudFwsqx6Wrd6OLc4Ov+SKUV8DssmWRht2ownrR7XMlQ2oDDd0F5H4sAUR+XRAiNwfECJfDDrKgd9+M0NzxdM9Xl/jdFe3r2q8j8+QcIWcKKJ6f9xvSpDv0E+KUom4Zk2lgzxVRV0gqdcLQ37969/qUb1ebUk6BzGak28qzUo1B411BLH60SSHK4E+AxwGBbUZsn3pkTwvcjAGw9LSwtQVCcREanTOevdfyks+FrlAsesettOz1pbkNgn7aQaU77BQ1Rfavf6/hBylde11aZVDZHOlLyZYcjFmnI0xKwL9biBnXKbOxedECLmq0IRE92mphcGacBqhFg42Ja3mqWUFl3xKvqaYtZGVQS5QzjKtxugBNyqvnI/XcpEr7R4h0obolQgh8eVViU2klyLTapghYV96R6+JnaPdSQdfhXCMMY0SYRFof1vFKpkrLBiIsZEqz1mprItXoPrbhhGHW82lQZ3VwRLOoEaY98GC8Z6M9wbwhH8Q8sIVreqzk5qufoKxERa6Ke2rzPmkO+Y7Yb+vxlgSTxlhlV40o6fCzqoxyfn2JPUPN9N3ochkS4rfPdHkHVikELN39PYV6QlP2K9/+R/2A3At2UzNHbWmlYZ80dSzpPKPdPIObfU1T15+XmENSUtEKqch8BQw+NOMW3KbvIY5+qccS7mXP2+rcS7Sulao6fUOXb3QVhXQbgquS+fA0AtnpRudC3mRsCO5IGdx4wXC7zSusw0KnGypz1lX5WwgIvekgfwSTMsNBplwAS2tqqlbrQ2M31w3uwX3dpRla8ki6AptwHHOG4okcefFwaqaG/JLOskj3epuIDOq42gOWab5xDbzxyspLxRcWvsUsmUCOmI/TaswK2LS77j+6hxcKxpIV96S4wwXNJ1yqbwUnpxOAlmybq2IjydrZ/hJy1PSf8MNykuxMViAVSzNm8k70JciBa+ObeHoPeq8F8VRLlLwVqi/v46+e/sDu3yaDKK4pdfdgbn3fnj1zcvX714iMChIHcKGySAZkLNMGVtw2VrJ88lxo2itPMaqtf9dPd5dPd5dPd5dPd5dPd5dPd7HWjF2V493V493V493V493V493V4/38yFhV493V493V493V493V493V493V493V493V493V493V493V4/38ciKXT3ex1LmdFeP97egwF093l093l093l093l093l093l093l093l093l093n9QP/CuHu+uHu+uHu+uHu+uHu+uHu+uHu+uHu//h3q8rbzAvTLngvJ+fZ0tl7J7slql9yyOZpjTe3gSXV8jBb7X+XKJn3+uKEXx5CyOLrkW+JSS0oHjkL2KmYgXgFmM37iXof1jXD92B07ZHytZ0Jh+60YcEQ5u7NtOO3775t1xFEdjX0m4UBmVEeBzzFzkc5fZ2UpvpG/XUc7ltKLUyMjNuXRFl2bdbN0Lytb1f7TyKzGrtYGwm8brtoH/4qY2Dri+dpnAy2Xd3zVtHeERG3rj+Z0tl8v/A2xKjfg=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPF1zGzeSfwU3dVWJucMRSUu2o3s5JfElvs3Zrli+1J2k1YIzTRLWDDABMKIYFav2Yf/BPd3r/rT8kqtuAPPBD0m25Kyyxzw44uCr0ehu9Ae6ryPLpyY6PImOoShzbsFEZ3GUgUm1KK1QMjqMjmfAQjP7RgPH7+zo7SvG81zNDasMaMOsYik2AksrY1UhfuHjHJgNE8dsPhPpjBnQl8C4YeO8glILaQ2bKM2mIEFzK+SUZSqtCsCGubAzVmrIYCIkZMxYXaW20mAS9r5UkpkqTcGYSZXXKzkwhJIxszMgQDXYSkvDOKuk+LkC1uuF3uci6/WYnXHLUi7ZGHA7Ge7GAwQtcMYc25SkiU0JqZgI7OznSk7lqTwW5SF7X+aKZ2yhKs3efvtv9RQ4L3476fW+hXE1Ze9f9XpnX86sLc3h3h4vy0SVII2YypyPTZKqYi/DjmU2eYIYBA04K8EK3Ih8wXiWsbnIpmAN7ViyVJULliqlMyEd6ks+BSarYgzaxIzLjBVKAxOScaaBZ4u+Vf3KAPv3d29e43EU3CbsbV6ZuF4uExpSmy/c9IiBsKsvHGae7eP5CDmNWcEv8CCFZT9XIr3AbRuQhFZ/JoSrXu9dVZZKW8jYT24Lh70etnwNuZozroH6p6oolGQl17wAS9SGB4bNGn6uhIbMkQrP84CLw1PZZ72e5AUc9nrsvTt4kYG0eGqaiM7OhPEDEtffLkrq/0pmIkXkEQD4lalJtysiFbu+84TgurZQjZTiiB5xOOfu/Mucp25bGpCGrLiE7sRXMVvgxN+CVAGCmdLiFyUtz+n4LkFbkfK8fcwIIBGm5Zr4qFRC2vDVr8D+yx8nnjYdoqdDBC1D5BZCUosBdsnzCoyHah6zGUL1I5QaDPGDnxcRLzM2AzGdbV2PZx8qYzsTs8ogmG0o/FrhVAm9QGib8NwAE5MOLgt+Aa3VmCKhxfOEfb1gGUx4lduYCaRQqytI2GtlGS/LXKQknZAGkNk4ypQ+nbInn6RLPm+1uhQZoAjJxGQCGpkZG2kKPyZAh3RZ0gDcHnGanXHJlFw56FTlSq+TEH3u4pGlSlqQNmFHl1zkBLzbrGFCpnmVARvnPL2ISa7GTEPmGH0BKKVjxx/UBYWvwznhhxnIkQqVRPil8ssL00i4hB0jo9T8h40B1bSIMG2sei6fKFwZURBYkkHBRR4T4mL2QY2ZFTaHGBm85HIRs4xbiJmFKztWVzFLZ5Be0F+aZ0KxcWUtCnZcM9OqzNRcelxOlLRG/LKBI0PLx2N0FLP9mD2L2YuYDQcxG45iNtyP2fBZzIYvYjYaxGw0itloP2ajZw6s0QuPa14juA3AcOSwbH8/2EU5/YMwxNkoYE0ts+cdmT1MWK9XcxN++/Of/3wqr08lY6cRMtdpdMhOo7rLaRS7NpSZ2Db0v6/wx9PRc/9zgT+fjV74n3PqOtz3P2f4czQ8lUu/4KkcESSWF+UNUGDzg0Lgf3kiwm+0KH4L8gw/oiCKQwOeVQcebFi29/IU9yKksILnZvt2Qo9HtKMGpLVN7eOmiFy374iaH9F22vBgC4lJ10RitdUUGJ6gGK3t/iDxN8v2zbtlH83eW+Dcb+vPcOsomo5RNG3ffy29HhESVmG6HyaeJ6QAkGTejgff4RFhoQvR/XDwAnGAl9J2BGDrI9p9Cxxs8De8axvs94cH/dFgtN/BANpSrkNR9LOsv1gsHgJ7qPP45VHlCRqq0+zQbJ1oVWwwP8g6aHp5nYj+Dir7f6CiPg46LGRoJ3Yt3mAhtrVsqzK++MK4qcLQWjnD/o1qtmiBSU0IB1nL6UyJ1AOPfYJKNkaDMEEc9AmTe1m218IkfsyyflH0Vz7izz4hvvWxKJIsS1Z6rp2O+1iwLIvZ+ueN37OMFUWx5bP73vm8VxTru0iKwsNGytdXCbkrSGfbzie+w2/FKg1HdBe+kY3Q06BkTmuTObeZj1Yum5mQvsETFVvpoGFa5VzDFdqlRijpej88jwUWazR7smO9JwGCYs2+fOO19yee/HEL3Qnwy+3j1naGkxx5BxvTMIUrVnJrQUua7JLnInP+uT59gCtelGgC7P3p9DT7wz/vkQMCbXzL8CRYJqYC/UZ7fzo56v/32YYeVVmCTrkBlgOuZGIGNk3YyQzysnFdzefzZP7UpDOlcue3+mA0TNy/52r84ZzALRNuyiebdupIo2XwI+ms2vsGbAdj3LAwcoPJTzRGPDQc0G3r7Z0brlvf4xHdOCsgYaPznmDzyWlUcFJIkJSh+VvZGejT6Kwe44x8yG4Ze3YHZp2JDHI+hny96c6MVn/O+UJVnr+DU6u7VU/RLbxhQyFk7beg7QziViO/Wml0bcsN/O0Q0ubOcOUE9gwnwHJhguemi872aO/aIgelBOdKHgMLA9i4ptJ7c0EN2N3YwEkif3a3LIH9GHWs3YphtVtW6BxMGzE4RyGkKKqi9o9O6lkDygqve7TxhSMxyBBWaJ/u2gr86pYVvJt/ywKnckh+jOD/uEEz9T0ekaxYAelmNv4UKdK5px/ogr2dAcO22gy44VrGru5CrpnPbOe+hL3B6w19sm4QetnSFEqLHrn7smYN8p1vKPJZtf1w2ymv3esRUd8GsD4zBfp+D337fBKRtnf/OyLUDth3JlbnlCz49AbLnZofEXl6eNacEENyRrr74gaHHLXfvJ3hoLOdg+52ng0+wbrqLHt/42pQf2ysqpcSYw5rC6FdXuX8QUW9nxNJ8xtVlJVt8wKZ/MTv4fIOYTUXJvxDzPox68VsL2ZfxuxJwn4ECsSlddDO3+VCu9CckCxTFcZM0krnCzbWPMVoOCTThF1f/1xxaYVdLJesx66vMda/XCbIHBdSzV3c7uRSGGEZxt0bWydTqdkQp1ep2UOjaO81zPvf+tj4ngftCftSrXDqjZalR8HHmpLbhn1m+wpDRG81TESetwL5LHwKx4OBUcih8MFjH8JHhZHCSUJahSgIjyV6vTFMFIaS8CUBBiRnvAn1O43NCcf2awT3/kNpNuPGWbJkOuP28KmEnUHhg1qvlQUX0TalkgacMC83AN1EpHu9lYhY6NZExYQMG0dxMnw4983oq0FbvgyfHXTE5UFXwAy2CZgbvDcoRhwugssbmqYW55MACt/X2X6V78OkiGwnbgKROepTVZ6xXFxQcDMTpsz5AskiXJYeytWo+TczpUzTwweuPZ+Zw25AXGmMiT9J6vjgff3Ow+dPO9L+xQM401bcy93DGOzvDQ/2bvQvr3hFP15eM3aXkyPH7Z1Ojno2R7fzA3+qH/hhCP/pQ7rBhs9HHe3t6eD+DPBA3q4249zi53oIb9aDuZXa7HZHh9Jv5ti5P/Xtfw4Td0UMPx8+gBjeYsnelxLXDNYHoz32UNbqJgK8g7l6o416bwJtA/vZifTgYUzb4aCjq33VUdW+GrWJ8uDgTkTZXnSFsk4j8Z9fv/lxPvjjd1N1dHR09Prd+9nL99Ojo6MCfydJstGrsem0aRnUYf2TXn8v0x2/ZZUkSRCFGbf8kIbvlXL6L258vH1M4p+DfCZX68FDRDc3eFTvLwXqrr/NRbPJffr5+Px+HMj8f6cyiiNVUkaAkq+y6DBy2QXhrX0UkysEjP1aZYvo8Dry7znxT/9aEofufTCYxXAdmXQGBce/gimHeQ8TkeNUaMiDNlEc0QMfTIJA6osOIzX+AKmNYgw+l+ghBINz0LjD69DLvXuPYq+OR4eRo/4ojnwItv7EQKYKH1WU2SRahgVvmqr+0kxl6I868QDnwafinzgNDV2u5H180kztGZYNWpvJuNZ8Ea2mmIQ34iHA78bVj2DzRbgkhEWXRP1wmbpFcSQsFO1VthyaVh+P6RQU7oQe/33sWDoWXnz0mjiunCn5SQP9+6xPGfpBjc8/iRxxsPeDbDjrO56Oa11fuEsqR/jqGbKgFfeb5/sxoye0yW2UGvoTlvm0vabznq2tebwtraP1mtzMyBTmZQlcJ5Rd8cmJPpRLxfO0onSmWix3dlaDWu9suIyjq9s3c8VS1Q85I+zLHCbWvfFgqdIS9JP2w7FHs7nR/v4yjha3b2/xu9zeczy8+e27+4mSbZpEpL8HrE9fLONodjus39fpQH9HYPefLZs7dkWFOB+rbHEe5Nbyto7hMsN+mMz2Sr7RGegWIsZK5cDlGiZeTZxjXbEv0OL5InYvqyiLQ2gTLjI2R7ezhhQwI4weXAZZxbyu41I8mH9Zj075l/iB1DRTjQ32kmE+4yYcA7NaTKeArnPfgwb7PBXglJUp/XsvPglevlLDpVCVCeChPx1vlxzQy+3iLNgk5LRrlbWwQ1779t6T9ungF7xcJSa2vDl+ewdcksnYd4l7Tj9wu3RzsDfHbzE3Tky8+pew96bGREAt73RhqI6xS8FD/kwt2xfuNQo4v6eizXZCDYnPSuuzdYAyYTZCFLu0WYxo1YmzaxM3yZZ4RKqyGLoQPiXIWChNB48ERY3IY1XdhSpvwSRn04oe/1pk2ZAoR+//mtw2IV1GLtkbWaVDOp8nC+yJ6bkNngJWsFNr/piBNG44ZxNuLOgYc3UR87pC66KeEq5K0AKjfhtRoMGh7rzSG/W1Lg66iWLvf/zBp9iGPQSmHCMHuokhY1VJVEOcUCcwhpNb3fqaooTcAfp8m2K4rnpQLNO7QkrQRkk0l5Secil+cSRMGglaW2OY8dx19aICXeYID3J4F5gga3/9699acG3VdNcBcyvwLMPXqbdASCalI3jU9DWUKAFVFyKcD/S/rl4CCB0xzXmhspqRzN1p/C29ZzW1XPShwDoUaap0hoZFLW9NHGSs8WqlIRuVDFmKJZa4X7gSxrZS8MJD+XX58CMgHtMWDKSGIFcjzctFm8GbEKlamY4SBUU3fbO+Btd4gVdWnWsohLzbPdX2yllVC4LKqoJbkbIwlUm6Sbku9BP4umBfBtCQGi+F0k+2sCpOd65kCudCnsMl6DsoeK/rh30ZXyBx2zmAbMMWkOSusyZxco658R2ctG4nSg/uEONBjHRXgJ7CeYpmChEe3AGPvR7O1uuxvoPFi1VTae9a8TntJD9QlDSzI0Q++7ROu2ju3HYpgYR9r+aIs5iVOeD7bDTj3fyIUkaQZ64IQnuFlEtMPyWvDuac4sR1mK3g9GjCL+Ei3XRetJtXzgpPnWcHZ8EcbFwnvmlPQYTW+SQc86jD6o4j3ObQrcJ4roil7KyRw1kXqFeUQjujK4iOEF3Bbp2Q167mEvSvf/lfQwF9907EJLiFra0U6ue5US4/tz1roOhA8wk5qNZI2r8d2GTs3uzxCALE6R5U3aEY4zMwegBBGhXdNKpxenSt589mft9kS/u4/M6S/h2ZmsPB4B/Zkn46+P1Y0vuD35El/QKB9c7726XJNu12o+wIwYibB3xQ4PybudI390Tf/jKuQyebENyww2jp/muM/yDEb3EIOI9BE0zwxmzYDKFhNBjg/1aEYKdQEZo2dRGjfPFPUXz3SMbNZ+A+Y+zkJmR9PRt9b0pZpDOn7hjTleQbhtyygTbehMyFhPOAlPPRYHB+EDl8729CzjtVgLvY52hNzbXCekJew7F6wfgUVRRcXj8grkDr26jq4yC7CQn7g8H5sEbCwToSXknKe6LaVcfqAuRvu9P28tYtj6BeFXnD2pFwnag96my2/d1t0kBaaWEX0eHJdXTV56Xou/bDk7PlGVKdnSmM8ZXKEMTczqLDaG8t5EfFwzCgdHIdkYEfBZFnuMzwDcua2OOl2LscJsNoGa+O2Sgmb+gPVf9jhxjLp0JObxt31uDoHZ6jO6oOphq9rhR/BFTs/EG0e8WRQPqZAUeLD1GP5PFjEyh9GQ45hDA3RSWbw1yNM4YwYydyuHpdbYgFtkKBJyEOR6G1OrIWNRuK6uhXFLXiWfijFaHCn7XSe9KQcx3eCTrpkJS50f4+aT3Ph6QePH1BN+/+s+WZQ37Ln0vP6ttOSfcyp+Nd85+63qYoWvHudFwsqx6Wrd6OLc4Ov+SKUV8DssmWRht2ownrR7XMlQ2oDDd0F5H4sAUR+XRAiNwfECJfDDrKgd9+M0NzxdM9Xl/jdFe3r2q8j8+QcIWcKKJ6f9xvSpDv0E+KUom4Zk2lgzxVRV0gqdcLQ37969/qUb1ebUk6BzGak28qzUo1B411BLH60SSHK4E+AxwGBbUZsn3pkTwvcjAGw9LSwtQVCcREanTOevdfyks+FrlAsesettOz1pbkNgn7aQaU77BQ1Rfavf6/hBylde11aZVDZHOlLyZYcjFmnI0xKwL9biBnXKbOxedECLmq0IRE92mphcGacBqhFg42Ja3mqWUFl3xKvqaYtZGVQS5QzjKtxugBNyqvnI/XcpEr7R4h0obolQgh8eVViU2klyLTapghYV96R6+JnaPdSQdfhXCMMY0SYRFof1vFKpkrLBiIsZEqz1mprItXoPrbhhGHW82lQZ3VwRLOoEaY98GC8Z6M9wbwhH8Q8sIVreqzk5qufoKxERa6Ke2rzPmkO+Y7Yb+vxlgSTxlhlV40o6fCzqoxyfn2JPUPN9N3ochkS4rfPdHkHVikELN39PYV6QlP2K9/+R/2A3At2UzNHbWmlYZ80dSzpPKPdPIObfU1T15+XmENSUtEKqch8BQw+NOMW3KbvIY5+qccS7mXP2+rcS7Sulao6fUOXb3QVhXQbgquS+fA0AtnpRudC3mRsCO5IGdx4wXC7zSusw0KnGypz1lX5WwgIvekgfwSTMsNBplwAS2tqqlbrQ2M31w3uwX3dpRla8ki6AptwHHOG4okcefFwaqaG/JLOskj3epuIDOq42gOWab5xDbzxyspLxRcWvsUsmUCOmI/TaswK2LS77j+6hxcKxpIV96S4wwXNJ1yqbwUnpxOAlmybq2IjydrZ/hJy1PSf8MNykuxMViAVSzNm8k70JciBa+ObeHoPeq8F8VRLlLwVqi/v46+e/sDu3yaDKK4pdfdgbn3fnj1zcvX714iMChIHcKGySAZkLNMGVtw2VrJ88lxo2itPMaqtf9dPd5dPd5dPd5dPd5dPd5dPd7HWjF2V493V493V493V493V493V4/38yFhV493V493V493V493V493V493V493V493V493V493V493V4/38ciKXT3ex1LmdFeP97egwF093l093l093l093l093l093l093l093l093l093n9QP/CuHu+uHu+uHu+uHu+uHu+uHu+uHu+uHu//h3q8rbzAvTLngvJ+fZ0tl7J7slql9yyOZpjTe3gSXV8jBb7X+XKJn3+uKEXx5CyOLrkW+JSS0oHjkL2KmYgXgFmM37iXof1jXD92B07ZHytZ0Jh+60YcEQ5u7NtOO3775t1xFEdjX0m4UBmVEeBzzFzkc5fZ2UpvpG/XUc7ltKLUyMjNuXRFl2bdbN0Lytb1f7TyKzGrtYGwm8brtoH/4qY2Dri+dpnAy2Xd3zVtHeERG3rj+Z0tl8v/A2xKjfg=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},b=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",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": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...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/9cd612ce.1bbc46c2.js b/assets/js/9cd612ce.1bbc46c2.js deleted file mode 100644 index 71a2a119a..000000000 --- a/assets/js/9cd612ce.1bbc46c2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>f,default:()=>h,frontMatter:()=>w,metadata:()=>n,toc:()=>S});const n=JSON.parse('{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/v1.1/deletefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletefolder","permalink":"/docs/API-docs/v1.1/deletefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar_label":"Delete Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V0tvI8cR/ivlvsRLjEhKKzvJnCLYylqxsitYMgRESwjNmZqZNnu62901pAiCgA/5Bznlmp+2vySongdJPTaRHeQicbq63l89eiNIlkGkd+LPVufoxSwROYbMK0fKGpGKmwohR42E0F6Bs6sLkFrbVYC1bYBsTy8ifSwSYR16yQIucpGKltxSRSKc9LJGQs96N8LIGkUqWvK9ykUiFCt2kirx2Bo7/wkzusjBFjAI9PhzozzmIiXfYCICrTWLDKp2GkUi8MFpm6NIC6kDX8gqrKVIN4LWLt4kr0wpElFYX0vaP8EHGaWkYv79cVbkJ5Wbi+12xmqDsyZgYEEn0yn/O7Q2NFmGIRSNhiEiIhGZNYSG+L50TqssEiY/BWbaPLWudZoj51kMqVZlH4vX+vHdIpz8xeHqwolt0iUnP6PnxOyYTqYnb4+Op0fT398cf52e/jH96uvxdDr9m0jEQ62Zt8tjLglZLinSu++9A2W0MnjfR+/+ZDq9Pz4R2y1fOn0ujEddqkEFMJYAa0frBDiMUpkAuc2aGg2B9T0GP5ojuLY1UqVMCSsmrrw1ZQJOowwI5NcgS6kMaEnov/j4mxJjDX4oIpoPU4TeW//5wL7aNY5U8isUvSocrGT2cs5Op9P7t0PKTp+mrPOKXSpsY/Lx/w72L7r6Ocw/tedzkDydnt7/YXDvq6fuXZil1CqPrZDsAs0X/wf/dt48o55NPSxE1V6KdHHg7P5562TArPGK1hHCD0fSqaOWnt7NGAeMHLtr5bGJUyVSMWkDO9kM7XsrWJxf9u39MHDXK1mW6L9r5tH4s4Ys/NVmi9bDxmuRiorIhXQyWSpPraRxaNmqZj7ObD258rJotH4vlwvpJ9ahmRyPp+Op4MI4FBKkyef2YcyXgiqNlvMQZUinJsvj8fEzPNK5V93H5ui1LIFkqUz5n/hmu9RcM3xahBwkaMCJdOp7XIukz//+rW6kVih5YnLGlSlsZO5Q8cGhuValiWmJyh+P3lvUma2R5z1VCKNRz/Lp7/8auEajoWVF9I8/mo/mQ+PB2RV6HoTS5FBofFBzjZEN60gblomAstYYgl6DMoSll4SQq1KR1MBx4haWSSfnSisuGr5mmdvDXt2FMdxWSBV6Jv3OI0jIcYmaaw1kQ7aWxKKGFruyflHwWpOAhHkTlMEQAE0lTcYX+0wk3IylATSE3nkVEAJ5tlq1tllDXmYEtTSyRJadwH6wctSK6wO8nTeBIFjdRJOBpNLWYw69QwYxDzGI57zDeAQ+zWztPFYMmyVC2agcAw+NHCHEHsEumBzmGAgc26IyDCy0Mdpmi5hAriBwlluWkpoXqn0bmZ28NIG7amtLn4MhYM5bXm+wNXA0+jEgZ/hSmUVIRyOewXcDrm5xHhTh7Mu+BFar1RPovznkeaeIO8UP6GxQZP16x10q6rvBvpDho5X0Dg1G/OwVw05GbrPwtPr4dFKhdpNrJEZImJxdXdww6xv49Ms/4BKlN1DZVYvWrPGo11D2qjhybebbsA1NGgobgVdxxLMWfLy6YqA+greVpE+//DPAe1yBMl1JsSuj0VUz1yqDG6wdz+gwGqXwjUdWSf0ZUCUJMmlgjhAqyVBaKgkSXMutlVmM4cysoQnoYaWoimDg88h34AbHZUh3gLkMmIM1kaPXOd5ZxOd1QL3EwLJ42M4RMFfEiK68bcpW274xnXMeC6U13Kq8RIq+neU5uO541R7Ht8bOHCy4IKjCNUiPENDQGK4esURK45z1bIVqjS8sv184AWhyZ5WhkELuZUE7+ckO6BmHWVnzzFEbQjmEI+nEDClpK7HzeDgdx33zUSM/7LceC/SsMLq9y4tTHZzuelgCo/W3wJrXg7hyZnF7wVoq3U6UPz2WEzcJ9HX4UFyjX6oMu6n2QkVP4uWJSIRWGZqAexvK2burS1i+HU8PRv9/UdyTy4tvzt9fn7Mx3EjbgPUrgHA2UC3NnqZv9x+wjyfbZre5/brXbjeACR9o4rRUcd2KDm26PelODI/VdPfQnSWisoGYvNlwcf3o9XbLxz836HkZmyViKb2Sc57RvEypwL/z4SX7oiNf/tA9it/As2/mZ23uNwnDa8RS6oa/RCIWuD54oW9n26RfJtisln6WZehoj/PJFnywSn57fnl+cy4SwS3xcI9ZxD2m+8EKnjXscMFpbeC/vG09y7DZtDvSdjvcb0kvcnQ+9rc5SrPtdvtvYtAJww==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.1/folderlist"}}');var l=o(74848),r=o(28453),i=o(33617),s=o.n(i),d=o(17543),a=o.n(d),p=o(86013),c=o.n(p),m=o(63723),y=o.n(m),u=(o(18766),o(79329),o(9303));const w={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V0tvI8cR/ivlvsRLjEhKKzvJnCLYylqxsitYMgRESwjNmZqZNnu62901pAiCgA/5Bznlmp+2vySongdJPTaRHeQicbq63l89eiNIlkGkd+LPVufoxSwROYbMK0fKGpGKmwohR42E0F6Bs6sLkFrbVYC1bYBsTy8ifSwSYR16yQIucpGKltxSRSKc9LJGQs96N8LIGkUqWvK9ykUiFCt2kirx2Bo7/wkzusjBFjAI9PhzozzmIiXfYCICrTWLDKp2GkUi8MFpm6NIC6kDX8gqrKVIN4LWLt4kr0wpElFYX0vaP8EHGaWkYv79cVbkJ5Wbi+12xmqDsyZgYEEn0yn/O7Q2NFmGIRSNhiEiIhGZNYSG+L50TqssEiY/BWbaPLWudZoj51kMqVZlH4vX+vHdIpz8xeHqwolt0iUnP6PnxOyYTqYnb4+Op0fT398cf52e/jH96uvxdDr9m0jEQ62Zt8tjLglZLinSu++9A2W0MnjfR+/+ZDq9Pz4R2y1fOn0ujEddqkEFMJYAa0frBDiMUpkAuc2aGg2B9T0GP5ojuLY1UqVMCSsmrrw1ZQJOowwI5NcgS6kMaEnov/j4mxJjDX4oIpoPU4TeW//5wL7aNY5U8isUvSocrGT2cs5Op9P7t0PKTp+mrPOKXSpsY/Lx/w72L7r6Ocw/tedzkDydnt7/YXDvq6fuXZil1CqPrZDsAs0X/wf/dt48o55NPSxE1V6KdHHg7P5562TArPGK1hHCD0fSqaOWnt7NGAeMHLtr5bGJUyVSMWkDO9kM7XsrWJxf9u39MHDXK1mW6L9r5tH4s4Ys/NVmi9bDxmuRiorIhXQyWSpPraRxaNmqZj7ObD258rJotH4vlwvpJ9ahmRyPp+Op4MI4FBKkyef2YcyXgiqNlvMQZUinJsvj8fEzPNK5V93H5ui1LIFkqUz5n/hmu9RcM3xahBwkaMCJdOp7XIukz//+rW6kVih5YnLGlSlsZO5Q8cGhuValiWmJyh+P3lvUma2R5z1VCKNRz/Lp7/8auEajoWVF9I8/mo/mQ+PB2RV6HoTS5FBofFBzjZEN60gblomAstYYgl6DMoSll4SQq1KR1MBx4haWSSfnSisuGr5mmdvDXt2FMdxWSBV6Jv3OI0jIcYmaaw1kQ7aWxKKGFruyflHwWpOAhHkTlMEQAE0lTcYX+0wk3IylATSE3nkVEAJ5tlq1tllDXmYEtTSyRJadwH6wctSK6wO8nTeBIFjdRJOBpNLWYw69QwYxDzGI57zDeAQ+zWztPFYMmyVC2agcAw+NHCHEHsEumBzmGAgc26IyDCy0Mdpmi5hAriBwlluWkpoXqn0bmZ28NIG7amtLn4MhYM5bXm+wNXA0+jEgZ/hSmUVIRyOewXcDrm5xHhTh7Mu+BFar1RPovznkeaeIO8UP6GxQZP16x10q6rvBvpDho5X0Dg1G/OwVw05GbrPwtPr4dFKhdpNrJEZImJxdXdww6xv49Ms/4BKlN1DZVYvWrPGo11D2qjhybebbsA1NGgobgVdxxLMWfLy6YqA+greVpE+//DPAe1yBMl1JsSuj0VUz1yqDG6wdz+gwGqXwjUdWSf0ZUCUJMmlgjhAqyVBaKgkSXMutlVmM4cysoQnoYaWoimDg88h34AbHZUh3gLkMmIM1kaPXOd5ZxOd1QL3EwLJ42M4RMFfEiK68bcpW274xnXMeC6U13Kq8RIq+neU5uO541R7Ht8bOHCy4IKjCNUiPENDQGK4esURK45z1bIVqjS8sv184AWhyZ5WhkELuZUE7+ckO6BmHWVnzzFEbQjmEI+nEDClpK7HzeDgdx33zUSM/7LceC/SsMLq9y4tTHZzuelgCo/W3wJrXg7hyZnF7wVoq3U6UPz2WEzcJ9HX4UFyjX6oMu6n2QkVP4uWJSIRWGZqAexvK2burS1i+HU8PRv9/UdyTy4tvzt9fn7Mx3EjbgPUrgHA2UC3NnqZv9x+wjyfbZre5/brXbjeACR9o4rRUcd2KDm26PelODI/VdPfQnSWisoGYvNlwcf3o9XbLxz836HkZmyViKb2Sc57RvEypwL/z4SX7oiNf/tA9it/As2/mZ23uNwnDa8RS6oa/RCIWuD54oW9n26RfJtisln6WZehoj/PJFnywSn57fnl+cy4SwS3xcI9ZxD2m+8EKnjXscMFpbeC/vG09y7DZtDvSdjvcb0kvcnQ+9rc5SrPtdvtvYtAJww==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,v={},S=[];function I(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,l.jsx)(s(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,l.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(a(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,l.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(y(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_12"}}}},400:{description:"- folder is not empty, contains document or folder.\n- Something went wrong, please try again later!\n",content:{"application/json":{schema:{type:"object",oneOf:[{properties:{error:{type:"string",example:"folder is not empty, contains document or folder."}}},{properties:{error:{type:"string",example:"Something went wrong, please try again later!"}}}],title:"inline_response_400_3"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.b75be620.js b/assets/js/9cd612ce.b75be620.js new file mode 100644 index 000000000..e41578926 --- /dev/null +++ b/assets/js/9cd612ce.b75be620.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>b,default:()=>S,frontMatter:()=>u,metadata:()=>n,toc:()=>D});const n=JSON.parse('{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/v1.1/deletefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletefolder","permalink":"/docs/API-docs/v1.1/deletefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar_label":"Delete Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uIzcSfpUKL5sR2pLscbKbPq2ROBMnRsaIHRiIRzDY3dVqxmySQ1ZLFgQBOewb7CnXPNo8yaLYP5L8MxsnQS62uor1/7GquBYk50GkN+Jrqwv0YpaIAkPulSNljUjFVYVQoEZCaI/AycUZSK3tMsDKNkC255eRPxaJsA69ZAVnhUhFy265IhFOelkjoWe7a2FkjSIVLftWFSIRig07SZV46I3NfsaczgqwJQwKPb5vlMdCpOQbTESglWaVQdVOo0gE3jttCxRpKXXgA3mFtRTpWtDKxZPklZmLRJTW15J2KXgvo5ZUZN8d5mVxVLlMbDYzNhucNQEDKzqaTvnfvrehyXMMoWw0DBkRicitITTE56VzWuWRMfk5sND6sXdt0Jw5z2pItSb7XLw0jm/uwtG3DpdnTmySrjjFCT2lZit0ND16fXA4PZj+8+rw8/T4i/Szz8fT6fQnkYj7WrNsV8dCErJeUqS33zsEZbQyeNtn7/ZoOr09PBKbDR86fiqNB12pQQUwlgBrR6sEOI1SmQCFzZsaDYH1PQbfmQO4tDVSpcwclsxcemvmCTiNMiCQX4GcS2VAS0L/ybs/VRhr8G0Z0bxfIvTe+o8n9sWhcaaSP2DoRelgI7Pna3Y8nd6+Hkp2/LhkXVQcUmkbU4z/Otg/G+rHMP/Yn49B8nh6fPuvIbzPHod3ZhZSqyK2QrJ3aD75G+LbRvOEeXZ1/yKq9lDki71gd+ltkAHzxitaRQjfH0inDlp+ejNjHDBy7LaVxyZOlUjFpE3sZD20741gdX7Rt/fGa5GKisiFdDIJ0hSZvR9bhyaoudEyC+Pc1hPp1GRxOD4UjO19Genci85jc/BSkUByrsz8/8nNtpm65Gq2BdvL11A26dR3uBJJX47dU92Eq1DyAOMCKFPaKNwV6a1Dc6nmJpY4Gn84Ca9R57ZGHr9UIYxGvciH//w2SI1GQweJYBy/M+/M28aDs0v0PJekKaDUeK8yjVEM68gbZntAWWsMQa9AGcK5l4RQqLkiqYHzxB0ll05mSivGMB+zLO1h5xqEMVxXSBV6Zv3DI0gocIGaoQ+yIVtLYlVDx1taf1fylpGAhKwJymAIgKaSJueDfSUS7o3SABpC77wKCIE8e61a36whL3OCWho5R9adwG6yCtSK4QreZk0gCFY30WUgqbT1WEAfkEEsQkziKa8UHoGpua2dx4phs0CYN6rAwD28QAjxynIIpoAMA4FjX1SOgZU2Rtv8LhawbLQGZ7mDKKl5v9n1kcXJSxO4ybW+9DUYEua85W0DWwdHox8DcoXPlbkL6WjEI/FmwNU1ZkERzj7tr8ByuXwE/Vf7Mm8UfdNk8AM6GxRZv9pKzxVVTRavy66S4aPV9AYNRvzsXIatjsLm4fHtY+qkQu0ml0iMkDA5uTi7YtFX8OGX/8I5Sm+gsssWrXnjUa9g3pvizLWVb9M29EwobQRexRnPW/DxJomB+gxeV5I+/PJrgO9xCcp0V4pDGY0umkyrHK6wdjwyw2iUwpce2ST1NKBKEuTSQIYQKslQWigJElwrrZW5G8OJWUET0MNSURXBwPQotxcG52Uod4BMBizAmijR2xxvPWJ6HVAvMLAunn0ZAhaKGNGVt828tbbrTBecx1JpDdeqmCPF2E6KAlxHXrbkuPpv3cGSLwRVuALpEQIaGsPFA5HIaZyznr1QrfOl5ecEFwBN4awyFFIovCxpqz/ZAj3nNCtrniC1KZRDOpJOzVCS9iZ2EQ/UcVz/HjTy/X7rsUTPBmPY27o41cHppoclMFr/DKx5WscNMI/LBNZS6Xai/PuhnjjY0dfhbXmJfqFy7KbaMzd6Eg9PRCK0ytEE3FkYTt5cnMPi9Xgqkp3x+Dsu9+T87MvT7y9P2RlupG3CDsfT8ZRJzgaqpdmx9NXue/LhZFtvF6k/9vjsBjDhPU2clipuPzGgdbe23Ijh7Zhu352zRFQ2ELPXa75cP3q92TD5fYOed6NZIhbSK5nxjL5Zi0IF/l0MD8tnA/n0h+6N+gqefMI+6XO/SRheIxZSN/wlEnGHq70H82a2Sfplgt1q+Sd5jo52JB8tpXub3Ven56dXpyIR3BL395i7uMd0P9jAk47tLzitD/yXt60nBdbrdkfabIbzLetZiS7G/jRnabbZbP4H92LiCQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.1/folderlist"}}');var l=o(74848),i=o(28453),a=o(33617),s=o.n(a),d=o(17543),r=o.n(d),p=o(86013),c=o.n(p),f=o(63723),m=o.n(f),I=(o(18766),o(79329),o(9303));const u={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uIzcSfpUKL5sR2pLscbKbPq2ROBMnRsaIHRiIRzDY3dVqxmySQ1ZLFgQBOewb7CnXPNo8yaLYP5L8MxsnQS62uor1/7GquBYk50GkN+Jrqwv0YpaIAkPulSNljUjFVYVQoEZCaI/AycUZSK3tMsDKNkC255eRPxaJsA69ZAVnhUhFy265IhFOelkjoWe7a2FkjSIVLftWFSIRig07SZV46I3NfsaczgqwJQwKPb5vlMdCpOQbTESglWaVQdVOo0gE3jttCxRpKXXgA3mFtRTpWtDKxZPklZmLRJTW15J2KXgvo5ZUZN8d5mVxVLlMbDYzNhucNQEDKzqaTvnfvrehyXMMoWw0DBkRicitITTE56VzWuWRMfk5sND6sXdt0Jw5z2pItSb7XLw0jm/uwtG3DpdnTmySrjjFCT2lZit0ND16fXA4PZj+8+rw8/T4i/Szz8fT6fQnkYj7WrNsV8dCErJeUqS33zsEZbQyeNtn7/ZoOr09PBKbDR86fiqNB12pQQUwlgBrR6sEOI1SmQCFzZsaDYH1PQbfmQO4tDVSpcwclsxcemvmCTiNMiCQX4GcS2VAS0L/ybs/VRhr8G0Z0bxfIvTe+o8n9sWhcaaSP2DoRelgI7Pna3Y8nd6+Hkp2/LhkXVQcUmkbU4z/Otg/G+rHMP/Yn49B8nh6fPuvIbzPHod3ZhZSqyK2QrJ3aD75G+LbRvOEeXZ1/yKq9lDki71gd+ltkAHzxitaRQjfH0inDlp+ejNjHDBy7LaVxyZOlUjFpE3sZD20741gdX7Rt/fGa5GKisiFdDIJ0hSZvR9bhyaoudEyC+Pc1hPp1GRxOD4UjO19Genci85jc/BSkUByrsz8/8nNtpm65Gq2BdvL11A26dR3uBJJX47dU92Eq1DyAOMCKFPaKNwV6a1Dc6nmJpY4Gn84Ca9R57ZGHr9UIYxGvciH//w2SI1GQweJYBy/M+/M28aDs0v0PJekKaDUeK8yjVEM68gbZntAWWsMQa9AGcK5l4RQqLkiqYHzxB0ll05mSivGMB+zLO1h5xqEMVxXSBV6Zv3DI0gocIGaoQ+yIVtLYlVDx1taf1fylpGAhKwJymAIgKaSJueDfSUS7o3SABpC77wKCIE8e61a36whL3OCWho5R9adwG6yCtSK4QreZk0gCFY30WUgqbT1WEAfkEEsQkziKa8UHoGpua2dx4phs0CYN6rAwD28QAjxynIIpoAMA4FjX1SOgZU2Rtv8LhawbLQGZ7mDKKl5v9n1kcXJSxO4ybW+9DUYEua85W0DWwdHox8DcoXPlbkL6WjEI/FmwNU1ZkERzj7tr8ByuXwE/Vf7Mm8UfdNk8AM6GxRZv9pKzxVVTRavy66S4aPV9AYNRvzsXIatjsLm4fHtY+qkQu0ml0iMkDA5uTi7YtFX8OGX/8I5Sm+gsssWrXnjUa9g3pvizLWVb9M29EwobQRexRnPW/DxJomB+gxeV5I+/PJrgO9xCcp0V4pDGY0umkyrHK6wdjwyw2iUwpce2ST1NKBKEuTSQIYQKslQWigJElwrrZW5G8OJWUET0MNSURXBwPQotxcG52Uod4BMBizAmijR2xxvPWJ6HVAvMLAunn0ZAhaKGNGVt828tbbrTBecx1JpDdeqmCPF2E6KAlxHXrbkuPpv3cGSLwRVuALpEQIaGsPFA5HIaZyznr1QrfOl5ecEFwBN4awyFFIovCxpqz/ZAj3nNCtrniC1KZRDOpJOzVCS9iZ2EQ/UcVz/HjTy/X7rsUTPBmPY27o41cHppoclMFr/DKx5WscNMI/LBNZS6Xai/PuhnjjY0dfhbXmJfqFy7KbaMzd6Eg9PRCK0ytEE3FkYTt5cnMPi9Xgqkp3x+Dsu9+T87MvT7y9P2RlupG3CDsfT8ZRJzgaqpdmx9NXue/LhZFtvF6k/9vjsBjDhPU2clipuPzGgdbe23Ijh7Zhu352zRFQ2ELPXa75cP3q92TD5fYOed6NZIhbSK5nxjL5Zi0IF/l0MD8tnA/n0h+6N+gqefMI+6XO/SRheIxZSN/wlEnGHq70H82a2Sfplgt1q+Sd5jo52JB8tpXub3Ven56dXpyIR3BL395i7uMd0P9jAk47tLzitD/yXt60nBdbrdkfabIbzLetZiS7G/jRnabbZbP4H92LiCQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,x={},D=[];function y(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,l.jsx)(s(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,l.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(r(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,l.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_12"}}}},400:{description:"- folder is not empty, contains document or folder.\n- Something went wrong, please try again later!\n",content:{"application/json":{schema:{type:"object",oneOf:[{properties:{error:{type:"string",example:"folder is not empty, contains document or folder."}}},{properties:{error:{type:"string",example:"Something went wrong, please try again later!"}}}],title:"inline_response_400_3"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function S(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.403772ac.js b/assets/js/ac7da374.403772ac.js deleted file mode 100644 index 3879ddf29..000000000 --- a/assets/js/ac7da374.403772ac.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>x,contentTitle:()=>f,default:()=>T,frontMatter:()=>I,metadata:()=>a,toc:()=>k});const a=JSON.parse('{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/v1.1/delete-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-template","permalink":"/docs/API-docs/v1.1/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV91u3MYVfpWTuWm8oHZXtuIivKoaC45QxRYiBQIqL4RZ8pCc7HBmMnO4q8WCQC76Br3qbR/NTxKcIbl/kp0aLYLe2NrD8//7zUaQLINI78Ut1k5LwiBmicgxZF45UtaIVNxWCG9QIyEMXHB+fQnO26XKMcDaNrBSVAFVCHKutKI1kAWPtV0iSAgOM1WoDGiQL7ytI/tACWO4LEDuOFQAY0FbU6IHg5hjLhJhHXrJfl3mIhV59GpwSiTCSS9rJPQc00YYWaNIxaDzQbEKxTE5SZU4DvTyDdjiwCugSlK0HjigOUJnkvV4/KVRHnORkm8wEYHWmq0FVTvNzuCj0zZHkRZSB2bIKqylSDeC1i5yklemFIkorK8l7ShtO2P9wVkTMLDEy+mU/zsqzOBl7xSEJsswhKLRev2VSERmDaEhlpTOaZXF1E1+Diy+eeqQnf+MGXEePSeaVGe8I3PGn7qOjzKGm4q/PlYvZXDfu1eiTfrS5Of0eaGX05evTk6nJ9M/356+Ts++Tb95PZ5Op38XiXisNcv2Ncy5wG0iSJHe/W6fsEWzB4w9pWXms+fSeGNrpEqZElZoCFbemjIBp1EGBPJrkKVUBjjT/n+YVfTe+s9n58s8a/eiVkYrgw9DDz2cTacPp9sknH2ml4wlKGxj8j821Ofsfz6gs4fX24C+eRrQpVlKrfK4qW7tAs0fG8++eerMP+1W1THF7+Ig2H16F2TArPGK1nGxPZ5Ip0667+n9jNcFd4rdLcW4DKkSqZgMy2yy2VuErWCVfjmsyqORWMmyRP99M48BnDdk4QebLbooG69FKioiF9LJZKk8dZrGoROrmvk4s/Xk2kteRe/kciH9xDo0k9PxdDwVbbI5UhKkyef2ccxMQZVGy3mIOqRTk+Xp+PQZGencF/Fjc/KlIoFkqUz5e3KzXXluuIW6Ljko0rZXpFN/w7VIhh7Y5+qPU4UyRx/7RZnCRuG+M947NDeqNLEs0fjxEbtDndka+VzxJRuNBpGP//j3Vmo0gtxmTY2G4gSMP5gP5n3jwdkV+qLRIE0OhcZHNdfdtcc6fuuuPVkIKGuNIeg1KENY+niIVKlIauA88drKpOvwgMLAbJalPezNXhjDXYVUoedPf/IMF3JcouZ5A9mQrSWxqsFfWFm/KLRdhQQkzJugDIYAaCppMmYcKpGA9SANoCH0zquAEMiz16rzzRryMiOopZElsu4E9pOVo1Y8H+DtvAkEweomugwklbYecxgCigghJvGCj75HYGpma+ex4rZZIpQNg6UEMpsjhLgnOASTwxwDgWNfVIYRaDRG22wRC8gTBM7y2lJSM0DZ95HFyUsTGEJ0vgw12CbMecuoADsHR6OfAnKFr5RZhHQ0+mBO4H7bV3c4D4pw9vUwAqvV6knrvziUeauIN8WP6GxQZP16J10qGrbBvpLtj07TWzQY+2dvGHY6cpuFp9PH1EmF2k1ukLhDwuT8+jJu+hfw8dd/whVKb6Cyq65bs8ajXkM5mOLMdZXv0rZd1FDY2HgVZzzrmo+xHgYaMnhXSfr4678CvMMVKNOPFIcyGl03c62yLVIOo1EK33mMYHKgdbAyk4YRZagkt9JSSZDgOmmtzGIM52YNTUC/A9dMj3IHYXBetuUOMJcBc7DmAMmOdx4xvQ6olxhYFx/cOQLmiiEkVd42ZWdt35k+OI+F0hruVF4ixdjO8xxcT151ZE74njtY8EBQhWuQHiGgoTFcH4nEL41z1rMXqnO+sFrbFRcATe6sMhRSyL0saKc/2TV6xmlW1jxD6lK4e14kvZptSbpJ7CPePUo+8FI+WuSH+9ZjgZ4NxrB3dXGqb6f7oS2Bu/W/aWuGCLy1ZBYRDNZS6e6i/OVYT0QT6OvwvrhBv1QZ9lftExM9icwTkQitMjQB91DK+dvrK1i+Gk8PTv9/MNyTq8vvLt7dXLAzvEi7hA0QQDgbqJZmz9LRK/P4tm12+O3/6lHaX3bCR5o4LVXEcjFTmx6E3W/foCIR6f57dJaIygZils2GJ/cnr9uWyb806BntzRKxlF7JOQMARmoq8N/59l35yRx9/WP/RH0BX/a0fTagAb8YBi9LqRv+JRKxwPXRG7udtckAYtjjjuM8y9DRnuwTBH4AY99cXF3cXohE8Co+xE+LiJ/6P9jAs64dAqvOB/6XUd6zAptNh83adsvfffqkRB/jwM15mrVt+xunERfw","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"}}');var l=i(74848),n=i(28453),o=i(33617),p=i.n(o),s=i(17543),r=i.n(s),d=i(86013),m=i.n(d),c=i(63723),u=i.n(c),h=(i(18766),i(79329),i(9303));const I={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV91u3MYVfpWTuWm8oHZXtuIivKoaC45QxRYiBQIqL4RZ8pCc7HBmMnO4q8WCQC76Br3qbR/NTxKcIbl/kp0aLYLe2NrD8//7zUaQLINI78Ut1k5LwiBmicgxZF45UtaIVNxWCG9QIyEMXHB+fQnO26XKMcDaNrBSVAFVCHKutKI1kAWPtV0iSAgOM1WoDGiQL7ytI/tACWO4LEDuOFQAY0FbU6IHg5hjLhJhHXrJfl3mIhV59GpwSiTCSS9rJPQc00YYWaNIxaDzQbEKxTE5SZU4DvTyDdjiwCugSlK0HjigOUJnkvV4/KVRHnORkm8wEYHWmq0FVTvNzuCj0zZHkRZSB2bIKqylSDeC1i5yklemFIkorK8l7ShtO2P9wVkTMLDEy+mU/zsqzOBl7xSEJsswhKLRev2VSERmDaEhlpTOaZXF1E1+Diy+eeqQnf+MGXEePSeaVGe8I3PGn7qOjzKGm4q/PlYvZXDfu1eiTfrS5Of0eaGX05evTk6nJ9M/356+Ts++Tb95PZ5Op38XiXisNcv2Ncy5wG0iSJHe/W6fsEWzB4w9pWXms+fSeGNrpEqZElZoCFbemjIBp1EGBPJrkKVUBjjT/n+YVfTe+s9n58s8a/eiVkYrgw9DDz2cTacPp9sknH2ml4wlKGxj8j821Ofsfz6gs4fX24C+eRrQpVlKrfK4qW7tAs0fG8++eerMP+1W1THF7+Ig2H16F2TArPGK1nGxPZ5Ip0667+n9jNcFd4rdLcW4DKkSqZgMy2yy2VuErWCVfjmsyqORWMmyRP99M48BnDdk4QebLbooG69FKioiF9LJZKk8dZrGoROrmvk4s/Xk2kteRe/kciH9xDo0k9PxdDwVbbI5UhKkyef2ccxMQZVGy3mIOqRTk+Xp+PQZGencF/Fjc/KlIoFkqUz5e3KzXXluuIW6Ljko0rZXpFN/w7VIhh7Y5+qPU4UyRx/7RZnCRuG+M947NDeqNLEs0fjxEbtDndka+VzxJRuNBpGP//j3Vmo0gtxmTY2G4gSMP5gP5n3jwdkV+qLRIE0OhcZHNdfdtcc6fuuuPVkIKGuNIeg1KENY+niIVKlIauA88drKpOvwgMLAbJalPezNXhjDXYVUoedPf/IMF3JcouZ5A9mQrSWxqsFfWFm/KLRdhQQkzJugDIYAaCppMmYcKpGA9SANoCH0zquAEMiz16rzzRryMiOopZElsu4E9pOVo1Y8H+DtvAkEweomugwklbYecxgCigghJvGCj75HYGpma+ex4rZZIpQNg6UEMpsjhLgnOASTwxwDgWNfVIYRaDRG22wRC8gTBM7y2lJSM0DZ95HFyUsTGEJ0vgw12CbMecuoADsHR6OfAnKFr5RZhHQ0+mBO4H7bV3c4D4pw9vUwAqvV6knrvziUeauIN8WP6GxQZP16J10qGrbBvpLtj07TWzQY+2dvGHY6cpuFp9PH1EmF2k1ukLhDwuT8+jJu+hfw8dd/whVKb6Cyq65bs8ajXkM5mOLMdZXv0rZd1FDY2HgVZzzrmo+xHgYaMnhXSfr4678CvMMVKNOPFIcyGl03c62yLVIOo1EK33mMYHKgdbAyk4YRZagkt9JSSZDgOmmtzGIM52YNTUC/A9dMj3IHYXBetuUOMJcBc7DmAMmOdx4xvQ6olxhYFx/cOQLmiiEkVd42ZWdt35k+OI+F0hruVF4ixdjO8xxcT151ZE74njtY8EBQhWuQHiGgoTFcH4nEL41z1rMXqnO+sFrbFRcATe6sMhRSyL0saKc/2TV6xmlW1jxD6lK4e14kvZptSbpJ7CPePUo+8FI+WuSH+9ZjgZ4NxrB3dXGqb6f7oS2Bu/W/aWuGCLy1ZBYRDNZS6e6i/OVYT0QT6OvwvrhBv1QZ9lftExM9icwTkQitMjQB91DK+dvrK1i+Gk8PTv9/MNyTq8vvLt7dXLAzvEi7hA0QQDgbqJZmz9LRK/P4tm12+O3/6lHaX3bCR5o4LVXEcjFTmx6E3W/foCIR6f57dJaIygZils2GJ/cnr9uWyb806BntzRKxlF7JOQMARmoq8N/59l35yRx9/WP/RH0BX/a0fTagAb8YBi9LqRv+JRKxwPXRG7udtckAYtjjjuM8y9DRnuwTBH4AY99cXF3cXohE8Co+xE+LiJ/6P9jAs64dAqvOB/6XUd6zAptNh83adsvfffqkRB/jwM15mrVt+xunERfw",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,x={},k=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,l.jsx)(p(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,l.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(r(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,l.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function T(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.4a1b8c9b.js b/assets/js/ac7da374.4a1b8c9b.js new file mode 100644 index 000000000..f38eb6e75 --- /dev/null +++ b/assets/js/ac7da374.4a1b8c9b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>h,contentTitle:()=>g,default:()=>S,frontMatter:()=>f,metadata:()=>a,toc:()=>y});const a=JSON.parse('{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/v1.1/delete-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-template","permalink":"/docs/API-docs/v1.1/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV19v47gR/ypTvvTWUGxnN7dF9dT0NtgLGtwGlxwCNGsEtDSSeKFIHjmyYxgC7qHfoE997UfbT1IMJdmyk9120eLQl8Qazv8Zzvy4FSTLINJ7cYu105IwiEUicgyZV46UNSIVtxXCO9RICAMXnF9fgvN2pXIMsLENrBVVQBWCXCqtaANkwWNtVwgSgsNMFSoDGuQLb+vIPlDCFC4LkHsOFcBY0NaU6MEg5piLRFiHXrJfl7lIRR69GpwSiXDSyxoJPce0FUbWKFIx6HxQrEJxTE5SJY4DvXwHtjjwCqiSFK0HDmiJ0JlkPR5/aZTHXKTkG0xEoI1ma0HVTrMz+OS0zVGkhdSBGbIKaynSraCNi5zklSlFIgrra0l7StsuWH9w1gQMLPF6Pud/R4UZvOydgtBkGYZQNFpvficSkVlDaIglpXNaZTF1s58Di2+fO2SXP2NGnEfPiSbVGe/InPHnruOTjOGm4s9P1WsZ3PfujWiTvjT5OX1Z6PX89ZuT0/nJ/A+3p2/Tsz+m376dzufzv4pEPNWaZfsa5lzgNhGkSO+/22ds0ewBY09pmfnspTTe2BqpUqaENRqCtbemTMBplAGB/AZkKZUBzrT/H2YVvbf+y9n5Os/aUdTKaGXwYeihh7P5/OF0l4SzL/SSsQSFbUz+24b6kv0vB3T28HYX0LfPA7o0K6lVHifVrX1E89vGMzZPnfnn3ao6pnguDoId07sgA2aNV7SJg+3pRDp10p2n9wseF9wpdj8U4zCkSqRiNgyz2XY0CFvBKv1qGJWN1yIVFZEL6WwWpMmX9mlqHZqgSqPlMkwzW8+kU7PV6fRUtMmxjHTuq/ixOflakUCyVKb8d3KLfbZuuKJd0Q5ytiuddOovuBHJUJIxV78rKpQ5+lg+ZQobhftCfXBoblRpYpmj8eOdcoc6szXy9uDFMpkMIp/+9s+d1GQCuc2aGg3Fhpx+NB/Nh8aDs2v0RaNBmhwKjU9qqbvli3U865YvWQgoa40h6A0oQ1j6uBdUqUhq4DzxFMmk69azwsBslqU9jK5CmMJdhVSh56Pfe97eOa5Qc/uDbMjWkljV4C+srX8stF2HBCQsm6AMhgBoKmkyZhwqkYD1IA2gIfTOq4AQyLPXqvPNGvIyI6ilkSWy7gTGycpRK25X8HbZBIJgdRNdBpJKW485DAHFhR2TeME72CMwNbO181hx26wQyoaxSwKZzRFCvLYcgslhiYHAsS8qw7j3G6Nt9hgLyLsVnOUpoqRmvDD2kcXJSxN4o3e+DDXYJcx5y0saOwcnk58CcoWvlHkM6WTy0ZzA/a6v7nAZFOHim+EKrNfrZ63/6lDmvaLvmyX8iM4GRdZv9tKloqpZxusyVrL76DS9R4Oxf0aXYa8jt1l4fvuYOqtQu9kNEndImJ1fX8bB+wo+/fp3uELpDVR23XVr1njUGygHU5y5rvJd2nZzEwobG6/ijGdd8zH0wkBDBu8qSZ9+/UeAH3ANyvRXikOZTK6bpVbZDriGySSF7zxGbDfQOpSXScMAL1SSW2mlJEhwnbRW5nEK52YDTUC/x7pMj3IHYXBeduUOsJQBc7DmAFhO9x4xvQ6oVxhYF++/JQLmihEdVd42ZWdt7EwfnMdCaQ13Ki+RYmzneQ6uJ687Mid85A4WfCGowg1IjxDQ0BSuj0TiSeOc9eyF6pwvrNZ2zQVAkzurDIUUci8L2utP9o2ecZqVNS+QuhTu0X7Sq9mVpLuJfcT7N8JHHspHg/xw3nos0LPBGPa+Lk717XQ/tCVwt/43bc0bm6eWzCKgwFoq3W2UPx3ricsdfR0+FDfoVyrDfqt95kbPIvNMJEKrDE3AEWg4f399Bas307lIRuvxP7jcs6vL7y5+uLlgZ3iQdgk7nc6ncyY5G6iWZmTp6NF3vNu2ezj1f/VG7Dc74RPNnJYqQquYqW2Pie53T0KRiHT8PFwkorKBmGW75Zv7k9dty+RfGvQMvhaJWEmv5JIBwP1W5Crw73z3zPtsjr75sX8xvoKve2m+GNCAXwyDl5XUDX+JRDzi5ujJ2y7aZAAx7HHHcZ5l6Ggk+wwQH6DKdxdXF7cXIhE8ig/x02PET/0PNvCia4fAqvOB/zLKe1Fgu+2wWdvu+Lujz0r0MQ7cnKdF27b/AsJK8DY=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"}}');var l=i(74848),s=i(28453),p=i(33617),n=i.n(p),o=i(17543),d=i.n(o),r=i(86013),m=i.n(r),c=i(63723),v=i.n(c),u=(i(18766),i(79329),i(9303));const f={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV19v47gR/ypTvvTWUGxnN7dF9dT0NtgLGtwGlxwCNGsEtDSSeKFIHjmyYxgC7qHfoE997UfbT1IMJdmyk9120eLQl8Qazv8Zzvy4FSTLINJ7cYu105IwiEUicgyZV46UNSIVtxXCO9RICAMXnF9fgvN2pXIMsLENrBVVQBWCXCqtaANkwWNtVwgSgsNMFSoDGuQLb+vIPlDCFC4LkHsOFcBY0NaU6MEg5piLRFiHXrJfl7lIRR69GpwSiXDSyxoJPce0FUbWKFIx6HxQrEJxTE5SJY4DvXwHtjjwCqiSFK0HDmiJ0JlkPR5/aZTHXKTkG0xEoI1ma0HVTrMz+OS0zVGkhdSBGbIKaynSraCNi5zklSlFIgrra0l7StsuWH9w1gQMLPF6Pud/R4UZvOydgtBkGYZQNFpvficSkVlDaIglpXNaZTF1s58Di2+fO2SXP2NGnEfPiSbVGe/InPHnruOTjOGm4s9P1WsZ3PfujWiTvjT5OX1Z6PX89ZuT0/nJ/A+3p2/Tsz+m376dzufzv4pEPNWaZfsa5lzgNhGkSO+/22ds0ewBY09pmfnspTTe2BqpUqaENRqCtbemTMBplAGB/AZkKZUBzrT/H2YVvbf+y9n5Os/aUdTKaGXwYeihh7P5/OF0l4SzL/SSsQSFbUz+24b6kv0vB3T28HYX0LfPA7o0K6lVHifVrX1E89vGMzZPnfnn3ao6pnguDoId07sgA2aNV7SJg+3pRDp10p2n9wseF9wpdj8U4zCkSqRiNgyz2XY0CFvBKv1qGJWN1yIVFZEL6WwWpMmX9mlqHZqgSqPlMkwzW8+kU7PV6fRUtMmxjHTuq/ixOflakUCyVKb8d3KLfbZuuKJd0Q5ytiuddOovuBHJUJIxV78rKpQ5+lg+ZQobhftCfXBoblRpYpmj8eOdcoc6szXy9uDFMpkMIp/+9s+d1GQCuc2aGg3Fhpx+NB/Nh8aDs2v0RaNBmhwKjU9qqbvli3U865YvWQgoa40h6A0oQ1j6uBdUqUhq4DzxFMmk69azwsBslqU9jK5CmMJdhVSh56Pfe97eOa5Qc/uDbMjWkljV4C+srX8stF2HBCQsm6AMhgBoKmkyZhwqkYD1IA2gIfTOq4AQyLPXqvPNGvIyI6ilkSWy7gTGycpRK25X8HbZBIJgdRNdBpJKW485DAHFhR2TeME72CMwNbO181hx26wQyoaxSwKZzRFCvLYcgslhiYHAsS8qw7j3G6Nt9hgLyLsVnOUpoqRmvDD2kcXJSxN4o3e+DDXYJcx5y0saOwcnk58CcoWvlHkM6WTy0ZzA/a6v7nAZFOHim+EKrNfrZ63/6lDmvaLvmyX8iM4GRdZv9tKloqpZxusyVrL76DS9R4Oxf0aXYa8jt1l4fvuYOqtQu9kNEndImJ1fX8bB+wo+/fp3uELpDVR23XVr1njUGygHU5y5rvJd2nZzEwobG6/ijGdd8zH0wkBDBu8qSZ9+/UeAH3ANyvRXikOZTK6bpVbZDriGySSF7zxGbDfQOpSXScMAL1SSW2mlJEhwnbRW5nEK52YDTUC/x7pMj3IHYXBeduUOsJQBc7DmAFhO9x4xvQ6oVxhYF++/JQLmihEdVd42ZWdt7EwfnMdCaQ13Ki+RYmzneQ6uJ687Mid85A4WfCGowg1IjxDQ0BSuj0TiSeOc9eyF6pwvrNZ2zQVAkzurDIUUci8L2utP9o2ecZqVNS+QuhTu0X7Sq9mVpLuJfcT7N8JHHspHg/xw3nos0LPBGPa+Lk717XQ/tCVwt/43bc0bm6eWzCKgwFoq3W2UPx3ricsdfR0+FDfoVyrDfqt95kbPIvNMJEKrDE3AEWg4f399Bas307lIRuvxP7jcs6vL7y5+uLlgZ3iQdgk7nc6ncyY5G6iWZmTp6NF3vNu2ezj1f/VG7Dc74RPNnJYqQquYqW2Pie53T0KRiHT8PFwkorKBmGW75Zv7k9dty+RfGvQMvhaJWEmv5JIBwP1W5Crw73z3zPtsjr75sX8xvoKve2m+GNCAXwyDl5XUDX+JRDzi5ujJ2y7aZAAx7HHHcZ5l6Ggk+wwQH6DKdxdXF7cXIhE8ig/x02PET/0PNvCia4fAqvOB/zLKe1Fgu+2wWdvu+Lujz0r0MQ7cnKdF27b/AsJK8DY=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,h={},y=[];function D(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,l.jsx)(n(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,l.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,l.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(v(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function S(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(D,{...e})}):D(e)}}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.102fca2b.js b/assets/js/b2e6bd40.102fca2b.js new file mode 100644 index 000000000..c46654463 --- /dev/null +++ b/assets/js/b2e6bd40.102fca2b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7960],{48597:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>v,default:()=>P,frontMatter:()=>g,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/v1.1/resendrequestmail.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/resendrequestmail","permalink":"/docs/API-docs/v1.1/resendrequestmail","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar_label":"Resend request mail","hide_title":true,"hide_table_of_contents":true,"api":"eJztWN1uW7kRfpUpb9IVjiUlTW8E11jXDbJGg40Re2EUjiFQ58zR4ZqH5PJHsioI2Iu+Qa/2dh8tT1IMef4ka5NNg7ZAsTeGPOQMZ74ZznyHW+b50rHZHfuLzkONyjt2n7ECXW6F8UIrNmPv0KEqwOIPAZ2HmgsJXkNwaKHUFpxYKqGWUDQmxu8Vy5g2aDlZuCw6G40JssAy1vz3Z11s2GzLcq08Kk8/uTFS5FF78r0jJ7bM5RXWnH6RnrBYkNvtmXNRsIxhtHyfMb8xyGZML77H3LOMGUvueIGODAyVZtt2s/NWqCVZeeS1kSQyVq9EgV1kIAq2a485ormPW6sdgYqolVbXES60jiC0ePIE2oRe7wNpf938O8513TkwdyGF90lHLoLzzcHcB4vdedEONHZAKPD46CeVryUltuZ+DBdcgVC5DAVCqaXUa0r1ilvBFxIdwHbbwemFl7jbwXZLUaGdK17jbpf1AjpvT2AqrZotFnMUqz2tToS9YicbqOKjEXYzL7hvBLmuDVeboQOpSOfBNnaUps3jPawPHIeKuxYrLGCjAyWNLB2Jus/LoinoL0oKGfktI+zUnH0jjrhyOjFnp+bsFqHSBsFXwjXAlUIVLuZqjVKO4dR5q9Xy7ACC00kjP55kiyuBa+CqSPnurRxi2xkaNz79TQc7SKtwkNuQCx6bprE6RyxgLXwFvkJQ+OjBeTQOuAPhUzctBcYYLPClRYy9h3zhwVfair/H1tgeeMqhslj+6dkBps/Orsn1Ci2eTvhZs/uyjDFWfIXA1QZi4EIrB9qCIt/KYH2FFnLJrSibPpyBkcgdArVpnvvofEK09eOm4urBZacLe3aDvIa3BhV58OEfP9MOtttlLILGZszGedBflx0t9o3d24BR4IxWLnXtF9NpbN57t4hlv35ufHwoWHRBHm2m6eIdnxCpgVJ6XMhzdK4MUm7Ge7EKJYXCeRvM/MV0On8+pZB3GXv5n40KrdX2c4O61jX6irrKmiJbU3l/PKSX0+n8RRfRy6cRnfQzVGkPpQ6qAFEOJyvdFFrLtbWYE4s4SaNzT6EZqkVaSle+UTSxqOIcSzMWpHAedH9KHK3/S2SPgKDtQZSfQvrl/HmH9B+fIn2pVlyKAs6vLuFGP6D63X8h5j7C4fE+HU+uPtaRMFHvjUHFTXGd7QU7lKcgHebBCr9hs7stezzhRpyk9dnd/e4+Y1Sqmiim0S56zH3FZmzSdxhGRuwKrYs2gpVsxirvjZtNJo6rYqEfx9qgoqqRfOGIZk24EZPV8/FztssOdbgxn7Ufw8nnqjjPl0ItP6V33+NzTTlMadpDqUsWN+KvuGFZm4ThrowJqp0KeYE2JoxK411P0F+1CT5gz0cpcseQn5LXJ9z1yzjXPuX6jS38P7EFqslSxwJu2kO7JTaXeAEOSfUtylzXSNjRiaPRwGqnNRp11ZqQea/eq7fBgtFrtGWQEbxS4qNYSIxqWMc119Uj8lqic5I4usel5R6hEEvhuey+h3Nu+EJIQd2TtukmR30DdmO4rTDCt9HhmUXgUOAKJTVdSp+uuR9+WsNa24dS6rXLgMMiOKHQOUBVcZXTxrYbZJQfrgCVR2uscAjOW/JaJN+08pYSU3PFl7FksmEKoEBJN8iB1YvgPDgtQ0q850JqiwW0AVEZuAjiq0dDS0BSIvwWK2pdK4RlEAW6DHJdILjYDygEVcCCvnkM+SJyjF/FQUmdP8QEEpsCo2l20ZXQ5Z6PpO4tV45GbvKlzUEHWLxCzmFycDT6ziFl+I1QD242GhHJuOvq6hYXTni8/33bhtfr9ZP2+9W+zmvhvwkLeIdGO+G13fTaS+GrsIgte2ik+ydZeo0KY/0MGnJvo9C5ezoBSDqpUJrJNXqqEDc5v7qM4/4r+PDjP+ENcqug0utUrXmwKDewbI8i5FLmE2zdtI4POtQ3CPE8FV/T7loEbyvuP/z4k4NvcU1cK10pCmU0ugoLKXK4wdpI7tGNRjO4sEhH+lYGvuIecq5ggeAqTqW0Ehw4mKQthXoYw7naJGLUNT+SR729MGLDbdPtYMEdFqBV1GjPHPcekbx2KFfoyBaxrgUCFoLaua+sDst02tCZJjiLpZASbkWxRB9jOy8Kop1RvE5iAnzgDpZ0IXyFG+A29kA/hqsDlbgSjNGWvBDJ+f7bHlVhtFDezaCwvPS9/awv9Jxgjq33iShByDs4ssZMl5J0E5uIO2l6iTogE/v91mKJlg6MYfd5MaIpp7u2LIGq9UvKmgZCM00iFW0YBjfi60M7kVKird3b8hrtSuTYMKtfuNGTuHnCMiZFjsrhgKqev756A6s/jKcsG1C0X3G5J28uL159e/2KnKFGmgB7Pp6OpyQitlpzNTjpyDPr4XwbPJL+m6+yDReMr0pGchHpd4xr2zDnu8G3OT2lVkSrZ3dsu6Wr9R1RBRL/ENASJ7/PWPv0FBl51pJIotoPSKzsIvl8ckNn03YZEh89+BAhFpw0zvMcjf/o3iHzv3p7fcMy1r671bqITwx8TY/MfJ0+qHXEMH3qk2zLJFfLwJe0N9kk3ku9b580P0TS3PygqNoltRl4uM+mUxj0l4I6qrDdJkIeWWzan5Z+UaMBtt1Nubvf7Xb/AtkJjmI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var i=n(74848),r=n(28453),o=n(33617),a=n.n(o),d=n(17543),l=n.n(d),p=n(86013),u=n.n(p),c=n(63723),m=n.n(c),q=(n(18766),n(79329),n(9303));const g={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uW7kRfpUpb9IVjiUlTW8E11jXDbJGg40Re2EUjiFQ58zR4ZqH5PJHsioI2Iu+Qa/2dh8tT1IMef4ka5NNg7ZAsTeGPOQMZ74ZznyHW+b50rHZHfuLzkONyjt2n7ECXW6F8UIrNmPv0KEqwOIPAZ2HmgsJXkNwaKHUFpxYKqGWUDQmxu8Vy5g2aDlZuCw6G40JssAy1vz3Z11s2GzLcq08Kk8/uTFS5FF78r0jJ7bM5RXWnH6RnrBYkNvtmXNRsIxhtHyfMb8xyGZML77H3LOMGUvueIGODAyVZtt2s/NWqCVZeeS1kSQyVq9EgV1kIAq2a485ormPW6sdgYqolVbXES60jiC0ePIE2oRe7wNpf938O8513TkwdyGF90lHLoLzzcHcB4vdedEONHZAKPD46CeVryUltuZ+DBdcgVC5DAVCqaXUa0r1ilvBFxIdwHbbwemFl7jbwXZLUaGdK17jbpf1AjpvT2AqrZotFnMUqz2tToS9YicbqOKjEXYzL7hvBLmuDVeboQOpSOfBNnaUps3jPawPHIeKuxYrLGCjAyWNLB2Jus/LoinoL0oKGfktI+zUnH0jjrhyOjFnp+bsFqHSBsFXwjXAlUIVLuZqjVKO4dR5q9Xy7ACC00kjP55kiyuBa+CqSPnurRxi2xkaNz79TQc7SKtwkNuQCx6bprE6RyxgLXwFvkJQ+OjBeTQOuAPhUzctBcYYLPClRYy9h3zhwVfair/H1tgeeMqhslj+6dkBps/Orsn1Ci2eTvhZs/uyjDFWfIXA1QZi4EIrB9qCIt/KYH2FFnLJrSibPpyBkcgdArVpnvvofEK09eOm4urBZacLe3aDvIa3BhV58OEfP9MOtttlLILGZszGedBflx0t9o3d24BR4IxWLnXtF9NpbN57t4hlv35ufHwoWHRBHm2m6eIdnxCpgVJ6XMhzdK4MUm7Ge7EKJYXCeRvM/MV0On8+pZB3GXv5n40KrdX2c4O61jX6irrKmiJbU3l/PKSX0+n8RRfRy6cRnfQzVGkPpQ6qAFEOJyvdFFrLtbWYE4s4SaNzT6EZqkVaSle+UTSxqOIcSzMWpHAedH9KHK3/S2SPgKDtQZSfQvrl/HmH9B+fIn2pVlyKAs6vLuFGP6D63X8h5j7C4fE+HU+uPtaRMFHvjUHFTXGd7QU7lKcgHebBCr9hs7stezzhRpyk9dnd/e4+Y1Sqmiim0S56zH3FZmzSdxhGRuwKrYs2gpVsxirvjZtNJo6rYqEfx9qgoqqRfOGIZk24EZPV8/FztssOdbgxn7Ufw8nnqjjPl0ItP6V33+NzTTlMadpDqUsWN+KvuGFZm4ThrowJqp0KeYE2JoxK411P0F+1CT5gz0cpcseQn5LXJ9z1yzjXPuX6jS38P7EFqslSxwJu2kO7JTaXeAEOSfUtylzXSNjRiaPRwGqnNRp11ZqQea/eq7fBgtFrtGWQEbxS4qNYSIxqWMc119Uj8lqic5I4usel5R6hEEvhuey+h3Nu+EJIQd2TtukmR30DdmO4rTDCt9HhmUXgUOAKJTVdSp+uuR9+WsNa24dS6rXLgMMiOKHQOUBVcZXTxrYbZJQfrgCVR2uscAjOW/JaJN+08pYSU3PFl7FksmEKoEBJN8iB1YvgPDgtQ0q850JqiwW0AVEZuAjiq0dDS0BSIvwWK2pdK4RlEAW6DHJdILjYDygEVcCCvnkM+SJyjF/FQUmdP8QEEpsCo2l20ZXQ5Z6PpO4tV45GbvKlzUEHWLxCzmFycDT6ziFl+I1QD242GhHJuOvq6hYXTni8/33bhtfr9ZP2+9W+zmvhvwkLeIdGO+G13fTaS+GrsIgte2ik+ydZeo0KY/0MGnJvo9C5ezoBSDqpUJrJNXqqEDc5v7qM4/4r+PDjP+ENcqug0utUrXmwKDewbI8i5FLmE2zdtI4POtQ3CPE8FV/T7loEbyvuP/z4k4NvcU1cK10pCmU0ugoLKXK4wdpI7tGNRjO4sEhH+lYGvuIecq5ggeAqTqW0Ehw4mKQthXoYw7naJGLUNT+SR729MGLDbdPtYMEdFqBV1GjPHPcekbx2KFfoyBaxrgUCFoLaua+sDst02tCZJjiLpZASbkWxRB9jOy8Kop1RvE5iAnzgDpZ0IXyFG+A29kA/hqsDlbgSjNGWvBDJ+f7bHlVhtFDezaCwvPS9/awv9Jxgjq33iShByDs4ssZMl5J0E5uIO2l6iTogE/v91mKJlg6MYfd5MaIpp7u2LIGq9UvKmgZCM00iFW0YBjfi60M7kVKird3b8hrtSuTYMKtfuNGTuHnCMiZFjsrhgKqev756A6s/jKcsG1C0X3G5J28uL159e/2KnKFGmgB7Pp6OpyQitlpzNTjpyDPr4XwbPJL+m6+yDReMr0pGchHpd4xr2zDnu8G3OT2lVkSrZ3dsu6Wr9R1RBRL/ENASJ7/PWPv0FBl51pJIotoPSKzsIvl8ckNn03YZEh89+BAhFpw0zvMcjf/o3iHzv3p7fcMy1r671bqITwx8TY/MfJ0+qHXEMH3qk2zLJFfLwJe0N9kk3ku9b580P0TS3PygqNoltRl4uM+mUxj0l4I6qrDdJkIeWWzan5Z+UaMBtt1Nubvf7Xb/AtkJjmI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,j={},f=[];function h(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(q.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,i.jsx)(q.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(u(),{title:"Body",body:{content:{"application/json":{schema:{required:["document_id","email"],type:"object",properties:{document_id:{type:"string",example:"provide document id"},email:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"},email_subject:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"}},title:"resendmail_body"}}},required:!0}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",format:"string",example:"mail sent successfully."}},title:"inline_response_200_10"}}}},400:{description:"",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Something went wrong."}},title:"inline_response_400_2"}}}},404:{description:"- document not found if document id is not correct.\n- user not found if provided user email is not present in signer list of document\n",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"document not found or user not found."}},title:"inline_response_404_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.57077b26.js b/assets/js/b2e6bd40.57077b26.js deleted file mode 100644 index 6548b35b3..000000000 --- a/assets/js/b2e6bd40.57077b26.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7960],{48597:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>b,default:()=>x,frontMatter:()=>h,metadata:()=>i,toc:()=>v});const i=JSON.parse('{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/v1.1/resendrequestmail.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/resendrequestmail","permalink":"/docs/API-docs/v1.1/resendrequestmail","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar_label":"Resend request mail","hide_title":true,"hide_table_of_contents":true,"api":"eJztWF9vG7kR/ypTvqQnrCU5TV8E1zjXDXJGc4kR+2AUjiFQu7O7PHFJHsmVrAoC7uG+wT31tR8tn6QYcv9J1iWXBm2B4l4MeZYznPnNcOZHbpnnhWOze/YXndYVKu/YQ8IydKkVxgut2Iy9Q4cqA4s/1Og8VFxI8BpqhxZybcGJQglVQNaYGL9XLGHaoOVk4SrrbDQmyAJLWPPfn3W2YbMtS7XyqDz95MZIkQbtyfeOnNgyl5ZYcfpFesJiRm63e85FxhKGwfJDwvzGIJsxvfgeU88SZiy54wU6MjBUmm3bxc5boQqy8sgrI0lkrF6JDLvIQGRs125zRHMft1Y7ABVQy62uAlxoHUFo8eQJtBG93gfS/rr5d5zqqnNg7uoY3icduaydbzbmvrbY7RfsQGMHhAKPj35S+kpSYivux3DJFQiVyjpDyLWUek2pXnEr+EKiA9huOzi98BJ3O9huKSq0c8Ur3O2SXkD77QlMqVWzxGKKYrWn1YmwV+xkA1V8NMJu5hn3jSDVleFqM3QgFum8to0dpWnxeA/rA8eh5K7FCjPY6JqSRpaORN3nZdEU9BclhYz8lhF2Zs6/EUdcOZuY8zNzfodQaoPgS+Ea4HKhMhdytUYpx3DmvNWqOD+A4GzSyI8n2eJK4Bq4ymK+eyuH2HaGxo1Pf9O1HaRVOEhtnQoemqaxOkXMYC18Cb5EUPjowXk0DrgD4WM3zQWGGCzwwiKG3kO+8NqX2oq/h9bYbnjGobSY/+nZAabPzm/I9RItnk34ebP6Kg8xlnyFwNUGQuBCKwfagiLf8tr6Ei2kkluRN304ASOROwRq0zz1wfmIaOvHbcnV0iVnC3t+i7yCtwYVefDhp3/SCrbbJSyAxmbMhnnQH5cdfewbu7c1BoEzWrnYtZ9Pp6F5750ilvz6ufHxoWDR1fJoM40H7/iEiA2U0uPqNEXn8lrKzXgvVqGkUDhvg5k/n07np1MKeZewF//ZqNBabT83qBtdoS+pq6wpsjWV98dDejGdzp93Eb14GtFJP0OV9pDrWmUg8uFkpZNC31JtLabEIk7i6NxTaIZqFj/FI98omlBUYY7FGQtSOA+63yWM1v8lskdA0PYgyk8h/WJ+2iH9x6dIX6kVlyKDi+sruNVLVL/7L8TcRzjc3sftydXHKhAm6r0hqLAofGd7wQ7lMUiHaW2F37DZ/ZY9nnAjTuL32f3D7iFhVKqaKKbRLnjMfclmbNJ3GEZG7AqtCzb24bpZ86JA+029CC5f1F7DtzpdxrhqK9mMld4bN5tMVsL6aGnsolpZL4iTTa4tp4P/hq+W3E60QTU5HU/HU7ZLtgdGHFfZQj+OaRGVqeQLF2xwIyar0/HpER1uzGetx/rkc1Wc54VQxaf0HvqE3FDRxLrYS0tXHdyIv+KGJW3Wh6sSJgj9EnmGNlQI1eK7/kbwsq2oA7p+lJN3lPwpW35Clr+M5O1zvN/oyf8TPaGazHUo4KYftUtCawgH4JDF36FMdYWEHe04Gg2sdlqjUVetEZn36r16W1sweo02r2UAL5f4KBYSgxpW4Zvr6hF5JdE5SZcCj4XlHiEThfBcdhfwlBu+EFJQu6ZluslR3/HdGO5KDPBtdP3MInDIcIWSujylT1fcD+/ysNZ2mUu9dglwWNROKHQOUJVcpbSw7QYJ5YcrQOXRGiscgvOWvBbRN628pcRUXPEilEwyTAFkKOkEObB6UTsPTss6Jt5zIbXFDNqAqAxcAPHlo6FPQFK6YVgsqXWtEIpaZOgSSHWG4EI/oBBUBgu6ZBnyRaQYruG1kjpdhgRSFwejaVjSkdD5no+k7i1XjmZ89KXNQQdYOELOYXRwNPrOIWX4tVBLNxuNiNXcd3V1hwsnPD78vm3D6/X6Sfv9al/nlfA0rd6h0U54bTe9diF8O5GGRrp/oqVXqDDUz6Ah9zYynbqnE4CkkxKlmdygpwpxk4vrq8AvvoIPP/4Mr5FbBaVex2pNa4tyA0W7FSEXMx9h6+hBeEGivkGIp7H4mnbXInhXcv/hx384eINrInfxSFEoo9F1vZAihVusjOQe3Wg0g0uLtKVvZeBL7iHlChYIruRUSivBgYOJ2lKo5Rgu1CYysa75kTzo7YURGm6bbgcL7jADrYJGu+e494jklUO5Qke2iOYtEDAT1M59aXVdxN2GzjTBWcyFlHAnsgJ9iO0iy4jnBvE6ignwgTuY04HwJW6A29AD/RiuD1TCl9oYbckLEZ3vHxNQZUYL5d0MMstz39tP+kJPCebQep+IIoS8gyNpzHQpiSexibiTxqevAzKx328t5mhpwxB2nxcjmnK6b8sSqFq/pKxpIDTTJHDfhmFwI74+tBM4LNrKvc1v0K5Eig2z+oUTPQmLJyxhUqSoHA648cWr69ew+sN4ukc/f8Xhnry+unz55uYlOUONNALW0tBAjyuuBjsdedc9nG+DV9l/8xm44YLhGctILgLfD3FtG6p+P3gMoLfbknj87J5tt3S0viOqQOIfarR0CXhIWPvWFa4ASUsiidsvkVjZZfT55Jb2puWyjnz04OZDLDhqXKQpGv/RtcOrxvXbm1uWsPahr9JZeNPga3rV5ut4g9cBw/i2QLItk1wVNS9obbRJvJd63z5pXgbS3PygqNpPajPwcJ9NxzDoLwV1VGG7jYQ8sNi4Pn76RY0G2HY15e5ht9v9C7Wdtg0=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var s=n(74848),r=n(28453),o=n(33617),a=n.n(o),d=n(17543),l=n.n(d),p=n(86013),c=n.n(p),u=n(63723),m=n.n(u),g=(n(18766),n(79329),n(9303));const h={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9vG7kR/ypTvqQnrCU5TV8E1zjXDXJGc4kR+2AUjiFQu7O7PHFJHsmVrAoC7uG+wT31tR8tn6QYcv9J1iWXBm2B4l4MeZYznPnNcOZHbpnnhWOze/YXndYVKu/YQ8IydKkVxgut2Iy9Q4cqA4s/1Og8VFxI8BpqhxZybcGJQglVQNaYGL9XLGHaoOVk4SrrbDQmyAJLWPPfn3W2YbMtS7XyqDz95MZIkQbtyfeOnNgyl5ZYcfpFesJiRm63e85FxhKGwfJDwvzGIJsxvfgeU88SZiy54wU6MjBUmm3bxc5boQqy8sgrI0lkrF6JDLvIQGRs125zRHMft1Y7ABVQy62uAlxoHUFo8eQJtBG93gfS/rr5d5zqqnNg7uoY3icduaydbzbmvrbY7RfsQGMHhAKPj35S+kpSYivux3DJFQiVyjpDyLWUek2pXnEr+EKiA9huOzi98BJ3O9huKSq0c8Ur3O2SXkD77QlMqVWzxGKKYrWn1YmwV+xkA1V8NMJu5hn3jSDVleFqM3QgFum8to0dpWnxeA/rA8eh5K7FCjPY6JqSRpaORN3nZdEU9BclhYz8lhF2Zs6/EUdcOZuY8zNzfodQaoPgS+Ea4HKhMhdytUYpx3DmvNWqOD+A4GzSyI8n2eJK4Bq4ymK+eyuH2HaGxo1Pf9O1HaRVOEhtnQoemqaxOkXMYC18Cb5EUPjowXk0DrgD4WM3zQWGGCzwwiKG3kO+8NqX2oq/h9bYbnjGobSY/+nZAabPzm/I9RItnk34ebP6Kg8xlnyFwNUGQuBCKwfagiLf8tr6Ei2kkluRN304ASOROwRq0zz1wfmIaOvHbcnV0iVnC3t+i7yCtwYVefDhp3/SCrbbJSyAxmbMhnnQH5cdfewbu7c1BoEzWrnYtZ9Pp6F5750ilvz6ufHxoWDR1fJoM40H7/iEiA2U0uPqNEXn8lrKzXgvVqGkUDhvg5k/n07np1MKeZewF//ZqNBabT83qBtdoS+pq6wpsjWV98dDejGdzp93Eb14GtFJP0OV9pDrWmUg8uFkpZNC31JtLabEIk7i6NxTaIZqFj/FI98omlBUYY7FGQtSOA+63yWM1v8lskdA0PYgyk8h/WJ+2iH9x6dIX6kVlyKDi+sruNVLVL/7L8TcRzjc3sftydXHKhAm6r0hqLAofGd7wQ7lMUiHaW2F37DZ/ZY9nnAjTuL32f3D7iFhVKqaKKbRLnjMfclmbNJ3GEZG7AqtCzb24bpZ86JA+029CC5f1F7DtzpdxrhqK9mMld4bN5tMVsL6aGnsolpZL4iTTa4tp4P/hq+W3E60QTU5HU/HU7ZLtgdGHFfZQj+OaRGVqeQLF2xwIyar0/HpER1uzGetx/rkc1Wc54VQxaf0HvqE3FDRxLrYS0tXHdyIv+KGJW3Wh6sSJgj9EnmGNlQI1eK7/kbwsq2oA7p+lJN3lPwpW35Clr+M5O1zvN/oyf8TPaGazHUo4KYftUtCawgH4JDF36FMdYWEHe04Gg2sdlqjUVetEZn36r16W1sweo02r2UAL5f4KBYSgxpW4Zvr6hF5JdE5SZcCj4XlHiEThfBcdhfwlBu+EFJQu6ZluslR3/HdGO5KDPBtdP3MInDIcIWSujylT1fcD+/ysNZ2mUu9dglwWNROKHQOUJVcpbSw7QYJ5YcrQOXRGiscgvOWvBbRN628pcRUXPEilEwyTAFkKOkEObB6UTsPTss6Jt5zIbXFDNqAqAxcAPHlo6FPQFK6YVgsqXWtEIpaZOgSSHWG4EI/oBBUBgu6ZBnyRaQYruG1kjpdhgRSFwejaVjSkdD5no+k7i1XjmZ89KXNQQdYOELOYXRwNPrOIWX4tVBLNxuNiNXcd3V1hwsnPD78vm3D6/X6Sfv9al/nlfA0rd6h0U54bTe9diF8O5GGRrp/oqVXqDDUz6Ah9zYynbqnE4CkkxKlmdygpwpxk4vrq8AvvoIPP/4Mr5FbBaVex2pNa4tyA0W7FSEXMx9h6+hBeEGivkGIp7H4mnbXInhXcv/hx384eINrInfxSFEoo9F1vZAihVusjOQe3Wg0g0uLtKVvZeBL7iHlChYIruRUSivBgYOJ2lKo5Rgu1CYysa75kTzo7YURGm6bbgcL7jADrYJGu+e494jklUO5Qke2iOYtEDAT1M59aXVdxN2GzjTBWcyFlHAnsgJ9iO0iy4jnBvE6ignwgTuY04HwJW6A29AD/RiuD1TCl9oYbckLEZ3vHxNQZUYL5d0MMstz39tP+kJPCebQep+IIoS8gyNpzHQpiSexibiTxqevAzKx328t5mhpwxB2nxcjmnK6b8sSqFq/pKxpIDTTJHDfhmFwI74+tBM4LNrKvc1v0K5Eig2z+oUTPQmLJyxhUqSoHA648cWr69ew+sN4ukc/f8Xhnry+unz55uYlOUONNALW0tBAjyuuBjsdedc9nG+DV9l/8xm44YLhGctILgLfD3FtG6p+P3gMoLfbknj87J5tt3S0viOqQOIfarR0CXhIWPvWFa4ASUsiidsvkVjZZfT55Jb2puWyjnz04OZDLDhqXKQpGv/RtcOrxvXbm1uWsPahr9JZeNPga3rV5ut4g9cBw/i2QLItk1wVNS9obbRJvJd63z5pXgbS3PygqNpPajPwcJ9NxzDoLwV1VGG7jYQ8sNi4Pn76RY0G2HY15e5ht9v9C7Wdtg0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,f={},v=[];function q(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,s.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["document_id","email"],type:"object",properties:{document_id:{type:"string",example:"provide document id"},email:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"},email_subject:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"}},title:"resendmail_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",format:"string",example:"mail sent successfully."}},title:"inline_response_200_10"}}}},400:{description:"",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Something went wrong."}},title:"inline_response_400_2"}}}},404:{description:"- document not found if document id is not correct.\n- user not found if provided user email is not present in signer list of document\n",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"document not found or user not found."}},title:"inline_response_404_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(q,{...e})}):q(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.bc214206.js b/assets/js/b93339ed.bc214206.js new file mode 100644 index 000000000..12a3043e1 --- /dev/null +++ b/assets/js/b93339ed.bc214206.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>h,default:()=>y,frontMatter:()=>I,metadata:()=>a,toc:()=>w});const a=JSON.parse('{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/v1.1/updatefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/updatefolder","permalink":"/docs/API-docs/v1.1/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WN1u47gVfpVT3nTHUGwnm922umo6mM6mO5gJJhkEaMYIKOlI4oYiuSRlxzAE7EXfoFe97aPNkxSHlGQ5yaQN2u1NYpM8h9/5zi+9Y55XjqU37M9aFmjZKmEFutwK44VWLGVXNcInU3CPEI/A2cU5cCn1xsFWt+A1tDrsl3Ff8QaBO9iglPTfcIvKR+HzYs4Spg1aTvrPC5ayNmiPwixhhlveoEdLsHaMtLGUxe1bUbCECcJluK/ZQ7A6+wlzf16ALmFUaPHnVlgsWOptiwlzfitJpRONkcgShvdG6gJZWnLp6EBeY8NZumN+a8JJb4WqWMJKbRvupyt4z4OWlGU/HudlcVKbjHXdKl6Lzv9JF1tSdQj0wuq1KBAylHoDo8lEZm5xTyZLWK6VR+VJBzdGijwwt/jJkaLdBOzezpuersDdKhnMiOwQxZY84AU6kotn3weeX2ayws2AswuOm/j5pbpY1yXMCy8n3s6Iu66jHYvOaOUi4pPl8jGlrs1zdK5sJYzx9RL6nidpiKyXmvXDnTv5i8HNuSGKYqgXZ/4pNXuhk+XJt0fHy6Pl766Ov09P/5B+9/18uVz+lSXsvpEk22cFaWMT3uL3yYJQUii8Hdi7PVkub4+Pe05Pn6LxUjfoa6Eq2KDysLFaVQkYidwheLsFXnGhQHKP9jf/O37RWm2fZ+VlyJ5j4ZRYGEk4fUzCUMm0h1K3KhStX9vQ56LoMZ7nzTu9/f1o3nePzTtXay5FESq513eo/r+OfOJ6gnoY2iIeCvvswNjpejTSYd5a4behYdwfcSOO4n56s6JSTHGjqdWYNgCm1pGyRWR1sRt7S8dIl10Pvae1kqWs9t64dLFwXBWZvp9rg8qJSkmeuXmumwU3YrE+nh+zLnkow4150Xlsj14q4jyvhKr+ndxqT9MluTJ664Cs0WfciB9xy5LBF9NTffutkYey3yWMIuTjvtm9Gfx82FmmzeJxr2DkYqFKHVD0rv5gUF2KSoVACVY87PfXKHPdILVNXyPMZoPIl7/9c5SazaDQedug8iGk55/VZ/WhtWD0Bi31C64KKCXei0xiEMMm7I0DjkPeSHRObkEoj5WlDl2ISngugQinqpRzwzMhBWUCHdMkbWGSTG4O1zX6Gi1t/dYicChwjZISCHjrdcM9qRrwwkbbu5JGrQQ4ZK0TCp0DVDVXOR0cXJqAtsAVoPJojRUOwXlLqEXEppW3PPfQcMUrJN0JTMkqUAqKe7A6a50Hp2UbIIPnQmqLBQwGKcTCBRLf0OBkEWg1142xWFP8rRGqVhToEsh1geBCQJAJqoAMnQdDWESOLkyPSur8LjiwbKUEo6kOCS5piptiJHFvuXJUKiOWwQcjYcZqmgIwApzNPjkkD78T6s6ls9lndQQ3Y1xdY+aEx9U3Qy5tNptHOfTqUOat8D+0GXxEo53w2m730pXwdZuFvJsqGb9ETW9RYYifSVbtdRQ6d4/TmFYXNUqzuERPEeIWZxfnVyT6Cr788nd4h9wqqPUmRmveWpRbqIariLno+UjbWHmh1CHwamI8j8HXD64Dg9c1919++YeD97gBofqUIlNms4s2kyKHK2wMtV03m6XwOs6vflgDX3MPOVeQIbiaUyitBQcOJkpLoe7mcKa20Dq0sBG+DsFA60HuwAziZXS3g4w7LECrIDHcOd8jovXGoVyjI13UQTMELISniK6tbqt42xRMb5zFUkgJ16Ko0AfbzooCTL+8ictE+AQOlpQQvsYtcIvgUPk5XDwQCTutMdoSChHBl5reVOQAVIXRQnmXQmF56ff6k32gh2eC0OqJpUghH+lIejWjS2Im9haPq/PPVN0fdITDemuxREsXBrP3fjGiD6ebISyBovW/CWtqCFS1eB5GEmy4kLE1/fGhnjAeoG3ch/IS7Vrk2LfHr2T0IhxesIRJkaNyOBk7zt5evIP1t/MlSyZ99j9I7sW789dv3l++ITBUSCNhx/PlfBkeR9r5hqvJTQeP6oedbbcfx36VF3jf6D3e+4WRXIQRK9i768ej4Q3JEpbuH9+rhNXaedre7Sj3PlnZdbT8c4uWBrBVwtbcCp5RC7/ZsUI4+lyMr+uv2vnNx/4B+wqefMc/iXmYWBSNK2su2/CWTNgdbg9+NehWXTIMLQQr7r+Olx9dkZa9/KP5l6auKHGW52j8s2enA+fFpyuWsKz/DaAJvzIwyzf0swTfRKg6cBHGsbC2Y5KrquUVnY0qacyiKn04o92FGa3/QEY9Scbh8BatoL9k05MCu12c/7puPB+3virR8zqcJs+suq77F6OBb6o=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"}}');var d=o(74848),n=o(28453),s=o(33617),i=o.n(s),l=o(17543),r=o.n(l),p=o(86013),c=o.n(p),u=o(63723),m=o.n(u),f=(o(18766),o(79329),o(9303));const I={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WN1u47gVfpVT3nTHUGwnm922umo6mM6mO5gJJhkEaMYIKOlI4oYiuSRlxzAE7EXfoFe97aPNkxSHlGQ5yaQN2u1NYpM8h9/5zi+9Y55XjqU37M9aFmjZKmEFutwK44VWLGVXNcInU3CPEI/A2cU5cCn1xsFWt+A1tDrsl3Ff8QaBO9iglPTfcIvKR+HzYs4Spg1aTvrPC5ayNmiPwixhhlveoEdLsHaMtLGUxe1bUbCECcJluK/ZQ7A6+wlzf16ALmFUaPHnVlgsWOptiwlzfitJpRONkcgShvdG6gJZWnLp6EBeY8NZumN+a8JJb4WqWMJKbRvupyt4z4OWlGU/HudlcVKbjHXdKl6Lzv9JF1tSdQj0wuq1KBAylHoDo8lEZm5xTyZLWK6VR+VJBzdGijwwt/jJkaLdBOzezpuersDdKhnMiOwQxZY84AU6kotn3weeX2ayws2AswuOm/j5pbpY1yXMCy8n3s6Iu66jHYvOaOUi4pPl8jGlrs1zdK5sJYzx9RL6nidpiKyXmvXDnTv5i8HNuSGKYqgXZ/4pNXuhk+XJt0fHy6Pl766Ov09P/5B+9/18uVz+lSXsvpEk22cFaWMT3uL3yYJQUii8Hdi7PVkub4+Pe05Pn6LxUjfoa6Eq2KDysLFaVQkYidwheLsFXnGhQHKP9jf/O37RWm2fZ+VlyJ5j4ZRYGEk4fUzCUMm0h1K3KhStX9vQ56LoMZ7nzTu9/f1o3nePzTtXay5FESq513eo/r+OfOJ6gnoY2iIeCvvswNjpejTSYd5a4behYdwfcSOO4n56s6JSTHGjqdWYNgCm1pGyRWR1sRt7S8dIl10Pvae1kqWs9t64dLFwXBWZvp9rg8qJSkmeuXmumwU3YrE+nh+zLnkow4150Xlsj14q4jyvhKr+ndxqT9MluTJ664Cs0WfciB9xy5LBF9NTffutkYey3yWMIuTjvtm9Gfx82FmmzeJxr2DkYqFKHVD0rv5gUF2KSoVACVY87PfXKHPdILVNXyPMZoPIl7/9c5SazaDQedug8iGk55/VZ/WhtWD0Bi31C64KKCXei0xiEMMm7I0DjkPeSHRObkEoj5WlDl2ISngugQinqpRzwzMhBWUCHdMkbWGSTG4O1zX6Gi1t/dYicChwjZISCHjrdcM9qRrwwkbbu5JGrQQ4ZK0TCp0DVDVXOR0cXJqAtsAVoPJojRUOwXlLqEXEppW3PPfQcMUrJN0JTMkqUAqKe7A6a50Hp2UbIIPnQmqLBQwGKcTCBRLf0OBkEWg1142xWFP8rRGqVhToEsh1geBCQJAJqoAMnQdDWESOLkyPSur8LjiwbKUEo6kOCS5piptiJHFvuXJUKiOWwQcjYcZqmgIwApzNPjkkD78T6s6ls9lndQQ3Y1xdY+aEx9U3Qy5tNptHOfTqUOat8D+0GXxEo53w2m730pXwdZuFvJsqGb9ETW9RYYifSVbtdRQ6d4/TmFYXNUqzuERPEeIWZxfnVyT6Cr788nd4h9wqqPUmRmveWpRbqIariLno+UjbWHmh1CHwamI8j8HXD64Dg9c1919++YeD97gBofqUIlNms4s2kyKHK2wMtV03m6XwOs6vflgDX3MPOVeQIbiaUyitBQcOJkpLoe7mcKa20Dq0sBG+DsFA60HuwAziZXS3g4w7LECrIDHcOd8jovXGoVyjI13UQTMELISniK6tbqt42xRMb5zFUkgJ16Ko0AfbzooCTL+8ictE+AQOlpQQvsYtcIvgUPk5XDwQCTutMdoSChHBl5reVOQAVIXRQnmXQmF56ff6k32gh2eC0OqJpUghH+lIejWjS2Im9haPq/PPVN0fdITDemuxREsXBrP3fjGiD6ebISyBovW/CWtqCFS1eB5GEmy4kLE1/fGhnjAeoG3ch/IS7Vrk2LfHr2T0IhxesIRJkaNyOBk7zt5evIP1t/MlSyZ99j9I7sW789dv3l++ITBUSCNhx/PlfBkeR9r5hqvJTQeP6oedbbcfx36VF3jf6D3e+4WRXIQRK9i768ej4Q3JEpbuH9+rhNXaedre7Sj3PlnZdbT8c4uWBrBVwtbcCp5RC7/ZsUI4+lyMr+uv2vnNx/4B+wqefMc/iXmYWBSNK2su2/CWTNgdbg9+NehWXTIMLQQr7r+Olx9dkZa9/KP5l6auKHGW52j8s2enA+fFpyuWsKz/DaAJvzIwyzf0swTfRKg6cBHGsbC2Y5KrquUVnY0qacyiKn04o92FGa3/QEY9Scbh8BatoL9k05MCu12c/7puPB+3virR8zqcJs+suq77F6OBb6o=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,j={},w=[];function P(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,d.jsx)(i(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,d.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,d.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,d.jsx)(r(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,d.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,d.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.d3620018.js b/assets/js/b93339ed.d3620018.js deleted file mode 100644 index 6f7dc50f4..000000000 --- a/assets/js/b93339ed.d3620018.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>f,default:()=>v,frontMatter:()=>y,metadata:()=>r,toc:()=>P});const r=JSON.parse('{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/v1.1/updatefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/updatefolder","permalink":"/docs/API-docs/v1.1/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WM1y5LYRfpU2LvFOUTMjWXaSOVnZ2qxlb3ZVK22pytopFUj2kPCAAAyAQ01NscqHvIFPvubR9klSDZAcjqSVo0qci34AdKP7678P3DHPC8cWN+zvWuZo2TJhObrMCuOFVmzBrkqEDybnHiEegbOLc+BS6sbBVtfgNdQ67K/ivuIVAnfQoJT023CLykfh83zKEqYNWk76z3O2YHXQHoVZwgy3vEKPlszaMdLGFixu34qcJUyQXYb7kt03Vqc/YebPc9ArGBRa/LkWFnO28LbGhDm/laTSicpIZAnDOyN1jmyx4tLRgazEirPFjvmtCSe9FapgCVtpW3E/XsE7HrQsWPrDcbbKT0qTsrZdxmvR+b/pfEuqDg29sHojcoQUpW5gcJnAzCzuwWQJy7TyqDzp4MZIkQXkZj85UrQbGbv386aDK2C3THo3IjoEsaUIeIGO5OLZtwHn57mssOntbEPgRnF+ri7WtgnzwstRtFPCrm1px6IzWrlo8cl8/hBSV2cZOreqJQz59Rz4ngapz6znuvXd2p18b7A5NwRRTPX8zD+mZi90Mj/56uh4fjT/89XxN4vTvy6+/mY6n89/ZAm7qyTJdlVB2tgIt/j/aEEoKRTe9ujdnsznt8fHHaanj8F4qSv0pVAFNKg8NFarIgEjkTsEb7fACy4USO7RfvG/wxet1fZpVJ5n2VMonBIKAwinD0HoO5n2sNK1Ck3rj3b0qSx6aM/T7p3e/mVw7+uH7p2rDZciD53c6zWq/28gH7meTD1MbREPhX124Ox4PTrpMKut8NswMO6OuBFHcX9xs6RWTHmjadSYOhhMo2PBZhHV2W6YLS0jXXbTz557ldHwokD7XZ0Gy89qr+EfOltH92or2YKV3hu3mM02wvqoaeqiWFmn00xXswvLV7WUb/lmze1MG1Sz4+l8OmdtsrunxHGVp/puSoecKJTkqQs6uBGzzfH0+BEZbsyzzmN99FwR53khVPF7cst9XC4pd2J6HERnSBJuxA+4ZUkf/PGpbt6XyMOcaRNGKfl+P11f9Yl1OMrG0+nhcGKUU0KtdLCiy613BtWlKFSIb/DiPsG4RpnpCmlO+xJhMulFPv3zX4PUZAK5zuoKlQ81NP2oPqp3tQWjG7Q0oLjKYSXxTqQSgxhWYW9gVA55JdE5uQWhPBaWKEEuCuG5BAKc2mDGDU+FFFR6dEyTtIVR9bopXJfoS7S09SeLwCHHDUqqWOC11xX3pKq3Fxpt1yvidglwSGsnFDoHqEquMjrYhzQBbYErQOXRGiscgvOWrBbRNq285ZmHiiteIOlOYAxWjlJQoYHVae08OC3rYDJ4LqS2mEPvkELMXQDxFTE1i0Crma6MxZLyb4NQ1CJHl0CmcwQXEoJcUDmk6DwYskVk6AJdVVJn6xBAKkUwmhqf4JJo49hGEveWK0e9OdrSx2AAzFhNtAOjgZPJB4cU4TdCrd1iMvmojuBmyKtrTJ3wuPyyr6WmaR7U0ItDmdfCU8t5j0Y74bXd7qUL4fu2MlYy/BM1vUaFIX9GVbXXkevMPSxjWp2VKM3sEj1liJudXZxfkegL+PTLr/AGuVVQ6iZma1ZblFso+qsIuRj5CNvQ6mGlQ+KVhHgWk69jyj2C1yX3n375zcFbbECorqTIlcnkok6lyOAKK0Nz3k0mC3gZCbPv18CX3EPGFaQIruSUShvBgYOJ0lKo9RTO1BZqhxYa4cuQDLQe5A7cIFyGcDtIucMctAoS/Z3TvUW0XjmUG3Ski0Z2ioC58JTRpdV1EW8bG9M5Z3ElpIRrkRfog29neQ6mW27iMgE+MgdXVBC+xC1wi+BQ+Slc3BMJO7Ux2pIVIhq/0vSIowCgyo0WyrsF5Jav/F5/sk/08C4RWj2yFCHkAxxJp2YISazEzuNhdfqRuvu9iXDYby2u0NKFwe19XIzo0ummT0ugbP1v0poGAnUtngUOhBUXMo6mb+/rCXwEbeXerS7RbkSG3Xj8TEXPwuEZS5gUGSqHI55z9vriDWy+ms4POMR/UNyzN+cvX729fEXGUCONgPVcghntfMXV6KaDV/z9ybbb878/5MnfDXqPd35mJBeB0wV/dx0f6x+tLGGL/Wt/mbBSO0/bux3V3gcr25aWf67REuNbJmzDreApjXAibcLR3/nwnP+sn1++717ML+DRDweP2twzFkV0ZcNlHR6vCVvj9uAzRbtsk560kFlx/2W8/OiKtOzlHxBuYl1R4izL0Pgnz44Z7sWHK5awtPvoUIXPGszyhr6D8CaaqgMWgY6FtR2TXBU1L+hsVEk0i7r0IUdbB47W/UFOPQrGIXmLXtBP8ulRgd0u8r+2Hc7Hrc9KdLj2pykyy7Zt/w0TFJdV","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"}}');var n=o(74848),a=o(28453),s=o(33617),d=o.n(s),l=o(17543),i=o.n(l),p=o(86013),c=o.n(p),u=o(63723),m=o.n(u),b=(o(18766),o(79329),o(9303));const y={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WM1y5LYRfpU2LvFOUTMjWXaSOVnZ2qxlb3ZVK22pytopFUj2kPCAAAyAQ01NscqHvIFPvubR9klSDZAcjqSVo0qci34AdKP7678P3DHPC8cWN+zvWuZo2TJhObrMCuOFVmzBrkqEDybnHiEegbOLc+BS6sbBVtfgNdQ67K/ivuIVAnfQoJT023CLykfh83zKEqYNWk76z3O2YHXQHoVZwgy3vEKPlszaMdLGFixu34qcJUyQXYb7kt03Vqc/YebPc9ArGBRa/LkWFnO28LbGhDm/laTSicpIZAnDOyN1jmyx4tLRgazEirPFjvmtCSe9FapgCVtpW3E/XsE7HrQsWPrDcbbKT0qTsrZdxmvR+b/pfEuqDg29sHojcoQUpW5gcJnAzCzuwWQJy7TyqDzp4MZIkQXkZj85UrQbGbv386aDK2C3THo3IjoEsaUIeIGO5OLZtwHn57mssOntbEPgRnF+ri7WtgnzwstRtFPCrm1px6IzWrlo8cl8/hBSV2cZOreqJQz59Rz4ngapz6znuvXd2p18b7A5NwRRTPX8zD+mZi90Mj/56uh4fjT/89XxN4vTvy6+/mY6n89/ZAm7qyTJdlVB2tgIt/j/aEEoKRTe9ujdnsznt8fHHaanj8F4qSv0pVAFNKg8NFarIgEjkTsEb7fACy4USO7RfvG/wxet1fZpVJ5n2VMonBIKAwinD0HoO5n2sNK1Ck3rj3b0qSx6aM/T7p3e/mVw7+uH7p2rDZciD53c6zWq/28gH7meTD1MbREPhX124Ox4PTrpMKut8NswMO6OuBFHcX9xs6RWTHmjadSYOhhMo2PBZhHV2W6YLS0jXXbTz557ldHwokD7XZ0Gy89qr+EfOltH92or2YKV3hu3mM02wvqoaeqiWFmn00xXswvLV7WUb/lmze1MG1Sz4+l8OmdtsrunxHGVp/puSoecKJTkqQs6uBGzzfH0+BEZbsyzzmN99FwR53khVPF7cst9XC4pd2J6HERnSBJuxA+4ZUkf/PGpbt6XyMOcaRNGKfl+P11f9Yl1OMrG0+nhcGKUU0KtdLCiy613BtWlKFSIb/DiPsG4RpnpCmlO+xJhMulFPv3zX4PUZAK5zuoKlQ81NP2oPqp3tQWjG7Q0oLjKYSXxTqQSgxhWYW9gVA55JdE5uQWhPBaWKEEuCuG5BAKc2mDGDU+FFFR6dEyTtIVR9bopXJfoS7S09SeLwCHHDUqqWOC11xX3pKq3Fxpt1yvidglwSGsnFDoHqEquMjrYhzQBbYErQOXRGiscgvOWrBbRNq285ZmHiiteIOlOYAxWjlJQoYHVae08OC3rYDJ4LqS2mEPvkELMXQDxFTE1i0Crma6MxZLyb4NQ1CJHl0CmcwQXEoJcUDmk6DwYskVk6AJdVVJn6xBAKkUwmhqf4JJo49hGEveWK0e9OdrSx2AAzFhNtAOjgZPJB4cU4TdCrd1iMvmojuBmyKtrTJ3wuPyyr6WmaR7U0ItDmdfCU8t5j0Y74bXd7qUL4fu2MlYy/BM1vUaFIX9GVbXXkevMPSxjWp2VKM3sEj1liJudXZxfkegL+PTLr/AGuVVQ6iZma1ZblFso+qsIuRj5CNvQ6mGlQ+KVhHgWk69jyj2C1yX3n375zcFbbECorqTIlcnkok6lyOAKK0Nz3k0mC3gZCbPv18CX3EPGFaQIruSUShvBgYOJ0lKo9RTO1BZqhxYa4cuQDLQe5A7cIFyGcDtIucMctAoS/Z3TvUW0XjmUG3Ski0Z2ioC58JTRpdV1EW8bG9M5Z3ElpIRrkRfog29neQ6mW27iMgE+MgdXVBC+xC1wi+BQ+Slc3BMJO7Ux2pIVIhq/0vSIowCgyo0WyrsF5Jav/F5/sk/08C4RWj2yFCHkAxxJp2YISazEzuNhdfqRuvu9iXDYby2u0NKFwe19XIzo0ummT0ugbP1v0poGAnUtngUOhBUXMo6mb+/rCXwEbeXerS7RbkSG3Xj8TEXPwuEZS5gUGSqHI55z9vriDWy+ms4POMR/UNyzN+cvX729fEXGUCONgPVcghntfMXV6KaDV/z9ybbb878/5MnfDXqPd35mJBeB0wV/dx0f6x+tLGGL/Wt/mbBSO0/bux3V3gcr25aWf67REuNbJmzDreApjXAibcLR3/nwnP+sn1++717ML+DRDweP2twzFkV0ZcNlHR6vCVvj9uAzRbtsk560kFlx/2W8/OiKtOzlHxBuYl1R4izL0Pgnz44Z7sWHK5awtPvoUIXPGszyhr6D8CaaqgMWgY6FtR2TXBU1L+hsVEk0i7r0IUdbB47W/UFOPQrGIXmLXtBP8ulRgd0u8r+2Hc7Hrc9KdLj2pykyy7Zt/w0TFJdV",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,g={},P=[];function F(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,n.jsx)(d(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(i(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.78cbdeaf.js b/assets/js/c195e1f1.78cbdeaf.js deleted file mode 100644 index 8d6013d54..000000000 --- a/assets/js/c195e1f1.78cbdeaf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11z2ziSfwXHF09UtGQ7ydydK5daT5KdcW02diXOpbYslwYkWyJiEuACoGStS1X7sP/gnu51f9r8kqtugCQoS7aVyb3ceWpqxgKB7kajvxu4jSyfmej4Mnqr0roEaU10FUcZmFSLygolo+PoIgf2RgO3wJpZbKpVySyUVYHDJ+enjBeFWhi2VDWzis1AgsZPEhYsa2CzZMm+1saySqu5yISctTAmImNCGgs8Y2rK6qpQnCZwAjEVBfwgJLM5sKnSJc5JuIEfXzClWSIk18tnDOagl8yKEogOCZAhMakjnreEDNmFR2sQGtNQ4YysWLLaQEbYDEu5ZAn41Znbcm1AMyEt6ClPgXHLLgeDt5DUM/b5dDC4+iG3tjLHoxGvqqGqQBoxkwVPzDBV5SjDiVU2fYZE14b23zH3ImDncCzH8i+qJiIct4BlMOV1YdmcFzWxAZnOFiKbAfKWI+mKeCQ0k7yE3ndTV5XSlsFNCpVlSBi3tYaYGcvLKmZCCit4YWImSj6D4VgeDtlgACUXxWAwlr/++utY3o4lY+MIoY+jYzaO6PM4it24Bp4pWSzx25QXBvy4Jz1Y8ge44WVVADJmHI3lyiMYyyPEigi2I3V/7YLzq4I+lueI5atK2IWwxT2ocIrFKbvhS0H18b1AfKkqKy6X27H5CTvy03GSVXPLCpv18b5EvBm392wRv+6G8fBw/+Dl/tHB0cs+sh8RmYUbm6ib7fj8hN1QlkuG6/r4/pWYmkN6fS/CZsYuGC/HkSILuH80jq46pPvITjfteDBgjY7mfA5MSUDNLpUGZnMuacBpq825JYNk0CIlwAwUkKJdSZaNYpPS/xudl1ZVphbynjPzM3ZjotvRYZ+J/44YNc+EYkltrboHK836DigPD0jH6zIBfY+W0/dd0B34IXQRdcEdmD7qweBcw1QUBfviDCOeYjPU2EqugUEBzmnR0eGIkAY0HpmQVgXuhCUwxSMXlgnDTM41ZGwhbM44OYwhO5PFkkx9u4S8itIs54ZVoEthjEDbrRjPMpxaDh21GkylpAFHpnMECCkQK5OrusjQixXolPAr3Ahj0b80yz2098JY9J1rToH21HABD+TwYUXepMcOF33kMtOwYAn07O7RztaoBcnG0cGL0eHL0dHB0YsQ5vNvNgId7MtxVHKy8Sg94P5e0/rwJP6MUQwGB7kyIH04FPKdjscgqxu8qOVCOk7j1CbyGbbeYQcd9LO28MmR/12oD7Ft3QHz/3hvQ+HD9g3Q581CI/7zp7OPi4M//TxTJycnJx8+fc7ffZ6dnJyU+Hs4HPpdedA/frOtDLnVHPd34VeDazuvxjKKI1VheCyUPM2i48iHmN42oOVopossiqOKa16CBY2R+i1tLDqOgsg5iiOBkXrFbR6th+8q+QqpPaWwugkxozjS8NdaaMiiY6triCNjlwWCNQJjiSiO4KYqVAbRsbO1kUlzKHl0fBvZZUUzrRZyFsVkbbkNR3xEgiT9cpjk6VFeJdFqdeXQgrE/qWyJoFIlLUiLf/KqKkRKTBl9NUj6bYCzI/cywtAVmXEVN6S4PSKrNHLWCjBEKMZtu1L8IchYXOR3h6Unkjm3xgvWHg4zFaRiumyielpKUTr+krAolm0u0SUip1OmSmEtZHFPTn77+38bD2KBnikBl5r0ooVoFbfM6HbJteZLFAkLZTi+hUlabeZRx5GTNFW1lVxaREjR+71MpQkhgK8KwnAfoTghvg/rVwXoPXBylSv5wOzDo+f47/NDnO+j6F1PvsnXEMRXlUy+SXwymON672C//VgeZpB3vxPachMcBUsSpQrgMlxDqryKm5Dpfvg+4k7UTbRaxY0yrRmrwApNPjlRnDR7X+20jJBMVZGBRqN4H2Uk9yCzybosdlteL2EIE2hqv1bh9ZYtcrA5aBpecGkZQe/idTQHinl9GzIsi/QzcmEwudE1jCNS7C5MU/ijR0Iwl3GZManYHuGbmJoEYm/kfycqW+51K11w6mgWaEo8CTS5NR+mZzWG454UINpGkRt0mxje5+Gb2lhVMkLjF5F1awsJzNv2IXvDJRMyLWofq04VMhwNI7u9bUTAqddqxW5v8SxBT1DkV6u4G0BcvQEyBG5EQwpi3lvVDkG3sB0LlsJNJfRygoGmG/D2IiRAzKSQs0mtPRypcPKwJ4ZrhFMs73kAWStdYiY37Lq1pHS+j+b+HWb7c0cg/2/4/qp6/YvYQMqrUfX6VfX6C7BcVeA0zrFnKmTm9H0BRTFkr4zVSs5er7Hg1ciPbz5KDXMBC1JXOtUOyjpvW0BDT9NfVB1qijAs1XUqeIFwK61SaFJGFyzcWGYsVIZxg2klsWUqgPagGZ9poOSUaOG1zZUWf6PQqUH4irNcw/Q/9tZ4uvcazS3LQcOrEX/tZ59OaY9UxOByyWjjQkmD5Qwqo05rTcYxLbgWUx+nxawqgBtgGMbx1BLxjqMNHRc5l9cmfpXo1xfAS3ZWgUQKfvvHP3FGY8lP5ZnOQD/ClJ9OmQGyxHtox/Zipprkeiq0sd5AO/vnJcTRtUV1fNmzWA7Zu9bgmzoxOEs28DqDarWYzQBTfD+DFsfu9ICnuXMVRBWfoq1H7BUKj6pNQx4KGIp/AShgrmTrD2rIfmqDvJgF3KHqQrj34QarjtXvC/XGg37Ll2Gs4Soqd3hKFXMslPtVLONLg9go5MQPvEhrqk07HWaow+jVSBwb6Q8joxZTS9/hSzR5kicFnF2cP+KkcUNs36mxC7fdGTgY7OzinM2hE8Yh+2zac2oOnvemsFRlwOaCu6OP2SIXKanckpWY44Gk8/JWOyzYDF3Jie2zuwRlwmykKHaBBtrfmkjbBJhlQkNqiyUJkKotFoCETy7IBgw3RXCOCReqfozOPMBJzma1yOika936dNAmDho12JzRdeqsQlbrJs3xQuuMmDEdnxqu4KQAfsxAGrecsyk3FnTMakk9FV1XqA0NSLipQAuQKWxkQWC6H/afGK1RS0S5uKwCbZRE86b0jEtvPbF9ssAknyWQ88JN9WbCsASQKtTu4ca84bd//DPq6NqaJ90lzGHgWabBmAcopIqfEyesO2PRb8ms6lOE8ED/Yb0BhdSRSE5KlbViah4vQedYqbSmtYm+XNmWSk2d5uiyWltrwrYS9ZlMjFvCxIJ6VarC/baFlKYuKbZp30dAPqYBDVSNQZ1BiZLLUH26Eq5aA0cJgTBuNAziN0oa9gMfPklsBZR82bbrELbvUYJEy5Ox87d/pOaiiyY2lGsxzw2sqFt+J/fhtVUTDaWQj/OZn5zToEO0qlX72qqSW5GyBpQZMj/VsduqUItL9kPDKtSOuVD62UZ2OXATJVOYCDmhruzDTugDDVMNDb1PAnYBIEPamkNzrtWVi5C2RQ6S9XgSeErcdF85XsbIwxL0DCYpJtykCPAIPg4GCG0wYPuOFm9ETa19JR7P0jtRcjcddKTIh+ZtTbDz/ygXnXD+ohbIsza6whjYwUeWMqLcl4tCDCmXUlmXq2K62DatcWLJhexQuGYAnRftxsd/aa6Uw4ecIzzxfXtqQiIv8RmqPm+xOw0NhJ4XilTcR7n+c4+o0yliz8nh0BHGGP4Snto4XVELCZrKY5WGKWj0D6bNtzd+pZSZF0bR1npQG4luZH4tVW5EunKtkYfLNv9rdZ/7ak5tmSZuS9u7gujaNVi2Wd1TupmEtRtKXmlyv54cUEK7Ojo4wP/11eltrxmGjr9OMYaY1kWx/Jcofnx1+H6WNhXwXXmSfxVHf7tJ50fnTaG11sW3n+zDhdNNRbi1qxJISZ+Kx23FX0updbFv1T7uZb9VPAIbnLeQhZAwaQ5wkql00ux+RabTGD7bWcTa46b8qH/WD6CPnEC+2CRFQe4q9yh67tq4PlPHMAFtbnPBBpNaZVtH3Uzp2yehGZbGaSWJ+XeTR9Ba6V25d+58gQFbV91OHOCHOPji4GCSdkx8uYGJcs4LkdFNrgt1DfI7qt/W7XabC9Fbhx5JvSmLziRGwk2i71Fvt+G426SBtNbCLqlhdrPPK7Hvvh9fXmEbqgSbK2y9VcoQxdg5O45GfVM3ug1s3SpCsHretOHWQqwFx6rAL3VCmziprWJ/Vum12ylpbKuEc6GtgzQ0blleJ3RB7FxzVIgPfH7N9QjD99Hh8GB4EK3i2zUghsssUTd3L5nxSozmh8PDDWs2Xkq7Zz7U+7suMZbPhJw9tO6qO6JPKEZOUnoH1ZnZSvwJUP28HISzfOMzB46RMJ48SufHrsn4rpGxthu4ucHXttEum45Y2PZqu153WlktVU27qu1WBS2poCPVNZl6PSZqGwVdo7DN23R5wiaP78m2fZxes4YkvOukRFG/W+L6vWvV/99XzO7Xsp8KtP+HCrRr9VknPJuKjIcve+U9L6Fhnaq5SBDWbXrFk/XaydY6xpYyhkfg0nUU+7VE2X/fnJ9iXrgxLfSrghRgu5pGYQTeC6qv0DgJOVWhKWqYTT6DLON6yvkFilS56iye3WAQnE+7ajBoDZqTMUylzmrNKrUAPa0LEsNpATcC82VcBiV965qgwMsCjCmWdL15RglcJmbCYhnSF+RSXvFEFAI9u7sE56S9Cw7MkH3p2qh7mm5dwxwKDAjaioOcdQZ4ofT1FNuxMeMswUvRWAMDmXOZunKbcxNUNuLSlWgrLTAWshqpFo42Ja1GES+55DNSvjgUZpZBgbbIMK0SrPUaVdROhSwXhdKu0k0bonuaxMR3eAlGA8NRtOEachTFuS9pmtiVlA05BNyCzFgCdMOdp1Zg7mkVq2Wh0mvXo6iLglXKur4BVjtCGnG51VwauuPuiuv+DFqG+UIrGJ/FfzaAJ/xeyGu8y4i3ly5bufoCiREWunvpi8Xijl9+1l/zs7AYxnyEShlhlV52q2fCNqFKCKT94SD93Fz+Dzx1ByNTqdlwNV6lZpRDUY0+gUUJMaOT81MKRZ+x3/7+X+w9cC1ZrhZOWtNaQ7Hs3hkg59zJO7a1kaS7J1/bHDmecn8pkuxnw8EvObdUMsDIQEivUu4a2HmdFCLt3gsMBsfNff2u1061Gf9cwF//xCYDZ5VbXQh5PWQncuneD7RuBMdpXW8b5LqCNxPBvf7gGtlFgB1KA8XcPVnwJSDIhGssaVXPHLaQGL+5/k1Y3NtJlrFq7TYslgE7ctxdV+qZ0E0EKlltukDbu1vab0eDzColpDXHLNN8ajv48doVWXJid4aa27UNO2IPpj0Sp4l+x+2oK+6sRZl9e0tFI0Roes9YeCW8OF02YslQWn+PWLubSuSXg/IAhrsbC/cWdGnOpp9Az0Xa5PRbNHpEk0dRHBUiBV8O8p7q5Ofz92z+fHjQy0seodyj96dv3n349A6JQUPqGNbkJ5RJlVwGmDY+GgquIPY4H9wFfHpx9PTi6OnF0dOLo6cXR08vjp5eHD29OHp6cfT04ujpxdHvfHHki+moQaOq4EIGnUTX/bhca/RGcXQcPjK6iqMcuyXHl9HtLcZ+n7FeicN/ramCdnkVR3OuBVb8XIvEXR7Jgnr1loj/h4++ffyMbXmvtJH+pkMgsT1ALHF1v2tYrr2QWl2t4qZNgKS5GW8cAfsXCKeDcKfbhX0Ot+IkxVj23rlhe+n87NNFFEfNHe+SHlRFmi+wUMgXjlrnsNxjHBy7jQouZzW1WCMHc+Vu/eT9tsg1tUX8H7irjfzo90vcNvC/uKmNC25vXcuFCvtuvvu0dYVnbDMbD+dqtVr9D8AVTyE=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var s=n(74848),r=n(28453),a=n(33617),o=n.n(a),l=n(17543),d=n.n(l),c=n(86013),p=n.n(c),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11z2ziSfwXHF09UtGQ7ydydK5daT5KdcW02diXOpbYslwYkWyJiEuACoGStS1X7sP/gnu51f9r8kqtugCQoS7aVyb3ceWpqxgKB7kajvxu4jSyfmej4Mnqr0roEaU10FUcZmFSLygolo+PoIgf2RgO3wJpZbKpVySyUVYHDJ+enjBeFWhi2VDWzis1AgsZPEhYsa2CzZMm+1saySqu5yISctTAmImNCGgs8Y2rK6qpQnCZwAjEVBfwgJLM5sKnSJc5JuIEfXzClWSIk18tnDOagl8yKEogOCZAhMakjnreEDNmFR2sQGtNQ4YysWLLaQEbYDEu5ZAn41Znbcm1AMyEt6ClPgXHLLgeDt5DUM/b5dDC4+iG3tjLHoxGvqqGqQBoxkwVPzDBV5SjDiVU2fYZE14b23zH3ImDncCzH8i+qJiIct4BlMOV1YdmcFzWxAZnOFiKbAfKWI+mKeCQ0k7yE3ndTV5XSlsFNCpVlSBi3tYaYGcvLKmZCCit4YWImSj6D4VgeDtlgACUXxWAwlr/++utY3o4lY+MIoY+jYzaO6PM4it24Bp4pWSzx25QXBvy4Jz1Y8ge44WVVADJmHI3lyiMYyyPEigi2I3V/7YLzq4I+lueI5atK2IWwxT2ocIrFKbvhS0H18b1AfKkqKy6X27H5CTvy03GSVXPLCpv18b5EvBm392wRv+6G8fBw/+Dl/tHB0cs+sh8RmYUbm6ib7fj8hN1QlkuG6/r4/pWYmkN6fS/CZsYuGC/HkSILuH80jq46pPvITjfteDBgjY7mfA5MSUDNLpUGZnMuacBpq825JYNk0CIlwAwUkKJdSZaNYpPS/xudl1ZVphbynjPzM3ZjotvRYZ+J/44YNc+EYkltrboHK836DigPD0jH6zIBfY+W0/dd0B34IXQRdcEdmD7qweBcw1QUBfviDCOeYjPU2EqugUEBzmnR0eGIkAY0HpmQVgXuhCUwxSMXlgnDTM41ZGwhbM44OYwhO5PFkkx9u4S8itIs54ZVoEthjEDbrRjPMpxaDh21GkylpAFHpnMECCkQK5OrusjQixXolPAr3Ahj0b80yz2098JY9J1rToH21HABD+TwYUXepMcOF33kMtOwYAn07O7RztaoBcnG0cGL0eHL0dHB0YsQ5vNvNgId7MtxVHKy8Sg94P5e0/rwJP6MUQwGB7kyIH04FPKdjscgqxu8qOVCOk7j1CbyGbbeYQcd9LO28MmR/12oD7Ft3QHz/3hvQ+HD9g3Q581CI/7zp7OPi4M//TxTJycnJx8+fc7ffZ6dnJyU+Hs4HPpdedA/frOtDLnVHPd34VeDazuvxjKKI1VheCyUPM2i48iHmN42oOVopossiqOKa16CBY2R+i1tLDqOgsg5iiOBkXrFbR6th+8q+QqpPaWwugkxozjS8NdaaMiiY6triCNjlwWCNQJjiSiO4KYqVAbRsbO1kUlzKHl0fBvZZUUzrRZyFsVkbbkNR3xEgiT9cpjk6VFeJdFqdeXQgrE/qWyJoFIlLUiLf/KqKkRKTBl9NUj6bYCzI/cywtAVmXEVN6S4PSKrNHLWCjBEKMZtu1L8IchYXOR3h6Unkjm3xgvWHg4zFaRiumyielpKUTr+krAolm0u0SUip1OmSmEtZHFPTn77+38bD2KBnikBl5r0ooVoFbfM6HbJteZLFAkLZTi+hUlabeZRx5GTNFW1lVxaREjR+71MpQkhgK8KwnAfoTghvg/rVwXoPXBylSv5wOzDo+f47/NDnO+j6F1PvsnXEMRXlUy+SXwymON672C//VgeZpB3vxPachMcBUsSpQrgMlxDqryKm5Dpfvg+4k7UTbRaxY0yrRmrwApNPjlRnDR7X+20jJBMVZGBRqN4H2Uk9yCzybosdlteL2EIE2hqv1bh9ZYtcrA5aBpecGkZQe/idTQHinl9GzIsi/QzcmEwudE1jCNS7C5MU/ijR0Iwl3GZManYHuGbmJoEYm/kfycqW+51K11w6mgWaEo8CTS5NR+mZzWG454UINpGkRt0mxje5+Gb2lhVMkLjF5F1awsJzNv2IXvDJRMyLWofq04VMhwNI7u9bUTAqddqxW5v8SxBT1DkV6u4G0BcvQEyBG5EQwpi3lvVDkG3sB0LlsJNJfRygoGmG/D2IiRAzKSQs0mtPRypcPKwJ4ZrhFMs73kAWStdYiY37Lq1pHS+j+b+HWb7c0cg/2/4/qp6/YvYQMqrUfX6VfX6C7BcVeA0zrFnKmTm9H0BRTFkr4zVSs5er7Hg1ciPbz5KDXMBC1JXOtUOyjpvW0BDT9NfVB1qijAs1XUqeIFwK61SaFJGFyzcWGYsVIZxg2klsWUqgPagGZ9poOSUaOG1zZUWf6PQqUH4irNcw/Q/9tZ4uvcazS3LQcOrEX/tZ59OaY9UxOByyWjjQkmD5Qwqo05rTcYxLbgWUx+nxawqgBtgGMbx1BLxjqMNHRc5l9cmfpXo1xfAS3ZWgUQKfvvHP3FGY8lP5ZnOQD/ClJ9OmQGyxHtox/Zipprkeiq0sd5AO/vnJcTRtUV1fNmzWA7Zu9bgmzoxOEs28DqDarWYzQBTfD+DFsfu9ICnuXMVRBWfoq1H7BUKj6pNQx4KGIp/AShgrmTrD2rIfmqDvJgF3KHqQrj34QarjtXvC/XGg37Ll2Gs4Soqd3hKFXMslPtVLONLg9go5MQPvEhrqk07HWaow+jVSBwb6Q8joxZTS9/hSzR5kicFnF2cP+KkcUNs36mxC7fdGTgY7OzinM2hE8Yh+2zac2oOnvemsFRlwOaCu6OP2SIXKanckpWY44Gk8/JWOyzYDF3Jie2zuwRlwmykKHaBBtrfmkjbBJhlQkNqiyUJkKotFoCETy7IBgw3RXCOCReqfozOPMBJzma1yOika936dNAmDho12JzRdeqsQlbrJs3xQuuMmDEdnxqu4KQAfsxAGrecsyk3FnTMakk9FV1XqA0NSLipQAuQKWxkQWC6H/afGK1RS0S5uKwCbZRE86b0jEtvPbF9ssAknyWQ88JN9WbCsASQKtTu4ca84bd//DPq6NqaJ90lzGHgWabBmAcopIqfEyesO2PRb8ms6lOE8ED/Yb0BhdSRSE5KlbViah4vQedYqbSmtYm+XNmWSk2d5uiyWltrwrYS9ZlMjFvCxIJ6VarC/baFlKYuKbZp30dAPqYBDVSNQZ1BiZLLUH26Eq5aA0cJgTBuNAziN0oa9gMfPklsBZR82bbrELbvUYJEy5Ox87d/pOaiiyY2lGsxzw2sqFt+J/fhtVUTDaWQj/OZn5zToEO0qlX72qqSW5GyBpQZMj/VsduqUItL9kPDKtSOuVD62UZ2OXATJVOYCDmhruzDTugDDVMNDb1PAnYBIEPamkNzrtWVi5C2RQ6S9XgSeErcdF85XsbIwxL0DCYpJtykCPAIPg4GCG0wYPuOFm9ETa19JR7P0jtRcjcddKTIh+ZtTbDz/ygXnXD+ohbIsza6whjYwUeWMqLcl4tCDCmXUlmXq2K62DatcWLJhexQuGYAnRftxsd/aa6Uw4ecIzzxfXtqQiIv8RmqPm+xOw0NhJ4XilTcR7n+c4+o0yliz8nh0BHGGP4Snto4XVELCZrKY5WGKWj0D6bNtzd+pZSZF0bR1npQG4luZH4tVW5EunKtkYfLNv9rdZ/7ak5tmSZuS9u7gujaNVi2Wd1TupmEtRtKXmlyv54cUEK7Ojo4wP/11eltrxmGjr9OMYaY1kWx/Jcofnx1+H6WNhXwXXmSfxVHf7tJ50fnTaG11sW3n+zDhdNNRbi1qxJISZ+Kx23FX0updbFv1T7uZb9VPAIbnLeQhZAwaQ5wkql00ux+RabTGD7bWcTa46b8qH/WD6CPnEC+2CRFQe4q9yh67tq4PlPHMAFtbnPBBpNaZVtH3Uzp2yehGZbGaSWJ+XeTR9Ba6V25d+58gQFbV91OHOCHOPji4GCSdkx8uYGJcs4LkdFNrgt1DfI7qt/W7XabC9Fbhx5JvSmLziRGwk2i71Fvt+G426SBtNbCLqlhdrPPK7Hvvh9fXmEbqgSbK2y9VcoQxdg5O45GfVM3ug1s3SpCsHretOHWQqwFx6rAL3VCmziprWJ/Vum12ylpbKuEc6GtgzQ0blleJ3RB7FxzVIgPfH7N9QjD99Hh8GB4EK3i2zUghsssUTd3L5nxSozmh8PDDWs2Xkq7Zz7U+7suMZbPhJw9tO6qO6JPKEZOUnoH1ZnZSvwJUP28HISzfOMzB46RMJ48SufHrsn4rpGxthu4ucHXttEum45Y2PZqu153WlktVU27qu1WBS2poCPVNZl6PSZqGwVdo7DN23R5wiaP78m2fZxes4YkvOukRFG/W+L6vWvV/99XzO7Xsp8KtP+HCrRr9VknPJuKjIcve+U9L6Fhnaq5SBDWbXrFk/XaydY6xpYyhkfg0nUU+7VE2X/fnJ9iXrgxLfSrghRgu5pGYQTeC6qv0DgJOVWhKWqYTT6DLON6yvkFilS56iye3WAQnE+7ajBoDZqTMUylzmrNKrUAPa0LEsNpATcC82VcBiV965qgwMsCjCmWdL15RglcJmbCYhnSF+RSXvFEFAI9u7sE56S9Cw7MkH3p2qh7mm5dwxwKDAjaioOcdQZ4ofT1FNuxMeMswUvRWAMDmXOZunKbcxNUNuLSlWgrLTAWshqpFo42Ja1GES+55DNSvjgUZpZBgbbIMK0SrPUaVdROhSwXhdKu0k0bonuaxMR3eAlGA8NRtOEachTFuS9pmtiVlA05BNyCzFgCdMOdp1Zg7mkVq2Wh0mvXo6iLglXKur4BVjtCGnG51VwauuPuiuv+DFqG+UIrGJ/FfzaAJ/xeyGu8y4i3ly5bufoCiREWunvpi8Xijl9+1l/zs7AYxnyEShlhlV52q2fCNqFKCKT94SD93Fz+Dzx1ByNTqdlwNV6lZpRDUY0+gUUJMaOT81MKRZ+x3/7+X+w9cC1ZrhZOWtNaQ7Hs3hkg59zJO7a1kaS7J1/bHDmecn8pkuxnw8EvObdUMsDIQEivUu4a2HmdFCLt3gsMBsfNff2u1061Gf9cwF//xCYDZ5VbXQh5PWQncuneD7RuBMdpXW8b5LqCNxPBvf7gGtlFgB1KA8XcPVnwJSDIhGssaVXPHLaQGL+5/k1Y3NtJlrFq7TYslgE7ctxdV+qZ0E0EKlltukDbu1vab0eDzColpDXHLNN8ajv48doVWXJid4aa27UNO2IPpj0Sp4l+x+2oK+6sRZl9e0tFI0Roes9YeCW8OF02YslQWn+PWLubSuSXg/IAhrsbC/cWdGnOpp9Az0Xa5PRbNHpEk0dRHBUiBV8O8p7q5Ofz92z+fHjQy0seodyj96dv3n349A6JQUPqGNbkJ5RJlVwGmDY+GgquIPY4H9wFfHpx9PTi6OnF0dOLo6cXR08vjp5eHD29OHp6cfT04ujpxdHvfHHki+moQaOq4EIGnUTX/bhca/RGcXQcPjK6iqMcuyXHl9HtLcZ+n7FeicN/ramCdnkVR3OuBVb8XIvEXR7Jgnr1loj/h4++ffyMbXmvtJH+pkMgsT1ALHF1v2tYrr2QWl2t4qZNgKS5GW8cAfsXCKeDcKfbhX0Ot+IkxVj23rlhe+n87NNFFEfNHe+SHlRFmi+wUMgXjlrnsNxjHBy7jQouZzW1WCMHc+Vu/eT9tsg1tUX8H7irjfzo90vcNvC/uKmNC25vXcuFCvtuvvu0dYVnbDMbD+dqtVr9D8AVTyE=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,f={},b=[];function y(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,s.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,s.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,s.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"7",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"8",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"9",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"10",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": ""\n}\n'})}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",properties:{widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"},response:{type:"string",format:"string",example:"andrew bee"}}}}}}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.ea9e4a46.js b/assets/js/c195e1f1.ea9e4a46.js new file mode 100644 index 000000000..e9fd5cada --- /dev/null +++ b/assets/js/c195e1f1.ea9e4a46.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>f,default:()=>y,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztW19z2ziS/yo4vniioiXbSWZ3XdnUepLcjGtzY1fiXGrLcmlAsiUiJgEuAErWulS1D/sN7ule96PNJ9nqBkiCsmRbmezLnaemZiwS6G40+h9+Dd5Gls9MdHwZvVVpXYK0JrqKowxMqkVlhZLRcXSRA3ujgVtgzSg21apkFsqqwMcn56eMF4VaGLZUNbOKzUCCxlcSFixraLNkyb7UxrJKq7nIhJy1NCYiY0IaCzxjasrqqlCcBnAiMRUFfCckszmwqdIljkm4ge9fMKVZIiTXy2cM5qCXzIoSSA4JkKEwqROet4IM2YVna5Aa01DhiKxYstpARtwMS7lkCfjZmVtybUAzIS3oKU+BccsuB4O3kNQz9ul0MLj6Lre2MsejEa+qoapAGjGTBU/MMFXlKMOBVTZ9hkLXhtbfKfciUOdwLMfyL6omIZy2gGUw5XVh2ZwXNakBlc4WIpsB6paj6Ip0JDSTvITee1NXldKWwU0KlWUoGLe1hpgZy8sqZkIKK3hhYiZKPoPhWB4O2WAAJRfFYDCWv/zyy1jejiVj4wipj6NjNo7o9TiK3XMNPFOyWOK7KS8M+Ode9GDKn+CGl1UBqJhxNJYrz2Asj5ArMtjO1P21C88vCvpcniOXLyphF8IW97DCIRaH7MYvBdXn9wL5paqsuFxu5+YH7KhPp0lWzS0rbNbn+xL5Ztzes0R8uxvHw8P9g5f7RwdHL/vMvkdmFm5som628/MDdmNZLhnO6/P7HSk1h/T6XobNiF04Xo4jRRFw/2gcXXVM91GdbtjxYMAaH835HJiSgJ5dKg3M5lzSA+etNueWApLBiJQAM1BAinElWTaOTU7/e9ovrapMLeQ9e+ZH7KZEt6LDvhL/gBw1z4RiSW2tuocrjfoGLA8PyMfrMgF9j5fT+13YHfhHmCLqgjsyfdaDwbmGqSgK9tkFRtzF5lETK7kGBgW4pEVbh0+ENKBxy4S0KkgnLIEpbrmwTBhmcq4hYwthc8YpYQzZmSyWFOrbKZRVlGY5N6wCXQpjBMZuxXiW4dBy6KTVYColDTgxXSJASoFZmVzVRYZZrMCkhG/hRhiL+aWZ7qm9F8Zi7lxLCrSmRgu4IYcPO/ImP3a86CWXmYYFS6AXd492jkYtSTaODl6MDl+Ojg6OXoQ0n391EOhoX46jklOMR+sB9/ea14c78V9YxWBxkCsD0pdDod5pewyquuGLXi6k0zQObSqfYZsddvBBP2qLnpz430T6kNvWFTD/j882VD5sXwC93mw04r9/OPuwOPjzjzN1cnJy8vPHT/m7T7OTk5MSfw+HQ78qT/r7r46Vobaa7f4m+mp4bdfVWEZxpCosj4WSp1l0HPkS08cGjBzNcJFFcVRxzUuwoLFSv6WFRcdRUDlHcSSwUq+4zaP18l0lXyC1p1RWNyVmFEca/loLDVl0bHUNcWTsskCyRmAtEcUR3FSFyiA6drE2MmkOJY+ObyO7rGik1ULOopiiLbfhE1+RoEg/HSZ5epRXSbRaXTm2YOwPKlsiqVRJC9Lin7yqCpGSUkZfDIp+G/DsxL2MsHRFZVzFjShujagqjZq1AgwJinXbrhL/HJxYXOV3R6Unkrm0xgvWbg4zFaRiumyqeppKVTr+krAolu1ZojuInE6ZKoW1kMU9O/n17/9rPIkFZqYE3NGkVy1Eq7hVRrdKrjVfoklYKMPnW5Sk1WYddRo5SVNVW8mlRYZUvd+rVBoQEviiICz3kYoz4vu4flGA2QMHV7mSD4w+PHqO/z4/xPG+it5155vzGpL4opLJV5lPBnOc7xPs12/Lwwry6XdCS26Ko2BKolQBXIZzyJVXcVMy3U/fV9yJuolWq7hxprVgFUShyUdnipNm7audphGTqSoy0BgU75OM7B5kNlm3xW7J6xCGMIGn9rEK77dskYPNQdPjBZeWEfWuXsdwoJj3tyFDWKR/IhcGDze6hnFEjt2VaQp/9EQIxjIuMyYV2yN+E1OTQeyN/O9EZcu9bqYrTp3MAkOJF4EGt+HD9KLGcNyzAmTbOHLDbpPC+zp8UxurSkZs/CSKbi2QwHxsH7I3XDIh06L2tepUocIxMLLb28YEnHutVuz2FvcS9ARNfrWKuwfIq/eAAoF7oiEFMe/Nah9BN7F9FkyFm0ro5QQLTffAx4tQADGTQs4mtfZ0pMLBw54ZrglOtbzXAWStdYmZ3LDqNpLS/j5a+3eU7fcdify/0fur6vVPYoMor0bV61fV68/AclWB8zinnqmQmfP3BRTFkL0yVis5e72mglcj/3zzVmqYC1iQu9KudlTWddsSGnqZ/qLq0FOEYamuU8ELpFtplUJzZHTFwo1lxkJlGDd4rCS1TAXQGjTjMw10OCVZeG1zpcXfqHRqGL7iLNcw/ePemk73XmO4ZTloeDXir/3o0ymtkUAMLpeMFi6UNAhnEIw6rTUFx7TgWkx9nRazqgBugGEZx1NLwjuNNnJc5Fxem/hVol9fAC/ZWQUSJfj1H//EEU0kP5VnOgP9iFB+OmUGKBLvYRzbi5lqDtdToY31AdrFP28hTq4truNhz2I5ZO/agG/qxOAo2dDrAqrVYjYDPOL7ETQ5drsHPM1dqiCp+BRjPXKv0HhUbRrx0MDQ/AtAA3OQrd+oIfuhLfJiFmiH0IVw7cMNUR3R7wv1xpN+y5dhreEQlTs6JcQcgXI/i2V8aZAblZz4ghdpTdi082GGPoxZjcyxsf6wMmo5tfIdvsSQJ3lSwNnF+SN2GhfE9p0bu3Lb7YGjwc4uztkcOmMcsk+m3adm43lvCEtVBmwuuNv6mC1ykZLLLVmJZzyQtF8+aoeAzdBBTmyf3RUoE2ajRLErNDD+1iTaJsIsExpSWyzJgFRtEQAS/nBBMWC4qYJzSrhQ9WN85gFNcjarRUY7Xes2p4M2cdCoweaMrlMXFbJaN8ccb7QuiBnT6anRCg4K6McMpHHTOZtyY0HHrJbUU9F1hd7QkISbCrQAmcJGFQSh++H8idUatUSUq8sq0EZJDG9Kz7j00RPbJws85LMEcl64oT5MGJYASoXePdx4bvj1H/+MOrm2npPuCuY48CzTYMwDEhLi58wJcWcE/ZbMqr5ESA/0n9YbUCgdmeSkVFlrpubxFnSOSKU1bUz0cGULlZo6zTFltbHWhG0l6jOZGJeEBwvqVakK19sCKQ0uKbZ53wdAPaaBDITGoM+gRcll6D4dhKvWyNGBQBj3NCziN1oa9gMf3klsBZR82bbrkLbvUYLEyJOx87f/Sc1FV01sgGvxnBtEUTf9ztmH11ZNNJRCPi5nfnRJgzbRqtbta6tKbkXKGlJmyPxQp26rQi8u2XeNqtA75kLpZxvV5chNlExhIuSEurIPJ6Gf6TFhaJh9ErALABnK1myaS60OLkLZFjlI1tNJkClx0X3neBmjDkvQM5ikeOAmR4BH6HEwQGqDAdt3svggamrtkXjcS59EKd101FEiX5q3mGCX/9EuOuP8SS1QZ211hTWwo48qZSS5h4tCDimXUll3VsXjYtu0xoElF7Jj4ZoBtF+0Gl//pblSjh9qjvjE962pKYm8xWfo+rzl7jw0MHpeKHJxX+X61z2hTqfIPaeEQ1sYY/lLfGrjfEUtJGiCxyoNU9CYH0x73t74lo7MvDCKltaj2lh0Y/NrR+XGpCvXGnkYtvm34T73YU4tTBO30PauJLp2DcI2q3ugm0mI3dDhlQb38eRAElrV0cEB/q/vTm97zTBM/HWKNcS0Lorlf0Tx49Hh+1XaIOC76iT/Io7+dpPOj84boLXWxdfv7MPA6SYQbu2qBErSl+JxS/HXUmpd7Fu1j2vZbx2PyAb7LWQhJEyaDZxkKp00q19R6DSGz3Y2sXa76XzU3+sH2EfOIF9ssqLg7Cr3qHru2rj+pI5lAsbc5oINHmqVbRN1M6Qfn4RmCI3TTDLzb2aPoLXSu2rv3OUCA7auupU4wg9p8MXBwSTtlPhygxLlnBcio5tcF+oa5Dd0v63L7RYXsreOPYp6UxZdSIyEG0Tvo95qw+dukQbSWgu7pIbZzT6vxL57f3x5hW2oEmyusPVWKUMSY+fsOBr1Q93oNoh1qwjJ6nnThiMvbB3LcJkl6ubunS9eidH8cIgg/fqcjXfE7hkP9f6uU4zlMyFnD8276jT2EXfVbVxPb13Uq8SfAb3Bb0s4yvchc+BYmOJGoLF86Hp+75otb5tzm/ttbVfrsmlQhV2otgl1p7PUStV0j9rmUdAhChpEXc+n1/KhLk7QxAm7rk3TJey5+BZp21bp9U7I4LrGRhT1mxeu/boGxv82bLkPLT/hpf+H8NI1uNQZzybM7/BlD23zFhrCRk1fP4RReljGOpSxFVbYgip4Bu70jGa/dm717zcfF/GYtvGU5mcFFfl2N43CgrhX415hcBJyqsJQ1Cib8hBFxvUT4GcoUuXAUty7wSDYn3bWYNAGNGdjeLI5qzWr1AL0tC7IDKcF3Ag8vuI0KOld15MEXhZgTLGk28YzOk9lYiYsooIeH0t5xRNRCEy07k6as/YuV5sh+9x1Nfc0XYKGORSYn1sAQM66ALxQ+nqK3dGYcZbgHWWEpEDmXKYO/XJpglAcLh1iWmmBpYnVKLVwsilpNZp4ySWfkfPFoTGzDAqMRYZplSD0alRROxeyXBRKO+CZFkTXJkmJ7/BOigaGTzGGa8jRFOceYTSxQ3gNJQRcgsxYAnThnKdW4FHQKlbLQqXXrmVQFwWrlHUwPoIPoYw43WouDV05d1i334NWYR73BOMP1Z8M4A6/F/IarxbiZaLL1q4+Q2KEhe6a+GKxuJOXn/Xn/CjsT3XCPkCljLBKL7vZM2HzOqFcHhJpfzhKPzZ38YNM3dHIVGo23FRXqRnlUFSjj2DRQszo5PyUKsNn7Ne//w97D1xLlquFs9a01lAsu2v/qDm3805tbWHnrq3XNkeNp9zfUaT42Wjwc84tneCxMhDSu5S7lXVeJ4VIu+v7g8Fxc32+a30TVOJv7/vbmIj5c1a52YWQ10N2IpfuOn+bRvA5zestg1JX8AlDcM0+uNV1EXCH0kAxd18QeEQGMuH6PFrVM8ctFMYvrn8xFdd2kmWsWruciqhcJ467ekotDLoYQAjSpvusvaue/e4wyKxSQlpzzDLNp7ajH6/dWKUkdudRc9m1UUfsybRb4jzRr7h96rCWtSqzH28Jw0GGpvdVCa+EN6fLxiwZWutvMWt3cYjycnBax3J3I45uQZfmbPoR9FykzRF7i0ePaPAoiqNCpODRGZ+pTn48f8/mz4cHURzU7o9w7tH70zfvfv74DoXBQOoUdjg8GB7QnSllbMllwGnjNzzBjcCe5oOreU8fAD19APT0AdDTB0BPHwA9fQD09AHQ0wdATx8APX0A9PQB0G/8AMiD6ehBo6rgQgaNPdeMuFzru0ZxdBx+83MVRzk2L44vo9tbrP0+IV6Jj/9aE4J2eRVHc64FIn6Ejfm7HFmAV2+p+L/74Lu5z9iWz4c2yt90CCS2B0glDve7huXaB0urq1XctAlQNDfijRNg/wLpdBTuNJ+wz+FmnKRYy947Nuz2nJ99vIjiqLlyXdL3TZHmCwQK+cJJ6xKW+zYGn91GBZezmjqekaO5cpdw8n5b5JraIv4PXNVGffT7JW4Z+F9c1MYJt7eu5ULAvhvvXm2d4RXbjMbNuVqtVv8CY8gndg==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var r=n(74848),o=n(28453),s=n(33617),l=n.n(s),a=n(17543),d=n.n(a),c=n(86013),p=n.n(c),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const x={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW19z2ziS/yo4vniioiXbSWZ3XdnUepLcjGtzY1fiXGrLcmlAsiUiJgEuAErWulS1D/sN7ule96PNJ9nqBkiCsmRbmezLnaemZiwS6G40+h9+Dd5Gls9MdHwZvVVpXYK0JrqKowxMqkVlhZLRcXSRA3ujgVtgzSg21apkFsqqwMcn56eMF4VaGLZUNbOKzUCCxlcSFixraLNkyb7UxrJKq7nIhJy1NCYiY0IaCzxjasrqqlCcBnAiMRUFfCckszmwqdIljkm4ge9fMKVZIiTXy2cM5qCXzIoSSA4JkKEwqROet4IM2YVna5Aa01DhiKxYstpARtwMS7lkCfjZmVtybUAzIS3oKU+BccsuB4O3kNQz9ul0MLj6Lre2MsejEa+qoapAGjGTBU/MMFXlKMOBVTZ9hkLXhtbfKfciUOdwLMfyL6omIZy2gGUw5XVh2ZwXNakBlc4WIpsB6paj6Ip0JDSTvITee1NXldKWwU0KlWUoGLe1hpgZy8sqZkIKK3hhYiZKPoPhWB4O2WAAJRfFYDCWv/zyy1jejiVj4wipj6NjNo7o9TiK3XMNPFOyWOK7KS8M+Ode9GDKn+CGl1UBqJhxNJYrz2Asj5ArMtjO1P21C88vCvpcniOXLyphF8IW97DCIRaH7MYvBdXn9wL5paqsuFxu5+YH7KhPp0lWzS0rbNbn+xL5Ztzes0R8uxvHw8P9g5f7RwdHL/vMvkdmFm5som628/MDdmNZLhnO6/P7HSk1h/T6XobNiF04Xo4jRRFw/2gcXXVM91GdbtjxYMAaH835HJiSgJ5dKg3M5lzSA+etNueWApLBiJQAM1BAinElWTaOTU7/e9ovrapMLeQ9e+ZH7KZEt6LDvhL/gBw1z4RiSW2tuocrjfoGLA8PyMfrMgF9j5fT+13YHfhHmCLqgjsyfdaDwbmGqSgK9tkFRtzF5lETK7kGBgW4pEVbh0+ENKBxy4S0KkgnLIEpbrmwTBhmcq4hYwthc8YpYQzZmSyWFOrbKZRVlGY5N6wCXQpjBMZuxXiW4dBy6KTVYColDTgxXSJASoFZmVzVRYZZrMCkhG/hRhiL+aWZ7qm9F8Zi7lxLCrSmRgu4IYcPO/ImP3a86CWXmYYFS6AXd492jkYtSTaODl6MDl+Ojg6OXoQ0n391EOhoX46jklOMR+sB9/ea14c78V9YxWBxkCsD0pdDod5pewyquuGLXi6k0zQObSqfYZsddvBBP2qLnpz430T6kNvWFTD/j882VD5sXwC93mw04r9/OPuwOPjzjzN1cnJy8vPHT/m7T7OTk5MSfw+HQ78qT/r7r46Vobaa7f4m+mp4bdfVWEZxpCosj4WSp1l0HPkS08cGjBzNcJFFcVRxzUuwoLFSv6WFRcdRUDlHcSSwUq+4zaP18l0lXyC1p1RWNyVmFEca/loLDVl0bHUNcWTsskCyRmAtEcUR3FSFyiA6drE2MmkOJY+ObyO7rGik1ULOopiiLbfhE1+RoEg/HSZ5epRXSbRaXTm2YOwPKlsiqVRJC9Lin7yqCpGSUkZfDIp+G/DsxL2MsHRFZVzFjShujagqjZq1AgwJinXbrhL/HJxYXOV3R6Unkrm0xgvWbg4zFaRiumyqeppKVTr+krAolu1ZojuInE6ZKoW1kMU9O/n17/9rPIkFZqYE3NGkVy1Eq7hVRrdKrjVfoklYKMPnW5Sk1WYddRo5SVNVW8mlRYZUvd+rVBoQEviiICz3kYoz4vu4flGA2QMHV7mSD4w+PHqO/z4/xPG+it5155vzGpL4opLJV5lPBnOc7xPs12/Lwwry6XdCS26Ko2BKolQBXIZzyJVXcVMy3U/fV9yJuolWq7hxprVgFUShyUdnipNm7audphGTqSoy0BgU75OM7B5kNlm3xW7J6xCGMIGn9rEK77dskYPNQdPjBZeWEfWuXsdwoJj3tyFDWKR/IhcGDze6hnFEjt2VaQp/9EQIxjIuMyYV2yN+E1OTQeyN/O9EZcu9bqYrTp3MAkOJF4EGt+HD9KLGcNyzAmTbOHLDbpPC+zp8UxurSkZs/CSKbi2QwHxsH7I3XDIh06L2tepUocIxMLLb28YEnHutVuz2FvcS9ARNfrWKuwfIq/eAAoF7oiEFMe/Nah9BN7F9FkyFm0ro5QQLTffAx4tQADGTQs4mtfZ0pMLBw54ZrglOtbzXAWStdYmZ3LDqNpLS/j5a+3eU7fcdify/0fur6vVPYoMor0bV61fV68/AclWB8zinnqmQmfP3BRTFkL0yVis5e72mglcj/3zzVmqYC1iQu9KudlTWddsSGnqZ/qLq0FOEYamuU8ELpFtplUJzZHTFwo1lxkJlGDd4rCS1TAXQGjTjMw10OCVZeG1zpcXfqHRqGL7iLNcw/ePemk73XmO4ZTloeDXir/3o0ymtkUAMLpeMFi6UNAhnEIw6rTUFx7TgWkx9nRazqgBugGEZx1NLwjuNNnJc5Fxem/hVol9fAC/ZWQUSJfj1H//EEU0kP5VnOgP9iFB+OmUGKBLvYRzbi5lqDtdToY31AdrFP28hTq4truNhz2I5ZO/agG/qxOAo2dDrAqrVYjYDPOL7ETQ5drsHPM1dqiCp+BRjPXKv0HhUbRrx0MDQ/AtAA3OQrd+oIfuhLfJiFmiH0IVw7cMNUR3R7wv1xpN+y5dhreEQlTs6JcQcgXI/i2V8aZAblZz4ghdpTdi082GGPoxZjcyxsf6wMmo5tfIdvsSQJ3lSwNnF+SN2GhfE9p0bu3Lb7YGjwc4uztkcOmMcsk+m3adm43lvCEtVBmwuuNv6mC1ykZLLLVmJZzyQtF8+aoeAzdBBTmyf3RUoE2ajRLErNDD+1iTaJsIsExpSWyzJgFRtEQAS/nBBMWC4qYJzSrhQ9WN85gFNcjarRUY7Xes2p4M2cdCoweaMrlMXFbJaN8ccb7QuiBnT6anRCg4K6McMpHHTOZtyY0HHrJbUU9F1hd7QkISbCrQAmcJGFQSh++H8idUatUSUq8sq0EZJDG9Kz7j00RPbJws85LMEcl64oT5MGJYASoXePdx4bvj1H/+MOrm2npPuCuY48CzTYMwDEhLi58wJcWcE/ZbMqr5ESA/0n9YbUCgdmeSkVFlrpubxFnSOSKU1bUz0cGULlZo6zTFltbHWhG0l6jOZGJeEBwvqVakK19sCKQ0uKbZ53wdAPaaBDITGoM+gRcll6D4dhKvWyNGBQBj3NCziN1oa9gMf3klsBZR82bbrkLbvUYLEyJOx87f/Sc1FV01sgGvxnBtEUTf9ztmH11ZNNJRCPi5nfnRJgzbRqtbta6tKbkXKGlJmyPxQp26rQi8u2XeNqtA75kLpZxvV5chNlExhIuSEurIPJ6Gf6TFhaJh9ErALABnK1myaS60OLkLZFjlI1tNJkClx0X3neBmjDkvQM5ikeOAmR4BH6HEwQGqDAdt3svggamrtkXjcS59EKd101FEiX5q3mGCX/9EuOuP8SS1QZ211hTWwo48qZSS5h4tCDimXUll3VsXjYtu0xoElF7Jj4ZoBtF+0Gl//pblSjh9qjvjE962pKYm8xWfo+rzl7jw0MHpeKHJxX+X61z2hTqfIPaeEQ1sYY/lLfGrjfEUtJGiCxyoNU9CYH0x73t74lo7MvDCKltaj2lh0Y/NrR+XGpCvXGnkYtvm34T73YU4tTBO30PauJLp2DcI2q3ugm0mI3dDhlQb38eRAElrV0cEB/q/vTm97zTBM/HWKNcS0Lorlf0Tx49Hh+1XaIOC76iT/Io7+dpPOj84boLXWxdfv7MPA6SYQbu2qBErSl+JxS/HXUmpd7Fu1j2vZbx2PyAb7LWQhJEyaDZxkKp00q19R6DSGz3Y2sXa76XzU3+sH2EfOIF9ssqLg7Cr3qHru2rj+pI5lAsbc5oINHmqVbRN1M6Qfn4RmCI3TTDLzb2aPoLXSu2rv3OUCA7auupU4wg9p8MXBwSTtlPhygxLlnBcio5tcF+oa5Dd0v63L7RYXsreOPYp6UxZdSIyEG0Tvo95qw+dukQbSWgu7pIbZzT6vxL57f3x5hW2oEmyusPVWKUMSY+fsOBr1Q93oNoh1qwjJ6nnThiMvbB3LcJkl6ubunS9eidH8cIgg/fqcjXfE7hkP9f6uU4zlMyFnD8276jT2EXfVbVxPb13Uq8SfAb3Bb0s4yvchc+BYmOJGoLF86Hp+75otb5tzm/ttbVfrsmlQhV2otgl1p7PUStV0j9rmUdAhChpEXc+n1/KhLk7QxAm7rk3TJey5+BZp21bp9U7I4LrGRhT1mxeu/boGxv82bLkPLT/hpf+H8NI1uNQZzybM7/BlD23zFhrCRk1fP4RReljGOpSxFVbYgip4Bu70jGa/dm717zcfF/GYtvGU5mcFFfl2N43CgrhX415hcBJyqsJQ1Cib8hBFxvUT4GcoUuXAUty7wSDYn3bWYNAGNGdjeLI5qzWr1AL0tC7IDKcF3Ag8vuI0KOld15MEXhZgTLGk28YzOk9lYiYsooIeH0t5xRNRCEy07k6as/YuV5sh+9x1Nfc0XYKGORSYn1sAQM66ALxQ+nqK3dGYcZbgHWWEpEDmXKYO/XJpglAcLh1iWmmBpYnVKLVwsilpNZp4ySWfkfPFoTGzDAqMRYZplSD0alRROxeyXBRKO+CZFkTXJkmJ7/BOigaGTzGGa8jRFOceYTSxQ3gNJQRcgsxYAnThnKdW4FHQKlbLQqXXrmVQFwWrlHUwPoIPoYw43WouDV05d1i334NWYR73BOMP1Z8M4A6/F/IarxbiZaLL1q4+Q2KEhe6a+GKxuJOXn/Xn/CjsT3XCPkCljLBKL7vZM2HzOqFcHhJpfzhKPzZ38YNM3dHIVGo23FRXqRnlUFSjj2DRQszo5PyUKsNn7Ne//w97D1xLlquFs9a01lAsu2v/qDm3805tbWHnrq3XNkeNp9zfUaT42Wjwc84tneCxMhDSu5S7lXVeJ4VIu+v7g8Fxc32+a30TVOJv7/vbmIj5c1a52YWQ10N2IpfuOn+bRvA5zestg1JX8AlDcM0+uNV1EXCH0kAxd18QeEQGMuH6PFrVM8ctFMYvrn8xFdd2kmWsWruciqhcJ467ekotDLoYQAjSpvusvaue/e4wyKxSQlpzzDLNp7ajH6/dWKUkdudRc9m1UUfsybRb4jzRr7h96rCWtSqzH28Jw0GGpvdVCa+EN6fLxiwZWutvMWt3cYjycnBax3J3I45uQZfmbPoR9FykzRF7i0ePaPAoiqNCpODRGZ+pTn48f8/mz4cHURzU7o9w7tH70zfvfv74DoXBQOoUdjg8GB7QnSllbMllwGnjNzzBjcCe5oOreU8fAD19APT0AdDTB0BPHwA9fQD09AHQ0wdATx8APX0A9PQB0G/8AMiD6ehBo6rgQgaNPdeMuFzru0ZxdBx+83MVRzk2L44vo9tbrP0+IV6Jj/9aE4J2eRVHc64FIn6Ejfm7HFmAV2+p+L/74Lu5z9iWz4c2yt90CCS2B0glDve7huXaB0urq1XctAlQNDfijRNg/wLpdBTuNJ+wz+FmnKRYy947Nuz2nJ99vIjiqLlyXdL3TZHmCwQK+cJJ6xKW+zYGn91GBZezmjqekaO5cpdw8n5b5JraIv4PXNVGffT7JW4Z+F9c1MYJt7eu5ULAvhvvXm2d4RXbjMbNuVqtVv8CY8gndg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,g={},j=[];function b(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,r.jsx)(l(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,r.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,r.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,r.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,r.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"2",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"3",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"4",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"5",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"6",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"7",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,r.jsxs)(t.ol,{start:"8",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"9",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"10",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": ""\n}\n'})}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"2",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"3",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,r.jsxs)(t.ol,{start:"4",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,r.jsxs)(t.ol,{start:"5",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"6",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,r.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",properties:{widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"},response:{type:"string",format:"string",example:"andrew bee"}}}}}}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.9177040b.js b/assets/js/c4fbe420.9177040b.js new file mode 100644 index 000000000..e3558f0e2 --- /dev/null +++ b/assets/js/c4fbe420.9177040b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>u,metadata:()=>r,toc:()=>f});const r=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtyG7eSv4Kd2qrEPEOKpC62tS+r2Iojx5a0lhTHlnQUcAYkIc0AYwAjilax6jycP9infT2fli/Z6gYwF14k2ZJzlBTzEIuDW6PR3egLuq8DQwc62DwODlmaJdQwHZyGQcx0pHhmuBTBZnA4ZMQ3k5eK9g0XA7K1v0OYoL2EaZJrpjQxkkSKQaco10am/DO0EuNnDolm6hLGUk16Sc4yxYXRpC8VGTDBFMWJYxnlKYOGETdDkikWsz4XLCbaqDwyuWK6RY4yKYjOo4hp3c8TuzKXgsg+ocWaITFDhqAqZnIlNKEkF/xTzkijIXvnLDI7caNBvo+Z5gNBDYsBOD/8jMdPQjIa8mhIIipIj8FWY9ipA5hVwO1RaJMC19QZi3ifQ2c3WYtsxTEHGGmSjENCSaORq6TRIFyTTMlLHrPYryb7fUApRdQSLgxTfRoxxBWDWcQAl/GTEypi0qcRT7ipo5HEXBvFezms3DoRJ+KQZ5vkKEskjclY5orsv/yx7G4kgW/HjcZL1ssH5Gin0Tj9fmhMpjdXVmiWtWTGBGAroT3dimS6EkPHLO4jrphiMCvii1HNkzGhcUxGPB4wo/FABIlkNiaRlCrmwpJGRgeMiDztMaVD3E0qFSNcEEoUo/G4aWQz14y8PtjbBTSk1LTIfpLrsFgu5opFJhnb6QE9flff2dPZWAMa4mIQkpReAJa4IZ9yHl3AtjUTeLSOZBBXjcZ7gLfADteOxmNCzJBrMmK9oZQXhF1C84gnCTGKDwZMNRon4rfffjsR1yeCkJMAe5wEm+QkcFOcBKFtMuOM2ZaXey+O3m7vHp4dftjfLto9pU712XlZ9OjzZHqGo3dvimZB0+nm3a235QJCGte+nzCqGVHskrMRngMctd2rx0IxrCIn7OiiBQYxpeHrMXwh5Nr+U4fmYOfV7va7Kiy2B0spT2pdtt9u7byp9cmGUtSn2f9pb7c+T64qs+zsvrJIse0T+OfUwetOZMsd0OHO2+2Dw623+9B54s4RqOEgzzKp4PjfW4LehGM+ET+wRI4IVQypJ5JpKgXJqKIpMygbh9Rgs2Kfcq5YbIUbTRLPGZsnokkaDcDNZqNBjqyU4jETBuSIQta3JIcDWrY/kA703xExj4CVrFgYZwwkYa0rsBh0PXCiyXatMB7ILit+gKNG1EqDLAHBA10VA6lm+CWrT3wVkjFM/JIBHdlph1Lxz1IYmiARXTJleESTKtMDgCgqDVUosjLJhfFf3Qrkg2Nu4H1kaSeVALQYkJtygS2akUua5Ew7qEYhGQJU71immEYJ7eYFxIuYDBkfDBeuR+PzXJvaxCTXXu56KNxa/lQRvQzR1qeJZoT3a7hM6QWrrEZkZu+DFvlhTGLWp3liQsJBXhmVsxbZlYbQLEt4hHcp0IC9qHLFmnjKjnxadfLZt/cJ3CAxh7sEpBM04hRujIcO6NJeQLA9lLtmSAWRYuqgI5lINUtC+LmORxJJYZgwLbJ1SXmCwNvNasJFlOQxI72ERhchagIhUXD3wamMWZLIUWj5A7vgjYw4R/wQzRKgQikAfiHd8lyXd26LHAKjFPwHjR7VuAjXVaw6md+XsDKgwLMkQTkUIuJCci57xHCTsBAYPKNiHJLYKhnsyvTkVUiiIYsu8C9FYy5JLzdGCruxWMksliPhcNmXwmj+eQ5H+pYvx2g3JGsh2QjJs5B02iHpdEPSWQtJZyMknWch6bZD0u2GpLsWku6GBav7zOGaFgiuAtDpWiybPw92QU6/4Ro5GwSsLmT2qCazOy3SaBTcNH1dl3dy0aW43UBmQlvH/b6CH6vdp+7nGH5udJ+5nyPs2llzP4fws9up3itdhMTQNLsBCmh+UAi8cmGJCL65O/ok8PIMPoIgCn1DeXU7eKBhUt3LKuyFC244TfTi7fgej2hHJUgzm1qDTSG5Lt6R01kezXaq8KCKA2LSNqFYrTR5hkcoujO7X2+5m2Xx5u2yj2bvFXDut/UN2DqIpkMQTYv3X0ivR4SEaZjuh4mnLVQAUDIvxoPr8IiwUIfofjh4BjiAS2kxAqD1Ee2+Ao412PCGt23ttWZnvdltd9dqGADL2nZI02YcN8fj8UNgD3QetzyoPF5DtZodeDD6SqZzzA+0DspeTifCv73K/hYU9R4rnCjgNaj7YLy/oKplGxnT8XfaTuWHFsoZ9C9Vs3EFTGwCONB3Eg0ljxzw0MerZD0wCFuAgyZiciWOVyqYhI9x3EzT5tRH+NlExFc+pmkrjltTPWdOx35MSRyHZPbz3O9xTNI0XfDZfq99XknT2V200tTBhsrXc2ASp7Mt5hPX4Y9ilZIj6gvfyEbgd5IiwbXRnJvPR1OXzZB7N48jKjLVQbFBnlDFrsAu1dO+kwfkMc9ipWaPdqzzJDCvWJPv95z2/sSRP2yhPgF8uX3czM5gki3nDiaKDdgVyagxTAmc7JImPLZu26Z1bV7RNAMTYOXvJyfx3/5zBR0QYOMbAidBYj7g4EVc+fvxVvPj6ZweeZYxFYEPK2Gwkg4JM1GLHA9ZkpWOzNFo1Bqt6mgoZWK9mOdasb79/5nsnZ8huFmL6uzJvJ1a0qgY/EA60/a+ZqaGMaqJHznH5EcaQx7qtPG2dfbODdet6/GIbpwpkKDRek+sLzBIKSokQMqs/FuaIVMnwWkxxhr5LL5l7OkdmHXIY5bQHktmm+7MaMXnhI5l7vjbO7XqW3UUXcEbNKRcFH4L3E674qZM6dVU40npopzib4uQKnf6K8ezpz8BknDtPTd1dFZHO9cWOigFs8GNHiN+AOkVVHpvLigAuxsbWEnkzu6WJaAfwY6FW9GvdssKtYOpIgbmSLngaZ4W/tF+MatHWep0jyq+YCTEbfwK1dOdWYFe3bKCCzwtWOBEdNCP4f0fN2imrscjkhVTIN3Mxl8jRWr39ANdsLczoN9WlQHnXMvQ1V7IBfPpxdzXIntwvYFP1g4CL1sUscyAR+6+rFmAfOcbCn1WVT/cYsqr9npE1DcHrG9Mga7fQ98+X0Wk1d3/iQi1BvadidU6JVM6uMFyx+ZHRJ4OnhknRAedkfa+uMEhh+03b6fTrm1nvb6djfZXWFe1Ze9vXLWLj6VVtQ2PIcjMQmCX5wl9UFHv5gTSfCHTLDdVXkCTH/ndX94+rGbDhH8LSTMkjZCshOT7kDxpkXcMA3FREbRzdzlXNjTH4aFBDjGTKFfJmPQUjeBtBGsNWuT6+lNOheFmPJmQBrm+htcnk0kLmONCyJGN2x1fcs0NgVcYpa0Ty0jPebUhI70CRtHKLhs1X7rY/ooD7Qn5Xk5x6o2WpUPBl5qSi4Z9Y/sKQkT7ivXhuUYZyCf+kz8eCIyyhKUueOxC+KAwYjiJCyMBBf5xSKPRY30JoSR4VwIBySEtQ/1WY7PCsfo2xT4okYoMqbaWLJrOsD14OGOGLHVBrV1pmI1o60wKzawwz+YAXUakG42piJjvVkbFuPAbB3HSeTj3Tfd5uypfOhvrNXG5Xhcw7UUC5gbvDYgRiwvv8mZlU4XzVfHYZi7bT/O9nxSQbcWNJzJLfTJPYpLwCwxuxlxnCR0DWfjL0kE5HTV/MZRSlz1c4Nrxmd6sB8Slgpj4k1YRH7yv37nzdLUm7Z89gDNtyr1cP4z22kpnfeVG//KUV/TL5TUhdzk5dNze6eSwZ3l0Sz/w1/qBH4bwVx/SDdZ52q1pb6vt+zPAA3m7qoxzi5/rIbxZD+ZWqrLbHR1Kf5hj5/7Ut/YtTNwpMfy08wBieIEle19KnDFYH4z2yENZq/MI8A7m6o026r0JtArsNyfS9YcxbTvtmq72vKaqPe9WiXJ9/U5EWV10irJOAv7LD3vvRu2fXw3k1tbW1u7B0XD7aLC1tZXC71arNderMe+0cRnQYd0Db3cv4x2/YJVWqwUojKmhmzh8JROD/7Ljw8VjWu45yDdyta4/RHRzjkf1/lKg6PrHXDTz3Kffjs/vy4FBGMgMc1ek2ImDzSCGDBmflxGE6AFh2vwg43GweR24Z5zwp3skCSNXzjXk2lwHOhqylMJf3oKD7Bx43h+E/lV9EAb4rgdSdYDogk2XIRCEEHPOwDHINMyB4zavfS+b/BCETgsPNgNL9EEYuMhr8YkwEUl4S5HF/WDiF7xpquJLOZXGP4okFZgHXoh/5TQ4dDKVnfRVM1VnmJRoLSejStFxMJ0I5Z+G+7i+HVe8fU3G/m7gBjwRxXtl7BaEATcsra6y4NCU/HJMR0zCTvDN35eOxWOh6RevCeMwCeNrBrpnWV8z9Fz2zr6KHGGwc3/MOes7no5tnV24Tipb8NiZxV4Zbpav9kOCL2dbt1Gq749YpoPqmtZpNrPm4aJsjsojcj1EC5hmGaOqhUkVX53thQl/NIlyTEArpHFtZwWoxc46kzC4un0zVySSTZ8qQr5PWN/Ypx0kkkow9aT6XuzRbK67tjYJg/Ht2xv/Kbf3FA5vdPvu3mOOTZl/9O+AdfXZJAyGt8P6U5EF9G8Edm1jUt6xLhmtSELtyXh85uXW5LaO/jKDfpDRuCP2VMxUBRE9KRNGxQwmdvrWny7Jd2DofBfaB1WYvMGV9heZTXJULGKQCIbvLL2sIk7XsZkdxD2oB1/8NnxA7UznPQ29hJ9P2wl7zCdOQqav7cFtpiz6zxmNhpCi6Z550b537mWQqyhz7cEDNzrcLgkD57YNr0ATF4O6MVbBDjrrq3tvVU8HvsDlitnOe4f7d8AlWopNm69n9QO7SzsH2Tvch5Q43nfqX4sc6QITHrW01oWAOkYuOfVpM4VsH9tHKMy6O6VP2CwjDC2XjNYkswDFXM+FKITUGZuvU2R3z0xcZtzCEcncQMTCpTgTbVima3hEKApEHsr8LlR5CyYpGeT45tcAy/r8OHz2V6a0cWFTx9HMiHPls/gcWUBPyCMv8eSxAp0q84eECW2HU9Kn2jAVQj45YF7lYFQUU7KrjCkOwb65KFDMou4sV3P1tToO6vlhR+/euDxrvwfPlD3gQDsxi0meIdUgJxR5i/7kprc+oygBdzB1tkgxnFU9MITpPCAZUxpy8RWRakAF/+xy80EjASOrx4Y0sV2dqABPOcADHF4Hxsva3//5rwpcCzXdWcDsCjSO4VHqLRCiJWkJHjR9xTKQgLIOEczH1H9PXwIAHTLNWSrjgpH03Wl8H5+x6kIuughgEYHUeTQEw6KQtzr0MlY7tVKjaYr2K4YQM9gvu+LaVDLv/Pv4WfnwjgEeowoMqIYAVwPNi3GVwcvIqJyaDvMDeT1rs7gGZ3iB5kaeKZZycbd7quqMM7IQBLmRKTU8In4q3arn4tqIj+frFIo+WNCAGi+5VE8WsCpMdyZFxM64OGOXTN1Bwdst3vPFdAzEbUaMiSpsHkn2OivzJUdQcKCGk8rthFnBNWJcD4HuUqYG7CwCMwUJj90Bj40GzNZokKaFxYlVnSvnUXGp7Cg/QJSUswNELum0yLYo79xqPYkW+UmOAGchyWxpATDj7fyAUoKQx7ZQR3WFiArIOkVnDqSawsRFdC2lvCzK4ALceF64mx1rhUfWoQOzQOo1rBPetCcvQos0Egrp0351yxF2c+BWITSRyFJmWMrhuA7UDmbODvEKwiMED7Bdx6ezy5Fg6vd//J/GOL59HqJbsIWFrRjhp4mWNi23OqunaE/z1j81Q9LuycA8Y/dmj4cXIGVJFJb24PUXvntAjQpvGlk6PerW8zczv2+ypV04fmlJ/4lMzU67/Ve2pFfbfx5Leq39J7KknwGwzmd/uzRZpN3OlR0+BnHzgHPJrH8zkermnuDbn4RFxGQegkt26E7sf6Xx74X4LQ4B6zEogwnOmPWbQTR02234Z0oI+tJSvuBRWW0rGf9HEN49knHzGfjiRjcj64dh9yediTQaAs4WWE1l95tJrBqhWWHj18Peq4jv8dc7R593Ort8R++Id+vRi52NnYvs119evH7eYuPXnaj7y/jX7i/mw/tE75xLHv30evhR/KJ7L9bzD79+VB9+3VEf3r8z9P36Vk8MRe/Vjzwar5/3um3+5sXr9sf3nVHv1Y/tj788zz7i5D+2P15ctKN090VPbEGf7MOv/8P3zrdX337e/vz2cPvq7efkeYvufjp/cRU9f3uxvdH8uKOab/d6P59/Mtm79Xh191e+8Yy9Ze/FYftNVKMGLhIu2Jk/6jPc9xkctqWktXnHfiBTZlWWEVa0UhLKZTndzagxoQNQvgB16gGpgCl1G798GWQ3IWKt3T7rFEhYn0XCjsBELqwcdygvmPhjd1pd3tjlAdSrNCmFVsBtJ2wPaputfreb1CzKFTfjYPP4Orhq0ow3bfvm8enkFMwHM5QQvMykRoipGQabwcp0LBMK+GGk7Pja8mDBaJqKGN7kzDAbzfjKZafVCSbh9Ji5zHlDf5Y3v3SINnTAxeC2caclig7gGO1J1RBVKqwZ/5mBxurOodorDDiQz5BRMGUB80Ad78oI8LY/Yx+bnRduLc9yOoDq46e1kOj0PTwnyFmJcR77ACPGDIuQYVBuKCjCekFQCdTBj0roDX4W2vxxSc1F3Mor2x3UUrtra6jOPe2g3rP6DFWKtY3JqUV+xVGNaQJVb6t9aVRzG7pPdTdaEEy5rWq+o2nX0UI3zgIvjltyyltRADLPSQDG+Vzb3I2q2GFzUOlVjzoi4aEOIHK1jYhcayMin7VrWo/bfjlDqbugglLoJ6iEVHUQUDROgXC56EukenfcexkTB+AABqGEXDOjq7IkkmlR8KnR8EN+/+e/ilGNRmEi06Ii5V6uSCZHTEElT6xkmbArDs4QrDKaYptGox4f/dM0YVpDvF0YNrBlOCExHLzOzq8Z0Yz2oBomeE3xoT4+060Ibt0i74cM8zfGMv9O2WyGS5aAsC7cSdVKmiOpLvqJHEGBStKDLA9wKDIxpCKyvksrQtAHB7Yx+IUzxTXUuFMANbewSWEUjQxJqaADdKKFpIqsmCUc5CxRsgeufS2T3DqvDeWJVPZRJW4IX70gErevMmhChRuYVrEhEPal82Dr0EYQrHRwNTZ7EKzJABYOjgUjSS4SCeUwIeiTJwnJpLGBGNDrqzDCcKOo0KCMW1j8GRQIc85lpp2L5kgzOOE3XFzYIlxNclzQ1XvW09yweor+NHM+qY95xc1PeQ9K/EnNjVTjcvSAm2HeQzlfnaT4YWd65cu4VqT43RNnDpgBCtErW/s7qCY8Ib//43/JG0aVIEM5stQa5Yol47JiLBY3xZO3aCtueQxf0BwqpBokUjHwETVdVCOlBv1Bu2wEjjfLUvYl037eS3hUlOrVjcYmeWEL8hY1eOspxTY9BWJKlGR2dMLFRYtsibGtPFu4t+A7jqttAyNCCyrglnVvDyurs1Sz5JLpin8P6tlipE7JfGBXqwLjNlfP1oG9bcXxTPIL+HhLcKxXCkNk1LqnoGbsnHyZWjJMvVodEzHWpdSbBLWhcv5wKoUHo2Yzn3z2T1mS2E5TKYsMmHQ7Lr5az92UBlKXt+gRhAV1rSAxzbgjp2NPlqRe++LLydpatMLQCNVff4PSjM+NgkBVTr3XP4Byz5E3xxZw9Ap2XgnCIOERc+a1u7+2Xu2/IZerrXYQVvS6OzD3ypudF9u7B9sADAhSi7BOq91qoxdQapNSUVkJy1oXhDp9tVVe7S2rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYT9q7C6rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYT8WWbGshv1Yigwvq2H/ERS4rIa9rIa9rIa9rIa9rIa9rIa9rIa9rIa9rIa9rIb9F/UDL6thL6thL6thL6thL6thL6thL6thL6th/5WrYVeyV1eyhHJRKdhg88qPp2pkn4bBEPLON4+D62sgvCOVTCbw+VOOebTHp2FwSRWHF5SYsh76FGtIl71gkGr7wj4IbR7C8qE9Z0xRmsrUhxxxO2ILt35j32pq/P7ewWEQBj1XxzuVMRbxoCNIr6Ujm35cycHFb9dBQsUgx/zdwM45sSXPhvWU8gtMKXd/VJKAIfW6hLCea263Af+HTc0dcH1t09Unk6K/bVo4wiHW94bjO51MJv8Py2yHZA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var i=t(74848),s=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),x=t.n(h),m=(t(18766),t(79329),t(9303));const u={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:"eJztPNtyG7eSv4Kd2qrEPEOKpC62tS+r2Iojx5a0lhTHlnQUcAYkIc0AYwAjilax6jycP9infT2fli/Z6gYwF14k2ZJzlBTzEIuDW6PR3egLuq8DQwc62DwODlmaJdQwHZyGQcx0pHhmuBTBZnA4ZMQ3k5eK9g0XA7K1v0OYoL2EaZJrpjQxkkSKQaco10am/DO0EuNnDolm6hLGUk16Sc4yxYXRpC8VGTDBFMWJYxnlKYOGETdDkikWsz4XLCbaqDwyuWK6RY4yKYjOo4hp3c8TuzKXgsg+ocWaITFDhqAqZnIlNKEkF/xTzkijIXvnLDI7caNBvo+Z5gNBDYsBOD/8jMdPQjIa8mhIIipIj8FWY9ipA5hVwO1RaJMC19QZi3ifQ2c3WYtsxTEHGGmSjENCSaORq6TRIFyTTMlLHrPYryb7fUApRdQSLgxTfRoxxBWDWcQAl/GTEypi0qcRT7ipo5HEXBvFezms3DoRJ+KQZ5vkKEskjclY5orsv/yx7G4kgW/HjcZL1ssH5Gin0Tj9fmhMpjdXVmiWtWTGBGAroT3dimS6EkPHLO4jrphiMCvii1HNkzGhcUxGPB4wo/FABIlkNiaRlCrmwpJGRgeMiDztMaVD3E0qFSNcEEoUo/G4aWQz14y8PtjbBTSk1LTIfpLrsFgu5opFJhnb6QE9flff2dPZWAMa4mIQkpReAJa4IZ9yHl3AtjUTeLSOZBBXjcZ7gLfADteOxmNCzJBrMmK9oZQXhF1C84gnCTGKDwZMNRon4rfffjsR1yeCkJMAe5wEm+QkcFOcBKFtMuOM2ZaXey+O3m7vHp4dftjfLto9pU712XlZ9OjzZHqGo3dvimZB0+nm3a235QJCGte+nzCqGVHskrMRngMctd2rx0IxrCIn7OiiBQYxpeHrMXwh5Nr+U4fmYOfV7va7Kiy2B0spT2pdtt9u7byp9cmGUtSn2f9pb7c+T64qs+zsvrJIse0T+OfUwetOZMsd0OHO2+2Dw623+9B54s4RqOEgzzKp4PjfW4LehGM+ET+wRI4IVQypJ5JpKgXJqKIpMygbh9Rgs2Kfcq5YbIUbTRLPGZsnokkaDcDNZqNBjqyU4jETBuSIQta3JIcDWrY/kA703xExj4CVrFgYZwwkYa0rsBh0PXCiyXatMB7ILit+gKNG1EqDLAHBA10VA6lm+CWrT3wVkjFM/JIBHdlph1Lxz1IYmiARXTJleESTKtMDgCgqDVUosjLJhfFf3Qrkg2Nu4H1kaSeVALQYkJtygS2akUua5Ew7qEYhGQJU71immEYJ7eYFxIuYDBkfDBeuR+PzXJvaxCTXXu56KNxa/lQRvQzR1qeJZoT3a7hM6QWrrEZkZu+DFvlhTGLWp3liQsJBXhmVsxbZlYbQLEt4hHcp0IC9qHLFmnjKjnxadfLZt/cJ3CAxh7sEpBM04hRujIcO6NJeQLA9lLtmSAWRYuqgI5lINUtC+LmORxJJYZgwLbJ1SXmCwNvNasJFlOQxI72ERhchagIhUXD3wamMWZLIUWj5A7vgjYw4R/wQzRKgQikAfiHd8lyXd26LHAKjFPwHjR7VuAjXVaw6md+XsDKgwLMkQTkUIuJCci57xHCTsBAYPKNiHJLYKhnsyvTkVUiiIYsu8C9FYy5JLzdGCruxWMksliPhcNmXwmj+eQ5H+pYvx2g3JGsh2QjJs5B02iHpdEPSWQtJZyMknWch6bZD0u2GpLsWku6GBav7zOGaFgiuAtDpWiybPw92QU6/4Ro5GwSsLmT2qCazOy3SaBTcNH1dl3dy0aW43UBmQlvH/b6CH6vdp+7nGH5udJ+5nyPs2llzP4fws9up3itdhMTQNLsBCmh+UAi8cmGJCL65O/ok8PIMPoIgCn1DeXU7eKBhUt3LKuyFC244TfTi7fgej2hHJUgzm1qDTSG5Lt6R01kezXaq8KCKA2LSNqFYrTR5hkcoujO7X2+5m2Xx5u2yj2bvFXDut/UN2DqIpkMQTYv3X0ivR4SEaZjuh4mnLVQAUDIvxoPr8IiwUIfofjh4BjiAS2kxAqD1Ee2+Ao412PCGt23ttWZnvdltd9dqGADL2nZI02YcN8fj8UNgD3QetzyoPF5DtZodeDD6SqZzzA+0DspeTifCv73K/hYU9R4rnCjgNaj7YLy/oKplGxnT8XfaTuWHFsoZ9C9Vs3EFTGwCONB3Eg0ljxzw0MerZD0wCFuAgyZiciWOVyqYhI9x3EzT5tRH+NlExFc+pmkrjltTPWdOx35MSRyHZPbz3O9xTNI0XfDZfq99XknT2V200tTBhsrXc2ASp7Mt5hPX4Y9ilZIj6gvfyEbgd5IiwbXRnJvPR1OXzZB7N48jKjLVQbFBnlDFrsAu1dO+kwfkMc9ipWaPdqzzJDCvWJPv95z2/sSRP2yhPgF8uX3czM5gki3nDiaKDdgVyagxTAmc7JImPLZu26Z1bV7RNAMTYOXvJyfx3/5zBR0QYOMbAidBYj7g4EVc+fvxVvPj6ZweeZYxFYEPK2Gwkg4JM1GLHA9ZkpWOzNFo1Bqt6mgoZWK9mOdasb79/5nsnZ8huFmL6uzJvJ1a0qgY/EA60/a+ZqaGMaqJHznH5EcaQx7qtPG2dfbODdet6/GIbpwpkKDRek+sLzBIKSokQMqs/FuaIVMnwWkxxhr5LL5l7OkdmHXIY5bQHktmm+7MaMXnhI5l7vjbO7XqW3UUXcEbNKRcFH4L3E674qZM6dVU40npopzib4uQKnf6K8ezpz8BknDtPTd1dFZHO9cWOigFs8GNHiN+AOkVVHpvLigAuxsbWEnkzu6WJaAfwY6FW9GvdssKtYOpIgbmSLngaZ4W/tF+MatHWep0jyq+YCTEbfwK1dOdWYFe3bKCCzwtWOBEdNCP4f0fN2imrscjkhVTIN3Mxl8jRWr39ANdsLczoN9WlQHnXMvQ1V7IBfPpxdzXIntwvYFP1g4CL1sUscyAR+6+rFmAfOcbCn1WVT/cYsqr9npE1DcHrG9Mga7fQ98+X0Wk1d3/iQi1BvadidU6JVM6uMFyx+ZHRJ4OnhknRAedkfa+uMEhh+03b6fTrm1nvb6djfZXWFe1Ze9vXLWLj6VVtQ2PIcjMQmCX5wl9UFHv5gTSfCHTLDdVXkCTH/ndX94+rGbDhH8LSTMkjZCshOT7kDxpkXcMA3FREbRzdzlXNjTH4aFBDjGTKFfJmPQUjeBtBGsNWuT6+lNOheFmPJmQBrm+htcnk0kLmONCyJGN2x1fcs0NgVcYpa0Ty0jPebUhI70CRtHKLhs1X7rY/ooD7Qn5Xk5x6o2WpUPBl5qSi4Z9Y/sKQkT7ivXhuUYZyCf+kz8eCIyyhKUueOxC+KAwYjiJCyMBBf5xSKPRY30JoSR4VwIBySEtQ/1WY7PCsfo2xT4okYoMqbaWLJrOsD14OGOGLHVBrV1pmI1o60wKzawwz+YAXUakG42piJjvVkbFuPAbB3HSeTj3Tfd5uypfOhvrNXG5Xhcw7UUC5gbvDYgRiwvv8mZlU4XzVfHYZi7bT/O9nxSQbcWNJzJLfTJPYpLwCwxuxlxnCR0DWfjL0kE5HTV/MZRSlz1c4Nrxmd6sB8Slgpj4k1YRH7yv37nzdLUm7Z89gDNtyr1cP4z22kpnfeVG//KUV/TL5TUhdzk5dNze6eSwZ3l0Sz/w1/qBH4bwVx/SDdZ52q1pb6vt+zPAA3m7qoxzi5/rIbxZD+ZWqrLbHR1Kf5hj5/7Ut/YtTNwpMfy08wBieIEle19KnDFYH4z2yENZq/MI8A7m6o026r0JtArsNyfS9YcxbTvtmq72vKaqPe9WiXJ9/U5EWV10irJOAv7LD3vvRu2fXw3k1tbW1u7B0XD7aLC1tZXC71arNderMe+0cRnQYd0Db3cv4x2/YJVWqwUojKmhmzh8JROD/7Ljw8VjWu45yDdyta4/RHRzjkf1/lKg6PrHXDTz3Kffjs/vy4FBGMgMc1ek2ImDzSCGDBmflxGE6AFh2vwg43GweR24Z5zwp3skCSNXzjXk2lwHOhqylMJf3oKD7Bx43h+E/lV9EAb4rgdSdYDogk2XIRCEEHPOwDHINMyB4zavfS+b/BCETgsPNgNL9EEYuMhr8YkwEUl4S5HF/WDiF7xpquJLOZXGP4okFZgHXoh/5TQ4dDKVnfRVM1VnmJRoLSejStFxMJ0I5Z+G+7i+HVe8fU3G/m7gBjwRxXtl7BaEATcsra6y4NCU/HJMR0zCTvDN35eOxWOh6RevCeMwCeNrBrpnWV8z9Fz2zr6KHGGwc3/MOes7no5tnV24Tipb8NiZxV4Zbpav9kOCL2dbt1Gq749YpoPqmtZpNrPm4aJsjsojcj1EC5hmGaOqhUkVX53thQl/NIlyTEArpHFtZwWoxc46kzC4un0zVySSTZ8qQr5PWN/Ypx0kkkow9aT6XuzRbK67tjYJg/Ht2xv/Kbf3FA5vdPvu3mOOTZl/9O+AdfXZJAyGt8P6U5EF9G8Edm1jUt6xLhmtSELtyXh85uXW5LaO/jKDfpDRuCP2VMxUBRE9KRNGxQwmdvrWny7Jd2DofBfaB1WYvMGV9heZTXJULGKQCIbvLL2sIk7XsZkdxD2oB1/8NnxA7UznPQ29hJ9P2wl7zCdOQqav7cFtpiz6zxmNhpCi6Z550b537mWQqyhz7cEDNzrcLgkD57YNr0ATF4O6MVbBDjrrq3tvVU8HvsDlitnOe4f7d8AlWopNm69n9QO7SzsH2Tvch5Q43nfqX4sc6QITHrW01oWAOkYuOfVpM4VsH9tHKMy6O6VP2CwjDC2XjNYkswDFXM+FKITUGZuvU2R3z0xcZtzCEcncQMTCpTgTbVima3hEKApEHsr8LlR5CyYpGeT45tcAy/r8OHz2V6a0cWFTx9HMiHPls/gcWUBPyCMv8eSxAp0q84eECW2HU9Kn2jAVQj45YF7lYFQUU7KrjCkOwb65KFDMou4sV3P1tToO6vlhR+/euDxrvwfPlD3gQDsxi0meIdUgJxR5i/7kprc+oygBdzB1tkgxnFU9MITpPCAZUxpy8RWRakAF/+xy80EjASOrx4Y0sV2dqABPOcADHF4Hxsva3//5rwpcCzXdWcDsCjSO4VHqLRCiJWkJHjR9xTKQgLIOEczH1H9PXwIAHTLNWSrjgpH03Wl8H5+x6kIuughgEYHUeTQEw6KQtzr0MlY7tVKjaYr2K4YQM9gvu+LaVDLv/Pv4WfnwjgEeowoMqIYAVwPNi3GVwcvIqJyaDvMDeT1rs7gGZ3iB5kaeKZZycbd7quqMM7IQBLmRKTU8In4q3arn4tqIj+frFIo+WNCAGi+5VE8WsCpMdyZFxM64OGOXTN1Bwdst3vPFdAzEbUaMiSpsHkn2OivzJUdQcKCGk8rthFnBNWJcD4HuUqYG7CwCMwUJj90Bj40GzNZokKaFxYlVnSvnUXGp7Cg/QJSUswNELum0yLYo79xqPYkW+UmOAGchyWxpATDj7fyAUoKQx7ZQR3WFiArIOkVnDqSawsRFdC2lvCzK4ALceF64mx1rhUfWoQOzQOo1rBPetCcvQos0Egrp0351yxF2c+BWITSRyFJmWMrhuA7UDmbODvEKwiMED7Bdx6ezy5Fg6vd//J/GOL59HqJbsIWFrRjhp4mWNi23OqunaE/z1j81Q9LuycA8Y/dmj4cXIGVJFJb24PUXvntAjQpvGlk6PerW8zczv2+ypV04fmlJ/4lMzU67/Ve2pFfbfx5Leq39J7KknwGwzmd/uzRZpN3OlR0+BnHzgHPJrH8zkermnuDbn4RFxGQegkt26E7sf6Xx74X4LQ4B6zEogwnOmPWbQTR02234Z0oI+tJSvuBRWW0rGf9HEN49knHzGfjiRjcj64dh9yediTQaAs4WWE1l95tJrBqhWWHj18Peq4jv8dc7R593Ort8R++Id+vRi52NnYvs119evH7eYuPXnaj7y/jX7i/mw/tE75xLHv30evhR/KJ7L9bzD79+VB9+3VEf3r8z9P36Vk8MRe/Vjzwar5/3um3+5sXr9sf3nVHv1Y/tj788zz7i5D+2P15ctKN090VPbEGf7MOv/8P3zrdX337e/vz2cPvq7efkeYvufjp/cRU9f3uxvdH8uKOab/d6P59/Mtm79Xh191e+8Yy9Ze/FYftNVKMGLhIu2Jk/6jPc9xkctqWktXnHfiBTZlWWEVa0UhLKZTndzagxoQNQvgB16gGpgCl1G798GWQ3IWKt3T7rFEhYn0XCjsBELqwcdygvmPhjd1pd3tjlAdSrNCmFVsBtJ2wPaputfreb1CzKFTfjYPP4Orhq0ow3bfvm8enkFMwHM5QQvMykRoipGQabwcp0LBMK+GGk7Pja8mDBaJqKGN7kzDAbzfjKZafVCSbh9Ji5zHlDf5Y3v3SINnTAxeC2caclig7gGO1J1RBVKqwZ/5mBxurOodorDDiQz5BRMGUB80Ad78oI8LY/Yx+bnRduLc9yOoDq46e1kOj0PTwnyFmJcR77ACPGDIuQYVBuKCjCekFQCdTBj0roDX4W2vxxSc1F3Mor2x3UUrtra6jOPe2g3rP6DFWKtY3JqUV+xVGNaQJVb6t9aVRzG7pPdTdaEEy5rWq+o2nX0UI3zgIvjltyyltRADLPSQDG+Vzb3I2q2GFzUOlVjzoi4aEOIHK1jYhcayMin7VrWo/bfjlDqbugglLoJ6iEVHUQUDROgXC56EukenfcexkTB+AABqGEXDOjq7IkkmlR8KnR8EN+/+e/ilGNRmEi06Ii5V6uSCZHTEElT6xkmbArDs4QrDKaYptGox4f/dM0YVpDvF0YNrBlOCExHLzOzq8Z0Yz2oBomeE3xoT4+060Ibt0i74cM8zfGMv9O2WyGS5aAsC7cSdVKmiOpLvqJHEGBStKDLA9wKDIxpCKyvksrQtAHB7Yx+IUzxTXUuFMANbewSWEUjQxJqaADdKKFpIqsmCUc5CxRsgeufS2T3DqvDeWJVPZRJW4IX70gErevMmhChRuYVrEhEPal82Dr0EYQrHRwNTZ7EKzJABYOjgUjSS4SCeUwIeiTJwnJpLGBGNDrqzDCcKOo0KCMW1j8GRQIc85lpp2L5kgzOOE3XFzYIlxNclzQ1XvW09yweor+NHM+qY95xc1PeQ9K/EnNjVTjcvSAm2HeQzlfnaT4YWd65cu4VqT43RNnDpgBCtErW/s7qCY8Ib//43/JG0aVIEM5stQa5Yol47JiLBY3xZO3aCtueQxf0BwqpBokUjHwETVdVCOlBv1Bu2wEjjfLUvYl037eS3hUlOrVjcYmeWEL8hY1eOspxTY9BWJKlGR2dMLFRYtsibGtPFu4t+A7jqttAyNCCyrglnVvDyurs1Sz5JLpin8P6tlipE7JfGBXqwLjNlfP1oG9bcXxTPIL+HhLcKxXCkNk1LqnoGbsnHyZWjJMvVodEzHWpdSbBLWhcv5wKoUHo2Yzn3z2T1mS2E5TKYsMmHQ7Lr5az92UBlKXt+gRhAV1rSAxzbgjp2NPlqRe++LLydpatMLQCNVff4PSjM+NgkBVTr3XP4Byz5E3xxZw9Ap2XgnCIOERc+a1u7+2Xu2/IZerrXYQVvS6OzD3ypudF9u7B9sADAhSi7BOq91qoxdQapNSUVkJy1oXhDp9tVVe7S2rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYT9q7C6rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYS+rYT8WWbGshv1Yigwvq2H/ERS4rIa9rIa9rIa9rIa9rIa9rIa9rIa9rIa9rIa9rIb9F/UDL6thL6thL6thL6thL6thL6thL6thL6th/5WrYVeyV1eyhHJRKdhg88qPp2pkn4bBEPLON4+D62sgvCOVTCbw+VOOebTHp2FwSRWHF5SYsh76FGtIl71gkGr7wj4IbR7C8qE9Z0xRmsrUhxxxO2ILt35j32pq/P7ewWEQBj1XxzuVMRbxoCNIr6Ujm35cycHFb9dBQsUgx/zdwM45sSXPhvWU8gtMKXd/VJKAIfW6hLCea263Af+HTc0dcH1t09Unk6K/bVo4wiHW94bjO51MJv8Py2yHZA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,g={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\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:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,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:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",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": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(x(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,s.R)(),...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/c4fbe420.c124b6c6.js b/assets/js/c4fbe420.c124b6c6.js deleted file mode 100644 index bbad93ee2..000000000 --- a/assets/js/c4fbe420.c124b6c6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtyG7eSv4Kd2qrEPMOrJF+0L6vYikPHlrS2HMeWdBRwBiQhzQBjACOKVrHqPJw/2Kd9PZ+WL9nqBjAXXiTZlnOUFPMQi4Nbo9Hd6Au6rwJDRzrYPgoOWZol1DAdnIRBzHSkeGa4FMF2cDhmxDeTZ4oODRcjsnPQJ0zQQcI0yTVTmhhJIsWgU5RrI1P+CVqJ8TOHRDN1AWOpJoMkZ5niwmgylIqMmGCK4sSxjPKUQcOEmzHJFIvZkAsWE21UHplcMd0ibzMpiM6jiGk9zBO7MpeCyCGhxZohMWOGoCpmciU0oSQX/GPOSKMhB2csMv240SDfx0zzkaCGxQCcH37K4wchmYx5NCYRFWTAYKsx7NQBzCrgDii0SYFr6oxFfMihs5usRXbimAOMNEmmIaGk0chV0mgQrkmm5AWPWexXk8MhoJQiagkXhqkhjRjiisEsYoTL+MkJFTEZ0ogn3NTRSGKujeKDHFZuHYtjccizbfI2SySNyVTmihw8+7HsbiSBb0eNxjM2yEfkbb/ROPl+bEymt9ttmmUtmTEB2EroQLcimbZj6JjFQ8QVUwxmRXwxqnkyJTSOyYTHI2Y0HoggkcymJJJSxVxY0sjoiBGRpwOmdIi7SaVihAtCiWI0njaNbOaakRdv9vcADSk1LXKQ5Doslou5YpFJpnZ6QI/f1Xf2dB5uAg1xMQpJSs8BS9yQjzmPzmHbmgk8WkcyiKtG4x3AW2CHa0fjMSFmzDWZsMFYynPCLqB5wpOEGMVHI6YajWPx22+/HYurY0HIcYA9joNtchy4KY6D0DaZacZsy7P9p29f7e4dnh6+P9gt2j2lzvXpPyt6DHkyP8Pb1y+LZkHT+ea9nVflAkIa136QMKoZUeyCswmeAxy13avHQjGsIifs6KIFBjGl4esRfCHkyv5Th+ZN//ne7usqLLYHSylPal12X+30X9b6ZGMp6tMc/LS/V58nV5VZ+nvPLVJs+wz+OXHwuhPZcQd02H+1++Zw59UBdJ65cwRqeJNnmVRw/O8sQW/DMR+LH1giJ4QqhtQTyTSVgmRU0ZQZlI1jarBZsY85Vyy2wo0mieeM7WPRJI0G4Ga70SBvrZTiMRMG5IhC1rckhwNatj+QDvTvi5hHwEpWLEwzBpKw1hVYDLq+caLJdq0wHsguK36AoybUSoMsAcEDXRUDqWb4BatPfBmSKUz8jAEd2WnHUvFPUhiaIBFdMGV4RJMq0wOAKCoNVSiyMsmF8V/dCuS9Y27gfWRpJ5UAtBiQm3KBLZqRC5rkTDuoJiEZA1SvWaaYRgnt5gXEi5iMGR+NV65H47Ncm9rEJNde7noo3Fr+VBG9DNE2pIlmhA9ruEzpOausRmRm74MW+WFKYjakeWJCwkFeGZWzFtmThtAsS3iEdynQgL2ocsWaeMqOfFp18jmw9wncIDGHuwSkEzTiFG6Mhw7o0l5AsD2Uu2ZMBZFi7qAjmUi1SEL4uY5HEklhmDAtsnNBeYLA281qwkWU5DEjg4RG5yFqAiFRcPfBqUxZkshJaPkDu+CNjDhH/BDNEqBCKQB+Id3yXJd3boscAqMU/AeNHtW4CNdVrDqZP5SwMqDAsyRBORQi4kJyJgfEcJOwEBg8o2IaktgqGezSDORlSKIxi87xL0VjLskgN0YKu7FYySyWE+FwOZTCaP5pCUf6ls/HaC8kmyF5GJLHIel2QtLthaS7GZLuw5B0H4ek1wlJrxeS3mZIeg8tWL3HDte0QHAVgG7PYtn8ebALcvol18jZIGB1IbMnNZndbZFGo+Cm+eu6vJOLLsXtBjIT2rru9yX82Og9cj+n8PNh77H7OcGu3U33cww/e93qvdJDSAxNs2uggOY7hcArF5aI4Ju7o48DL8/gIwii0DeUV7eDBxpm1b1swF644IbTRK/eju9xj3ZUgrSwqU3YFJLr6h05neXebKcKD6o4ICZtE4rVSpNneISit7D7rZa7WVZv3i57b/ZeAefrtv4Qtg6i6RBE0+r9F9LrHiFhHqavw8SjFioAKJlX48F1uEdYqEP0dTh4DDiAS2k1AqD1Hu2+Ao412PCGt22dzWZ3q9nr9DZrGADL2nZI02YcN6fT6V1gD3QetzyoPF5DtZodeDCGSqZLzA+0DspeTifCv73K/goU9QErnCjgNaj7YLy/oKplGxnT6XfaTuWHFsoZ9C9Vs2kFTGwCONB3Eo0ljxzw0MerZAMwCFuAgyZish3H7Qom4WMcN9O0OfcRfjYR8ZWPadqK49Zcz4XTsR9TEschWfy89HsckzRNV3y232uf22m6uItWmjrYUPl6AkzidLbVfOI6/FGsUnJEfeFr2Qj8TlIkuDaac8v5aO6yGXPv5nFEReY6KDbKE6rYJdilet53coc85lms1OzRjnWeBOYVa/L9vtPeHzjyhy3UJ4AvN49b2BlMsuPcwUSxEbskGTWGKYGTXdCEx9Zt27SuzUuaZmACtP9+fBz/7T/b6IAAG98QOAkS8xEHL2L770c7zQ8nS3rkWcZUBD6shMFKOiTMRC1yNGZJVjoyJ5NJa7Kho7GUifVinmnFhvb/p3JwdorgZi2qswfLdmpJo2LwA+nM2/uamRrGqCZ+5BKTH2kMeajbwdvW2TvXXLeuxz26ceZAgkbrPbG+wCClqJAAKbPyb2nGTB0HJ8UYa+Sz+IaxJ7dg1jGPWUIHLFlsujWjFZ8TOpW542/v1Kpv1VF0BW/QkHJR+C1wO52KmzKll3ONx6WLco6/LUKq3OmvHM+e/gRIwrX33NTRWR3tXFvooBTMBjcGjPgBZFBQ6VdzQQHY7djASiJ3djcsAf0Idizcin61G1aoHUwVMTBHygVP87Twjw6LWT3KUqd7VPEFIyFu41eonu7CCvTyhhVc4GnFAseii34M7/+4RjN1Pe6RrJgD6Xo2/hIpUrun7+iCvZkB/baqDLjkWoau9kIumE+v5r4W2YfrDXyydhB42aKIZQY8cl/LmgXIt76h0GdV9cOtprxqr3tEfUvA+sYU6Prd9e3zRURa3f2fiFBrYN+aWK1TMqWjayx3bL5H5OngWXBCdNEZae+Laxxy2H79drqd2na26tt52PkC66q27NcbV53iY2lV7cJjCLKwENjleULvVNS7OYE0n8o0y02VF9DkR373l7cPq9kw4d9C0gxJIyTtkHwfkgct8pphIC4qgnbuLufKhuY4PDTIIWYS5SqZkoGiEbyNYK1Ri1xdfcypMNxMZzPSIFdX8PpkNmsBc5wLObFxu6MLrrkh8AqjtHViGeklrzZkpNtgFLX32KT5zMX22w60B+R7Ocep11qWDgWfa0quGvaN7SsIER0oNoTnGmUgn/hP/nggMMoSlrrgsQvhg8KI4SQujAQU+MchjcaADSWEkuBdCQQkx7QM9VuNzQrH6tsU+6BEKjKm2lqyaDrD9uDhjBmz1AW19qRhNqKtMyk0s8I8WwJ0GZFuNOYiYr5bGRXjwm8cxEn37tw3vSedqnzpPtyqicutuoDprBIw13hvQIxYXHiXNyubKpyvisc2S9l+nu/9pIBsK248kVnqk3kSk4SfY3Az5jpL6BTIwl+WDsr5qPnTsZS67OEC147P9HY9IC4VxMQftIr44Nf6nbuPNmrS/vEdONPm3Mv1w+hstrtb7Wv9y3Ne0c+X14Tc5uTQcXurk8Oe5dGt/cBf6ge+G8LfuEs3WPdRr6a9bXS+ngHuyNtVZZwb/Fx34c26M7dSld1u6VD6wxw7X099m9/CxJ0Tw4+6dyCGV1iyX0uJCwbrndEeuStrdRkB3sJcvdZG/WoCrQL7zYl0625M226npqs9qalqT3pVotzauhVRVhedo6zjgP/yw/7rSefn5yO5s7Ozs/fm7Xj37WhnZyeF361Wa6lXY9lp4zKgw7oH3u5exjt+xSqtVgtQGFNDt3F4OxOj/7Ljw9VjWu45yDdytW7dRXRziUf166VA0fWPuWiWuU+/HZ9/LQcGYSAzzF2Roh8H20EMGTI+LyMI0QPCtPlBxtNg+ypwzzjhT/dIEka2zzTk2lwFOhqzlMJf3oKD7Bx43h+E/lV9EAb4rgdSdYDogm2XIRCEEHPOwDHINMyB47avfC+b/BCETgsPtgNL9EEYuMhr8YkwEUl4S5HFw2DmF7xuquJLOZXGP4okFZgHXoh/4TQ4dDaXnfRFM1VnmJVoLSejStFpMJ8I5Z+G+7i+HVe8fU2m/m7gBjwRxXtl7BaEATcsra6y4tCU/HxMR0zCTvDN3+eOxWOh6WevCeMwCeNLBrpnWV8y9EwOTr+IHGGwc38sOetbno5tXVy4Tio78NiZxV4Zbpav9kOCL2dbN1Gq749YpqPqmtZptrDm4apsjsojcj1GC5hmGaOqhUkVX5zthQl/NIlyTEArpHFtZwWoxc66szC4vHkzlySSTZ8qQr5P2NDYpx0kkkow9aD6XuzebK63uTkLg+nN25v+Kbf3CA5vcvPu3mGOTZl/9O+AdePxLAzGN8P6U5EF9G8EdvPhrLxjXTJakYQ6kPH01Mut2U0d/WUG/SCjsS/2VcxUBREDKRNGxQIm+kPrT5fkOzB0vgvtgypM3uBK+4vMJjkqFjFIBMN3ll5WEafr2MwO4h7Ugy9+Fz6gdqbzgYZews+n7YQD5hMnIdPX9uA2Uxb954xGY0jRdM+86NA79zLIVZS59uCBGx1ul4SBc9uGV6CJi1HdGKtgB5311b23qqcDX+ByxWzn/cODW+ASLcWmzdez+oHdpZ2D7B8eQEocHzr1r0Xe6gITHrW01oWAOkYuOPVpM4Vsn9pHKMy6O6VP2CwjDC2XjNYkiwDFXC+FKITUGZuvU2R3L0xcZtzCEcncQMTCpTgTbVima3hEKApEHsr8NlR5AyYpGeX45tcAy/r8OHz2V6a0cWFTx9HMiHPls/gcWUBPyCMv8eSxAp0q84eECW2HUzKk2jAVQj45YF7lYFQUU7LLjCkOwb6lKFDMou40V0v1tToO6vlhb1+/dHnWfg+eKQfAgXZiFpM8Q6pBTijyFv3JzW99QVEC7mDqdJViuKh6YAjTeUAypjTk4isi1YgK/snl5oNGAkbWgI1pYrs6UQGecoAHOLwOjJe1v//zXxW4Vmq6i4DZFWgcw6PUGyBES9ISPGj6imUgAWUdIpiPqf+evwQAOmSa01TGBSPp29P4AT5j1YVcdBHAIgKp82gMhkUhb3XoZax2aqVG0xTtVwwhZrBfdsm1qWTe+ffxi/LhNQM8RhUYUA0BrgaaF9Mqg5eRUTk3HeYH8nrWZnENLvACzY08VSzl4nb3VNUZZ2QhCHIjU2p4RPxUulXPxbURH8/XKRR9sKABNV5wqR6sYFWY7lSKiJ1yccoumLqFgrdXvOeL6RSI20wYE1XYPJLsdVbmS06g4EANJ5XbCbOCa8S4FQLdpUyN2GkEZgoSHrsFHhsNmK3RIE0LixOrOlfOo+JS2VF+gCgpZweIXNJpkW1R3rnVehIt8pOcAM5CktnSAmDG2/kBpQQhj22hjuoKERWQdYrOHEg1hYmL6FpKeVmUwQW48bxwN31rhUfWoQOzQOo1rBNetycvQos0Egrp0351yxF2c+BWITSRyFJmXMrhuA5UHzNnx3gF4RGCB9iu49PZ5UQw9fs//k9jHN8+D9Et2MLKVozw00RLm5ZbndVTtKd5659aIGn3ZGCZsXu9x8MLkLIkCksH8PoL3z2gRoU3jSydHnXr+ZuZ39fZ0i4cv7ak/0SmZrfT+Stb0hudP48lvdn5E1nSjwFY57O/WZqs0m6Xyg4fg7h+wJlk1r+ZSHV9T/Dtz8IiYrIMwSU79Gb2v9L490L8BoeA9RiUwQRnzPrNIBp6nQ78MycEfWkpX/CorLaVTP8jCG8fybj+DHxxo+uR9cO495PORBqNAWcrrKay+/UkVo3QtNn0xXjwPOL7/EX/7ad+d4/3dV+83oqe9h/2z7Nff3n64kmLTV90o94v0197v5j37xLdP5M8+unF+IP4RQ+ebuXvf/2g3v/aV+/fvTb03dbOQIzF4PmPPJpunQ16Hf7y6YvOh3fdyeD5j50PvzzJPuDkP3Y+nJ93onTv6UDsQJ/s/a//w/fPdjdefdr99Opw9/LVp+RJi+59PHt6GT15db77sPmhr5qv9gc/n3002euteGPvV/7wMXvF3onDzsuoRg1cJFywU3/Up7jvUzhsS0mby479jUyZVVkmWNFKSSiX5XQ3o6aEjkD5AtSpO6QCptRN/PJ5kF2HiM1O57RbIGFrEQl9gYlcWDnuUJ4z8cfutLq8scsDqJdpUgqtgNtO2B7UNlv9bjepWZQrbqbB9tFVcNmkGW/a9u2jk9kJmA9mLCF4mUmNEFMzDraD9nwsEwr4YaTsaIFsJhR8dz/lA4R6JzeSvJLRud0a8mvBlBdcGTtTS9th43yAnHmgKIiXPXpxTlUbGLfdbXVanWAWXs1NoqmI4RHQAnfTjLcvuq3ukjFLpcE1/Vne/Nwh2tARF6Obxp2UZ/IG6MaSRu1kSg054z8zUJHdwVd7hQEH7I8ZBdsZjhrI8XUZct71ROWDwcviuyXxzEdsfcC2FoOdv/iXRFUrQdUjH9HEIGURowzKDQVFHDEIKpFB+FGJ9cHPwnw4KtmnCJR57b6LanFvcxP1x0ddVLQ2HqMOs/lwdmKRX/GMY15C1b1rnzbV/JTuU91vFwRzfrKas2reV7XSb7TCbeSWnHOPFIAs80qAN2CpM8CNqhh+S1DpdZ06IuFlECByo4OI3OwgIh93amqW2345Q6ksoUZUKESo9VSVHtBsToBwuRhKpHp33PsZE2/A4wzyBLlmQTlmSSTTosJUo+GH/P7PfxWjGo3CJqdFCcz9XJFMTpiC0qFYOjNhlxy8L1jWNMU2jV4EzDKgacK0hgC/MGxk635CJjq4uZ0jNaIZHUD5TXDTYmYAvguu3BS6Rd6NGSaMTGX+nbLpExcsgduh8F9VS3dOpDofJnICFTHJANJKwIPJxJiKyDpLrQhBpx8Y4+CIzhTXUFRPAdTcwiaFUTQyJKWCjtBrF5IqsmKWcBDsRMkBxBK0THLrLTeUJ1LZV5y4IXxmg0jcvcygCTV8YFrFxkDYF85lrkMbsrDSwRX1HEB0KANYOHgyjCS5SCTU34QoU54kJJPGRn7AkKjCCMONokKD9m9h8WdQIMx5s5l2PqG3msEJv+Ti3Fb9apKjgq7esYHmhtVrAswz54P6mOfcwBX3mmVScyPVtBw94sZfY9VJih92pue+bmxFit8+U+cNM0Ahur1z0Ee95AH5/R//S14yqgQZy4ml1ihXLJmWJWqxmiqevEVboVZgvITmUJLVIJGKkQ/h6aL8KTXogNpjE/D0WZayT6cO8kHCo6I2sG40tslTWwG4KPpbz2G2+TAQxKIks6MTLs5bZEdMbanbwp8G33FcbRsYglpRcrcstHtYWZ2lmiUXTFccilBAF0ODSuYju1oVGLe5enoQ7G0njheybcCpXIJj3WAYk6PWHwZFapck6NSyb+rl8ZiIsRCm3iaofpXzh3M5QximW/jk043KGsh2mkodZsCk23Hx1boK5zSQurxFFyQsqGsVkGnGHTkdebIk9WIbn0/W1oQWhkaob/sblGZ8adgFyoDq/eEbqC8deftvBUe3sXM7CIOER8zZ8+7+2nl+8JJcbLQ6NZ31Fszdftl/urv3ZheAAUFqEeZ1V1SrUyoqK2Ed7YJQ56+2yjPBdfntdfntdfntdfntdfntdfntdfntdfntdfntdfnte43ddfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfnt+yIr1uW370tV43X57T+CAtflt9flt9flt9flt9flt9flt9flt9flt9flt9flt/+ifuB1+e11+e11+e11+e11+e11+e11+e11+e2/cvntSvZqO0soF5UKETaR/WiuKPdJGIwh0X37KLi6AsJ7q5LZDD5/zDGP9ugkDC6o4vCCEnPkQ59iDemy5wxSbZ/aB6HNQ1g+tOeMKUpzpQEgR9yO2MGtX9u3mot/sP/mMAiDgSscnsoYq4bQCaTX0olNP67k4OK3qyChYpRj/m5g55zZGmvjekr5OaaUuz8qScCQel1CWM81t9uA/8Omlg64urLp6rNZ0d82rRzhEOt7w/GdzGaz/wdRpK8P","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={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:"eJztPNtyG7eSv4Kd2qrEPMOrJF+0L6vYikPHlrS2HMeWdBRwBiQhzQBjACOKVrHqPJw/2Kd9PZ+WL9nqBjAXXiTZlnOUFPMQi4Nbo9Hd6Au6rwJDRzrYPgoOWZol1DAdnIRBzHSkeGa4FMF2cDhmxDeTZ4oODRcjsnPQJ0zQQcI0yTVTmhhJIsWgU5RrI1P+CVqJ8TOHRDN1AWOpJoMkZ5niwmgylIqMmGCK4sSxjPKUQcOEmzHJFIvZkAsWE21UHplcMd0ibzMpiM6jiGk9zBO7MpeCyCGhxZohMWOGoCpmciU0oSQX/GPOSKMhB2csMv240SDfx0zzkaCGxQCcH37K4wchmYx5NCYRFWTAYKsx7NQBzCrgDii0SYFr6oxFfMihs5usRXbimAOMNEmmIaGk0chV0mgQrkmm5AWPWexXk8MhoJQiagkXhqkhjRjiisEsYoTL+MkJFTEZ0ogn3NTRSGKujeKDHFZuHYtjccizbfI2SySNyVTmihw8+7HsbiSBb0eNxjM2yEfkbb/ROPl+bEymt9ttmmUtmTEB2EroQLcimbZj6JjFQ8QVUwxmRXwxqnkyJTSOyYTHI2Y0HoggkcymJJJSxVxY0sjoiBGRpwOmdIi7SaVihAtCiWI0njaNbOaakRdv9vcADSk1LXKQ5Doslou5YpFJpnZ6QI/f1Xf2dB5uAg1xMQpJSs8BS9yQjzmPzmHbmgk8WkcyiKtG4x3AW2CHa0fjMSFmzDWZsMFYynPCLqB5wpOEGMVHI6YajWPx22+/HYurY0HIcYA9joNtchy4KY6D0DaZacZsy7P9p29f7e4dnh6+P9gt2j2lzvXpPyt6DHkyP8Pb1y+LZkHT+ea9nVflAkIa136QMKoZUeyCswmeAxy13avHQjGsIifs6KIFBjGl4esRfCHkyv5Th+ZN//ne7usqLLYHSylPal12X+30X9b6ZGMp6tMc/LS/V58nV5VZ+nvPLVJs+wz+OXHwuhPZcQd02H+1++Zw59UBdJ65cwRqeJNnmVRw/O8sQW/DMR+LH1giJ4QqhtQTyTSVgmRU0ZQZlI1jarBZsY85Vyy2wo0mieeM7WPRJI0G4Ga70SBvrZTiMRMG5IhC1rckhwNatj+QDvTvi5hHwEpWLEwzBpKw1hVYDLq+caLJdq0wHsguK36AoybUSoMsAcEDXRUDqWb4BatPfBmSKUz8jAEd2WnHUvFPUhiaIBFdMGV4RJMq0wOAKCoNVSiyMsmF8V/dCuS9Y27gfWRpJ5UAtBiQm3KBLZqRC5rkTDuoJiEZA1SvWaaYRgnt5gXEi5iMGR+NV65H47Ncm9rEJNde7noo3Fr+VBG9DNE2pIlmhA9ruEzpOausRmRm74MW+WFKYjakeWJCwkFeGZWzFtmThtAsS3iEdynQgL2ocsWaeMqOfFp18jmw9wncIDGHuwSkEzTiFG6Mhw7o0l5AsD2Uu2ZMBZFi7qAjmUi1SEL4uY5HEklhmDAtsnNBeYLA281qwkWU5DEjg4RG5yFqAiFRcPfBqUxZkshJaPkDu+CNjDhH/BDNEqBCKQB+Id3yXJd3boscAqMU/AeNHtW4CNdVrDqZP5SwMqDAsyRBORQi4kJyJgfEcJOwEBg8o2IaktgqGezSDORlSKIxi87xL0VjLskgN0YKu7FYySyWE+FwOZTCaP5pCUf6ls/HaC8kmyF5GJLHIel2QtLthaS7GZLuw5B0H4ek1wlJrxeS3mZIeg8tWL3HDte0QHAVgG7PYtn8ebALcvol18jZIGB1IbMnNZndbZFGo+Cm+eu6vJOLLsXtBjIT2rru9yX82Og9cj+n8PNh77H7OcGu3U33cww/e93qvdJDSAxNs2uggOY7hcArF5aI4Ju7o48DL8/gIwii0DeUV7eDBxpm1b1swF644IbTRK/eju9xj3ZUgrSwqU3YFJLr6h05neXebKcKD6o4ICZtE4rVSpNneISit7D7rZa7WVZv3i57b/ZeAefrtv4Qtg6i6RBE0+r9F9LrHiFhHqavw8SjFioAKJlX48F1uEdYqEP0dTh4DDiAS2k1AqD1Hu2+Ao412PCGt22dzWZ3q9nr9DZrGADL2nZI02YcN6fT6V1gD3QetzyoPF5DtZodeDCGSqZLzA+0DspeTifCv73K/goU9QErnCjgNaj7YLy/oKplGxnT6XfaTuWHFsoZ9C9Vs2kFTGwCONB3Eo0ljxzw0MerZAMwCFuAgyZish3H7Qom4WMcN9O0OfcRfjYR8ZWPadqK49Zcz4XTsR9TEschWfy89HsckzRNV3y232uf22m6uItWmjrYUPl6AkzidLbVfOI6/FGsUnJEfeFr2Qj8TlIkuDaac8v5aO6yGXPv5nFEReY6KDbKE6rYJdilet53coc85lms1OzRjnWeBOYVa/L9vtPeHzjyhy3UJ4AvN49b2BlMsuPcwUSxEbskGTWGKYGTXdCEx9Zt27SuzUuaZmACtP9+fBz/7T/b6IAAG98QOAkS8xEHL2L770c7zQ8nS3rkWcZUBD6shMFKOiTMRC1yNGZJVjoyJ5NJa7Kho7GUifVinmnFhvb/p3JwdorgZi2qswfLdmpJo2LwA+nM2/uamRrGqCZ+5BKTH2kMeajbwdvW2TvXXLeuxz26ceZAgkbrPbG+wCClqJAAKbPyb2nGTB0HJ8UYa+Sz+IaxJ7dg1jGPWUIHLFlsujWjFZ8TOpW542/v1Kpv1VF0BW/QkHJR+C1wO52KmzKll3ONx6WLco6/LUKq3OmvHM+e/gRIwrX33NTRWR3tXFvooBTMBjcGjPgBZFBQ6VdzQQHY7djASiJ3djcsAf0Idizcin61G1aoHUwVMTBHygVP87Twjw6LWT3KUqd7VPEFIyFu41eonu7CCvTyhhVc4GnFAseii34M7/+4RjN1Pe6RrJgD6Xo2/hIpUrun7+iCvZkB/baqDLjkWoau9kIumE+v5r4W2YfrDXyydhB42aKIZQY8cl/LmgXIt76h0GdV9cOtprxqr3tEfUvA+sYU6Prd9e3zRURa3f2fiFBrYN+aWK1TMqWjayx3bL5H5OngWXBCdNEZae+Laxxy2H79drqd2na26tt52PkC66q27NcbV53iY2lV7cJjCLKwENjleULvVNS7OYE0n8o0y02VF9DkR373l7cPq9kw4d9C0gxJIyTtkHwfkgct8pphIC4qgnbuLufKhuY4PDTIIWYS5SqZkoGiEbyNYK1Ri1xdfcypMNxMZzPSIFdX8PpkNmsBc5wLObFxu6MLrrkh8AqjtHViGeklrzZkpNtgFLX32KT5zMX22w60B+R7Ocep11qWDgWfa0quGvaN7SsIER0oNoTnGmUgn/hP/nggMMoSlrrgsQvhg8KI4SQujAQU+MchjcaADSWEkuBdCQQkx7QM9VuNzQrH6tsU+6BEKjKm2lqyaDrD9uDhjBmz1AW19qRhNqKtMyk0s8I8WwJ0GZFuNOYiYr5bGRXjwm8cxEn37tw3vSedqnzpPtyqicutuoDprBIw13hvQIxYXHiXNyubKpyvisc2S9l+nu/9pIBsK248kVnqk3kSk4SfY3Az5jpL6BTIwl+WDsr5qPnTsZS67OEC147P9HY9IC4VxMQftIr44Nf6nbuPNmrS/vEdONPm3Mv1w+hstrtb7Wv9y3Ne0c+X14Tc5uTQcXurk8Oe5dGt/cBf6ge+G8LfuEs3WPdRr6a9bXS+ngHuyNtVZZwb/Fx34c26M7dSld1u6VD6wxw7X099m9/CxJ0Tw4+6dyCGV1iyX0uJCwbrndEeuStrdRkB3sJcvdZG/WoCrQL7zYl0625M226npqs9qalqT3pVotzauhVRVhedo6zjgP/yw/7rSefn5yO5s7Ozs/fm7Xj37WhnZyeF361Wa6lXY9lp4zKgw7oH3u5exjt+xSqtVgtQGFNDt3F4OxOj/7Ljw9VjWu45yDdytW7dRXRziUf166VA0fWPuWiWuU+/HZ9/LQcGYSAzzF2Roh8H20EMGTI+LyMI0QPCtPlBxtNg+ypwzzjhT/dIEka2zzTk2lwFOhqzlMJf3oKD7Bx43h+E/lV9EAb4rgdSdYDogm2XIRCEEHPOwDHINMyB47avfC+b/BCETgsPtgNL9EEYuMhr8YkwEUl4S5HFw2DmF7xuquJLOZXGP4okFZgHXoh/4TQ4dDaXnfRFM1VnmJVoLSejStFpMJ8I5Z+G+7i+HVe8fU2m/m7gBjwRxXtl7BaEATcsra6y4tCU/HxMR0zCTvDN3+eOxWOh6WevCeMwCeNLBrpnWV8y9EwOTr+IHGGwc38sOetbno5tXVy4Tio78NiZxV4Zbpav9kOCL2dbN1Gq749YpqPqmtZptrDm4apsjsojcj1GC5hmGaOqhUkVX5zthQl/NIlyTEArpHFtZwWoxc66szC4vHkzlySSTZ8qQr5P2NDYpx0kkkow9aD6XuzebK63uTkLg+nN25v+Kbf3CA5vcvPu3mGOTZl/9O+AdePxLAzGN8P6U5EF9G8EdvPhrLxjXTJakYQ6kPH01Mut2U0d/WUG/SCjsS/2VcxUBREDKRNGxQIm+kPrT5fkOzB0vgvtgypM3uBK+4vMJjkqFjFIBMN3ll5WEafr2MwO4h7Ugy9+Fz6gdqbzgYZews+n7YQD5hMnIdPX9uA2Uxb954xGY0jRdM+86NA79zLIVZS59uCBGx1ul4SBc9uGV6CJi1HdGKtgB5311b23qqcDX+ByxWzn/cODW+ASLcWmzdez+oHdpZ2D7B8eQEocHzr1r0Xe6gITHrW01oWAOkYuOPVpM4Vsn9pHKMy6O6VP2CwjDC2XjNYkiwDFXC+FKITUGZuvU2R3L0xcZtzCEcncQMTCpTgTbVima3hEKApEHsr8NlR5AyYpGeX45tcAy/r8OHz2V6a0cWFTx9HMiHPls/gcWUBPyCMv8eSxAp0q84eECW2HUzKk2jAVQj45YF7lYFQUU7LLjCkOwb6lKFDMou40V0v1tToO6vlhb1+/dHnWfg+eKQfAgXZiFpM8Q6pBTijyFv3JzW99QVEC7mDqdJViuKh6YAjTeUAypjTk4isi1YgK/snl5oNGAkbWgI1pYrs6UQGecoAHOLwOjJe1v//zXxW4Vmq6i4DZFWgcw6PUGyBES9ISPGj6imUgAWUdIpiPqf+evwQAOmSa01TGBSPp29P4AT5j1YVcdBHAIgKp82gMhkUhb3XoZax2aqVG0xTtVwwhZrBfdsm1qWTe+ffxi/LhNQM8RhUYUA0BrgaaF9Mqg5eRUTk3HeYH8nrWZnENLvACzY08VSzl4nb3VNUZZ2QhCHIjU2p4RPxUulXPxbURH8/XKRR9sKABNV5wqR6sYFWY7lSKiJ1yccoumLqFgrdXvOeL6RSI20wYE1XYPJLsdVbmS06g4EANJ5XbCbOCa8S4FQLdpUyN2GkEZgoSHrsFHhsNmK3RIE0LixOrOlfOo+JS2VF+gCgpZweIXNJpkW1R3rnVehIt8pOcAM5CktnSAmDG2/kBpQQhj22hjuoKERWQdYrOHEg1hYmL6FpKeVmUwQW48bxwN31rhUfWoQOzQOo1rBNetycvQos0Egrp0351yxF2c+BWITSRyFJmXMrhuA5UHzNnx3gF4RGCB9iu49PZ5UQw9fs//k9jHN8+D9Et2MLKVozw00RLm5ZbndVTtKd5659aIGn3ZGCZsXu9x8MLkLIkCksH8PoL3z2gRoU3jSydHnXr+ZuZ39fZ0i4cv7ak/0SmZrfT+Stb0hudP48lvdn5E1nSjwFY57O/WZqs0m6Xyg4fg7h+wJlk1r+ZSHV9T/Dtz8IiYrIMwSU79Gb2v9L490L8BoeA9RiUwQRnzPrNIBp6nQ78MycEfWkpX/CorLaVTP8jCG8fybj+DHxxo+uR9cO495PORBqNAWcrrKay+/UkVo3QtNn0xXjwPOL7/EX/7ad+d4/3dV+83oqe9h/2z7Nff3n64kmLTV90o94v0197v5j37xLdP5M8+unF+IP4RQ+ebuXvf/2g3v/aV+/fvTb03dbOQIzF4PmPPJpunQ16Hf7y6YvOh3fdyeD5j50PvzzJPuDkP3Y+nJ93onTv6UDsQJ/s/a//w/fPdjdefdr99Opw9/LVp+RJi+59PHt6GT15db77sPmhr5qv9gc/n3002euteGPvV/7wMXvF3onDzsuoRg1cJFywU3/Up7jvUzhsS0mby479jUyZVVkmWNFKSSiX5XQ3o6aEjkD5AtSpO6QCptRN/PJ5kF2HiM1O57RbIGFrEQl9gYlcWDnuUJ4z8cfutLq8scsDqJdpUgqtgNtO2B7UNlv9bjepWZQrbqbB9tFVcNmkGW/a9u2jk9kJmA9mLCF4mUmNEFMzDraD9nwsEwr4YaTsaIFsJhR8dz/lA4R6JzeSvJLRud0a8mvBlBdcGTtTS9th43yAnHmgKIiXPXpxTlUbGLfdbXVanWAWXs1NoqmI4RHQAnfTjLcvuq3ukjFLpcE1/Vne/Nwh2tARF6Obxp2UZ/IG6MaSRu1kSg054z8zUJHdwVd7hQEH7I8ZBdsZjhrI8XUZct71ROWDwcviuyXxzEdsfcC2FoOdv/iXRFUrQdUjH9HEIGURowzKDQVFHDEIKpFB+FGJ9cHPwnw4KtmnCJR57b6LanFvcxP1x0ddVLQ2HqMOs/lwdmKRX/GMY15C1b1rnzbV/JTuU91vFwRzfrKas2reV7XSb7TCbeSWnHOPFIAs80qAN2CpM8CNqhh+S1DpdZ06IuFlECByo4OI3OwgIh93amqW2345Q6ksoUZUKESo9VSVHtBsToBwuRhKpHp33PsZE2/A4wzyBLlmQTlmSSTTosJUo+GH/P7PfxWjGo3CJqdFCcz9XJFMTpiC0qFYOjNhlxy8L1jWNMU2jV4EzDKgacK0hgC/MGxk635CJjq4uZ0jNaIZHUD5TXDTYmYAvguu3BS6Rd6NGSaMTGX+nbLpExcsgduh8F9VS3dOpDofJnICFTHJANJKwIPJxJiKyDpLrQhBpx8Y4+CIzhTXUFRPAdTcwiaFUTQyJKWCjtBrF5IqsmKWcBDsRMkBxBK0THLrLTeUJ1LZV5y4IXxmg0jcvcygCTV8YFrFxkDYF85lrkMbsrDSwRX1HEB0KANYOHgyjCS5SCTU34QoU54kJJPGRn7AkKjCCMONokKD9m9h8WdQIMx5s5l2PqG3msEJv+Ti3Fb9apKjgq7esYHmhtVrAswz54P6mOfcwBX3mmVScyPVtBw94sZfY9VJih92pue+bmxFit8+U+cNM0Ahur1z0Ee95AH5/R//S14yqgQZy4ml1ihXLJmWJWqxmiqevEVboVZgvITmUJLVIJGKkQ/h6aL8KTXogNpjE/D0WZayT6cO8kHCo6I2sG40tslTWwG4KPpbz2G2+TAQxKIks6MTLs5bZEdMbanbwp8G33FcbRsYglpRcrcstHtYWZ2lmiUXTFccilBAF0ODSuYju1oVGLe5enoQ7G0njheybcCpXIJj3WAYk6PWHwZFapck6NSyb+rl8ZiIsRCm3iaofpXzh3M5QximW/jk043KGsh2mkodZsCk23Hx1boK5zSQurxFFyQsqGsVkGnGHTkdebIk9WIbn0/W1oQWhkaob/sblGZ8adgFyoDq/eEbqC8deftvBUe3sXM7CIOER8zZ8+7+2nl+8JJcbLQ6NZ31Fszdftl/urv3ZheAAUFqEeZ1V1SrUyoqK2Ed7YJQ56+2yjPBdfntdfntdfntdfntdfntdfntdfntdfntdfntdfnte43ddfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfntdfnt+yIr1uW370tV43X57T+CAtflt9flt9flt9flt9flt9flt9flt9flt9flt9flt/+ifuB1+e11+e11+e11+e11+e11+e11+e11+e2/cvntSvZqO0soF5UKETaR/WiuKPdJGIwh0X37KLi6AsJ7q5LZDD5/zDGP9ugkDC6o4vCCEnPkQ59iDemy5wxSbZ/aB6HNQ1g+tOeMKUpzpQEgR9yO2MGtX9u3mot/sP/mMAiDgSscnsoYq4bQCaTX0olNP67k4OK3qyChYpRj/m5g55zZGmvjekr5OaaUuz8qScCQel1CWM81t9uA/8Omlg64urLp6rNZ0d82rRzhEOt7w/GdzGaz/wdRpK8P",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,f={},j=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\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:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,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:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",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": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.037506c8.js b/assets/js/c7e3ab5f.037506c8.js deleted file mode 100644 index d89ba85fd..000000000 --- a/assets/js/c7e3ab5f.037506c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>I,contentTitle:()=>f,default:()=>j,frontMatter:()=>y,metadata:()=>n,toc:()=>C});const n=JSON.parse('{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1.1/deletecontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletecontact","permalink":"/docs/API-docs/v1.1/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV91uI7cVfpVT3iQrjCXZ66ToXNXdGBujzq4ROzBQr2FQM0czjDgkQ56RLAgCctE36FVv+2j7JMUhZ0aS7d1m0SJAb2zN4fn/48eNIFkFkd+JN9aQLCiI+0yUGAqvHClrRC5uaoTvUCMhdExwdnUBUmu7CrC2LZAFj41dIkgoOpa5tw0f+p4ys3Yxhot5lDAWtDUVejCIJUhw0pMqWi0H/q8CKDO3vpHsRwZUqxANN3KBARQByrBm22VyjmpUHjwW1pdjkQnr0EfZi1LkIjF1ukUmnPSyQULP0W+EkQ2KXHTnD6oUmVAcvZNUi6cpufJ2qUoEO/sZC7oowc6HwAeHRCY8/tIqj6XIybeYiUBrzWaCapxmBnx02pYo8rnUgRmKGhsp8o2gtYuc5JWpRCZSJvYp+Cijlly4+mRWn8hQiu32nq0GZ03AwHpOplP+d+h/X8fkaAmhLQoMYd5qvf6DyGIa0BALSue0KmIeJz8Hlt489zLlgbPqOeukku0+PS/Fs/P+L4/su/vevRbbrKtTeUafFzqZnrw+Op4eTf94c/xtfvqn/Jtvx9Pp9G8iE4+NZtmuoqUkZL2kSO++t8/YUsn2GTvKlplPX8ritW2QamUqWKEhWHlrqgycRhkQyK9BVlIZ0JLQ/w+zit5b//nsfJln272oldHK4EPfQg+n0+nD8ZCE00+3krEEc9ua8veN9AXznw/n9OFkCOeb5+FcmKXUqoyL5sYu0Py+4eybp2T+ea+qxBTPxUGw+/QUZMCi9YrWcck9HkmnjtJ5fnfPu4L7xO72Y1yMVItcTLp9NtnsduJWsEK/7Jfmk3FYyapC/307i+6ftWThB1ssUoyt1yIXNZEL+WSyVJ6SpnFIYnU7Gxe2mVx5yWvonVwupJ9Yh2ZyPJ6Op2KbbZ4oCdKUM/s4ZqagKqPlLEQd0qnJ8nh8/IKMdO6L+LE9+lKRQLJSpvpPcve74lxzA6UeOSjR0CnSqb/iWmR9B+xzdfdUjbJEH7uFr80o3PXFe4fmWlUmliUaf3qf3aIubIN8d1GNMBr1Ih///q9BajSC0hZtg4Zi/48/mA/mfevB2RX6eatBmhLmGh/VTGMUwyaeDSghoGw0hqDXoAxh5SUhlKpSJDVwnnhlFdLJmdKKx4bZbIIRe5MXxnBbI9Xo+egrz7ijxCVqnjaQLVkGDaYa/IWV9Ys545UMJMzaoAyGAGhqaQpm7CuRgfUgDaAh9M6rgBDIs9cq+WYNed43jTSyQtadwX6yStSK5wO8nbWBIFjdRpeBpNLWYwl9QIx8QkziOaMAj5DQUuM81tw2S4SqVSWGDApbIoS4JTgEU8IMA4FjX1SBgZW2RttiEQvIEwTO8tJSUjM62feRxclLExhTJF/6GgwJc94yIsDk4Gj0U0Cu8KUyi5CPRh/MEdwNfXWLs6AI77/uR2C1Wj1r/VeHMm8V8ab4EZ0Niqxf76QrRf022FcyfCRNb9Fg7J+9YdjpKG0Rnk8fUyc1aje5RuIOCZOzq4u451/Bx1//AZcovYHarlK3Fq1HvYaqN8WZS5VPaRvWNMxtbLyaM16k5mPwh4H6DN7Wkj7++s8A73AFynQjxaGMRlftTKsCbrBxfCeH0SiHNx7ZJPU0oFoSFNLADCHUkltpqSRj5yStlVmM4cysoQ3oYaWojs3A9Ch3EAbnZSh3gJkMWII1UaK3Od55xPQmoF5iYF183c4QsFQMH6n2tq2StX1nuuA8zpXWcKvKCinGdlaW4DryKpEjbt65g3MeCKpxDdIjBDQ0hqsnIvGkdc569kIl5+eWHyZcADSls8pQyKH0ck47/dmu0QtOc3xgPCOlFMohHVmnZihJmsQu4oE6/sBL+ckiP9y3Hufo2WAMe1cXp7p2uuvbErhb/5u2ZoDQv3oYgzRS6XSj/Pmpnogl0Dfh/fwa/VIV2N1qn5joSWSeiExoVaAJuIdRzt5eXcLy9Xh6cPX/huGeXF68OX93fc7O8CJNCeshgHA2UCPNnqXDp+nTq22zA2//tw/ZDgQQPtLEaaki6ItJ3XRo7U7sHrb53hv2PhO1DcQMmw2P+E9eb7dM/qVFz6DwPhNL6ZWcMVJgSKcC/y6HF+kns/n1j93j9hX81ufwi4H0EMcwvllK3fKXyMQC14cP8u39NuthDruaGM6KAh3tiT5D6Acw97vzy/Obc5EJXtaHCGsREVb3gw286Nkh9Eo+8F/GgS8KbDYJvW23A386+qREF2PPzWm63263/waKNzXa","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var a=o(74848),c=o(28453),i=o(33617),s=o.n(i),l=o(17543),r=o.n(l),p=o(86013),d=o.n(p),h=o(63723),m=o.n(h),u=(o(18766),o(79329),o(9303));const y={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV91uI7cVfpVT3iQrjCXZ66ToXNXdGBujzq4ROzBQr2FQM0czjDgkQ56RLAgCctE36FVv+2j7JMUhZ0aS7d1m0SJAb2zN4fn/48eNIFkFkd+JN9aQLCiI+0yUGAqvHClrRC5uaoTvUCMhdExwdnUBUmu7CrC2LZAFj41dIkgoOpa5tw0f+p4ys3Yxhot5lDAWtDUVejCIJUhw0pMqWi0H/q8CKDO3vpHsRwZUqxANN3KBARQByrBm22VyjmpUHjwW1pdjkQnr0EfZi1LkIjF1ukUmnPSyQULP0W+EkQ2KXHTnD6oUmVAcvZNUi6cpufJ2qUoEO/sZC7oowc6HwAeHRCY8/tIqj6XIybeYiUBrzWaCapxmBnx02pYo8rnUgRmKGhsp8o2gtYuc5JWpRCZSJvYp+Cijlly4+mRWn8hQiu32nq0GZ03AwHpOplP+d+h/X8fkaAmhLQoMYd5qvf6DyGIa0BALSue0KmIeJz8Hlt489zLlgbPqOeukku0+PS/Fs/P+L4/su/vevRbbrKtTeUafFzqZnrw+Op4eTf94c/xtfvqn/Jtvx9Pp9G8iE4+NZtmuoqUkZL2kSO++t8/YUsn2GTvKlplPX8ritW2QamUqWKEhWHlrqgycRhkQyK9BVlIZ0JLQ/w+zit5b//nsfJln272oldHK4EPfQg+n0+nD8ZCE00+3krEEc9ua8veN9AXznw/n9OFkCOeb5+FcmKXUqoyL5sYu0Py+4eybp2T+ea+qxBTPxUGw+/QUZMCi9YrWcck9HkmnjtJ5fnfPu4L7xO72Y1yMVItcTLp9NtnsduJWsEK/7Jfmk3FYyapC/307i+6ftWThB1ssUoyt1yIXNZEL+WSyVJ6SpnFIYnU7Gxe2mVx5yWvonVwupJ9Yh2ZyPJ6Op2KbbZ4oCdKUM/s4ZqagKqPlLEQd0qnJ8nh8/IKMdO6L+LE9+lKRQLJSpvpPcve74lxzA6UeOSjR0CnSqb/iWmR9B+xzdfdUjbJEH7uFr80o3PXFe4fmWlUmliUaf3qf3aIubIN8d1GNMBr1Ih///q9BajSC0hZtg4Zi/48/mA/mfevB2RX6eatBmhLmGh/VTGMUwyaeDSghoGw0hqDXoAxh5SUhlKpSJDVwnnhlFdLJmdKKx4bZbIIRe5MXxnBbI9Xo+egrz7ijxCVqnjaQLVkGDaYa/IWV9Ys545UMJMzaoAyGAGhqaQpm7CuRgfUgDaAh9M6rgBDIs9cq+WYNed43jTSyQtadwX6yStSK5wO8nbWBIFjdRpeBpNLWYwl9QIx8QkziOaMAj5DQUuM81tw2S4SqVSWGDApbIoS4JTgEU8IMA4FjX1SBgZW2RttiEQvIEwTO8tJSUjM62feRxclLExhTJF/6GgwJc94yIsDk4Gj0U0Cu8KUyi5CPRh/MEdwNfXWLs6AI77/uR2C1Wj1r/VeHMm8V8ab4EZ0Niqxf76QrRf022FcyfCRNb9Fg7J+9YdjpKG0Rnk8fUyc1aje5RuIOCZOzq4u451/Bx1//AZcovYHarlK3Fq1HvYaqN8WZS5VPaRvWNMxtbLyaM16k5mPwh4H6DN7Wkj7++s8A73AFynQjxaGMRlftTKsCbrBxfCeH0SiHNx7ZJPU0oFoSFNLADCHUkltpqSRj5yStlVmM4cysoQ3oYaWojs3A9Ch3EAbnZSh3gJkMWII1UaK3Od55xPQmoF5iYF183c4QsFQMH6n2tq2StX1nuuA8zpXWcKvKCinGdlaW4DryKpEjbt65g3MeCKpxDdIjBDQ0hqsnIvGkdc569kIl5+eWHyZcADSls8pQyKH0ck47/dmu0QtOc3xgPCOlFMohHVmnZihJmsQu4oE6/sBL+ckiP9y3Hufo2WAMe1cXp7p2uuvbErhb/5u2ZoDQv3oYgzRS6XSj/Pmpnogl0Dfh/fwa/VIV2N1qn5joSWSeiExoVaAJuIdRzt5eXcLy9Xh6cPX/huGeXF68OX93fc7O8CJNCeshgHA2UCPNnqXDp+nTq22zA2//tw/ZDgQQPtLEaaki6ItJ3XRo7U7sHrb53hv2PhO1DcQMmw2P+E9eb7dM/qVFz6DwPhNL6ZWcMVJgSKcC/y6HF+kns/n1j93j9hX81ufwi4H0EMcwvllK3fKXyMQC14cP8u39NuthDruaGM6KAh3tiT5D6Acw97vzy/Obc5EJXtaHCGsREVb3gw286Nkh9Eo+8F/GgS8KbDYJvW23A386+qREF2PPzWm63263/waKNzXa",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,I={},C=[];function A(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(s(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,a.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(r(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,a.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(A,{...e})}):A(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.cf9a081c.js b/assets/js/c7e3ab5f.cf9a081c.js new file mode 100644 index 000000000..555ade2bb --- /dev/null +++ b/assets/js/c7e3ab5f.cf9a081c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>h,default:()=>g,frontMatter:()=>y,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1.1/deletecontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletecontact","permalink":"/docs/API-docs/v1.1/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV81uIzcSfpVaXpIR2pLscbJYneKdGBMjRsaIHRhYj2Gwm6VuRmySIaslC4KAHPYN9rTXfbR5kkWxfyTZnkkGuwiQi60u1u9XxariRpAso5jdiTfOkiwoivtMKIxF0J60s2ImbiqEb9EgIXRMcHZ1AdIYt4qwdg2Qg4C1WyJIKDqWeXA1H4aekju3GMPFPElYB8bZEgNYRAUSvAyki8bIgf+LCNrOXagl+5EBVTomw7VcYARNgDKu2bZqnaMKdYCAhQtqLDLhPIYke6HETLRMnW6RCS+DrJEwcPQbYWWNYia68wetRCY0R+8lVeIpJFfBLbVCcPnPWNCFAjcfAh8cEpkI+EujAyoxo9BgJiKtDZuJuvaGGfDRG6dQzObSRGYoKqylmG0ErX3ipKBtKTLRIrFPwUeZtMyEr07y6kRGJbbbe7YavbMRI+s5mU7536H/fR5bRxXEpigwxnljzPovIkswoCUWlN4bXSQcJz9Hlt4897LFgVENjDrp1nYPz0vx7Lz/+yP77r/zr8U26/KkzujTQifTk9dHx9Oj6V9vjr+enf5t9tXX4+l0+g+RicfasGyXUSUJWS9pMrvv7TO2NmX7jB1ly8ynL6F47WqkStsSVmgJVsHZMgNvUEYECmuQpdQWjCQM/0dUMQQXPo3O53m23YtaW6MtPvQl9HA6nT4cDyCcfryUrCOYu8aqPzbSF8x/OpzTh5MhnK+eh3Nhl9JolRrNjVug/WPD2TdPrfnntapbpnQuDoLdp7dBRiyaoGmdmtzjkfT6qD2f3d1zr+A6cbv+mBojVWImJl0/m2x2PXErWGFY9k2zCUbMREXk42wyidKq3D2OnUcbdWmNzOO4cPVEej1ZHo+PxTZ7KiO9/yx+bI4+VySSLLUtf0vufofVNeezTdkBYkPipNff41pkfUL2ubqxUaFUGFLyeIol4S5N7zzaa13alORk/Ol4uUVTuBp5lFCFMBr1Ih/++Z9BajQC5YqmRkupHMfv7Xv7rgng3QrDvDEgrYK5wUedG0xiWKezYWhHlLXBGM0atCUsgyQEpUtN0gDjxB2kkF7m2miuYmZz7VTfuwhxDLcVUoWBj74IvAYoXKLh4gfZkOMZbsvBX1i5sJjz+pCBhLyJ2mKMgLaStmDGPhMZuADSAlrC4IOOCJECe61b35ylwNe/llaWyLoz2AdLodFcrhBc3kSC6EyTXAaS2riACvqAeBGJCcRzHsoBoV1eah+w4rJZIpSNVhgzKJxCiOnScghWQY6RwLMvusDIShtrXLFICeS5Ct5xD9HS8LKw7yOLU5A28ohvfelzMADmg+MBja2Do9FPETnDl9ou4mw0em+P4G6oq1vMoya8/7K/AqvV6lnpvzqUeavpuyaHH9G7qMmF9U661FQ1ebou+0qGj1bTW7SY6mfvMux0KFfE57ePqZMKjZ9cI3GFxMnZ1UVqu6/gw6//gkuUwULlVm21Fk1As4ayN8XItZlvYRu6JsxdKryKES/a4uNdDCP1CN5Wkj78+u8IP+AKtO2uFIcyGl01udEF3GDteUTG0WgGbwKySeppQJUkKKSFHCFWkktpqSWvsq200XYxhjO7hiZigJWmKhUD05PcQRiMy5DuCLmMqMDZJNHbHO88Ynod0Swxsi6efjkCKs3bHFXBNWVrbd+ZLriAc20M3GpVIqXYzpQC35FXLTmtsTt3cM4XgipcgwwIES2N4eqJSDppvHeBvdCt83PH7wROAFrlnbYUZ6CCnNNOf7Yr9IJhTvv+M1ILoRzgyDo1Q0ram9hFPFDH77kpP2nkh/024BwDG0xh7/LidVdOd31ZAlfr/1LWPK/7RwivBLXUpp0o3zzVk0Y7hjq+m19jWOoCu6n2kRs9ScwTkQmjC7QR91aGs7dXl7B8PZ6KbG88/o7LPbm8eHP+w/U5O8ONtAXseDwdT5nkXaRa2j1Lhy/Fp6Nts9ul/rTvym4JIHykiTdSpx0sgbrplqc7sXtnzvaelPeZqFwkZths+Ir/FMx2y+RfGgy8o91nYimDljlvCncboXTk32p4IH4UzS9/7N6ar+D3vk5fDKRfcSzvN0tpGv4SmVjg+vB9vL3fZv2aw662DGdFgZ72RJ8tzAdb57fnl+c35yIT3KwPN6xF2rC6H2zgRc8OV6/WB/7Le+CLAptNu71ttwN/e/RRiS7Gnpthut9ut/8FkbgOLw==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var a=o(74848),i=o(28453),c=o(33617),r=o.n(c),l=o(17543),s=o.n(l),d=o(86013),p=o.n(d),m=o(63723),u=o.n(m),v=(o(18766),o(79329),o(9303));const y={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV81uIzcSfpVaXpIR2pLscbJYneKdGBMjRsaIHRhYj2Gwm6VuRmySIaslC4KAHPYN9rTXfbR5kkWxfyTZnkkGuwiQi60u1u9XxariRpAso5jdiTfOkiwoivtMKIxF0J60s2ImbiqEb9EgIXRMcHZ1AdIYt4qwdg2Qg4C1WyJIKDqWeXA1H4aekju3GMPFPElYB8bZEgNYRAUSvAyki8bIgf+LCNrOXagl+5EBVTomw7VcYARNgDKu2bZqnaMKdYCAhQtqLDLhPIYke6HETLRMnW6RCS+DrJEwcPQbYWWNYia68wetRCY0R+8lVeIpJFfBLbVCcPnPWNCFAjcfAh8cEpkI+EujAyoxo9BgJiKtDZuJuvaGGfDRG6dQzObSRGYoKqylmG0ErX3ipKBtKTLRIrFPwUeZtMyEr07y6kRGJbbbe7YavbMRI+s5mU7536H/fR5bRxXEpigwxnljzPovIkswoCUWlN4bXSQcJz9Hlt4897LFgVENjDrp1nYPz0vx7Lz/+yP77r/zr8U26/KkzujTQifTk9dHx9Oj6V9vjr+enf5t9tXX4+l0+g+RicfasGyXUSUJWS9pMrvv7TO2NmX7jB1ly8ynL6F47WqkStsSVmgJVsHZMgNvUEYECmuQpdQWjCQM/0dUMQQXPo3O53m23YtaW6MtPvQl9HA6nT4cDyCcfryUrCOYu8aqPzbSF8x/OpzTh5MhnK+eh3Nhl9JolRrNjVug/WPD2TdPrfnntapbpnQuDoLdp7dBRiyaoGmdmtzjkfT6qD2f3d1zr+A6cbv+mBojVWImJl0/m2x2PXErWGFY9k2zCUbMREXk42wyidKq3D2OnUcbdWmNzOO4cPVEej1ZHo+PxTZ7KiO9/yx+bI4+VySSLLUtf0vufofVNeezTdkBYkPipNff41pkfUL2ubqxUaFUGFLyeIol4S5N7zzaa13alORk/Ol4uUVTuBp5lFCFMBr1Ih/++Z9BajQC5YqmRkupHMfv7Xv7rgng3QrDvDEgrYK5wUedG0xiWKezYWhHlLXBGM0atCUsgyQEpUtN0gDjxB2kkF7m2miuYmZz7VTfuwhxDLcVUoWBj74IvAYoXKLh4gfZkOMZbsvBX1i5sJjz+pCBhLyJ2mKMgLaStmDGPhMZuADSAlrC4IOOCJECe61b35ylwNe/llaWyLoz2AdLodFcrhBc3kSC6EyTXAaS2riACvqAeBGJCcRzHsoBoV1eah+w4rJZIpSNVhgzKJxCiOnScghWQY6RwLMvusDIShtrXLFICeS5Ct5xD9HS8LKw7yOLU5A28ohvfelzMADmg+MBja2Do9FPETnDl9ou4mw0em+P4G6oq1vMoya8/7K/AqvV6lnpvzqUeavpuyaHH9G7qMmF9U661FQ1ebou+0qGj1bTW7SY6mfvMux0KFfE57ePqZMKjZ9cI3GFxMnZ1UVqu6/gw6//gkuUwULlVm21Fk1As4ayN8XItZlvYRu6JsxdKryKES/a4uNdDCP1CN5Wkj78+u8IP+AKtO2uFIcyGl01udEF3GDteUTG0WgGbwKySeppQJUkKKSFHCFWkktpqSWvsq200XYxhjO7hiZigJWmKhUD05PcQRiMy5DuCLmMqMDZJNHbHO88Ynod0Swxsi6efjkCKs3bHFXBNWVrbd+ZLriAc20M3GpVIqXYzpQC35FXLTmtsTt3cM4XgipcgwwIES2N4eqJSDppvHeBvdCt83PH7wROAFrlnbYUZ6CCnNNOf7Yr9IJhTvv+M1ILoRzgyDo1Q0ram9hFPFDH77kpP2nkh/024BwDG0xh7/LidVdOd31ZAlfr/1LWPK/7RwivBLXUpp0o3zzVk0Y7hjq+m19jWOoCu6n2kRs9ScwTkQmjC7QR91aGs7dXl7B8PZ6KbG88/o7LPbm8eHP+w/U5O8ONtAXseDwdT5nkXaRa2j1Lhy/Fp6Nts9ul/rTvym4JIHykiTdSpx0sgbrplqc7sXtnzvaelPeZqFwkZths+Ir/FMx2y+RfGgy8o91nYimDljlvCncboXTk32p4IH4UzS9/7N6ar+D3vk5fDKRfcSzvN0tpGv4SmVjg+vB9vL3fZv2aw662DGdFgZ72RJ8tzAdb57fnl+c35yIT3KwPN6xF2rC6H2zgRc8OV6/WB/7Le+CLAptNu71ttwN/e/RRiS7Gnpthut9ut/8FkbgOLw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,k={},f=[];function b(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(r(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,a.jsx)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(s(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/d0524430.5aa106b8.js b/assets/js/d0524430.5aa106b8.js new file mode 100644 index 000000000..f362b59ea --- /dev/null +++ b/assets/js/d0524430.5aa106b8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>N,default:()=>M,frontMatter:()=>u,metadata:()=>o,toc:()=>v});const o=JSON.parse('{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/v1.1/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/save-update-webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWc1uIzcSfpUKB9jdCG3JnjjAQqcojnYirH8EW4axsAwP1V1SM6bIDsmWLAgCctg32NNe82jzJEGR3a2W7NFkZgJjMNBFP2RVsX4+FsmqJXN8Yln7lt3gKNX6gd1FLEEbG5E5oRVrs0GKYPkMQRvIs4Q7hIIWOv0ecCn13MJC5+B0IOQwLwiuL09hnoo4BWEht5gQjTNiMkEDOEPlbHOohurVq1fQ9X/b9LfROGrCTOAck3ajMVQHcJOiAg5WTBQaP2WBQ6LjfIrKReBSYYNAmAspyzWaQ/X27duhWg4VwJB5giFrw5AF6UMWhRm3yDBM/HRxcn3WPR/cD/7T71bzevQLxq6XbNH0fqooxkJuS7i+PK2mFZ9uT593ztYLKO2K+b5EbhEMkorAVeKtDhaWBldstVAF7momuMrS6C2NACzD16Y2V703593Lui6BAqdcyA2S7lmnd7pBk6VabYrp/3xx3h2yQLKir7tCneDvHxfvFVmSdIoADXpn3atB56xfzccGuXuWYKhWRaAJO6+bUJBugqd0HmGxIPgE4BSce+S8FHL+TNh3xRhcanQ+ScGlCInhYwcOp5mkRNbp9/YQ+MIgUKPJTU1K7/xNcMonYoRSw3fNcITsyAxhHkaL6rj5BIQEIV89QGiwAMaHYPFhUHwgK6zqK/8Fp8RxE2I9zSTuPCdqaJCywIP9lJRRLvXVY+LLOTfQODEWMS/NPOleDnr/6p10Bt0NR1Wx+XxQfd+EBGMpdmaYkuIzc0wpZo+ol0JU6fGdt9iS6PPAxCKmMzScnNJLWJvRw+pv4flVvtQiZvDXHK37UScL1l5uvdv6Rs9EgpAbSa+usCqsmWOtHCpHjDzLJG0UoVXrF0vcS2bjFKecftEqwmBCr8RrI+mFSFBj7QJRLGKZIW2dQEsMuZH0VRBZZ4SasIiNtZlyVx/BR05bj7VZ6lxm263WQufmoHg9HuRG/lCQNGM9ZatVxJxwnqGguR+R7asVTRm0mVY26PD68PCpS67yOEZrx7mEyrsf44ndZhu0uXTPWb62s3w5h0gmYCuN5OKbDQOFIhjdl0bdvz48vP9nYenxs8bpKbpUqAnMfRIxWk0iyMJOdGYBfMKFArr3mm/+OqvRGG12G/1xmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXG90/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6KHvODj2Wxjk+EmnyI727tnCsKYIjRhouqSPFM/BsXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQqNRsrz77+8VV6NRXXU8jn2h8yI3kOk5GjqD6F40lvgoRtKXIgCnfm5dTUU+lWitXIBQDieGTvBETITj4TFCOTXmGR8JKQj+RKaJ20BtB9kmXUNdioam/m6oQpvgDCXtGuC501PuSFR1S51r8zCmum4EHEa5FQqtBVQpVzERlhGNqCjMFaByaDIjLIJ1hrQWQTetnOGxgylXfIKhVlt3VoJSEOzB6FFuHVgtc68yOC6kNqFi7A1SiEmoFncfM5oCGqXLu8GU4DdDmOQiQRtBrBMqWlOUyQSVwAitg4x0ETFaEporqeMHH0A6fiHTlHwEl6DHGzoSuzNcWbrABF3KGFQOy4ymcxyDgo3GtUWK8KlQD7Z4CdxWuLrBkRUO7/5RInQ+nz/ZQt9u8rwR7ud8BJeYaSucNos190S4NB/5bVcXUv0Jkt6gQo+f2qZay0h0bJ/uYhptpSiz1hU6Qohtdfo9n6+/hXe//Q9OkRsFqZ4HtMa5QbmASbkUeS5EPritSrcw1h54KXk8DuArLrOlB29S7t799n8L5zgHoYotRaY0Gv18JEUMg6KMZxuNNpyE+21Z2rPgUu4g5gpGCDblBKWZ4MAhC9xSqIcmdNSCGhMG5sKFEiGNe74NM/z7pQy3hRGnZoZWnqNcs7nWiManFuUMLcmiQ3OEgInYLkjWlSmMMzimB+CNSCbovG2dJIGsGJ6HYXJ4TR0c04ZwKS6AGwSLyjWhv8XiZ/Is04a0EEH5saYGDgUAVZJpQT2YokxayY/WQPfPCKHVM0PBhbxyR7RVbS12YmFxNdr0r52tA2Ez3xoco6EFvdnruGSigNNtCUsgtH4OrOlAoKzFY38P8U/IcDL9sC3H3wnQTO3F+ArNTMTlQ+Y9O7rliVssYlLEqCzW7hqdN/1TmH3XPGRR7fT6E5u7ddo76Z5fdUkZSqTBYUfNw+YhDdF1Y8pVbaWropV3vdHK2z7iluvL2L4BuC+e7BuA++7PvgG4h8C+AbhvAO4bgPsG4JeXNPYNwD2ivrIGYFEUdfjoWpnkwhehi95aqB/flm0w6smlVFlu37LlkooT10auVjT8a46GytJ3EZtxI/iIapy3d6uoLKVSwfkBF6zNTsKT72BACxO5zENVdqsWT7XgwNGJY8zcTtp68bt/cTVgERsV/cqpTojH8Dn1MvmctZnve/oCoO+o0diSSa4mOZ8QbZBJ1V+qHm2Wjh986bj4QVaVU2pR03CzphzMoE8y6lmG5TKUpVerij5MvZejcGxJTYG7W61WfwAQ6xsX","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"}}');var i=t(74848),s=t(28453),r=t(33617),a=t.n(r),d=t(17543),l=t.n(d),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),E=(t(18766),t(79329),t(9303));const u={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1uIzcSfpUKB9jdCG3JnjjAQqcojnYirH8EW4axsAwP1V1SM6bIDsmWLAgCctg32NNe82jzJEGR3a2W7NFkZgJjMNBFP2RVsX4+FsmqJXN8Yln7lt3gKNX6gd1FLEEbG5E5oRVrs0GKYPkMQRvIs4Q7hIIWOv0ecCn13MJC5+B0IOQwLwiuL09hnoo4BWEht5gQjTNiMkEDOEPlbHOohurVq1fQ9X/b9LfROGrCTOAck3ajMVQHcJOiAg5WTBQaP2WBQ6LjfIrKReBSYYNAmAspyzWaQ/X27duhWg4VwJB5giFrw5AF6UMWhRm3yDBM/HRxcn3WPR/cD/7T71bzevQLxq6XbNH0fqooxkJuS7i+PK2mFZ9uT593ztYLKO2K+b5EbhEMkorAVeKtDhaWBldstVAF7momuMrS6C2NACzD16Y2V703593Lui6BAqdcyA2S7lmnd7pBk6VabYrp/3xx3h2yQLKir7tCneDvHxfvFVmSdIoADXpn3atB56xfzccGuXuWYKhWRaAJO6+bUJBugqd0HmGxIPgE4BSce+S8FHL+TNh3xRhcanQ+ScGlCInhYwcOp5mkRNbp9/YQ+MIgUKPJTU1K7/xNcMonYoRSw3fNcITsyAxhHkaL6rj5BIQEIV89QGiwAMaHYPFhUHwgK6zqK/8Fp8RxE2I9zSTuPCdqaJCywIP9lJRRLvXVY+LLOTfQODEWMS/NPOleDnr/6p10Bt0NR1Wx+XxQfd+EBGMpdmaYkuIzc0wpZo+ol0JU6fGdt9iS6PPAxCKmMzScnNJLWJvRw+pv4flVvtQiZvDXHK37UScL1l5uvdv6Rs9EgpAbSa+usCqsmWOtHCpHjDzLJG0UoVXrF0vcS2bjFKecftEqwmBCr8RrI+mFSFBj7QJRLGKZIW2dQEsMuZH0VRBZZ4SasIiNtZlyVx/BR05bj7VZ6lxm263WQufmoHg9HuRG/lCQNGM9ZatVxJxwnqGguR+R7asVTRm0mVY26PD68PCpS67yOEZrx7mEyrsf44ndZhu0uXTPWb62s3w5h0gmYCuN5OKbDQOFIhjdl0bdvz48vP9nYenxs8bpKbpUqAnMfRIxWk0iyMJOdGYBfMKFArr3mm/+OqvRGG12G/1xmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXG90/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6KHvODj2Wxjk+EmnyI727tnCsKYIjRhouqSPFM/BsXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQqNRsrz77+8VV6NRXXU8jn2h8yI3kOk5GjqD6F40lvgoRtKXIgCnfm5dTUU+lWitXIBQDieGTvBETITj4TFCOTXmGR8JKQj+RKaJ20BtB9kmXUNdioam/m6oQpvgDCXtGuC501PuSFR1S51r8zCmum4EHEa5FQqtBVQpVzERlhGNqCjMFaByaDIjLIJ1hrQWQTetnOGxgylXfIKhVlt3VoJSEOzB6FFuHVgtc68yOC6kNqFi7A1SiEmoFncfM5oCGqXLu8GU4DdDmOQiQRtBrBMqWlOUyQSVwAitg4x0ETFaEporqeMHH0A6fiHTlHwEl6DHGzoSuzNcWbrABF3KGFQOy4ymcxyDgo3GtUWK8KlQD7Z4CdxWuLrBkRUO7/5RInQ+nz/ZQt9u8rwR7ud8BJeYaSucNos190S4NB/5bVcXUv0Jkt6gQo+f2qZay0h0bJ/uYhptpSiz1hU6Qohtdfo9n6+/hXe//Q9OkRsFqZ4HtMa5QbmASbkUeS5EPritSrcw1h54KXk8DuArLrOlB29S7t799n8L5zgHoYotRaY0Gv18JEUMg6KMZxuNNpyE+21Z2rPgUu4g5gpGCDblBKWZ4MAhC9xSqIcmdNSCGhMG5sKFEiGNe74NM/z7pQy3hRGnZoZWnqNcs7nWiManFuUMLcmiQ3OEgInYLkjWlSmMMzimB+CNSCbovG2dJIGsGJ6HYXJ4TR0c04ZwKS6AGwSLyjWhv8XiZ/Is04a0EEH5saYGDgUAVZJpQT2YokxayY/WQPfPCKHVM0PBhbxyR7RVbS12YmFxNdr0r52tA2Ez3xoco6EFvdnruGSigNNtCUsgtH4OrOlAoKzFY38P8U/IcDL9sC3H3wnQTO3F+ArNTMTlQ+Y9O7rliVssYlLEqCzW7hqdN/1TmH3XPGRR7fT6E5u7ddo76Z5fdUkZSqTBYUfNw+YhDdF1Y8pVbaWropV3vdHK2z7iluvL2L4BuC+e7BuA++7PvgG4h8C+AbhvAO4bgPsG4JeXNPYNwD2ivrIGYFEUdfjoWpnkwhehi95aqB/flm0w6smlVFlu37LlkooT10auVjT8a46GytJ3EZtxI/iIapy3d6uoLKVSwfkBF6zNTsKT72BACxO5zENVdqsWT7XgwNGJY8zcTtp68bt/cTVgERsV/cqpTojH8Dn1MvmctZnve/oCoO+o0diSSa4mOZ8QbZBJ1V+qHm2Wjh986bj4QVaVU2pR03CzphzMoE8y6lmG5TKUpVerij5MvZejcGxJTYG7W61WfwAQ6xsX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},N=void 0,g={},v=[{value:"Events:",id:"events",level:3}];function I(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(E.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,i.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(E.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function M(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/d0524430.6f5015ca.js b/assets/js/d0524430.6f5015ca.js deleted file mode 100644 index 92e53c943..000000000 --- a/assets/js/d0524430.6f5015ca.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>T,frontMatter:()=>I,metadata:()=>s,toc:()=>N});const s=JSON.parse('{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/v1.1/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/save-update-webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWdtuIzcS/ZUKB9jdCG3JnjjAQk9RHO1EWF8ES4axsAwP1V1SM6LIDsmWLAgC8rB/sE/7mk+bLwmK7G5d7NFkZgJjMNCLLmRVsS6HRbJqyRwfW9a8Y7c4TLWesPuIJWhjIzIntGJN1k8RLJ8haAN5lnCHUNBCq9sBLqWeW1joHJwOhBzmBcHN9TnMUxGnICzkFhOicUaMx2gAZ6icrQ/UQL169Qra/m+T/tZqJ3WYCZxj0qzVBuoIblNUwMGKsULjpyxwSHScT1G5CFwqbBAIcyFluUZ9oN6+fTtQy4ECGDBPMGBNGLAgfcCiMOMWGYaJn67Obi7al/2H/n+67WpeD3/B2HWSHZrOTxXFSMhdCTfX59W04tPd6cvWxXoBpV0x35XILYJBUhG4SrzVwcLS4IptI1SBu5oJrrI0ekcjAMvwta1Nr/Pmsn29qUugwCkXcoukfdHqnG/RZKlW22K6P19dtgcskKzo675QJ/j7x8V7RZYkrSJA/c5Fu9dvXXSr+dggd88SDNSqCDRh53UdCtJt8JTOIywWBJ8AnILzgJyXQs6fCfu+GINLjc7HKbgUITF85MDhNJOUyFrdzgECXxgENmhysyGlc/kmOOUTMUKp4bt6OEL2ZIYwD8NFddx8AkKCkK8eIDRYAONDsPgwKD6QFVabK/8Fp8RpHWI9zSTuPSc20CBlgQf7KSmjXOqrx8SXc26gcWIkYl6aeda+7nf+1Tlr9dtbjqpi8/mg+r4OCcZS7M0wJcVn5phSzAFRL4Wo0uN7b7El0eeBiUVMZ2g4OaWTsCajh9XfwvOrfKlFzOCvOVr3o04WrLncebd1jZ6JBCE3kl5dYVVYM8daOVSOGHmWSdooQqvGL5a4l8zGKU45/aJVhMGEXok3RtILkaDGmgWiWMQyQ9o6gZYYciPpqyCyzgg1ZhEbaTPlbnMEHzltPdZkqXOZbTYaC52bo+L1eJQb+UNBUo/1lK1WEXPCeYaC5mFItq9WNGXQZlrZoMPr4+OnLunlcYzWjnIJlXc/xhP7zTZoc+mes3xtZ/lyDpFMwFYaycU3WwYKRTB6KI16eH18/PDPwtLTZ43TU3SpUGOY+yRitBpHkIWd6MwC+JgLBXTvNd/8dVajMdrsN/rjNNvnhNPj44eTygknT51Q+ddI4NIgTxaAj8I6+7Im79Njv4EnD/PKwNOnBt5YNKC0g5HOVfKyRu2uvd+Q08qM75+a0VEzLkXiK0h9PUH1spZsLu/C8qTq49QnLjpZvEmeyM+zLVM3x4ORFuPcCLdgzbslezzimTgK8827+9V9xGgDaMrjmbZeY+5S1mSNeZWOLZoZGusF7GzsOaebwM/50Ovbyp2GCx1PglE+2Vb5cyaMC5LqNrCl+ZCSZ6NrOGWZSz6bcNPQGarGSf24fsxW0XJHiOUqGerHOhHRESz50HoZPBON2Un95BkenmUfRY/50ceyWMfHQo0/xHe/jkaPEBNAsRWTCho8E//GBYvKkG9SRUyQ91PkCRoPDwLi9frIbZdw2lV0/yFGckfaK1EA6ipD1aP7EYXXG7Fbg71FGesp+uppilCrlSzv/vt7xVWrVXcrv3F8ZfUqN5DpORo69OgiNpL4KIbS1z4Ap35uXb5FPpVorVyAUA7Hhq4MiRgLx8Prh5J4zDM+FFLQfiMyTdwGNrasrdO916VoaOrvhkrCCc5Q0jYFnjs95Y5EVdfiuTaTERWSI+AwzK1QaC2gSrmKibCMaERVaK4AlUOTGWERrDOktQi6aeUMjx1MueJjDMXhTWclKAXtMzB6mFsHVsvcqwyOC6lNKFF7gxRiEsrT7ceMpoBG6bVgMCX4zRDGuUjQRhDrhKrkFGUyQSUwROsgI11EjJaE5krqeOIDSDsRMk3ZTnAJerSlI7E7w5WlG1PQpYxB5bDMaLo4YFCwVruxSBE+F2pii6fHXYWrWxxa4fD+HyVC5/P5ky307TbPG+Eo41xjpq1w2izW3GPhyqyyKaT6EyS9QYUePxubai0j0bF9uotptJGizBo9dIQQ22h1O/6A+Bbe/fY/OEduFKR6HtAa5wblAsblUuS5EPngtiq/w0h74KXk8TiAr7g9lx68Tbl799v/LVziHIQqthSZUqt186EUMfSLuqGt1ZpwFi7UZS3Rgku5g5grGCLYlBOUZoIDhyxwS6EmdWipBXVCDMyFCzVJGvd8W2b4B1MZbgtDTt0TrTxHuWZ9rRGNTy3KGVqSRaf0EAETsVsB3VSmMM7giF6ctyIZo/O2tZIEsmJ4HobJ4Rvq4Ig2hEtxAdwgWFSuDt0dFj+TZ5k2pIUIyo80dYwoAKiSTAtq+hR12Up+tAa6f7cIrZ4ZCi7klTuinfJusRMLi6vRun9e7RwI2/nW4AgNLejNXsclEwWc7kpYAqH1c2BNBwJlLR77i49/s4aT6YddOf4SgmZqr0Y9NDMRly+n9+zohidusIhJEaOyuHG5ab3pnsPsu/rx1hXiT2zuxnnnrH3Za5MylEiDw8qrhL/fTLnaWKlX9A5vtnqHu0fccn37O3QcD9WaQ8fx0G46dBwPEDh0HA8dx0PH8dBx/PKSxqHjeEDUV9ZxLIqiDh9dI5Nc+Kp30cwLBeu7su9GTcCUStnNO7ZcUnHixsjVioZ/zdFQHfw+YjNuBB9SjfPufhWVpVSqcE9wwZrsLDz5jvq0MJHLPFRld4r/VAsOHK04xsztpd2stneven0WsWHRIJ3qhHgMn1PzlM9Zk/lGqy8A+hYejS2Z5Gqc8zHRBplU/aXq0XbpeOJLx8UPsqqcUosNDbdrysEM+iSjnmVYLkNZerWq6MPUezkKx5bUFLj71Wr1B2V0QsI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"}}');var i=t(74848),r=t(28453),o=t(33617),a=t.n(o),d=t(17543),l=t.n(d),c=t(86013),p=t.n(c),h=t(63723),E=t.n(h),M=(t(18766),t(79329),t(9303));const I={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWdtuIzcS/ZUKB9jdCG3JnjjAQk9RHO1EWF8ES4axsAwP1V1SM6LIDsmWLAgC8rB/sE/7mk+bLwmK7G5d7NFkZgJjMNCLLmRVsS6HRbJqyRwfW9a8Y7c4TLWesPuIJWhjIzIntGJN1k8RLJ8haAN5lnCHUNBCq9sBLqWeW1joHJwOhBzmBcHN9TnMUxGnICzkFhOicUaMx2gAZ6icrQ/UQL169Qra/m+T/tZqJ3WYCZxj0qzVBuoIblNUwMGKsULjpyxwSHScT1G5CFwqbBAIcyFluUZ9oN6+fTtQy4ECGDBPMGBNGLAgfcCiMOMWGYaJn67Obi7al/2H/n+67WpeD3/B2HWSHZrOTxXFSMhdCTfX59W04tPd6cvWxXoBpV0x35XILYJBUhG4SrzVwcLS4IptI1SBu5oJrrI0ekcjAMvwta1Nr/Pmsn29qUugwCkXcoukfdHqnG/RZKlW22K6P19dtgcskKzo675QJ/j7x8V7RZYkrSJA/c5Fu9dvXXSr+dggd88SDNSqCDRh53UdCtJt8JTOIywWBJ8AnILzgJyXQs6fCfu+GINLjc7HKbgUITF85MDhNJOUyFrdzgECXxgENmhysyGlc/kmOOUTMUKp4bt6OEL2ZIYwD8NFddx8AkKCkK8eIDRYAONDsPgwKD6QFVabK/8Fp8RpHWI9zSTuPSc20CBlgQf7KSmjXOqrx8SXc26gcWIkYl6aeda+7nf+1Tlr9dtbjqpi8/mg+r4OCcZS7M0wJcVn5phSzAFRL4Wo0uN7b7El0eeBiUVMZ2g4OaWTsCajh9XfwvOrfKlFzOCvOVr3o04WrLncebd1jZ6JBCE3kl5dYVVYM8daOVSOGHmWSdooQqvGL5a4l8zGKU45/aJVhMGEXok3RtILkaDGmgWiWMQyQ9o6gZYYciPpqyCyzgg1ZhEbaTPlbnMEHzltPdZkqXOZbTYaC52bo+L1eJQb+UNBUo/1lK1WEXPCeYaC5mFItq9WNGXQZlrZoMPr4+OnLunlcYzWjnIJlXc/xhP7zTZoc+mes3xtZ/lyDpFMwFYaycU3WwYKRTB6KI16eH18/PDPwtLTZ43TU3SpUGOY+yRitBpHkIWd6MwC+JgLBXTvNd/8dVajMdrsN/rjNNvnhNPj44eTygknT51Q+ddI4NIgTxaAj8I6+7Im79Njv4EnD/PKwNOnBt5YNKC0g5HOVfKyRu2uvd+Q08qM75+a0VEzLkXiK0h9PUH1spZsLu/C8qTq49QnLjpZvEmeyM+zLVM3x4ORFuPcCLdgzbslezzimTgK8827+9V9xGgDaMrjmbZeY+5S1mSNeZWOLZoZGusF7GzsOaebwM/50Ovbyp2GCx1PglE+2Vb5cyaMC5LqNrCl+ZCSZ6NrOGWZSz6bcNPQGarGSf24fsxW0XJHiOUqGerHOhHRESz50HoZPBON2Un95BkenmUfRY/50ceyWMfHQo0/xHe/jkaPEBNAsRWTCho8E//GBYvKkG9SRUyQ91PkCRoPDwLi9frIbZdw2lV0/yFGckfaK1EA6ipD1aP7EYXXG7Fbg71FGesp+uppilCrlSzv/vt7xVWrVXcrv3F8ZfUqN5DpORo69OgiNpL4KIbS1z4Ap35uXb5FPpVorVyAUA7Hhq4MiRgLx8Prh5J4zDM+FFLQfiMyTdwGNrasrdO916VoaOrvhkrCCc5Q0jYFnjs95Y5EVdfiuTaTERWSI+AwzK1QaC2gSrmKibCMaERVaK4AlUOTGWERrDOktQi6aeUMjx1MueJjDMXhTWclKAXtMzB6mFsHVsvcqwyOC6lNKFF7gxRiEsrT7ceMpoBG6bVgMCX4zRDGuUjQRhDrhKrkFGUyQSUwROsgI11EjJaE5krqeOIDSDsRMk3ZTnAJerSlI7E7w5WlG1PQpYxB5bDMaLo4YFCwVruxSBE+F2pii6fHXYWrWxxa4fD+HyVC5/P5ky307TbPG+Eo41xjpq1w2izW3GPhyqyyKaT6EyS9QYUePxubai0j0bF9uotptJGizBo9dIQQ22h1O/6A+Bbe/fY/OEduFKR6HtAa5wblAsblUuS5EPngtiq/w0h74KXk8TiAr7g9lx68Tbl799v/LVziHIQqthSZUqt186EUMfSLuqGt1ZpwFi7UZS3Rgku5g5grGCLYlBOUZoIDhyxwS6EmdWipBXVCDMyFCzVJGvd8W2b4B1MZbgtDTt0TrTxHuWZ9rRGNTy3KGVqSRaf0EAETsVsB3VSmMM7giF6ctyIZo/O2tZIEsmJ4HobJ4Rvq4Ig2hEtxAdwgWFSuDt0dFj+TZ5k2pIUIyo80dYwoAKiSTAtq+hR12Up+tAa6f7cIrZ4ZCi7klTuinfJusRMLi6vRun9e7RwI2/nW4AgNLejNXsclEwWc7kpYAqH1c2BNBwJlLR77i49/s4aT6YddOf4SgmZqr0Y9NDMRly+n9+zohidusIhJEaOyuHG5ab3pnsPsu/rx1hXiT2zuxnnnrH3Za5MylEiDw8qrhL/fTLnaWKlX9A5vtnqHu0fccn37O3QcD9WaQ8fx0G46dBwPEDh0HA8dx0PH8dBx/PKSxqHjeEDUV9ZxLIqiDh9dI5Nc+Kp30cwLBeu7su9GTcCUStnNO7ZcUnHixsjVioZ/zdFQHfw+YjNuBB9SjfPufhWVpVSqcE9wwZrsLDz5jvq0MJHLPFRld4r/VAsOHK04xsztpd2stneven0WsWHRIJ3qhHgMn1PzlM9Zk/lGqy8A+hYejS2Z5Gqc8zHRBplU/aXq0XbpeOJLx8UPsqqcUosNDbdrysEM+iSjnmVYLkNZerWq6MPUezkKx5bUFLj71Wr1B2V0QsI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,g={},N=[{value:"Events:",id:"events",level:3}];function S(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(M.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,i.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(M.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,i.jsx)(E(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function T(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(S,{...e})}):S(e)}}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.2025796d.js b/assets/js/d480dde9.2025796d.js deleted file mode 100644 index a7836d32c..000000000 --- a/assets/js/d480dde9.2025796d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3230],{94677:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>S,contentTitle:()=>u,default:()=>q,frontMatter:()=>W,metadata:()=>s,toc:()=>k});const s=JSON.parse('{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.1/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-webhook","permalink":"/docs/API-docs/v1.1/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uGzcQfpUJL22EtVZJ00N1qpEYqVE3MWoHPthCwN0d7TLikiyHK1kQBOTQN+ip1z5anqQYUqs/J2nTFr1I8vz/fDMcr0SQNYnxrbjBorF2JiaZqJBKr1xQ1oixuG4QXqDGgLCRgdPLc5Ba2wUsbQfBQpX4iw2/81pkwjr0ko2cV2IskkjvJRMeyVlDSGK8Ek9HI/46dHzVlSUSTTsNW1MiE6U1AU1geemcVmVk5O+IlVaCygZbyb/C0qEYC1u8wzKITDjPZoJKLj1Sp8OeHAWvTC0ygfeydZpJfb4p9gpoG5FePhLrdSaCClFSGa0Mvu2Tevt0NHr7nVivWebZ6NnD5N4QejA2wNR2pnr03+WF3lv/+bSOfX8uEQ6+T+Pbh2mcm7nUqoqIuLYzNP9vJvvuQ3LPod63mvWMbFNKUSjyxUGq+/SUJGHZeRWWYny7Evcn0qmTxB/fTtaTTLQYGruDM8csQyPGIl9skU3o5+gpmjhC9ELWNfofuiJGfNoFCz/ZcpbS4qkZiyYER+M8nysfkqUhJbWmK4albfNLLxmBr+R8Jn1uHZr8yXA0HIl1tjoyQtJUhb0fshCp2mhZULQhncrnT4ZPPqIjnfsieexOvlSFgqyVqf9Kb7LrxxVjJsHioCtbcEinfsSlyPqm70tlQnH1G5QV+ggQZaY2Km+g8NqhuVK1iW2Jzo+34A3q0rbIyy40CINBr/Lh1z+2WoMBVLbsWjQhQn54Z+7M686Dswv0vMikqWCq8V4VGqMatpFH/SYllK1GIr0EZQLWXgaEStUqSA1cJ2VqKKWThdKKJ4XFLGt72Bs2GsJNg6FBz6yvPIKECueoecBAdsG2MrCpPl5YWD+barugDCQUHSmDRICmkaZkwb4TGVgP0gCagN55RQgUPEetUmzWBC/LAK00ska2ncF+sSrUiucDvC06CkBWdzFkCFJp67GCPiGDWFEs4tm9YxYwtbSt89gwbOYIdacqpAxKWyFQXAycgqmgQArgOBZVIrHRzmhbzmIDeYLAWd5TSmqw04MYWT14aWhqfZti6XuwLZjzlh8DTAEOBm8IucMXysxoPBjcmRO43eLqBgtSASdf9yOwWCweQP/xoc5LFXhT/IzOkgrWL3fatQr9Ntg3sv0jWXqJBiN+9oZhZ6OyJT2cPqbmDWqXX2FghFB+enkeV/tj+PD+N7hA6Q00dpHQWnYe9RLq3hVXLnU+lW27mWFqI/AarniZwOfxlw4p9BW8aWT48P53gle4AGU2I8WpDAaXXaFVCdfYOi0D0mAwhuce2WXoaRAaGaCUBgoEaiRDaa4kSHBJWyszG8KpWULHT+BChSaCgelR7yANrsu23QSFJKzAmqjR+xzuImJ6S6jnSGyL39cCASvFl0NovO3q5G0/mE1yHqdKa7hRVY0h5nZaVeA25EUix0NrFw5OeSBCg0uQHoHQhCFcHqlETuec9RyFSsFPLd9u3AA0lbPKBBpD5eU07OxnO6CXXGZlzUdIqYRyW45sY2bbkjSJm4y31OEdL+WjRX64bz1O0bPDmPauL05t4HTbwxIYrf8G1nwT8NaSZTxZsJVKpxfl+2M78XxA39Lr6RX6uSpx86p9YqLzKJyLTGhVoiHcO0tOX15ewPyb4ejg6f8bw51fnD8/e3V1xsHwIk0F608A4SyFVpo9T4fX+/HTttrda//81t+8wgHvQ+60VPHQilmtNhfSrVjs/sNoLAUmrVY8VW+8Xq+Z/EuHnk+vSSbm0itZ8ON8O1ln/dvNJ9UMl1y9skTHN+Nc6i4dAEeX5sG59uLs4uz6TGSCN9Dh2TCLZ8PmBzvoWWa5Z/7wnkgx8CcfNx9VWK3SSbJeb+UT65Mamxx7aa7hZL1e/wmEwNKU","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"}}');var n=t(74848),a=t(28453),l=t(33617),i=t.n(l),r=t(17543),d=t.n(r),c=t(86013),p=t.n(c),h=t(63723),b=t.n(h),m=(t(18766),t(79329),t(9303));const W={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uGzcQfpUJL22EtVZJ00N1qpEYqVE3MWoHPthCwN0d7TLikiyHK1kQBOTQN+ip1z5anqQYUqs/J2nTFr1I8vz/fDMcr0SQNYnxrbjBorF2JiaZqJBKr1xQ1oixuG4QXqDGgLCRgdPLc5Ba2wUsbQfBQpX4iw2/81pkwjr0ko2cV2IskkjvJRMeyVlDSGK8Ek9HI/46dHzVlSUSTTsNW1MiE6U1AU1geemcVmVk5O+IlVaCygZbyb/C0qEYC1u8wzKITDjPZoJKLj1Sp8OeHAWvTC0ygfeydZpJfb4p9gpoG5FePhLrdSaCClFSGa0Mvu2Tevt0NHr7nVivWebZ6NnD5N4QejA2wNR2pnr03+WF3lv/+bSOfX8uEQ6+T+Pbh2mcm7nUqoqIuLYzNP9vJvvuQ3LPod63mvWMbFNKUSjyxUGq+/SUJGHZeRWWYny7Evcn0qmTxB/fTtaTTLQYGruDM8csQyPGIl9skU3o5+gpmjhC9ELWNfofuiJGfNoFCz/ZcpbS4qkZiyYER+M8nysfkqUhJbWmK4albfNLLxmBr+R8Jn1uHZr8yXA0HIl1tjoyQtJUhb0fshCp2mhZULQhncrnT4ZPPqIjnfsieexOvlSFgqyVqf9Kb7LrxxVjJsHioCtbcEinfsSlyPqm70tlQnH1G5QV+ggQZaY2Km+g8NqhuVK1iW2Jzo+34A3q0rbIyy40CINBr/Lh1z+2WoMBVLbsWjQhQn54Z+7M686Dswv0vMikqWCq8V4VGqMatpFH/SYllK1GIr0EZQLWXgaEStUqSA1cJ2VqKKWThdKKJ4XFLGt72Bs2GsJNg6FBz6yvPIKECueoecBAdsG2MrCpPl5YWD+barugDCQUHSmDRICmkaZkwb4TGVgP0gCagN55RQgUPEetUmzWBC/LAK00ska2ncF+sSrUiucDvC06CkBWdzFkCFJp67GCPiGDWFEs4tm9YxYwtbSt89gwbOYIdacqpAxKWyFQXAycgqmgQArgOBZVIrHRzmhbzmIDeYLAWd5TSmqw04MYWT14aWhqfZti6XuwLZjzlh8DTAEOBm8IucMXysxoPBjcmRO43eLqBgtSASdf9yOwWCweQP/xoc5LFXhT/IzOkgrWL3fatQr9Ntg3sv0jWXqJBiN+9oZhZ6OyJT2cPqbmDWqXX2FghFB+enkeV/tj+PD+N7hA6Q00dpHQWnYe9RLq3hVXLnU+lW27mWFqI/AarniZwOfxlw4p9BW8aWT48P53gle4AGU2I8WpDAaXXaFVCdfYOi0D0mAwhuce2WXoaRAaGaCUBgoEaiRDaa4kSHBJWyszG8KpWULHT+BChSaCgelR7yANrsu23QSFJKzAmqjR+xzuImJ6S6jnSGyL39cCASvFl0NovO3q5G0/mE1yHqdKa7hRVY0h5nZaVeA25EUix0NrFw5OeSBCg0uQHoHQhCFcHqlETuec9RyFSsFPLd9u3AA0lbPKBBpD5eU07OxnO6CXXGZlzUdIqYRyW45sY2bbkjSJm4y31OEdL+WjRX64bz1O0bPDmPauL05t4HTbwxIYrf8G1nwT8NaSZTxZsJVKpxfl+2M78XxA39Lr6RX6uSpx86p9YqLzKJyLTGhVoiHcO0tOX15ewPyb4ejg6f8bw51fnD8/e3V1xsHwIk0F608A4SyFVpo9T4fX+/HTttrda//81t+8wgHvQ+60VPHQilmtNhfSrVjs/sNoLAUmrVY8VW+8Xq+Z/EuHnk+vSSbm0itZ8ON8O1ln/dvNJ9UMl1y9skTHN+Nc6i4dAEeX5sG59uLs4uz6TGSCN9Dh2TCLZ8PmBzvoWWa5Z/7wnkgx8CcfNx9VWK3SSbJeb+UT65Mamxx7aa7hZL1e/wmEwNKU",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,S={},k=[];function y(e){const o={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,n.jsx)(i(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,n.jsx)(d(),{parameters:void 0}),"\n",(0,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function q(e={}){const{wrapper:o}={...(0,a.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.a2cfa06b.js b/assets/js/d480dde9.a2cfa06b.js new file mode 100644 index 000000000..fe60841ae --- /dev/null +++ b/assets/js/d480dde9.a2cfa06b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3230],{94677:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>m,contentTitle:()=>W,default:()=>I,frontMatter:()=>u,metadata:()=>l,toc:()=>E});const l=JSON.parse('{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.1/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-webhook","permalink":"/docs/API-docs/v1.1/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9VktvGzcQ/isTXtoIa0lJ00N1qpEYqVEjMWoHPthCwN0daRlxSYYzK1kQBOTQf9BTr/1p+SXFcLV6OUmbtuhFj+G855vHSrGekhrdqhvMK+9napypEqmIJrDxTo3UdYXwAi0ywoYHTi/PQVvrF7D0DbCHsn1fbN6baFWmfMCoRcl5qUaqZemsZCoiBe8ISY1W6ulwKF+Hhq+aokCiSWNhq0plqvCO0bHw6xCsKdLD4B2J0EpRUWGt5RcvA6qR8vk7LFhlKkRRw6Y1GZEay3t8xNG4qcoU3us6WCF18ba+l0Bbj+zykVqvM8WGE6dx1jh82wX19ulw+PYHtV4Lz7Phs4fBvSGM4DzDxDeufPTfxYUx+vjlsI5tfykQcb4L4/uHYZy7ubamTIi49jN0/28k++a5NS+u3tdW5Jyu25ASU3pXB6Hu09sgCYsmGl6q0e1K3Z/oYE7a99HteD3OVI1c+R2cxWfNlRqpwWKLbMI4x0hJhXTCSFXMgUaDAWlX5v6+7wM6MlNndU79wtcDHcxg/qT/RK2zYxkdwlfxY3PytSLEemrc9K/kxrv0XEkJ2yodJGlbKx3Mz7hUWVeDfa5MGYFOhbrEmOpl3MQn4U1lXgd0V2bqUl2T8eOhdIO28DXK7OEKodfrRD7++sdWqteD0hdNjY4TAvt37s69biIEv8Aoc0W7EiYW701uMYlhnd6oG2yEurZIZJdgHOM0akYozdSwtiB5Mm4KhQ46N9YIcIXNi3SEPexTH24q5AqjPH0TETSUOEcreAfdsK81i6rOX1j4OJtYv6AMNOQNGYdEgK7SrhDGrhIZ+AjaATrGGKIhBOIoXpvWN+846oKh1k5PUXRnsJ+sEq0RuEL0eUMM5G2TXAbWxvqIJXQBOcSSUhLP7oM8gVALX4eIlcBmjjBtTImUQeFLBEp9KiG4EnIkhiC+mAJJlDbO+mKWCigjFYKXsWG0BT858FHEOWpHEx/r1peuBtuEhehlNmPrYK/3hlAqfGHcjEa93p07gdstrm4wJ8M4/rZrgcVi8QD6jw9lXhr+qcnhFwyeDPu43ElPDVdNntplX8n2T6vpJTpM+Nlrhp2O0hf0sPuEOqjQhsEVsiCEBqeX52nSPoaPH36DC9TRQeUXLVqLJqJdwrQzJZlrK9+mbTsoYeIT8CrJeNGCL+L7Bom7DN5Umj9++J3gFS7AuE1LSSi93mWTW1PANdbBakbq9UbwPKKY5I4GXGmGQjvIEajSAqW50aAhtNLWuFkfTt0SGtlIC8NVAoPQk9xBGJKXbbkJck1YgndJorPZ33kk9JrQzpFEl6y7HAFLI4ucq+ibaWtt35lNcBEnxlq4MeUUOcV2WpYQNuRFS053z84dnEhDcIVL0BGB0HEfLo9E0ksTgo/ihWmdn3g5paQA6MrgjWMaQRn1hHf6sx3QC0mz8e4TpDaFepuObKNmW5K2EzcRb6n9OxnKR4P8cN5GnGAUgynsXV2C2cDptoMlCFr/DaxlRcvU0kW6ILDWxrYb5cdjPWmbY6zp9eQK49wUuNlqn+noQWIeqExZU6Aj3LsSTl9eXsD8u/5QZXvr8W809+Di/PnZq6szcUYGaZuwJ/1hfyik4Ilr7fYsHR7Tx6tttTuf/vnpvdnCjPc8CFabdPekqFabg+VWLXYHf+WJhbRaSVe9iXa9FvL7BqNcQuNMzXU0OpflfDteZ93ulgtnhkvJXlFgkBNurm3THgBHh9/B9fTi7OLs+kxlSibQ4dkwS2fD5ocY6J7cck/94T3R+iCfctx8UmC1ak+S9XrL3z59VmITY8ctORyv1+s/AXfSquk=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"}}');var s=o(74848),n=o(28453),i=o(33617),r=o.n(i),d=o(17543),a=o.n(d),c=o(86013),h=o.n(c),p=o(63723),b=o.n(p),k=(o(18766),o(79329),o(9303));const u={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VktvGzcQ/isTXtoIa0lJ00N1qpEYqVEjMWoHPthCwN0daRlxSYYzK1kQBOTQf9BTr/1p+SXFcLV6OUmbtuhFj+G855vHSrGekhrdqhvMK+9napypEqmIJrDxTo3UdYXwAi0ywoYHTi/PQVvrF7D0DbCHsn1fbN6baFWmfMCoRcl5qUaqZemsZCoiBe8ISY1W6ulwKF+Hhq+aokCiSWNhq0plqvCO0bHw6xCsKdLD4B2J0EpRUWGt5RcvA6qR8vk7LFhlKkRRw6Y1GZEay3t8xNG4qcoU3us6WCF18ba+l0Bbj+zykVqvM8WGE6dx1jh82wX19ulw+PYHtV4Lz7Phs4fBvSGM4DzDxDeufPTfxYUx+vjlsI5tfykQcb4L4/uHYZy7ubamTIi49jN0/28k++a5NS+u3tdW5Jyu25ASU3pXB6Hu09sgCYsmGl6q0e1K3Z/oYE7a99HteD3OVI1c+R2cxWfNlRqpwWKLbMI4x0hJhXTCSFXMgUaDAWlX5v6+7wM6MlNndU79wtcDHcxg/qT/RK2zYxkdwlfxY3PytSLEemrc9K/kxrv0XEkJ2yodJGlbKx3Mz7hUWVeDfa5MGYFOhbrEmOpl3MQn4U1lXgd0V2bqUl2T8eOhdIO28DXK7OEKodfrRD7++sdWqteD0hdNjY4TAvt37s69biIEv8Aoc0W7EiYW701uMYlhnd6oG2yEurZIZJdgHOM0akYozdSwtiB5Mm4KhQ46N9YIcIXNi3SEPexTH24q5AqjPH0TETSUOEcreAfdsK81i6rOX1j4OJtYv6AMNOQNGYdEgK7SrhDGrhIZ+AjaATrGGKIhBOIoXpvWN+846oKh1k5PUXRnsJ+sEq0RuEL0eUMM5G2TXAbWxvqIJXQBOcSSUhLP7oM8gVALX4eIlcBmjjBtTImUQeFLBEp9KiG4EnIkhiC+mAJJlDbO+mKWCigjFYKXsWG0BT858FHEOWpHEx/r1peuBtuEhehlNmPrYK/3hlAqfGHcjEa93p07gdstrm4wJ8M4/rZrgcVi8QD6jw9lXhr+qcnhFwyeDPu43ElPDVdNntplX8n2T6vpJTpM+Nlrhp2O0hf0sPuEOqjQhsEVsiCEBqeX52nSPoaPH36DC9TRQeUXLVqLJqJdwrQzJZlrK9+mbTsoYeIT8CrJeNGCL+L7Bom7DN5Umj9++J3gFS7AuE1LSSi93mWTW1PANdbBakbq9UbwPKKY5I4GXGmGQjvIEajSAqW50aAhtNLWuFkfTt0SGtlIC8NVAoPQk9xBGJKXbbkJck1YgndJorPZ33kk9JrQzpFEl6y7HAFLI4ucq+ibaWtt35lNcBEnxlq4MeUUOcV2WpYQNuRFS053z84dnEhDcIVL0BGB0HEfLo9E0ksTgo/ihWmdn3g5paQA6MrgjWMaQRn1hHf6sx3QC0mz8e4TpDaFepuObKNmW5K2EzcRb6n9OxnKR4P8cN5GnGAUgynsXV2C2cDptoMlCFr/DaxlRcvU0kW6ILDWxrYb5cdjPWmbY6zp9eQK49wUuNlqn+noQWIeqExZU6Aj3LsSTl9eXsD8u/5QZXvr8W809+Di/PnZq6szcUYGaZuwJ/1hfyik4Ilr7fYsHR7Tx6tttTuf/vnpvdnCjPc8CFabdPekqFabg+VWLXYHf+WJhbRaSVe9iXa9FvL7BqNcQuNMzXU0OpflfDteZ93ulgtnhkvJXlFgkBNurm3THgBHh9/B9fTi7OLs+kxlSibQ4dkwS2fD5ocY6J7cck/94T3R+iCfctx8UmC1ak+S9XrL3z59VmITY8ctORyv1+s/AXfSquk=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},W=void 0,m={},E=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.717af639.js b/assets/js/da66eb9c.717af639.js new file mode 100644 index 000000000..b680eb21e --- /dev/null +++ b/assets/js/da66eb9c.717af639.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>f,metadata:()=>a,toc:()=>b});const a=JSON.parse('{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/v1.1/update-document.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-document","permalink":"/docs/API-docs/v1.1/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWM2OG7kRfpUKL7GFHkm2xxtEp0y8hm3EsAXPDAxkPBCoZrWaO2ySS7KlEQQBe9g3yCnXPJqfJCiyu9X68djOLhIgl4GGXSxWfVVkfVUbFvjCs8kN+9HkdYU6eHabMYE+d9IGaTSbsKsS4doKHhBaKbiYvgGulFl5qD06D8FAZYQs1sC1gDqJhxJBYOBSeTAFcPAWc1nIHESjaAjvTBTkAUIpfVRstFq32oNplXEocAWWO15hQOczWJsacq61CZCXXC/SgYVUCEbnCDIkC1qjpYfcIQ8ohixjxqLj5OIbwSYsHdL6xzK2O4hNbjZM8wrZhLW6ZlKwjEmCx/JQskPM3vxIDu+dHn3UiCI6NcfGL9Lj8OdaOhRsElyNGfNhreg0LyurkGUM760yAtmk4MqTQF5ixdlkw8LaRsngpF6wjBXGVTzsVrbb26QfffirEWvas2/q1JmlFAhzVKaHbw/5gJVVPKCHRzyAQu4DGI092daBxyxjudGBIJxsGLdWyTyCPPrJ02mbY9PN/CfMI+KOQhIkevqaAP+6gwQOjzBNmI8/OsjZNmPahO9WMyUXERwuJa5iPnu50Ck/+7r3cPy+I7qs6OvY0h4l0FFGHuvb7SZJ1Hyu8P3VtCc6N0Yh10fZSFkFZ8kBExdhJZWCpAPeX01hiY4uZozVEK7jnY4yDnOUS7p+fRHIjUBYSg5YcakyWJUyLynh11DVPgDqJoca6LB35WMSwxkcGySkP2lRlp4DqRe75+ZIMQjpMA9qDSsZSlMH4EJI2s4V+IDWD/soRis6IK9M7X47khwWtRQoIJjaQWFctDI+VjZeM/JAah9cndNmD6Km6EY/SJR+W2dy9H6HU4sKCfX0Z4Dap+0cCu4DugxqLQl5V9uAolOJ9xadRJ3jSQgiuLP4fjeA+2/HYoquksG3nlJouBCACmM9AV/nJfD0nYfaoc9AahkkVz4DH3hlfQbGQcB7elcgGEuPJ95LH8j4lRQLDB7kl/LoA9IdyXs2FM5UMfqEjV73E6GzK5gDdVcUVOmbqlXwWgVYclWfxsxhSrdZ7dSp27qP1WUqfJi0X394C6sSHXZxR5fyaE7PTlKMVEbjTaODQ5slXbYfpsvRC8HrYGYOK6kFfktuX2KIoFBYg+lSug6m4kHm0KryQ2hEUwCC6WdoBY9a8OZY8qU07vEXACR1M6rUM6lnuES37lmp62qO7sjId3GZ8kPwtYc5hhWi7tvWhjGxiFSByLZViRr2MCEpv3N6z8rn223Gggx7r/WsV/5nc6qm2+02uuKt0T4Vrqfj8XGR7YhTU/TpVlDUilqp9R9+v6qZlr9WP7gXT1/76flrS3nSmHQRHt70dPz02dmT8dn4T1dPfpic/3ny/IfheDz+O8vYfaV2JZuRNtZHL/7fW5BaSY2zFrXZ0/F49qyB8vwUek1Btg1TWXIlBRQSlQA60/+OAKJzxv2HhOEB+x5yn1xunT9/IHWI5xam1uJ/7e4pix528Hx23rn4/NjFNzpBRuT/ytyh/m94uPOnf3xIx5Op+1ktk1D8zvac7a8nJz3mtZNhHTuH+zNu5Vn6Prm5JT5eYSgNdR22Tq1GKNmEjdrXZbTpvTNbRvrcsm1EYrlhZQjWT0Yjz7WYm/uhsaipICg+98PcVCNu5Wj5ZPiEbbPDPdza75LH+ux7t/jAF1IvvrbvdgfVJYUzRWwPsC5u3Mq/4ZplbTz6Uk0nViKnSkcRoCz5sOt6Xrax7sJ52Cq0ncK3kf/DqnSSzvfZPGN7jL1p4/rUs1k6ScWab/uUg1QelPhO7lRlfb4lmAoTMW2S971FfUnuUerHmBx69hFVbips2dJg0G75/Ou/ul2DQQdNaiA+6U/6fe3AmhW6olYRx0LhvaRKTNuwit98bOKJzSOvFHqv1kAEduGo8RRyIQOR94bq5NzyuVSS7jaJGdrtoPc8+CF8LDGU6OjTHx1RcoFLVPQkdFxGL3Y0amXcXUGjhgw4zGsvNXoPqEuucxJsEzRSVK5TY2Od9Ag+OLJaJtuMDo7nASqu+SJyzAz6YAlUkm4xODOnDskbVacegAYkxkVWnxyKU4II4ktq/B0CrRIRdFjSbVo2jYDPUiOWsplc0ALm6ANYskXmmCYoWpn8Lk1HaqXAGnpZJVfEo/o20vbguPb0/Cdb2hh0gDV8E5OBg8G1R4rwW6nv/GQw+KTP4KbLq4849zLg7aP2ZVitVkcvwuP9Pa9keF3P4QNa42Uwbr3bvZChrOfxFekr6f5Jml6hxpg/vTdip0OY3B8/SrQ6KlHZ0SUGyhA/upi+icXoMXz+5R/wFrnTUJpVyta8dqjWsGiPIuRS5BNsXS2JXSCvQ0mI5yn5mnlMi+DHkofPv/zTwztcUZeTrhS5MhhM67mSOVy1I5jBYAIv4hCrN5aJo6Wca2offMkplag152DTbiX13RAu9Dp2z7E9jslA63HfnhvxvWvD7WHOPYrYl5W7M4c7iyLp96iW6Ntp3BwBhSSaG0pn6kU6rW9M45zDgrqej6nDI98uhADbLLeNHzUYO3OwMKlxWgN3CD72btODLfFLba1xZEXTORamHSKgFtZIHfwEhONF2OnPdokeZ4Vx+HC0lCDkHRxZo6YLSbqJjcfd6vATVYWD+rb/3jos0NGB0e1dXKxs0ummTUugbP0taU0shl4tnkeSFQc5qdD+5VBPJDzoKv++uES3lDk2xf4LN3oUhUcsY0rmqH2/8l68mr6F5bPhmGU91vANl3v09s2Ll+8uX5Ix9JAmwJ4Mx8MxLVnjQ8V176SDofVhbdvsKOb/64y74U40WRlZxWVkrs3AIrHOG9YjNZP+ePs2Y6XxgUQ2G3oErp3abmn55zoSipvbjC25k8RhIjVtpgCiIyJfhPvRh3ZgDN83KT/pUMsQNdHDOLFJ7OgO1wcj++3tNmtpIlmcJF4ku86uSM9Ow1HXQTw37bjIc7ThQdk+zZ9eX7GMzZvxexUn+czxFY3++SoZm6aJkQDHtQ1TXC9qviDZpHKbhjrlPiu+i6y4+UFOnYRjny4nL+gv+XRyw2aTGPd228mnT1/c0eDaSlNsbrfb7b8BOQ9Ukg==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"}}');var i=n(74848),s=n(28453),o=n(33617),d=n.n(o),l=n(17543),r=n.n(l),c=n(86013),p=n.n(c),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const f={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWM2OG7kRfpUKL7GFHkm2xxtEp0y8hm3EsAXPDAxkPBCoZrWaO2ySS7KlEQQBe9g3yCnXPJqfJCiyu9X68djOLhIgl4GGXSxWfVVkfVUbFvjCs8kN+9HkdYU6eHabMYE+d9IGaTSbsKsS4doKHhBaKbiYvgGulFl5qD06D8FAZYQs1sC1gDqJhxJBYOBSeTAFcPAWc1nIHESjaAjvTBTkAUIpfVRstFq32oNplXEocAWWO15hQOczWJsacq61CZCXXC/SgYVUCEbnCDIkC1qjpYfcIQ8ohixjxqLj5OIbwSYsHdL6xzK2O4hNbjZM8wrZhLW6ZlKwjEmCx/JQskPM3vxIDu+dHn3UiCI6NcfGL9Lj8OdaOhRsElyNGfNhreg0LyurkGUM760yAtmk4MqTQF5ixdlkw8LaRsngpF6wjBXGVTzsVrbb26QfffirEWvas2/q1JmlFAhzVKaHbw/5gJVVPKCHRzyAQu4DGI092daBxyxjudGBIJxsGLdWyTyCPPrJ02mbY9PN/CfMI+KOQhIkevqaAP+6gwQOjzBNmI8/OsjZNmPahO9WMyUXERwuJa5iPnu50Ck/+7r3cPy+I7qs6OvY0h4l0FFGHuvb7SZJ1Hyu8P3VtCc6N0Yh10fZSFkFZ8kBExdhJZWCpAPeX01hiY4uZozVEK7jnY4yDnOUS7p+fRHIjUBYSg5YcakyWJUyLynh11DVPgDqJoca6LB35WMSwxkcGySkP2lRlp4DqRe75+ZIMQjpMA9qDSsZSlMH4EJI2s4V+IDWD/soRis6IK9M7X47khwWtRQoIJjaQWFctDI+VjZeM/JAah9cndNmD6Km6EY/SJR+W2dy9H6HU4sKCfX0Z4Dap+0cCu4DugxqLQl5V9uAolOJ9xadRJ3jSQgiuLP4fjeA+2/HYoquksG3nlJouBCACmM9AV/nJfD0nYfaoc9AahkkVz4DH3hlfQbGQcB7elcgGEuPJ95LH8j4lRQLDB7kl/LoA9IdyXs2FM5UMfqEjV73E6GzK5gDdVcUVOmbqlXwWgVYclWfxsxhSrdZ7dSp27qP1WUqfJi0X394C6sSHXZxR5fyaE7PTlKMVEbjTaODQ5slXbYfpsvRC8HrYGYOK6kFfktuX2KIoFBYg+lSug6m4kHm0KryQ2hEUwCC6WdoBY9a8OZY8qU07vEXACR1M6rUM6lnuES37lmp62qO7sjId3GZ8kPwtYc5hhWi7tvWhjGxiFSByLZViRr2MCEpv3N6z8rn223Gggx7r/WsV/5nc6qm2+02uuKt0T4Vrqfj8XGR7YhTU/TpVlDUilqp9R9+v6qZlr9WP7gXT1/76flrS3nSmHQRHt70dPz02dmT8dn4T1dPfpic/3ny/IfheDz+O8vYfaV2JZuRNtZHL/7fW5BaSY2zFrXZ0/F49qyB8vwUek1Btg1TWXIlBRQSlQA60/+OAKJzxv2HhOEB+x5yn1xunT9/IHWI5xam1uJ/7e4pix528Hx23rn4/NjFNzpBRuT/ytyh/m94uPOnf3xIx5Op+1ktk1D8zvac7a8nJz3mtZNhHTuH+zNu5Vn6Prm5JT5eYSgNdR22Tq1GKNmEjdrXZbTpvTNbRvrcsm1EYrlhZQjWT0Yjz7WYm/uhsaipICg+98PcVCNu5Wj5ZPiEbbPDPdza75LH+ux7t/jAF1IvvrbvdgfVJYUzRWwPsC5u3Mq/4ZplbTz6Uk0nViKnSkcRoCz5sOt6Xrax7sJ52Cq0ncK3kf/DqnSSzvfZPGN7jL1p4/rUs1k6ScWab/uUg1QelPhO7lRlfb4lmAoTMW2S971FfUnuUerHmBx69hFVbips2dJg0G75/Ou/ul2DQQdNaiA+6U/6fe3AmhW6olYRx0LhvaRKTNuwit98bOKJzSOvFHqv1kAEduGo8RRyIQOR94bq5NzyuVSS7jaJGdrtoPc8+CF8LDGU6OjTHx1RcoFLVPQkdFxGL3Y0amXcXUGjhgw4zGsvNXoPqEuucxJsEzRSVK5TY2Od9Ag+OLJaJtuMDo7nASqu+SJyzAz6YAlUkm4xODOnDskbVacegAYkxkVWnxyKU4II4ktq/B0CrRIRdFjSbVo2jYDPUiOWsplc0ALm6ANYskXmmCYoWpn8Lk1HaqXAGnpZJVfEo/o20vbguPb0/Cdb2hh0gDV8E5OBg8G1R4rwW6nv/GQw+KTP4KbLq4849zLg7aP2ZVitVkcvwuP9Pa9keF3P4QNa42Uwbr3bvZChrOfxFekr6f5Jml6hxpg/vTdip0OY3B8/SrQ6KlHZ0SUGyhA/upi+icXoMXz+5R/wFrnTUJpVyta8dqjWsGiPIuRS5BNsXS2JXSCvQ0mI5yn5mnlMi+DHkofPv/zTwztcUZeTrhS5MhhM67mSOVy1I5jBYAIv4hCrN5aJo6Wca2offMkplag152DTbiX13RAu9Dp2z7E9jslA63HfnhvxvWvD7WHOPYrYl5W7M4c7iyLp96iW6Ntp3BwBhSSaG0pn6kU6rW9M45zDgrqej6nDI98uhADbLLeNHzUYO3OwMKlxWgN3CD72btODLfFLba1xZEXTORamHSKgFtZIHfwEhONF2OnPdokeZ4Vx+HC0lCDkHRxZo6YLSbqJjcfd6vATVYWD+rb/3jos0NGB0e1dXKxs0ummTUugbP0taU0shl4tnkeSFQc5qdD+5VBPJDzoKv++uES3lDk2xf4LN3oUhUcsY0rmqH2/8l68mr6F5bPhmGU91vANl3v09s2Ll+8uX5Ix9JAmwJ4Mx8MxLVnjQ8V176SDofVhbdvsKOb/64y74U40WRlZxWVkrs3AIrHOG9YjNZP+ePs2Y6XxgUQ2G3oErp3abmn55zoSipvbjC25k8RhIjVtpgCiIyJfhPvRh3ZgDN83KT/pUMsQNdHDOLFJ7OgO1wcj++3tNmtpIlmcJF4ku86uSM9Ow1HXQTw37bjIc7ThQdk+zZ9eX7GMzZvxexUn+czxFY3++SoZm6aJkQDHtQ1TXC9qviDZpHKbhjrlPiu+i6y4+UFOnYRjny4nL+gv+XRyw2aTGPd228mnT1/c0eDaSlNsbrfb7b8BOQ9Ukg==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,g={},b=[];function P(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(p(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.b5f1e6c1.js b/assets/js/da66eb9c.b5f1e6c1.js deleted file mode 100644 index 6a6964b78..000000000 --- a/assets/js/da66eb9c.b5f1e6c1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>w,contentTitle:()=>v,default:()=>y,frontMatter:()=>f,metadata:()=>o,toc:()=>b});const o=JSON.parse('{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/v1.1/update-document.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-document","permalink":"/docs/API-docs/v1.1/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWd1uG7sRfpUpb5oIa0lJnFNUV3VzgiRomgixjQB1DIFazmp5zCV5SK5kQRBwLvoGveptHy1PUgy5u1r9xEl6DlqgN4bNnRnOfDOcP29Y4AvPJjfsR5PXFerg2W3GBPrcSRuk0WzCrkqEayt4QGip4GL6BrhSZuWh9ug8BAOVEbJYA9cC6kQeSgSBgUvlwRTAwVvMZSFzEI2gIbwzkZAHCKX0UbDRat1KD6YVxqHAFVjueIUBnc9gbWrIudYmQF5yvUgXFlIhGJ0jyJA0aJWWHnKHPKAYsowZi46TiW8Em7B0SWsfy9juIja52TDNK2QT1sqaScEyJgkey0PJDjF78yMZvHd7tFEjimjUHBu7SI7Dn2vpULBJcDVmzIe1otu8rKxCljG8t8oIZJOCK08EeYkVZ5MNC2sbKYOTesEyVhhX8bA72W5vk3z04c9GrIlnX9WpM0spEOaoTA/fHvIBK6t4QA+PeACF3AcwGnu0rQGPWcZyowNBONkwbq2SeQR59JOn2zbHqpv5T5hHxB25JEj09DUB/nUDCRweYZowH3/pIGfbjGkTvlvMlExEcLiUuIrx7OVCp/jsy97D8fuu6KKiL2NLPEqgo4g8lrfjJkrUfK7w/dW0Rzo3RiHXR9FIUQVnyQATD2EllYIkA95fTWGJjh5m9NUQruObjjQOc5RLen59EsiNQFhKDlhxqTJYlTIvKeDXUNU+AOomhhrosPfkYxDDGRwrJKQ/qVGW0oHUi126ORIMQjrMg1rDSobS1AG4EJLYuQIf0PphH8WoRQfklandr0eSw6KWAgUEUzsojItaxmRl4zMjC6T2wdU5MXsQNXk32kGk9Lt1Jkfvdzi1qBBRT34GqH1i51BwH9BlUGtJyLvaBhSdSLy36CTqHE9CEMGdxfzdAO6/HYspukoG31pKruFCACqM9QR8nZfA03ceaoc+A6llkFz5DHzglfUZGAcB7ymvQDCWkifeSx9I+ZUUCwwe5Jfi6APSG8l7OhTOVNH7hI1e9wOh0yuYA3FX5FTpm6pV8FoFWHJVn8bMYQq3We3Uqde6j9VlKnyYpF9/eAurEh12fkeX4mhOaScJRiqj8aXRxaGNki7aD8PlKEPwOpiZw0pqgd8S25cYIijk1mC6kK6DqXiQObSi/BAa0uSAYPoRWsGjFrw5lnwpjXv8BQBJ3Iwq9UzqGS7RrXta6rqaoztS8l08pvgQfO1hjmGFqPu6tW5MXUSqQKTbqkQNe5gQld8Zvafl8+02Y0GGvWw965X/2Zyq6Xa7jaZ4a7RPhevpeHxcZLvGqSn69CrIa0Wt1Pp3v13VTMdfqx/ci6ev/fT8taU4aVS6CA8zPR0/fXb2ZHw2/sPVkx8m53+cPP9hOB6P/8Yydl+pXclmJI310Yt/9w6kVlLjrEVt9nQ8nj1roDw/hV5TkG3TqSy5kgIKiUoA3el/QwDROeP+w4bhAf0eMp9Mbo0/fyB0qM8tTK3F/9rcUxo9bOD57Lwz8fmxiW90goya/ytzh/q/YeHOnv71IV1Pqu5HtUxE8TvbM7Z/noz0mNdOhnWcHO7PuJVn6fvk5pb68QpDaWjqsHUaNULJJmzUZpfRppdntozkuWU7iBzk7BVfLNC9rudR+4s6GPirye+SibE0sTIE6yej0VK6kCQNfWIr6/kwN9Vo6jglond8ecfdyFjUoyfD8XDMttnmQIjnWszN/ZCIqAIpPvdRBrdytHwyfHKCh1v7XfRYn30viw98IfXia3y3O99cUvykENnzUBco3Mq/4JplbQD0qZrRr0ROpZVcTmH5YTdmvWyDq4ufw9mkHU2+bdo4LIMn54f++MDY3ojQzI39Xrc5Otn7Nd/2exwSedBTdHSnSvnzLcFUmIhp81reW9SXZB5Fa/TJoWUfUeWmwrY9Gwxals9//1fHNRh00KSJ5ZP+pN/XDqxZoStqFXEsFN5LKv3EhlX85uPWgMYH5JVC79UaqGNeOJp0hVzIQNNC01vl3PK5VJKSCZEZ4nbQy0d+CB9LDCU6+vR7RzOAwCUqykFd86QXu75tZdxdQbuNDDjMay81eg+oS65zImwDNPbEXKdJyjrpEXxwpLVMuhkdHM8DVFzzRWxqM+iDJVBJShvgzJxGMm9UnYYO2sgYF8eIZFBcS0QQX9KmwSHQKXWeDkt6Tctm8vBZmvxSNJMJWsAcfQBLusgc08pGK5PfpXVMrRRYQ6lcckWNW19HYg+Oa0/1JunS+qADrGlwMSk4GFx7JA+/lfrOTwaDT/oMbrq4+ohzLwPePmozw2q1OsoIj/d5XslACfQDWuNlMG69417I0CbJvpDujyTpFWqM8dPLETsZwuT+OCnR6ahEZUeXGChC/Ohi+iZWv8fw+Zd/wFvkTkNpVila89qhWsOivYqQS55PsHXFK46dvA4lIZ6n4GsWQC2CH0sePv/yTw/vcEVjVXpSZMpgMK3nSuZw1e58BoMJvIhbs94eKO6ycq5pXvElp1CiXQAHm7iV1HdDuNDrOK7HeTwGA51Hvj0zYr5r3e1hzj2KOAiWuzuHO43ilOFRLdG36785AgpJfXUonakX6ba+Mo1xDgsasz6mkZJsuxACbHPcTpo00ezUwcKkSW0N3CH4OCxOD1jil9pa40iLZlQtTLu1QC2skTr4CQjHi7CTn+0CPS4n47bj6ChByDs4skZM55L0EhuLu9PhJ6oKB/VtP986LNDRhdHsnV+sbMLppg1LoGj9NWFNbRNlLZ7Hri5ujlKh/dOhnNhhoav8++IS3VLm2BT7L7zoUSQesYwpmaP2/cp78Wr6FpbPhuO9jugbHvfo7ZsXL99dviRlKJEmwNrOiFnjQ8V176aDLflhbdvsetr/16V60zvRKmdkFZexVW42JKnNvWG9pmbS36ffZqw0PhDJZkNJ4Nqp7ZaOf65jQ3Fzm7Eld5J6mNQLp7WD6BqRL8L96EO7oYbvW82fNKjtEDW1h3FFlLqjO1wf/I9ge7vN2jaRNE4UL5JeZ1ckZyfhaMyhPjdxXOQ52vAgbX+umF5fsYzNm31/Ff91wBxf0f8a+Copm9aXsQGOZxumuF7UfEG0SeQ2bZHK/a74LnbFzS9k1Ek49tvlZAX9JJtOMmw2qePebjv69OmLHA2uLTX55na73f4bPEx8PQ==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"}}');var i=n(74848),a=n(28453),s=n(33617),d=n.n(s),p=n(17543),r=n.n(p),l=n(86013),c=n.n(l),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const f={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWd1uG7sRfpUpb5oIa0lJnFNUV3VzgiRomgixjQB1DIFazmp5zCV5SK5kQRBwLvoGveptHy1PUgy5u1r9xEl6DlqgN4bNnRnOfDOcP29Y4AvPJjfsR5PXFerg2W3GBPrcSRuk0WzCrkqEayt4QGip4GL6BrhSZuWh9ug8BAOVEbJYA9cC6kQeSgSBgUvlwRTAwVvMZSFzEI2gIbwzkZAHCKX0UbDRat1KD6YVxqHAFVjueIUBnc9gbWrIudYmQF5yvUgXFlIhGJ0jyJA0aJWWHnKHPKAYsowZi46TiW8Em7B0SWsfy9juIja52TDNK2QT1sqaScEyJgkey0PJDjF78yMZvHd7tFEjimjUHBu7SI7Dn2vpULBJcDVmzIe1otu8rKxCljG8t8oIZJOCK08EeYkVZ5MNC2sbKYOTesEyVhhX8bA72W5vk3z04c9GrIlnX9WpM0spEOaoTA/fHvIBK6t4QA+PeACF3AcwGnu0rQGPWcZyowNBONkwbq2SeQR59JOn2zbHqpv5T5hHxB25JEj09DUB/nUDCRweYZowH3/pIGfbjGkTvlvMlExEcLiUuIrx7OVCp/jsy97D8fuu6KKiL2NLPEqgo4g8lrfjJkrUfK7w/dW0Rzo3RiHXR9FIUQVnyQATD2EllYIkA95fTWGJjh5m9NUQruObjjQOc5RLen59EsiNQFhKDlhxqTJYlTIvKeDXUNU+AOomhhrosPfkYxDDGRwrJKQ/qVGW0oHUi126ORIMQjrMg1rDSobS1AG4EJLYuQIf0PphH8WoRQfklandr0eSw6KWAgUEUzsojItaxmRl4zMjC6T2wdU5MXsQNXk32kGk9Lt1Jkfvdzi1qBBRT34GqH1i51BwH9BlUGtJyLvaBhSdSLy36CTqHE9CEMGdxfzdAO6/HYspukoG31pKruFCACqM9QR8nZfA03ceaoc+A6llkFz5DHzglfUZGAcB7ymvQDCWkifeSx9I+ZUUCwwe5Jfi6APSG8l7OhTOVNH7hI1e9wOh0yuYA3FX5FTpm6pV8FoFWHJVn8bMYQq3We3Uqde6j9VlKnyYpF9/eAurEh12fkeX4mhOaScJRiqj8aXRxaGNki7aD8PlKEPwOpiZw0pqgd8S25cYIijk1mC6kK6DqXiQObSi/BAa0uSAYPoRWsGjFrw5lnwpjXv8BQBJ3Iwq9UzqGS7RrXta6rqaoztS8l08pvgQfO1hjmGFqPu6tW5MXUSqQKTbqkQNe5gQld8Zvafl8+02Y0GGvWw965X/2Zyq6Xa7jaZ4a7RPhevpeHxcZLvGqSn69CrIa0Wt1Pp3v13VTMdfqx/ci6ev/fT8taU4aVS6CA8zPR0/fXb2ZHw2/sPVkx8m53+cPP9hOB6P/8Yydl+pXclmJI310Yt/9w6kVlLjrEVt9nQ8nj1roDw/hV5TkG3TqSy5kgIKiUoA3el/QwDROeP+w4bhAf0eMp9Mbo0/fyB0qM8tTK3F/9rcUxo9bOD57Lwz8fmxiW90goya/ytzh/q/YeHOnv71IV1Pqu5HtUxE8TvbM7Z/noz0mNdOhnWcHO7PuJVn6fvk5pb68QpDaWjqsHUaNULJJmzUZpfRppdntozkuWU7iBzk7BVfLNC9rudR+4s6GPirye+SibE0sTIE6yej0VK6kCQNfWIr6/kwN9Vo6jglond8ecfdyFjUoyfD8XDMttnmQIjnWszN/ZCIqAIpPvdRBrdytHwyfHKCh1v7XfRYn30viw98IfXia3y3O99cUvykENnzUBco3Mq/4JplbQD0qZrRr0ROpZVcTmH5YTdmvWyDq4ufw9mkHU2+bdo4LIMn54f++MDY3ojQzI39Xrc5Otn7Nd/2exwSedBTdHSnSvnzLcFUmIhp81reW9SXZB5Fa/TJoWUfUeWmwrY9Gwxals9//1fHNRh00KSJ5ZP+pN/XDqxZoStqFXEsFN5LKv3EhlX85uPWgMYH5JVC79UaqGNeOJp0hVzIQNNC01vl3PK5VJKSCZEZ4nbQy0d+CB9LDCU6+vR7RzOAwCUqykFd86QXu75tZdxdQbuNDDjMay81eg+oS65zImwDNPbEXKdJyjrpEXxwpLVMuhkdHM8DVFzzRWxqM+iDJVBJShvgzJxGMm9UnYYO2sgYF8eIZFBcS0QQX9KmwSHQKXWeDkt6Tctm8vBZmvxSNJMJWsAcfQBLusgc08pGK5PfpXVMrRRYQ6lcckWNW19HYg+Oa0/1JunS+qADrGlwMSk4GFx7JA+/lfrOTwaDT/oMbrq4+ohzLwPePmozw2q1OsoIj/d5XslACfQDWuNlMG69417I0CbJvpDujyTpFWqM8dPLETsZwuT+OCnR6ahEZUeXGChC/Ohi+iZWv8fw+Zd/wFvkTkNpVila89qhWsOivYqQS55PsHXFK46dvA4lIZ6n4GsWQC2CH0sePv/yTw/vcEVjVXpSZMpgMK3nSuZw1e58BoMJvIhbs94eKO6ycq5pXvElp1CiXQAHm7iV1HdDuNDrOK7HeTwGA51Hvj0zYr5r3e1hzj2KOAiWuzuHO43ilOFRLdG36785AgpJfXUonakX6ba+Mo1xDgsasz6mkZJsuxACbHPcTpo00ezUwcKkSW0N3CH4OCxOD1jil9pa40iLZlQtTLu1QC2skTr4CQjHi7CTn+0CPS4n47bj6ChByDs4skZM55L0EhuLu9PhJ6oKB/VtP986LNDRhdHsnV+sbMLppg1LoGj9NWFNbRNlLZ7Hri5ujlKh/dOhnNhhoav8++IS3VLm2BT7L7zoUSQesYwpmaP2/cp78Wr6FpbPhuO9jugbHvfo7ZsXL99dviRlKJEmwNrOiFnjQ8V176aDLflhbdvsetr/16V60zvRKmdkFZexVW42JKnNvWG9pmbS36ffZqw0PhDJZkNJ4Nqp7ZaOf65jQ3Fzm7Eld5J6mNQLp7WD6BqRL8L96EO7oYbvW82fNKjtEDW1h3FFlLqjO1wf/I9ge7vN2jaRNE4UL5JeZ1ckZyfhaMyhPjdxXOQ52vAgbX+umF5fsYzNm31/Ff91wBxf0f8a+Copm9aXsQGOZxumuF7UfEG0SeQ2bZHK/a74LnbFzS9k1Ek49tvlZAX9JJtOMmw2qePebjv69OmLHA2uLTX55na73f4bPEx8PQ==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,w={},b=[];function j(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.1dc5766b.js b/assets/js/runtime~main.3e17fae5.js similarity index 88% rename from assets/js/runtime~main.1dc5766b.js rename to assets/js/runtime~main.3e17fae5.js index d31fd70fa..7383530f5 100644 --- a/assets/js/runtime~main.1dc5766b.js +++ b/assets/js/runtime~main.3e17fae5.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,d,b={},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 b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},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/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",225:"0a7196e9",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2075:"5c485335",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9260:"96f83544",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9429:"fa501e35",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"5cd13f3b",89:"67599f09",108:"b9723cd9",157:"77f58424",225:"5354ae5c",285:"12d03f5a",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"126598af",849:"332bda69",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"e69f4137",1665:"53514c64",1679:"a3f62faa",1688:"2582d322",1706:"781d6d29",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"403772ac",2075:"a9f3081e",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"b5f1e6c1",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"2025796d",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"7bc9fb1d",3460:"c87a9aec",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3724:"8970445f",3795:"c124b6c6",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"1c2422fe",4240:"575920a9",4372:"1bbc46c2",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"037506c8",4865:"3dea52d8",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"db88685e",5373:"ebd704b1",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"4dd81245",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"4abe84c3",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"b4fce6c8",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"78cbdeaf",6235:"6f5015ca",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"740e393e",7054:"cab4fa5c",7068:"33303148",7075:"7e5f8810",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"7c000e5d",7910:"5b11649a",7960:"57077b26",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"7015e218",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"cb327dba",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"d3620018",8901:"e05f6301",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"0064d4c8",9099:"a5fa9a4e",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9260:"f79cb59e",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"3b3ff2a4",9426:"4597631d",9429:"5d7507de",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","0a7196e9":"225","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043","5c485335":"2075",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241","96f83544":"9260",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426",fa501e35:"9429","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,d,b={},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 b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},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/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",225:"0a7196e9",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2075:"5c485335",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9260:"96f83544",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9429:"fa501e35",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"04d03f97",89:"67599f09",108:"b9723cd9",157:"77f58424",225:"5354ae5c",285:"928902d5",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"126598af",849:"332bda69",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"e44b2367",1665:"6005cc6b",1679:"27742ef4",1688:"2582d322",1706:"33c9f705",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"4a1b8c9b",2075:"a9f3081e",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"717af639",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"a2cfa06b",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"8e56cf3c",3460:"827e01c6",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3724:"8970445f",3795:"9177040b",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"804e9e11",4240:"ffea3fac",4372:"b75be620",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"cf9a081c",4865:"4a732e7a",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"3f44a353",5373:"60be571e",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"4dd81245",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"9f2d8c5b",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"b4fce6c8",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"ea9e4a46",6235:"5aa106b8",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"163938f2",7054:"cab4fa5c",7068:"33303148",7075:"8d0aa3f2",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"8aab2983",7910:"5b11649a",7960:"102fca2b",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"7015e218",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"7661f930",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"bc214206",8901:"e05f6301",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"905ad68d",9099:"635276a4",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9260:"f79cb59e",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"4db3ade4",9426:"4597631d",9429:"5d7507de",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","0a7196e9":"225","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043","5c485335":"2075",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241","96f83544":"9260",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426",fa501e35:"9429","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index 2ff15f99f..815dc453f 100644 --- a/blog/authors/index.html +++ b/blog/authors/index.html @@ -5,7 +5,7 @@ Authors | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index efb6f0b46..da44a46e5 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 6efdb2397..2e51b3ccb 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 a82370b0d..cf040bd83 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 a27dbddbc..6bf30a8f5 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 d9ab9b72d..7b3f6e222 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 475ee019b..c10cd615a 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 892d5d361..109ae734a 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 292680ac7..635b06fcb 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 134cb0c04..6a3eabbce 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 3959aae99..75145653c 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/api-intro/index.html b/docs/API-docs/api-intro/index.html index 4c9b9581f..f07885f84 100644 --- a/docs/API-docs/api-intro/index.html +++ b/docs/API-docs/api-intro/index.html @@ -5,7 +5,7 @@ OpenSign APIs | OpenSign™ - + diff --git a/docs/API-docs/v1.1/contactlist/index.html b/docs/API-docs/v1.1/contactlist/index.html index 66efd4594..cb05139cf 100644 --- a/docs/API-docs/v1.1/contactlist/index.html +++ b/docs/API-docs/v1.1/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createcontact/index.html b/docs/API-docs/v1.1/createcontact/index.html index a74f041aa..7e19410fb 100644 --- a/docs/API-docs/v1.1/createcontact/index.html +++ b/docs/API-docs/v1.1/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createdocument/index.html b/docs/API-docs/v1.1/createdocument/index.html index 2aae1e65d..0014f4b60 100644 --- a/docs/API-docs/v1.1/createdocument/index.html +++ b/docs/API-docs/v1.1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html index 6589cc40b..9677f61ba 100644 --- a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createfolder/index.html b/docs/API-docs/v1.1/createfolder/index.html index 6e332bb88..8298db812 100644 --- a/docs/API-docs/v1.1/createfolder/index.html +++ b/docs/API-docs/v1.1/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createtemplate/index.html b/docs/API-docs/v1.1/createtemplate/index.html index 43dc39337..d8b2b4702 100644 --- a/docs/API-docs/v1.1/createtemplate/index.html +++ b/docs/API-docs/v1.1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/delete-template/index.html b/docs/API-docs/v1.1/delete-template/index.html index ab5846d22..b42a2c6b7 100644 --- a/docs/API-docs/v1.1/delete-template/index.html +++ b/docs/API-docs/v1.1/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/delete-webhook/index.html b/docs/API-docs/v1.1/delete-webhook/index.html index 33301dac3..ebb1689aa 100644 --- a/docs/API-docs/v1.1/delete-webhook/index.html +++ b/docs/API-docs/v1.1/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletecontact/index.html b/docs/API-docs/v1.1/deletecontact/index.html index bdcd1fc11..a629e5b43 100644 --- a/docs/API-docs/v1.1/deletecontact/index.html +++ b/docs/API-docs/v1.1/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletedocument/index.html b/docs/API-docs/v1.1/deletedocument/index.html index be82ce7fa..eebc7e38f 100644 --- a/docs/API-docs/v1.1/deletedocument/index.html +++ b/docs/API-docs/v1.1/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletefolder/index.html b/docs/API-docs/v1.1/deletefolder/index.html index a3953feed..63a4d6b3d 100644 --- a/docs/API-docs/v1.1/deletefolder/index.html +++ b/docs/API-docs/v1.1/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/draftdocument/index.html b/docs/API-docs/v1.1/draftdocument/index.html index 53af0713c..8f1954095 100644 --- a/docs/API-docs/v1.1/draftdocument/index.html +++ b/docs/API-docs/v1.1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/drafttemplate/index.html b/docs/API-docs/v1.1/drafttemplate/index.html index ca7e5f1b3..44286086e 100644 --- a/docs/API-docs/v1.1/drafttemplate/index.html +++ b/docs/API-docs/v1.1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/folderlist/index.html b/docs/API-docs/v1.1/folderlist/index.html index f4ca09df4..f39ad4a26 100644 --- a/docs/API-docs/v1.1/folderlist/index.html +++ b/docs/API-docs/v1.1/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-template/index.html b/docs/API-docs/v1.1/get-template/index.html index dc1c36e4f..130618e34 100644 --- a/docs/API-docs/v1.1/get-template/index.html +++ b/docs/API-docs/v1.1/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-user/index.html b/docs/API-docs/v1.1/get-user/index.html index 861790ada..a6ada7236 100644 --- a/docs/API-docs/v1.1/get-user/index.html +++ b/docs/API-docs/v1.1/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-webhook/index.html b/docs/API-docs/v1.1/get-webhook/index.html index 5c4338660..a5360108e 100644 --- a/docs/API-docs/v1.1/get-webhook/index.html +++ b/docs/API-docs/v1.1/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getcontact/index.html b/docs/API-docs/v1.1/getcontact/index.html index ee40cfa59..8a962dd85 100644 --- a/docs/API-docs/v1.1/getcontact/index.html +++ b/docs/API-docs/v1.1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getcredits/index.html b/docs/API-docs/v1.1/getcredits/index.html index 2cc6af76c..57d976ccc 100644 --- a/docs/API-docs/v1.1/getcredits/index.html +++ b/docs/API-docs/v1.1/getcredits/index.html @@ -5,7 +5,7 @@ Get your API credits | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocument/index.html b/docs/API-docs/v1.1/getdocument/index.html index 641393a1d..32164504d 100644 --- a/docs/API-docs/v1.1/getdocument/index.html +++ b/docs/API-docs/v1.1/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocumentlist/index.html b/docs/API-docs/v1.1/getdocumentlist/index.html index 95c29687e..ee9631d44 100644 --- a/docs/API-docs/v1.1/getdocumentlist/index.html +++ b/docs/API-docs/v1.1/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getfolder/index.html b/docs/API-docs/v1.1/getfolder/index.html index 22e18dd01..60ea09265 100644 --- a/docs/API-docs/v1.1/getfolder/index.html +++ b/docs/API-docs/v1.1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/gettemplatelist/index.html b/docs/API-docs/v1.1/gettemplatelist/index.html index ac60e8cbe..060305d97 100644 --- a/docs/API-docs/v1.1/gettemplatelist/index.html +++ b/docs/API-docs/v1.1/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/index.html b/docs/API-docs/v1.1/index.html index 1387190f4..8ecf4307a 100644 --- a/docs/API-docs/v1.1/index.html +++ b/docs/API-docs/v1.1/index.html @@ -5,7 +5,7 @@ OpenSign API v1.1 | OpenSign™ - + diff --git a/docs/API-docs/v1.1/intro/index.html b/docs/API-docs/v1.1/intro/index.html index 09cb9eac9..75b569e93 100644 --- a/docs/API-docs/v1.1/intro/index.html +++ b/docs/API-docs/v1.1/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html index 67153e732..c4664af0d 100644 --- a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html +++ b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1.1 | OpenSign™ - + diff --git a/docs/API-docs/v1.1/publictemplate/index.html b/docs/API-docs/v1.1/publictemplate/index.html index 2e4dfa7c2..5ac1152b4 100644 --- a/docs/API-docs/v1.1/publictemplate/index.html +++ b/docs/API-docs/v1.1/publictemplate/index.html @@ -5,7 +5,7 @@ Public Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/resendrequestmail/index.html b/docs/API-docs/v1.1/resendrequestmail/index.html index 5d91af82b..eee475f0d 100644 --- a/docs/API-docs/v1.1/resendrequestmail/index.html +++ b/docs/API-docs/v1.1/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1.1/revokedocument/index.html b/docs/API-docs/v1.1/revokedocument/index.html index e53941f84..b3e10bfbc 100644 --- a/docs/API-docs/v1.1/revokedocument/index.html +++ b/docs/API-docs/v1.1/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/save-update-webhook/index.html b/docs/API-docs/v1.1/save-update-webhook/index.html index b5acf9709..8932f964e 100644 --- a/docs/API-docs/v1.1/save-update-webhook/index.html +++ b/docs/API-docs/v1.1/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/selfsign/index.html b/docs/API-docs/v1.1/selfsign/index.html index 3428267de..f00c74e2d 100644 --- a/docs/API-docs/v1.1/selfsign/index.html +++ b/docs/API-docs/v1.1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/v1.1/update-document/index.html b/docs/API-docs/v1.1/update-document/index.html index 0af27029a..78b826f51 100644 --- a/docs/API-docs/v1.1/update-document/index.html +++ b/docs/API-docs/v1.1/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/update-template/index.html b/docs/API-docs/v1.1/update-template/index.html index b409a08e0..9fa9c128f 100644 --- a/docs/API-docs/v1.1/update-template/index.html +++ b/docs/API-docs/v1.1/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/updatefolder/index.html b/docs/API-docs/v1.1/updatefolder/index.html index 0f4bd5c77..9551e7de4 100644 --- a/docs/API-docs/v1.1/updatefolder/index.html +++ b/docs/API-docs/v1.1/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/contactlist/index.html b/docs/API-docs/v1/contactlist/index.html index 2d7757c27..7ef3a58c5 100644 --- a/docs/API-docs/v1/contactlist/index.html +++ b/docs/API-docs/v1/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1/createcontact/index.html b/docs/API-docs/v1/createcontact/index.html index 369902174..cd5eadb2a 100644 --- a/docs/API-docs/v1/createcontact/index.html +++ b/docs/API-docs/v1/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/createdocument/index.html b/docs/API-docs/v1/createdocument/index.html index 20842a50b..07730d1d8 100644 --- a/docs/API-docs/v1/createdocument/index.html +++ b/docs/API-docs/v1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/v1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1/createdocumentwithtemplateid/index.html index 9e9b1d1ce..f2ec1ff97 100644 --- a/docs/API-docs/v1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/v1/createfolder/index.html b/docs/API-docs/v1/createfolder/index.html index 47a850b24..35365e899 100644 --- a/docs/API-docs/v1/createfolder/index.html +++ b/docs/API-docs/v1/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/createtemplate/index.html b/docs/API-docs/v1/createtemplate/index.html index 5382e7aac..97087ecd0 100644 --- a/docs/API-docs/v1/createtemplate/index.html +++ b/docs/API-docs/v1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/v1/delete-template/index.html b/docs/API-docs/v1/delete-template/index.html index 42075421b..83fcb58c5 100644 --- a/docs/API-docs/v1/delete-template/index.html +++ b/docs/API-docs/v1/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1/delete-webhook/index.html b/docs/API-docs/v1/delete-webhook/index.html index 6f9a460b0..335204c14 100644 --- a/docs/API-docs/v1/delete-webhook/index.html +++ b/docs/API-docs/v1/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/deletecontact/index.html b/docs/API-docs/v1/deletecontact/index.html index f08bc9465..77a3cc941 100644 --- a/docs/API-docs/v1/deletecontact/index.html +++ b/docs/API-docs/v1/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/deletedocument/index.html b/docs/API-docs/v1/deletedocument/index.html index 8ae51da67..329861836 100644 --- a/docs/API-docs/v1/deletedocument/index.html +++ b/docs/API-docs/v1/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1/deletefolder/index.html b/docs/API-docs/v1/deletefolder/index.html index 5bdd34dbb..88c762072 100644 --- a/docs/API-docs/v1/deletefolder/index.html +++ b/docs/API-docs/v1/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/draftdocument/index.html b/docs/API-docs/v1/draftdocument/index.html index d4a1ac396..dcdef71a7 100644 --- a/docs/API-docs/v1/draftdocument/index.html +++ b/docs/API-docs/v1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/v1/drafttemplate/index.html b/docs/API-docs/v1/drafttemplate/index.html index 52859d10d..bab9effba 100644 --- a/docs/API-docs/v1/drafttemplate/index.html +++ b/docs/API-docs/v1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/v1/folderlist/index.html b/docs/API-docs/v1/folderlist/index.html index 2b2ef4f2b..8913b8a9b 100644 --- a/docs/API-docs/v1/folderlist/index.html +++ b/docs/API-docs/v1/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1/get-template/index.html b/docs/API-docs/v1/get-template/index.html index 57a3a1bf2..788d1d1b3 100644 --- a/docs/API-docs/v1/get-template/index.html +++ b/docs/API-docs/v1/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1/get-user/index.html b/docs/API-docs/v1/get-user/index.html index 3c196a965..0a008b122 100644 --- a/docs/API-docs/v1/get-user/index.html +++ b/docs/API-docs/v1/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1/get-webhook/index.html b/docs/API-docs/v1/get-webhook/index.html index 612b8ac94..63825f434 100644 --- a/docs/API-docs/v1/get-webhook/index.html +++ b/docs/API-docs/v1/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/getcontact/index.html b/docs/API-docs/v1/getcontact/index.html index 2d49377ce..c0705938b 100644 --- a/docs/API-docs/v1/getcontact/index.html +++ b/docs/API-docs/v1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/getdocument/index.html b/docs/API-docs/v1/getdocument/index.html index f5ee2daef..b6934b3e5 100644 --- a/docs/API-docs/v1/getdocument/index.html +++ b/docs/API-docs/v1/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1/getdocumentlist/index.html b/docs/API-docs/v1/getdocumentlist/index.html index 1d215f207..e0fcb382f 100644 --- a/docs/API-docs/v1/getdocumentlist/index.html +++ b/docs/API-docs/v1/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1/getfolder/index.html b/docs/API-docs/v1/getfolder/index.html index 8ad3388a4..09ba95032 100644 --- a/docs/API-docs/v1/getfolder/index.html +++ b/docs/API-docs/v1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/gettemplatelist/index.html b/docs/API-docs/v1/gettemplatelist/index.html index c92faa340..1c2b9f48c 100644 --- a/docs/API-docs/v1/gettemplatelist/index.html +++ b/docs/API-docs/v1/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1/index.html b/docs/API-docs/v1/index.html index bdca78372..c84c3963a 100644 --- a/docs/API-docs/v1/index.html +++ b/docs/API-docs/v1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/v1/intro/index.html b/docs/API-docs/v1/intro/index.html index 9c4405cf6..bec669514 100644 --- a/docs/API-docs/v1/intro/index.html +++ b/docs/API-docs/v1/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1/opensign-api-v-1/index.html b/docs/API-docs/v1/opensign-api-v-1/index.html index 8ef859816..94a360819 100644 --- a/docs/API-docs/v1/opensign-api-v-1/index.html +++ b/docs/API-docs/v1/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/v1/resendrequestmail/index.html b/docs/API-docs/v1/resendrequestmail/index.html index eed85ad87..766ec3864 100644 --- a/docs/API-docs/v1/resendrequestmail/index.html +++ b/docs/API-docs/v1/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1/revokedocument/index.html b/docs/API-docs/v1/revokedocument/index.html index 985c74646..1fd701f43 100644 --- a/docs/API-docs/v1/revokedocument/index.html +++ b/docs/API-docs/v1/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1/save-update-webhook/index.html b/docs/API-docs/v1/save-update-webhook/index.html index 16727e3e0..42f2a5674 100644 --- a/docs/API-docs/v1/save-update-webhook/index.html +++ b/docs/API-docs/v1/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/selfsign/index.html b/docs/API-docs/v1/selfsign/index.html index 2ab2973bb..e074abf53 100644 --- a/docs/API-docs/v1/selfsign/index.html +++ b/docs/API-docs/v1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/v1/update-document/index.html b/docs/API-docs/v1/update-document/index.html index c4aed8381..b883cde84 100644 --- a/docs/API-docs/v1/update-document/index.html +++ b/docs/API-docs/v1/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1/update-template/index.html b/docs/API-docs/v1/update-template/index.html index 24d770bf9..7dc69a65d 100644 --- a/docs/API-docs/v1/update-template/index.html +++ b/docs/API-docs/v1/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1/updatefolder/index.html b/docs/API-docs/v1/updatefolder/index.html index 568f42a5b..f1cdb9cda 100644 --- a/docs/API-docs/v1/updatefolder/index.html +++ b/docs/API-docs/v1/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 67e895329..e05fdd0fd 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 1ef8c14cb..21595e006 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 78bedeb23..56999db77 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/documents/index.html b/docs/category/documents/index.html index 50acfa4b7..5b34cf702 100644 --- a/docs/category/documents/index.html +++ b/docs/category/documents/index.html @@ -5,7 +5,7 @@ Documents | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 3ad00e2ce..ac4684ddc 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 ac43bd8d6..1c223475e 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 0aae2c47e..e6e8352dc 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index 912f2e214..aee99ef9d 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 0fde50e5e..71ceea8af 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/category/user-menu/index.html b/docs/category/user-menu/index.html index 67440641b..614e744af 100644 --- a/docs/category/user-menu/index.html +++ b/docs/category/user-menu/index.html @@ -5,7 +5,7 @@ User Menu | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 33bb8f3e5..f8fc0812a 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 d7e170998..e43de444e 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 a0b9f118c..e95d7f153 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 42719f94a..31e0b65e6 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 31eb0dc64..cc2a838a9 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 084fd4832..70b06f718 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/Max File Upload Size/index.html b/docs/help/FAQs/Max File Upload Size/index.html index d87d8694e..81fda4d76 100644 --- a/docs/help/FAQs/Max File Upload Size/index.html +++ b/docs/help/FAQs/Max File Upload Size/index.html @@ -5,7 +5,7 @@ Max File Upload Size | OpenSign™ - + diff --git a/docs/help/FAQs/User Deletion/index.html b/docs/help/FAQs/User Deletion/index.html index cbd027725..1e08f21a6 100644 --- a/docs/help/FAQs/User Deletion/index.html +++ b/docs/help/FAQs/User Deletion/index.html @@ -5,7 +5,7 @@ User Deletion | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index 1e3cedc21..c15297b60 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/edit-document-before-sending/index.html b/docs/help/New-Document/edit-document-before-sending/index.html index cce779a8d..ad6840d54 100644 --- a/docs/help/New-Document/edit-document-before-sending/index.html +++ b/docs/help/New-Document/edit-document-before-sending/index.html @@ -5,7 +5,7 @@ Editing Your Document Before Sending | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index 4f0f6c91c..18834aac7 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/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 40c6b283b..c48c1532f 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 5c3204630..4d9a8f29a 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/New-Document/widgets/index.html b/docs/help/New-Document/widgets/index.html index 05ff12828..ac8364ac4 100644 --- a/docs/help/New-Document/widgets/index.html +++ b/docs/help/New-Document/widgets/index.html @@ -5,7 +5,7 @@ Widgets in OpenSign | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index c60bfccd7..a0dc0049b 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 040839882..e06a69d65 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 879506fc3..8885b61f9 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 b8d11c6d2..2298d418d 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 6a97b3126..67cebe8ce 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 59d0e0383..82b0c4456 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 572eb366a..f6e59a663 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 536f22bb0..0638375a3 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 fd7f19996..de8c24d8a 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 228d346b2..224894f76 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 9b986128a..9869e14db 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/APIToken/index.html b/docs/help/Settings/APIToken/index.html index e6c2edae1..a740d94b5 100644 --- a/docs/help/Settings/APIToken/index.html +++ b/docs/help/Settings/APIToken/index.html @@ -5,7 +5,7 @@ API Token | OpenSign™ - + diff --git a/docs/help/Settings/Custom-email-templates/index.html b/docs/help/Settings/Custom-email-templates/index.html index c1b237bc5..b8584aa18 100644 --- a/docs/help/Settings/Custom-email-templates/index.html +++ b/docs/help/Settings/Custom-email-templates/index.html @@ -5,7 +5,7 @@ Custom email templates | OpenSign™ - + diff --git a/docs/help/Settings/Preferences/index.html b/docs/help/Settings/Preferences/index.html index b75f7075b..608d82484 100644 --- a/docs/help/Settings/Preferences/index.html +++ b/docs/help/Settings/Preferences/index.html @@ -5,7 +5,7 @@ Preferences | OpenSign™ - + diff --git a/docs/help/Settings/SecurityManagement/index.html b/docs/help/Settings/SecurityManagement/index.html index add2759cb..aa8fc3b84 100644 --- a/docs/help/Settings/SecurityManagement/index.html +++ b/docs/help/Settings/SecurityManagement/index.html @@ -5,7 +5,7 @@ Security | OpenSign™ - + diff --git a/docs/help/Settings/Teams/index.html b/docs/help/Settings/Teams/index.html index 025d89b0e..cef3148d7 100644 --- a/docs/help/Settings/Teams/index.html +++ b/docs/help/Settings/Teams/index.html @@ -5,7 +5,7 @@ Manage Teams | OpenSign™ - + diff --git a/docs/help/Settings/Webhook/index.html b/docs/help/Settings/Webhook/index.html index 8efab53fc..3f6d895d6 100644 --- a/docs/help/Settings/Webhook/index.html +++ b/docs/help/Settings/Webhook/index.html @@ -5,7 +5,7 @@ Webhook | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index fca6e084d..15a4b7142 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 3ccce8db8..c3b5708f5 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 e35e77460..f53deeaa1 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 75d277215..f261293af 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 4900086f4..a65e18b4b 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/manage-templates/index.html b/docs/help/Templates/manage-templates/index.html index 8e53db564..59e3a61af 100644 --- a/docs/help/Templates/manage-templates/index.html +++ b/docs/help/Templates/manage-templates/index.html @@ -5,7 +5,7 @@ Manage Templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index 6c7411c9b..fcb9fd959 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 ec5aa44c2..b040debd5 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 617db7aa7..2ee887a90 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/User Menu/Profile/index.html b/docs/help/User Menu/Profile/index.html index 89ad7fd83..16a57a141 100644 --- a/docs/help/User Menu/Profile/index.html +++ b/docs/help/User Menu/Profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index ae8a9b2cf..cf53759a6 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 13f43f948..e3327c165 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 b00fedbbb..dd24063e0 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 c236bf79c..905cc16d6 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 46efde172..4d4287799 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 dc39b7f13..79b1e2b71 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/azure-vm-setup/index.html b/docs/self-host/guides/azure-vm-setup/index.html index 94e2a75da..dcc20513f 100644 --- a/docs/self-host/guides/azure-vm-setup/index.html +++ b/docs/self-host/guides/azure-vm-setup/index.html @@ -5,7 +5,7 @@ OpenSign Deployment Guide on Azure VM via command-line | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 7137fa184..22ce0bfcf 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 3e844298c..8bad1e6d6 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 a82ce5f18..d031f3ea2 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 e6cf28e4a..019c1ad77 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 693e8521f..94a8576cc 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 bd7091edd..0b08dd063 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +