From cc042ed8e5e9d0f74780902658359f507f5988a0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 05:44:05 +0000 Subject: [PATCH] deploy: 6c57ee65914035137df1d1690fbbd63d669da4a1 --- 404.html | 2 +- assets/js/{02e5f5c4.eb16148c.js => 02e5f5c4.60be571e.js} | 2 +- assets/js/03e06346.9e9eb20c.js | 1 - assets/js/03e06346.fd769b08.js | 1 + assets/js/138cee78.2ff83df9.js | 1 + assets/js/138cee78.40b50d00.js | 1 - assets/js/{18b84479.4249218d.js => 18b84479.33c9f705.js} | 2 +- assets/js/19e5ad2a.e44b2367.js | 1 + assets/js/19e5ad2a.f969e353.js | 1 - assets/js/{1c57a399.9642dc06.js => 1c57a399.e05f6301.js} | 2 +- assets/js/23f866da.9ad181d3.js | 1 - assets/js/23f866da.e170b9c6.js | 1 + assets/js/34593b53.1df317b0.js | 1 - assets/js/34593b53.e3542020.js | 1 + assets/js/{4227e71a.47aa6633.js => 4227e71a.3f44a353.js} | 2 +- assets/js/{5144c8d4.79e73705.js => 5144c8d4.d7ccdb73.js} | 2 +- assets/js/58abd73c.66f4fead.js | 1 - assets/js/58abd73c.7661f930.js | 1 + assets/js/5a144266.804e9e11.js | 1 + assets/js/5a144266.e4fd7cb0.js | 1 - assets/js/5ce6d213.60832077.js | 1 - assets/js/5ce6d213.827e01c6.js | 1 + assets/js/{62b755e6.2a78d705.js => 62b755e6.4db3ade4.js} | 2 +- assets/js/{6d2e526e.320fba40.js => 6d2e526e.9f2d8c5b.js} | 2 +- assets/js/7357a3c5.6005cc6b.js | 1 + assets/js/7357a3c5.65cb2696.js | 1 - assets/js/7ad5624c.04d03f97.js | 1 + assets/js/7ad5624c.171e57a2.js | 1 - assets/js/7ef59f7a.4a732e7a.js | 1 + assets/js/7ef59f7a.93721c1a.js | 1 - assets/js/851f8f65.8c63ba6b.js | 1 - assets/js/851f8f65.b07419f4.js | 1 + assets/js/98334e25.163938f2.js | 1 + assets/js/98334e25.257eca44.js | 1 - assets/js/9c9cb35e.b86e5973.js | 1 + assets/js/9c9cb35e.ed86382c.js | 1 - assets/js/{9cd612ce.b0d1b7a3.js => 9cd612ce.b75be620.js} | 2 +- assets/js/{ac7da374.68a5f06c.js => ac7da374.4a1b8c9b.js} | 2 +- assets/js/b2e6bd40.102fca2b.js | 1 + assets/js/b2e6bd40.fc3ba422.js | 1 - assets/js/{b93339ed.a0b3573e.js => b93339ed.bc214206.js} | 2 +- assets/js/c195e1f1.0541c66c.js | 1 + assets/js/c195e1f1.abecfe08.js | 1 - assets/js/c4fbe420.1bb5b9be.js | 1 - assets/js/c4fbe420.8c4aab4f.js | 1 + assets/js/{c7e3ab5f.0a9740c7.js => c7e3ab5f.cf9a081c.js} | 2 +- assets/js/{d0524430.388e6290.js => d0524430.5aa106b8.js} | 2 +- assets/js/d480dde9.1c9a3b71.js | 1 - assets/js/d480dde9.a2cfa06b.js | 1 + assets/js/da66eb9c.717af639.js | 1 + assets/js/da66eb9c.78d6bb4e.js | 1 - .../js/{runtime~main.2b1efa87.js => runtime~main.a9b37470.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/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 | 4 ++-- 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/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/index.html | 2 +- .../help/New-Document/edit-document-before-sending/index.html | 2 +- docs/help/New-Document/enforce-email-verification/index.html | 2 +- docs/help/New-Document/navigate-between-pages/index.html | 2 +- docs/help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/OpenSign™ Drive/create-document/index.html | 2 +- docs/help/OpenSign™ Drive/list-grid-view/index.html | 2 +- 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/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 +- 190 files changed, 172 insertions(+), 172 deletions(-) rename assets/js/{02e5f5c4.eb16148c.js => 02e5f5c4.60be571e.js} (77%) delete mode 100644 assets/js/03e06346.9e9eb20c.js create mode 100644 assets/js/03e06346.fd769b08.js create mode 100644 assets/js/138cee78.2ff83df9.js delete mode 100644 assets/js/138cee78.40b50d00.js rename assets/js/{18b84479.4249218d.js => 18b84479.33c9f705.js} (77%) create mode 100644 assets/js/19e5ad2a.e44b2367.js delete mode 100644 assets/js/19e5ad2a.f969e353.js rename assets/js/{1c57a399.9642dc06.js => 1c57a399.e05f6301.js} (97%) delete mode 100644 assets/js/23f866da.9ad181d3.js create mode 100644 assets/js/23f866da.e170b9c6.js delete mode 100644 assets/js/34593b53.1df317b0.js create mode 100644 assets/js/34593b53.e3542020.js rename assets/js/{4227e71a.47aa6633.js => 4227e71a.3f44a353.js} (87%) rename assets/js/{5144c8d4.79e73705.js => 5144c8d4.d7ccdb73.js} (83%) delete mode 100644 assets/js/58abd73c.66f4fead.js create mode 100644 assets/js/58abd73c.7661f930.js create mode 100644 assets/js/5a144266.804e9e11.js delete mode 100644 assets/js/5a144266.e4fd7cb0.js delete mode 100644 assets/js/5ce6d213.60832077.js create mode 100644 assets/js/5ce6d213.827e01c6.js rename assets/js/{62b755e6.2a78d705.js => 62b755e6.4db3ade4.js} (91%) rename assets/js/{6d2e526e.320fba40.js => 6d2e526e.9f2d8c5b.js} (83%) create mode 100644 assets/js/7357a3c5.6005cc6b.js delete mode 100644 assets/js/7357a3c5.65cb2696.js create mode 100644 assets/js/7ad5624c.04d03f97.js delete mode 100644 assets/js/7ad5624c.171e57a2.js create mode 100644 assets/js/7ef59f7a.4a732e7a.js delete mode 100644 assets/js/7ef59f7a.93721c1a.js delete mode 100644 assets/js/851f8f65.8c63ba6b.js create mode 100644 assets/js/851f8f65.b07419f4.js create mode 100644 assets/js/98334e25.163938f2.js delete mode 100644 assets/js/98334e25.257eca44.js create mode 100644 assets/js/9c9cb35e.b86e5973.js delete mode 100644 assets/js/9c9cb35e.ed86382c.js rename assets/js/{9cd612ce.b0d1b7a3.js => 9cd612ce.b75be620.js} (77%) rename assets/js/{ac7da374.68a5f06c.js => ac7da374.4a1b8c9b.js} (82%) create mode 100644 assets/js/b2e6bd40.102fca2b.js delete mode 100644 assets/js/b2e6bd40.fc3ba422.js rename assets/js/{b93339ed.a0b3573e.js => b93339ed.bc214206.js} (78%) create mode 100644 assets/js/c195e1f1.0541c66c.js delete mode 100644 assets/js/c195e1f1.abecfe08.js delete mode 100644 assets/js/c4fbe420.1bb5b9be.js create mode 100644 assets/js/c4fbe420.8c4aab4f.js rename assets/js/{c7e3ab5f.0a9740c7.js => c7e3ab5f.cf9a081c.js} (84%) rename assets/js/{d0524430.388e6290.js => d0524430.5aa106b8.js} (98%) delete mode 100644 assets/js/d480dde9.1c9a3b71.js create mode 100644 assets/js/d480dde9.a2cfa06b.js create mode 100644 assets/js/da66eb9c.717af639.js delete mode 100644 assets/js/da66eb9c.78d6bb4e.js rename assets/js/{runtime~main.2b1efa87.js => runtime~main.a9b37470.js} (88%) diff --git a/404.html b/404.html index 776ce862c..3730f9601 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/02e5f5c4.eb16148c.js b/assets/js/02e5f5c4.60be571e.js similarity index 77% rename from assets/js/02e5f5c4.eb16148c.js rename to assets/js/02e5f5c4.60be571e.js index 7080336cc..f287d15a6 100644 --- a/assets/js/02e5f5c4.eb16148c.js +++ b/assets/js/02e5f5c4.60be571e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>I,contentTitle:()=>g,default:()=>z,frontMatter:()=>j,metadata:()=>r,toc:()=>w});const r=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+m2b0vgbv0jbR0ZrNEBy8hGqEWp0mr68thPZAbkWv9qfkVuIUvarsffmOhJVJ6ITChZkvY0YBznzy9fwOKz8VRkgz37fwz35MXF189eXj3jYPghTYCdjk/H00jsjQ8t6sFNB9+qx5ttvWdiv+/DdrvJA92HiVUoI32KCa23zOf28HN3lomGiVF+K9ZrnqofndpsWPxzR45Z1SwTC3QSC17Ot7NN1pMApkp3tOKcUtAn13w7q6su8YkjKsksJlmclyXZ8FHdIXe7fHV1LTJRbD/JW1OxjcMlf67jkokEf9THzRW/qFm2Fgp13WHNuskn8xZ+9g5Jz10kPdt/OKv+SK8GER6yoZQG/+WkPmiwXidCtdns9NPRb1psge21uXqzzWbzX6rM87U=","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 s=o(74848),a=o(28453),n=o(33617),l=o.n(n),i=o(17543),d=o.n(i),p=o(86013),c=o.n(p),m=o(63723),f=o.n(m),u=(o(18766),o(79329),o(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+m2b0vgbv0jbR0ZrNEBy8hGqEWp0mr68thPZAbkWv9qfkVuIUvarsffmOhJVJ6ITChZkvY0YBznzy9fwOKz8VRkgz37fwz35MXF189eXj3jYPghTYCdjk/H00jsjQ8t6sFNB9+qx5ttvWdiv+/DdrvJA92HiVUoI32KCa23zOf28HN3lomGiVF+K9ZrnqofndpsWPxzR45Z1SwTC3QSC17Ot7NN1pMApkp3tOKcUtAn13w7q6su8YkjKsksJlmclyXZ8FHdIXe7fHV1LTJRbD/JW1OxjcMlf67jkokEf9THzRW/qFm2Fgp13WHNuskn8xZ+9g5Jz10kPdt/OKv+SK8GER6yoZQG/+WkPmiwXidCtdns9NPRb1psge21uXqzzWbzX6rM87U=",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,I={},w=[];function h(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{title:"Body",body:{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,s.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 z(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file +"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/03e06346.9e9eb20c.js b/assets/js/03e06346.9e9eb20c.js deleted file mode 100644 index 008ba7ed8..000000000 --- a/assets/js/03e06346.9e9eb20c.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:()=>g,contentTitle:()=>b,default:()=>f,frontMatter:()=>x,metadata:()=>i,toc:()=>j});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":"eJztPF1zGzeSfwU3tVWJeUOKpCRb0dbVnZJ4E996bZUtX+pO0irgTJMDawaYABhRjIpV+7D/4J7udX9afslVN4DhDD8k2VYS+Y55cMTBV3ejG+hudPdNZPnERIen0QkUZc4tmOg8jlIwiRalFUpGh9FJBuy4GuUiYaEXOzp+wXieq6lhlQFtmFUs0YBNNszEbMYtM6CvgHHDRnkFpRbSGjZWmk1AguZWyAlLVVIVgA1TYTNWakhhLCSkzFhdJbbSYHrshwwk4/X0TBhmqiQBY8ZVns/88mnMbObg02ArLQ3jrJLipwpYpxMGX4i002FcpoyzTqck5C4qnXc6PYbotr/hUu53PmOclhSjHGh8wWdsBMxkXEPq4OdyRkSJGUg+yhFDm0GBJPJIu6FGTGQD9xE3kDIlCf4AaI99r6ZwhZM1PzNhDeRjlnAplUUACpWKsYCU2UyrapIxmwnD3r15+UcmLPZjSuYEaoXL4A6EpR3lhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/5pMcwqht9OO51vYVRN2LsXnc75l5m1pTnc2eFl2VMlSJwv5yPTS1Sxk2LHMh0/idk0Aw04KwEH3Agkboo0TCdgDSEsWaLKGUuU0qmQyFQxK/kEmKyKEWgTuz1QGphA5tDA01nXqm5lgP3729evENGC2x47zisT18ulQkNikWlweqRswOoLtxFP95D3hJzErOCXuIXCsp8qkVwi2gZkiv/3nEa06nTeVmWptIWU/eBQOOx0sOVryNWUcQ3UP1FFoSQrueYFWBIdFBNs1vBTJRZslOeBFodnsovcOyvhsNNhL2QqEi9hwPArU2Pft+e6IpGw69sSEuQL17VBOmS0aSaSjGgy5W4/y5wnDkwNpoTEiitoT3wdsxlO/C1IFSDIlBY/K2l5TttxBdqKhOfNbUMAsauxXJPMl0pIG776Fdh/+u3B3aNN8XyFoKVIrEJIajHArnhegfFQTWOWIVRvoNRgSJz8vCSPKctATLKN6/H0fWVsa2JWGS+4NRR+rbBLRF4gso15boCJcYuWBb+ExmpM0XnK8x77esZSGPMqtzETyHFWV9Bjr5RlvCxzkXA8XVBEUXg4nn9d2mXPDh4QyQva42OtrkQKeNClYjwGjcKJjTSFHxOgQz4raQCiR5JjMzodljY6UbnSqyxEn9t0ZImSFqTtsaMrLnIC3iFrmJBJXqXARjlPLmO6A2Km8ZTGXZkBXiGx43fqgheFoznRhxnIkQuVRPil8svj0e+hSvHAxvM5yBM2BlLTIsI0qeqldqxwZSRBEDEGBRd5TISL2Xs1YlbYHGIU2JLLWcxSbiFmFq7tSF3HLMkguaS/NE+FYqPKWiUdYqlWZaqm0tNyrKQ14uc1EhlaPpyiw5jtxexpzA5iNujHbDCM2WAvZoOnMRscxGzYj9lwGLPhXsyGTx1YwwNPa14TuAnAYOiobD8f6uK5+1IYkmw8ME19Bk9bZ/CgxzqdWprw248//ngmb84kY2cRCtdZdMjOorrLWRS7NjwzsW3gf1/jj93hM/9zhj+fDg/8zyl1Hez5nxn+HA7O5NwveCaHBInlRXkLFNj8oBD4X56J8Bstit/CeYYf8SCKQwPuVQsebJg3cdlFXIQUVvDcbEYn9HhEGC1AWkFqD5Eidt2METU/InSa8GALHZOuiY7VRlMQeIJiuIL9fs/fLJuRd8s+Gtwb4Hwa6k8RdTyaTvBo2ox/fXo9IiIsw/RplHjWIwWATubNdPAdHhEV2hB9Gg0OkAZ4KW0mALY+Iuwb4GCDv+FdW3+vO9jvDvvDvRYF0DZyHYqim6bd2Wz2ENRDnccvjypP0FCdZofm61irYo35QdbBopfXiejvoLL/BRX1UdBhIUW7jwyLoLHUFl9Ty7Yq5bMvjJsqDK2VM+y/UM1mDTCpCeEg6zfJlEg88NgnqGQjNPB6SIMuUXInTXcalMSPadotiu7SR/zZJcI3PhZFL017Sz1Xdsd9LFiaxmz189rvacqKotjw2X1vfd4pilUsekXhYSPl66seOVVIZ9ssJ77DbyUqC4loL3yrGKHnAD0k2EDm3Ho5WrpsMiF9g2cqttRBw6TKuYZrtEuNUNL1fngZCyK20OzJjiUT0HmOiBTsy9dee3/i2R9RaE+AX+4et4IZTnLEkspYVTANE7hmJbcWtKTJrnguUudm6tIHuOZFiSbAzl/PztJ//sMOOSDQxrfOV5WKiUA/0M5fT4+6/3W+pkdVlqATboDlgCuZmIFNeuw0g7xcuKKm02lvumuSTKnc+aHeGw1j9++FGr2/IHDLHjflk3WYOtZoGPzIOsv2vgHbohg3LIxcY/ITj5EMDfp023p755br1vd4RDfOEkjY6Lwn2Hx6FhWcFBJkZVj8rWwG+iw6r8c4Ix/SO8ae30NYM5FCzkeQrzbdW9DqzzmfqcrLd3BqtVH1HN2gGzYUQtZ+C0KnHzca+fVSo2ubr5FvR5CmdIYrJ4hn2AGWCxM8N21yNkd71xY5HCUA+TDRee0HsFHNpZ8sBTVg9xMDdxL5vbtjCezHqGPtVgyr3bFCa2OahME5CiFFURW1f3RczxpIVnjdo0kvHInO/rBCc3dXVuDXd6yAzsjNC5zJAfkxgv/jFs3U93hEZ8USSLeL8cecIq17+oEu2LsFMKDVFMA11zJ2dRdyLXxms/T12Gu83tAn6wahly1JoLTokftU0axBvvcNRT6rph9uM+c1ez0i7lsD1q/Mgb7fQ98+H8WkTew/I0ZtgX1vZnVOyYJPbrHcqfkRsaeHZ8UJ0ekcaxiLPG88KbLwKbzs4JMO5FD4Zy//mIhXHTnChbQKzYLwbDuCMb2XWnpGab5bu3vGbWnzTdQ9ECvNMm6c/k0KP24VPtji4/aSKz6AtnDHCxngxl0ZPJzdOPyq39ynwdP91j7t91v71N+0T7eYjbiDplTS1L42WDQ15Jq2OHxfvVqWxTZMilv6XOLbSrAenDCoKk9ZLi7pVSUVpsz5DHc1SKmHcvm57ptMKbPo4V/MvvQIH7Zf4pTGx7gnvfph4j4Or6XNaOzF4NluYyv2Dw7aEtMSmPvY74v1Vnehv7cz2N9xHq31Dq2FG2bzIXyLJsDYffaL/ET32i/qudiwrdvpY91OD8Puuw9pdQ+eDVuXxW7/Yy+LBzeum1Jzh1n9EMbzg1mxTXG7p/36m9mRn859e7+GRj14ttvkwmeDB3ChblCcP5UTV/TjB+M99lDK8ToGvId2fKtK/MkM2gT2V2fS/YfRpAf9lob2VUtB+2rYZMr9/XsxZXPRJc46i8R/fP36zbT/5+8m6ujo6OjV23fZ83eTo6OjAn/3er21RtS63aZlUHP1EYH+XqY7fsMqvV4PSZhyyw9p+E4pJ3904+PNY3r+9flX8uzsP8RjyhoHzqefAnXX389b8+vJ+adKYBRHqqQgaSVfpNFh5IKQQxBwFJNpCcZ+rdJZdHgT+bAx/NMHZeHQnfcG47hvIpNkUHD8K5ikGPk9FjlOhZFPoE0URxRHgGHgyHXRYaRG7yGxUYxvXCU6IsDgHDTu8Cb0cuGyUeyV8OgwclwfxZF/6ak/MZCJwrfbMh1H87DgbVPVXxZTGfqjjojGeTAi9SOnoaHzpcj3j5qpOcN8QdbFZFxrPouWg+xDKGp4R3Tj6li7fBYuB2HRFVLHR1K3KI6EhaK5yoZN0+rDKZ2AQkwoxuhDx9K28OKD18RxZabkRw303oc1NL8nlVzr6sLtLTvCIEdIg1baXUTrxowi5np3cUzoT9jySXNN90awsubJpijuRvCoycgU5WUJXPcomPqj4/Qpr4PnSUVZB/Wx2MKsBrXGbDCPo+u7kblmieqGEHH2ZQ5j6550WaK0BP2kGSfyaJAb7u3N42h2N3qzzxK9Z7h507ux+4Fi6xd5B78HrLsH8zjK7ob1+zr6/3cEdu/pfHHXRS5bqc5HGql0dhHOrfldHcOlgv0wF+WFfK1T0A1CjJTKgcsVSrwYO++6Yl+gxfFF7AIpKGhbaBMuFDZFB7OGBDABhOKrwlnFvM7hIrqZD6RFp/xz/EBqkqlGBnvJMJ9xE46AWS0mE0Cfs+9Bg31YOvAkw+QaH97Bx8HLVmq4EqoyATx0RGOwXw6WUp5A6DpxqWUVNahD7u4m7r3m7uAXvOQwYwtenxzfg5ZksnVdopW7px2Wbg72+uQYU2HE2KthPfbO1JQIpOWtLgzVInYleAiXr8/2mXt8Bud3VC53rOmj7/kklC5bBSgVZi1EsUvhwzj9OolvZeJFrhRukaos+vyFzwAwFkrToiNBURPyRFX34co7KMnZpKJYP4siG/JiKNxnkcoipEsWJH0/rXTI3vFsgT0xcW9Bp0AV7NSYH7P2jBvO2Zgbi7l3lRRIeV2hdl9PCdclaAEygbUk0OBIh0mEd2sT7byQd29e+gy5gEMQyhFKoJsYUlaVxDUkCXW+Uti5ZdRXFCWUDtAXmxS0VdWDsoq8K6IEbZREc0XpCZfiZ8fCpJGgtTOCjOeuqz8q0GWN8KCEt4EJZ+0vf/9HA66NGucqYG4FnqYYjHYHhGTSOYZHjVtDiSegakOE84H+t+VLAKEjoblwCZdOkMz9efyYwtdMfS76N7T6/c5USYYKfn3emjicscarlYZsRDIk6RGuRHzhWhjbyLgJcbGr58MbQDomDRhIDUGpRp6Xs6aAL94V1dJ0lBck2tla9TW4Igu8supCQyHk/e6pplfMqvogqKwquBUJC1OZXjsHzz29BLku2JcBNOTGK6H0kw2iitNdKJnAhZAXmHB7DwXvVR3Hk/IZMredAsgmbIFI7jpb5ElNKZe5SZPG7UTZgE0o99E8cI+n62yX2w3JwA/uKqFc22KEj/juGRhFjQ4OtbAl28bQ52JN+ffQrS31GRkbg37//7Ittdv/fGypvf5nZEsdILDefXr3AbRJv1l7dgR38O0D3ity2pAj9/ae6GWdx7Xzeh2BF+IwnLv/FuZfOPfvMAmdzbhw63pzJiBDZBj2+/i/pUMwVJTw5TNaNTX+KYrv71O+4xJYVN64nV5HVwfHRSmLJKOTvC7DcfuoJrP5r8Rnbjyy3r8GCET6L+01CjCmfWGsWcAXQLG3k6u5S0LmQsJF2IKLJee92+a9dXvyVhVgM1LmUI2faoV1KMocMNPB6hnjEy4kw2n0A24RaH0XM38YZLdRY6/fvxjURNhfJcILSfH1VMnlRF2C/G0xbS5v3fII6nWRL06USLhO1B61kG1+d0gaSCot7Cw6PL2Jrru8FF3Xfnh6Pj9HLrSZokceZQhibrPoMNpZefOhgjr4onB6E5Fc1MxvuEwxeGHltOWl2Lka9AbRPF4es/Z0vqU/VN0PHWIsnwg5uWvc+YJGb3Ef3Va1KLXQQEvxZ0AV1G9Es1ccCeSfDDiaGkh6ZI83i5ey52GTwxvWumepxWYuPzSFd6bW09HyLbnmMajxFnQaHmLobaV+WokWCEX18wf+WavgpwuWrd8Ogro7ID1xuLdHCtWzAWkeuwd0qe89nZ87AjechRSL2vR4ubCLluvGf2q7MqJoyXXQst+XzfeNpvQGS9ovuWQx1oCsM9T2W/bRGmqF+71NKwxMQFrt9olWe32i1UG/pVp4DBczLBQE0gJqJYBu+uZFj7f5OfKfkGNFzOs56nUJ8i362fBwIeZfUQghT1RR19PodMKQX/7+j3pUp1Ob487BiDEbryvNSjUFPa5cgY5xDtdUrQqHQUFthl4SKdKaFzkYg8+L0sKEalNR3h0697z7KOElH4lc4OnpookpLLFxALvqXPjSj01faJeGeAU5Hrq11d6o9MWmSl+OsXxYzDgbYa0d9NuAzLhMnIvInQTk6kCbFd1vpRYGSwhphFo42JS0mieWFVzyCfkqYtYkVgq5wOOSaTVCD6pReeV8hJaLXGkXREYI0Ss/EfH5dYlNpNWic01Dhrx75R2FJnaOWifkvgjVCH3iJcIiEiB/SSVzhfWi0Lde5TkrlXX+blSemzDicKu5NKjxOljCHtQE8z48MD7S+p0B3OGXQl66Gidddlrz1Q8wMsJCOwNyWf6etMd8J+z31QgrKCkjrNKzxeiJsFk1ouO6OUn9w830Xaht1jiMF3OkKjFrzACVmB1M1tx5CxY5xOwcHb+g6/4J++Vv/81eAteSZWrquDWpNOSzdhk1t/OObPVtTV5iXmEJMUtMKifh4SJQ8IeM21/+9j+GvYIpesucSLnIjaVyd6bTOWTfrC1vFzK2XBw9uu65rxXHciEve+zIV4NzLxzIDPidxn1ENbiTxupQGMivwDSqwEEqbKsGHLSA8ci1UwoQt6M0ZeVSWgG60hbgOG8RvURw5zbComprMhFaIf/tYkAgUyr7ZQ5ZqvnYLuaPV4vRrfkU0hQCOWI/Tb0lThLLtqpuXCTNkiLRPm81jIEK4pl2lb5SeHY6DWzJ2qnFH87WzmyUliekxoZLkpdirbMZi56Z1+O3oK9EEiydDRK9Q513ojjKRQLehvX319F3xy/Z1W6vH8UN9ewewr3z8sU3z1+9fY7A4EHqCDboDXp9MtCUsQWXjZWWZGf5bmtEKW0rS24rS24rS24rS24rS24rS24rS24rSz4q6m4rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rSz6Ws2JbWfKxFOzbVpb8LThwW1lyW1lyW1lyW1lyW1lyW1lyW1lyW1nyg51X28qS28qS28qS28qS28qS28qS28qS/08rSzYyo3bKnAtKYPR5ti738HS53uR5HGWYnHh4Gt3cIOe90/l8jp9/qigP6/Q8jq64FhixRXmNcUjDw1ysS5hFh9E3LgCte4Lrx26jKf59KZ0T8wjdiCPC/da+zfzJ49dvT6I4GvmamIVKKQ2bTzF3i09d+lojwYu+3UQ5l5OKksMiN+fclS3J2mmHl5R26P9oZJhxOWtA2M5HdGjgv4jU2gE3Ny6lcT6v+7umjSM8YUNv3L/z+Xz+v57+5X8=","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),p=t.n(c),h=t(63723),u=t.n(h),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:"eJztPF1zGzeSfwU3tVWJeUOKpCRb0dbVnZJ4E996bZUtX+pO0irgTJMDawaYABhRjIpV+7D/4J7udX9afslVN4DhDD8k2VYS+Y55cMTBV3ejG+hudPdNZPnERIen0QkUZc4tmOg8jlIwiRalFUpGh9FJBuy4GuUiYaEXOzp+wXieq6lhlQFtmFUs0YBNNszEbMYtM6CvgHHDRnkFpRbSGjZWmk1AguZWyAlLVVIVgA1TYTNWakhhLCSkzFhdJbbSYHrshwwk4/X0TBhmqiQBY8ZVns/88mnMbObg02ArLQ3jrJLipwpYpxMGX4i002FcpoyzTqck5C4qnXc6PYbotr/hUu53PmOclhSjHGh8wWdsBMxkXEPq4OdyRkSJGUg+yhFDm0GBJPJIu6FGTGQD9xE3kDIlCf4AaI99r6ZwhZM1PzNhDeRjlnAplUUACpWKsYCU2UyrapIxmwnD3r15+UcmLPZjSuYEaoXL4A6EpR3lhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/5pMcwqht9OO51vYVRN2LsXnc75l5m1pTnc2eFl2VMlSJwv5yPTS1Sxk2LHMh0/idk0Aw04KwEH3Agkboo0TCdgDSEsWaLKGUuU0qmQyFQxK/kEmKyKEWgTuz1QGphA5tDA01nXqm5lgP3729evENGC2x47zisT18ulQkNikWlweqRswOoLtxFP95D3hJzErOCXuIXCsp8qkVwi2gZkiv/3nEa06nTeVmWptIWU/eBQOOx0sOVryNWUcQ3UP1FFoSQrueYFWBIdFBNs1vBTJRZslOeBFodnsovcOyvhsNNhL2QqEi9hwPArU2Pft+e6IpGw69sSEuQL17VBOmS0aSaSjGgy5W4/y5wnDkwNpoTEiitoT3wdsxlO/C1IFSDIlBY/K2l5TttxBdqKhOfNbUMAsauxXJPMl0pIG776Fdh/+u3B3aNN8XyFoKVIrEJIajHArnhegfFQTWOWIVRvoNRgSJz8vCSPKctATLKN6/H0fWVsa2JWGS+4NRR+rbBLRF4gso15boCJcYuWBb+ExmpM0XnK8x77esZSGPMqtzETyHFWV9Bjr5RlvCxzkXA8XVBEUXg4nn9d2mXPDh4QyQva42OtrkQKeNClYjwGjcKJjTSFHxOgQz4raQCiR5JjMzodljY6UbnSqyxEn9t0ZImSFqTtsaMrLnIC3iFrmJBJXqXARjlPLmO6A2Km8ZTGXZkBXiGx43fqgheFoznRhxnIkQuVRPil8svj0e+hSvHAxvM5yBM2BlLTIsI0qeqldqxwZSRBEDEGBRd5TISL2Xs1YlbYHGIU2JLLWcxSbiFmFq7tSF3HLMkguaS/NE+FYqPKWiUdYqlWZaqm0tNyrKQ14uc1EhlaPpyiw5jtxexpzA5iNujHbDCM2WAvZoOnMRscxGzYj9lwGLPhXsyGTx1YwwNPa14TuAnAYOiobD8f6uK5+1IYkmw8ME19Bk9bZ/CgxzqdWprw248//ngmb84kY2cRCtdZdMjOorrLWRS7NjwzsW3gf1/jj93hM/9zhj+fDg/8zyl1Hez5nxn+HA7O5NwveCaHBInlRXkLFNj8oBD4X56J8Bstit/CeYYf8SCKQwPuVQsebJg3cdlFXIQUVvDcbEYn9HhEGC1AWkFqD5Eidt2METU/InSa8GALHZOuiY7VRlMQeIJiuIL9fs/fLJuRd8s+Gtwb4Hwa6k8RdTyaTvBo2ox/fXo9IiIsw/RplHjWIwWATubNdPAdHhEV2hB9Gg0OkAZ4KW0mALY+Iuwb4GCDv+FdW3+vO9jvDvvDvRYF0DZyHYqim6bd2Wz2ENRDnccvjypP0FCdZofm61irYo35QdbBopfXiejvoLL/BRX1UdBhIUW7jwyLoLHUFl9Ty7Yq5bMvjJsqDK2VM+y/UM1mDTCpCeEg6zfJlEg88NgnqGQjNPB6SIMuUXInTXcalMSPadotiu7SR/zZJcI3PhZFL017Sz1Xdsd9LFiaxmz189rvacqKotjw2X1vfd4pilUsekXhYSPl66seOVVIZ9ssJ77DbyUqC4loL3yrGKHnAD0k2EDm3Ho5WrpsMiF9g2cqttRBw6TKuYZrtEuNUNL1fngZCyK20OzJjiUT0HmOiBTsy9dee3/i2R9RaE+AX+4et4IZTnLEkspYVTANE7hmJbcWtKTJrnguUudm6tIHuOZFiSbAzl/PztJ//sMOOSDQxrfOV5WKiUA/0M5fT4+6/3W+pkdVlqATboDlgCuZmIFNeuw0g7xcuKKm02lvumuSTKnc+aHeGw1j9++FGr2/IHDLHjflk3WYOtZoGPzIOsv2vgHbohg3LIxcY/ITj5EMDfp023p755br1vd4RDfOEkjY6Lwn2Hx6FhWcFBJkZVj8rWwG+iw6r8c4Ix/SO8ae30NYM5FCzkeQrzbdW9DqzzmfqcrLd3BqtVH1HN2gGzYUQtZ+C0KnHzca+fVSo2ubr5FvR5CmdIYrJ4hn2AGWCxM8N21yNkd71xY5HCUA+TDRee0HsFHNpZ8sBTVg9xMDdxL5vbtjCezHqGPtVgyr3bFCa2OahME5CiFFURW1f3RczxpIVnjdo0kvHInO/rBCc3dXVuDXd6yAzsjNC5zJAfkxgv/jFs3U93hEZ8USSLeL8cecIq17+oEu2LsFMKDVFMA11zJ2dRdyLXxms/T12Gu83tAn6wahly1JoLTokftU0axBvvcNRT6rph9uM+c1ez0i7lsD1q/Mgb7fQ98+H8WkTew/I0ZtgX1vZnVOyYJPbrHcqfkRsaeHZ8UJ0ekcaxiLPG88KbLwKbzs4JMO5FD4Zy//mIhXHTnChbQKzYLwbDuCMb2XWnpGab5bu3vGbWnzTdQ9ECvNMm6c/k0KP24VPtji4/aSKz6AtnDHCxngxl0ZPJzdOPyq39ynwdP91j7t91v71N+0T7eYjbiDplTS1L42WDQ15Jq2OHxfvVqWxTZMilv6XOLbSrAenDCoKk9ZLi7pVSUVpsz5DHc1SKmHcvm57ptMKbPo4V/MvvQIH7Zf4pTGx7gnvfph4j4Or6XNaOzF4NluYyv2Dw7aEtMSmPvY74v1Vnehv7cz2N9xHq31Dq2FG2bzIXyLJsDYffaL/ET32i/qudiwrdvpY91OD8Puuw9pdQ+eDVuXxW7/Yy+LBzeum1Jzh1n9EMbzg1mxTXG7p/36m9mRn859e7+GRj14ttvkwmeDB3ChblCcP5UTV/TjB+M99lDK8ToGvId2fKtK/MkM2gT2V2fS/YfRpAf9lob2VUtB+2rYZMr9/XsxZXPRJc46i8R/fP36zbT/5+8m6ujo6OjV23fZ83eTo6OjAn/3er21RtS63aZlUHP1EYH+XqY7fsMqvV4PSZhyyw9p+E4pJ3904+PNY3r+9flX8uzsP8RjyhoHzqefAnXX389b8+vJ+adKYBRHqqQgaSVfpNFh5IKQQxBwFJNpCcZ+rdJZdHgT+bAx/NMHZeHQnfcG47hvIpNkUHD8K5ikGPk9FjlOhZFPoE0URxRHgGHgyHXRYaRG7yGxUYxvXCU6IsDgHDTu8Cb0cuGyUeyV8OgwclwfxZF/6ak/MZCJwrfbMh1H87DgbVPVXxZTGfqjjojGeTAi9SOnoaHzpcj3j5qpOcN8QdbFZFxrPouWg+xDKGp4R3Tj6li7fBYuB2HRFVLHR1K3KI6EhaK5yoZN0+rDKZ2AQkwoxuhDx9K28OKD18RxZabkRw303oc1NL8nlVzr6sLtLTvCIEdIg1baXUTrxowi5np3cUzoT9jySXNN90awsubJpijuRvCoycgU5WUJXPcomPqj4/Qpr4PnSUVZB/Wx2MKsBrXGbDCPo+u7kblmieqGEHH2ZQ5j6550WaK0BP2kGSfyaJAb7u3N42h2N3qzzxK9Z7h507ux+4Fi6xd5B78HrLsH8zjK7ob1+zr6/3cEdu/pfHHXRS5bqc5HGql0dhHOrfldHcOlgv0wF+WFfK1T0A1CjJTKgcsVSrwYO++6Yl+gxfFF7AIpKGhbaBMuFDZFB7OGBDABhOKrwlnFvM7hIrqZD6RFp/xz/EBqkqlGBnvJMJ9xE46AWS0mE0Cfs+9Bg31YOvAkw+QaH97Bx8HLVmq4EqoyATx0RGOwXw6WUp5A6DpxqWUVNahD7u4m7r3m7uAXvOQwYwtenxzfg5ZksnVdopW7px2Wbg72+uQYU2HE2KthPfbO1JQIpOWtLgzVInYleAiXr8/2mXt8Bud3VC53rOmj7/kklC5bBSgVZi1EsUvhwzj9OolvZeJFrhRukaos+vyFzwAwFkrToiNBURPyRFX34co7KMnZpKJYP4siG/JiKNxnkcoipEsWJH0/rXTI3vFsgT0xcW9Bp0AV7NSYH7P2jBvO2Zgbi7l3lRRIeV2hdl9PCdclaAEygbUk0OBIh0mEd2sT7byQd29e+gy5gEMQyhFKoJsYUlaVxDUkCXW+Uti5ZdRXFCWUDtAXmxS0VdWDsoq8K6IEbZREc0XpCZfiZ8fCpJGgtTOCjOeuqz8q0GWN8KCEt4EJZ+0vf/9HA66NGucqYG4FnqYYjHYHhGTSOYZHjVtDiSegakOE84H+t+VLAKEjoblwCZdOkMz9efyYwtdMfS76N7T6/c5USYYKfn3emjicscarlYZsRDIk6RGuRHzhWhjbyLgJcbGr58MbQDomDRhIDUGpRp6Xs6aAL94V1dJ0lBck2tla9TW4Igu8supCQyHk/e6pplfMqvogqKwquBUJC1OZXjsHzz29BLku2JcBNOTGK6H0kw2iitNdKJnAhZAXmHB7DwXvVR3Hk/IZMredAsgmbIFI7jpb5ElNKZe5SZPG7UTZgE0o99E8cI+n62yX2w3JwA/uKqFc22KEj/juGRhFjQ4OtbAl28bQ52JN+ffQrS31GRkbg37//7Ittdv/fGypvf5nZEsdILDefXr3AbRJv1l7dgR38O0D3ity2pAj9/ae6GWdx7Xzeh2BF+IwnLv/FuZfOPfvMAmdzbhw63pzJiBDZBj2+/i/pUMwVJTw5TNaNTX+KYrv71O+4xJYVN64nV5HVwfHRSmLJKOTvC7DcfuoJrP5r8Rnbjyy3r8GCET6L+01CjCmfWGsWcAXQLG3k6u5S0LmQsJF2IKLJee92+a9dXvyVhVgM1LmUI2faoV1KMocMNPB6hnjEy4kw2n0A24RaH0XM38YZLdRY6/fvxjURNhfJcILSfH1VMnlRF2C/G0xbS5v3fII6nWRL06USLhO1B61kG1+d0gaSCot7Cw6PL2Jrru8FF3Xfnh6Pj9HLrSZokceZQhibrPoMNpZefOhgjr4onB6E5Fc1MxvuEwxeGHltOWl2Lka9AbRPF4es/Z0vqU/VN0PHWIsnwg5uWvc+YJGb3Ef3Va1KLXQQEvxZ0AV1G9Es1ccCeSfDDiaGkh6ZI83i5ey52GTwxvWumepxWYuPzSFd6bW09HyLbnmMajxFnQaHmLobaV+WokWCEX18wf+WavgpwuWrd8Ogro7ID1xuLdHCtWzAWkeuwd0qe89nZ87AjechRSL2vR4ubCLluvGf2q7MqJoyXXQst+XzfeNpvQGS9ovuWQx1oCsM9T2W/bRGmqF+71NKwxMQFrt9olWe32i1UG/pVp4DBczLBQE0gJqJYBu+uZFj7f5OfKfkGNFzOs56nUJ8i362fBwIeZfUQghT1RR19PodMKQX/7+j3pUp1Ob487BiDEbryvNSjUFPa5cgY5xDtdUrQqHQUFthl4SKdKaFzkYg8+L0sKEalNR3h0697z7KOElH4lc4OnpookpLLFxALvqXPjSj01faJeGeAU5Hrq11d6o9MWmSl+OsXxYzDgbYa0d9NuAzLhMnIvInQTk6kCbFd1vpRYGSwhphFo42JS0mieWFVzyCfkqYtYkVgq5wOOSaTVCD6pReeV8hJaLXGkXREYI0Ss/EfH5dYlNpNWic01Dhrx75R2FJnaOWifkvgjVCH3iJcIiEiB/SSVzhfWi0Lde5TkrlXX+blSemzDicKu5NKjxOljCHtQE8z48MD7S+p0B3OGXQl66Gidddlrz1Q8wMsJCOwNyWf6etMd8J+z31QgrKCkjrNKzxeiJsFk1ouO6OUn9w830Xaht1jiMF3OkKjFrzACVmB1M1tx5CxY5xOwcHb+g6/4J++Vv/81eAteSZWrquDWpNOSzdhk1t/OObPVtTV5iXmEJMUtMKifh4SJQ8IeM21/+9j+GvYIpesucSLnIjaVyd6bTOWTfrC1vFzK2XBw9uu65rxXHciEve+zIV4NzLxzIDPidxn1ENbiTxupQGMivwDSqwEEqbKsGHLSA8ci1UwoQt6M0ZeVSWgG60hbgOG8RvURw5zbComprMhFaIf/tYkAgUyr7ZQ5ZqvnYLuaPV4vRrfkU0hQCOWI/Tb0lThLLtqpuXCTNkiLRPm81jIEK4pl2lb5SeHY6DWzJ2qnFH87WzmyUliekxoZLkpdirbMZi56Z1+O3oK9EEiydDRK9Q513ojjKRQLehvX319F3xy/Z1W6vH8UN9ewewr3z8sU3z1+9fY7A4EHqCDboDXp9MtCUsQWXjZWWZGf5bmtEKW0rS24rS24rS24rS24rS24rS24rS24rSz4q6m4rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rSz6Ws2JbWfKxFOzbVpb8LThwW1lyW1lyW1lyW1lyW1lyW1lyW1lyW1nyg51X28qS28qS28qS28qS28qS28qS28qS/08rSzYyo3bKnAtKYPR5ti738HS53uR5HGWYnHh4Gt3cIOe90/l8jp9/qigP6/Q8jq64FhixRXmNcUjDw1ysS5hFh9E3LgCte4Lrx26jKf59KZ0T8wjdiCPC/da+zfzJ49dvT6I4GvmamIVKKQ2bTzF3i09d+lojwYu+3UQ5l5OKksMiN+fclS3J2mmHl5R26P9oZJhxOWtA2M5HdGjgv4jU2gE3Ny6lcT6v+7umjSM8YUNv3L/z+Xz+v57+5X8=",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,g={},j=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"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:"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.p,{children:[(0,s.jsx)(n.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.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)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",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/03e06346.fd769b08.js b/assets/js/03e06346.fd769b08.js new file mode 100644 index 000000000..fdcf9e9fe --- /dev/null +++ b/assets/js/03e06346.fd769b08.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:()=>b,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>y});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":"eJztPF1zGzeSfwU3tVWJeUOKpCRb0dbVnZJ4E996bZUtX+pO0irgTJMDawaYABhRjIpV+7D/4J7udX9afslVN4DhDD8k2VYS+Y55cMTBV6M/gO5Gd99Elk9MdHganUBR5tyCic7jKAWTaFFaoWR0GJ1kwI6rUS4SFnqxo+MXjOe5mhpWGdCGWcUSDdhkw0zMZtwyA/oKGDdslFdQaiGtYWOl2QQkaG6FnLBUJVUB2DAVNmOlhhTGQkLKjNVVYisNpsd+yEAyXk/PhGGmShIwZlzl+cwvn8bMZg4+DbbS0jDOKil+qoB1OmHwhUg7HcZlyjjrdEra3EWl806nx3C77W+4lPudzxinJcUoBxpf8BkbATMZ15A6+LmcEVJiBpKPctyhzaBAFPlNu6FGTGRj7yNuIGVKEvwB0B77Xk3hCidrfmbCGsjHLOFSKosAFCoVYwEps5lW1SRjNhOGvXvz8o9MWOzHlMwJ1AqXQQqEpR3mhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/5pMcwqht9OO51vYVRN2LsXnc75l5m1pTnc2eFl2VMlSJwv5yPTS1Sxk2LHMh0/idk0Aw04KwEH3AhEboo4TCdgDW1YskSVM5YopVMhkaliVvIJMFkVI9AmdjRQGphA5tDA01nXqm5lgP3729evcKMFtz12nFcmrpdLhYbEItPg9IjZsKsvHCGe7iHvCTmJWcEvkYTCsp8qkVzitg3IFP/vOY1w1em8rcpSaQsp+8Ft4bDTwZavIVdTxjVQ/0QVhZKs5JoXYEl0UEywWcNPlViwUZ4HXByeyS5y76yEw06HvZCpSLyEAcOvTI19357rikjCrm9LSJAvXNcG6pDRpplIMsLJlDt6ljlPHJgaTAmJFVfQnvg6ZjOc+FuQKkCQKS1+VtLynMhxBdqKhOdNsiGA2NVYrknmSyWkDV/9Cuw/PXmQekQUz1cIWorIKoSkFgPsiucVGA/VNGYZQvUGSg2GxMnPS/KYsgzEJNu4Hk/fV8a2JmaV8YJbQ+HXClQi9AKhbcxzA0yMW7gs+CU0VmOKzlOe99jXM5bCmFe5jZlAjrO6gh57pSzjZZmLhOPpgiKKwsPx/OsSlT07eEAkL4jGx1pdiRTwoEvFeAwahRMbaQo/JkCHfFbSANweSY7N6HRYInSicqVXWYg+t/HIEiUtSNtjR1dc5AS826xhQiZ5lQIb5Ty5jOkOiJnGUxqpMgO8QmLH79QFLwqHc8IPM5AjFyqJ8Evll8ej30OV4oGN53OQJ2wMqKZFhGli1UvtWOHKiIIgYgwKLvKYEBez92rErLA5xCiwJZezmKXcQswsXNuRuo5ZkkFySX9pngrFRpW1SrqNpVqVqZpKj8uxktaIn9dIZGj5cIwOY7YXs6cxO4jZoB+zwTBmg72YDZ7GbHAQs2E/ZsNhzIZ7MRs+dWANDzyueY3gJgCDocOy/Xywi+fuS2FIsvHANPUZPG2dwYMe63RqacJvP/7445m8OZOMnUUoXGfRITuL6i5nUeza8MzEtoH/fY0/dofP/M8Z/nw6PPA/p9R1sOd/ZvhzODiTc7/gmRwSJJYX5S1QYPODQuB/eSbCb7QofgvnGX7EgygODUirFjzYMG/uZRf3IqSwgudm83ZCj0e0owVIK5vaw00Ru27eETU/ou004cEWOiZdEx2rjaYg8ATFcGX3+z1/s2zevFv20ey9Ac6nbf0pbh2PphM8mjbvvz69HhESlmH6NEw865ECQCfzZjz4Do8IC22IPg0HB4gDvJQ2IwBbH9HuG+Bgg7/hXVt/rzvY7w77w70WBtA2ch2Kopum3dls9hDYQ53HL48qT9BQnWaH5utYq2KN+UHWwaKX14no76Cy/wUV9VHQYSFFu48Mi6Cx1BZfU8u2KuWzL4ybKgytlTPsv1DNZg0wqQnhIOs3yZRIPPDYJ6hkIzTweoiDLmFyJ013GpjEj2naLYru0kf82SXENz4WRS9Ne0s9V6jjPhYsTWO2+nnt9zRlRVFs+Oy+tz7vFMXqLnpF4WEj5eurHjlVSGfbLCe+w28lKguJaC98qxih5wA9JNhA5tx6OVq6bDIhfYNnKrbUQcOkyrmGa7RLjVDS9X54GQsittDsyY4lE9B5jggV7MvXXnt/4tkft9CeAL/cPW5lZzjJEUsqY1XBNEzgmpXcWtCSJrviuUidm6lLH+CaFyWaADt/PTtL//kPO+SAQBvfOl9VKiYC/UA7fz096v7X+ZoeVVmCTrgBlgOuZGIGNumx0wzycuGKmk6nvemuSTKlcueHem80jN2/F2r0/oLALXvclE/W7dSxRsPgR9ZZtvcN2BbGuGFh5BqTn3iMZGjQp9vW2zu3XLe+xyO6cZZAwkbnPcHm07Oo4KSQICvD4m9lM9Bn0Xk9xhn5kN4x9vwewpqJFHI+gny16d6CVn/O+UxVXr6DU6u9Vc/RDbxhQyFk7beg7fTjRiO/Xmp0bfM18u0Q0pTOcOUE8QwUYLkwwXPTRmdztHdtkcNRApAPE53XfgAb1Vz6yVJQA3Y/MXAnkafdHUtgP0Yda7diWO2OFVqEaSIG5yiEFEVV1P7RcT1rQFnhdY8mvnAkOvvDCk3qrqzAr+9YAZ2Rmxc4kwPyYwT/xy2aqe/xiM6KJZBuF+OPOUVa9/QDXbB3C2DYVlMA11zL2NVdyLXwmc3S12Ov8XpDn6wbhF62JIHSokfuU0WzBvneNxT5rJp+uM2c1+z1iLhvDVi/Mgf6fg99+3wUkzZ3/xkxagvsezOrc0oWfHKL5U7Nj4g9PTwrTohO51jDWOR540mRhU/hZQefdCCHwj97+cdEvOrIES6kVWgWhGfbEYzpvdTSM0rz3drdM46kzTdR90CsNMu4cfo3KfxIKnywxcftJVd8AG3hjhcywI1UGTyc3Tj8qt+k0+DpfotO+/0Wnfqb6HSL2YgUNKWSpva1waKpIddE4vB99WpZFtswKZL0ucS3lWA9OGFQVZ6yXFzSq0oqTJnzGVI1SKmHcvm57ptMKbPo4V/MvvQbPmy/xCmNj3FPevXDxH0cXkvEaNBi8Gy3QYr9g4O2xLQE5j72+2K9VSr093YG+zvOo7XeobVww2w+hG/RBBi7D73IT3QvelHPBcG2bqePdTs9DLvvPqTVPXg2bF0Wu/2PvSwe3LhuSs0dZvVDGM8PZsU2xe2e9utvZkd+Ovft/Roa9eDZbpMLnw0ewIW6QXH+VE5c0Y8fjPfYQynH6xjwHtrxrSrxJzNoE9hfnUn3H0aTHvRbGtpXLQXtq2GTKff378WUzUWXOOssEv/x9es30/6fv5uoo6Ojo1dv32XP302Ojo4K/N3r9dYaUeuoTcug5uojAv29THf8hlV6vR6iMOWWH9LwnVJO/ujGx5vH9Pzr86/k2dl/iMeUNQ6cTz8F6q6/n7fm15PzT5XAKI5USUHSSr5Io8PIBSGHIOAoJtMSjP1apbPo8CbyYWP4pw/KwqE77w3Gcd9EJsmg4PhXMEkx8nsscpwKI59AmyiOKI4Aw8CR66LDSI3eQ2KjGN+4SnREgME5aNzhTejlwmWj2Cvh0WHkuD6KI//SU39iIBOFb7dlOo7mYcHbpqq/LKYy9EcdEY3zYETqR05DQ+dLke8fNVNzhvkCrYvJuNZ8Fi0H2YdQ1PCO6MbVsXb5LFwOwqIrpI6PpG5RHAkLRXOVDUTT6sMxnYDCnVCM0YeOJbLw4oPXxHFlpuRHDfRhIB8z9L0aXXwUO+Jg7/VYQ+t7Use1ri7cZpUjDK6ENGjD3UWUcMwoUq93F6eG/oRlPmmu6d4mVtY82RQ93ghaNRmZwLwsgeseBXF/dH4A5ZPwPKko26E+jls7q0GtdzaYx9H13Zu5ZonqhtB09mUOY+ueklmitAT9pBmf8mg2N9zbm8fR7O7tzT7L7T1D4k3v3t0PFNO/yHf4PWDdPZjHUXY3rN/XWQe/I7B7T+eLOzZyWVJ1HtRIpbOLcG7N7+oYLjPshzkwL+RrnYJuIGKkVA5crmDixdh59RX7Ai2dL2IXwEHB4kKbcJGxKTq2NSSAiScU1xXOKuZ1HRdJznwALz4GPMcPpJ6ZamSwlwzzGTfhCJjVYjIB9HX7HjTYh8MDTzJM6vFhJXwcvHulhiuhKhPAQwc43i45WEq1AqHrhKmWNdbADrnZm3vvNamDX/ByxUwxeH1yfA9ckqnYdQleTj9wu3RzsNcnx5iCI8Ze/euxd6bGREAtb3VhqI6xK8FDmH59ts/cozc4f6dyOWvNt4GeT37pslWAUmHWQhS71EHMD6iTB1cmXuRoIYlUZfGtQfjMA2OhNC08EhQ1Ik9UdR+uvAOTnE0qijG0KLIhH4fCjBYpNEK6JEWyM9JKh6whzxbYExMGF3gKWMFOjfkxW9C44ZyNubGY81dJgZjXFVoV9ZRwXYIWIBNYiwINDnWYvHi3NtHOR3n35qXPzAt7CEI5Qgl0E0PKqpK4hiShzpMKlFve+oqihNIB+mKTYriqelA2k3eBlKCNkmgmKT3hUvzsWJg0ErSyRpDx3HX1RwW6yhEelPA2MOGs/eXv/2jAtVHTXQXMrcDTFIPg7oCQTEnH8KjpayjxBFRtiHA+0P+2fAkgdCQ0Fy7R0wmSuT+PH1PYnKnPRf92V78bmirJ0LCoz1sThzPWeLXSkG1KBiw9/pW4X7gWxjYyfUI87ur58AYQj0kDBlJDUKqR5+WsKeCL90y1NB3lI4l2llh9Da7IAq+sutBQCHm/e6rpjbOqPggqqwpuRcLCVKbXzv1zTz5Brgv2ZQANufFKKP1kg6jidBdKJnAh5AUm+t5DwXtVxw+lfIbMbacAsglbQJK7zhb5WVPKoW7ipHE7URZiE8p9NA/co+062+V2Azbwg7tKKMe3GGHwgHt+RlGjg0MtbNi2MfS5WFP+HXZrS31Gxsag3/+/bEvt9j8fW2qv/xnZUgcIrHfb3n0AbdJv1p4dwQ19+4D3CpyHK1f69p7o3Z3HtdN8HYIX4jCcu/8W5l849+8wCZ3NuHAne3MmbIbQMOz38X9Lh2CoZOHLdrRqefxTFN/fl33HJbCo+HE7vo6uDo6LUhZJRid5Xf7j9lFNZvNfic/ceGS9fw0QiPRf2msUYEz7wlizgC+8Ym9HV5NKQuZCwkUgwcXSo4Ej8946mrxVBdiMlDlU46daYf2LMgfMsLB6xviEC8lwGv2AJAKt72LmD4PsNmzs9fsXgxoJ+6tIeCEprp8qyJyoS5C/7U6by1u3PIJ6XeSLEyUSrhO1R63NNr+7TRpIKi3sLDo8vYmuu7wUXdd+eHo+P0cutJmixyVlCGJus+gw2ll5a6JCPviScXoTkVzUzG+4TDFoYuW05aXYuRr0BtE8Xh6z9nS+pT9U3Q8dYiyfCDm5a9z5AkdvkY6OVC1MLTTQUvwZUAX1hGj2iiOB/JMBR1MDUY/s8WbxQvc8EDm8na17DlsQc/mBK7xvtZ6slm/JNY9QjTeo0/AARG869ZNOtNhQVD+7RFHjIQV/NJ5G8Getnp8u2Ll+Vwiq8IB0yOHeHilbzwaklewe0IW/93R+7pDfcCRSfGzTG+ZCQVpuHf+p7eaIoiW3Qsu2XzbtN5rZG6xsv+SSNVkDss6I22/ZTmuwFe7+Nq4wWAJxtdsnXO31CVcH/Zba4Xe4mGGhPJCGUCsIpAU0lQC86c+RN4UcK2JsT9HXJci36IPDg4cEY0VZhDxRRV3jo9MJQ375+z/qUZ1Obao75yPGkbyuNCvVFPS4ckVDxjlcUwUtHAYFtRl63aTob17kYAw+eUoLE6qXRbmA6PjzrqWEl3wkcoEnq4twplDJxuHsKoZh9AE2faFdauQV5Hgg1xZ9o/oYmyp9OcaSZjHjbIT1f9CnAzLjMnHuI3dKkBsE7Vl0zZVaGCxrpBFq4WBT0mqeWFZwySfkx4hZE1kp5AKPUqbVCL2rRuWV8x9aLnKlXWAbbYgiDwiJz69LbCKNF+VSQ4a8e+WdiCZ2Tlx3APjCWCP0l5cIi0iAfCmVzBXWsEK/e5XnrFTW+cJRsW7CiMOt5tKgNuxgCTSoEeb9e2B89Pc7A0jhl0JeurorXXZa89UPMDLCQjsrc1n+nrTHfCfs99UIqzopI6zSs8XoibBZNaKjvDlJ/cPN9F2ot9Y4qBdzpCoxa0wElZgdTCDdeQsWOcTsHB2/IFXgCfvlb//NXgLXkmVq6rg1qTTks3ZpN0d5h7b6JicPMq+wrJklJpWT8KgRMPhDxu0vf/sfw17BFD1pTqRcNMlSCT7T6Ryyb9aW3AtZZC62H9363NevY7mQlz125CvUudcPZAb8TuM+okLdSWN1KAzkV2AalekgFbZVlw5awPjNtdMccG9HacrKpVQHdLMtwHGeJHql4M6lhIXe1mRHtNIQ2gWKQKZUiswcslTzsV3MH68WyFvzKaROBHTEfpqaJE4Sy7Yab1x0z5KS0T5vNYyBivSZduXAUnh2Og1sydrpzh/O1s6klJYnpOKGS5KXYq0jGguxmdfjt6CvRBKsoA0SvUOdd6I4ykUC3r7199fRd8cv2dVurx/FDdXtHsK98/LFN89fvX2OwOBB6hA26PV7fTLelLEFl42VlmRn+W5rRE5tq11uq11uq11uq11uq11uq11uq11uq10+Kuxuq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq10+lrNiW+3ysRQR3Fa7/C04cFvtclvtclvtclvtclvtclvtclvtclvt8oOdV9tql9tql9tql9tql9tql9tql9tql/9Pq102MqN2ypwLSm70ObguL/F0uQbmeRxlmLh4eBrd3CDnvdP5fI6ff6ooD+v0PI6uuBYYsUU5j3FI0cNcrEvA7LZvXABa9wTXjx2hKf59KdUTcwzdiCPa+619m7mVx6/fnkRxNPJ1OguVUoo2n2LuFp+69LVGghd9u4lyLicVJYdFbs65K2mStVMSLykl0f/RyDDD1L0FhO1cRbcN/Bc3tXbAzY1Ld5zP6/6uaeMIj9jQG+l3Pp/P/xfm6hYZ","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),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),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:"eJztPF1zGzeSfwU3tVWJeUOKpCRb0dbVnZJ4E996bZUtX+pO0irgTJMDawaYABhRjIpV+7D/4J7udX9afslVN4DhDD8k2VYS+Y55cMTBV6M/gO5Gd99Elk9MdHganUBR5tyCic7jKAWTaFFaoWR0GJ1kwI6rUS4SFnqxo+MXjOe5mhpWGdCGWcUSDdhkw0zMZtwyA/oKGDdslFdQaiGtYWOl2QQkaG6FnLBUJVUB2DAVNmOlhhTGQkLKjNVVYisNpsd+yEAyXk/PhGGmShIwZlzl+cwvn8bMZg4+DbbS0jDOKil+qoB1OmHwhUg7HcZlyjjrdEra3EWl806nx3C77W+4lPudzxinJcUoBxpf8BkbATMZ15A6+LmcEVJiBpKPctyhzaBAFPlNu6FGTGRj7yNuIGVKEvwB0B77Xk3hCidrfmbCGsjHLOFSKosAFCoVYwEps5lW1SRjNhOGvXvz8o9MWOzHlMwJ1AqXQQqEpR3mhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/5pMcwqht9OO51vYVRN2LsXnc75l5m1pTnc2eFl2VMlSJwv5yPTS1Sxk2LHMh0/idk0Aw04KwEH3AhEboo4TCdgDW1YskSVM5YopVMhkaliVvIJMFkVI9AmdjRQGphA5tDA01nXqm5lgP3729evcKMFtz12nFcmrpdLhYbEItPg9IjZsKsvHCGe7iHvCTmJWcEvkYTCsp8qkVzitg3IFP/vOY1w1em8rcpSaQsp+8Ft4bDTwZavIVdTxjVQ/0QVhZKs5JoXYEl0UEywWcNPlViwUZ4HXByeyS5y76yEw06HvZCpSLyEAcOvTI19357rikjCrm9LSJAvXNcG6pDRpplIMsLJlDt6ljlPHJgaTAmJFVfQnvg6ZjOc+FuQKkCQKS1+VtLynMhxBdqKhOdNsiGA2NVYrknmSyWkDV/9Cuw/PXmQekQUz1cIWorIKoSkFgPsiucVGA/VNGYZQvUGSg2GxMnPS/KYsgzEJNu4Hk/fV8a2JmaV8YJbQ+HXClQi9AKhbcxzA0yMW7gs+CU0VmOKzlOe99jXM5bCmFe5jZlAjrO6gh57pSzjZZmLhOPpgiKKwsPx/OsSlT07eEAkL4jGx1pdiRTwoEvFeAwahRMbaQo/JkCHfFbSANweSY7N6HRYInSicqVXWYg+t/HIEiUtSNtjR1dc5AS826xhQiZ5lQIb5Ty5jOkOiJnGUxqpMgO8QmLH79QFLwqHc8IPM5AjFyqJ8Evll8ej30OV4oGN53OQJ2wMqKZFhGli1UvtWOHKiIIgYgwKLvKYEBez92rErLA5xCiwJZezmKXcQswsXNuRuo5ZkkFySX9pngrFRpW1SrqNpVqVqZpKj8uxktaIn9dIZGj5cIwOY7YXs6cxO4jZoB+zwTBmg72YDZ7GbHAQs2E/ZsNhzIZ7MRs+dWANDzyueY3gJgCDocOy/Xywi+fuS2FIsvHANPUZPG2dwYMe63RqacJvP/7445m8OZOMnUUoXGfRITuL6i5nUeza8MzEtoH/fY0/dofP/M8Z/nw6PPA/p9R1sOd/ZvhzODiTc7/gmRwSJJYX5S1QYPODQuB/eSbCb7QofgvnGX7EgygODUirFjzYMG/uZRf3IqSwgudm83ZCj0e0owVIK5vaw00Ru27eETU/ou004cEWOiZdEx2rjaYg8ATFcGX3+z1/s2zevFv20ey9Ac6nbf0pbh2PphM8mjbvvz69HhESlmH6NEw865ECQCfzZjz4Do8IC22IPg0HB4gDvJQ2IwBbH9HuG+Bgg7/hXVt/rzvY7w77w70WBtA2ch2Kopum3dls9hDYQ53HL48qT9BQnWaH5utYq2KN+UHWwaKX14no76Cy/wUV9VHQYSFFu48Mi6Cx1BZfU8u2KuWzL4ybKgytlTPsv1DNZg0wqQnhIOs3yZRIPPDYJ6hkIzTweoiDLmFyJ013GpjEj2naLYru0kf82SXENz4WRS9Ne0s9V6jjPhYsTWO2+nnt9zRlRVFs+Oy+tz7vFMXqLnpF4WEj5eurHjlVSGfbLCe+w28lKguJaC98qxih5wA9JNhA5tx6OVq6bDIhfYNnKrbUQcOkyrmGa7RLjVDS9X54GQsittDsyY4lE9B5jggV7MvXXnt/4tkft9CeAL/cPW5lZzjJEUsqY1XBNEzgmpXcWtCSJrviuUidm6lLH+CaFyWaADt/PTtL//kPO+SAQBvfOl9VKiYC/UA7fz096v7X+ZoeVVmCTrgBlgOuZGIGNumx0wzycuGKmk6nvemuSTKlcueHem80jN2/F2r0/oLALXvclE/W7dSxRsPgR9ZZtvcN2BbGuGFh5BqTn3iMZGjQp9vW2zu3XLe+xyO6cZZAwkbnPcHm07Oo4KSQICvD4m9lM9Bn0Xk9xhn5kN4x9vwewpqJFHI+gny16d6CVn/O+UxVXr6DU6u9Vc/RDbxhQyFk7beg7fTjRiO/Xmp0bfM18u0Q0pTOcOUE8QwUYLkwwXPTRmdztHdtkcNRApAPE53XfgAb1Vz6yVJQA3Y/MXAnkafdHUtgP0Yda7diWO2OFVqEaSIG5yiEFEVV1P7RcT1rQFnhdY8mvnAkOvvDCk3qrqzAr+9YAZ2Rmxc4kwPyYwT/xy2aqe/xiM6KJZBuF+OPOUVa9/QDXbB3C2DYVlMA11zL2NVdyLXwmc3S12Ov8XpDn6wbhF62JIHSokfuU0WzBvneNxT5rJp+uM2c1+z1iLhvDVi/Mgf6fg99+3wUkzZ3/xkxagvsezOrc0oWfHKL5U7Nj4g9PTwrTohO51jDWOR540mRhU/hZQefdCCHwj97+cdEvOrIES6kVWgWhGfbEYzpvdTSM0rz3drdM46kzTdR90CsNMu4cfo3KfxIKnywxcftJVd8AG3hjhcywI1UGTyc3Tj8qt+k0+DpfotO+/0Wnfqb6HSL2YgUNKWSpva1waKpIddE4vB99WpZFtswKZL0ucS3lWA9OGFQVZ6yXFzSq0oqTJnzGVI1SKmHcvm57ptMKbPo4V/MvvQbPmy/xCmNj3FPevXDxH0cXkvEaNBi8Gy3QYr9g4O2xLQE5j72+2K9VSr093YG+zvOo7XeobVww2w+hG/RBBi7D73IT3QvelHPBcG2bqePdTs9DLvvPqTVPXg2bF0Wu/2PvSwe3LhuSs0dZvVDGM8PZsU2xe2e9utvZkd+Ovft/Roa9eDZbpMLnw0ewIW6QXH+VE5c0Y8fjPfYQynH6xjwHtrxrSrxJzNoE9hfnUn3H0aTHvRbGtpXLQXtq2GTKff378WUzUWXOOssEv/x9es30/6fv5uoo6Ojo1dv32XP302Ojo4K/N3r9dYaUeuoTcug5uojAv29THf8hlV6vR6iMOWWH9LwnVJO/ujGx5vH9Pzr86/k2dl/iMeUNQ6cTz8F6q6/n7fm15PzT5XAKI5USUHSSr5Io8PIBSGHIOAoJtMSjP1apbPo8CbyYWP4pw/KwqE77w3Gcd9EJsmg4PhXMEkx8nsscpwKI59AmyiOKI4Aw8CR66LDSI3eQ2KjGN+4SnREgME5aNzhTejlwmWj2Cvh0WHkuD6KI//SU39iIBOFb7dlOo7mYcHbpqq/LKYy9EcdEY3zYETqR05DQ+dLke8fNVNzhvkCrYvJuNZ8Fi0H2YdQ1PCO6MbVsXb5LFwOwqIrpI6PpG5RHAkLRXOVDUTT6sMxnYDCnVCM0YeOJbLw4oPXxHFlpuRHDfRhIB8z9L0aXXwUO+Jg7/VYQ+t7Use1ri7cZpUjDK6ENGjD3UWUcMwoUq93F6eG/oRlPmmu6d4mVtY82RQ93ghaNRmZwLwsgeseBXF/dH4A5ZPwPKko26E+jls7q0GtdzaYx9H13Zu5ZonqhtB09mUOY+ueklmitAT9pBmf8mg2N9zbm8fR7O7tzT7L7T1D4k3v3t0PFNO/yHf4PWDdPZjHUXY3rN/XWQe/I7B7T+eLOzZyWVJ1HtRIpbOLcG7N7+oYLjPshzkwL+RrnYJuIGKkVA5crmDixdh59RX7Ai2dL2IXwEHB4kKbcJGxKTq2NSSAiScU1xXOKuZ1HRdJznwALz4GPMcPpJ6ZamSwlwzzGTfhCJjVYjIB9HX7HjTYh8MDTzJM6vFhJXwcvHulhiuhKhPAQwc43i45WEq1AqHrhKmWNdbADrnZm3vvNamDX/ByxUwxeH1yfA9ckqnYdQleTj9wu3RzsNcnx5iCI8Ze/euxd6bGREAtb3VhqI6xK8FDmH59ts/cozc4f6dyOWvNt4GeT37pslWAUmHWQhS71EHMD6iTB1cmXuRoIYlUZfGtQfjMA2OhNC08EhQ1Ik9UdR+uvAOTnE0qijG0KLIhH4fCjBYpNEK6JEWyM9JKh6whzxbYExMGF3gKWMFOjfkxW9C44ZyNubGY81dJgZjXFVoV9ZRwXYIWIBNYiwINDnWYvHi3NtHOR3n35qXPzAt7CEI5Qgl0E0PKqpK4hiShzpMKlFve+oqihNIB+mKTYriqelA2k3eBlKCNkmgmKT3hUvzsWJg0ErSyRpDx3HX1RwW6yhEelPA2MOGs/eXv/2jAtVHTXQXMrcDTFIPg7oCQTEnH8KjpayjxBFRtiHA+0P+2fAkgdCQ0Fy7R0wmSuT+PH1PYnKnPRf92V78bmirJ0LCoz1sThzPWeLXSkG1KBiw9/pW4X7gWxjYyfUI87ur58AYQj0kDBlJDUKqR5+WsKeCL90y1NB3lI4l2llh9Da7IAq+sutBQCHm/e6rpjbOqPggqqwpuRcLCVKbXzv1zTz5Brgv2ZQANufFKKP1kg6jidBdKJnAh5AUm+t5DwXtVxw+lfIbMbacAsglbQJK7zhb5WVPKoW7ipHE7URZiE8p9NA/co+062+V2Azbwg7tKKMe3GGHwgHt+RlGjg0MtbNi2MfS5WFP+HXZrS31Gxsag3/+/bEvt9j8fW2qv/xnZUgcIrHfb3n0AbdJv1p4dwQ19+4D3CpyHK1f69p7o3Z3HtdN8HYIX4jCcu/8W5l849+8wCZ3NuHAne3MmbIbQMOz38X9Lh2CoZOHLdrRqefxTFN/fl33HJbCo+HE7vo6uDo6LUhZJRid5Xf7j9lFNZvNfic/ceGS9fw0QiPRf2msUYEz7wlizgC+8Ym9HV5NKQuZCwkUgwcXSo4Ej8946mrxVBdiMlDlU46daYf2LMgfMsLB6xviEC8lwGv2AJAKt72LmD4PsNmzs9fsXgxoJ+6tIeCEprp8qyJyoS5C/7U6by1u3PIJ6XeSLEyUSrhO1R63NNr+7TRpIKi3sLDo8vYmuu7wUXdd+eHo+P0cutJmixyVlCGJus+gw2ll5a6JCPviScXoTkVzUzG+4TDFoYuW05aXYuRr0BtE8Xh6z9nS+pT9U3Q8dYiyfCDm5a9z5AkdvkY6OVC1MLTTQUvwZUAX1hGj2iiOB/JMBR1MDUY/s8WbxQvc8EDm8na17DlsQc/mBK7xvtZ6slm/JNY9QjTeo0/AARG869ZNOtNhQVD+7RFHjIQV/NJ5G8Getnp8u2Ll+Vwiq8IB0yOHeHilbzwaklewe0IW/93R+7pDfcCRSfGzTG+ZCQVpuHf+p7eaIoiW3Qsu2XzbtN5rZG6xsv+SSNVkDss6I22/ZTmuwFe7+Nq4wWAJxtdsnXO31CVcH/Zba4Xe4mGGhPJCGUCsIpAU0lQC86c+RN4UcK2JsT9HXJci36IPDg4cEY0VZhDxRRV3jo9MJQ375+z/qUZ1Obao75yPGkbyuNCvVFPS4ckVDxjlcUwUtHAYFtRl63aTob17kYAw+eUoLE6qXRbmA6PjzrqWEl3wkcoEnq4twplDJxuHsKoZh9AE2faFdauQV5Hgg1xZ9o/oYmyp9OcaSZjHjbIT1f9CnAzLjMnHuI3dKkBsE7Vl0zZVaGCxrpBFq4WBT0mqeWFZwySfkx4hZE1kp5AKPUqbVCL2rRuWV8x9aLnKlXWAbbYgiDwiJz69LbCKNF+VSQ4a8e+WdiCZ2Tlx3APjCWCP0l5cIi0iAfCmVzBXWsEK/e5XnrFTW+cJRsW7CiMOt5tKgNuxgCTSoEeb9e2B89Pc7A0jhl0JeurorXXZa89UPMDLCQjsrc1n+nrTHfCfs99UIqzopI6zSs8XoibBZNaKjvDlJ/cPN9F2ot9Y4qBdzpCoxa0wElZgdTCDdeQsWOcTsHB2/IFXgCfvlb//NXgLXkmVq6rg1qTTks3ZpN0d5h7b6JicPMq+wrJklJpWT8KgRMPhDxu0vf/sfw17BFD1pTqRcNMlSCT7T6Ryyb9aW3AtZZC62H9363NevY7mQlz125CvUudcPZAb8TuM+okLdSWN1KAzkV2AalekgFbZVlw5awPjNtdMccG9HacrKpVQHdLMtwHGeJHql4M6lhIXe1mRHtNIQ2gWKQKZUiswcslTzsV3MH68WyFvzKaROBHTEfpqaJE4Sy7Yab1x0z5KS0T5vNYyBivSZduXAUnh2Og1sydrpzh/O1s6klJYnpOKGS5KXYq0jGguxmdfjt6CvRBKsoA0SvUOdd6I4ykUC3r7199fRd8cv2dVurx/FDdXtHsK98/LFN89fvX2OwOBB6hA26PV7fTLelLEFl42VlmRn+W5rRE5tq11uq11uq11uq11uq11uq11uq11uq10+Kuxuq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq10+lrNiW+3ysRQR3Fa7/C04cFvtclvtclvtclvtclvtclvtclvtclvt8oOdV9tql9tql9tql9tql9tql9tql9tql/9Pq102MqN2ypwLSm70ObguL/F0uQbmeRxlmLh4eBrd3CDnvdP5fI6ff6ooD+v0PI6uuBYYsUU5j3FI0cNcrEvA7LZvXABa9wTXjx2hKf59KdUTcwzdiCPa+619m7mVx6/fnkRxNPJ1OguVUoo2n2LuFp+69LVGghd9u4lyLicVJYdFbs65K2mStVMSLykl0f/RyDDD1L0FhO1cRbcN/Bc3tXbAzY1Ld5zP6/6uaeMIj9jQG+l3Pp/P/xfm6hYZ",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,b={},y=[];function j(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:"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.p,{children:[(0,i.jsx)(n.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,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)(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},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",description:"Allowed values - signature, stamp.",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 f(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.2ff83df9.js b/assets/js/138cee78.2ff83df9.js new file mode 100644 index 000000000..e89c399d7 --- /dev/null +++ b/assets/js/138cee78.2ff83df9.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:()=>b});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 account details","permalink":"/docs/API-docs/v1.1/get-user"},"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={},b=[];function P(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)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.40b50d00.js b/assets/js/138cee78.40b50d00.js deleted file mode 100644 index a9f1eb827..000000000 --- a/assets/js/138cee78.40b50d00.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>x,contentTitle:()=>y,default:()=>V,frontMatter:()=>v,metadata:()=>n,toc:()=>u});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":"eJzVWF9v3MYR/yrTfUlzoO6P5CQon6IahivUiIVIgYDIB2NIzpFrLXc3u8v7g8MBeeg36FNe89H8SYJZkne8k+xWaOGigGGcZmdm5//8llsRsPQivRcvjQ6YBy/miSjI507aII0WqbitCF46wkDQMcHl9RWgUmblYWMaCAZosTAuKPJebSBvuTWtIO/UQqgwQI4aWB49eFlqch4WxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkqhCpaDV3SkUiHP3SkA9/NcVGpNsTw6+dWcqCICNlVmDRYU2BHJvbWXhQxL9IB1aC1iqZxzsnHzxr2gqfV1Qj/+IbpaOCY0Y1SiUSobEmjlvYWBKpMNkHikqtY+uDJM+SkSvd9lw+OKlLkYiFcTWGIYXWWFvFTB8Mm09il3SXPV8+I/q+I4xzU7MqWxn9bFNm5xfns4vZxflM7HaJCDJE8lFG3meciB2fH+IUXEOR4K3Rvo3F+XT6OF99dbUqC/BNnpP3i0apzZ+ek6PP56Elczk9LwC2mmXV+vyD5RD+nyfzxexidh7/sYou4JfhKTUHofPp+cXZbHo2/e529m364i/pN9+Op9PpzyIR61odSlwUGKKXfY30fze2+AL37E7ZuuIsKKBUfijQ9/8uluyLp4ryxtQUKqlLWJEOsHJGlwlYRegJgtsAlig1KAzk/otFSs4Z9/kwPc+yYc9KraSm931Hvn8xnb6f7YMw+3RnonKExQZoLX3wX9bdT9nwecdmA8e+eezYlV6ikkVcaLfmgfSX9Wl4fWivf1y+smWK5+LI2SG9ddJT3jgZNiK934r1GVp51p6n9/PdPBFcMYYXqTU+WoyhEqmYnO5VT25Jzkc1jVMiFVUI1qeTiUddZGY9NpY073CFmedRNEErJ8vZmAfKqQxa+yx+as6eK+IDllKX/0pufgjRDaexzdRRoPb5Qiv/Tpt+vadHXImQXD4VYUEu5oyr48cDGnnV53ifxn7674f/U/N8P86P1i3ftjDRtC73by3pG1nqWDnRtVPUdkcqNzUx2AkVwWjUi3z8x+97qdFoD7ZijY/f6Xf6bePAmhW5RaMAdQELRWuZKYpiVMezPfDzhHUH+6QOVDrGVYUsZUAVQR4PqBwtZlJJbg1mMy3kG3SXH8NdRaGiiAa/cgQIBS1JcUcBNsHUGFhVby+sjHtYMARNACFrvNTkPZCuUOfM2Oc5AeMANZAO5KyTnsAHx1bL1jajg+PBUqPGklh3AsNgFaQkNwM4kzU+gDeqiSYD7xPjqIDeIU1U+BjEV2vLR8DU3NTWUcVFuSQoG1mQTyA3BYGPqWcXdAEZ+QCWbZE5eVbaaGXyh5hARkFgDQ8miQrM4shGFg8Oteel39rS52AfMOsMwylqDRyNfvLEGX4j9YNPR6N3+gzu93V1R5mXgeZ/7htstVo9aqyvj2Vey/C3JoMfyRovg3Gbg3QpQ9VksRmHSvZ/tJpek6ZYP4NWO+goTO4f9zZTJxUpO7mhwBXiJ5fXV3GWfw0ff/0nvCF0Giqzaqs1bxypDZT9VRy5NvNt2PajOL5MsAkVRzxvi697bvQRvKswfPz1Nw8/0Aqk7lqKXRmNrptMyRxuqba8gf1olPavqNDTDo+ijMBXyKW0lAgItpVWUj+M4VJvoPHkYCVDFYuB6VHuyA2Oy+HxBBl6KsDoKNHfOT5YxPTak1qSZ13aBDaDCsnYO1TONGV729CYzjlHC6kU3MmipBB9uywKsB151ZI54ANzaMENESraADoCTzqM4fpEJJ40lp+CVHBMY+0bfmtyAkgX1kgdfAqFw8XgrZgcCj0uM2n0E6Q2hLgPR9Kp2aek7cTO4z11/I5H/smaOJ63jhbk+MLo9iEvVnbldN+XJXC1/idlHSF7t6oZZ3TrBK38/lRPxAvkav92cUNuKXPqduYnOnoSmSciEUrmpP1wgV2+vn4Dy4vxVCSD5ftvNPfkzdXLVz/cvGJjeJC2AZuNZ+NpfMAYH2rUg5uOvzacrrbtAaD9j79NdEAh0DpMrEIZ4VkMzbZDVvcnXyzmiagYeaX3YrvlBv3Jqd2Oyb805Bi2zROxRCcx4z1/P98lPchgKPZAmw4Jkw5nt3w9s6umxSsnWJVRUitxmedkw2d5h+Dw+u3NrUhE1n1VqU3BMg5X/MUFVyIV8cNMXILxmwjTtkKhLhssI9iJOhkX8QQ9BlUPEVR1P9ir/khvBhYeo63WDf6fnXpSYLttAdtut+dvjz4p0QW25+b0zXe73R+Ycah8","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 account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var o=a(74848),i=a(28453),s=a(33617),c=a.n(s),r=a(17543),l=a.n(r),p=a(86013),d=a.n(p),m=a(63723),f=a.n(m),g=(a(18766),a(79329),a(9303));const v={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:"eJzVWF9v3MYR/yrTfUlzoO6P5CQon6IahivUiIVIgYDIB2NIzpFrLXc3u8v7g8MBeeg36FNe89H8SYJZkne8k+xWaOGigGGcZmdm5//8llsRsPQivRcvjQ6YBy/miSjI507aII0WqbitCF46wkDQMcHl9RWgUmblYWMaCAZosTAuKPJebSBvuTWtIO/UQqgwQI4aWB49eFlqch4WxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkqhCpaDV3SkUiHP3SkA9/NcVGpNsTw6+dWcqCICNlVmDRYU2BHJvbWXhQxL9IB1aC1iqZxzsnHzxr2gqfV1Qj/+IbpaOCY0Y1SiUSobEmjlvYWBKpMNkHikqtY+uDJM+SkSvd9lw+OKlLkYiFcTWGIYXWWFvFTB8Mm09il3SXPV8+I/q+I4xzU7MqWxn9bFNm5xfns4vZxflM7HaJCDJE8lFG3meciB2fH+IUXEOR4K3Rvo3F+XT6OF99dbUqC/BNnpP3i0apzZ+ek6PP56Elczk9LwC2mmXV+vyD5RD+nyfzxexidh7/sYou4JfhKTUHofPp+cXZbHo2/e529m364i/pN9+Op9PpzyIR61odSlwUGKKXfY30fze2+AL37E7ZuuIsKKBUfijQ9/8uluyLp4ryxtQUKqlLWJEOsHJGlwlYRegJgtsAlig1KAzk/otFSs4Z9/kwPc+yYc9KraSm931Hvn8xnb6f7YMw+3RnonKExQZoLX3wX9bdT9nwecdmA8e+eezYlV6ikkVcaLfmgfSX9Wl4fWivf1y+smWK5+LI2SG9ddJT3jgZNiK934r1GVp51p6n9/PdPBFcMYYXqTU+WoyhEqmYnO5VT25Jzkc1jVMiFVUI1qeTiUddZGY9NpY073CFmedRNEErJ8vZmAfKqQxa+yx+as6eK+IDllKX/0pufgjRDaexzdRRoPb5Qiv/Tpt+vadHXImQXD4VYUEu5oyr48cDGnnV53ifxn7674f/U/N8P86P1i3ftjDRtC73by3pG1nqWDnRtVPUdkcqNzUx2AkVwWjUi3z8x+97qdFoD7ZijY/f6Xf6bePAmhW5RaMAdQELRWuZKYpiVMezPfDzhHUH+6QOVDrGVYUsZUAVQR4PqBwtZlJJbg1mMy3kG3SXH8NdRaGiiAa/cgQIBS1JcUcBNsHUGFhVby+sjHtYMARNACFrvNTkPZCuUOfM2Oc5AeMANZAO5KyTnsAHx1bL1jajg+PBUqPGklh3AsNgFaQkNwM4kzU+gDeqiSYD7xPjqIDeIU1U+BjEV2vLR8DU3NTWUcVFuSQoG1mQTyA3BYGPqWcXdAEZ+QCWbZE5eVbaaGXyh5hARkFgDQ8miQrM4shGFg8Oteel39rS52AfMOsMwylqDRyNfvLEGX4j9YNPR6N3+gzu93V1R5mXgeZ/7htstVo9aqyvj2Vey/C3JoMfyRovg3Gbg3QpQ9VksRmHSvZ/tJpek6ZYP4NWO+goTO4f9zZTJxUpO7mhwBXiJ5fXV3GWfw0ff/0nvCF0Giqzaqs1bxypDZT9VRy5NvNt2PajOL5MsAkVRzxvi697bvQRvKswfPz1Nw8/0Aqk7lqKXRmNrptMyRxuqba8gf1olPavqNDTDo+ijMBXyKW0lAgItpVWUj+M4VJvoPHkYCVDFYuB6VHuyA2Oy+HxBBl6KsDoKNHfOT5YxPTak1qSZ13aBDaDCsnYO1TONGV729CYzjlHC6kU3MmipBB9uywKsB151ZI54ANzaMENESraADoCTzqM4fpEJJ40lp+CVHBMY+0bfmtyAkgX1kgdfAqFw8XgrZgcCj0uM2n0E6Q2hLgPR9Kp2aek7cTO4z11/I5H/smaOJ63jhbk+MLo9iEvVnbldN+XJXC1/idlHSF7t6oZZ3TrBK38/lRPxAvkav92cUNuKXPqduYnOnoSmSciEUrmpP1wgV2+vn4Dy4vxVCSD5ftvNPfkzdXLVz/cvGJjeJC2AZuNZ+NpfMAYH2rUg5uOvzacrrbtAaD9j79NdEAh0DpMrEIZ4VkMzbZDVvcnXyzmiagYeaX3YrvlBv3Jqd2Oyb805Bi2zROxRCcx4z1/P98lPchgKPZAmw4Jkw5nt3w9s6umxSsnWJVRUitxmedkw2d5h+Dw+u3NrUhE1n1VqU3BMg5X/MUFVyIV8cNMXILxmwjTtkKhLhssI9iJOhkX8QQ9BlUPEVR1P9ir/khvBhYeo63WDf6fnXpSYLttAdtut+dvjz4p0QW25+b0zXe73R+Ycah8",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,x={},u=[];function P(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(c(),{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)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{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"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,o.jsx)(f(),{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"},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 V(e={}){const{wrapper:t}={...(0,i.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/18b84479.4249218d.js b/assets/js/18b84479.33c9f705.js similarity index 77% rename from assets/js/18b84479.4249218d.js rename to assets/js/18b84479.33c9f705.js index 58b9b79e4..ff55be753 100644 --- a/assets/js/18b84479.4249218d.js +++ b/assets/js/18b84479.33c9f705.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>j,default:()=>y,frontMatter:()=>P,metadata:()=>d,toc:()=>w});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+QMNdIOsOP58XxJJGt8qLmeWOrfc2/2D64DrHf7der/9PzrZ3TAx7Cwisu4JMWYd/12c8cmz8F0+vJbJawyPhDLbkd38Aen2pbIPzXoaI1aJWzNneQZjfK7HRPS028xPuM+Gu0X3/cvwlfwhx+RL8YyLCGaNpA1Vw19sYQ94PbJQ7ZdtcmwiZCzHcdZnqMNE9lnW+3Bavjm/PL85pwljPrp4RL0EJeg/gcZeNG1w+2o84H+0qr2osBu1y1YbTvyd0cflehjHLgJp1Xbtv8BUkjPng==","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 o=n(74848),s=n(28453),c=n(33617),i=n.n(c),a=n(17543),r=n.n(a),l=n(86013),p=n.n(l),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const P={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+QMNdIOsOP58XxJJGt8qLmeWOrfc2/2D64DrHf7der/9PzrZ3TAx7Cwisu4JMWYd/12c8cmz8F0+vJbJawyPhDLbkd38Aen2pbIPzXoaI1aJWzNneQZjfK7HRPS028xPuM+Gu0X3/cvwlfwhx+RL8YyLCGaNpA1Vw19sYQ94PbJQ7ZdtcmwiZCzHcdZnqMNE9lnW+3Bavjm/PL85pwljPrp4RL0EJeg/gcZeNG1w+2o84H+0qr2osBu1y1YbTvyd0cflehjHLgJp1Xbtv8BUkjPng==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,f={},w=[];function b(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:"Delete Document"}),"\n",(0,o.jsx)(i(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(r(),{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,o.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,o.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 y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"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/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.f969e353.js b/assets/js/19e5ad2a.f969e353.js deleted file mode 100644 index 2f07211a4..000000000 --- a/assets/js/19e5ad2a.f969e353.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>u,default:()=>w,frontMatter:()=>v,metadata:()=>s,toc:()=>b});const s=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":"eJzNV1tv5LYV/iunfGkzkOfi3U1RPcVYLBwjRtaoHRio11hQ0hmJOxTJkEczHgwGyEP/QZ/62p+2v6Q41GU0tjepmyAIYNjW4bnf+HEnSJZBpHfirTUkcwriPhEFhtwrR8oakYqbCqE7hUsVCM6uLgBrZzfoA2xtA2TBI3mFawQJmnnsEvJOYwLO27UqlClBQm5r57FCE9QaYa1ww7xSa5BrqbTMNA6SoAzr9z0hs3Y1FYmwDr1k7y4KkYrukM2KRDjpZY2EnqPaCSNrFKnQqlZ8qjigHxv0W5EIjz82ymMh0qXUARMRaKuZe2l9LRKBD07bAkVKvuHTvMJainQnavmg6qYW6Zv5PBG0dSxkmjpDL/YsJ2vHihbzfTK4EFbK/WYefNnmfH/PeoOzJmBg3tP5nP8cFzU0eY4hLBsNQzZFEnOJhphfOqdVHg9mnwIL7Z46YLNPmMe0e1ZDqjXpMTSaRnzSe8kBK8I6/LJ8S+bqDpyBvDKlSGJqJI0pQ+zCVYusejj95Dglbd5fpuCTRcgQY0ZrqfT/IZ8hftMRprmtWZWrrHmxK68Xrxan8YdV5B4lYXFGz6k5CJ3OT1+dLOYn87/eLL5OX/8tffP1dD6f/0Mk4qGO0XTdWEiKUZIiPf5uXPE72Nk/ZutmuECSSoexQHci9vsRURmtDH7s2/wjt/g+crx+rtmvbY1U8f7ZoCHYeGvKBJxGGRDIb0GWUhnQktD/6bebAvTe+p/P48s8+7kUvJ7PPy6GJLx5moQLs5ZaFXF739gVmt830rF5as0/bQPVMsVzcRTsmN4GGTBvvKJtXPMPJ9Kpk/Y8vbvnHciJtXw/lNjeC1SJVMyOb4uAft1fFY3XIhUVkQvpbBakKTL7MLWOr6rSaJkFnueZdGq2Xkx5Kh/LSOdexI/NyUtFAslSmfKX5O4P+bnmGrZlOsrSYTc79R3ycu6KMObq7qsKZcH3zJ6/lzYKd6V579Bcq9LEwkbjj/HDLerc1sgogSqEyaQX+fzP/wxSkwkUNm9qNBRbcPrBfDDvGw8RZvA1JU0BS40PihHCcxAkoKw1hqC3oAxh6SUhFKpUJDVwnnjMculkprTizmU22wKMUfOHKdxWSBV6PvqzZ0hT4Bo1NzzIhmwtiVX1/sLG+tVS201IQELWBGUwBEBTSZMzY1+JBKwHaQANoXdeBYRAnr1WrW/WkGeUVUsjS2TdCYyTVaBW3K7gbdYEgmB1E10GXpvWYwF9QAaxCDGJ7xhDeIQWR43BV9moAkMCuS0QQhxUDsEUkGEgcOyLyjGw0sZom69iAZeN1uAs7w0lNaO3sY8sTl6awHdb60tfgyFhzlsGH9g6OJn8EJArfKnMKqSTyQdzAndDX91iFhTh/V/6EdhsNk9a/6tjmXNF3zYZ/B2dDYqs3x6kS0VVk8VxGSsZPlpN52gw9s9oGA46CpuHp9PH1FmF2s2ukbhDwuzs6iKu2q/g80//gkuU3kBlN2235o1HvYWyN8WZayvfpm3YlLC0sfEqznjeNh8jRwzUZ/C2kvT5p38H+B43jJrbkeJQJpOrJtMqhxusHd8jYTJJ4W2EE0A9DaiSBLk0kCGESnIrrZUECa6V1sqspnBmttAE9LBRVMVmYHqUOwqD8zKUO0AmAxZgTZTobU4PHjG9DqjXGFiXscRuYKGIO7rytilba2NnuuA8LpXWcKuKEinGdlYU4DrypiVzwkfu4JIHgircgvQIAQ1N4eqRSDxpnLOevVCt80urtd1wAdAUzipDIYXCyyUd9CeHRo+oTVnzDKlNoRzSkXRqhpK0k9hFPFCnH3gpP1rkx/vW4xI9G4xhH+riVNdOd31bAnfrr2nriEw7gMYwoIXMfKN881hPvM7R1+H98hr9WuXY3WpfmOhZZJ6JRGiVowk4ggln51eXsH41nYtkdD3+D8M9u7x4++7763fsDC/SNmGL6WI6jzjdBqqlGVk6Rxrevh1kOEr27oCg/oDv5O6CJ3ygmdNSRUwVE7br8NDd0ev5PhGVDcTk3Y6H9gev93smtw9WRkmFCmz78GRd4Xb0wF5L3bDNCF2+wNu9hA+s9/zhFfNG9Jb0gIMNtjJneY5ubOAJXD3CfOfvbkQieGceA51VBDrdP6y9PzLbke5jBNQ6wL85pmcFdrsWRO33A3979EWJLsCem0tzv9/v/wumTyEF","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 i=n(74848),o=n(28453),a=n(33617),r=n.n(a),c=n(17543),l=n.n(c),p=n(86013),m=n.n(p),d=n(63723),h=n.n(d),k=(n(18766),n(79329),n(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:"eJzNV1tv5LYV/iunfGkzkOfi3U1RPcVYLBwjRtaoHRio11hQ0hmJOxTJkEczHgwGyEP/QZ/62p+2v6Q41GU0tjepmyAIYNjW4bnf+HEnSJZBpHfirTUkcwriPhEFhtwrR8oakYqbCqE7hUsVCM6uLgBrZzfoA2xtA2TBI3mFawQJmnnsEvJOYwLO27UqlClBQm5r57FCE9QaYa1ww7xSa5BrqbTMNA6SoAzr9z0hs3Y1FYmwDr1k7y4KkYrukM2KRDjpZY2EnqPaCSNrFKnQqlZ8qjigHxv0W5EIjz82ymMh0qXUARMRaKuZe2l9LRKBD07bAkVKvuHTvMJainQnavmg6qYW6Zv5PBG0dSxkmjpDL/YsJ2vHihbzfTK4EFbK/WYefNnmfH/PeoOzJmBg3tP5nP8cFzU0eY4hLBsNQzZFEnOJhphfOqdVHg9mnwIL7Z46YLNPmMe0e1ZDqjXpMTSaRnzSe8kBK8I6/LJ8S+bqDpyBvDKlSGJqJI0pQ+zCVYusejj95Dglbd5fpuCTRcgQY0ZrqfT/IZ8hftMRprmtWZWrrHmxK68Xrxan8YdV5B4lYXFGz6k5CJ3OT1+dLOYn87/eLL5OX/8tffP1dD6f/0Mk4qGO0XTdWEiKUZIiPf5uXPE72Nk/ZutmuECSSoexQHci9vsRURmtDH7s2/wjt/g+crx+rtmvbY1U8f7ZoCHYeGvKBJxGGRDIb0GWUhnQktD/6bebAvTe+p/P48s8+7kUvJ7PPy6GJLx5moQLs5ZaFXF739gVmt830rF5as0/bQPVMsVzcRTsmN4GGTBvvKJtXPMPJ9Kpk/Y8vbvnHciJtXw/lNjeC1SJVMyOb4uAft1fFY3XIhUVkQvpbBakKTL7MLWOr6rSaJkFnueZdGq2Xkx5Kh/LSOdexI/NyUtFAslSmfKX5O4P+bnmGrZlOsrSYTc79R3ycu6KMObq7qsKZcH3zJ6/lzYKd6V579Bcq9LEwkbjj/HDLerc1sgogSqEyaQX+fzP/wxSkwkUNm9qNBRbcPrBfDDvGw8RZvA1JU0BS40PihHCcxAkoKw1hqC3oAxh6SUhFKpUJDVwnnjMculkprTizmU22wKMUfOHKdxWSBV6PvqzZ0hT4Bo1NzzIhmwtiVX1/sLG+tVS201IQELWBGUwBEBTSZMzY1+JBKwHaQANoXdeBYRAnr1WrW/WkGeUVUsjS2TdCYyTVaBW3K7gbdYEgmB1E10GXpvWYwF9QAaxCDGJ7xhDeIQWR43BV9moAkMCuS0QQhxUDsEUkGEgcOyLyjGw0sZom69iAZeN1uAs7w0lNaO3sY8sTl6awHdb60tfgyFhzlsGH9g6OJn8EJArfKnMKqSTyQdzAndDX91iFhTh/V/6EdhsNk9a/6tjmXNF3zYZ/B2dDYqs3x6kS0VVk8VxGSsZPlpN52gw9s9oGA46CpuHp9PH1FmF2s2ukbhDwuzs6iKu2q/g80//gkuU3kBlN2235o1HvYWyN8WZayvfpm3YlLC0sfEqznjeNh8jRwzUZ/C2kvT5p38H+B43jJrbkeJQJpOrJtMqhxusHd8jYTJJ4W2EE0A9DaiSBLk0kCGESnIrrZUECa6V1sqspnBmttAE9LBRVMVmYHqUOwqD8zKUO0AmAxZgTZTobU4PHjG9DqjXGFiXscRuYKGIO7rytilba2NnuuA8LpXWcKuKEinGdlYU4DrypiVzwkfu4JIHgircgvQIAQ1N4eqRSDxpnLOevVCt80urtd1wAdAUzipDIYXCyyUd9CeHRo+oTVnzDKlNoRzSkXRqhpK0k9hFPFCnH3gpP1rkx/vW4xI9G4xhH+riVNdOd31bAnfrr2nriEw7gMYwoIXMfKN881hPvM7R1+H98hr9WuXY3WpfmOhZZJ6JRGiVowk4ggln51eXsH41nYtkdD3+D8M9u7x4++7763fsDC/SNmGL6WI6jzjdBqqlGVk6Rxrevh1kOEr27oCg/oDv5O6CJ3ygmdNSRUwVE7br8NDd0ev5PhGVDcTk3Y6H9gev93smtw9WRkmFCmz78GRd4Xb0wF5L3bDNCF2+wNu9hA+s9/zhFfNG9Jb0gIMNtjJneY5ubOAJXD3CfOfvbkQieGceA51VBDrdP6y9PzLbke5jBNQ6wL85pmcFdrsWRO33A3979EWJLsCem0tzv9/v/wumTyEF",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,f={},b=[];function g(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,i.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,i.jsx)(k.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.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,i.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,i.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"},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 w(e={}){const{wrapper:t}={...(0,o.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/1c57a399.9642dc06.js b/assets/js/1c57a399.e05f6301.js similarity index 97% rename from assets/js/1c57a399.9642dc06.js rename to assets/js/1c57a399.e05f6301.js index 809d7ef4e..7d756949d 100644 --- a/assets/js/1c57a399.9642dc06.js +++ b/assets/js/1c57a399.e05f6301.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8901],{45740:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>h,contentTitle:()=>p,default:()=>g,frontMatter:()=>d,metadata:()=>s,toc:()=>m});const s=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","source":"@site/docs/API-docs/v1.1/opensign-api-v-1-1.info.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/opensign-api-v-1-1","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"}}');var t=i(74848),r=i(28453),o=(i(64624),i(9303)),a=i(12990),l=i.n(a),c=i(79329);i(25383);const d={id:"opensign-api-v-1-1",title:"OpenSign API v1.1",description:"Welcome to the **OpenSign\u2122 API v1.1** documentation.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,h={},m=[];function u(e){const n={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.1.0"}),"\n",(0,t.jsx)(o.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.1"}),"\n",(0,t.jsxs)(n.p,{children:["Welcome to the ",(0,t.jsx)(n.strong,{children:"OpenSign\u2122 API v1.1"})," documentation."]}),"\n",(0,t.jsx)(n.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,t.jsx)(n.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Useful Links:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"What\u2019s New in v1.1"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Public Templates"}),": Create templates that can be shared via a public link. Any user with the link can generate and sign documents based on the template. Templates themselves cannot be edited through the public link."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Prefill Widgets"}),": Add prefill widgets to documents before they are sent. Prefill widgets are supported in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates."]}),"\n"]}),"\n",(0,t.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,t.jsx)(o.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,t.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,t.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,t.jsx)("div",{children:(0,t.jsx)("table",{children:(0,t.jsxs)("tbody",{children:[(0,t.jsxs)("tr",{children:[(0,t.jsx)("th",{children:(0,t.jsx)(n.p,{children:"Security Scheme Type:"})}),(0,t.jsx)("td",{children:(0,t.jsx)(n.p,{children:"apiKey"})})]}),(0,t.jsxs)("tr",{children:[(0,t.jsx)("th",{children:(0,t.jsx)(n.p,{children:"Header parameter name:"})}),(0,t.jsx)("td",{children:(0,t.jsx)(n.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,t.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"Contact"})}),(0,t.jsx)("span",{children:(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,t.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"Terms of Service"})}),(0,t.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,t.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"License"})}),(0,t.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,t.jsx)(n.p,{children:"AGPL v3.0"})})]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8901],{45740:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>h,contentTitle:()=>p,default:()=>g,frontMatter:()=>d,metadata:()=>s,toc:()=>m});const s=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","source":"@site/docs/API-docs/v1.1/opensign-api-v-1-1.info.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/opensign-api-v-1-1","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"}}');var t=i(74848),r=i(28453),o=(i(64624),i(9303)),a=i(12990),l=i.n(a),c=i(79329);i(25383);const d={id:"opensign-api-v-1-1",title:"OpenSign API v1.1",description:"Welcome to the **OpenSign\u2122 API v1.1** documentation.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,h={},m=[];function u(e){const n={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,t.jsx)(o.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.1"}),"\n",(0,t.jsxs)(n.p,{children:["Welcome to the ",(0,t.jsx)(n.strong,{children:"OpenSign\u2122 API v1.1"})," documentation."]}),"\n",(0,t.jsx)(n.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,t.jsx)(n.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Useful Links:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"What\u2019s New in v1.1"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Public Templates"}),": Create templates that can be shared via a public link. Any user with the link can generate and sign documents based on the template. Templates themselves cannot be edited through the public link."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Prefill Widgets"}),": Add prefill widgets to documents before they are sent. Prefill widgets are supported in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates."]}),"\n"]}),"\n",(0,t.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,t.jsx)(o.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,t.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,t.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,t.jsx)("div",{children:(0,t.jsx)("table",{children:(0,t.jsxs)("tbody",{children:[(0,t.jsxs)("tr",{children:[(0,t.jsx)("th",{children:(0,t.jsx)(n.p,{children:"Security Scheme Type:"})}),(0,t.jsx)("td",{children:(0,t.jsx)(n.p,{children:"apiKey"})})]}),(0,t.jsxs)("tr",{children:[(0,t.jsx)("th",{children:(0,t.jsx)(n.p,{children:"Header parameter name:"})}),(0,t.jsx)("td",{children:(0,t.jsx)(n.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,t.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"Contact"})}),(0,t.jsx)("span",{children:(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,t.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"Terms of Service"})}),(0,t.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,t.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"License"})}),(0,t.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,t.jsx)(n.p,{children:"AGPL v3.0"})})]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/23f866da.9ad181d3.js b/assets/js/23f866da.9ad181d3.js deleted file mode 100644 index 422aae017..000000000 --- a/assets/js/23f866da.9ad181d3.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:()=>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":"eJztO11vG0lyf6UyCOC1MiRFWvY6gmOc1t7sKnFsYSXDuEg6bXOmyGlrpnu2u0ckVyCwD/cP7umA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ05/11dVV1VXXkRNTG+2fRi91UhWonI3O4yhFmxhZOqlVtB+dZAgW84mVUwUHR4cwRYVGOLQg4O0Pr8BlwgEqMc7RwsQgWrfIEWi8VFPQExCQhvX78EddQSIUiNxqkCrJqxRB82Yih9JgL8WJVJjCTKZTdDaGWSaTDFzm10TD8zGVDrQBnJdCpVCVWoGwoBBTTPtwkkkLpdFXMmVAa2hwXqKRqBJarJC5MOA0r/3hl/86JhT/qCtD+H745b9hkusZSMX9b0pUPECUZf9MnakTWe7D2zLXIoWFrgwcvfzXBlFaldpOd3Ze4riawtvDnZ3zrzLnSrs/GNAaukRFYOVibPuJLgYpDSzTyUNCGQ3Sqh5XYWW+AJG2iOIyVJDocgGJ1iaVijgSQymmCKoqxmhsDESZQhskHAQYFOmi53Svsgj/dvzmNUy0KYTrw1Fe2bjZLpUGE5cv/PKEe43VAwtjYfHJHlhnpJrGUIhLIqt08FMlk0tC26JKa6IeHB0yrXZ2jquy1MZhCu88Cvs7O9TzDRKNhUEen+ii0ApKYUSBDo310kXdBn+qpGG5cBmIPK9psX+merCz4xYl7u/swKFKZcLiSQtSK4mgH9v3Q4lINPS4xEROZBjaIh1oFaSOaDITnp9lLhIPpkFbYuLkFXYXnsewoIVfotI1BJk28metnMiZHVdonExE3mYbAcji7YRxRM5SS+Xq1rBDc3KIe8yUIFcEWkrEKqTiHotwJfIKbYBqFkNGUP2ApUFLp7xelwipUshQTrNb9xPp+8q6zsJQWQKzDUXYq+YSkxeZbBORWwQ56dCyEJfY2q3RAH34ZgEpTkSVuxgkSZwzFfbhtXZ08nKZkKIhyeUzLVxlsMdcDuIQAFGiYB4frXRAKicTNHQ4qZOXCHNq6EjOvNIg9PjkuEwo0GqN0YnOtbkpQtzcpSMkWjnWfAdXQuYMvEfWNupvnIvkMoZxXmEMBlN/cBeY53oWe3nnIaTgPM2ZPqSWSQq1IviVDttLCzZA1SjC+jxRZ6NsaRNp21QNp3aiaWciQX3EAAsh85gJF8N7PQYnXY4xHdhSqEUMqXAYg8O5G+t5DEmGyeVYzwO9Jlo5K3/ecOrqnk+n2iiGvRiexPA0huFuDMNRDMO9GIZPYhg+jWG0G8NoFMNoL4bRE0/T0dNAT9EQsQ3AcOQp6b4sCpL+fCUtn1BSfLbRpbOOLh32YWenORXU9uOPP56p6zMFcBbRITmL9uEsaoacRbHvI91HfcPwPaePR6Ovw+eCPp+MnobPGQ8d7oXPjD5HwzO1DBueqRFD4kRR3gEFdf+mEISvICjUxptSW62XqJEUSlx3ED868FDHso3LI8JFKumkyO3t6NQjviCMViDdQGqPkGKRvB0j7v6C0GnDQz2s7nwXq8dWV32oGYrRDewf98MNcTvyftsvBvcWOJ+H+hNCndTPCamf2/FvNNQXRIR1mD6PEl/3+SJn7Xs7HcKAL4gKXYg+jwZPiQZ08dxOAOr9grBvgUMd4Rb3fbt7veHj3mh3tNehAPk4fkBR9NK0t1gsfgvqkV0TtiezprY0vYUmHMLE6GKDG8FW/mpUsHv4d216/wcZ3OPaFsW09kEbq6Tx3NrWstOpWDywfql6amOA0fiV+bVogcldBAd7sUmmZRKApzG12TUmR61PNOgxJQdpOmhRkhrTtFcUvbVG+uwx4VuNRdFP0/7ayBvc8Y0FpGkMN5s3tqcpFEVxS7Nv7zQPiuImFv2iCLAxvmfqn+mYBMvs9pMSBvy9DsvqTHQ3vvMgUQxAq5z3Zsds80lau24yqUJHECtYG2BwWuXC4Jw8TCu18qN/+1NWH7KV/c4eKTtz7O97UsBXb4KN/jAcAEKhuwC13D/vBma0yAEklXW6AINTnEMpnEOjeLErkctUsFPW4waci6IkQ3/wp7Oz9J/+ccChBPLWHRAnIJVTSRGdwZ9OD3r/eb5hRFWWaBJhEXKknWwM6JI+nGaYl6ug0mw2688e2STTOvcRpffW4MT/vdDj9xcMbtkXtny4CVMvGi3XnURn3XO36DoUExbqmRucd5YxdmGGu3zfBq/mjgs3jPiC7pw1kKjTx0Go+/QsKgSbJCTKuPqtXYbmLDpv5nh3HdN75p5/xGHNZIq5GGN+s+ujD1rTnIuFrsL5rsNTXVSDRLfoRh2FVE0EgtHZjVudYr7W6fuWG863J0j7dNaXTn08aw5ALm0dg+mSsz07BKk4dEgBYRLbMUI9AcaNlH72KWgA+7hj4DVR4N09W9A44IFNgLCJCdy9Q4cxbcLQGoVUsqiKJtI5aVatSVYE66NNL5pZWTT1Dm3u3thBzO/ZgcKKt29wpoYcyZCFmN5hmHL3F6QlAjxr8h3FkS7pvURqdZhG+1H9lhLFvCha941OF9H+dRRiXvQzRJRo0uC9pXeY68gmGRaCftXA0MvNROYYxZF/GbFRHLGDRM84RKloP9Lj95i4KKaru6TTjZbW4Hn71/UoH8+P4mAuR/uRD/RHcRQusKYJUCWajNIynUTLesO7lmpaVktZ/tE8LNA6FDL/lcu8pqnLtZerX7XSy9YKjFuBJ/qFpj6HL8XCttb18h2tP5jRHDq/SZgFqVhYChNW1quiRORJlZPpjfNSmkXjB7D93ZCkBW+zUwPv8PGyZnoLolt4bfSnMyhBTQTgmMunzn2vcYz4h9BAlgjzVxSfDMV7jTBG5m2ZafXJ84ejR8PR8NFwRCuEYGlrDWGMWERxJB0W9n46+t6bEHT5f0ChX0zrW6i3eqeIgWOM/ftEsR7PaIsp3i9zJ7e9X7VC6jbTVZ5SsBqF6fMz0q9+oeyKMW3C2PbvEdplHM3vR2YOie7Vj2PwVY4T501gSLRRaB62PesvBrnR3t4yjhb3o7f4X4ne18S82f3YveNXxdWL6+8B66OnyzjK7of1++bd83cEdu/JcnWJRolB4dBhUdIiF2OdLi5qvbVsD6zNiPq68EPDjbCkHfMUDVkcN/XVStXQSHqvv1jX82OtcxRqg6LpPIYJ0nWWzVYyikNoaZYh+T4ra5ZXt40ZHkxob7LQAxuuefPSkqVnKjyL+nA4WdHSG8Lr73H1WH6PUxoe8H4XtmI1/mAQvolCD9q5BfTcuwqp1SDwYKhZYGEm85zgpuu7D80/Nu0aShIA9XVZb3z/VfHCRxF4wzCp+7INwUTswwuhmpfP7gsjXF83QsDSsVzC9TVxFc0FXbrLZbxqoL06DXyv+haDCcqrzqymCVcTm7bWVG/JXJAl4xtClLoNgE/BuahMWIcMvuWy3xHINcAhY7+KaYBpI2eUhnMT68ZeYU5/NPVvEDtIAC3y/4buz8rn38sNoDwblM+flc/fUR5Lif7sefJMpEr9yZ9hnvfhmXVGq+nzNRI8G4T2zaw0eCVxxgeXubpaZZ22zUL9ABMlarWYJy0kpkqkyDl8ZnSCdbIQ8U3h3IF1WFpy1aXzGWGchsBmt5gaRM7cIlhE5Thvhz2wesNnAjKDk395sEbTB885L4xStp4NxPMw+tB785m4QhBqAYw4BzW08VGJSWVYTSa5MHIS3L0Yyhwp1EfeoEh8lMFTtIbjJBPq0sbPxub5CYqiyUz78Oe/0Qg+BpyOd6Ir8xE6nYMPPc9b7/t6necXAQHTih8hHNGpVk8chVzlykhlnal8PADSytTpQXXeHfPD2n7IBupBKq1PmMiwvX4MqKyfLmAirEMTQ6WkcmhMVZLk3Ezl64gyb7Ak59rnsRGP7tcF3aQUSmv0KXitrMP6HqgXxpB1GPy8JiGqzgBcR33jxRvOyf0A0iXJaUshFFSisVqRLGkzFSqIqjf8tSWvKRO5H+rPq6QnHIKH7t8uMLVJ8+HPf2vBdavrdxMwv4NIU4qR3wMhB4Ao0mM5DGSwzBfgdBciWg/NH9ZtreheC8gbSasASbiXKWFPK+vduNHuLv3XRaPOgAVvgaVgq4TYNqnyfPEPUfzx0Zm7fUjfvNkuu8spzN7L0c/z5Gp0RCy6RabvXCDYsJXJKQeUKNdr0nLXaStVLhVe1GS7GO3uXgyJtss42ttEvmNdoMs44YmIOCNN3agyZxYgpkIqIIvK/IbURGO0udvE/TTI7iLCXocIj28S4VBxrJyzpE/0Jaq/L6bt7Z3fnkCdFywrXs1E0g/i/qiDbLvdI2kxqYx0i2j/9Dqa90Qpe75///R8eR5HRFhNMc1SW4ZYuCzajwatEKdFc0VxSVqBhbaRQytUSqHsG/6UKOXgatgfRst4fc5G/+uO8Vj1PnWKdWIq1fS+eecr6hwTBz2TOjRaRZlK+e9IYabAgvaoOJIkORmKlPy2ZRyRYPywCgx/W7O3DtluisK2lOJaXLUOq3YipesqfEPsc3Poc/i4HXT0YUWOFDaBwk2xvwbxOprXBPNa8blWeO50JeRNJKwOhA05gjTa2+NQy9dDjkk8esru/t6T5XnH842irnfLgft1H+3zXI6ux7E1o/8PmdFdK9o/sq5ZlbWANVZcx5Rat6Rut2pIC0w0q4xwjptqE1LmrHJuBNowT3TRZBzv7LTgb2bt7DSqwPOAXtfeVAZKPUMzqXwK8yTHuSRjnKZhwX2roA6KIkdr8wWQFT6l0h+fsyDyxsZNRCnGMpd0W9EwHaRhdeHZPrxbhYUeGJ/CcYU5XXIkKLoQbEM39vNMm0sqwKE6FhhTxQEZl6gyoRJvx3r9G5MkUJUM+QilkZYKKQxBLT1sWjlDIlAIJaYsnHGb2ZBiTmfVgtFjevq0Oq+8iDkhc238qw0jRAJnmYjfzkvq4mgheQAGM+LqVfBmLCV2pwhetYZSnDEFF0qCRSbI4bBK5ZqqZiiwUOU5lJpsBTp8etKBkaY7I5QlEy88FAUeNAQLjgbakDL+1iJx+JVUlz5DvAenjVy9w7GVDrvZI+uS+bA75zvpvq/GVEeirXTaLFazp9Jl1ZgvyfYizYdf6btQOgatK3C1RqoTuyG8qhM7oESXwTE6khA7ODg6ZPPqIXz45S/wCoVRkOmZl9akMpgvmio1XwPFnPdka6wjdmVJQxHFEy98QbHWFHyXCffhl79aeI1cB+aPlH8CP6rGuUzgpI4T7uzswwv2HVqxw85rdyZIlK6kAAGln51LddmHA7Vgj2ilZqmd53XQYNVes9uXYqWgVUjH8Xv2VxBRe2Exv0J2taisYYxcOEcSnRldTf1ubWACcgYn5O6GWi3C7SBNqTyPm+uyGao8WoGDE18wgwsfWeX6jaO1KdzT1C+EvMZVUA1VysVPdh9SIyZutX68EnR20VjJ32iqqztqcsRhmYYl/iQGjJvWPkdz18y3rr41OEF+nWW0V3wpZRCn01osoZuW9eliTRdCuLfY9A/XhyjlxruDSr/sm8kxmiuZ1K7eLSd6wIMHURzlMkFlseUaHHx39AquHvV3o7hlFH/E4R68Onzx7evjbwkYUqSeYMP+sL/LT5jaukKo1k7HmE/g2HsIa2/2jbu0LTzdFp5uC0+3hafbwtNt4em28HRbeLotPN0Wnm4LT7eFp9vC09+tDGZbeLotPN0Wnm4LT7eFp9vC023h6bbwdFt4ui083Rae/u5a4tbC05BFQwpzUOZCqlbqoM/VOl2Vo57HUUZpXPun0fU1BdvfUlIGNf9UoaEcsPM4uhJGUriJM8DiOm2JMnYukfJfXvjoWe+Edo69suKXq7XEN8q78jMOkgRLd+fYdqbZ0ZvjkyiO6gT/Qqc0x4gZldOKmU/JCHTkHCXBNUu5UNOKE4givyZlWtHbbzdN65LTtMKPVh6SUIsWhN38LY8G/SWkNk64vvYpYJwv5Mf7rltnBMLWo4lz58vl8n8Ahi7LkQ==","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),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"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:"eJztO11vG0lyf6UyCOC1MiRFWvY6gmOc1t7sKnFsYSXDuEg6bXOmyGlrpnu2u0ckVyCwD/cP7umA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ05/11dVV1VXXkRNTG+2fRi91UhWonI3O4yhFmxhZOqlVtB+dZAgW84mVUwUHR4cwRYVGOLQg4O0Pr8BlwgEqMc7RwsQgWrfIEWi8VFPQExCQhvX78EddQSIUiNxqkCrJqxRB82Yih9JgL8WJVJjCTKZTdDaGWSaTDFzm10TD8zGVDrQBnJdCpVCVWoGwoBBTTPtwkkkLpdFXMmVAa2hwXqKRqBJarJC5MOA0r/3hl/86JhT/qCtD+H745b9hkusZSMX9b0pUPECUZf9MnakTWe7D2zLXIoWFrgwcvfzXBlFaldpOd3Ze4riawtvDnZ3zrzLnSrs/GNAaukRFYOVibPuJLgYpDSzTyUNCGQ3Sqh5XYWW+AJG2iOIyVJDocgGJ1iaVijgSQymmCKoqxmhsDESZQhskHAQYFOmi53Svsgj/dvzmNUy0KYTrw1Fe2bjZLpUGE5cv/PKEe43VAwtjYfHJHlhnpJrGUIhLIqt08FMlk0tC26JKa6IeHB0yrXZ2jquy1MZhCu88Cvs7O9TzDRKNhUEen+ii0ApKYUSBDo310kXdBn+qpGG5cBmIPK9psX+merCz4xYl7u/swKFKZcLiSQtSK4mgH9v3Q4lINPS4xEROZBjaIh1oFaSOaDITnp9lLhIPpkFbYuLkFXYXnsewoIVfotI1BJk28metnMiZHVdonExE3mYbAcji7YRxRM5SS+Xq1rBDc3KIe8yUIFcEWkrEKqTiHotwJfIKbYBqFkNGUP2ApUFLp7xelwipUshQTrNb9xPp+8q6zsJQWQKzDUXYq+YSkxeZbBORWwQ56dCyEJfY2q3RAH34ZgEpTkSVuxgkSZwzFfbhtXZ08nKZkKIhyeUzLVxlsMdcDuIQAFGiYB4frXRAKicTNHQ4qZOXCHNq6EjOvNIg9PjkuEwo0GqN0YnOtbkpQtzcpSMkWjnWfAdXQuYMvEfWNupvnIvkMoZxXmEMBlN/cBeY53oWe3nnIaTgPM2ZPqSWSQq1IviVDttLCzZA1SjC+jxRZ6NsaRNp21QNp3aiaWciQX3EAAsh85gJF8N7PQYnXY4xHdhSqEUMqXAYg8O5G+t5DEmGyeVYzwO9Jlo5K3/ecOrqnk+n2iiGvRiexPA0huFuDMNRDMO9GIZPYhg+jWG0G8NoFMNoL4bRE0/T0dNAT9EQsQ3AcOQp6b4sCpL+fCUtn1BSfLbRpbOOLh32YWenORXU9uOPP56p6zMFcBbRITmL9uEsaoacRbHvI91HfcPwPaePR6Ovw+eCPp+MnobPGQ8d7oXPjD5HwzO1DBueqRFD4kRR3gEFdf+mEISvICjUxptSW62XqJEUSlx3ED868FDHso3LI8JFKumkyO3t6NQjviCMViDdQGqPkGKRvB0j7v6C0GnDQz2s7nwXq8dWV32oGYrRDewf98MNcTvyftsvBvcWOJ+H+hNCndTPCamf2/FvNNQXRIR1mD6PEl/3+SJn7Xs7HcKAL4gKXYg+jwZPiQZ08dxOAOr9grBvgUMd4Rb3fbt7veHj3mh3tNehAPk4fkBR9NK0t1gsfgvqkV0TtiezprY0vYUmHMLE6GKDG8FW/mpUsHv4d216/wcZ3OPaFsW09kEbq6Tx3NrWstOpWDywfql6amOA0fiV+bVogcldBAd7sUmmZRKApzG12TUmR61PNOgxJQdpOmhRkhrTtFcUvbVG+uwx4VuNRdFP0/7ayBvc8Y0FpGkMN5s3tqcpFEVxS7Nv7zQPiuImFv2iCLAxvmfqn+mYBMvs9pMSBvy9DsvqTHQ3vvMgUQxAq5z3Zsds80lau24yqUJHECtYG2BwWuXC4Jw8TCu18qN/+1NWH7KV/c4eKTtz7O97UsBXb4KN/jAcAEKhuwC13D/vBma0yAEklXW6AINTnEMpnEOjeLErkctUsFPW4waci6IkQ3/wp7Oz9J/+ccChBPLWHRAnIJVTSRGdwZ9OD3r/eb5hRFWWaBJhEXKknWwM6JI+nGaYl6ug0mw2688e2STTOvcRpffW4MT/vdDj9xcMbtkXtny4CVMvGi3XnURn3XO36DoUExbqmRucd5YxdmGGu3zfBq/mjgs3jPiC7pw1kKjTx0Go+/QsKgSbJCTKuPqtXYbmLDpv5nh3HdN75p5/xGHNZIq5GGN+s+ujD1rTnIuFrsL5rsNTXVSDRLfoRh2FVE0EgtHZjVudYr7W6fuWG863J0j7dNaXTn08aw5ALm0dg+mSsz07BKk4dEgBYRLbMUI9AcaNlH72KWgA+7hj4DVR4N09W9A44IFNgLCJCdy9Q4cxbcLQGoVUsqiKJtI5aVatSVYE66NNL5pZWTT1Dm3u3thBzO/ZgcKKt29wpoYcyZCFmN5hmHL3F6QlAjxr8h3FkS7pvURqdZhG+1H9lhLFvCha941OF9H+dRRiXvQzRJRo0uC9pXeY68gmGRaCftXA0MvNROYYxZF/GbFRHLGDRM84RKloP9Lj95i4KKaru6TTjZbW4Hn71/UoH8+P4mAuR/uRD/RHcRQusKYJUCWajNIynUTLesO7lmpaVktZ/tE8LNA6FDL/lcu8pqnLtZerX7XSy9YKjFuBJ/qFpj6HL8XCttb18h2tP5jRHDq/SZgFqVhYChNW1quiRORJlZPpjfNSmkXjB7D93ZCkBW+zUwPv8PGyZnoLolt4bfSnMyhBTQTgmMunzn2vcYz4h9BAlgjzVxSfDMV7jTBG5m2ZafXJ84ejR8PR8NFwRCuEYGlrDWGMWERxJB0W9n46+t6bEHT5f0ChX0zrW6i3eqeIgWOM/ftEsR7PaIsp3i9zJ7e9X7VC6jbTVZ5SsBqF6fMz0q9+oeyKMW3C2PbvEdplHM3vR2YOie7Vj2PwVY4T501gSLRRaB62PesvBrnR3t4yjhb3o7f4X4ne18S82f3YveNXxdWL6+8B66OnyzjK7of1++bd83cEdu/JcnWJRolB4dBhUdIiF2OdLi5qvbVsD6zNiPq68EPDjbCkHfMUDVkcN/XVStXQSHqvv1jX82OtcxRqg6LpPIYJ0nWWzVYyikNoaZYh+T4ra5ZXt40ZHkxob7LQAxuuefPSkqVnKjyL+nA4WdHSG8Lr73H1WH6PUxoe8H4XtmI1/mAQvolCD9q5BfTcuwqp1SDwYKhZYGEm85zgpuu7D80/Nu0aShIA9XVZb3z/VfHCRxF4wzCp+7INwUTswwuhmpfP7gsjXF83QsDSsVzC9TVxFc0FXbrLZbxqoL06DXyv+haDCcqrzqymCVcTm7bWVG/JXJAl4xtClLoNgE/BuahMWIcMvuWy3xHINcAhY7+KaYBpI2eUhnMT68ZeYU5/NPVvEDtIAC3y/4buz8rn38sNoDwblM+flc/fUR5Lif7sefJMpEr9yZ9hnvfhmXVGq+nzNRI8G4T2zaw0eCVxxgeXubpaZZ22zUL9ABMlarWYJy0kpkqkyDl8ZnSCdbIQ8U3h3IF1WFpy1aXzGWGchsBmt5gaRM7cIlhE5Thvhz2wesNnAjKDk395sEbTB885L4xStp4NxPMw+tB785m4QhBqAYw4BzW08VGJSWVYTSa5MHIS3L0Yyhwp1EfeoEh8lMFTtIbjJBPq0sbPxub5CYqiyUz78Oe/0Qg+BpyOd6Ir8xE6nYMPPc9b7/t6necXAQHTih8hHNGpVk8chVzlykhlnal8PADSytTpQXXeHfPD2n7IBupBKq1PmMiwvX4MqKyfLmAirEMTQ6WkcmhMVZLk3Ezl64gyb7Ak59rnsRGP7tcF3aQUSmv0KXitrMP6HqgXxpB1GPy8JiGqzgBcR33jxRvOyf0A0iXJaUshFFSisVqRLGkzFSqIqjf8tSWvKRO5H+rPq6QnHIKH7t8uMLVJ8+HPf2vBdavrdxMwv4NIU4qR3wMhB4Ao0mM5DGSwzBfgdBciWg/NH9ZtreheC8gbSasASbiXKWFPK+vduNHuLv3XRaPOgAVvgaVgq4TYNqnyfPEPUfzx0Zm7fUjfvNkuu8spzN7L0c/z5Gp0RCy6RabvXCDYsJXJKQeUKNdr0nLXaStVLhVe1GS7GO3uXgyJtss42ttEvmNdoMs44YmIOCNN3agyZxYgpkIqIIvK/IbURGO0udvE/TTI7iLCXocIj28S4VBxrJyzpE/0Jaq/L6bt7Z3fnkCdFywrXs1E0g/i/qiDbLvdI2kxqYx0i2j/9Dqa90Qpe75///R8eR5HRFhNMc1SW4ZYuCzajwatEKdFc0VxSVqBhbaRQytUSqHsG/6UKOXgatgfRst4fc5G/+uO8Vj1PnWKdWIq1fS+eecr6hwTBz2TOjRaRZlK+e9IYabAgvaoOJIkORmKlPy2ZRyRYPywCgx/W7O3DtluisK2lOJaXLUOq3YipesqfEPsc3Poc/i4HXT0YUWOFDaBwk2xvwbxOprXBPNa8blWeO50JeRNJKwOhA05gjTa2+NQy9dDjkk8esru/t6T5XnH842irnfLgft1H+3zXI6ux7E1o/8PmdFdK9o/sq5ZlbWANVZcx5Rat6Rut2pIC0w0q4xwjptqE1LmrHJuBNowT3TRZBzv7LTgb2bt7DSqwPOAXtfeVAZKPUMzqXwK8yTHuSRjnKZhwX2roA6KIkdr8wWQFT6l0h+fsyDyxsZNRCnGMpd0W9EwHaRhdeHZPrxbhYUeGJ/CcYU5XXIkKLoQbEM39vNMm0sqwKE6FhhTxQEZl6gyoRJvx3r9G5MkUJUM+QilkZYKKQxBLT1sWjlDIlAIJaYsnHGb2ZBiTmfVgtFjevq0Oq+8iDkhc238qw0jRAJnmYjfzkvq4mgheQAGM+LqVfBmLCV2pwhetYZSnDEFF0qCRSbI4bBK5ZqqZiiwUOU5lJpsBTp8etKBkaY7I5QlEy88FAUeNAQLjgbakDL+1iJx+JVUlz5DvAenjVy9w7GVDrvZI+uS+bA75zvpvq/GVEeirXTaLFazp9Jl1ZgvyfYizYdf6btQOgatK3C1RqoTuyG8qhM7oESXwTE6khA7ODg6ZPPqIXz45S/wCoVRkOmZl9akMpgvmio1XwPFnPdka6wjdmVJQxHFEy98QbHWFHyXCffhl79aeI1cB+aPlH8CP6rGuUzgpI4T7uzswwv2HVqxw85rdyZIlK6kAAGln51LddmHA7Vgj2ilZqmd53XQYNVes9uXYqWgVUjH8Xv2VxBRe2Exv0J2taisYYxcOEcSnRldTf1ubWACcgYn5O6GWi3C7SBNqTyPm+uyGao8WoGDE18wgwsfWeX6jaO1KdzT1C+EvMZVUA1VysVPdh9SIyZutX68EnR20VjJ32iqqztqcsRhmYYl/iQGjJvWPkdz18y3rr41OEF+nWW0V3wpZRCn01osoZuW9eliTRdCuLfY9A/XhyjlxruDSr/sm8kxmiuZ1K7eLSd6wIMHURzlMkFlseUaHHx39AquHvV3o7hlFH/E4R68Onzx7evjbwkYUqSeYMP+sL/LT5jaukKo1k7HmE/g2HsIa2/2jbu0LTzdFp5uC0+3hafbwtNt4em28HRbeLotPN0Wnm4LT7eFp9vC09+tDGZbeLotPN0Wnm4LT7eFp9vC023h6bbwdFt4ui083Rae/u5a4tbC05BFQwpzUOZCqlbqoM/VOl2Vo57HUUZpXPun0fU1BdvfUlIGNf9UoaEcsPM4uhJGUriJM8DiOm2JMnYukfJfXvjoWe+Edo69suKXq7XEN8q78jMOkgRLd+fYdqbZ0ZvjkyiO6gT/Qqc0x4gZldOKmU/JCHTkHCXBNUu5UNOKE4givyZlWtHbbzdN65LTtMKPVh6SUIsWhN38LY8G/SWkNk64vvYpYJwv5Mf7rltnBMLWo4lz58vl8n8Ahi7LkQ==",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)(a(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"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"}},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/23f866da.e170b9c6.js b/assets/js/23f866da.e170b9c6.js new file mode 100644 index 000000000..361ce1a88 --- /dev/null +++ b/assets/js/23f866da.e170b9c6.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:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>m,metadata:()=>i,toc:()=>f});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":"eJztO11vG0lyf6UyCOC1MiRFWvY6gmOc1t7sOnFsYSXDuEg6bXOmyGlppnu2u0ckVyCwD/cP7umA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ059V1VXVVdVV15ETUxvtn0QvdVIVqJyNzuIoRZsYWTqpVbQfHWcIFvOJlVMFB4evYIoKjXBoQcC7H16Dy4QDVGKco4WJQbRukSPQeKmmoCcgIA3r9+GPuoJEKBC51SBVklcpgubNRA6lwV6KE6kwhZlMp+hsDLNMJhm4zK+JhudjKh1oAzgvhUqhKrUCYUEhppj24TiTFkqjr2TKgNbQ4LxEI1EltFghc2HAaV77wy//dUQo/lFXhvD98Mt/wyTXM5CK+9+WqHiAKMv+qTpVx7Lch3dlrkUKC10ZOHz5rw2itCq1nezsvMRxNYV3r3Z2zr7KnCvt/mBAa+gSFYGVi7HtJ7oYpDSwTCcPCWU0SKt6XIWV+QJE2iKKy1BBossFJFqbVCo6kRhKMUVQVTFGY2MgyhTaIOEgwKBIFz2ne5VF+Lejt29gok0hXB8O88rGzXapNJi4fOGXJ9xrrB5YGAuLT/bAOiPVNIZCXBJZpYOfKplcEtoWVVoT9eDwFdNqZ+eoKkttHKbw3qOwv7NDPd8g0VgY5PGJLgqtoBRGFOjQWM9d1G3wp0oa5guXgcjzmhb7p6oHOztuUeL+zg68UqlMmD1pQWolFvRj+34oEYmGHpWYyIkMQ1ukA60C1xFNZsKfZ5mLxINp0JaYOHmF3YXnMSxo4ZeodA1Bpo38WSsncj6OKzROJiJvHxsByOzthHFEzlJL5erWsEMjOXR6fCiBrwi0lIhVSMU9FuFK5BXaANUshoyg+gFLg5akvF6XCKlSyFBOs1v3E+lFZV1nYagsgdmGIuxVnxKTF5lsE5FbBDnp0LIQl9jardEAffhmASlORJW7GCRxnDMV9uGNdiR5uUxI0RDnskwLVxns8SkHdgiAKFHwGR+udEAqJxM0JJzUyUuEOTV0xGdeaRB6LDkuEwq0WjvoROfa3GQhbu7SERKtHGu+gyshcwbeI2sb9TfORXIZwzivMAaDqRfcBea5nsWe33kIKThPc6YPqWXiQq0IfqXD9tKCDVA1irCWJ+pslC1tIm2bqkFqJ5p2JhLUIgZYCJnHTLgYLvQYnHQ5xiSwpVCLGFLhMAaHczfW8xiSDJPLsZ4Hek20clb+vEHq6p5Pp9oohr0YnsTwNIbhbgzDUQzDvRiGT2IYPo1htBvDaBTDaC+G0RNP09HTQE/RELENwHDkKem+LAqS/nwtLUsoKT7b6NJZR5cO+7Cz00gFtf3444+n6vpUAZxGJCSn0T6cRs2Q0yj2faT7qG8Yvuf08Wj0dfhc0OeT0dPwOeOhw73wmdHnaHiqlmHDUzViSJwoyjugoO7fFILwFRiF2nhTaqv1EjWSQonrDjqPDjzUsWzj8ohwkUo6KXJ7Ozr1iC8IoxVIN5DaI6SYJW/HiLu/IHTa8FAPqzvfxeqx1VULNUMxuoH94364IW5H3m/7xeDeAufzUH9CqJP6OSb1czv+jYb6goiwDtPnUeLrPl/krH1vp0MY8AVRoQvR59HgKdGALp7bCUC9XxD2LXCoI9zivm93rzd83BvtjvY6FCAfxw8oil6a9haLxW9BPbJrwvZk1tSWprfQhEOYGF1scCPYyl+NCnYP/65N7/8gg3tc26KY1j5oY5U0nlvbWnY6FYsH1i9VT20MMBq/Mr8WLTC5i+BgLzbJtEwC8DSmNrvG5Kj1iQY9puQgTQctSlJjmvaKorfWSJ89JnyrsSj6adpfG3njdHxjAWkaw83mje1pCkVR3NLs2zvNg6K4iUW/KAJsjO+p+mcSk2CZ3S4pYcDfS1hWMtHd+E5BohiAVjnvzY7ZZklau24yqUJHYCtYG2BwWuXC4Jw8TCu18qN/eymrhWxlv7NHys4c+/ueFPDV22CjPwwCQCh0F6CW++fdwIwWOYCksk4XYHCKcyiFc2gUL3YlcpkKdsp63IBzUZRk6A/+dHqa/tM/DjiUQN66AzoJSOVUUkRn8KeTg95/nm0YUZUlmkRYhBxpJxsDuqQPJxnm5SqoNJvN+rNHNsm0zn1E6cIanPi/53p8cc7gln1hy4ebMPWs0XLdiXXWPXeLrkMxYaGeucF5Zx5jF2a4y/dt8GruuHDDiC/ozlkDiTp9HIS6T06jQrBJQqyMq9/aZWhOo7NmjnfXMb1n7tlHCGsmU8zFGPObXR8taE1zLha6CvJdh6e6qAaObtGNOgqpmggEo7MbtzrFfK3T9y03yLcnSFs660unFs/6BCCXto7BdMnZnh2CVBw6pIAwse0YoZ4A44ZLP1sKGsA+Tgy8Jgpnd88WNA54YBMgbGICd+/QOZg2YWiNQipZVEUT6Zw0q9YkK4L10aYXzawsmnqH9une2EHM79mBwoq3b3CqhhzJkIWY3mGYcvcXpCUCPGv8HcWRLum9RGr1Ko32o/otJYp5UbTuG50uov3rKMS86GeIKNGkwYWld5jryCYZFoJ+1cDQy81E5hjFkX8ZsVEcsYNEzzhEqWg/0uMLTFwU09VdknSjpTV43v51PcrH86M4mMvRfuQD/VEchQusaQJUiSajtEwn0bLe8K6lmpbVUpZ/NA8LtA6FzH/lMm9o6nLt5epXrfSytQLjVuCxfqGpz+FLsbCtdT1/R+sPZjSH5DcJsyAVC0thwsp6VZSIPKlyMr1xXkqzaPwAtr8bkrTgbXZq4B0+XtaH3oLolrM2+tMPKEFNBOCYy6fOvdA4RvxDaCBLhM9XFJ8MxYVGGCOfbZlp9cnzh6NHw9Hw0XBEKwTH+VPXqN/paIkLPT7/Vfye4hXND/Ha1mxhjFhEcSQdFvb+o/S9N/fusuABRZ8xrS/C3uqpJAYOc/bvk4Z6PFNeTPF+tj++7QmtFdW3ma7ylOLlKEyfX7J+9SNpV5JoE8a2f4/cLONofj8yc0h0r36fg69ynDhvhUOijULzsO3cfzHIjfb2lnG0uB+9xf9K9L6mw5vdj917fthcPfr+HrA+erqMo+x+WL9vnl5/R2D3nixX93iUGBQOHRYlLXI+1univNZby/bA2pKpbyw/NFxKS9oxT9GQ0XNTX61UDY2klIHz9atmrHWOQm1QNJ33OEG6zrLlTHZ5iG7NMiT3a2VQ8+q28QSCFe+tJnrjw7WAgrRkbJoKT6M+vJqsaOlt8fUnwXosPwkqDQ94v3NbsRp/MAjfRKEH7fQGenFeRfVqEHgw1EdgYSbznOAmC6IPzT+2LhtKEgD1jV1vfP9V8cIHMnjDMKn7uA7BSu3DC6Gax9fuIydcXzdMwNyxXML1NZ0qmnO695fLeNVAe3Ua+Gr3LQYTlFedWU0TriY2ba2p3pg6J2PKN4T7vg2AzwI6r0xYh2zO5bLfYcg1wCFj145pgGnDZ5QJdBPrxmTik/5o6t8gduAAWuT/Dd2flc+/lxtAeTYonz8rn7+nVJoSvex58kykSr3kzzDP+/DMOqPV9PkaCZ4NQvvmozR4JXHGgsunulplnbbNQv0AE+WKtQ5PWkhMlUiRcwTP6ATrfCU6N4VzB9ZhaSlaIJ1PSuNMCLb8xdQgcvIYwSIqx6lD7ATWGz4TkBmc/MuDNZo+eM6paZQ19mwgnofRr3xAIRNXCEItgBHnuIo2PjAyqQyrySQXRk6CxxlDmSNFG8khFYkPdHiK1nAcZ0Jd2vjZ2Dw/RlE0yXEf/vw3GsFiwBmBx7oyH6HTOf7R82fr3W+v8/wiIGBa8TuIIzrV6okDoat0HamsM5UPSUBamTpDqU794/Owth8SknqQSutzNjJsrx8DKuunC5gI69DEUCmpHBpTlcQ5N7MJO6zMGyzJv/epdHRG9+uCbl4MZVb6LMBW4mN9D9QLY0h8DK5mk5NVJyGuo77x4g1ycj+AdEly5lSIRpVorFbES9pMhQqs6g1/bclxy0Tuh3p5lfSKRPDQ/dvf6GR9+PPfWnDd6n3eBMzvINKUwvT3QMgxKAo2WY5EGSzzBTjdhYjWQ/OHdVsrutcC8kbSKkYT7mXKGdTKejdutLtL/3XRqJNwwVtgKdgqoWObVHm++Ico/vgA0d0+pG/ebJfd5RRmF3L08zy5Gh3SEd3C03cuEGzYyuSUhkqU6zWZweu0lSqXCs9rsp2PdnfPh0TbZRztbSLfkS7QZZxzRUSckaZuVJkzCxBTIRWQRWV+Q2qiMdrcbeJ+GmR3EWGvQ4THN4nwSnG4nhO1j/Ulqr8vpu3tnd+eQJ0XzCtezUTSD+L+qINsu90jaTGpjHSLaP/kOpr3RCl7vn//5Gx5FkdEWE1h1VJbhli4LNqPBq0oq0VzRaFRWoGZtuFDK1RK0fQb/pQo5eBq2B9Gy3h9zkb/647xWPU+dYp1YirV9L55ZyvqHNEJ+kPq0GgVZSrlvyOFmcIRtEfFkSTOyVCk5LdRlMtq9cMqNv1tfbx11HhTILilFNdCu3VktxOsXVfhG8Kvm6Ovw8ftuKePbHKwsolVbgo/NojXAcUmntgKEbYihKugXyfmx2G8VhTvZCULTcCsjpcNOdA02tvjiMzXQw5dPHrKUYG9J8uzjoMcRV0nmJ8Y1l25z/NMuo7J1tr+P2Rtd41t/xy8ZnzWDNYYex2La93gut34IWUx0axZgkg0dTGk81kz3YjHYZ7oosmN3tlpwd/M2tlpNIY/A3oHfFsZKPUMzaTyydaTHOeSbHaahgX3rWI/KIocrc0XQMb6lIqUfHaFyBtTOBGlGMtc0qVGw3TghtW9aPvwfhU9emB8sskV5nQXEqPoQrCp3ZjZM20uqVSIKm5gTLURZIOiyoRKvLnr1XRMnED1PORKlEZaKvkwBLX0sGnlDLFAIZSYMnPG7cOGFHOSVQtGj+mR1uq88izmhMy18e9LjBAxnGUifjsvqYuDiqTgDGZ0qlfB6bGUgp4ieA0ciobGFIMoCRaZIEfNKpVrqu+h+EOV51BqMilI+PSkAyNNd0YoS5ZgeNIKZ9AQLPgjaENy+zuLdMKvpbr0uew9OGn46j2OrXTYzXNZ58yH3TnfSfd9NaaKF22l02axmj2VLqvGfJe2F2k+/ErfhSI3aN2UqzVSndgNUVid2AGl5AyO0BGH2MHB4Su2wh7Ch1/+Aq9RGAWZnnluTSqD+aKpp/PVWnzynmyNEcUeL2koonjimS8o1pqC7zPhPvzyVwtvkCvWvEj5x/rDapzLBI7rcOLOzj68YBejFWLsvMtngljpSgoQUPrZuVSXfThQC3acVmqW2nleBw1W7fVx+6KxFLQKiUN+z/4KImovLOZXyB4ZFWCMkUv8iKMzo6up360NTEDO4IS84lBVRrgdpCkVEnJzXeBDNVIrcHDiS3tw4QOwXGlyuDaFe5pKi5CBuYq9oUq5TMvuQ2rExK3Wj1eMzp4cK/kbTXUdSk2OOCzTHImXxIBx09rnoO+aldfVtwYnyO/IjPbqXEoZ2OmkZkvoJpB9Olv7Z1W+t9hDCNeHKOXGu4OK1OzbyRGaK5nUHuEtEj3gwYMojnKZoLLY8iAOvjt8DVeP+rtR3LKdP0K4B69fvfj2zdG3BAwpUk+wYX+3v8svndq6QqjWTkeYT+DIG4Jr2QWNV7Utkd2WyG5LZLclstsS2W2J7LZEdlsiuy2R3ZbIbktktyWy2xLZ361gZ1siuy2R3ZbIbktktyWy2xLZbYnstkR2WyK7LZHdlsj+7lri1hLZkEVDCnNQ5kKqVoahT+k6WRXOnsVRRtle+yfR9TUF299RUgY1/1ShoVSxszi6EkZSuIkTxeI6u4kydi6R8l9e+OhZ75h2jr2y4pertfw4Ss/yMw6SBEt359h2Qtrh26PjKI7qOoBCpzTHiBkV/oqZT8kIdORUJsGlTblQ04oTiCK/JiVk0dtvN5vrkrO5wo9WHhJlL60g7KZ5eTToLyG1ccL1tc8U43whP9533TojELYeTSd3tlwu/we3oQVv","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),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),g=(t(18766),t(79329),t(9303));const m={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:"eJztO11vG0lyf6UyCOC1MiRFWvY6gmOc1t7sOnFsYSXDuEg6bXOmyGlppnu2u0ckVyCwD/cP7umA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ059V1VXVVdVV15ETUxvtn0QvdVIVqJyNzuIoRZsYWTqpVbQfHWcIFvOJlVMFB4evYIoKjXBoQcC7H16Dy4QDVGKco4WJQbRukSPQeKmmoCcgIA3r9+GPuoJEKBC51SBVklcpgubNRA6lwV6KE6kwhZlMp+hsDLNMJhm4zK+JhudjKh1oAzgvhUqhKrUCYUEhppj24TiTFkqjr2TKgNbQ4LxEI1EltFghc2HAaV77wy//dUQo/lFXhvD98Mt/wyTXM5CK+9+WqHiAKMv+qTpVx7Lch3dlrkUKC10ZOHz5rw2itCq1nezsvMRxNYV3r3Z2zr7KnCvt/mBAa+gSFYGVi7HtJ7oYpDSwTCcPCWU0SKt6XIWV+QJE2iKKy1BBossFJFqbVCo6kRhKMUVQVTFGY2MgyhTaIOEgwKBIFz2ne5VF+Lejt29gok0hXB8O88rGzXapNJi4fOGXJ9xrrB5YGAuLT/bAOiPVNIZCXBJZpYOfKplcEtoWVVoT9eDwFdNqZ+eoKkttHKbw3qOwv7NDPd8g0VgY5PGJLgqtoBRGFOjQWM9d1G3wp0oa5guXgcjzmhb7p6oHOztuUeL+zg68UqlMmD1pQWolFvRj+34oEYmGHpWYyIkMQ1ukA60C1xFNZsKfZ5mLxINp0JaYOHmF3YXnMSxo4ZeodA1Bpo38WSsncj6OKzROJiJvHxsByOzthHFEzlJL5erWsEMjOXR6fCiBrwi0lIhVSMU9FuFK5BXaANUshoyg+gFLg5akvF6XCKlSyFBOs1v3E+lFZV1nYagsgdmGIuxVnxKTF5lsE5FbBDnp0LIQl9jardEAffhmASlORJW7GCRxnDMV9uGNdiR5uUxI0RDnskwLVxns8SkHdgiAKFHwGR+udEAqJxM0JJzUyUuEOTV0xGdeaRB6LDkuEwq0WjvoROfa3GQhbu7SERKtHGu+gyshcwbeI2sb9TfORXIZwzivMAaDqRfcBea5nsWe33kIKThPc6YPqWXiQq0IfqXD9tKCDVA1irCWJ+pslC1tIm2bqkFqJ5p2JhLUIgZYCJnHTLgYLvQYnHQ5xiSwpVCLGFLhMAaHczfW8xiSDJPLsZ4Hek20clb+vEHq6p5Pp9oohr0YnsTwNIbhbgzDUQzDvRiGT2IYPo1htBvDaBTDaC+G0RNP09HTQE/RELENwHDkKem+LAqS/nwtLUsoKT7b6NJZR5cO+7Cz00gFtf3444+n6vpUAZxGJCSn0T6cRs2Q0yj2faT7qG8Yvuf08Wj0dfhc0OeT0dPwOeOhw73wmdHnaHiqlmHDUzViSJwoyjugoO7fFILwFRiF2nhTaqv1EjWSQonrDjqPDjzUsWzj8ohwkUo6KXJ7Ozr1iC8IoxVIN5DaI6SYJW/HiLu/IHTa8FAPqzvfxeqx1VULNUMxuoH94364IW5H3m/7xeDeAufzUH9CqJP6OSb1czv+jYb6goiwDtPnUeLrPl/krH1vp0MY8AVRoQvR59HgKdGALp7bCUC9XxD2LXCoI9zivm93rzd83BvtjvY6FCAfxw8oil6a9haLxW9BPbJrwvZk1tSWprfQhEOYGF1scCPYyl+NCnYP/65N7/8gg3tc26KY1j5oY5U0nlvbWnY6FYsH1i9VT20MMBq/Mr8WLTC5i+BgLzbJtEwC8DSmNrvG5Kj1iQY9puQgTQctSlJjmvaKorfWSJ89JnyrsSj6adpfG3njdHxjAWkaw83mje1pCkVR3NLs2zvNg6K4iUW/KAJsjO+p+mcSk2CZ3S4pYcDfS1hWMtHd+E5BohiAVjnvzY7ZZklau24yqUJHYCtYG2BwWuXC4Jw8TCu18qN/eymrhWxlv7NHys4c+/ueFPDV22CjPwwCQCh0F6CW++fdwIwWOYCksk4XYHCKcyiFc2gUL3YlcpkKdsp63IBzUZRk6A/+dHqa/tM/DjiUQN66AzoJSOVUUkRn8KeTg95/nm0YUZUlmkRYhBxpJxsDuqQPJxnm5SqoNJvN+rNHNsm0zn1E6cIanPi/53p8cc7gln1hy4ebMPWs0XLdiXXWPXeLrkMxYaGeucF5Zx5jF2a4y/dt8GruuHDDiC/ozlkDiTp9HIS6T06jQrBJQqyMq9/aZWhOo7NmjnfXMb1n7tlHCGsmU8zFGPObXR8taE1zLha6CvJdh6e6qAaObtGNOgqpmggEo7MbtzrFfK3T9y03yLcnSFs660unFs/6BCCXto7BdMnZnh2CVBw6pIAwse0YoZ4A44ZLP1sKGsA+Tgy8Jgpnd88WNA54YBMgbGICd+/QOZg2YWiNQipZVEUT6Zw0q9YkK4L10aYXzawsmnqH9une2EHM79mBwoq3b3CqhhzJkIWY3mGYcvcXpCUCPGv8HcWRLum9RGr1Ko32o/otJYp5UbTuG50uov3rKMS86GeIKNGkwYWld5jryCYZFoJ+1cDQy81E5hjFkX8ZsVEcsYNEzzhEqWg/0uMLTFwU09VdknSjpTV43v51PcrH86M4mMvRfuQD/VEchQusaQJUiSajtEwn0bLe8K6lmpbVUpZ/NA8LtA6FzH/lMm9o6nLt5epXrfSytQLjVuCxfqGpz+FLsbCtdT1/R+sPZjSH5DcJsyAVC0thwsp6VZSIPKlyMr1xXkqzaPwAtr8bkrTgbXZq4B0+XtaH3oLolrM2+tMPKEFNBOCYy6fOvdA4RvxDaCBLhM9XFJ8MxYVGGCOfbZlp9cnzh6NHw9Hw0XBEKwTH+VPXqN/paIkLPT7/Vfye4hXND/Ha1mxhjFhEcSQdFvb+o/S9N/fusuABRZ8xrS/C3uqpJAYOc/bvk4Z6PFNeTPF+tj++7QmtFdW3ma7ylOLlKEyfX7J+9SNpV5JoE8a2f4/cLONofj8yc0h0r36fg69ynDhvhUOijULzsO3cfzHIjfb2lnG0uB+9xf9K9L6mw5vdj917fthcPfr+HrA+erqMo+x+WL9vnl5/R2D3nixX93iUGBQOHRYlLXI+1univNZby/bA2pKpbyw/NFxKS9oxT9GQ0XNTX61UDY2klIHz9atmrHWOQm1QNJ33OEG6zrLlTHZ5iG7NMiT3a2VQ8+q28QSCFe+tJnrjw7WAgrRkbJoKT6M+vJqsaOlt8fUnwXosPwkqDQ94v3NbsRp/MAjfRKEH7fQGenFeRfVqEHgw1EdgYSbznOAmC6IPzT+2LhtKEgD1jV1vfP9V8cIHMnjDMKn7uA7BSu3DC6Gax9fuIydcXzdMwNyxXML1NZ0qmnO695fLeNVAe3Ua+Gr3LQYTlFedWU0TriY2ba2p3pg6J2PKN4T7vg2AzwI6r0xYh2zO5bLfYcg1wCFj145pgGnDZ5QJdBPrxmTik/5o6t8gduAAWuT/Dd2flc+/lxtAeTYonz8rn7+nVJoSvex58kykSr3kzzDP+/DMOqPV9PkaCZ4NQvvmozR4JXHGgsunulplnbbNQv0AE+WKtQ5PWkhMlUiRcwTP6ATrfCU6N4VzB9ZhaSlaIJ1PSuNMCLb8xdQgcvIYwSIqx6lD7ATWGz4TkBmc/MuDNZo+eM6paZQ19mwgnofRr3xAIRNXCEItgBHnuIo2PjAyqQyrySQXRk6CxxlDmSNFG8khFYkPdHiK1nAcZ0Jd2vjZ2Dw/RlE0yXEf/vw3GsFiwBmBx7oyH6HTOf7R82fr3W+v8/wiIGBa8TuIIzrV6okDoat0HamsM5UPSUBamTpDqU794/Owth8SknqQSutzNjJsrx8DKuunC5gI69DEUCmpHBpTlcQ5N7MJO6zMGyzJv/epdHRG9+uCbl4MZVb6LMBW4mN9D9QLY0h8DK5mk5NVJyGuo77x4g1ycj+AdEly5lSIRpVorFbES9pMhQqs6g1/bclxy0Tuh3p5lfSKRPDQ/dvf6GR9+PPfWnDd6n3eBMzvINKUwvT3QMgxKAo2WY5EGSzzBTjdhYjWQ/OHdVsrutcC8kbSKkYT7mXKGdTKejdutLtL/3XRqJNwwVtgKdgqoWObVHm++Ico/vgA0d0+pG/ebJfd5RRmF3L08zy5Gh3SEd3C03cuEGzYyuSUhkqU6zWZweu0lSqXCs9rsp2PdnfPh0TbZRztbSLfkS7QZZxzRUSckaZuVJkzCxBTIRWQRWV+Q2qiMdrcbeJ+GmR3EWGvQ4THN4nwSnG4nhO1j/Ulqr8vpu3tnd+eQJ0XzCtezUTSD+L+qINsu90jaTGpjHSLaP/kOpr3RCl7vn//5Gx5FkdEWE1h1VJbhli4LNqPBq0oq0VzRaFRWoGZtuFDK1RK0fQb/pQo5eBq2B9Gy3h9zkb/647xWPU+dYp1YirV9L55ZyvqHNEJ+kPq0GgVZSrlvyOFmcIRtEfFkSTOyVCk5LdRlMtq9cMqNv1tfbx11HhTILilFNdCu3VktxOsXVfhG8Kvm6Ovw8ftuKePbHKwsolVbgo/NojXAcUmntgKEbYihKugXyfmx2G8VhTvZCULTcCsjpcNOdA02tvjiMzXQw5dPHrKUYG9J8uzjoMcRV0nmJ8Y1l25z/NMuo7J1tr+P2Rtd41t/xy8ZnzWDNYYex2La93gut34IWUx0axZgkg0dTGk81kz3YjHYZ7oosmN3tlpwd/M2tlpNIY/A3oHfFsZKPUMzaTyydaTHOeSbHaahgX3rWI/KIocrc0XQMb6lIqUfHaFyBtTOBGlGMtc0qVGw3TghtW9aPvwfhU9emB8sskV5nQXEqPoQrCp3ZjZM20uqVSIKm5gTLURZIOiyoRKvLnr1XRMnED1PORKlEZaKvkwBLX0sGnlDLFAIZSYMnPG7cOGFHOSVQtGj+mR1uq88izmhMy18e9LjBAxnGUifjsvqYuDiqTgDGZ0qlfB6bGUgp4ieA0ciobGFIMoCRaZIEfNKpVrqu+h+EOV51BqMilI+PSkAyNNd0YoS5ZgeNIKZ9AQLPgjaENy+zuLdMKvpbr0uew9OGn46j2OrXTYzXNZ58yH3TnfSfd9NaaKF22l02axmj2VLqvGfJe2F2k+/ErfhSI3aN2UqzVSndgNUVid2AGl5AyO0BGH2MHB4Su2wh7Ch1/+Aq9RGAWZnnluTSqD+aKpp/PVWnzynmyNEcUeL2koonjimS8o1pqC7zPhPvzyVwtvkCvWvEj5x/rDapzLBI7rcOLOzj68YBejFWLsvMtngljpSgoQUPrZuVSXfThQC3acVmqW2nleBw1W7fVx+6KxFLQKiUN+z/4KImovLOZXyB4ZFWCMkUv8iKMzo6up360NTEDO4IS84lBVRrgdpCkVEnJzXeBDNVIrcHDiS3tw4QOwXGlyuDaFe5pKi5CBuYq9oUq5TMvuQ2rExK3Wj1eMzp4cK/kbTXUdSk2OOCzTHImXxIBx09rnoO+aldfVtwYnyO/IjPbqXEoZ2OmkZkvoJpB9Olv7Z1W+t9hDCNeHKOXGu4OK1OzbyRGaK5nUHuEtEj3gwYMojnKZoLLY8iAOvjt8DVeP+rtR3LKdP0K4B69fvfj2zdG3BAwpUk+wYX+3v8svndq6QqjWTkeYT+DIG4Jr2QWNV7Utkd2WyG5LZLclstsS2W2J7LZEdlsiuy2R3ZbIbktktyWy2xLZ361gZ1siuy2R3ZbIbktktyWy2xLZbYnstkR2WyK7LZHdlsj+7lri1hLZkEVDCnNQ5kKqVoahT+k6WRXOnsVRRtle+yfR9TUF299RUgY1/1ShoVSxszi6EkZSuIkTxeI6u4kydi6R8l9e+OhZ75h2jr2y4pertfw4Ss/yMw6SBEt359h2Qtrh26PjKI7qOoBCpzTHiBkV/oqZT8kIdORUJsGlTblQ04oTiCK/JiVk0dtvN5vrkrO5wo9WHhJlL60g7KZ5eTToLyG1ccL1tc8U43whP9533TojELYeTSd3tlwu/we3oQVv",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,y={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},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"}},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 b(e={}){const{wrapper:n}={...(0,o.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/34593b53.1df317b0.js b/assets/js/34593b53.1df317b0.js deleted file mode 100644 index b55d393f0..000000000 --- a/assets/js/34593b53.1df317b0.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:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>j});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":"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDR6Bca3Y2+jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsuQZugYVe7ODwFeN5rmaGVQa0YVaxKUjQ2EvCjKVhPjaes1Krc5EKOWUpt5zNhM3YmBt4tMtAJiqFlE1EDr0TeSKPRLnP3pW54imbq0qzwxf/Xs+Gy2Db8dbWCxhXU/bu1dbW+68ya0uz3+/zsuypEqQRU5nzseklquin2LFMJw9jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8fbNazZRuuC2xw7zysT1cqnQkNh87qa3GdS7emACNozVQk5jVvAzxJaw7OdKJGe4bQMyxf/jwIPDV4Srra23VVkqbSFlP7ot7G9t4ZdvIFczxjVQ/0QVhZKs5JoXYIlcGbf0WcPPldCQOqLwPA+42D+R22xry85L2N/aYq9kKhJEBk2IrUxNfN+e64pIwq5vS0jERPiuLdQxJdksE0lGOJlxR88y54kDU4MpIbHiHLoTX8RsjhO/AKkCBJnS4hclLc+JHOegrUh43iYbAohdjeXaIjpLJaQNrX4F9idPHqQeEcXzFYKWIrIKIemLAXbO8wqMh2oWswyh+gFKDYZY3c+LiJQpy0BMs7Xr8fRDZWxnYlYZBLMNhV8rUInQC4S2Cc8NMDHp4LLgZ9BajSmSYZ732DdzlsKEV7mNmUCOs7qCHnutLONlmYuEj3NAzmUoPNxWGraJyp4dPCCSF0TjQ5JoMIyzVEwmoFE48SNN4ccE6JDPGhVAkmMzLpmSC4ROVK70MgtRcxePLFHSgrQ9dnDORU7Au80aJmSSVymwcc6Ts5iN8wpipiF1gjsHVFuxV0LYhXHjcU74YQZy5EIlEX6p/PLCMOOhSnvsKBOmkSf8GFBNiwjTxqqX2onClREFQcQYFFzkMSEuZh/UmFlhc4hRYEsu5zHqS4iZhQs7VhcxSzJIzugvzVOh2LiyVkm3sVSrMlUz6XE5UdIa8csKiQxfPh6jo5jtxuxRzJ7EbDiI2XAUs+FuzIaPYjZ8ErPRIGajUcxGuzEbPXJgjZ54XPMawW0AhiOHZfvlYBf17vfCkGSjwjS1Dp51dPCwx7a2amnCtp9++ulEXp5Ixk4iFK6TaJ+dRHWXkyh231Bn4reh/32BP3ZGj/3POf58NHrif86o63DX/8zw52h4Iq/8gidyRJBYXpTXQIGf7xQC/8szEbbRotgW9Bk2oiKKwwekVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbuu3xF9vkfbacODX0hNuk+kVlufgsATFKOl3e/1/MmyfvNu2Xuz9xY4n7f1R7h1VE1HqJrW77/WXvcICYswfR4mHvfIACDNvB4PvsM9wkIXos/DwRPEAR5K6xGAX+/R7lvg4Ad/wrtvg93t4d72aDDa7WAA70auQ1Fsp+n2fD6/C+yhzeOXR5MnWKjOssNb6USrYsX1g24HTS9vE9HfwWT/TzTUx8GGhRTvfXSxCBZLfeNrW9lWpXz+wLipwtDaOMP+jWk2b4FJnxAOuv0mmRKJBx77BJNsjBe8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6HnEnVcY8HSNGbLzSvb05QVRbGm2bV3mvtFsbyLXlF42Mj4+hqFxNts6+XEd/i9RKWRiO7C14oReg6UzGltus6tlqOFwyYT0n/wTMUWOmiYVjnXcIH3UiOUdL3vXsaCiDWWPd1j6QpIXgKHCvbVG2+9P/Tsj1voToAtN49b2hlOcsCSylhVMA1TuGAltxa0pMnOeS5STle5bWqAC16UeAXo//nkJP2Xf+6TAwLv+JYhJVgqpgL9QP0/Hx9s//f7FT2qsgSdcAMsB1zJxAxs0mPHGeRl44qazWa92Y5JMqVy54f6YDRM3L+navzhlMAte9yUD1ft1LFG68KPrLN43zdgOxjjhoWRK678xGMkQ8MBnbb+vnPNcet73KMTZwEk/Oi8J/j5+CQqOBkkyMrQ/K1sBvokel+PcZd8SG8Y+/4WwpqJFHI+hnz5060FrW7O+VxVXr6DU6u7Vc/RLbzhh0LI2m9B2xnErY/8YuGj+3a1Qr4dQtrSGY6cIJ6BAiwXJnhuuuhsj/auLXI4SgDyYY6BhQHoHg7a43OloAbsdmLgNJGn3Q1LYD9GHWu3YljthhU6hGkjBucohBRFVdT+0Uk9a0BZ4W2PNr5wJHrdwwpt6i6twC9uWAGdkesXOJFD8mME/8c1lqnvcY90xQJI14vxp2iRzjl9RwfszQIYttUWwBXHMnZ1B3ItfGa99PXYGzze0CfrBqGXLUmgtOiR+1zRrEG+9QlFPqu2H24957V73SPuWwHWb8yBvt9dnz6fxKTt3X9BjNoB+9bM6pySBZ9ec3Onz/eIPT08S06Ira1DDROR562QIgtNIbKDIR3IofBhLx9MxKOOHOFCWoXXghC2HcOE4qWWwigZbwKO7pxxJG3HRFmCEWelWcaNs7/J4EdSYcDWZlAsuOIDaI07XsgAN1JleHf3xtHXgzadho/2OnTaG3ToNFhHp2uujUhBUyppal8bNJ9ack0kDu3LR8ui2IZJkaQvJcZWwu3BCYOq8pTl4oyiKqkwZc7nSNUgpR7KxXDd80wp0/TwEbOv/Ib3u5E4pTEY97BXByZu4/BaIEaLFsPHOy1S7D150pWYjsDc5v7erLdMhcFuf7jXdx6t1Q6txg2zXglfYwkwdht6kZ/oVvSing3BNm6nT3U73Q2779zlrXv4eNQ5LHYGn3pY3Pnlui01N1yr7+LyfGe32La43fL++rvdIz+f+3Z/C4t6+HinzYWPh3fgQl1jOH8uJy7Zx3fGe+yujONVDHgL6/hak/izGbQN7G/OpHt3Y0kPBx0L7euOgfb1qM2Ue3u3Ysr2ogucdRKJ//rmzQ+zwR+/naqDg4OD12/fZS/fTQ8ODgr83ev1Vl6iVlGblkHL1WcE+nOZzvg1q/R6PUQhplbu0/B+Kaf/6sbH68f0TmQUR6rEnE2h5Ks02o/I6IZgg0cx3SPA2G9UOo/2LyOfI4R/+gwcHNr/YDBR9DIySQYFx7/C/QNTSzG1M4opzQW0ieKIgsaYZ4okjfYjNf4ACa5WagTHCjA4B43bvwy9XG5kFHuLK9qP3BajOPJu/bqpziot00l0FRa8bqq6pZnK0B/1hQTnwfTDT5zmNQ69Wkit/aSZXrRmoL0VcKSeK/xm4QWfm9a8zusXLWb04hgU9sSPYimfG1QalXEHXMLzpMrRLoSLUuh5HRsl47DFHzW89Uo1vMO9q4boDUhcaz6P4khYKNrta5hAq4+nXAIKMUMJKh879oOCMcAffAMGbojwvPhoKD4oYGMgopeZkh89fjjaGY6GO8MRzuAvt5+OR/d1GYIuYxxgDh2kwejZbpJBY0YJWb2beDT0p23zKdzMjEfrkoRbuYkmo5sOL0vguke5up+cBt7l7/p07d3AzVdxdHHzZi5YorZDBjL7KoeJdRFDligtQT9spyHcm82Ndnev4mh+8/bmX+T2HiPxZjfv7kdK3W7S2v8esO48uYqj7GZYv6uTy/+OwO4+umpO1wXj4XSs0vlp0FtXN3UMBwX2m6g8BY0GybK+alQNahh8FHG6qOfHSuXA5QpF08kq9s9X0PhF/693iMwywDtEYxPT7I3B7b3FDlrMVIaF5Adh0FbVFZxEPfZq0jLfyZxeTGwOfSnJWCr2gNY7NRWp8Qd9/xtx9KD9gAPdrU3+UQCBOjMLRZnTC4gZ+mzHFMxLe6z+jyy/GpMIQDguw8I3HxXPXdIFLegHdZ8PMG879thzLusU8m6qNru8rNmAuOPqil1eIlVBn+Khe3UVNw24VqeBzlXXoiEBcd4ZVTdBM7Buaw11Js4pmjiuwaf0tQEQUynk9LTSfh60BK+ueh2GXACcPNceB5DWfCamcsWua3uFKH1r7C8h23MATvL/Bu9Py2ffiRWgPO2Xz56Wz37Ex0IlONlz6JkImTrJn0Ge99hTY7WS02cLKHja9+2rSanhXMCMBJeo2syyiNt6op6H6U+oqBviCcMSXSWC55RtpFUCIUCCdJN4gzYWSoMRKWFppHvPQfY4n2qgUAzBwitLj6PoahYWfMpZpmHybw8WcPrg2VsEHd/FPe3zZ773K+cTyPg5MC7njDZODgylnRNsUmlSk0nOtZj4e2DMyhwwMwqviTxxATWH0QDHUcblmYmfjvWzI+AFe1OCRAh+/evfsEfQ6a/kG52CvoVSfzVxoTvFHqAeexC7LC1id6GN9araaULPIQ6uNaLjs/Qx4veyVv2mGhvsJcN8jWq1WkyngAEt34MG+zcvwJPMHRoEFZ8EF36JzKMqE8BDBgu3MYpuCccfQk67LpcWdiiW1t57b5VWl/hI5s3R4S1wSf6gbScozhnidunmYG+ODvGdXU3uHntnakwE1PJOF4bXcHYueHiLU1v2c5fZAi6o4fViOwDY8y/cttkyQKkwKyGK3aGOGq5+lbo0cfMQE0mkKosBReGfF5GUdfBIUNSIPFLVbbjyBkxyNq0okdii+IZTk3IJm3dyQhqrK5fVw9JKh6eBni2cmjCmwVPACnZqzR8zkMYN52zCjQUds0oKxLyu0EVYTwkXJWgBMoGVKNDgUIeq4+Yjqvvo7N0P3/vnt2EPQSjHKIFuYkhZVRLXkCTUjyED5Ra3vtIe9Or7ZgDRdqMni97PWYI2SqKKU3rKpdeg7j6KzswxZDx3Xb2qwHgYwoMS3gUmWNq//vVvLbjWeiSWAXMr8DTFTNcbICS/sGN4TObSUKIGVF2IcD7Qf1i8AiB0JDSnhUprQTK35/FDyo01tV70Afo6OcBUSYbHVq1vTRx0rPFOBUMuYPITU4S/xP3ChTC29ZwvJN0v64cfAPGYtGCgSyhKNfK8nLcFvElaUAvT0fVAdJ+C1pegJVnglVWnGgohb3dOtV3uVtWKoLKq4FYkLExlet0Hvi6uG+S6YF8F0JAbz4XSD9eIKk53qmQCp0KewjnoW1zvX9dJguQQHIOdAcg2bAFJ7jhrHmHO8N18Byet04meGrehRM9g6TIzVnmuukCFB9Mh2z3wgztK6CF/McYMIZdjgqJGiiPc0pZcYV+KL80nW2w8aV+Qq2k4GPwje9J2Bl+OJ2138AV50p4gsD4AebMCWmffrNQdIcp4/YAPilz2FKe9vidG9chJ58LgqxDciMPoyv3XOP+C3r/BIeg8hk0Y0V9nwmYIDaPBAP/XJeeLTgIhGrdVgsbipMrz+T9F8e1jmNfTwDWvdlJep9WzD2L0y0VyPjqMfHysa01/5Fn0SUEuHLMY4lpj01+7FS8Qlc6x/g3uZbu2p2jaFo2FzIWE00DA01Qlp2H32K8AY7qn3K1gqMlNt+wurW9YPnKMubuKi96qAmxG5ifOO0PvTe3esHrO+JQLyVDG9R0yFWh9k/h9HGTXoWB3MDgd1kjYW0bCK0nPjajY05E6A/n77rS9vHXLI6gXRd7owEi4TvQ96my23e42aSCptLDzaP/4MrrY5qXYdt/3j99fvUcWtJnCNIhSGYKY2yzaj/pLWREG9DlFtY8vndzUomC4TDGXa+l84KXonw97w+gqXhyz8jy5pj9U2x87xFg+FXJ607j3DY7eIh0dqTqYavRUKf4IqKg8Idq94kgg/2TA8XKEqEf2+KHJJXkZiByyPFYlbjTEXEzFCJkYneSKxXN9RbrE6myJ4V4rT+E4pBxQFkGdRLAqL6Deeoj014H+Vuy+Fbo/bpi9jpIH035INvFod5eMx8dDsrJ2npABs/voitizCYtFUTf0RRn+iwGcz4tHdMMRGx/7P5CPfcHF7pmn8RO7TMiOw9M3dR2AgQtrh1vH67Xo9FrrgFrjf/JLLvhZakBWuTf2Ol6FFXIXrOKu1GGuIErdzoCkbndAUvdk0DHI/Q6bGRqzmmzn2nQm+7htHqMN/B51oJATRQrUa7VAFzrgSAEvXaMgT1RRl7ja2mqRsh61tVUrRseOmEb5ptKsVDPQk8rVzJrkcCHQU4PDoKBvTfAbeJGDMTk+HrAwpSqO9BQeXeLe6Zrwko9FLvAEdw98nGA0RoDpsR+b8PkD7SoDnEOOB3/t68IqkMFomyl9NsEwfMw4G2P5O/R2gsy4TJxj1Z1G5CBETw86rUstDFb10wi1cLApaTVKQ8Eln5Kcxm2+ZynkqLYM02qMcQej8spJm+UiV9qlvdGGKMGWkPjyosRPdBdEl7SGDHn33LvXTezCG+6g8XUhxxhJKhEWkQB5GSuZKyzhiBGpKs9ZqayLEuGVsw0jDreaS4P2rs+08zSoEeY932D846d3BpDC3wt55sqObbPjmq9+hLERFrpFCRbl72F3zLfCfleNsaihMsIqPW9GT4XNqjGZDO1J6h9upm9DFdCWQdDMkarErLg8q8T0sX5C/y1Y5BDTPzh8RSbnQ/brX/6HfQ9cS5apmePWpNKQz5uCo1SQkyjv0FZbjBRbQWWNGE8c8/kzJmDwx4zbX//yv4a9hhn6mJ1IuQTdw2qci4QdhXyKra39UAm1ybHoPKJ2T9sw4MVZ6UbnQp712IGck4u+OXGwncZ1tkGnXKt4KseMTCV9JrVbs9dARE5hA/k5kO8f6+iNgUEqXBhRq2rqVmsD4zfXfeWHeztIU1YuvPRDB3QDjvOxUvyOO2cr1jld8Tiw8wqvm3wAMqVKnGafpZpPbDN/vPD8j867pabwcjCgI/bT1CRxkuh3XLe6fOcFY7arbzVMgNJbu/VseSk8Ox0HtmTdah8fz9bO2UJHeOsaj1b1yhAN1iE1byZvQZ+LJNy910h0nzr3ozjKRQLe8+PPr4NvD79n5zu9QRS3rgi3EO7+96+ev3z99iUCg4rUIWzYG/YG5KBWxhZctlZaqBi8eLa1csk3BYY3BYY3BYY3BYY3BYa/mBK4mwLDmwLDmwLDmwLDmwLDmwLDvx0SNgWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWG74+u2BQYvi91WzcFhn8PDtwUGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGF5TYLj19KJf5lzI1mNT98DueLHs8Ps4yvAF3v5xdHmJy7zDZzTY/HNFDz2O38fROdcC03Po8V4c3prhY48zwBdLz1220fYRrh872aYE24U3i/hYzo04IIa+tm/7keDhm7dHURyFem2FSul1NJ/h4xA+c+9jWi9IqO0yyrmcVvT6JHJzXrlqIln3bd0Zva3zf7SesHA5b0HYfXTntoH/4qZWDri8dO/26IWX6+8+rR3hERt6I/3eX11d/R82xfr6","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:"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDR6Bca3Y2+jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsuQZugYVe7ODwFeN5rmaGVQa0YVaxKUjQ2EvCjKVhPjaes1Krc5EKOWUpt5zNhM3YmBt4tMtAJiqFlE1EDr0TeSKPRLnP3pW54imbq0qzwxf/Xs+Gy2Db8dbWCxhXU/bu1dbW+68ya0uz3+/zsuypEqQRU5nzseklquin2LFMJw9jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8fbNazZRuuC2xw7zysT1cqnQkNh87qa3GdS7emACNozVQk5jVvAzxJaw7OdKJGe4bQMyxf/jwIPDV4Srra23VVkqbSFlP7ot7G9t4ZdvIFczxjVQ/0QVhZKs5JoXYIlcGbf0WcPPldCQOqLwPA+42D+R22xry85L2N/aYq9kKhJEBk2IrUxNfN+e64pIwq5vS0jERPiuLdQxJdksE0lGOJlxR88y54kDU4MpIbHiHLoTX8RsjhO/AKkCBJnS4hclLc+JHOegrUh43iYbAohdjeXaIjpLJaQNrX4F9idPHqQeEcXzFYKWIrIKIemLAXbO8wqMh2oWswyh+gFKDYZY3c+LiJQpy0BMs7Xr8fRDZWxnYlYZBLMNhV8rUInQC4S2Cc8NMDHp4LLgZ9BajSmSYZ732DdzlsKEV7mNmUCOs7qCHnutLONlmYuEj3NAzmUoPNxWGraJyp4dPCCSF0TjQ5JoMIyzVEwmoFE48SNN4ccE6JDPGhVAkmMzLpmSC4ROVK70MgtRcxePLFHSgrQ9dnDORU7Au80aJmSSVymwcc6Ts5iN8wpipiF1gjsHVFuxV0LYhXHjcU74YQZy5EIlEX6p/PLCMOOhSnvsKBOmkSf8GFBNiwjTxqqX2onClREFQcQYFFzkMSEuZh/UmFlhc4hRYEsu5zHqS4iZhQs7VhcxSzJIzugvzVOh2LiyVkm3sVSrMlUz6XE5UdIa8csKiQxfPh6jo5jtxuxRzJ7EbDiI2XAUs+FuzIaPYjZ8ErPRIGajUcxGuzEbPXJgjZ54XPMawW0AhiOHZfvlYBf17vfCkGSjwjS1Dp51dPCwx7a2amnCtp9++ulEXp5Ixk4iFK6TaJ+dRHWXkyh231Bn4reh/32BP3ZGj/3POf58NHrif86o63DX/8zw52h4Iq/8gidyRJBYXpTXQIGf7xQC/8szEbbRotgW9Bk2oiKKwwekVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbuu3xF9vkfbacODX0hNuk+kVlufgsATFKOl3e/1/MmyfvNu2Xuz9xY4n7f1R7h1VE1HqJrW77/WXvcICYswfR4mHvfIACDNvB4PvsM9wkIXos/DwRPEAR5K6xGAX+/R7lvg4Ad/wrtvg93t4d72aDDa7WAA70auQ1Fsp+n2fD6/C+yhzeOXR5MnWKjOssNb6USrYsX1g24HTS9vE9HfwWT/TzTUx8GGhRTvfXSxCBZLfeNrW9lWpXz+wLipwtDaOMP+jWk2b4FJnxAOuv0mmRKJBx77BJNsjBe8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6HnEnVcY8HSNGbLzSvb05QVRbGm2bV3mvtFsbyLXlF42Mj4+hqFxNts6+XEd/i9RKWRiO7C14oReg6UzGltus6tlqOFwyYT0n/wTMUWOmiYVjnXcIH3UiOUdL3vXsaCiDWWPd1j6QpIXgKHCvbVG2+9P/Tsj1voToAtN49b2hlOcsCSylhVMA1TuGAltxa0pMnOeS5STle5bWqAC16UeAXo//nkJP2Xf+6TAwLv+JYhJVgqpgL9QP0/Hx9s//f7FT2qsgSdcAMsB1zJxAxs0mPHGeRl44qazWa92Y5JMqVy54f6YDRM3L+navzhlMAte9yUD1ft1LFG68KPrLN43zdgOxjjhoWRK678xGMkQ8MBnbb+vnPNcet73KMTZwEk/Oi8J/j5+CQqOBkkyMrQ/K1sBvokel+PcZd8SG8Y+/4WwpqJFHI+hnz5060FrW7O+VxVXr6DU6u7Vc/RLbzhh0LI2m9B2xnErY/8YuGj+3a1Qr4dQtrSGY6cIJ6BAiwXJnhuuuhsj/auLXI4SgDyYY6BhQHoHg7a43OloAbsdmLgNJGn3Q1LYD9GHWu3YljthhU6hGkjBucohBRFVdT+0Uk9a0BZ4W2PNr5wJHrdwwpt6i6twC9uWAGdkesXOJFD8mME/8c1lqnvcY90xQJI14vxp2iRzjl9RwfszQIYttUWwBXHMnZ1B3ItfGa99PXYGzze0CfrBqGXLUmgtOiR+1zRrEG+9QlFPqu2H24957V73SPuWwHWb8yBvt9dnz6fxKTt3X9BjNoB+9bM6pySBZ9ec3Onz/eIPT08S06Ira1DDROR562QIgtNIbKDIR3IofBhLx9MxKOOHOFCWoXXghC2HcOE4qWWwigZbwKO7pxxJG3HRFmCEWelWcaNs7/J4EdSYcDWZlAsuOIDaI07XsgAN1JleHf3xtHXgzadho/2OnTaG3ToNFhHp2uujUhBUyppal8bNJ9ack0kDu3LR8ui2IZJkaQvJcZWwu3BCYOq8pTl4oyiKqkwZc7nSNUgpR7KxXDd80wp0/TwEbOv/Ib3u5E4pTEY97BXByZu4/BaIEaLFsPHOy1S7D150pWYjsDc5v7erLdMhcFuf7jXdx6t1Q6txg2zXglfYwkwdht6kZ/oVvSing3BNm6nT3U73Q2779zlrXv4eNQ5LHYGn3pY3Pnlui01N1yr7+LyfGe32La43fL++rvdIz+f+3Z/C4t6+HinzYWPh3fgQl1jOH8uJy7Zx3fGe+yujONVDHgL6/hak/izGbQN7G/OpHt3Y0kPBx0L7euOgfb1qM2Ue3u3Ysr2ogucdRKJ//rmzQ+zwR+/naqDg4OD12/fZS/fTQ8ODgr83ev1Vl6iVlGblkHL1WcE+nOZzvg1q/R6PUQhplbu0/B+Kaf/6sbH68f0TmQUR6rEnE2h5Ks02o/I6IZgg0cx3SPA2G9UOo/2LyOfI4R/+gwcHNr/YDBR9DIySQYFx7/C/QNTSzG1M4opzQW0ieKIgsaYZ4okjfYjNf4ACa5WagTHCjA4B43bvwy9XG5kFHuLK9qP3BajOPJu/bqpziot00l0FRa8bqq6pZnK0B/1hQTnwfTDT5zmNQ69Wkit/aSZXrRmoL0VcKSeK/xm4QWfm9a8zusXLWb04hgU9sSPYimfG1QalXEHXMLzpMrRLoSLUuh5HRsl47DFHzW89Uo1vMO9q4boDUhcaz6P4khYKNrta5hAq4+nXAIKMUMJKh879oOCMcAffAMGbojwvPhoKD4oYGMgopeZkh89fjjaGY6GO8MRzuAvt5+OR/d1GYIuYxxgDh2kwejZbpJBY0YJWb2beDT0p23zKdzMjEfrkoRbuYkmo5sOL0vguke5up+cBt7l7/p07d3AzVdxdHHzZi5YorZDBjL7KoeJdRFDligtQT9spyHcm82Ndnev4mh+8/bmX+T2HiPxZjfv7kdK3W7S2v8esO48uYqj7GZYv6uTy/+OwO4+umpO1wXj4XSs0vlp0FtXN3UMBwX2m6g8BY0GybK+alQNahh8FHG6qOfHSuXA5QpF08kq9s9X0PhF/693iMwywDtEYxPT7I3B7b3FDlrMVIaF5Adh0FbVFZxEPfZq0jLfyZxeTGwOfSnJWCr2gNY7NRWp8Qd9/xtx9KD9gAPdrU3+UQCBOjMLRZnTC4gZ+mzHFMxLe6z+jyy/GpMIQDguw8I3HxXPXdIFLegHdZ8PMG879thzLusU8m6qNru8rNmAuOPqil1eIlVBn+Khe3UVNw24VqeBzlXXoiEBcd4ZVTdBM7Buaw11Js4pmjiuwaf0tQEQUynk9LTSfh60BK+ueh2GXACcPNceB5DWfCamcsWua3uFKH1r7C8h23MATvL/Bu9Py2ffiRWgPO2Xz56Wz37Ex0IlONlz6JkImTrJn0Ge99hTY7WS02cLKHja9+2rSanhXMCMBJeo2syyiNt6op6H6U+oqBviCcMSXSWC55RtpFUCIUCCdJN4gzYWSoMRKWFppHvPQfY4n2qgUAzBwitLj6PoahYWfMpZpmHybw8WcPrg2VsEHd/FPe3zZ773K+cTyPg5MC7njDZODgylnRNsUmlSk0nOtZj4e2DMyhwwMwqviTxxATWH0QDHUcblmYmfjvWzI+AFe1OCRAh+/evfsEfQ6a/kG52CvoVSfzVxoTvFHqAeexC7LC1id6GN9araaULPIQ6uNaLjs/Qx4veyVv2mGhvsJcN8jWq1WkyngAEt34MG+zcvwJPMHRoEFZ8EF36JzKMqE8BDBgu3MYpuCccfQk67LpcWdiiW1t57b5VWl/hI5s3R4S1wSf6gbScozhnidunmYG+ODvGdXU3uHntnakwE1PJOF4bXcHYueHiLU1v2c5fZAi6o4fViOwDY8y/cttkyQKkwKyGK3aGOGq5+lbo0cfMQE0mkKosBReGfF5GUdfBIUNSIPFLVbbjyBkxyNq0okdii+IZTk3IJm3dyQhqrK5fVw9JKh6eBni2cmjCmwVPACnZqzR8zkMYN52zCjQUds0oKxLyu0EVYTwkXJWgBMoGVKNDgUIeq4+Yjqvvo7N0P3/vnt2EPQSjHKIFuYkhZVRLXkCTUjyED5Ra3vtIe9Or7ZgDRdqMni97PWYI2SqKKU3rKpdeg7j6KzswxZDx3Xb2qwHgYwoMS3gUmWNq//vVvLbjWeiSWAXMr8DTFTNcbICS/sGN4TObSUKIGVF2IcD7Qf1i8AiB0JDSnhUprQTK35/FDyo01tV70Afo6OcBUSYbHVq1vTRx0rPFOBUMuYPITU4S/xP3ChTC29ZwvJN0v64cfAPGYtGCgSyhKNfK8nLcFvElaUAvT0fVAdJ+C1pegJVnglVWnGgohb3dOtV3uVtWKoLKq4FYkLExlet0Hvi6uG+S6YF8F0JAbz4XSD9eIKk53qmQCp0KewjnoW1zvX9dJguQQHIOdAcg2bAFJ7jhrHmHO8N18Byet04meGrehRM9g6TIzVnmuukCFB9Mh2z3wgztK6CF/McYMIZdjgqJGiiPc0pZcYV+KL80nW2w8aV+Qq2k4GPwje9J2Bl+OJ2138AV50p4gsD4AebMCWmffrNQdIcp4/YAPilz2FKe9vidG9chJ58LgqxDciMPoyv3XOP+C3r/BIeg8hk0Y0V9nwmYIDaPBAP/XJeeLTgIhGrdVgsbipMrz+T9F8e1jmNfTwDWvdlJep9WzD2L0y0VyPjqMfHysa01/5Fn0SUEuHLMY4lpj01+7FS8Qlc6x/g3uZbu2p2jaFo2FzIWE00DA01Qlp2H32K8AY7qn3K1gqMlNt+wurW9YPnKMubuKi96qAmxG5ifOO0PvTe3esHrO+JQLyVDG9R0yFWh9k/h9HGTXoWB3MDgd1kjYW0bCK0nPjajY05E6A/n77rS9vHXLI6gXRd7owEi4TvQ96my23e42aSCptLDzaP/4MrrY5qXYdt/3j99fvUcWtJnCNIhSGYKY2yzaj/pLWREG9DlFtY8vndzUomC4TDGXa+l84KXonw97w+gqXhyz8jy5pj9U2x87xFg+FXJ607j3DY7eIh0dqTqYavRUKf4IqKg8Idq94kgg/2TA8XKEqEf2+KHJJXkZiByyPFYlbjTEXEzFCJkYneSKxXN9RbrE6myJ4V4rT+E4pBxQFkGdRLAqL6Deeoj014H+Vuy+Fbo/bpi9jpIH035INvFod5eMx8dDsrJ2npABs/voitizCYtFUTf0RRn+iwGcz4tHdMMRGx/7P5CPfcHF7pmn8RO7TMiOw9M3dR2AgQtrh1vH67Xo9FrrgFrjf/JLLvhZakBWuTf2Ol6FFXIXrOKu1GGuIErdzoCkbndAUvdk0DHI/Q6bGRqzmmzn2nQm+7htHqMN/B51oJATRQrUa7VAFzrgSAEvXaMgT1RRl7ja2mqRsh61tVUrRseOmEb5ptKsVDPQk8rVzJrkcCHQU4PDoKBvTfAbeJGDMTk+HrAwpSqO9BQeXeLe6Zrwko9FLvAEdw98nGA0RoDpsR+b8PkD7SoDnEOOB3/t68IqkMFomyl9NsEwfMw4G2P5O/R2gsy4TJxj1Z1G5CBETw86rUstDFb10wi1cLApaTVKQ8Eln5Kcxm2+ZynkqLYM02qMcQej8spJm+UiV9qlvdGGKMGWkPjyosRPdBdEl7SGDHn33LvXTezCG+6g8XUhxxhJKhEWkQB5GSuZKyzhiBGpKs9ZqayLEuGVsw0jDreaS4P2rs+08zSoEeY932D846d3BpDC3wt55sqObbPjmq9+hLERFrpFCRbl72F3zLfCfleNsaihMsIqPW9GT4XNqjGZDO1J6h9upm9DFdCWQdDMkarErLg8q8T0sX5C/y1Y5BDTPzh8RSbnQ/brX/6HfQ9cS5apmePWpNKQz5uCo1SQkyjv0FZbjBRbQWWNGE8c8/kzJmDwx4zbX//yv4a9hhn6mJ1IuQTdw2qci4QdhXyKra39UAm1ybHoPKJ2T9sw4MVZ6UbnQp712IGck4u+OXGwncZ1tkGnXKt4KseMTCV9JrVbs9dARE5hA/k5kO8f6+iNgUEqXBhRq2rqVmsD4zfXfeWHeztIU1YuvPRDB3QDjvOxUvyOO2cr1jld8Tiw8wqvm3wAMqVKnGafpZpPbDN/vPD8j867pabwcjCgI/bT1CRxkuh3XLe6fOcFY7arbzVMgNJbu/VseSk8Ox0HtmTdah8fz9bO2UJHeOsaj1b1yhAN1iE1byZvQZ+LJNy910h0nzr3ozjKRQLe8+PPr4NvD79n5zu9QRS3rgi3EO7+96+ev3z99iUCg4rUIWzYG/YG5KBWxhZctlZaqBi8eLa1csk3BYY3BYY3BYY3BYY3BYa/mBK4mwLDmwLDmwLDmwLDmwLDmwLDvx0SNgWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWG74+u2BQYvi91WzcFhn8PDtwUGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGF5TYLj19KJf5lzI1mNT98DueLHs8Ps4yvAF3v5xdHmJy7zDZzTY/HNFDz2O38fROdcC03Po8V4c3prhY48zwBdLz1220fYRrh872aYE24U3i/hYzo04IIa+tm/7keDhm7dHURyFem2FSul1NJ/h4xA+c+9jWi9IqO0yyrmcVvT6JHJzXrlqIln3bd0Zva3zf7SesHA5b0HYfXTntoH/4qZWDri8dO/26IWX6+8+rR3hERt6I/3eX11d/R82xfr6",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={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.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.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"},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},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",description:"Allowed values - signature, stamp.",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.e3542020.js b/assets/js/34593b53.e3542020.js new file mode 100644 index 000000000..edfe789a2 --- /dev/null +++ b/assets/js/34593b53.e3542020.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:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=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":"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDR6Bca3Y2+jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsuQZugYVe7ODwFeN5rmaGVQa0YVaxKUjQ2EvCjKVhPjaes1Krc5EKOWUpt5zNhM3YmBt4tMtAJiqFlE1EDr0TeSKPRLnP3pW54imbq0qzwxf/Xs+Gy2Db8dbWCxhXU/bu1dbW+68ya0uz3+/zsuypEqQRU5nzseklquin2LFMJw9jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8fbNazZRuuC2xw7zysT1cqnQkNh87qa3GdS7emACNozVQk5jVvAzxJaw7OdKJGe4bQMyxf/jwIPDV4Srra23VVkqbSFlP7ot7G9t4ZdvIFczxjVQ/0QVhZKs5JoXYIlcGbf0WcPPldCQOqLwPA+42D+R22xry85L2N/aYq9kKhJEBk2IrUxNfN+e64pIwq5vS0jERPiuLdQxJdksE0lGOJlxR88y54kDU4MpIbHiHLoTX8RsjhO/AKkCBJnS4hclLc+JHOegrUh43iYbAohdjeXaIjpLJaQNrX4F9idPHqQeEcXzFYKWIrIKIemLAXbO8wqMh2oWswyh+gFKDYZY3c+LiJQpy0BMs7Xr8fRDZWxnYlYZBLMNhV8rUInQC4S2Cc8NMDHp4LLgZ9BajSmSYZ732DdzlsKEV7mNmUCOs7qCHnutLONlmYuEj3NAzmUoPNxWGraJyp4dPCCSF0TjQ5JoMIyzVEwmoFE48SNN4ccE6JDPGhVAkmMzLpmSC4ROVK70MgtRcxePLFHSgrQ9dnDORU7Au80aJmSSVymwcc6Ts5iN8wpipiF1gjsHVFuxV0LYhXHjcU74YQZy5EIlEX6p/PLCMOOhSnvsKBOmkSf8GFBNiwjTxqqX2onClREFQcQYFFzkMSEuZh/UmFlhc4hRYEsu5zHqS4iZhQs7VhcxSzJIzugvzVOh2LiyVkm3sVSrMlUz6XE5UdIa8csKiQxfPh6jo5jtxuxRzJ7EbDiI2XAUs+FuzIaPYjZ8ErPRIGajUcxGuzEbPXJgjZ54XPMawW0AhiOHZfvlYBf17vfCkGSjwjS1Dp51dPCwx7a2amnCtp9++ulEXp5Ixk4iFK6TaJ+dRHWXkyh231Bn4reh/32BP3ZGj/3POf58NHrif86o63DX/8zw52h4Iq/8gidyRJBYXpTXQIGf7xQC/8szEbbRotgW9Bk2oiKKwwekVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbuu3xF9vkfbacODX0hNuk+kVlufgsATFKOl3e/1/MmyfvNu2Xuz9xY4n7f1R7h1VE1HqJrW77/WXvcICYswfR4mHvfIACDNvB4PvsM9wkIXos/DwRPEAR5K6xGAX+/R7lvg4Ad/wrtvg93t4d72aDDa7WAA70auQ1Fsp+n2fD6/C+yhzeOXR5MnWKjOssNb6USrYsX1g24HTS9vE9HfwWT/TzTUx8GGhRTvfXSxCBZLfeNrW9lWpXz+wLipwtDaOMP+jWk2b4FJnxAOuv0mmRKJBx77BJNsjBe8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6HnEnVcY8HSNGbLzSvb05QVRbGm2bV3mvtFsbyLXlF42Mj4+hqFxNts6+XEd/i9RKWRiO7C14oReg6UzGltus6tlqOFwyYT0n/wTMUWOmiYVjnXcIH3UiOUdL3vXsaCiDWWPd1j6QpIXgKHCvbVG2+9P/Tsj1voToAtN49b2hlOcsCSylhVMA1TuGAltxa0pMnOeS5STle5bWqAC16UeAXo//nkJP2Xf+6TAwLv+JYhJVgqpgL9QP0/Hx9s//f7FT2qsgSdcAMsB1zJxAxs0mPHGeRl44qazWa92Y5JMqVy54f6YDRM3L+navzhlMAte9yUD1ft1LFG68KPrLN43zdgOxjjhoWRK678xGMkQ8MBnbb+vnPNcet73KMTZwEk/Oi8J/j5+CQqOBkkyMrQ/K1sBvokel+PcZd8SG8Y+/4WwpqJFHI+hnz5060FrW7O+VxVXr6DU6u7Vc/RLbzhh0LI2m9B2xnErY/8YuGj+3a1Qr4dQtrSGY6cIJ6BAiwXJnhuuuhsj/auLXI4SgDyYY6BhQHoHg7a43OloAbsdmLgNJGn3Q1LYD9GHWu3YljthhU6hGkjBucohBRFVdT+0Uk9a0BZ4W2PNr5wJHrdwwpt6i6twC9uWAGdkesXOJFD8mME/8c1lqnvcY90xQJI14vxp2iRzjl9RwfszQIYttUWwBXHMnZ1B3ItfGa99PXYGzze0CfrBqGXLUmgtOiR+1zRrEG+9QlFPqu2H24957V73SPuWwHWb8yBvt9dnz6fxKTt3X9BjNoB+9bM6pySBZ9ec3Onz/eIPT08S06Ira1DDROR562QIgtNIbKDIR3IofBhLx9MxKOOHOFCWoXXghC2HcOE4qWWwigZbwKO7pxxJG3HRFmCEWelWcaNs7/J4EdSYcDWZlAsuOIDaI07XsgAN1JleHf3xtHXgzadho/2OnTaG3ToNFhHp2uujUhBUyppal8bNJ9ack0kDu3LR8ui2IZJkaQvJcZWwu3BCYOq8pTl4oyiKqkwZc7nSNUgpR7KxXDd80wp0/TwEbOv/Ib3u5E4pTEY97BXByZu4/BaIEaLFsPHOy1S7D150pWYjsDc5v7erLdMhcFuf7jXdx6t1Q6txg2zXglfYwkwdht6kZ/oVvSing3BNm6nT3U73Q2779zlrXv4eNQ5LHYGn3pY3Pnlui01N1yr7+LyfGe32La43fL++rvdIz+f+3Z/C4t6+HinzYWPh3fgQl1jOH8uJy7Zx3fGe+yujONVDHgL6/hak/izGbQN7G/OpHt3Y0kPBx0L7euOgfb1qM2Ue3u3Ysr2ogucdRKJ//rmzQ+zwR+/naqDg4OD12/fZS/fTQ8ODgr83ev1Vl6iVlGblkHL1WcE+nOZzvg1q/R6PUQhplbu0/B+Kaf/6sbH68f0TmQUR6rEnE2h5Ks02o/I6IZgg0cx3SPA2G9UOo/2LyOfI4R/+gwcHNr/YDBR9DIySQYFx7/C/QNTSzG1M4opzQW0ieKIgsaYZ4okjfYjNf4ACa5WagTHCjA4B43bvwy9XG5kFHuLK9qP3BajOPJu/bqpziot00l0FRa8bqq6pZnK0B/1hQTnwfTDT5zmNQ69Wkit/aSZXrRmoL0VcKSeK/xm4QWfm9a8zusXLWb04hgU9sSPYimfG1QalXEHXMLzpMrRLoSLUuh5HRsl47DFHzW89Uo1vMO9q4boDUhcaz6P4khYKNrta5hAq4+nXAIKMUMJKh879oOCMcAffAMGbojwvPhoKD4oYGMgopeZkh89fjjaGY6GO8MRzuCzDD52jpAMjVN8UOPTTxKEFM5xvL9ffzop3dfltbu8eYBpfJAGu2u7yUeNGeWE9W4Sk9CfMM+ncLM8HK3LU26lR5qMLlu8LIHrHqULf3ImelfE6gO+d4NAXcXRxc2buWCJ2g5J0OyrHCbWBS1ZorQE/bCdCXFvNjfa3b2Ko/nN25t/kdt7jMSb3by7Hyl7vMms/3vAuvPkKo6ym2H9rs5v/zsCu/voqjngF+yX07FK56dBb13d1DGcVdhvovIUNNpEy/qqUTWoYfBdxuniUTNWKgcuVyiaTmKzf0GD9je6oL1PZpYBXmMas5xmb2x+77B20GKyNCzkXwiD5rKu4CTqsVeT1g2CLPrF3OrQl/KcpWIPaL1TU5Eaf9D3vxFHD9pvSNDj26RABRCoM7NQlDk9wpih23hM8cS0x+r/yPisMYkAhBM7LHzzUfHc5X3Qgn5Q9wUD8+Zrjz3nss5i72aLs8vLmg2IO66u2OUlUhX0KZ77V1dx04BrdRroaHctGhIQ551RdRM0A+u21lBnZZ2ileUa/HnfBkBMpZDT00r7edAYvbrqdRhyAXBynnscQFrzmZjKFbuuTSai9K2xv4RszwE4yf8bvD8tn30nVoDytF8+e1o++xHfK5XgZM+hZyJk6iR/BnneY0+N1UpOny2g4Gnft68mpYZzATMSXKJqM8sibuuJeh6mP6GibognDEt0lQieU8KTVgmEGA3STeIl3lgoDQbFhKWR7kkJXQn4VANFgwgWXll6n0W3w7DgU84yDZN/e7CA0wfP3iLo+DTvaZ8/871fObdExs+BcTlntHHyoSjt/HCTSpOaTHKuxcRfRWNW5oDJWXhT5YmL6TmMBjiOMi7PTPx0rJ8dAS/YmxIkQvDrX/+GPYJOfyXf6BT0LZT6q4mLHir2APXYg9glihG7C22sV9VOE3oOcXCtER3/UACDji9r1W+qscFeMszXqFarxXQKGFPzPWiwf3YDPMncoUFQ8UmIIpTIPKoyATxksHAhpACbcPwh5LTr9Wlhh8J57b33Vml1ie903hwd3gKX5JLadoLi/DFul24O9uboEJ/61eTusXemxkRALe90YegJYOeCh+dAtWU/d8k14OIqXi+2Y5A9/8humy0DlAqzEqLYHeqo4eqHsUsTN29BkUSqshjTFP6FE0lZB48ERY3II1XdhitvwCRn04pymS2Kbzg1KZ2xeaonpLG6colFLK10eJ3o2cKpCWMaPAWsYKfW/DEDadxwzibcWNAxq6RAzOsKvZT1lHBRghYgE1iJAg0Odag6bj6iuu/e3v3wvX8BHPYQhHKMEugmhpRVJXENSUL9HjNQbnHrK+1Br75vBhBtN3o16V2tJWijJKo4padceg3q7qPoTx1DxnPX1asKDMkhPCjhvZV3/1//+rcWXGudIsuAuRV4mmKy7Q0QkmvaMTzmk2koUQOqLkQ4H+g/LF4BEDoSmtNCpbUgmdvz+CGl55paL/ocgTo/wVRJhsdWrW9NHHSs8U4FQ15oclVTkkGJ+4ULYWzrRWHI+1/WDz8A4jFpwUCXUJRq5Hk5bwt4kzehFqaj64HovkatL0FLssArq041FELe7pxqe/2tqhVBZVXBrUhYmMr0um+MXWg5yHXBvgqgITeeC6UfrhFVnO5UyQROhTyFc9C3uN6/rvMUySc5BjsDkG3YApLccda8A53h0/0OTlqnE712bkOJzsnSJYes8lx1gQpvtkPCfeAHd5RQLYFijElKLs0FRY0UR7ilLbnCvhRfms/32HjSviBX03Aw+Ef2pO0MvhxP2u7gC/KkPUFgfQz0ZgW0zr5ZqTtCoPP6AR8UuFBHrvT1PTGwSE46F4lfheBGHEZX7r/G+Rf0/g0OQecxbCKZ/joTNkNoGA0G+L8uOV90chjRuK0SNBYnVZ7P/ymKbx9GvZ4Grnm1k/I6rZ59EKNfLpLz0WHkQ3Rda/ojz6JPirPhmMUo2xqb/tqteIGodI4leHAv27U9RdO2aCxkLiScBgKepio5DbvHfgUY0z3lbgVDTW66ZXdpfcPykWPM3VVc9FYVYDMyP3HeGXpvaveG1XPGp1xIhjKu75CpQOubxO/jILsOBbuDwemwRsLeMhJeSXrxRPWmjtQZyN93p+3lrVseQb0o8kYHRsJ1ou9RZ7PtdrdJA0mlhZ1H+8eX0cU2L8W2+75//P7qPbKgzRRmYpTKEMTcZtF+1F9KzDCgzymwfnzp5KYWBcNliulkS+cDL0X/fNgbRlfx4piV58k1/aHa/tghxvKpkNObxr1vcPQW6ehI1cFUo6dK8UdAReUJ0e4VRwL5JwOOlyNEPbLHD006y8tA5JBosip3pCHmYjZISAbp5HcsnusrMjZWJ2wM91qpEsch64ESGeo8hlWpCfXWQ7JBnWvQSh9oZQ80CQGdfAAK8bci/MeNTNTB9HADGJLpPNrdJRvz8ZCMsZ0nZOfsProiLm6iZ1HUjZDRW4TFOM/nhS26UYuNK/4fyBW/4In3zNO4k13OZscv6pu6fsLAhbVfruMcW/SNrfVTrXFT+SUX3DE1IKu8IHsd58MKuQvGc1fqMKsRpW5nQFK3OyCpezLo2O1+h80MjfVNJnZtYZMZ3bai0VR+j6pSyIkiPevVQ6ALnYOkp5duW5AnqqiLcW1ttUhZj9raqvWnY0dM+HxTaVaqGehJ5ap7TXK4EOjQwWFQ0LcmRg68yMGYHJ85WJhSvUl6tI+ec++bTXjJxyIXeNC7p0hOMBpbwfTYj02U/YF2NQzOIUf7oHaJYb3KYNvNlD6bYLQ+ZpyNsVAfOkVBZlwmzv/qDi3yI6JDCH3bpRYG6w9qhFo42JS0GqWh4JJPSU7jNt+zFHJUW4ZpNcbwhFF55aTNcpEr7RL0aEOUCkxIfHlR4ie6MqKy15Ah7557L7yJXRTEnUe+guUYA04lwiISIGdkJXOFxSYxcFXlOSuVdcEkvJm2YcThVnNp0Cz2OYGeBjXCvIMcjH+m9c4AUvh7Ic9cgbRtdlzz1Y8wNsJCt3zCovw97I75VtjvqjGWX1RGWKXnzeipsFk1JsuiPUn9w830bahX2rIbmjlSlZgVd2yVmD5Weui/BYscYvoHh6/IMn3Ifv3L/7DvgWvJMjVz3JpUGvJ5UxqVSocS5R3aasOSQjCorBHjiWM+f8YEDP6YcfvrX/7XsNcwQ1e0EymXSnxYjXORsKOQdrG1tR9qtjapGJ3n3u4RHsbFOCvd6FzIsx47kHPy5DcnDrbTuM426JRrlXnlmDuqpM/5dmv2GojId2wgPwcKEWDFvzEwSIWLNmpVTd1qbWD85rrvEXFvB2nKyoU3ieinbsBxrlgK83Hnk8WKrCueMXbeC3ZzFECmVDPU7LNU84lt5o8XHirSebfUFN44BnTEfpqaJE4S/Y7rVpeZvWDzdvWthglQIm638i4vhWen48CWrFuX5OPZ2vlk6Ahv3fbR+F4ZycGKqebN5C3oc5GEK/oaie5T534UR7lIwDuI/Pl18O3h9+x8pzeI4tZN4hbC3f/+1fOXr9++RGBQkTqEDXuD3oD82MrYgsvWSgu1jRfPtlbW+6YU8qYU8qYU8qYU8qYU8hdTrHdTCnlTCnlTCnlTCnlTCnlTCvm3Q8KmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPL90RWbUsj3pcLsphTy78GBm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIa0oht55e9MucC9l6k+re4R0vFkh+H0cZPtTbP44uL3GZd/iMBpt/ruihx/H7ODrnWmB6Dr3xi8OTNHzscQb4Yum5yzbaPsL1YyfblGC78LQR39S5EQfE0Nf2bb8lPHzz9iiKo1DWrVApPaLmM3wcwmfufUzrBQm1XUY5l9OKXp9Ebs4rV3Qk6z7BO6MneP6P1hMWfHDWQNh9m+e2gf/iplYOuLx0z/vohZfr7z6tHeERG3oj/d5fXV39HwLdNNg=","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 i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const x={id:"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:"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDR6Bca3Y2+jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsuQZugYVe7ODwFeN5rmaGVQa0YVaxKUjQ2EvCjKVhPjaes1Krc5EKOWUpt5zNhM3YmBt4tMtAJiqFlE1EDr0TeSKPRLnP3pW54imbq0qzwxf/Xs+Gy2Db8dbWCxhXU/bu1dbW+68ya0uz3+/zsuypEqQRU5nzseklquin2LFMJw9jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8fbNazZRuuC2xw7zysT1cqnQkNh87qa3GdS7emACNozVQk5jVvAzxJaw7OdKJGe4bQMyxf/jwIPDV4Srra23VVkqbSFlP7ot7G9t4ZdvIFczxjVQ/0QVhZKs5JoXYIlcGbf0WcPPldCQOqLwPA+42D+R22xry85L2N/aYq9kKhJEBk2IrUxNfN+e64pIwq5vS0jERPiuLdQxJdksE0lGOJlxR88y54kDU4MpIbHiHLoTX8RsjhO/AKkCBJnS4hclLc+JHOegrUh43iYbAohdjeXaIjpLJaQNrX4F9idPHqQeEcXzFYKWIrIKIemLAXbO8wqMh2oWswyh+gFKDYZY3c+LiJQpy0BMs7Xr8fRDZWxnYlYZBLMNhV8rUInQC4S2Cc8NMDHp4LLgZ9BajSmSYZ732DdzlsKEV7mNmUCOs7qCHnutLONlmYuEj3NAzmUoPNxWGraJyp4dPCCSF0TjQ5JoMIyzVEwmoFE48SNN4ccE6JDPGhVAkmMzLpmSC4ROVK70MgtRcxePLFHSgrQ9dnDORU7Au80aJmSSVymwcc6Ts5iN8wpipiF1gjsHVFuxV0LYhXHjcU74YQZy5EIlEX6p/PLCMOOhSnvsKBOmkSf8GFBNiwjTxqqX2onClREFQcQYFFzkMSEuZh/UmFlhc4hRYEsu5zHqS4iZhQs7VhcxSzJIzugvzVOh2LiyVkm3sVSrMlUz6XE5UdIa8csKiQxfPh6jo5jtxuxRzJ7EbDiI2XAUs+FuzIaPYjZ8ErPRIGajUcxGuzEbPXJgjZ54XPMawW0AhiOHZfvlYBf17vfCkGSjwjS1Dp51dPCwx7a2amnCtp9++ulEXp5Ixk4iFK6TaJ+dRHWXkyh231Bn4reh/32BP3ZGj/3POf58NHrif86o63DX/8zw52h4Iq/8gidyRJBYXpTXQIGf7xQC/8szEbbRotgW9Bk2oiKKwwekVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbuu3xF9vkfbacODX0hNuk+kVlufgsATFKOl3e/1/MmyfvNu2Xuz9xY4n7f1R7h1VE1HqJrW77/WXvcICYswfR4mHvfIACDNvB4PvsM9wkIXos/DwRPEAR5K6xGAX+/R7lvg4Ad/wrtvg93t4d72aDDa7WAA70auQ1Fsp+n2fD6/C+yhzeOXR5MnWKjOssNb6USrYsX1g24HTS9vE9HfwWT/TzTUx8GGhRTvfXSxCBZLfeNrW9lWpXz+wLipwtDaOMP+jWk2b4FJnxAOuv0mmRKJBx77BJNsjBe8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6HnEnVcY8HSNGbLzSvb05QVRbGm2bV3mvtFsbyLXlF42Mj4+hqFxNts6+XEd/i9RKWRiO7C14oReg6UzGltus6tlqOFwyYT0n/wTMUWOmiYVjnXcIH3UiOUdL3vXsaCiDWWPd1j6QpIXgKHCvbVG2+9P/Tsj1voToAtN49b2hlOcsCSylhVMA1TuGAltxa0pMnOeS5STle5bWqAC16UeAXo//nkJP2Xf+6TAwLv+JYhJVgqpgL9QP0/Hx9s//f7FT2qsgSdcAMsB1zJxAxs0mPHGeRl44qazWa92Y5JMqVy54f6YDRM3L+navzhlMAte9yUD1ft1LFG68KPrLN43zdgOxjjhoWRK678xGMkQ8MBnbb+vnPNcet73KMTZwEk/Oi8J/j5+CQqOBkkyMrQ/K1sBvokel+PcZd8SG8Y+/4WwpqJFHI+hnz5060FrW7O+VxVXr6DU6u7Vc/RLbzhh0LI2m9B2xnErY/8YuGj+3a1Qr4dQtrSGY6cIJ6BAiwXJnhuuuhsj/auLXI4SgDyYY6BhQHoHg7a43OloAbsdmLgNJGn3Q1LYD9GHWu3YljthhU6hGkjBucohBRFVdT+0Uk9a0BZ4W2PNr5wJHrdwwpt6i6twC9uWAGdkesXOJFD8mME/8c1lqnvcY90xQJI14vxp2iRzjl9RwfszQIYttUWwBXHMnZ1B3ItfGa99PXYGzze0CfrBqGXLUmgtOiR+1zRrEG+9QlFPqu2H24957V73SPuWwHWb8yBvt9dnz6fxKTt3X9BjNoB+9bM6pySBZ9ec3Onz/eIPT08S06Ira1DDROR562QIgtNIbKDIR3IofBhLx9MxKOOHOFCWoXXghC2HcOE4qWWwigZbwKO7pxxJG3HRFmCEWelWcaNs7/J4EdSYcDWZlAsuOIDaI07XsgAN1JleHf3xtHXgzadho/2OnTaG3ToNFhHp2uujUhBUyppal8bNJ9ack0kDu3LR8ui2IZJkaQvJcZWwu3BCYOq8pTl4oyiKqkwZc7nSNUgpR7KxXDd80wp0/TwEbOv/Ib3u5E4pTEY97BXByZu4/BaIEaLFsPHOy1S7D150pWYjsDc5v7erLdMhcFuf7jXdx6t1Q6txg2zXglfYwkwdht6kZ/oVvSing3BNm6nT3U73Q2779zlrXv4eNQ5LHYGn3pY3Pnlui01N1yr7+LyfGe32La43fL++rvdIz+f+3Z/C4t6+HinzYWPh3fgQl1jOH8uJy7Zx3fGe+yujONVDHgL6/hak/izGbQN7G/OpHt3Y0kPBx0L7euOgfb1qM2Ue3u3Ysr2ogucdRKJ//rmzQ+zwR+/naqDg4OD12/fZS/fTQ8ODgr83ev1Vl6iVlGblkHL1WcE+nOZzvg1q/R6PUQhplbu0/B+Kaf/6sbH68f0TmQUR6rEnE2h5Ks02o/I6IZgg0cx3SPA2G9UOo/2LyOfI4R/+gwcHNr/YDBR9DIySQYFx7/C/QNTSzG1M4opzQW0ieKIgsaYZ4okjfYjNf4ACa5WagTHCjA4B43bvwy9XG5kFHuLK9qP3BajOPJu/bqpziot00l0FRa8bqq6pZnK0B/1hQTnwfTDT5zmNQ69Wkit/aSZXrRmoL0VcKSeK/xm4QWfm9a8zusXLWb04hgU9sSPYimfG1QalXEHXMLzpMrRLoSLUuh5HRsl47DFHzW89Uo1vMO9q4boDUhcaz6P4khYKNrta5hAq4+nXAIKMUMJKh879oOCMcAffAMGbojwvPhoKD4oYGMgopeZkh89fjjaGY6GO8MRzuCzDD52jpAMjVN8UOPTTxKEFM5xvL9ffzop3dfltbu8eYBpfJAGu2u7yUeNGeWE9W4Sk9CfMM+ncLM8HK3LU26lR5qMLlu8LIHrHqULf3ImelfE6gO+d4NAXcXRxc2buWCJ2g5J0OyrHCbWBS1ZorQE/bCdCXFvNjfa3b2Ko/nN25t/kdt7jMSb3by7Hyl7vMms/3vAuvPkKo6ym2H9rs5v/zsCu/voqjngF+yX07FK56dBb13d1DGcVdhvovIUNNpEy/qqUTWoYfBdxuniUTNWKgcuVyiaTmKzf0GD9je6oL1PZpYBXmMas5xmb2x+77B20GKyNCzkXwiD5rKu4CTqsVeT1g2CLPrF3OrQl/KcpWIPaL1TU5Eaf9D3vxFHD9pvSNDj26RABRCoM7NQlDk9wpih23hM8cS0x+r/yPisMYkAhBM7LHzzUfHc5X3Qgn5Q9wUD8+Zrjz3nss5i72aLs8vLmg2IO66u2OUlUhX0KZ77V1dx04BrdRroaHctGhIQ551RdRM0A+u21lBnZZ2ileUa/HnfBkBMpZDT00r7edAYvbrqdRhyAXBynnscQFrzmZjKFbuuTSai9K2xv4RszwE4yf8bvD8tn30nVoDytF8+e1o++xHfK5XgZM+hZyJk6iR/BnneY0+N1UpOny2g4Gnft68mpYZzATMSXKJqM8sibuuJeh6mP6GibognDEt0lQieU8KTVgmEGA3STeIl3lgoDQbFhKWR7kkJXQn4VANFgwgWXll6n0W3w7DgU84yDZN/e7CA0wfP3iLo+DTvaZ8/871fObdExs+BcTlntHHyoSjt/HCTSpOaTHKuxcRfRWNW5oDJWXhT5YmL6TmMBjiOMi7PTPx0rJ8dAS/YmxIkQvDrX/+GPYJOfyXf6BT0LZT6q4mLHir2APXYg9glihG7C22sV9VOE3oOcXCtER3/UACDji9r1W+qscFeMszXqFarxXQKGFPzPWiwf3YDPMncoUFQ8UmIIpTIPKoyATxksHAhpACbcPwh5LTr9Wlhh8J57b33Vml1ie903hwd3gKX5JLadoLi/DFul24O9uboEJ/61eTusXemxkRALe90YegJYOeCh+dAtWU/d8k14OIqXi+2Y5A9/8humy0DlAqzEqLYHeqo4eqHsUsTN29BkUSqshjTFP6FE0lZB48ERY3II1XdhitvwCRn04pymS2Kbzg1KZ2xeaonpLG6colFLK10eJ3o2cKpCWMaPAWsYKfW/DEDadxwzibcWNAxq6RAzOsKvZT1lHBRghYgE1iJAg0Odag6bj6iuu/e3v3wvX8BHPYQhHKMEugmhpRVJXENSUL9HjNQbnHrK+1Br75vBhBtN3o16V2tJWijJKo4padceg3q7qPoTx1DxnPX1asKDMkhPCjhvZV3/1//+rcWXGudIsuAuRV4mmKy7Q0QkmvaMTzmk2koUQOqLkQ4H+g/LF4BEDoSmtNCpbUgmdvz+CGl55paL/ocgTo/wVRJhsdWrW9NHHSs8U4FQ15oclVTkkGJ+4ULYWzrRWHI+1/WDz8A4jFpwUCXUJRq5Hk5bwt4kzehFqaj64HovkatL0FLssArq041FELe7pxqe/2tqhVBZVXBrUhYmMr0um+MXWg5yHXBvgqgITeeC6UfrhFVnO5UyQROhTyFc9C3uN6/rvMUySc5BjsDkG3YApLccda8A53h0/0OTlqnE712bkOJzsnSJYes8lx1gQpvtkPCfeAHd5RQLYFijElKLs0FRY0UR7ilLbnCvhRfms/32HjSviBX03Aw+Ef2pO0MvhxP2u7gC/KkPUFgfQz0ZgW0zr5ZqTtCoPP6AR8UuFBHrvT1PTGwSE46F4lfheBGHEZX7r/G+Rf0/g0OQecxbCKZ/joTNkNoGA0G+L8uOV90chjRuK0SNBYnVZ7P/ymKbx9GvZ4Grnm1k/I6rZ59EKNfLpLz0WHkQ3Rda/ojz6JPirPhmMUo2xqb/tqteIGodI4leHAv27U9RdO2aCxkLiScBgKepio5DbvHfgUY0z3lbgVDTW66ZXdpfcPykWPM3VVc9FYVYDMyP3HeGXpvaveG1XPGp1xIhjKu75CpQOubxO/jILsOBbuDwemwRsLeMhJeSXrxRPWmjtQZyN93p+3lrVseQb0o8kYHRsJ1ou9RZ7PtdrdJA0mlhZ1H+8eX0cU2L8W2+75//P7qPbKgzRRmYpTKEMTcZtF+1F9KzDCgzymwfnzp5KYWBcNliulkS+cDL0X/fNgbRlfx4piV58k1/aHa/tghxvKpkNObxr1vcPQW6ehI1cFUo6dK8UdAReUJ0e4VRwL5JwOOlyNEPbLHD006y8tA5JBosip3pCHmYjZISAbp5HcsnusrMjZWJ2wM91qpEsch64ESGeo8hlWpCfXWQ7JBnWvQSh9oZQ80CQGdfAAK8bci/MeNTNTB9HADGJLpPNrdJRvz8ZCMsZ0nZOfsProiLm6iZ1HUjZDRW4TFOM/nhS26UYuNK/4fyBW/4In3zNO4k13OZscv6pu6fsLAhbVfruMcW/SNrfVTrXFT+SUX3DE1IKu8IHsd58MKuQvGc1fqMKsRpW5nQFK3OyCpezLo2O1+h80MjfVNJnZtYZMZ3bai0VR+j6pSyIkiPevVQ6ALnYOkp5duW5AnqqiLcW1ttUhZj9raqvWnY0dM+HxTaVaqGehJ5ap7TXK4EOjQwWFQ0LcmRg68yMGYHJ85WJhSvUl6tI+ec++bTXjJxyIXeNC7p0hOMBpbwfTYj02U/YF2NQzOIUf7oHaJYb3KYNvNlD6bYLQ+ZpyNsVAfOkVBZlwmzv/qDi3yI6JDCH3bpRYG6w9qhFo42JS0GqWh4JJPSU7jNt+zFHJUW4ZpNcbwhFF55aTNcpEr7RL0aEOUCkxIfHlR4ie6MqKy15Ah7557L7yJXRTEnUe+guUYA04lwiISIGdkJXOFxSYxcFXlOSuVdcEkvJm2YcThVnNp0Cz2OYGeBjXCvIMcjH+m9c4AUvh7Ic9cgbRtdlzz1Y8wNsJCt3zCovw97I75VtjvqjGWX1RGWKXnzeipsFk1JsuiPUn9w830bahX2rIbmjlSlZgVd2yVmD5Weui/BYscYvoHh6/IMn3Ifv3L/7DvgWvJMjVz3JpUGvJ5UxqVSocS5R3aasOSQjCorBHjiWM+f8YEDP6YcfvrX/7XsNcwQ1e0EymXSnxYjXORsKOQdrG1tR9qtjapGJ3n3u4RHsbFOCvd6FzIsx47kHPy5DcnDrbTuM426JRrlXnlmDuqpM/5dmv2GojId2wgPwcKEWDFvzEwSIWLNmpVTd1qbWD85rrvEXFvB2nKyoU3ieinbsBxrlgK83Hnk8WKrCueMXbeC3ZzFECmVDPU7LNU84lt5o8XHirSebfUFN44BnTEfpqaJE4S/Y7rVpeZvWDzdvWthglQIm638i4vhWen48CWrFuX5OPZ2vlk6Ahv3fbR+F4ZycGKqebN5C3oc5GEK/oaie5T534UR7lIwDuI/Pl18O3h9+x8pzeI4tZN4hbC3f/+1fOXr9++RGBQkTqEDXuD3oD82MrYgsvWSgu1jRfPtlbW+6YU8qYU8qYU8qYU8qYU8hdTrHdTCnlTCnlTCnlTCnlTCnlTCvm3Q8KmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPL90RWbUsj3pcLsphTy78GBm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIa0oht55e9MucC9l6k+re4R0vFkh+H0cZPtTbP44uL3GZd/iMBpt/ruihx/H7ODrnWmB6Dr3xi8OTNHzscQb4Yum5yzbaPsL1YyfblGC78LQR39S5EQfE0Nf2bb8lPHzz9iiKo1DWrVApPaLmM3wcwmfufUzrBQm1XUY5l9OKXp9Ebs4rV3Qk6z7BO6MneP6P1hMWfHDWQNh9m+e2gf/iplYOuLx0z/vohZfr7z6tHeERG3oj/d5fXV39HwLdNNg=",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={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"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.p,{children:[(0,i.jsx)(n.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,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.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(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},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",description:"Allowed values - signature, stamp.",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,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.47aa6633.js b/assets/js/4227e71a.3f44a353.js similarity index 87% rename from assets/js/4227e71a.47aa6633.js rename to assets/js/4227e71a.3f44a353.js index 59cb056c0..9195b4979 100644 --- a/assets/js/4227e71a.47aa6633.js +++ b/assets/js/4227e71a.3f44a353.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5342],{30649:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>P,contentTitle:()=>y,default:()=>f,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+HY5b0yuMzknv04eLHdz9fvSNl6CGNDjseHg/HoSnWzpdc9U7qzyL3C9tmS6T+D+aWTbGndnRkJBeBajU9UaRJt9s+IWGT/tTyLmGFdp5ENhtK5l+trGta/q0KLcrtXcIW3ArqzAKXyoWjv/NuAvlVz333SzPMfAXPH4AeNKalM4q4zILLKrRwCbvH9d4Utr6jUUHkNKRtlDjPMjS+h31AjncY5vt31yx0ecUul7oPXKr5g3Y/qNcuyYoK0L/E+A4CNpvI0+q6k4+fvopoDGylyUl3dV3/F5aGM8E=","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),o=a.n(r),i=a(17543),s=a.n(i),m=a(86013),d=a.n(m),c=a(63723),g=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:"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+HY5b0yuMzknv04eLHdz9fvSNl6CGNDjseHg/HoSnWzpdc9U7qzyL3C9tmS6T+D+aWTbGndnRkJBeBajU9UaRJt9s+IWGT/tTyLmGFdp5ENhtK5l+trGta/q0KLcrtXcIW3ArqzAKXyoWjv/NuAvlVz333SzPMfAXPH4AeNKalM4q4zILLKrRwCbvH9d4Utr6jUUHkNKRtlDjPMjS+h31AjncY5vt31yx0ecUul7oPXKr5g3Y/qNcuyYoK0L/E+A4CNpvI0+q6k4+fvopoDGylyUl3dV3/F5aGM8E=",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,P={},x=[];function b(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)(o(),{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)(d(),{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 f(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,p.jsx)(t,{...e,children:(0,p.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"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/5144c8d4.79e73705.js b/assets/js/5144c8d4.d7ccdb73.js similarity index 83% rename from assets/js/5144c8d4.79e73705.js rename to assets/js/5144c8d4.d7ccdb73.js index 153c1bd29..f439dee5c 100644 --- a/assets/js/5144c8d4.79e73705.js +++ b/assets/js/5144c8d4.d7ccdb73.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7904],{8437:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>S,contentTitle:()=>x,default:()=>A,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/FPXh58vzo1dkRG8ONNAVst7/bH8bN3QZqpFm76bj7ptr6ntoecvO7LeqLv9OWY5nwlgZOSxW3oOjmfLnBXIpug7nORG0DMWk+5zJ74/ViweT3LXrei64zMZFesQVxK8q6Yc4rzw3OOJxFgY73o4nUbdoIttbAjV3q+OhcZIL70eYScROXiOUDa++OzGxN9+Z2kQzgX151Pikwn6cFZbFY8aejz0osHey4OYDXi8Xib7uOWlU=","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":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var a=i(74848),o=i(28453),s=i(33617),r=i.n(s),c=i(17543),p=i.n(c),d=i(86013),l=i.n(d),b=i(63723),m=i.n(b),u=(i(18766),i(79329),i(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/FPXh58vzo1dkRG8ONNAVst7/bH8bN3QZqpFm76bj7ptr6ntoecvO7LeqLv9OWY5nwlgZOSxW3oOjmfLnBXIpug7nORG0DMWk+5zJ74/ViweT3LXrei64zMZFesQVxK8q6Yc4rzw3OOJxFgY73o4nUbdoIttbAjV3q+OhcZIL70eYScROXiOUDa++OzGxN9+Z2kQzgX151Pikwn6cFZbFY8aejz0osHey4OYDXi8Xib7uOWlU=",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 j(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,a.jsx)(p(),{parameters:void 0}),"\n",(0,a.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,a.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:"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 A(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7904],{8437:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>S,contentTitle:()=>x,default:()=>A,frontMatter:()=>g,metadata:()=>s,toc:()=>v});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/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":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var a=n(74848),i=n(28453),o=n(33617),r=n.n(o),p=n(17543),c=n.n(p),d=n(86013),l=n.n(d),m=n(63723),b=n.n(m),u=(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/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 C(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,a.jsx)(c(),{parameters:void 0}),"\n",(0,a.jsx)(l(),{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:"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 A(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(C,{...e})}):C(e)}}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.66f4fead.js b/assets/js/58abd73c.66f4fead.js deleted file mode 100644 index 6fba0d015..000000000 --- a/assets/js/58abd73c.66f4fead.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8564],{73135:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>v,default:()=>X,frontMatter:()=>x,metadata:()=>o,toc:()=>f});const o=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":"eJy9WM1uI7kRfpUKL8kKbf14ZjaITjEWE8eJMWPEXhiIxxiwu0vdHLFJLlmtHwgC9pA3yCnXPNo8SVCkWmrZmt1xstmL7S5WFb+q+sgqeiNIVkFMH8SfrC7Ri8dMlBgKrxwpa8RU3NUIaQ2uVSC4uLkCbJxdog+wti2QBY/kFS4QJGjWsTOYJZOlohps+m1bAic9Gkr+rkqRCevQS97qqhRTkazYh8iEk142SOgZ30YY2aCYimceFKP8oUW/Fk+x2/wTFnRVHgCJTHj8oVUeSzGdSR0wE4HWGuPmvhGZwJXTtsTDclFjI8V0I2jtWC+QV6YSWTSQ1JfgSjYuOhPbbbbHrFWj6CnUr8ZBvj2C0ciVatpGTN+Mx1kHyrRNjl5sexgm4x6EMFfuF0Pw5T3H20f2G5w1AQPrno/H/Ou4MKEtCgxh1mrYE0BkorCG0BDrS+e0KuLC6FNgo81zAKm+TBXPbkilLT2GVlNPT3ovOWBF2ISft+9o89Kau3qS16vzT45Tkvj2Lmb/ZW4MLju2brOnfH+hr7+cGxnezNUNPvX13yILbd5DV3iUhOUFnXJ1MDwfn786m4zPxr+/m3w7ff2H6Ztvh+Px+O8iE6tGs+2OpqWkiJQU6f5368pfYZ+eIIX40WMQ275cGa0Mfuwo/vF8PP44ecU620y8PsX1W9sg1cpUsERDsPTWVBk4jTIgkF+DrKQyoCWh/80vdwjQe+t/OlsvQ/ZTWXjNWdgn4c3zJFyZhdSqjN3jzs7R/LqR9rentD1DPeaESkpxXRwF25enIAMWrVe0jp1pdSadOkvr04dHvgI5sZY7WoWplVEtpmJ01N8C+kXX3FqvxVTURC5MR6MgTZnb1dA6NEFVRss8DAvbjKRTo8VkOBF8sx/bSOdepI/t2UtNAslKmern7B4P6bnlEqYqHSXpcDM79Vfkq3lXg77WrlvVKONls+XvmY3Gu8q8d2huVWViXePmTyeAe9SFbZCHFKoRBoPO5PM//r23GgygtEXboKHIwOEH88G8bz3EKYeblDQlzDSuVK7x5AQUUDYaQ9BrUIaw8pIQSlUpkho4T3zKCulkrrRi4rKaZWsPPe6HIdzXSDV6Xvqt54mqxAVq5jvIlmwjiV11eGFp/Xym7TJkICFvgzIYAqCppSlYsatExlOYNICG0DuvAkIgz6hVwmYNeVkQNNLICtl3Bv1klagV0xW8zdtAEKxuI2QgqbT1WEIXkEEsQ0ziW54gPAJLC9s4jzXTZoFQtarEkEFhS4QQzymHYErIMRA4xqIKDOy0NdoW81jAWas1OMvXhpKa57o+RjYnL03gJpawdDXYJ8x5y6MHJoCDwfcBucLXyszDdDD4YM7gYc+re8yDInz8XXcElsvlM+p/c2xzqejPbQ5/Q2eDIuvXB+tKUd3m8bj0new/kqdLNBj50zsMBx+lLcLz08fSUY3ajW6RmCFhdHFzFW/ab+Dzj/+Ea5TeQG2Xia1F61Gvoeq24sylyqe07S9KmNlIvJozXiTy8dyIgboM3teSPv/4rwDvcAnK7I4UhzIY3LS5VgXcYeO4jYTBYArfxZkBqJMB1ZKgkAZyhFBLptJCSZDgkrVWZj6EC7OGNnRvCiYDy6PdURicl325A+QyYAnWRItuz+EBEcubgHqBgX0ZSwwDS0XM6Nrbtkq79cHsgvM4U1rDvSorpBjbRVmC24mXScwJ78HBGR8IqnEN0iMENDSEmycmcaV1znpGoRL4mdXaLrkAaEpnlaEwhdLLGR38Zweix9FMWXNClFIo9+nIdm72JUkncRfxXjr8wJfyk4v8+L71OEPPG8awD3Vxakenh46WwGz9X2gdx09rSBZxgsBGKp06yh+f+ondHH0T3s9u0S9Ugbuu9oUTPYrKI5EJrQo0AXtTwsXlzTUsXg3HIuu1x6843KPrq+/evrt9y2D4Ik0Jmwwnw3GczW2gRpreTpdI3TN6NzEc5XpzmJ/+34/0XbMmXNHIaanieBSD3+xGm4f+0/0xE7UNxNLNhs/f915vtyxOL08eeEoVZK57b88vxnbyEX8S0RzXp/5BsJC6TU/y7MS+yah7oX+N7u4pfVB95A+vWDfOf1k3s3CgyeaiKND1N3g28B5NjZdv70Qm+No9npXmcVba/cHeuyWz7vk+HqISAP7JMZ002GzSHLbd7vXT0hctdgF22pz/x+12+x+LZWDx","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),i=r(28453),n=r(33617),l=r.n(n),a=r(17543),d=r.n(a),p=r(86013),m=r.n(p),c=r(63723),I=r.n(c),g=(r(18766),r(79329),r(9303));const x={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:"eJy9WM1uI7kRfpUKL8kKbf14ZjaITjEWE8eJMWPEXhiIxxiwu0vdHLFJLlmtHwgC9pA3yCnXPNo8SVCkWmrZmt1xstmL7S5WFb+q+sgqeiNIVkFMH8SfrC7Ri8dMlBgKrxwpa8RU3NUIaQ2uVSC4uLkCbJxdog+wti2QBY/kFS4QJGjWsTOYJZOlohps+m1bAic9Gkr+rkqRCevQS97qqhRTkazYh8iEk142SOgZ30YY2aCYimceFKP8oUW/Fk+x2/wTFnRVHgCJTHj8oVUeSzGdSR0wE4HWGuPmvhGZwJXTtsTDclFjI8V0I2jtWC+QV6YSWTSQ1JfgSjYuOhPbbbbHrFWj6CnUr8ZBvj2C0ciVatpGTN+Mx1kHyrRNjl5sexgm4x6EMFfuF0Pw5T3H20f2G5w1AQPrno/H/Ou4MKEtCgxh1mrYE0BkorCG0BDrS+e0KuLC6FNgo81zAKm+TBXPbkilLT2GVlNPT3ovOWBF2ISft+9o89Kau3qS16vzT45Tkvj2Lmb/ZW4MLju2brOnfH+hr7+cGxnezNUNPvX13yILbd5DV3iUhOUFnXJ1MDwfn786m4zPxr+/m3w7ff2H6Ztvh+Px+O8iE6tGs+2OpqWkiJQU6f5368pfYZ+eIIX40WMQ275cGa0Mfuwo/vF8PP44ecU620y8PsX1W9sg1cpUsERDsPTWVBk4jTIgkF+DrKQyoCWh/80vdwjQe+t/OlsvQ/ZTWXjNWdgn4c3zJFyZhdSqjN3jzs7R/LqR9rentD1DPeaESkpxXRwF25enIAMWrVe0jp1pdSadOkvr04dHvgI5sZY7WoWplVEtpmJ01N8C+kXX3FqvxVTURC5MR6MgTZnb1dA6NEFVRss8DAvbjKRTo8VkOBF8sx/bSOdepI/t2UtNAslKmern7B4P6bnlEqYqHSXpcDM79Vfkq3lXg77WrlvVKONls+XvmY3Gu8q8d2huVWViXePmTyeAe9SFbZCHFKoRBoPO5PM//r23GgygtEXboKHIwOEH88G8bz3EKYeblDQlzDSuVK7x5AQUUDYaQ9BrUIaw8pIQSlUpkho4T3zKCulkrrRi4rKaZWsPPe6HIdzXSDV6Xvqt54mqxAVq5jvIlmwjiV11eGFp/Xym7TJkICFvgzIYAqCppSlYsatExlOYNICG0DuvAkIgz6hVwmYNeVkQNNLICtl3Bv1klagV0xW8zdtAEKxuI2QgqbT1WEIXkEEsQ0ziW54gPAJLC9s4jzXTZoFQtarEkEFhS4QQzymHYErIMRA4xqIKDOy0NdoW81jAWas1OMvXhpKa57o+RjYnL03gJpawdDXYJ8x5y6MHJoCDwfcBucLXyszDdDD4YM7gYc+re8yDInz8XXcElsvlM+p/c2xzqejPbQ5/Q2eDIuvXB+tKUd3m8bj0new/kqdLNBj50zsMBx+lLcLz08fSUY3ajW6RmCFhdHFzFW/ab+Dzj/+Ea5TeQG2Xia1F61Gvoeq24sylyqe07S9KmNlIvJozXiTy8dyIgboM3teSPv/4rwDvcAnK7I4UhzIY3LS5VgXcYeO4jYTBYArfxZkBqJMB1ZKgkAZyhFBLptJCSZDgkrVWZj6EC7OGNnRvCiYDy6PdURicl325A+QyYAnWRItuz+EBEcubgHqBgX0ZSwwDS0XM6Nrbtkq79cHsgvM4U1rDvSorpBjbRVmC24mXScwJ78HBGR8IqnEN0iMENDSEmycmcaV1znpGoRL4mdXaLrkAaEpnlaEwhdLLGR38Zweix9FMWXNClFIo9+nIdm72JUkncRfxXjr8wJfyk4v8+L71OEPPG8awD3Vxakenh46WwGz9X2gdx09rSBZxgsBGKp06yh+f+ondHH0T3s9u0S9Ugbuu9oUTPYrKI5EJrQo0AXtTwsXlzTUsXg3HIuu1x6843KPrq+/evrt9y2D4Ik0Jmwwnw3GczW2gRpreTpdI3TN6NzEc5XpzmJ/+34/0XbMmXNHIaanieBSD3+xGm4f+0/0xE7UNxNLNhs/f915vtyxOL08eeEoVZK57b88vxnbyEX8S0RzXp/5BsJC6TU/y7MS+yah7oX+N7u4pfVB95A+vWDfOf1k3s3CgyeaiKND1N3g28B5NjZdv70Qm+No9npXmcVba/cHeuyWz7vk+HqISAP7JMZ002GzSHLbd7vXT0hctdgF22pz/x+12+x+LZWDx",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,u={},f=[];function k(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,s.jsx)(l(),{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)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{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)(I(),{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 X(e={}){const{wrapper:t}={...(0,i.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/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/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/5a144266.e4fd7cb0.js b/assets/js/5a144266.e4fd7cb0.js deleted file mode 100644 index 141f47380..000000000 --- a/assets/js/5a144266.e4fd7cb0.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:()=>b,contentTitle:()=>y,default:()=>P,frontMatter:()=>h,metadata:()=>i,toc:()=>f});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/iu1vGQjtCXZ4/FkdYoRDBxjjYyxdmAgHkNgd1erOWaTDMnWA0IDOew/2NNe96fNL1kU+ym/ZG+CHPZiq8n6WA9WkV9xyzxfODa7ZddYGMk9OnYXsRRdYoXxQis2Y9c5whl6aEXgQjgPp5fnwKXUKwcbXYLXYNFbgUsEDpIkdAZ8yYXksUTw7fpjuM6Fg6xUCa3PpfAbMFYvRYoOuAK9RLsUuAp4KXtkBKh4LIVaQOnQOtKZ5Fo7hMzqAnAtnKfZDgGrHBUkFnkYT3VSFqi8G7OIaYOWkwXnKZuxBfoWRbaziBlueYEeLYVnyxQvkM2YFIWgWUGB+bVEu2ERs/hrKSymbJZx6TBizm8kSWfaFixiuDZSp8hm3pY0m+RYcDbbsoKvRVEWbPZ+Oo2Y3xgCqbKI0bKKcLwwtNDhtIo6E9y9MH+YBc/rnFZ3tK4zWjl0JHs0ndK/3eRwZZKgc1kpoYsoi1iilUflSZ4bI0USJiZfHIG2jw3Q8RdMQtgtLeNFrdKiK6UfyHFrOTksPBZuP74eph3uJJ23Qi1YFELD/XCk852tD3+MVeGOLhcUEy88jT5eoge48KPLPEIp7feAWmkIohWZJFO0f5ZbdT69ZGBtDwTBqg9EZ/i8MZhMF/tClHtv3GwyacFUw+NEF4TWK7Xj90vBCuWsW6si5sRChSr9X5PE6n2mJ6hfF7AvGiHGYBYWXMi90jHi981AGwuTa7VHzfH7k6PDd999OCT5lUgX6H+H//Xs2zLJ49rHeh3s5Qt8fJQM4N1If55VEVu/EXN0fFxFbPNG1AdStXoj6N13VcTyN4KOTyiPw7H4ipg/l0qvinn1ZC1e1XUwb/PhRalQzg5Veq4+2d0zJ9ZaIldD1XRrVBELlYfpqX85O4+mR+8ODqcH0w/Xhyez47/N3p+Mp9PpLyxi60L23rO0OSlbI9vv0qR/ip5AJ/Bal69z32IqLCZ+XtonC/ulvSN1gS3NC52KrLkP3ct6w11OwNLrucVCqL071UJq6blWCc6FmuOSeMITCT247quHYRteZg/zaDe7hJJC4bxlC/Oj6XR+0uTp8fT9Y9ZwrpZcijSQyGt9j+ovfxxnQGv1nrtkqN7X6h+7L2qhMM92nB2O1046TEor/CZQxfUBN+Kgnp/d3hGPKtDnuuGZgVv6nM3Y5AHldGiXLd8MOdbdmY6rNNbrsTao6L6TPHZ0X0y4EZPl4ZgugocYbsyb5LE8eCvEeb4QarEPd9cH6Io2sd6nnTD1d5cRf0e6vJpdGEo1pDdHHkhHRd+ZDuBmbz4ZVHTChZ0Nyh82MzcoE10g9Q4+RxiNWsjXf/6nQ41GXa8QcnD8WX1Wn0oLRq/QEtflKoVM4lpQb0MwLMJc1ww55IVE5+QGhPK4sERdUrEQnkugOFFDknDDYyEFpS6JaUJbGGS/G8NNjj5HS1PfWGquUlyipIwHOhiK3d4GVtreZ9SWRcAhLp1Q6BygyrlKSLDdiQi0pXYLlUdrrHAIzluyWtS2aeUtTzwUXPEF0toRDIOVohSUrmB1XDoPTssymAyeC6ktptA6pBBTF4L4kRoRi0CjiS6MxZzSZomwKKkBjCDRKUJNp8kFlUKMzoMhW0SCoesrldTJfdjArJQSjKaDQ3BJPePQRoJ7y5Wjs7m2pd2DLmDGaupgsDZwNPrZIe3whVD3bjYafVYHcNvl1Q3GTni8+2tbAqvV6lHqf7uLORP+xzKGf6DRTnhtNz16IXxexqFchot0H/VKZ6gw5M+gGPo1Up24x9VHo5McpZlcoacMcZPTy/Nw1n4LX3/7F1wgtwpyvaqzNSktyg0sWlUUuXrn67B1RyVkOiReThFP6uSj9hOdbyN4k3P/9bd/O/gJVyBUU1Lkymh0WcZSJN1bghuNZvBD4BWDtt3n3EPCFcQILueUSkvBgYOp0VKo+zGcqk14CICV8HlIBhoPuB03KC597w8xd5iCVgHR6hz3FtF44VAu0dFaSnsyA1PhKaNzq8tFrW1oTOOcxUxICTc1BSPfTtMUTDPcMDMK+MAczKggfI4b4BbBofJjuHwACTOlMdqSFaI2PtPEKGgDUKVGC+XdDFLLM9+vH/WJXr+DaPXEUB1C3oUjapYZvL1QJBuP+7ecz3QoPzjId89bixlaUhjc7vfFiCadbtu0BMrW35PWdEnTqcWTwCGaBoxulO8frhPuc7SF+5Rd0WtT0jaoz1T0JAhPWMSkSFA5HPCE07PLC1i+G09ZNLgeX1Hck4vzHz7+dPWRjKGDtA7Y4fhwPA19lXa+4GqgaecRruEMO9He9hzq//TVrmEJ1ApNjOQiMLOGj9es6pbtsKq7iOXaeRrfbqn0f7ayqmi4fjsjrpUKR972r2f3uBm89S25LBsO/6xs8yjXi97RhxUkG0hg1NIWUlhjTpMEzVDBI9a7Qx3PPl6z0Avku3TpPtCl5get3k6pzWDtXR5VG0B/yacnAdttTcWqqpOvp55FNA620rQ3d1VV/RfaiswL","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),r=a.n(p),m=a(86013),d=a.n(m),c=a(63723),u=a.n(c),g=(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/iu1vGQjtCXZ4/FkdYoRDBxjjYyxdmAgHkNgd1erOWaTDMnWA0IDOew/2NNe96fNL1kU+ym/ZG+CHPZiq8n6WA9WkV9xyzxfODa7ZddYGMk9OnYXsRRdYoXxQis2Y9c5whl6aEXgQjgPp5fnwKXUKwcbXYLXYNFbgUsEDpIkdAZ8yYXksUTw7fpjuM6Fg6xUCa3PpfAbMFYvRYoOuAK9RLsUuAp4KXtkBKh4LIVaQOnQOtKZ5Fo7hMzqAnAtnKfZDgGrHBUkFnkYT3VSFqi8G7OIaYOWkwXnKZuxBfoWRbaziBlueYEeLYVnyxQvkM2YFIWgWUGB+bVEu2ERs/hrKSymbJZx6TBizm8kSWfaFixiuDZSp8hm3pY0m+RYcDbbsoKvRVEWbPZ+Oo2Y3xgCqbKI0bKKcLwwtNDhtIo6E9y9MH+YBc/rnFZ3tK4zWjl0JHs0ndK/3eRwZZKgc1kpoYsoi1iilUflSZ4bI0USJiZfHIG2jw3Q8RdMQtgtLeNFrdKiK6UfyHFrOTksPBZuP74eph3uJJ23Qi1YFELD/XCk852tD3+MVeGOLhcUEy88jT5eoge48KPLPEIp7feAWmkIohWZJFO0f5ZbdT69ZGBtDwTBqg9EZ/i8MZhMF/tClHtv3GwyacFUw+NEF4TWK7Xj90vBCuWsW6si5sRChSr9X5PE6n2mJ6hfF7AvGiHGYBYWXMi90jHi981AGwuTa7VHzfH7k6PDd999OCT5lUgX6H+H//Xs2zLJ49rHeh3s5Qt8fJQM4N1If55VEVu/EXN0fFxFbPNG1AdStXoj6N13VcTyN4KOTyiPw7H4ipg/l0qvinn1ZC1e1XUwb/PhRalQzg5Veq4+2d0zJ9ZaIldD1XRrVBELlYfpqX85O4+mR+8ODqcH0w/Xhyez47/N3p+Mp9PpLyxi60L23rO0OSlbI9vv0qR/ip5AJ/Bal69z32IqLCZ+XtonC/ulvSN1gS3NC52KrLkP3ct6w11OwNLrucVCqL071UJq6blWCc6FmuOSeMITCT247quHYRteZg/zaDe7hJJC4bxlC/Oj6XR+0uTp8fT9Y9ZwrpZcijSQyGt9j+ovfxxnQGv1nrtkqN7X6h+7L2qhMM92nB2O1046TEor/CZQxfUBN+Kgnp/d3hGPKtDnuuGZgVv6nM3Y5AHldGiXLd8MOdbdmY6rNNbrsTao6L6TPHZ0X0y4EZPl4ZgugocYbsyb5LE8eCvEeb4QarEPd9cH6Io2sd6nnTD1d5cRf0e6vJpdGEo1pDdHHkhHRd+ZDuBmbz4ZVHTChZ0Nyh82MzcoE10g9Q4+RxiNWsjXf/6nQ41GXa8QcnD8WX1Wn0oLRq/QEtflKoVM4lpQb0MwLMJc1ww55IVE5+QGhPK4sERdUrEQnkugOFFDknDDYyEFpS6JaUJbGGS/G8NNjj5HS1PfWGquUlyipIwHOhiK3d4GVtreZ9SWRcAhLp1Q6BygyrlKSLDdiQi0pXYLlUdrrHAIzluyWtS2aeUtTzwUXPEF0toRDIOVohSUrmB1XDoPTssymAyeC6ktptA6pBBTF4L4kRoRi0CjiS6MxZzSZomwKKkBjCDRKUJNp8kFlUKMzoMhW0SCoesrldTJfdjArJQSjKaDQ3BJPePQRoJ7y5Wjs7m2pd2DLmDGaupgsDZwNPrZIe3whVD3bjYafVYHcNvl1Q3GTni8+2tbAqvV6lHqf7uLORP+xzKGf6DRTnhtNz16IXxexqFchot0H/VKZ6gw5M+gGPo1Up24x9VHo5McpZlcoacMcZPTy/Nw1n4LX3/7F1wgtwpyvaqzNSktyg0sWlUUuXrn67B1RyVkOiReThFP6uSj9hOdbyN4k3P/9bd/O/gJVyBUU1Lkymh0WcZSJN1bghuNZvBD4BWDtt3n3EPCFcQILueUSkvBgYOp0VKo+zGcqk14CICV8HlIBhoPuB03KC597w8xd5iCVgHR6hz3FtF44VAu0dFaSnsyA1PhKaNzq8tFrW1oTOOcxUxICTc1BSPfTtMUTDPcMDMK+MAczKggfI4b4BbBofJjuHwACTOlMdqSFaI2PtPEKGgDUKVGC+XdDFLLM9+vH/WJXr+DaPXEUB1C3oUjapYZvL1QJBuP+7ecz3QoPzjId89bixlaUhjc7vfFiCadbtu0BMrW35PWdEnTqcWTwCGaBoxulO8frhPuc7SF+5Rd0WtT0jaoz1T0JAhPWMSkSFA5HPCE07PLC1i+G09ZNLgeX1Hck4vzHz7+dPWRjKGDtA7Y4fhwPA19lXa+4GqgaecRruEMO9He9hzq//TVrmEJ1ApNjOQiMLOGj9es6pbtsKq7iOXaeRrfbqn0f7ayqmi4fjsjrpUKR972r2f3uBm89S25LBsO/6xs8yjXi97RhxUkG0hg1NIWUlhjTpMEzVDBI9a7Qx3PPl6z0Avku3TpPtCl5get3k6pzWDtXR5VG0B/yacnAdttTcWqqpOvp55FNA620rQ3d1VV/RfaiswL",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,b={},f=[];function x(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(g.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)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(r(),{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)(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 P(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.60832077.js b/assets/js/5ce6d213.60832077.js deleted file mode 100644 index e1c75a3ae..000000000 --- a/assets/js/5ce6d213.60832077.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:()=>n,toc:()=>I});const n=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":"eJzFWN1uG7sRfpUpb5oIa0lOnBxUV3Vz0iRokAixjaB1DIG7O6vlMZfkIbmSBWOBc9E36FVv+2h5kmLI3dXqJ07Sc9reGDJ3Zji/nG/mnnm+dGx2zS6xMpJ7dOwmYTm6zArjhVZsxi5LhCuTc4/QUcH5/A2g4qlEBxtdg9dQ6VwUG+AqhzpS+xIhR8+FdKAL4OAMZqIQGfhWzpglTBu0nK56k7MZi6zdPSxhhlteoUdLat4zxStkM9YJWIicJUyQmob7ku3r/uZHupkU6TjAl9yDQswdaZ1iqy3JsfhzLSzmbOZtjQlzfiPpNicqI0kZvDNS58hmBZeOCLISK85m98xvTKD0VqglS1ihbcX99qRpbqJ8dP5POt8Qz66qc6tXIkdIUeo19GaTkp0/uxjBI+5BIncetMIBbWfAY5awTCuPytNF3BgpsuDkyU+Obrs/VF2nP2HmyeOWQuIFOvoaHf51A8k5PLhpxlz40evLmoQp7b9bzJxMRLC4ErgOieXEUoEvhYNcZ3VF5jV7If++K/qsGMpoiEfmaCkjD+VtuYkyVsH7y/mANNVaIlcH2UhZBSfRAB0OYS2kbCsJ3l/OYYWWKiTEagxXDq2LNBYzFCsEvkMCmc4RVoIDVlzIBNalyEpK+A1UtfOAqs2h1nXYe24MIYnhBA4VyoU7qlECXEq9FmoJdVDtmGDIhcXMyw2shS917YHnuSB2LsF5NG489GLQonfkpa7tr/ckh2UtcszB69pCoW3QEq1LwIQyIwuEct7WGTE7yGuKbrCDSOm3sTpD57Z+6rxCRAP5CaBykZ1DwZ1Hm0CtBHne1sZj3ovEO4NWoMrwqAuCcxfhIW0d7r7dF3O0lfCus5RCw/McUCIFxYGrsxJ4/M59bdElIJTwgkuXgPO8Mi4BbcHjHb0r4LWhxxPvhPOk/FrkS/QOxJfy6ANSjWQDHQqrqxB98o3aDBOh18vrPXGXFFTh2vZR8Fp6WHFZH/dZIeTRh2XXR3/VNVR800Y/hjDlDp+fASqqoRzmP/4ZSBgpZNFInkWy3n6tcPiaRPaD98BiTP9FbeXX9bqIHRGjtVcf3sK6RIt9HqKNeZ3SMxgFI/XXUPl0q++ytq++/fQ90JDXXi8sVkLl+C21doE+BInSzOu+xGqvK+5FBp0oN4aWNCaE18OKqeBRF8wUS74S2j4+GtAobqFVhguhFrhCuxloqeoqRXug5LtwTPma842DFP0aUQ1169JKK7mBtiOSbusSFez4hKjc1ugdLZ81TcK88DvdYzGAI4uUunvTNMEUZ7RysZE+mU4Pm34PqFoQQlVKUStqKTe/++26eDz+Wj/jLn/y2s3PXhvKk1alc/8w05Ppk6cnp9OT6Q+Xp89nZ3+YPXs+nk6nf2MJu6vkFkKwvIUCnffi/4MDoaRQuOi8tngynS6etq48O+a9FiB0Rb3iUuRQCJQ50J3uN3QgWqvtfwhgHtDvIfPJ5M74swdSR2kPha5V/v8295hGDxt4tvihN/HZoYlvVHQZTRuX+hbV/8LCrT3D6328nlTdzWoRicJ3tmPs8Dwa6TCrrfCbMMncnXAjTuL32fUNzQcV+lLTFGTqoDBNNDM26V6Xyf3gnWkYybOrbjAK7YaV3hs3m0wcV3mq78baoKKGIHnqxpmuJtyIyep0fMqaZJ+HG/Nd9FiffC+L83wp1PJrfDdbV11QOGPEdhzWx40b8RfcsKSLx5CqnQxL5NTpKAKUJR+2U9jLLtZ9OPdHl25y+bZh5ACaHRsvhtMFYzsTRDtWDqFwe3QUGrbfIgRibB980Mles285jvfYZw05rNDBu20avzeoLshQKoIQnX0bP6LMdIUdjhuNOpbPf/9XzzUa9U6Ko80n9Um9ry0YvUZb1DJ4tJB4J6gnh/VCFb71+wWHvJLonNwAQeulDX4VS+FprGhBT8YNT4UUVOVEponbwuChcGP4WKIv0dKn31saFnJcoaTHoUc1arkFVGttbwup1y4BDmnthELnAFXJVUaEXaoG8MxVHLmMFQ7BeUtai6ibVt7yzEPFFV8G9JvA0Fk5SkH1DFanNLs5Les4ndAORdswb0SDwv4iOPElrSQsAp0SJLRYUl2t2hHFJXFEjHlNJqgcUnQeDOkiMgwIvFZSZ7chgAQ9wGh6YwWXhKiGOhK7t1w5agRRly4GvcNa5IlRwdHoyiFF+K1Qt242Gn1SJ3Dd59VHTJ3wePOoeyPW6/XB2/B4l+eV8K/rFD6g0U54bTdb7qXwZZ2G92QopP8nSnqFCkP+DF6LrYxcZ+7weaLTSYnSTC7QU4a4yfn8TWhLj+HzL/+At8itglKvY7ZmtUW5gWV3FXkuRj66re8qYT7ltS/J41lMvnZT1HnwY8n951/+6eAdrmn+iiVFpoxG8zqVIutXc240msELi7sLo7D0yriiQcKVnFKJlgYcTOSWQt2O4VxtwlwfBveQDHQe+HbMCC9fF24XBqk8TIyDPdt4q1GA/w7lCh3JInSQImAuCPD60up6GW8bKtMaZ7Gg+edjnD3JtvM8B9MedyMpjRpbdbDQcYTaALcILkyV8z2W8KU2RlvSop1pC92tN1DlRgvl3Qxyywu/lZ9sEz0jN4e1yMFRdCHv3ZG0YvqQxEpsLe5Px5+oP+x1ut331mKBli4MZm/jYkSbTtddWgJl669Ja8Iz9GrxLMCtsGKKLfeP+3IC9EFbuffFBdqVyLBt+1+o6EkgnrCESZGhcsMefP5q/hZWT8dTlgzwwzcU9+Ttmxcv3128JGXoIY0OOx2fjqd0ZLTzFVeDm/bW2vu97X4LNv/bW/AWzdDuZWIkFwFLtiuEiAOv2QCUzIYL8JuEldp5Irm/p2K8srJp6PjnOjT265uErbgVpGkAi+1cnveA4ItmP/rQrZTh+3bpRw3qMJsiwBZ2OhGl3OJmb6nf3DRJB9xI40jxIup1cklythIO5gBCnpHjPMvQ+Adph8B7fnXJEpa2C/oq7PqZ5WvCVnwdlY37xgBJw9k9k1wta74k2iiyiWuWchen3gac2v4go466YxfARivoL9l0lOH+PmLgpunp46cvcrR+7agpNjdN0/wbecUxQQ==","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 a=i(74848),s=i(28453),o=i(33617),p=i.n(o),l=i(17543),d=i.n(l),r=i(86013),c=i.n(r),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:"eJzFWN1uG7sRfpUpb5oIa0lOnBxUV3Vz0iRokAixjaB1DIG7O6vlMZfkIbmSBWOBc9E36FVv+2h5kmLI3dXqJ07Sc9reGDJ3Zji/nG/mnnm+dGx2zS6xMpJ7dOwmYTm6zArjhVZsxi5LhCuTc4/QUcH5/A2g4qlEBxtdg9dQ6VwUG+AqhzpS+xIhR8+FdKAL4OAMZqIQGfhWzpglTBu0nK56k7MZi6zdPSxhhlteoUdLat4zxStkM9YJWIicJUyQmob7ku3r/uZHupkU6TjAl9yDQswdaZ1iqy3JsfhzLSzmbOZtjQlzfiPpNicqI0kZvDNS58hmBZeOCLISK85m98xvTKD0VqglS1ihbcX99qRpbqJ8dP5POt8Qz66qc6tXIkdIUeo19GaTkp0/uxjBI+5BIncetMIBbWfAY5awTCuPytNF3BgpsuDkyU+Obrs/VF2nP2HmyeOWQuIFOvoaHf51A8k5PLhpxlz40evLmoQp7b9bzJxMRLC4ErgOieXEUoEvhYNcZ3VF5jV7If++K/qsGMpoiEfmaCkjD+VtuYkyVsH7y/mANNVaIlcH2UhZBSfRAB0OYS2kbCsJ3l/OYYWWKiTEagxXDq2LNBYzFCsEvkMCmc4RVoIDVlzIBNalyEpK+A1UtfOAqs2h1nXYe24MIYnhBA4VyoU7qlECXEq9FmoJdVDtmGDIhcXMyw2shS917YHnuSB2LsF5NG489GLQonfkpa7tr/ckh2UtcszB69pCoW3QEq1LwIQyIwuEct7WGTE7yGuKbrCDSOm3sTpD57Z+6rxCRAP5CaBykZ1DwZ1Hm0CtBHne1sZj3ovEO4NWoMrwqAuCcxfhIW0d7r7dF3O0lfCus5RCw/McUCIFxYGrsxJ4/M59bdElIJTwgkuXgPO8Mi4BbcHjHb0r4LWhxxPvhPOk/FrkS/QOxJfy6ANSjWQDHQqrqxB98o3aDBOh18vrPXGXFFTh2vZR8Fp6WHFZH/dZIeTRh2XXR3/VNVR800Y/hjDlDp+fASqqoRzmP/4ZSBgpZNFInkWy3n6tcPiaRPaD98BiTP9FbeXX9bqIHRGjtVcf3sK6RIt9HqKNeZ3SMxgFI/XXUPl0q++ytq++/fQ90JDXXi8sVkLl+C21doE+BInSzOu+xGqvK+5FBp0oN4aWNCaE18OKqeBRF8wUS74S2j4+GtAobqFVhguhFrhCuxloqeoqRXug5LtwTPma842DFP0aUQ1169JKK7mBtiOSbusSFez4hKjc1ugdLZ81TcK88DvdYzGAI4uUunvTNMEUZ7RysZE+mU4Pm34PqFoQQlVKUStqKTe/++26eDz+Wj/jLn/y2s3PXhvKk1alc/8w05Ppk6cnp9OT6Q+Xp89nZ3+YPXs+nk6nf2MJu6vkFkKwvIUCnffi/4MDoaRQuOi8tngynS6etq48O+a9FiB0Rb3iUuRQCJQ50J3uN3QgWqvtfwhgHtDvIfPJ5M74swdSR2kPha5V/v8295hGDxt4tvihN/HZoYlvVHQZTRuX+hbV/8LCrT3D6328nlTdzWoRicJ3tmPs8Dwa6TCrrfCbMMncnXAjTuL32fUNzQcV+lLTFGTqoDBNNDM26V6Xyf3gnWkYybOrbjAK7YaV3hs3m0wcV3mq78baoKKGIHnqxpmuJtyIyep0fMqaZJ+HG/Nd9FiffC+L83wp1PJrfDdbV11QOGPEdhzWx40b8RfcsKSLx5CqnQxL5NTpKAKUJR+2U9jLLtZ9OPdHl25y+bZh5ACaHRsvhtMFYzsTRDtWDqFwe3QUGrbfIgRibB980Mles285jvfYZw05rNDBu20avzeoLshQKoIQnX0bP6LMdIUdjhuNOpbPf/9XzzUa9U6Ko80n9Um9ry0YvUZb1DJ4tJB4J6gnh/VCFb71+wWHvJLonNwAQeulDX4VS+FprGhBT8YNT4UUVOVEponbwuChcGP4WKIv0dKn31saFnJcoaTHoUc1arkFVGttbwup1y4BDmnthELnAFXJVUaEXaoG8MxVHLmMFQ7BeUtai6ibVt7yzEPFFV8G9JvA0Fk5SkH1DFanNLs5Les4ndAORdswb0SDwv4iOPElrSQsAp0SJLRYUl2t2hHFJXFEjHlNJqgcUnQeDOkiMgwIvFZSZ7chgAQ9wGh6YwWXhKiGOhK7t1w5agRRly4GvcNa5IlRwdHoyiFF+K1Qt242Gn1SJ3Dd59VHTJ3wePOoeyPW6/XB2/B4l+eV8K/rFD6g0U54bTdb7qXwZZ2G92QopP8nSnqFCkP+DF6LrYxcZ+7weaLTSYnSTC7QU4a4yfn8TWhLj+HzL/+At8itglKvY7ZmtUW5gWV3FXkuRj66re8qYT7ltS/J41lMvnZT1HnwY8n951/+6eAdrmn+iiVFpoxG8zqVIutXc240msELi7sLo7D0yriiQcKVnFKJlgYcTOSWQt2O4VxtwlwfBveQDHQe+HbMCC9fF24XBqk8TIyDPdt4q1GA/w7lCh3JInSQImAuCPD60up6GW8bKtMaZ7Gg+edjnD3JtvM8B9MedyMpjRpbdbDQcYTaALcILkyV8z2W8KU2RlvSop1pC92tN1DlRgvl3Qxyywu/lZ9sEz0jN4e1yMFRdCHv3ZG0YvqQxEpsLe5Px5+oP+x1ut331mKBli4MZm/jYkSbTtddWgJl669Ja8Iz9GrxLMCtsGKKLfeP+3IC9EFbuffFBdqVyLBt+1+o6EkgnrCESZGhcsMefP5q/hZWT8dTlgzwwzcU9+Ttmxcv3128JGXoIY0OOx2fjqd0ZLTzFVeDm/bW2vu97X4LNv/bW/AWzdDuZWIkFwFLtiuEiAOv2QCUzIYL8JuEldp5Irm/p2K8srJp6PjnOjT265uErbgVpGkAi+1cnveA4ItmP/rQrZTh+3bpRw3qMJsiwBZ2OhGl3OJmb6nf3DRJB9xI40jxIup1cklythIO5gBCnpHjPMvQ+Adph8B7fnXJEpa2C/oq7PqZ5WvCVnwdlY37xgBJw9k9k1wta74k2iiyiWuWchen3gac2v4go466YxfARivoL9l0lOH+PmLgpunp46cvcrR+7agpNjdN0/wbecUxQQ==",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={},I=[];function g(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,a.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,a.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,a.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,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(g,{...e})}):g(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/62b755e6.2a78d705.js b/assets/js/62b755e6.4db3ade4.js similarity index 91% rename from assets/js/62b755e6.2a78d705.js rename to assets/js/62b755e6.4db3ade4.js index 2c6d6d3b9..455b620e2 100644 --- a/assets/js/62b755e6.2a78d705.js +++ b/assets/js/62b755e6.4db3ade4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9350],{30456:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>j,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>y});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+ZUeT27fzczRLkTTjontu9MgTj1jEpEhQWexVDMcnZ69heTgcs6j3PD7ico9en7589eb8FRlDiTQEbH+4Pxz7Plxbl3PV03SC3TA/fAPwVX6Y0t9+6W66yuqv7wl/fU9ovyfUdRYNH0aF5MJXuXUHHCrUj+zWJ4Zp8zXhMmKZto5Ibm4IIu+NrCpaDkNwKlzrzq8bg1/huje0X3JZ1g30vbT1dL0jvaQfRhDtdh33Iv/pu/rknsFjPndsDU5Tmap136jG2CY21SUNmUJpSjaG3eMkwaLv950eZ6NROHl1wXyfnm2WxFe+JK7/IOlbbdqslYMB9C+FeivDzU0ot6uqpQ9b93LUDjbUFKDLqqr+D+IB/0s=","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),l=n(33617),a=n.n(l),o=n(17543),p=n.n(o),m=n(86013),d=n.n(m),c=n(63723),u=n.n(c),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+ZUeT27fzczRLkTTjontu9MgTj1jEpEhQWexVDMcnZ69heTgcs6j3PD7ico9en7589eb8FRlDiTQEbH+4Pxz7Plxbl3PV03SC3TA/fAPwVX6Y0t9+6W66yuqv7wl/fU9ovyfUdRYNH0aF5MJXuXUHHCrUj+zWJ4Zp8zXhMmKZto5Ibm4IIu+NrCpaDkNwKlzrzq8bg1/huje0X3JZ1g30vbT1dL0jvaQfRhDtdh33Iv/pu/rknsFjPndsDU5Tmap136jG2CY21SUNmUJpSjaG3eMkwaLv950eZ6NROHl1wXyfnm2WxFe+JK7/IOlbbdqslYMB9C+FeivDzU0ot6uqpQ9b93LUDjbUFKDLqqr+D+IB/0s=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,b={},y=[{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)(a(),{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 +"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.320fba40.js b/assets/js/6d2e526e.9f2d8c5b.js similarity index 83% rename from assets/js/6d2e526e.320fba40.js rename to assets/js/6d2e526e.9f2d8c5b.js index 78fe053e0..9a1fb7970 100644 --- a/assets/js/6d2e526e.320fba40.js +++ b/assets/js/6d2e526e.9f2d8c5b.js @@ -1 +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:()=>B,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/ev395WsyhgppBOx4fjxfEomGi4aryU39QvrtbmPcw3qyVP2f9te+lXt88AsjuQiTVPB52w9BN2yyz6bT1fU2YTWNS+kN227pDf5gZdcR+acWLc1atwlbcSt4Rq38ZssK4eh3Me6hn/T2i/f9SvsC/vAW/KQvw6yiaFBZcdmG/TFh97g52MS72y4ZBhYyNnK8iiYdXZGenYZHAzBNXFHiLM/R+Gd5pxPnxbvLK5awrN+im7CmM8vXtNfzdbRWB4jifky0LZNcVS2viDfqpBmLivj+gHYfBrT+B3n1JB77k1t0g/6SU08KbLdx+Ou6kT8efVKiB3bgpuDcdl33XzM5PJY=","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),i=o(28453),s=o(33617),d=o.n(s),r=o(17543),a=o.n(r),l=o(86013),u=o.n(l),m=o(63723),p=o.n(m),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/ev395WsyhgppBOx4fjxfEomGi4aryU39QvrtbmPcw3qyVP2f9te+lXt88AsjuQiTVPB52w9BN2yyz6bT1fU2YTWNS+kN227pDf5gZdcR+acWLc1atwlbcSt4Rq38ZssK4eh3Me6hn/T2i/f9SvsC/vAW/KQvw6yiaFBZcdmG/TFh97g52MS72y4ZBhYyNnK8iiYdXZGenYZHAzBNXFHiLM/R+Gd5pxPnxbvLK5awrN+im7CmM8vXtNfzdbRWB4jifky0LZNcVS2viDfqpBmLivj+gHYfBrT+B3n1JB77k1t0g/6SU08KbLdx+Ou6kT8efVKiB3bgpuDcdl33XzM5PJY=",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,i.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)(d(),{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)(a(),{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)(u(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,c.jsx)(p(),{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 B(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file +"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.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/7357a3c5.65cb2696.js b/assets/js/7357a3c5.65cb2696.js deleted file mode 100644 index f070dca9a..000000000 --- a/assets/js/7357a3c5.65cb2696.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:()=>k,contentTitle:()=>x,default:()=>Q,frontMatter:()=>f,metadata:()=>i,toc:()=>K});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":"eJy9V81uI7kRfpUKL9kR2pLs9WwSnWIsJl5nBzPG2gsD8QgGu7vUzTGb5JLVkgWhgT3kDXLKNY82TxIU+0ct2zOJk8VcbDXJKn5V9dUPd4JkEcTiVvzF6hy9WCYix5B55UhZIxbiukQ4R4J2H84uL0BqbTcBtrYGsuCRvMI1Qo4klQ4gU1sTSAgOM7VSGayi6FQkwjr0khVf5GIhCqR2SyTCSS8rJPQMZieMrFAsRLt9p3KRCMVonKRSPIZo04+Y0UUOdgWDQo+/1MpjLhbka0xEoK1mlUFVTqNIBD44bXMUi5XUgQ9kJVZSLHaCti6eJK9MIRKxsr6SNF7BBxm1LIT74Tgts5PSpaJplnxtcNYEDKzoZD7nf4doQ51lGMKq1jC4QyQis4bQEJ+XzmmVxY3Zx8BCu6foWqPZc57VkGqv7H3xYjvK47R8OPnoRJN0bn8XY/AyNQY3fQiaGFQ01DLn5ZD+emJkeH2vLvGxrv8VWajTEbrMoyTMz+g5VXvBk/nJt0fH86P5H66Pv1uc/mnx+rvpfD7/m0jEQ6VZtiNrLikiJUV6/F27/CvcM1rossZjEE3DG6fP8fDKVkilMgVs0BBsvDVFAk6jDAjktyALqQxoSeh/99sRFL23/sueeBmyseXKaGXwrk/Cu9P5/O54cMLpUye0rgJjCVa2Nvn0Kxj6JZY+xfNl807v/jiY9/qpeRdmLbXKY9W+tvdovm4gx9dTez1DPaSzag/FfXFg7Hi9NTJgVntF29gjHo6kU0ft/uJ2ydWXeWO71hKbCpViIWatV2e7oZ00gnX5dd9uaq/FQpRELixmsyBNntqHqXVogiqMlmmYZraaSadm6+PpsWiSxzLSuRedx/ropSKBZKFM8Z/klns3XXEo22gdOGuImXTqR9yKpI/F+FTXcUuUsV42/L2yUbiL0HuH5koVJsY3Xv64M9+gzmyFPCZQiTCZ9CKf/v6vQWoygdxmdYWGIhOnH8wH87724OwGPfdJaXJYaXxQqcYohlXcG2aQgLLSGILegjKEhZeEkKtCkdTAfuJikkknU6UVE5iPWZb2MMqBMIWbEqlEz1u/9wgSclyjZt6DrMlWklhVjxc21t+veBpKQEJaB2UwBEBTSpPxwT4SCVgP0gAaQu+8CgiBPKNWLTZryMuMoJJGFsi6Exg7K0etmK7gbVoHgmB1HSEDD13WYw69QQYxD9GJb3jE8Qi8mtnKeSyZNmuEolY5hgQymyOEmK9sgskhxUDgGIvKMLDS2mib3ccArmqtwVkuH0pqnrfGGFmcvDSBK1yLpY/B4DDnLU8/2AKcTH4OyBF+q8x9WEwmH8wR3A68usE0KMLlN30KbDabJ9R/dShzruiHOoWf0NmgyPrtXrpQVNZpTJexkuGj1XSOBiN/Rsmw15HbLDzNPl6dlajd7AqJGRJmZ5cXseK+gk+//gPeovQGSrtp2ZrVHvUWiv4q9lwb+dZtQ8GElY3EK9njWUs+nmwxUO/Bm1LSp1//GeAdbkCZLqXYlMnksk61yuAaK8fdMkwmC/g+jj1A/RpQKQkyaSBFCKVkKq2VBAmuldbK3E/hzGyhDuhho6iMZOD1KHdgBvtlCHeAVAbMwZoo0d853SPi9SqgXmNgXdz4UgTMFTGjS2/ror1tDKYzzuNKaQ03Ki+Qom1neQ6uW960y+zwERxccUJQiVuQHiGgoSlcPhKJO7Vz1jMK1YJfWX72cADQ5M4qQ2EBuZcr2utP9kSP06Wy5pml1oVycEfSqRlC0mZiZ/GwOv3ARflRIT+stx5X6PnCaPY+Lk51dLrtaQnM1v+H1nGCtoZkFicJrKTSbUf582M9saujr8L71RX6tcqw62qfyehZPDwTidAqQxNwNC2cnV++hfW307lIRu3xv0ju2duL79+8u3rDYLiQtg47nh5P5/F5YQNV0oxu2j96H7e13X6E+m2fx11XJnygmdNSxXkoWrnrZplbMTxwF/vH8TIRpQ3E27sdZ9zPXjcNL/9So+dpaZmItfRKpty4b3ciV4F/58Pr97MGfvNT95B+Bc++s5/F3I8XhmeLtdQ1f4lE3OP24FXfLJuknzAYVrt/lmXoaCT5ZEw9mPXO31yLRHCRPJxs7uNk0/1g7c+iOhx5WgD8l+evZwV2u3ZqaprhfLv1WYnOwP40u2jZNM2/Aej1Gkg=","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),n=o(28453),s=o(33617),a=o.n(s),d=o(17543),l=o.n(d),p=o(86013),c=o.n(p),m=o(63723),g=o.n(m),u=(o(18766),o(79329),o(9303));const f={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:"eJy9V81uI7kRfpUKL9kR2pLs9WwSnWIsJl5nBzPG2gsD8QgGu7vUzTGb5JLVkgWhgT3kDXLKNY82TxIU+0ct2zOJk8VcbDXJKn5V9dUPd4JkEcTiVvzF6hy9WCYix5B55UhZIxbiukQ4R4J2H84uL0BqbTcBtrYGsuCRvMI1Qo4klQ4gU1sTSAgOM7VSGayi6FQkwjr0khVf5GIhCqR2SyTCSS8rJPQMZieMrFAsRLt9p3KRCMVonKRSPIZo04+Y0UUOdgWDQo+/1MpjLhbka0xEoK1mlUFVTqNIBD44bXMUi5XUgQ9kJVZSLHaCti6eJK9MIRKxsr6SNF7BBxm1LIT74Tgts5PSpaJplnxtcNYEDKzoZD7nf4doQ51lGMKq1jC4QyQis4bQEJ+XzmmVxY3Zx8BCu6foWqPZc57VkGqv7H3xYjvK47R8OPnoRJN0bn8XY/AyNQY3fQiaGFQ01DLn5ZD+emJkeH2vLvGxrv8VWajTEbrMoyTMz+g5VXvBk/nJt0fH86P5H66Pv1uc/mnx+rvpfD7/m0jEQ6VZtiNrLikiJUV6/F27/CvcM1rossZjEE3DG6fP8fDKVkilMgVs0BBsvDVFAk6jDAjktyALqQxoSeh/99sRFL23/sueeBmyseXKaGXwrk/Cu9P5/O54cMLpUye0rgJjCVa2Nvn0Kxj6JZY+xfNl807v/jiY9/qpeRdmLbXKY9W+tvdovm4gx9dTez1DPaSzag/FfXFg7Hi9NTJgVntF29gjHo6kU0ft/uJ2ydWXeWO71hKbCpViIWatV2e7oZ00gnX5dd9uaq/FQpRELixmsyBNntqHqXVogiqMlmmYZraaSadm6+PpsWiSxzLSuRedx/ropSKBZKFM8Z/klns3XXEo22gdOGuImXTqR9yKpI/F+FTXcUuUsV42/L2yUbiL0HuH5koVJsY3Xv64M9+gzmyFPCZQiTCZ9CKf/v6vQWoygdxmdYWGIhOnH8wH87724OwGPfdJaXJYaXxQqcYohlXcG2aQgLLSGILegjKEhZeEkKtCkdTAfuJikkknU6UVE5iPWZb2MMqBMIWbEqlEz1u/9wgSclyjZt6DrMlWklhVjxc21t+veBpKQEJaB2UwBEBTSpPxwT4SCVgP0gAaQu+8CgiBPKNWLTZryMuMoJJGFsi6Exg7K0etmK7gbVoHgmB1HSEDD13WYw69QQYxD9GJb3jE8Qi8mtnKeSyZNmuEolY5hgQymyOEmK9sgskhxUDgGIvKMLDS2mib3ccArmqtwVkuH0pqnrfGGFmcvDSBK1yLpY/B4DDnLU8/2AKcTH4OyBF+q8x9WEwmH8wR3A68usE0KMLlN30KbDabJ9R/dShzruiHOoWf0NmgyPrtXrpQVNZpTJexkuGj1XSOBiN/Rsmw15HbLDzNPl6dlajd7AqJGRJmZ5cXseK+gk+//gPeovQGSrtp2ZrVHvUWiv4q9lwb+dZtQ8GElY3EK9njWUs+nmwxUO/Bm1LSp1//GeAdbkCZLqXYlMnksk61yuAaK8fdMkwmC/g+jj1A/RpQKQkyaSBFCKVkKq2VBAmuldbK3E/hzGyhDuhho6iMZOD1KHdgBvtlCHeAVAbMwZoo0d853SPi9SqgXmNgXdz4UgTMFTGjS2/ror1tDKYzzuNKaQ03Ki+Qom1neQ6uW960y+zwERxccUJQiVuQHiGgoSlcPhKJO7Vz1jMK1YJfWX72cADQ5M4qQ2EBuZcr2utP9kSP06Wy5pml1oVycEfSqRlC0mZiZ/GwOv3ARflRIT+stx5X6PnCaPY+Lk51dLrtaQnM1v+H1nGCtoZkFicJrKTSbUf582M9saujr8L71RX6tcqw62qfyehZPDwTidAqQxNwNC2cnV++hfW307lIRu3xv0ju2duL79+8u3rDYLiQtg47nh5P5/F5YQNV0oxu2j96H7e13X6E+m2fx11XJnygmdNSxXkoWrnrZplbMTxwF/vH8TIRpQ3E27sdZ9zPXjcNL/9So+dpaZmItfRKpty4b3ciV4F/58Pr97MGfvNT95B+Bc++s5/F3I8XhmeLtdQ1f4lE3OP24FXfLJuknzAYVrt/lmXoaCT5ZEw9mPXO31yLRHCRPJxs7uNk0/1g7c+iOhx5WgD8l+evZwV2u3ZqaprhfLv1WYnOwP40u2jZNM2/Aej1Gkg=",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,k={},K=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(u.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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{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)(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:"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 Q(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(v,{...e})}):v(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.171e57a2.js b/assets/js/7ad5624c.171e57a2.js deleted file mode 100644 index 811492b8f..000000000 --- a/assets/js/7ad5624c.171e57a2.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:()=>v,contentTitle:()=>V,default:()=>P,frontMatter:()=>h,metadata:()=>o,toc:()=>y});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":"eJy9V91uG7cSfpUpb9oIa/04boruVY0gcI0TNEbtwEAdweDujnYZc0mWnJUsCAJ60TfoVW/Po+VJDoa7K61sp+e4pwhgyNJwZjj/83EjSJZBpDfitTUkcwpinogCQ+6VI2WNSMVVhXCGBB0HnF6cg9TargKsbQNkwSN5hUuEAkkqHUBmtiGQEBzmaqFyyFvZsUiEdeglqz4vRCpKpO5MJMJJL2sk9GzRRhhZo0hFd36rCpEIxRY5SZV4aKbNPmJO5wXYBexVevy1UR4LkZJvMBGB1pqVBlU7jSIReO+0LVCkC6kDM+QV1lKkG0FrFznJK1OKRCysryUNKXgvo5ZUuB9nWZUfVy4T2+2crw3OmoCBFR1Pp/zv0NzQ5DmGsGg07CIikugsGmJ+6ZxWeTyYfAwstHlsXes1x86zGlLtlX0wnu1HNcuq++OPTmyTLv7PU/DRImSILI61VPpvyGeIP3SEcW5rVuUqa55tysns5ew4/rGK3KMkLE7pKTV7oePp8cuj2fRo+t3V7FV68n367avxdDr9RSTivo7edFVZSIpekiI9/N244gvcs33I1lV814BDgb4XtluWOnmqFi9tjVQpU8IKDcHKW1Mm4DTKgEB+DbKUyoCWhP6rf65I0Xvr/zpMz7NsO3BbGa0M3vaNeHsynd7OdkE4eRyEfrwZS7CwjSm+rKdPXP/X7pzcHu/c+faxO+dmKbUq4rS+sndovqw7w+upvf5x0aqWKZ6LA2eH9NbJgHnjFa3jZrg/kk4dtefpzZwnLteJ7TZKXCVUiVRMuuqfbPZbZCtYm1/2a6bxWqSiInIhnUyCNEVm78fWoQmqNFpmgcfQRDo1Wc7GPEweykjnnsWPzdFzRQLJUpnyv8nN94G65GS2+ToI1y5r0ql/4Vr0c/6Aq1u0FcoCfcycMgsbhbscvXNoLlVpYobj5Q8X8jXq3NbIAIEqhNGoF/n0+793UqMRFDZvajQUa3H8wXww7xoPzq7Q83aUpoCFxnuVaYxiWMezHfoIKGuNIeg1KENYekkIhSoVSQ0cJx4fuXQyU1pxCTObZWkPgy4IY7iukCr0fPS1R5BQ4BI1Vz7IhmwtiVX19sLK+rsF46AEJGRNUAZDADSVNDkz9plIwHqQBtAQeudVQAjk2WrV2mYNee79WhpZIutOYBisArXicgVvsyYQBKubaDLwtLceC+gdMohFiEF8w8DGIzA1t7XzWHHZLBHKRhUYEshtgRBix7ILpoAMA4FjW1SOgZU2Rtv8LiZw0WgNzvIAUVIzzBrayOLkpQm8kltb+hzsAua8ZcyDrYGj0fuAnOG3ytyFdDT6YI7gZldX15gFRTj/pm+B1Wr1qPRfHMqcKfqxyeBndDYosn69ly4VVU0W22WoZPej1XSGBmP9DJphr6OweXjcfUydVKjd5BKJKyRMTi/O48x9AZ9++wPeovQGKrtqqzVvPOo1lP1VHLk2823YdiMTFjYWXsURz9viYzyLgfoIXleSPv32Z4CfcAXKdC3FroxGF02mVQ5XWDvej2E0SuF1REFAPQ2okgS5NJAhhEpyKS2VBAmuldbK3I3h1KyhCehhpaiKxcD0KHfgBsdll+4AmQxYgDVRor9zvLeI6XVAvcTAunj1ZQhYKOKKrrxtyva2oTGdcx4XSmu4VkWJFH07LQpwHXnVkjngA3NwwQ1BFa5BeoSAhsZw8UAknjTOWc9WqNb4heUHDycATeGsMhRSKLxc0F5/si/0CDaVNU+Q2hDKXTiSTs0uJW0ndh7vqOMPPJQfDPLDeetxgZ4vjG7v8+JUV043fVkCV+v/U9YRUHe4kvFAi/R5o/zwUE/c6+jr8G5xiX6pcuy22mc6ehKZJyIRWuVoAg7wwunZxVtYvhxPRTJYj/9Dc0/enr9+89PlGzaGB2kbsNl4Np7G54UNVEszuGnw3n241zZ7FPVPP427xUx4TxOnpYqgKDq66QDNjdg/bdPBw3ieiMoGYobNhtvuvdfbLZN/bdAzaJonYim9khlv75uNKFTg78Xu4ftZJ7/5uXtDv4Cn39hPmt2DDMMIYyl1w79EIu5wffim3863SQ802LCW4TTP0dFA9BFePQB9Z2+uRCJ4Vh4CnLsIcLovrP1Jsw6RT2sAfzIMe1Jgs2nB03a742+PPivROdhzc4zm2+32P/mPGkg=","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),c=n(33617),i=n.n(c),r=n(17543),p=n.n(r),d=n(86013),l=n.n(d),u=n(63723),m=n.n(u),g=(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:"eJy9V91uG7cSfpUpb9oIa/04boruVY0gcI0TNEbtwEAdweDujnYZc0mWnJUsCAJ60TfoVW/Po+VJDoa7K61sp+e4pwhgyNJwZjj/83EjSJZBpDfitTUkcwpinogCQ+6VI2WNSMVVhXCGBB0HnF6cg9TargKsbQNkwSN5hUuEAkkqHUBmtiGQEBzmaqFyyFvZsUiEdeglqz4vRCpKpO5MJMJJL2sk9GzRRhhZo0hFd36rCpEIxRY5SZV4aKbNPmJO5wXYBexVevy1UR4LkZJvMBGB1pqVBlU7jSIReO+0LVCkC6kDM+QV1lKkG0FrFznJK1OKRCysryUNKXgvo5ZUuB9nWZUfVy4T2+2crw3OmoCBFR1Pp/zv0NzQ5DmGsGg07CIikugsGmJ+6ZxWeTyYfAwstHlsXes1x86zGlLtlX0wnu1HNcuq++OPTmyTLv7PU/DRImSILI61VPpvyGeIP3SEcW5rVuUqa55tysns5ew4/rGK3KMkLE7pKTV7oePp8cuj2fRo+t3V7FV68n367avxdDr9RSTivo7edFVZSIpekiI9/N244gvcs33I1lV814BDgb4XtluWOnmqFi9tjVQpU8IKDcHKW1Mm4DTKgEB+DbKUyoCWhP6rf65I0Xvr/zpMz7NsO3BbGa0M3vaNeHsynd7OdkE4eRyEfrwZS7CwjSm+rKdPXP/X7pzcHu/c+faxO+dmKbUq4rS+sndovqw7w+upvf5x0aqWKZ6LA2eH9NbJgHnjFa3jZrg/kk4dtefpzZwnLteJ7TZKXCVUiVRMuuqfbPZbZCtYm1/2a6bxWqSiInIhnUyCNEVm78fWoQmqNFpmgcfQRDo1Wc7GPEweykjnnsWPzdFzRQLJUpnyv8nN94G65GS2+ToI1y5r0ql/4Vr0c/6Aq1u0FcoCfcycMgsbhbscvXNoLlVpYobj5Q8X8jXq3NbIAIEqhNGoF/n0+793UqMRFDZvajQUa3H8wXww7xoPzq7Q83aUpoCFxnuVaYxiWMezHfoIKGuNIeg1KENYekkIhSoVSQ0cJx4fuXQyU1pxCTObZWkPgy4IY7iukCr0fPS1R5BQ4BI1Vz7IhmwtiVX19sLK+rsF46AEJGRNUAZDADSVNDkz9plIwHqQBtAQeudVQAjk2WrV2mYNee79WhpZIutOYBisArXicgVvsyYQBKubaDLwtLceC+gdMohFiEF8w8DGIzA1t7XzWHHZLBHKRhUYEshtgRBix7ILpoAMA4FjW1SOgZU2Rtv8LiZw0WgNzvIAUVIzzBrayOLkpQm8kltb+hzsAua8ZcyDrYGj0fuAnOG3ytyFdDT6YI7gZldX15gFRTj/pm+B1Wr1qPRfHMqcKfqxyeBndDYosn69ly4VVU0W22WoZPej1XSGBmP9DJphr6OweXjcfUydVKjd5BKJKyRMTi/O48x9AZ9++wPeovQGKrtqqzVvPOo1lP1VHLk2823YdiMTFjYWXsURz9viYzyLgfoIXleSPv32Z4CfcAXKdC3FroxGF02mVQ5XWDvej2E0SuF1REFAPQ2okgS5NJAhhEpyKS2VBAmuldbK3I3h1KyhCehhpaiKxcD0KHfgBsdll+4AmQxYgDVRor9zvLeI6XVAvcTAunj1ZQhYKOKKrrxtyva2oTGdcx4XSmu4VkWJFH07LQpwHXnVkjngA3NwwQ1BFa5BeoSAhsZw8UAknjTOWc9WqNb4heUHDycATeGsMhRSKLxc0F5/si/0CDaVNU+Q2hDKXTiSTs0uJW0ndh7vqOMPPJQfDPLDeetxgZ4vjG7v8+JUV043fVkCV+v/U9YRUHe4kvFAi/R5o/zwUE/c6+jr8G5xiX6pcuy22mc6ehKZJyIRWuVoAg7wwunZxVtYvhxPRTJYj/9Dc0/enr9+89PlGzaGB2kbsNl4Np7G54UNVEszuGnw3n241zZ7FPVPP427xUx4TxOnpYqgKDq66QDNjdg/bdPBw3ieiMoGYobNhtvuvdfbLZN/bdAzaJonYim9khlv75uNKFTg78Xu4ftZJ7/5uXtDv4Cn39hPmt2DDMMIYyl1w79EIu5wffim3863SQ802LCW4TTP0dFA9BFePQB9Z2+uRCJ4Vh4CnLsIcLovrP1Jsw6RT2sAfzIMe1Jgs2nB03a742+PPivROdhzc4zm2+32P/mPGkg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},V=void 0,v={},y=[];function I(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,a.jsx)(i(),{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)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.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,a.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,a.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:"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"},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 P(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(I,{...e})}):I(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/7ef59f7a.93721c1a.js b/assets/js/7ef59f7a.93721c1a.js deleted file mode 100644 index fd5bb8583..000000000 --- a/assets/js/7ef59f7a.93721c1a.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:()=>h,contentTitle:()=>g,default:()=>F,frontMatter:()=>b,metadata:()=>a,toc:()=>y});const a=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":"eJy9GctuGznyV2p52YnQ1sN2klmdxpjNejwbTIyxgwDrGAK7u7qbMZvkkGzJgiBgDvsHe9rrflq+ZFHsh1qyYkeZTC62RNb7xarSinmeOza9YX/XSVWi8o7dRixFl1hhvNCKTdl1gXCOHloQOLu8AFQ8luhgqSvwGix6K3COkKLnQjrgsa48cHAGE5GJBNIGe8gipg1aTtQvUjZlOfr2kkXMcMtL9GhJrBVTvEQ2ZS3ATKQsYoLEMtwXbFdWHX/AxF+koLNOXhYxi79VwmLKpt5WGDHnl5LIOlEaiSxieG+kTpFNMy4dASQFlpxNV8wvTYD0VqicRSzTtuS+f4L3PFCZMvPTJC6S48LEbL2+JbbOaOXQEaHj8Zj+bcvrqiRB57JKQmcUFrFEK0+ST1eMGyNFEi5GHxwhrR5KV6tN1rNExouapfPcV+5QLYQ6MlbnFp1j66gz6aFk/nEu7o5P4uLtz0QlE3R4GIXCe+Omo1FzUlk5THRJ1BLSMSOzfDHRHokeYS/84XK68IEinEgofbhQRiJ3CE7kqkuUYDUtU7RPO/rr+KjOtcMo1BJCQF1vDLhJ2EYFCqSF2tLls+h/0AgxIuGTdUJZ6Chwa/mS6oHH0j1tJav3+3bDLUH9mCH2ioUlF/JJ6Bjxh+agjTVTaPUEm9PnL44nJ9+/nBD8QqQ5+j+gf317mP093vtY3wd5ed5HV1UZo+2jdycd+mQdsfsDcY5PT9cRWx6I9ZJYLQ5EOvl+HbHiQKTTFxTLoYB/hs2/JKc6m6/7GeWxNJJ7nF3VeTBr4+FRqJCUDlV6od7Y7VoSay2Rqz5reh2pvFrkHtMz/3h0Ho+PT44m46Pxy+vJi+np36bPXwzH4/G/WMTuS7nRnqVUp/vFoflemfSb8KmblWtdfZ76FlNhMfGzyu5N7Md8R+y4lHoxK3Vavy87gbKHb2g6CLFKhZ95u11QDszyL65Hc4EL3PuEfEVXhCL+5zLZ8wothC/qZmjWt3EAbRNGPCFVDxCEA63kEvicC0mxBYsCFfgCu+ebYJo8gszqEji0FIYhSCqvZxZLoZ7MyjY8auiZVgnOhJrhHO3eMtkhjknBHZM9sAh71F5NETrd17xe6RJ9IVQOC1J4YbXKI2h6GW+XwHMuFJDK9i9fr6tFa/XePmLjq8Mk60eMUFIonLWd++x0PJ5NOiOcPjRCNxUp7SHTlUq/rar7+D+u0OnspFPo+UOFLtScS5GGKe9a36H6tvr02fua/cMoFjVQuGdbyvbPayUdJpUVfhnGyfsjbsRRfT+9uaUhjSJFN3NomD99waZs1KbCaNWbPdeM6Nl5O52GB6IbKRxXaazvh9qgojoneeyouI64EaP5ZEhd3C4ON+YgeKyODkVxnudC5U/h3W5MdUXurD22ZbDNk2TEP5HepMYffahmPC+Qh75/Td8zHZAbL70xqKg9CT4OzHfH+HcoE10ibRaopg4GLcrHf/+vwxoMumIbonH4Xr1XbyoLRi/Q0kjNVQqZxHtBFTpsLcpw160tHPJSonNyCUJ5zC33CKnIhecyTGNUQhJueCykoCAmME3YFnp54IbwrkBfoKWrv1oEDinOUVLsA1X6knsi1T0OC23vMqkXLgIOceWEQucAVcFVQoCtJyLQFrgCVB6tsYKGRG9JalHLppW3PPFQcsVzJNoR9I2VohQUrmB1XDkPTssqiAy0p9EWU2gVUoipC0Z8RdsQi0CniS6NxYLCZo6QVyJFF0GiU4R67iUVVAoxOg+GZBEJOiJaKamTu+DArJISjKYSIrik5UxfRkL3litHjVUtS+uDzmDGalqUYC3gYPDWIXn4tVB3bjoYvFdHcNPF1TuMnfB4+12bAovF4kHoP9vGORf+pyqGX9FoJ7y2yw12LnxRxSFd+kS6LzWlc1QY4qeXDBsaqU7cw+yj01GB0oyu0FOEuNHZ5UWous/g4+//gdfIrYJCL+poTSqLcgl5y4osV3u+NltXNCHTIfAKsnhSBx8twdD51oLvCu4//v5fB7/gAoRqUopUGQwuq1iKBK6bhsUNBlP4MTQzXRPjwBfcQ8IVxAiu4BRKc8GBg6mxpVB3QzhTS6gcWqCeIgQDnQe8LTW2dh8OYu4wBV33VF3jtJGIzkuHco6OaNHjFyNgKqjf8oXVVV5z6wvTKGcxE1LCu3p+It3O0hRMc9yMVWTwnjiYUUL4ApfALYKjTSZc7qCEm8oYbUkKUQufaRoHyAGoUqOF8m4KqeWZ39CPNoEeekah1Z6j2oSbPjJqyHQuqTOx0bg7Hb6norxTyLfrrcUMLTEMam/8YkQTTjdtWAJF6x8J67C+08rzxPemFXpRftilE152tKV7k12hnYuk3d99IqNHAXjEIiZFgsphr2M4O798DfOT4ZhFvefxM5J79Prix1e/XL0KExJaVxtsMpwMx2Epop0vuepx6q/Kdx+21aaR+hPW6s3jTOuDkZFchNaomWHrtuaG9Tbt0/5S/TZihXaeQFYrSr63Vq7XdPxbFcaMm9uIzbkVJF/ofVLh6HPa7cw/qel3vzbr92fwif38XsnbXkNRozHnsgrzdcTucLnzi8D6lvY4dcNBotUQZ0mCxvdwH3SuW+3f+atrFsayYrvRuQuNTvOBqO+Va7sDqgWgv9SO7UVYreomar3u4OurT2I0CrbQZKTb9Xr9f9+R7BA=","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 n=o(74848),i=o(28453),r=o(33617),s=o.n(r),p=o(17543),m=o.n(p),c=o(86013),l=o.n(c),d=o(63723),u=o.n(d),x=(o(18766),o(79329),o(9303));const b={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:"eJy9GctuGznyV2p52YnQ1sN2klmdxpjNejwbTIyxgwDrGAK7u7qbMZvkkGzJgiBgDvsHe9rrflq+ZFHsh1qyYkeZTC62RNb7xarSinmeOza9YX/XSVWi8o7dRixFl1hhvNCKTdl1gXCOHloQOLu8AFQ8luhgqSvwGix6K3COkKLnQjrgsa48cHAGE5GJBNIGe8gipg1aTtQvUjZlOfr2kkXMcMtL9GhJrBVTvEQ2ZS3ATKQsYoLEMtwXbFdWHX/AxF+koLNOXhYxi79VwmLKpt5WGDHnl5LIOlEaiSxieG+kTpFNMy4dASQFlpxNV8wvTYD0VqicRSzTtuS+f4L3PFCZMvPTJC6S48LEbL2+JbbOaOXQEaHj8Zj+bcvrqiRB57JKQmcUFrFEK0+ST1eMGyNFEi5GHxwhrR5KV6tN1rNExouapfPcV+5QLYQ6MlbnFp1j66gz6aFk/nEu7o5P4uLtz0QlE3R4GIXCe+Omo1FzUlk5THRJ1BLSMSOzfDHRHokeYS/84XK68IEinEgofbhQRiJ3CE7kqkuUYDUtU7RPO/rr+KjOtcMo1BJCQF1vDLhJ2EYFCqSF2tLls+h/0AgxIuGTdUJZ6Chwa/mS6oHH0j1tJav3+3bDLUH9mCH2ioUlF/JJ6Bjxh+agjTVTaPUEm9PnL44nJ9+/nBD8QqQ5+j+gf317mP093vtY3wd5ed5HV1UZo+2jdycd+mQdsfsDcY5PT9cRWx6I9ZJYLQ5EOvl+HbHiQKTTFxTLoYB/hs2/JKc6m6/7GeWxNJJ7nF3VeTBr4+FRqJCUDlV6od7Y7VoSay2Rqz5reh2pvFrkHtMz/3h0Ho+PT44m46Pxy+vJi+np36bPXwzH4/G/WMTuS7nRnqVUp/vFoflemfSb8KmblWtdfZ76FlNhMfGzyu5N7Md8R+y4lHoxK3Vavy87gbKHb2g6CLFKhZ95u11QDszyL65Hc4EL3PuEfEVXhCL+5zLZ8wothC/qZmjWt3EAbRNGPCFVDxCEA63kEvicC0mxBYsCFfgCu+ebYJo8gszqEji0FIYhSCqvZxZLoZ7MyjY8auiZVgnOhJrhHO3eMtkhjknBHZM9sAh71F5NETrd17xe6RJ9IVQOC1J4YbXKI2h6GW+XwHMuFJDK9i9fr6tFa/XePmLjq8Mk60eMUFIonLWd++x0PJ5NOiOcPjRCNxUp7SHTlUq/rar7+D+u0OnspFPo+UOFLtScS5GGKe9a36H6tvr02fua/cMoFjVQuGdbyvbPayUdJpUVfhnGyfsjbsRRfT+9uaUhjSJFN3NomD99waZs1KbCaNWbPdeM6Nl5O52GB6IbKRxXaazvh9qgojoneeyouI64EaP5ZEhd3C4ON+YgeKyODkVxnudC5U/h3W5MdUXurD22ZbDNk2TEP5HepMYffahmPC+Qh75/Td8zHZAbL70xqKg9CT4OzHfH+HcoE10ibRaopg4GLcrHf/+vwxoMumIbonH4Xr1XbyoLRi/Q0kjNVQqZxHtBFTpsLcpw160tHPJSonNyCUJ5zC33CKnIhecyTGNUQhJueCykoCAmME3YFnp54IbwrkBfoKWrv1oEDinOUVLsA1X6knsi1T0OC23vMqkXLgIOceWEQucAVcFVQoCtJyLQFrgCVB6tsYKGRG9JalHLppW3PPFQcsVzJNoR9I2VohQUrmB1XDkPTssqiAy0p9EWU2gVUoipC0Z8RdsQi0CniS6NxYLCZo6QVyJFF0GiU4R67iUVVAoxOg+GZBEJOiJaKamTu+DArJISjKYSIrik5UxfRkL3litHjVUtS+uDzmDGalqUYC3gYPDWIXn4tVB3bjoYvFdHcNPF1TuMnfB4+12bAovF4kHoP9vGORf+pyqGX9FoJ7y2yw12LnxRxSFd+kS6LzWlc1QY4qeXDBsaqU7cw+yj01GB0oyu0FOEuNHZ5UWous/g4+//gdfIrYJCL+poTSqLcgl5y4osV3u+NltXNCHTIfAKsnhSBx8twdD51oLvCu4//v5fB7/gAoRqUopUGQwuq1iKBK6bhsUNBlP4MTQzXRPjwBfcQ8IVxAiu4BRKc8GBg6mxpVB3QzhTS6gcWqCeIgQDnQe8LTW2dh8OYu4wBV33VF3jtJGIzkuHco6OaNHjFyNgKqjf8oXVVV5z6wvTKGcxE1LCu3p+It3O0hRMc9yMVWTwnjiYUUL4ApfALYKjTSZc7qCEm8oYbUkKUQufaRoHyAGoUqOF8m4KqeWZ39CPNoEeekah1Z6j2oSbPjJqyHQuqTOx0bg7Hb6norxTyLfrrcUMLTEMam/8YkQTTjdtWAJF6x8J67C+08rzxPemFXpRftilE152tKV7k12hnYuk3d99IqNHAXjEIiZFgsphr2M4O798DfOT4ZhFvefxM5J79Prix1e/XL0KExJaVxtsMpwMx2Epop0vuepx6q/Kdx+21aaR+hPW6s3jTOuDkZFchNaomWHrtuaG9Tbt0/5S/TZihXaeQFYrSr63Vq7XdPxbFcaMm9uIzbkVJF/ofVLh6HPa7cw/qel3vzbr92fwif38XsnbXkNRozHnsgrzdcTucLnzi8D6lvY4dcNBotUQZ0mCxvdwH3SuW+3f+atrFsayYrvRuQuNTvOBqO+Va7sDqgWgv9SO7UVYreomar3u4OurT2I0CrbQZKTb9Xr9f9+R7BA=",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,h={},y=[];function f(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,n.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,n.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(m(),{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,n.jsx)(l(),{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:{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 F(e={}){const{wrapper:t}={...(0,i.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/851f8f65.8c63ba6b.js b/assets/js/851f8f65.8c63ba6b.js deleted file mode 100644 index da82c4b9e..000000000 --- a/assets/js/851f8f65.8c63ba6b.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:()=>j,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>g});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":"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDRaHQ3Gv26jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsheYTy0IndnD4ivE8VzPDKgPaMKvYFCRoboFJmLE0TMfGc1ZqdS5SIacs5ZazmbAZ42zMDTzaZSATlULKJiKH3ok8kUei3GfvylzxlM1Vpdnhi3+v58OFsO14a+sFjKspe/dqa+v9V5m1pdnv93lZ9lQJ0oipzPnY9BJV9FPsWKaThzGbZaABZ2UJlwy4Efmc8TRlM5FOwZqY2QwkS1Q5Z4lSOhWSWzAxK/kUmKyKMWgTMy5TVigNTEjGmQaezret2q4MsP94++Y1myhdcNtjh3ll4nq5VGhIbD5309sM6l09MAEbxmohpzEr+BniS1j2cyWSM9y2AZni/3HgweErwtXW1tuqLJW2kLIf3Rb2t7bwyzeQqxnjGqh/oopCSVZyzQuwdGAZt/RZw8+V0JD6Y8nzgIv9E7nNtrbsvIT9rS32SqYiQWTQhNjK1MT37bmuiCTs+raEREyE79pCHVOSzTKRZISTGXfnWeY8cWBqMCUkVpxDd+KLmM1x4hcgVYAgU1r8oqTlOR3HOWgrEp63jw0BxK7Gcm0RnaUS0oZWvwL7kz8ePD06FE9XCFqKyCqEpC8G2DnPKzAeqlnMMoTqByg1GCJ2Py8iUqYsAzHN1q7H0w+VsZ2JWWUQzDYUfq1wSoReILRNeG6AiUkHlwU/g9ZqTBET87zHvpmzFCa8ym3MBFKc1RX02GtlGS/LXCR8nANSLkPm4bbSsE2n7MnBAyJ5QWd8SDwNhnGWiskENDInfqQp/JgAHdJZIwSIc2zGJVNy4aATlSu9TELU3MUjS5S0IG2PHZxzkRPwbrOGCZnkVQpsnPPkLGbjvIKYaUgd484BBVfs6J26MG48zgk/zECOVKgkwi+VX14YZjxUaY8dZcI0/IQfA6ppEWHaWPVcO1G4MqIgsBiDgos8JsTF7IMaMytsDjEybMnlPEaJCTGzcGHH6iJmSQbJGf2leSoUG1fWKuk2lmpVpmomPS4nSlojflnBkeHLx2N0FLPdmD2K2ZOYDQcxG45iNtyN2fBRzIZPYjYaxGw0itloN2ajRw6s0ZM4iPyA4DYAw5HDsv1ysIty93thiLNRYJpaBs86MnjYY1tbNTdh208//XQiL08kYycRMtdJtM9OorrLSRS7bygz8dvQ/77AHzujx/7nHH8+Gj3xP2fUdbjrf2b4czQ8kVd+wRM5IkgsL8proMDPdwqB/+WJCNtoUWwL8gwbURDF4QOeVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbmu3xF9vkfbacODX0hMuk8kVlufAsMTFKOl3e/1/M2yfvNu2Xuz9xY4n7f1R7h1FE1HKJrW77+WXvcICYswfR4mHvdIASDJvB4PvsM9wkIXos/DwRPEAV5K6xGAX+/R7lvg4Ad/w7tvg93t4d72aDDa7WAA30auQ1Fsp+n2fD6/C+yhzuOXR5UnaKhOs8N36USrYsXzg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+wLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6Hn0um4xoKlacyWm1e2pykrimJNs2vvNPeLYnkXvaLwsJHy9TUyidfZ1vOJ7/B7sUrDEd2Fr2UjtBwomdPa9JxbzUcLl00mpP/giYotdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rH0hOQrAQOFeyrN157f+jJH7fQnQBbbh63tDOc5IAllbGqYBqmcMFKbi1oSZOd81yknJ5y29QAF7wo8QnQ//PJSfov/9wnAwS+8S3Dk2CpmAq0A/X/fHyw/d/vV/SoyhJ0wg2wHHAlEzOwSY8dZ5CXjSlqNpv1ZjsmyZTKnR3qg9Ewcf+eqvGHUwK37HFTPly1U0carQc/ks7ie9+A7WCMGxZGrnjyE40RDw0HdNv69841163vcY9unAWQ8KOznuDn45Oo4KSQIClD87eyGeiT6H09xj3yIb1h7PtbMGsmUsj5GPLlT7dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi4WP7tvVCv52CGlzZ7hyAnuGE2C5MMFy00Vne7Q3bZHBUQKQDXMMLAxAA3GQHp/LBTVgt2MDJ4n82d2wBPZj1LE2K4bVblihczBtxOAchZCiqIraPjqpZw0oK7zu0cYXjkS7e1ihfbpLK/CLG1ZAY+T6BU7kkOwYwf5xjWbqe9wjWbEA0vVs/ClSpHNP39EFezMDhm21GXDFtYxd3YVcM59Zz3099gavN7TJukFoZUsSKC1a5D6XNWuQb31Dkc3K2eG+ITvcesprW+vuEfWtAOs3pkDf765vn08i0vbuvyBC7YB9a2J1RsmCT695udPne0SeHp4lI8TW1qGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgwxQfQGnO8kAFuPJXh3b0bR18P2uc0fLTXOae9QeecBuvO6ZpnI56gKZU0ta0Nmk8tvqYjDu3LV8si24ZJ8UhfSvSthNeDYwZV5SnLxRl5VVJhypzP8VQDl3ooF911zzOlTNPDe8y+8hve73rilEZn3MNe7Zi4jcFr4TBaZzF8vNM6ir0nT7oc02GY27zfm/WWT2Gw2x/u9Z1Fa7VBqzHDrBfC12gCjN3mvMhOdKvzop7NgW3MTp9qdrobct+5y1f38PGoc1nsDD71srjzx3Wba254Vt/F4/nOXrFtdrvl+/V3e0d+PvXtNhr1+M406uHjnTYVPh7egQl1jeL8uZS4pB/fGe2xu1KOVxHgLbTja1XizybQNrC/OZHu3Y0mPRx0NLSvOwra16M2Ue7t3Yoo24suUNZJJP7rmzc/zAZ//HaqDg4ODl6/fZe9fDc9ODgo8Hev11v5iFp12rQMaq4+ItDfy3THr1ml1+shCjG4cp+G90s5/Vc3Pl4/pnciozhSJUZtCiVfpdF+lGKcZ1DBo5ieEWDsNyqdR/uXkQ8Rwj99AA6O7H8wGCh6GZkkg4LjX+H5gaGlGNkZxRF5ijG6FM8x2o/U+AMkuEapEQYrwOBI6r1/GXq5gMgo9mpWtB+5fUVx5G35dVMdSlqmk+gqLHjdVHVLM5WhP+pXCM6DMYefOM1rHHq1EFD7STO9aM1AeyvgSD1X+M3CCz43rXmdqS9ajOPFMcjhiR/FUj43KCkq4261hOdJlaMyCBel0PPaIUoaYYsqanjrlWp4h3tXMQU0gW6DxLXm8yiOhIWi3b6GCLT6+JNLQCFmKCrlY8d+UDAG+INvQG8NHTwvPhqKDwrYGOjQy0zJjx4/HO0MR8Od4Qhn8C/aT8ej+7oMQZcwDjBwDtKg6Ww3EaAxoyis3k00GvrTtvkUbibGo3WRwa2ARJPR84aXJXDdowDdT4797tJ3faX2bqDmqzi6uHkzFyxR2yHsmH2Vw8Q6NyFLlJagH7ZjD+7N5ka7u1dxNL95e/MvcnuP8fBmN+/uR4rXbmLZ/x6w7jy5iqPsZli/qyPK/47A7j66am7XiMx0EC6H07FK56dBbl3d1DFcFNhvovIUNGohy/KqETUoYTAT4nRRzo+VyoHLFYKmE0rss1ZQ40Wjr7eCzDLAh0OjCNPsjZbtTcQOWgxPhoWIB2FQQdUVnEQ99mrS0tlJh16MZg59KbJYKvaA1js1FYnxB33/G3H0oJ21gTbWJugogECdmYWizCntYYaG2jF58NIeq/8jda/GJAIQrsuw8M1XxXMXaUEL+kHdnAHmNcYee85lHTfejc9ml5c1GRB1XF2xy0s8VdCneOleXcVNA67VaaB71bVoSECcd0bVTdAMrNtaQ52Kc4oqjmvwcXxtAMRUCjk9rbSfBzXBq6tehyAXACdztccBpDWdialcsetaX6GTvjX2l5DtKQAn+X+D96fls+/EClCe9stnT8tnP2KGUAmO9xx6JkKmjvNnkOc99tRYreT02QIKnvZ9++qj1HAuYEaMS6fazLKI23qinofpTyiom8MThiW6SgTPKcRIqwSCVwTPTeKz2VgoDbqhhKWRLomD9HE+1UD+F4KFV5YyouhBFhZ8ylmmYfJvDxZw+uDZWwQdk+Ge9vkz3/uVMwRk/BwYl3NGGyerhdLO8jWpNInJJOdaTPzrL2ZlDhgOhY9DnjgvmsNogOMo4/LMxE/H+tkR8IK9KUEiBL/+9W/YI8j0V/KNTkHfQqi/mjh/nWIPUI49iF1oFpG70MZ6Ue0koacQB9ca1vGh+ejme1mLflONDfaSYb5GtFotplNAL5bvQYN9ogvwJHOXBkHFJ8FuXyLxqMoE8JDAwmuMXFrC0YeQ066dpYUdcqC1995bJdUlZsa8OTq8BS7JCLTtGMVZQNwu3RzszdEhJtfVx91j70yNiYBa3unC8BnOzgUPCTi1Zj934SzgPBleLra9fj2f1rbNlgFKhVkJUewudZRwdTLq0sRN9iUekaosehGFzykiLuvgkaCoEXmkqttQ5Q2Y5GxaUfSwRfYNtyYFEDbJcUIaqysXysPSSod8QE8WTkwY0+ApYAU7teaPGUjjhnM24caCjlklBWJeV2gXrKeEixK0AJnAShRocKhD0XHzFdXNNHv3w/c+5zbsITDlGDnQTQwpq0qiGuKEOgMynNzi1lfqg1583wwg6m6Up+iNmyVooySKOKWnXHoJ6t6jaMEcQ8Zz19WLCnSCITzI4V1ggqb961//1oJrrUViGTC3Ak9TDG+9AUIyBjuCxwguDSVKQNWFCOcD/YfFJwBCR0xzWqi0ZiRzexo/pIBYU8tF75WvIwJMlWR4bdXy1sRBxhpvVDBk9yXjMLn1S9wvXAhjWzl8IdJ+WT78AIjHpAUDPUKRq5Hm5bzN4E2kglqYjp4Hopv/WT+ClniBV1adaiiEvN091bazW1ULgsqqgluRsDCV6XWzep0zN/B1wb4KoCE1ngulH65hVZzuVMkEToU8hXPQt3jev64jA8kgOAY7A5Bt2AKS3HXWZF7OMFm+g5PW7UT5xW0o0TJYunCMVZarLlAhSzqEuAd6cFcJZe8XYwwLcoElyGokOMIrbckU9qXY0nyExcaS9gWZmoaDwT+yJW1n8OVY0nYHX5Al7QkC672ONwugdfrNStkRXIvXD/igyGRPztnre6Ivj4x0zve9CsENO4yu3H+N8S/I/XZbx9foLCA0pvEd+tdM2AthYTQY4P+6p/miEzSIum2VoK44qfJ8/k9RfHvH5fVHUEMrVpopr5Pr2Qcx+uUiOR8dIh7X6NLXTuAJsdI5FpvBG2+71mNIp2vhVshcSDglFJ+mKjnVYE5Hg8HpMHIHs7sKjW9VATYj9QuROUPrRf28t3rO+JQLyZDG9R1iFbS+ifw+DrIVmAg0dLrbQcLeMhJeScqxoRpHR+oM5O+70/by1i2PoF4UeSMDIuE60feos9l2u9ukgaTSws6j/ePL6GKbl2Lbfd8/fn/1Po4QsQp9/6UyBDG3WbQf9RdDAQzoc3LqHl868q0p0nCZYvzSknjkpeifD3vD6CpeHLNSnF7TH6rtjx1iLJ8KOb1p3PsGRW/xGN1JdRDVqIyl+COgzujPod0rjgSSTwYc3waIeaSOH5oAipfhjEOQw6q4heYsFyMRQiBCJ7Zg8VpbES2wOlhguNdy0x8Hjzs50Wsf+iq3eL314Oiu/dwt13XLc33c0HrtJA6a7ZBUwtHuLulOj4ekZOw8oft799EVUWfjFYqirueHotoX/RefZ47vWuM3JuZ/IBPzgoXZE09jJnXRfx17n2/q2r8CFdb2po7RZ9Hms9b+ssb84pdcMDPUgKx63e91HtUr+C4ohV2uw/g45LqdAXHd7oC47smgo4/6HTYzNFolqY615kjqYVs7RBXwPcpAISeKBKiXauFc6H4jAbz0ioA8UUVd1mlrq3WU9aitrVowOnLE0ME3lWalmoGeVK5O1CSHC4GGChwGBX1rfL/AixyMyTFg3sKUahdS+jdahL3NMeElH4tc4AXuklocYzQ6gOmxHxvv8QPtsuHPIcd7vzb1YO3DoKPOlD6boBc6xiqIWPINjX0gMy4TZ1d0txHZx9DQgTbbUguDlew0Qi0cbEpajdxQcMmnxKdxm+5ZCjmKLcO0GqPZ3ai8ctxmuciVdlFftCEKKiUkvrwo8RM9hdAiqyFD2j331mUTO+u+u2h8LcQxOlJKhEUkQEa2SuYKyxaiQ6bKc1Yq65wk+OJqw4jDrebSoOrrA838GdQI84ZfMD7h550BPOHvhTxzpba22XFNVz/C2AgL3UT8Rf572B3zrbDfVWMs5KeMsErPm9FTYbNqTCpDe5L6h5vp21D7sqUQNHOkKjEr3o4qMX2sGdB/CxYpxPQPDl+RxvmQ/fqX/2HfA9eSZWrmqDWpNOTzpswmFaGkk3doqxVGci2gsEaMJ474/B0TMPhjxu2vf/lfw17DDE2sjqVcUOphNc5Fwo5COMHW1j57Ts+qVohBJ3HYpXOhv4ez0o3OhTzrsQM5Jwt1c+NgO43rbINuuVbJUI4BiUr66GG3Zq+BiGyiBvJzINM31o4bA4NUOC+aVtXUrdYGxm+um9mGeztIU1YuZLeh/bUBx5kYyX3Fna0Ra3uuSIjrZJ51fe8gU6o+afYZKdbN/PFCyhvdd0tNIVsuoCP209RH4jjR77hudTG+C8psV95qmABFd3aruPJSeHI6DmTJuhUuPp6sna2BrnB6DflLkpdipYcCa2+aN5O3oM9FEp7Aazi6T537URzlIgFv+PD318G3h9+z853eIIpbT4RbMHf/+1fPX75++xKBQUHqEDbsDXsDss8qYwsuWyt1y+QuXm2t+OlNUd1NUd1NUd1NUd1NUd0vp+zrpqjupqjupqjupqjupqjupqjub4eETVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHd+yMrNkV170ut0k1R3d+DAjdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFddcU1W2lXvTLnAvZyvl0+XXHC6V238dRhvl3+8fR5SWu8g6zaLD554ryPI7fx9E51wKjcyh1Lw6pZpjrcQaYsPTcBRttH+HysWNtiq9dyFjEXDk34oDo+dq+7RTBwzdvj6I4CtXKCpVSbjCfYW4In7n0mFYCCbVdRjmX04qSTyI355WrpZF1U+vOKLXO/9HKYOFy3oKwm3PntoH/4qZWDri8dGl7lODl+rtPa0d4xIbeeHzvr66u/g+M05u2","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),o=t(28453),r=t(33617),l=t.n(r),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDRaHQ3Gv26jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsheYTy0IndnD4ivE8VzPDKgPaMKvYFCRoboFJmLE0TMfGc1ZqdS5SIacs5ZazmbAZ42zMDTzaZSATlULKJiKH3ok8kUei3GfvylzxlM1Vpdnhi3+v58OFsO14a+sFjKspe/dqa+v9V5m1pdnv93lZ9lQJ0oipzPnY9BJV9FPsWKaThzGbZaABZ2UJlwy4Efmc8TRlM5FOwZqY2QwkS1Q5Z4lSOhWSWzAxK/kUmKyKMWgTMy5TVigNTEjGmQaezret2q4MsP94++Y1myhdcNtjh3ll4nq5VGhIbD5309sM6l09MAEbxmohpzEr+BniS1j2cyWSM9y2AZni/3HgweErwtXW1tuqLJW2kLIf3Rb2t7bwyzeQqxnjGqh/oopCSVZyzQuwdGAZt/RZw8+V0JD6Y8nzgIv9E7nNtrbsvIT9rS32SqYiQWTQhNjK1MT37bmuiCTs+raEREyE79pCHVOSzTKRZISTGXfnWeY8cWBqMCUkVpxDd+KLmM1x4hcgVYAgU1r8oqTlOR3HOWgrEp63jw0BxK7Gcm0RnaUS0oZWvwL7kz8ePD06FE9XCFqKyCqEpC8G2DnPKzAeqlnMMoTqByg1GCJ2Py8iUqYsAzHN1q7H0w+VsZ2JWWUQzDYUfq1wSoReILRNeG6AiUkHlwU/g9ZqTBET87zHvpmzFCa8ym3MBFKc1RX02GtlGS/LXCR8nANSLkPm4bbSsE2n7MnBAyJ5QWd8SDwNhnGWiskENDInfqQp/JgAHdJZIwSIc2zGJVNy4aATlSu9TELU3MUjS5S0IG2PHZxzkRPwbrOGCZnkVQpsnPPkLGbjvIKYaUgd484BBVfs6J26MG48zgk/zECOVKgkwi+VX14YZjxUaY8dZcI0/IQfA6ppEWHaWPVcO1G4MqIgsBiDgos8JsTF7IMaMytsDjEybMnlPEaJCTGzcGHH6iJmSQbJGf2leSoUG1fWKuk2lmpVpmomPS4nSlojflnBkeHLx2N0FLPdmD2K2ZOYDQcxG45iNtyN2fBRzIZPYjYaxGw0itloN2ajRw6s0ZM4iPyA4DYAw5HDsv1ysIty93thiLNRYJpaBs86MnjYY1tbNTdh208//XQiL08kYycRMtdJtM9OorrLSRS7bygz8dvQ/77AHzujx/7nHH8+Gj3xP2fUdbjrf2b4czQ8kVd+wRM5IkgsL8proMDPdwqB/+WJCNtoUWwL8gwbURDF4QOeVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbmu3xF9vkfbacODX0hMuk8kVlufAsMTFKOl3e/1/M2yfvNu2Xuz9xY4n7f1R7h1FE1HKJrW77+WXvcICYswfR4mHvdIASDJvB4PvsM9wkIXos/DwRPEAV5K6xGAX+/R7lvg4Ad/w7tvg93t4d72aDDa7WAA30auQ1Fsp+n2fD6/C+yhzuOXR5UnaKhOs8N36USrYsXzg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+wLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6Hn0um4xoKlacyWm1e2pykrimJNs2vvNPeLYnkXvaLwsJHy9TUyidfZ1vOJ7/B7sUrDEd2Fr2UjtBwomdPa9JxbzUcLl00mpP/giYotdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rH0hOQrAQOFeyrN157f+jJH7fQnQBbbh63tDOc5IAllbGqYBqmcMFKbi1oSZOd81yknJ5y29QAF7wo8QnQ//PJSfov/9wnAwS+8S3Dk2CpmAq0A/X/fHyw/d/vV/SoyhJ0wg2wHHAlEzOwSY8dZ5CXjSlqNpv1ZjsmyZTKnR3qg9Ewcf+eqvGHUwK37HFTPly1U0carQc/ks7ie9+A7WCMGxZGrnjyE40RDw0HdNv69841163vcY9unAWQ8KOznuDn45Oo4KSQIClD87eyGeiT6H09xj3yIb1h7PtbMGsmUsj5GPLlT7dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi4WP7tvVCv52CGlzZ7hyAnuGE2C5MMFy00Vne7Q3bZHBUQKQDXMMLAxAA3GQHp/LBTVgt2MDJ4n82d2wBPZj1LE2K4bVblihczBtxOAchZCiqIraPjqpZw0oK7zu0cYXjkS7e1ihfbpLK/CLG1ZAY+T6BU7kkOwYwf5xjWbqe9wjWbEA0vVs/ClSpHNP39EFezMDhm21GXDFtYxd3YVcM59Zz3099gavN7TJukFoZUsSKC1a5D6XNWuQb31Dkc3K2eG+ITvcesprW+vuEfWtAOs3pkDf765vn08i0vbuvyBC7YB9a2J1RsmCT695udPne0SeHp4lI8TW1qGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgwxQfQGnO8kAFuPJXh3b0bR18P2uc0fLTXOae9QeecBuvO6ZpnI56gKZU0ta0Nmk8tvqYjDu3LV8si24ZJ8UhfSvSthNeDYwZV5SnLxRl5VVJhypzP8VQDl3ooF911zzOlTNPDe8y+8hve73rilEZn3MNe7Zi4jcFr4TBaZzF8vNM6ir0nT7oc02GY27zfm/WWT2Gw2x/u9Z1Fa7VBqzHDrBfC12gCjN3mvMhOdKvzop7NgW3MTp9qdrobct+5y1f38PGoc1nsDD71srjzx3Wba254Vt/F4/nOXrFtdrvl+/V3e0d+PvXtNhr1+M406uHjnTYVPh7egQl1jeL8uZS4pB/fGe2xu1KOVxHgLbTja1XizybQNrC/OZHu3Y0mPRx0NLSvOwra16M2Ue7t3Yoo24suUNZJJP7rmzc/zAZ//HaqDg4ODl6/fZe9fDc9ODgo8Hev11v5iFp12rQMaq4+ItDfy3THr1ml1+shCjG4cp+G90s5/Vc3Pl4/pnciozhSJUZtCiVfpdF+lGKcZ1DBo5ieEWDsNyqdR/uXkQ8Rwj99AA6O7H8wGCh6GZkkg4LjX+H5gaGlGNkZxRF5ijG6FM8x2o/U+AMkuEapEQYrwOBI6r1/GXq5gMgo9mpWtB+5fUVx5G35dVMdSlqmk+gqLHjdVHVLM5WhP+pXCM6DMYefOM1rHHq1EFD7STO9aM1AeyvgSD1X+M3CCz43rXmdqS9ajOPFMcjhiR/FUj43KCkq4261hOdJlaMyCBel0PPaIUoaYYsqanjrlWp4h3tXMQU0gW6DxLXm8yiOhIWi3b6GCLT6+JNLQCFmKCrlY8d+UDAG+INvQG8NHTwvPhqKDwrYGOjQy0zJjx4/HO0MR8Od4Qhn8C/aT8ej+7oMQZcwDjBwDtKg6Ww3EaAxoyis3k00GvrTtvkUbibGo3WRwa2ARJPR84aXJXDdowDdT4797tJ3faX2bqDmqzi6uHkzFyxR2yHsmH2Vw8Q6NyFLlJagH7ZjD+7N5ka7u1dxNL95e/MvcnuP8fBmN+/uR4rXbmLZ/x6w7jy5iqPsZli/qyPK/47A7j66am7XiMx0EC6H07FK56dBbl3d1DFcFNhvovIUNGohy/KqETUoYTAT4nRRzo+VyoHLFYKmE0rss1ZQ40Wjr7eCzDLAh0OjCNPsjZbtTcQOWgxPhoWIB2FQQdUVnEQ99mrS0tlJh16MZg59KbJYKvaA1js1FYnxB33/G3H0oJ21gTbWJugogECdmYWizCntYYaG2jF58NIeq/8jda/GJAIQrsuw8M1XxXMXaUEL+kHdnAHmNcYee85lHTfejc9ml5c1GRB1XF2xy0s8VdCneOleXcVNA67VaaB71bVoSECcd0bVTdAMrNtaQ52Kc4oqjmvwcXxtAMRUCjk9rbSfBzXBq6tehyAXACdztccBpDWdialcsetaX6GTvjX2l5DtKQAn+X+D96fls+/EClCe9stnT8tnP2KGUAmO9xx6JkKmjvNnkOc99tRYreT02QIKnvZ9++qj1HAuYEaMS6fazLKI23qinofpTyiom8MThiW6SgTPKcRIqwSCVwTPTeKz2VgoDbqhhKWRLomD9HE+1UD+F4KFV5YyouhBFhZ8ylmmYfJvDxZw+uDZWwQdk+Ge9vkz3/uVMwRk/BwYl3NGGyerhdLO8jWpNInJJOdaTPzrL2ZlDhgOhY9DnjgvmsNogOMo4/LMxE/H+tkR8IK9KUEiBL/+9W/YI8j0V/KNTkHfQqi/mjh/nWIPUI49iF1oFpG70MZ6Ue0koacQB9ca1vGh+ejme1mLflONDfaSYb5GtFotplNAL5bvQYN9ogvwJHOXBkHFJ8FuXyLxqMoE8JDAwmuMXFrC0YeQ066dpYUdcqC1995bJdUlZsa8OTq8BS7JCLTtGMVZQNwu3RzszdEhJtfVx91j70yNiYBa3unC8BnOzgUPCTi1Zj934SzgPBleLra9fj2f1rbNlgFKhVkJUewudZRwdTLq0sRN9iUekaosehGFzykiLuvgkaCoEXmkqttQ5Q2Y5GxaUfSwRfYNtyYFEDbJcUIaqysXysPSSod8QE8WTkwY0+ApYAU7teaPGUjjhnM24caCjlklBWJeV2gXrKeEixK0AJnAShRocKhD0XHzFdXNNHv3w/c+5zbsITDlGDnQTQwpq0qiGuKEOgMynNzi1lfqg1583wwg6m6Up+iNmyVooySKOKWnXHoJ6t6jaMEcQ8Zz19WLCnSCITzI4V1ggqb961//1oJrrUViGTC3Ak9TDG+9AUIyBjuCxwguDSVKQNWFCOcD/YfFJwBCR0xzWqi0ZiRzexo/pIBYU8tF75WvIwJMlWR4bdXy1sRBxhpvVDBk9yXjMLn1S9wvXAhjWzl8IdJ+WT78AIjHpAUDPUKRq5Hm5bzN4E2kglqYjp4Hopv/WT+ClniBV1adaiiEvN091bazW1ULgsqqgluRsDCV6XWzep0zN/B1wb4KoCE1ngulH65hVZzuVMkEToU8hXPQt3jev64jA8kgOAY7A5Bt2AKS3HXWZF7OMFm+g5PW7UT5xW0o0TJYunCMVZarLlAhSzqEuAd6cFcJZe8XYwwLcoElyGokOMIrbckU9qXY0nyExcaS9gWZmoaDwT+yJW1n8OVY0nYHX5Al7QkC672ONwugdfrNStkRXIvXD/igyGRPztnre6Ivj4x0zve9CsENO4yu3H+N8S/I/XZbx9foLCA0pvEd+tdM2AthYTQY4P+6p/miEzSIum2VoK44qfJ8/k9RfHvH5fVHUEMrVpopr5Pr2Qcx+uUiOR8dIh7X6NLXTuAJsdI5FpvBG2+71mNIp2vhVshcSDglFJ+mKjnVYE5Hg8HpMHIHs7sKjW9VATYj9QuROUPrRf28t3rO+JQLyZDG9R1iFbS+ifw+DrIVmAg0dLrbQcLeMhJeScqxoRpHR+oM5O+70/by1i2PoF4UeSMDIuE60feos9l2u9ukgaTSws6j/ePL6GKbl2Lbfd8/fn/1Po4QsQp9/6UyBDG3WbQf9RdDAQzoc3LqHl868q0p0nCZYvzSknjkpeifD3vD6CpeHLNSnF7TH6rtjx1iLJ8KOb1p3PsGRW/xGN1JdRDVqIyl+COgzujPod0rjgSSTwYc3waIeaSOH5oAipfhjEOQw6q4heYsFyMRQiBCJ7Zg8VpbES2wOlhguNdy0x8Hjzs50Wsf+iq3eL314Oiu/dwt13XLc33c0HrtJA6a7ZBUwtHuLulOj4ekZOw8oft799EVUWfjFYqirueHotoX/RefZ47vWuM3JuZ/IBPzgoXZE09jJnXRfx17n2/q2r8CFdb2po7RZ9Hms9b+ssb84pdcMDPUgKx63e91HtUr+C4ohV2uw/g45LqdAXHd7oC47smgo4/6HTYzNFolqY615kjqYVs7RBXwPcpAISeKBKiXauFc6H4jAbz0ioA8UUVd1mlrq3WU9aitrVowOnLE0ME3lWalmoGeVK5O1CSHC4GGChwGBX1rfL/AixyMyTFg3sKUahdS+jdahL3NMeElH4tc4AXuklocYzQ6gOmxHxvv8QPtsuHPIcd7vzb1YO3DoKPOlD6boBc6xiqIWPINjX0gMy4TZ1d0txHZx9DQgTbbUguDlew0Qi0cbEpajdxQcMmnxKdxm+5ZCjmKLcO0GqPZ3ai8ctxmuciVdlFftCEKKiUkvrwo8RM9hdAiqyFD2j331mUTO+u+u2h8LcQxOlJKhEUkQEa2SuYKyxaiQ6bKc1Yq65wk+OJqw4jDrebSoOrrA838GdQI84ZfMD7h550BPOHvhTxzpba22XFNVz/C2AgL3UT8Rf572B3zrbDfVWMs5KeMsErPm9FTYbNqTCpDe5L6h5vp21D7sqUQNHOkKjEr3o4qMX2sGdB/CxYpxPQPDl+RxvmQ/fqX/2HfA9eSZWrmqDWpNOTzpswmFaGkk3doqxVGci2gsEaMJ474/B0TMPhjxu2vf/lfw17DDE2sjqVcUOphNc5Fwo5COMHW1j57Ts+qVohBJ3HYpXOhv4ez0o3OhTzrsQM5Jwt1c+NgO43rbINuuVbJUI4BiUr66GG3Zq+BiGyiBvJzINM31o4bA4NUOC+aVtXUrdYGxm+um9mGeztIU1YuZLeh/bUBx5kYyX3Fna0Ra3uuSIjrZJ51fe8gU6o+afYZKdbN/PFCyhvdd0tNIVsuoCP209RH4jjR77hudTG+C8psV95qmABFd3aruPJSeHI6DmTJuhUuPp6sna2BrnB6DflLkpdipYcCa2+aN5O3oM9FEp7Aazi6T537URzlIgFv+PD318G3h9+z853eIIpbT4RbMHf/+1fPX75++xKBQUHqEDbsDXsDss8qYwsuWyt1y+QuXm2t+OlNUd1NUd1NUd1NUd1NUd0vp+zrpqjupqjupqjupqjupqjupqjub4eETVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHd+yMrNkV170ut0k1R3d+DAjdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFddcU1W2lXvTLnAvZyvl0+XXHC6V238dRhvl3+8fR5SWu8g6zaLD554ryPI7fx9E51wKjcyh1Lw6pZpjrcQaYsPTcBRttH+HysWNtiq9dyFjEXDk34oDo+dq+7RTBwzdvj6I4CtXKCpVSbjCfYW4In7n0mFYCCbVdRjmX04qSTyI355WrpZF1U+vOKLXO/9HKYOFy3oKwm3PntoH/4qZWDri8dGl7lODl+rtPa0d4xIbeeHzvr66u/g+M05u2",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,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.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.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)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{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},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",description:"Allowed values - signature, stamp.",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,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.b07419f4.js b/assets/js/851f8f65.b07419f4.js new file mode 100644 index 000000000..8e1ed57de --- /dev/null +++ b/assets/js/851f8f65.b07419f4.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:()=>x,default:()=>b,frontMatter:()=>y,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":"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDRaHQ3Gv26jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsheYTy0IndnD4ivE8VzPDKgPaMKvYFCRoboFJmLE0TMfGc1ZqdS5SIacs5ZazmbAZ42zMDTzaZSATlULKJiKH3ok8kUei3GfvylzxlM1Vpdnhi3+v58OFsO14a+sFjKspe/dqa+v9V5m1pdnv93lZ9lQJ0oipzPnY9BJV9FPsWKaThzGbZaABZ2UJlwy4Efmc8TRlM5FOwZqY2QwkS1Q5Z4lSOhWSWzAxK/kUmKyKMWgTMy5TVigNTEjGmQaezret2q4MsP94++Y1myhdcNtjh3ll4nq5VGhIbD5309sM6l09MAEbxmohpzEr+BniS1j2cyWSM9y2AZni/3HgweErwtXW1tuqLJW2kLIf3Rb2t7bwyzeQqxnjGqh/oopCSVZyzQuwdGAZt/RZw8+V0JD6Y8nzgIv9E7nNtrbsvIT9rS32SqYiQWTQhNjK1MT37bmuiCTs+raEREyE79pCHVOSzTKRZISTGXfnWeY8cWBqMCUkVpxDd+KLmM1x4hcgVYAgU1r8oqTlOR3HOWgrEp63jw0BxK7Gcm0RnaUS0oZWvwL7kz8ePD06FE9XCFqKyCqEpC8G2DnPKzAeqlnMMoTqByg1GCJ2Py8iUqYsAzHN1q7H0w+VsZ2JWWUQzDYUfq1wSoReILRNeG6AiUkHlwU/g9ZqTBET87zHvpmzFCa8ym3MBFKc1RX02GtlGS/LXCR8nANSLkPm4bbSsE2n7MnBAyJ5QWd8SDwNhnGWiskENDInfqQp/JgAHdJZIwSIc2zGJVNy4aATlSu9TELU3MUjS5S0IG2PHZxzkRPwbrOGCZnkVQpsnPPkLGbjvIKYaUgd484BBVfs6J26MG48zgk/zECOVKgkwi+VX14YZjxUaY8dZcI0/IQfA6ppEWHaWPVcO1G4MqIgsBiDgos8JsTF7IMaMytsDjEybMnlPEaJCTGzcGHH6iJmSQbJGf2leSoUG1fWKuk2lmpVpmomPS4nSlojflnBkeHLx2N0FLPdmD2K2ZOYDQcxG45iNtyN2fBRzIZPYjYaxGw0itloN2ajRw6s0ZM4iPyA4DYAw5HDsv1ysIty93thiLNRYJpaBs86MnjYY1tbNTdh208//XQiL08kYycRMtdJtM9OorrLSRS7bygz8dvQ/77AHzujx/7nHH8+Gj3xP2fUdbjrf2b4czQ8kVd+wRM5IkgsL8proMDPdwqB/+WJCNtoUWwL8gwbURDF4QOeVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbmu3xF9vkfbacODX0hMuk8kVlufAsMTFKOl3e/1/M2yfvNu2Xuz9xY4n7f1R7h1FE1HKJrW77+WXvcICYswfR4mHvdIASDJvB4PvsM9wkIXos/DwRPEAV5K6xGAX+/R7lvg4Ad/w7tvg93t4d72aDDa7WAA30auQ1Fsp+n2fD6/C+yhzuOXR5UnaKhOs8N36USrYsXzg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+wLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6Hn0um4xoKlacyWm1e2pykrimJNs2vvNPeLYnkXvaLwsJHy9TUyidfZ1vOJ7/B7sUrDEd2Fr2UjtBwomdPa9JxbzUcLl00mpP/giYotdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rH0hOQrAQOFeyrN157f+jJH7fQnQBbbh63tDOc5IAllbGqYBqmcMFKbi1oSZOd81yknJ5y29QAF7wo8QnQ//PJSfov/9wnAwS+8S3Dk2CpmAq0A/X/fHyw/d/vV/SoyhJ0wg2wHHAlEzOwSY8dZ5CXjSlqNpv1ZjsmyZTKnR3qg9Ewcf+eqvGHUwK37HFTPly1U0carQc/ks7ie9+A7WCMGxZGrnjyE40RDw0HdNv69841163vcY9unAWQ8KOznuDn45Oo4KSQIClD87eyGeiT6H09xj3yIb1h7PtbMGsmUsj5GPLlT7dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi4WP7tvVCv52CGlzZ7hyAnuGE2C5MMFy00Vne7Q3bZHBUQKQDXMMLAxAA3GQHp/LBTVgt2MDJ4n82d2wBPZj1LE2K4bVblihczBtxOAchZCiqIraPjqpZw0oK7zu0cYXjkS7e1ihfbpLK/CLG1ZAY+T6BU7kkOwYwf5xjWbqe9wjWbEA0vVs/ClSpHNP39EFezMDhm21GXDFtYxd3YVcM59Zz3099gavN7TJukFoZUsSKC1a5D6XNWuQb31Dkc3K2eG+ITvcesprW+vuEfWtAOs3pkDf765vn08i0vbuvyBC7YB9a2J1RsmCT695udPne0SeHp4lI8TW1qGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgwxQfQGnO8kAFuPJXh3b0bR18P2uc0fLTXOae9QeecBuvO6ZpnI56gKZU0ta0Nmk8tvqYjDu3LV8si24ZJ8UhfSvSthNeDYwZV5SnLxRl5VVJhypzP8VQDl3ooF911zzOlTNPDe8y+8hve73rilEZn3MNe7Zi4jcFr4TBaZzF8vNM6ir0nT7oc02GY27zfm/WWT2Gw2x/u9Z1Fa7VBqzHDrBfC12gCjN3mvMhOdKvzop7NgW3MTp9qdrobct+5y1f38PGoc1nsDD71srjzx3Wba254Vt/F4/nOXrFtdrvl+/V3e0d+PvXtNhr1+M406uHjnTYVPh7egQl1jeL8uZS4pB/fGe2xu1KOVxHgLbTja1XizybQNrC/OZHu3Y0mPRx0NLSvOwra16M2Ue7t3Yoo24suUNZJJP7rmzc/zAZ//HaqDg4ODl6/fZe9fDc9ODgo8Hev11v5iFp12rQMaq4+ItDfy3THr1ml1+shCjG4cp+G90s5/Vc3Pl4/pnciozhSJUZtCiVfpdF+lGKcZ1DBo5ieEWDsNyqdR/uXkQ8Rwj99AA6O7H8wGCh6GZkkg4LjX+H5gaGlGNkZxRF5ijG6FM8x2o/U+AMkuEapEQYrwOBI6r1/GXq5gMgo9mpWtB+5fUVx5G35dVMdSlqmk+gqLHjdVHVLM5WhP+pXCM6DMYefOM1rHHq1EFD7STO9aM1AeyvgSD1X+M3CCz43rXmdqS9ajOPFMcjhiR/FUj43KCkq4261hOdJlaMyCBel0PPaIUoaYYsqanjrlWp4h3tXMQU0gW6DxLXm8yiOhIWi3b6GCLT6+JNLQCFmKCrlY8d+UDAG+INvQG8NHTwvPhqKDwrYGOjQy0zJjx4/HO0MR8Od4Qhn8KEFHztHiIDGKT6o8eknMUIK5zjeP6o//Sjd1+W1u7R5gLF7kAZla7sJQo0ZBYL1bmKT0J8wz6dwMz8crQtObsVEmoxeWLwsgesexQh/cvh5l8XqW713A0NdxdHFzZu5YInaDpHP7KscJtZ5KlmitAT9sB3+cG82N9rdvYqj+c3bm3+R23uMhze7eXc/Ush4E07/94B158lVHGU3w/pdHdT+dwR299FVc8FHZCmEcD+djlU6Pw1y6+qmjuGuwn4TlaegURFalleNqEEJg8kYp4tXzVipHLhcIWg60cw+cQaVbrQ7e0PMLAN8uzS6OM3eKPreSu2gxQhpWAi6EAZ1ZF3BSdRjryatZwOp8YsB1aEvBTdLxR7QeqemIjH+oO9/I44etBNH0MzbxD0FEKgzs1CUOWVezNBWPCYnYtpj9X+kcdaYRADCjR0WvvmqeO6CPWhBP6ibtsC80tpjz7msQ9e7IeLs8rImA6KOqyt2eYmnCvoU7/2rq7hpwLU6DXS1uxYNCYjzzqi6CZqBdVtrqNOyTlHLcg3+vm8DIKZSyOlppf08qIxeXfU6BLkAOFnMPQ4grelMTOWKXdcqE530rbG/hGxPATjJ/xu8Py2ffSdWgPK0Xz57Wj77EZOUSnC859AzETJ1nD+DPO+xp8ZqJafPFlDwtO/bVx+lhnMBM2JcOtVmlkXc1hP1PEx/QkHdHJ4wLNFVInhOUU5aJRAcM3huEl/uxkJp0BMmLI10eST0JOBTDeQCIlh4ZSkpi96EYcGnnGUaJv/2YAGnD569RdAxH+9pnz/zvV85W0TGz4FxOWe0cTKcKO2Mb5NKk5hMcq7FxD9AY1bmgBFZ+D7liXPkOYwGOI4yLs9M/HSsnx0BL9ibEiRC8Otf/4Y9gkx/Jd/oFPQthPqriXMZKvYA5diD2EWHEbkLbawX1U4SegpxcK1hHZ8dgJ7Gl7XoN9XYYC8Z5mtEq9ViOgV0pPkeNNjn2gBPMndpEFR8ElwHJRKPqkwADwksPAjJqyYcfQg57Zp6WtghH157771VUl1ics6bo8Nb4JLsUNuOUZwRxu3SzcHeHB1ifl993D32ztSYCKjlnS4MLQHsXPCQA1Rr9nMXUQPOmeLlYtvx2POZddtsGaBUmJUQxe5SRwlX58MuTdwkgOIRqcqiI1P4tCbisg4eCYoakUequg1V3oBJzqYVBTBbZN9wa1IMY5OfJ6SxunLRRCytdEhJ9GThxIQxDZ4CVrBTa/6YgTRuOGcTbizomFVSIOZ1habJekq4KEELkAmsRIEGhzoUHTdfUd1kt3c/fO/TfsMeAlOOkQPdxJCyqiSqIU6okzDDyS1ufaU+6MX3zQCi7kapkt6+WoI2SqKIU3rKpZeg7j2KRtQxZDx3Xb2oQD8cwoMc3lv59v/1r39rwbXWKLIMmFuBpylG2N4AIdmjHcFjEJmGEiWg6kKE84H+w+ITAKEjpjktVFozkrk9jR9STK6p5aIPDKiDEkyVZHht1fLWxEHGGm9UMGR6Jvs0RRaUuF+4EMa20ghDsP+yfPgBEI9JCwZ6hCJXI83LeZvBm2AJtTAdPQ9ENwW1fgQt8QKvrDrVUAh5u3uqbeq3qhYElVUFtyJhYSrT6yYWO39y4OuCfRVAQ2o8F0o/XMOqON2pkgmcCnkK56Bv8bx/XQcnkk1yDHYGINuwBSS566xJ/pxhvn4HJ63biVKc21CicbJ0ESGrLFddoEKidoiyD/TgrhIqIFCMMTLJxbYgq5HgCK+0JVPYl2JL80EeG0vaF2RqGg4G/8iWtJ3Bl2NJ2x18QZa0Jwisd3zeLIDW6TcrZUfwbl4/4IMC5+rIlb6+J7oTyUjn3O+rENyww+jK/dcY/4Lcb7d13J3OAkJjGvelf82EvRAWRoMB/q97mi86cYuo21YJ6oqTKs/n/xTFt/edXn8ENbRipZnyOrmefRCjXy6S89Eh4nGNLn3tBJ4QK51jvRu88bZrPYZ0uhZuhcyFhFNC8WmqklMN5nQ0GJwOI3cwu6vQ+FYVYDNSvxCZM7Re1M97q+eMT7mQDGlc3yFWQeubyO/jIFuBiUBDp7sdJOwtI+GVpDQfKrN0pM5A/r47bS9v3fII6kWRNzIgEq4TfY86m223u00aSCot7DzaP76MLrZ5Kbbd9/3j91fv4wgRqzD8oFSGIOY2i/aj/mI0ggF9Tn7l40tHvjVFGi5TDKFaEo+8FP3zYW8YXcWLY1aK02v6Q7X9sUOM5VMhpzeNe9+g6C0eozupDqIalbEUfwTUGf05tHvFkUDyyYDj2wAxj9TxQxPD8TKccYizWBU60ZzlYjBEiIXohDcsXmsrAhZWxysM91qRAsfB6U9+/NqNv8ozX289+NprV3vLe95ynjf+8I47nDzcLQf3ccMStS85KMBD0hxHu7ukYj0eki6y84Su+d1HV0TEjfMoiroOIoq/X3RzfJ7Vvmu031ii/4Es0QuGaE88jTXVxSl2zIK+qWsmC1RYm6U6tqFF09BaM80aK41fcsEaUQOyygiw13l7r+C7oDt2uQ4j+ZDrdgbEdbsD4rong47a6nfYzNAon6Rh1gomaZFtJRI1xfcoKoWcKJKzXjyEc6FrkOT00mMD8kQVdQGqra3WUdajtrZq+enIEYMc31SalWoGelK5ilaTHC4E2jNwGBT0rXERAy9yMCbH0H4LU6qySInqaDj2psmEl3wscoH3vEu/cYzRqAqmx35snMwPtMvbP4cc1YPaIoRVGoMqO1P6bILO6hjrNWJxOrQJgsy4TJz50V1aZEZDewiadkstDNbc0wi1cLApaTVyQ8ElnxKfxm26ZynkKLYM02qM1nmj8spxm+UiV9rFp9GGKPyVkPjyosRP9GJCYa8hQ9o990ZoEzsngLuPfNXGMfpbSoRFJEC2uErmCgssot+mynNWKut8Kfgwa8OIw63m0qCG7EPi/BnUCPP2YTA+NemdATzh74U8c0XBttlxTVc/wtgIC92SAYv897A75lthv6vGWHJQGWGVnjejp8Jm1Zg0i/Yk9Q8307ehSmdLb2jmSFViVjwxVWL6WN2g/xYsUojpHxy+IsX0Ifv1L//DvgeuJcvUzFFrUmnI501BUCqXSSfv0FbrleSBQGGNGE8c8fk7JmDwx4zbX//yv4a9hhlaYh1LufDZw2qci4QdhaiDra199pxeX61IhE6Ks0s8Q7cQZ6UbnQt51mMHck6G7ObGwXYa19kG3XKt4qYcQyeV9HHObs1eAxGZTg3k50AWcqxyNwYGqXDONq2qqVutDYzfXDcHD/d2kKasXMjDQzNtA46zRJKXizuTJFYhXZG618mR67roQaZUJ9PsM9K/m/njheQ8uu+WmkJeX0BH7Kepj8Rxot9x3eqikRd03q681TABikPt1pvlpfDkdBzIknVrcXw8WTuTBF3h9GjylyQvxUpHBlYJNW8mb0GfiyS8lNdwdJ8696M4ykUC3j7i76+Dbw+/Z+c7vUEUt14St2Du/vevnr98/fYlAoOC1CFs2Bv0BmTGVcYWXLZW6hb0XbzaWpHem/K/m/K/m/K/m/K/m/K/X06B2k3530353035303530353035398OCZvyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv/dHVmzK/96Xqqqb8r+/BwVuyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv+uKf/bSr3olzkXspUa6tLwjheKAr+PowzT9PaPo8tLXOUdZtFg888V5Xkcv4+jc64FRudQhl8cMtIw1+MMMGHpuQs22j7C5WPH2hRfu5DYiCl1bsQB0fO1fduZhIdv3h5FcRSKmhUqpRRiPsPcED5z6TGtBBJqu4xyLqcVJZ9Ebs4rV3Ij62bgnVEGnv+jlcGC+WYNhN3UPLcN/Bc3tXLA5aXL7qMEL9fffVo7wiM29Mbje391dfV/94fVhQ==","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),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const y={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDRaHQ3Gv26jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsheYTy0IndnD4ivE8VzPDKgPaMKvYFCRoboFJmLE0TMfGc1ZqdS5SIacs5ZazmbAZ42zMDTzaZSATlULKJiKH3ok8kUei3GfvylzxlM1Vpdnhi3+v58OFsO14a+sFjKspe/dqa+v9V5m1pdnv93lZ9lQJ0oipzPnY9BJV9FPsWKaThzGbZaABZ2UJlwy4Efmc8TRlM5FOwZqY2QwkS1Q5Z4lSOhWSWzAxK/kUmKyKMWgTMy5TVigNTEjGmQaezret2q4MsP94++Y1myhdcNtjh3ll4nq5VGhIbD5309sM6l09MAEbxmohpzEr+BniS1j2cyWSM9y2AZni/3HgweErwtXW1tuqLJW2kLIf3Rb2t7bwyzeQqxnjGqh/oopCSVZyzQuwdGAZt/RZw8+V0JD6Y8nzgIv9E7nNtrbsvIT9rS32SqYiQWTQhNjK1MT37bmuiCTs+raEREyE79pCHVOSzTKRZISTGXfnWeY8cWBqMCUkVpxDd+KLmM1x4hcgVYAgU1r8oqTlOR3HOWgrEp63jw0BxK7Gcm0RnaUS0oZWvwL7kz8ePD06FE9XCFqKyCqEpC8G2DnPKzAeqlnMMoTqByg1GCJ2Py8iUqYsAzHN1q7H0w+VsZ2JWWUQzDYUfq1wSoReILRNeG6AiUkHlwU/g9ZqTBET87zHvpmzFCa8ym3MBFKc1RX02GtlGS/LXCR8nANSLkPm4bbSsE2n7MnBAyJ5QWd8SDwNhnGWiskENDInfqQp/JgAHdJZIwSIc2zGJVNy4aATlSu9TELU3MUjS5S0IG2PHZxzkRPwbrOGCZnkVQpsnPPkLGbjvIKYaUgd484BBVfs6J26MG48zgk/zECOVKgkwi+VX14YZjxUaY8dZcI0/IQfA6ppEWHaWPVcO1G4MqIgsBiDgos8JsTF7IMaMytsDjEybMnlPEaJCTGzcGHH6iJmSQbJGf2leSoUG1fWKuk2lmpVpmomPS4nSlojflnBkeHLx2N0FLPdmD2K2ZOYDQcxG45iNtyN2fBRzIZPYjYaxGw0itloN2ajRw6s0ZM4iPyA4DYAw5HDsv1ysIty93thiLNRYJpaBs86MnjYY1tbNTdh208//XQiL08kYycRMtdJtM9OorrLSRS7bygz8dvQ/77AHzujx/7nHH8+Gj3xP2fUdbjrf2b4czQ8kVd+wRM5IkgsL8proMDPdwqB/+WJCNtoUWwL8gwbURDF4QOeVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbmu3xF9vkfbacODX0hMuk8kVlufAsMTFKOl3e/1/M2yfvNu2Xuz9xY4n7f1R7h1FE1HKJrW77+WXvcICYswfR4mHvdIASDJvB4PvsM9wkIXos/DwRPEAV5K6xGAX+/R7lvg4Ad/w7tvg93t4d72aDDa7WAA30auQ1Fsp+n2fD6/C+yhzuOXR5UnaKhOs8N36USrYsXzg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+wLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6Hn0um4xoKlacyWm1e2pykrimJNs2vvNPeLYnkXvaLwsJHy9TUyidfZ1vOJ7/B7sUrDEd2Fr2UjtBwomdPa9JxbzUcLl00mpP/giYotdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rH0hOQrAQOFeyrN157f+jJH7fQnQBbbh63tDOc5IAllbGqYBqmcMFKbi1oSZOd81yknJ5y29QAF7wo8QnQ//PJSfov/9wnAwS+8S3Dk2CpmAq0A/X/fHyw/d/vV/SoyhJ0wg2wHHAlEzOwSY8dZ5CXjSlqNpv1ZjsmyZTKnR3qg9Ewcf+eqvGHUwK37HFTPly1U0carQc/ks7ie9+A7WCMGxZGrnjyE40RDw0HdNv69841163vcY9unAWQ8KOznuDn45Oo4KSQIClD87eyGeiT6H09xj3yIb1h7PtbMGsmUsj5GPLlT7dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi4WP7tvVCv52CGlzZ7hyAnuGE2C5MMFy00Vne7Q3bZHBUQKQDXMMLAxAA3GQHp/LBTVgt2MDJ4n82d2wBPZj1LE2K4bVblihczBtxOAchZCiqIraPjqpZw0oK7zu0cYXjkS7e1ihfbpLK/CLG1ZAY+T6BU7kkOwYwf5xjWbqe9wjWbEA0vVs/ClSpHNP39EFezMDhm21GXDFtYxd3YVcM59Zz3099gavN7TJukFoZUsSKC1a5D6XNWuQb31Dkc3K2eG+ITvcesprW+vuEfWtAOs3pkDf765vn08i0vbuvyBC7YB9a2J1RsmCT695udPne0SeHp4lI8TW1qGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgwxQfQGnO8kAFuPJXh3b0bR18P2uc0fLTXOae9QeecBuvO6ZpnI56gKZU0ta0Nmk8tvqYjDu3LV8si24ZJ8UhfSvSthNeDYwZV5SnLxRl5VVJhypzP8VQDl3ooF911zzOlTNPDe8y+8hve73rilEZn3MNe7Zi4jcFr4TBaZzF8vNM6ir0nT7oc02GY27zfm/WWT2Gw2x/u9Z1Fa7VBqzHDrBfC12gCjN3mvMhOdKvzop7NgW3MTp9qdrobct+5y1f38PGoc1nsDD71srjzx3Wba254Vt/F4/nOXrFtdrvl+/V3e0d+PvXtNhr1+M406uHjnTYVPh7egQl1jeL8uZS4pB/fGe2xu1KOVxHgLbTja1XizybQNrC/OZHu3Y0mPRx0NLSvOwra16M2Ue7t3Yoo24suUNZJJP7rmzc/zAZ//HaqDg4ODl6/fZe9fDc9ODgo8Hev11v5iFp12rQMaq4+ItDfy3THr1ml1+shCjG4cp+G90s5/Vc3Pl4/pnciozhSJUZtCiVfpdF+lGKcZ1DBo5ieEWDsNyqdR/uXkQ8Rwj99AA6O7H8wGCh6GZkkg4LjX+H5gaGlGNkZxRF5ijG6FM8x2o/U+AMkuEapEQYrwOBI6r1/GXq5gMgo9mpWtB+5fUVx5G35dVMdSlqmk+gqLHjdVHVLM5WhP+pXCM6DMYefOM1rHHq1EFD7STO9aM1AeyvgSD1X+M3CCz43rXmdqS9ajOPFMcjhiR/FUj43KCkq4261hOdJlaMyCBel0PPaIUoaYYsqanjrlWp4h3tXMQU0gW6DxLXm8yiOhIWi3b6GCLT6+JNLQCFmKCrlY8d+UDAG+INvQG8NHTwvPhqKDwrYGOjQy0zJjx4/HO0MR8Od4Qhn8KEFHztHiIDGKT6o8eknMUIK5zjeP6o//Sjd1+W1u7R5gLF7kAZla7sJQo0ZBYL1bmKT0J8wz6dwMz8crQtObsVEmoxeWLwsgesexQh/cvh5l8XqW713A0NdxdHFzZu5YInaDpHP7KscJtZ5KlmitAT9sB3+cG82N9rdvYqj+c3bm3+R23uMhze7eXc/Ush4E07/94B158lVHGU3w/pdHdT+dwR299FVc8FHZCmEcD+djlU6Pw1y6+qmjuGuwn4TlaegURFalleNqEEJg8kYp4tXzVipHLhcIWg60cw+cQaVbrQ7e0PMLAN8uzS6OM3eKPreSu2gxQhpWAi6EAZ1ZF3BSdRjryatZwOp8YsB1aEvBTdLxR7QeqemIjH+oO9/I44etBNH0MzbxD0FEKgzs1CUOWVezNBWPCYnYtpj9X+kcdaYRADCjR0WvvmqeO6CPWhBP6ibtsC80tpjz7msQ9e7IeLs8rImA6KOqyt2eYmnCvoU7/2rq7hpwLU6DXS1uxYNCYjzzqi6CZqBdVtrqNOyTlHLcg3+vm8DIKZSyOlppf08qIxeXfU6BLkAOFnMPQ4grelMTOWKXdcqE530rbG/hGxPATjJ/xu8Py2ffSdWgPK0Xz57Wj77EZOUSnC859AzETJ1nD+DPO+xp8ZqJafPFlDwtO/bVx+lhnMBM2JcOtVmlkXc1hP1PEx/QkHdHJ4wLNFVInhOUU5aJRAcM3huEl/uxkJp0BMmLI10eST0JOBTDeQCIlh4ZSkpi96EYcGnnGUaJv/2YAGnD569RdAxH+9pnz/zvV85W0TGz4FxOWe0cTKcKO2Mb5NKk5hMcq7FxD9AY1bmgBFZ+D7liXPkOYwGOI4yLs9M/HSsnx0BL9ibEiRC8Otf/4Y9gkx/Jd/oFPQthPqriXMZKvYA5diD2EWHEbkLbawX1U4SegpxcK1hHZ8dgJ7Gl7XoN9XYYC8Z5mtEq9ViOgV0pPkeNNjn2gBPMndpEFR8ElwHJRKPqkwADwksPAjJqyYcfQg57Zp6WtghH157771VUl1ics6bo8Nb4JLsUNuOUZwRxu3SzcHeHB1ifl993D32ztSYCKjlnS4MLQHsXPCQA1Rr9nMXUQPOmeLlYtvx2POZddtsGaBUmJUQxe5SRwlX58MuTdwkgOIRqcqiI1P4tCbisg4eCYoakUequg1V3oBJzqYVBTBbZN9wa1IMY5OfJ6SxunLRRCytdEhJ9GThxIQxDZ4CVrBTa/6YgTRuOGcTbizomFVSIOZ1habJekq4KEELkAmsRIEGhzoUHTdfUd1kt3c/fO/TfsMeAlOOkQPdxJCyqiSqIU6okzDDyS1ufaU+6MX3zQCi7kapkt6+WoI2SqKIU3rKpZeg7j2KRtQxZDx3Xb2oQD8cwoMc3lv59v/1r39rwbXWKLIMmFuBpylG2N4AIdmjHcFjEJmGEiWg6kKE84H+w+ITAKEjpjktVFozkrk9jR9STK6p5aIPDKiDEkyVZHht1fLWxEHGGm9UMGR6Jvs0RRaUuF+4EMa20ghDsP+yfPgBEI9JCwZ6hCJXI83LeZvBm2AJtTAdPQ9ENwW1fgQt8QKvrDrVUAh5u3uqbeq3qhYElVUFtyJhYSrT6yYWO39y4OuCfRVAQ2o8F0o/XMOqON2pkgmcCnkK56Bv8bx/XQcnkk1yDHYGINuwBSS566xJ/pxhvn4HJ63biVKc21CicbJ0ESGrLFddoEKidoiyD/TgrhIqIFCMMTLJxbYgq5HgCK+0JVPYl2JL80EeG0vaF2RqGg4G/8iWtJ3Bl2NJ2x18QZa0Jwisd3zeLIDW6TcrZUfwbl4/4IMC5+rIlb6+J7oTyUjn3O+rENyww+jK/dcY/4Lcb7d13J3OAkJjGvelf82EvRAWRoMB/q97mi86cYuo21YJ6oqTKs/n/xTFt/edXn8ENbRipZnyOrmefRCjXy6S89Eh4nGNLn3tBJ4QK51jvRu88bZrPYZ0uhZuhcyFhFNC8WmqklMN5nQ0GJwOI3cwu6vQ+FYVYDNSvxCZM7Re1M97q+eMT7mQDGlc3yFWQeubyO/jIFuBiUBDp7sdJOwtI+GVpDQfKrN0pM5A/r47bS9v3fII6kWRNzIgEq4TfY86m223u00aSCot7DzaP76MLrZ5Kbbd9/3j91fv4wgRqzD8oFSGIOY2i/aj/mI0ggF9Tn7l40tHvjVFGi5TDKFaEo+8FP3zYW8YXcWLY1aK02v6Q7X9sUOM5VMhpzeNe9+g6C0eozupDqIalbEUfwTUGf05tHvFkUDyyYDj2wAxj9TxQxPD8TKccYizWBU60ZzlYjBEiIXohDcsXmsrAhZWxysM91qRAsfB6U9+/NqNv8ozX289+NprV3vLe95ynjf+8I47nDzcLQf3ccMStS85KMBD0hxHu7ukYj0eki6y84Su+d1HV0TEjfMoiroOIoq/X3RzfJ7Vvmu031ii/4Es0QuGaE88jTXVxSl2zIK+qWsmC1RYm6U6tqFF09BaM80aK41fcsEaUQOyygiw13l7r+C7oDt2uQ4j+ZDrdgbEdbsD4rong47a6nfYzNAon6Rh1gomaZFtJRI1xfcoKoWcKJKzXjyEc6FrkOT00mMD8kQVdQGqra3WUdajtrZq+enIEYMc31SalWoGelK5ilaTHC4E2jNwGBT0rXERAy9yMCbH0H4LU6qySInqaDj2psmEl3wscoH3vEu/cYzRqAqmx35snMwPtMvbP4cc1YPaIoRVGoMqO1P6bILO6hjrNWJxOrQJgsy4TJz50V1aZEZDewiadkstDNbc0wi1cLApaTVyQ8ElnxKfxm26ZynkKLYM02qM1nmj8spxm+UiV9rFp9GGKPyVkPjyosRP9GJCYa8hQ9o990ZoEzsngLuPfNXGMfpbSoRFJEC2uErmCgssot+mynNWKut8Kfgwa8OIw63m0qCG7EPi/BnUCPP2YTA+NemdATzh74U8c0XBttlxTVc/wtgIC92SAYv897A75lthv6vGWHJQGWGVnjejp8Jm1Zg0i/Yk9Q8307ehSmdLb2jmSFViVjwxVWL6WN2g/xYsUojpHxy+IsX0Ifv1L//DvgeuJcvUzFFrUmnI501BUCqXSSfv0FbrleSBQGGNGE8c8fk7JmDwx4zbX//yv4a9hhlaYh1LufDZw2qci4QdhaiDra199pxeX61IhE6Ks0s8Q7cQZ6UbnQt51mMHck6G7ObGwXYa19kG3XKt4qYcQyeV9HHObs1eAxGZTg3k50AWcqxyNwYGqXDONq2qqVutDYzfXDcHD/d2kKasXMjDQzNtA46zRJKXizuTJFYhXZG618mR67roQaZUJ9PsM9K/m/njheQ8uu+WmkJeX0BH7Kepj8Rxot9x3eqikRd03q681TABikPt1pvlpfDkdBzIknVrcXw8WTuTBF3h9GjylyQvxUpHBlYJNW8mb0GfiyS8lNdwdJ8696M4ykUC3j7i76+Dbw+/Z+c7vUEUt14St2Du/vevnr98/fYlAoOC1CFs2Bv0BmTGVcYWXLZW6hb0XbzaWpHem/K/m/K/m/K/m/K/m/K/X06B2k3530353035303530353035398OCZvyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv/dHVmzK/96Xqqqb8r+/BwVuyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv+uKf/bSr3olzkXspUa6tLwjheKAr+PowzT9PaPo8tLXOUdZtFg888V5Xkcv4+jc64FRudQhl8cMtIw1+MMMGHpuQs22j7C5WPH2hRfu5DYiCl1bsQB0fO1fduZhIdv3h5FcRSKmhUqpRRiPsPcED5z6TGtBBJqu4xyLqcVJZ9Ebs4rV3Ij62bgnVEGnv+jlcGC+WYNhN3UPLcN/Bc3tXLA5aXL7qMEL9fffVo7wiM29Mbje391dfV/94fVhQ==",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,g={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(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.p,{children:[(0,s.jsx)(n.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.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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},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},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",description:"Allowed values - signature, stamp.",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)(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,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/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.257eca44.js b/assets/js/98334e25.257eca44.js deleted file mode 100644 index 37d368c5a..000000000 --- a/assets/js/98334e25.257eca44.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:()=>I,contentTitle:()=>k,default:()=>j,frontMatter:()=>b,metadata:()=>n,toc:()=>E});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":"eJy9Vs1u20YQfpXpXtoItGSnKQroFCMwXKNGYtQ2fLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZy1IlkFM78UdppW1czFLRI4h88qRskZMxU2FcI4EHQOcXl2A1NouYWUbIAslEiy7x8ZrkQjr0EsWv8jFVJRIvfJEeAzOmoBBTNfi+fExf+3bu26yDEMoGg1bPSIRmTWEhphfOqdVFh8m7wILrUXIKqwl/6KVQzEVNn2HGYlEOM9qSLUmO0cHjIG8MqVIBD7K2mkmVUQuTCeTlW38USdx1Hj9smMZZ7YWm00iSFEUUEYrg2/74N4+Pz5++6PYbJjnxfGLp0HeBvRgLEFhG5N/89/Fh95b/+XoDm1/KRB2vg/jh6dhXJiF1CqPmLixczT/byRD89SaZ1cfa81yRtZtSJEpvou9UIf0NsiAWeMVrcT0fi0ej6RTR+379H62mSWiRqpsh2l2WFIlpmKy3MI7oF+gD1Gee2GHpSBNntrHsXVogiqNlmlgHE2kU5PFyfhEbJJDGencV/Fjc/S1IoFkqUz5V3KzXW6uuX5tifYytC2UdOpnXImkL8CQKxGKcVOhzNHHYilT2CjcleWNQ3OtShOLGo0fDqQ71JmtkUcPVQijUS/y8dc/tlKjEeQ2a2o0FOE3fjAP5k3jwdkleh4u0uRQaHxUqcYohnV8C/1cCyhrjSHoFShDWHpJCLkqFUkNnCdlSsikk6nSilHLbJalPQyAH8ZwVyFV6PnpW48gIccFagY7yIZsLYlV9f7C0vp5oe0yJCAhbYIyGAKgqaTJmLGvRALWgzSAhtA7rwJCIM9eq9Y3a8jLjKCWRpbIuhMYJitHrRiu4G3aBIJgdRNdBpJKW4859AEZxDzEJJ49On4Cpma2dh4rhs0CoWxUjiGBzOYIITYph2BySDEQOPZFZRhYaWO0zeaxgEWjNTjLM0NJDbbY85HFyUsTCuvr1pe+BtuEOW95ZWDr4Gh0G5ArfKnMPExHowdzBPdbXN1hGhTh7Lu+BZbL5RPoP9uXOVf0U5PCL+hsUGT9aiddKqqaNLbLUMn2T6vpHA1G/AyaYacjt1l42n1MnVSo3eQaiRESJqdXF3HMPoOPH36DS5TeQGWXLVqzxqNeQdmb4sy1lW/Ttp2SUNgIvIoznrXg8/i+wUB9Bu8qSR8//B7gNS5Bma6lOJTR6KpJtcrgBmunJWEYjabwyiObpJ4GVEmCTBpIEUIlGUoLJUGCa6W1MvMxnJoVNLyOloqqCAamR7m9MDgv23IHSGXAHKyJEr3N8c4jptcB9QID6+JdlyJgrogRXXnblK21oTNdcB4LpTXcqbxEirGd5jm4jrxsyZzwgTtYcENQhSuQHiGgoTFcHYjEl8Y569kL1TpfWL6kuABocmeVoTCF3MuCdvqTHdAzTrOy5hOkNoVym46kU7MtSduJXcRb6viBh/LBIN+ftx4L9GwwtNdeXxenOjjd97AERuu/gTXvZ55aMovnA9ZS6XajvDzUE1c5+jq8Ka7RL1TWH26f6ehJZJ6IRGiVoQk4OBFOz68uYfH9+Fgkg/X4N5p7cnnx6uz19Rk7w4O0TdjJ+GR8zCRnA9XSDCwNDunDvbbeHU7/5Obuli/hI02clireOjGYdXen3G+P31kiKhuISes1N9Ot15sNk9836Pn6mSViIb2SKe/k+9km6Vc2HzZzXHHSsgwdX0ELqZt27x8ce3sX0/nZjUgET539U2EeT4XuB2vvn8xqoHv/hmgd4E8+aD4psF63Z8hms+Vvnz4r0QXYc3MCZ5vN5k/S/6Sj","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),s=t(28453),l=t(33617),a=t.n(l),c=t(17543),d=t.n(c),p=t(86013),h=t.n(p),r=t(63723),u=t.n(r),m=(t(18766),t(79329),t(9303));const b={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:"eJy9Vs1u20YQfpXpXtoItGSnKQroFCMwXKNGYtQ2fLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZy1IlkFM78UdppW1czFLRI4h88qRskZMxU2FcI4EHQOcXl2A1NouYWUbIAslEiy7x8ZrkQjr0EsWv8jFVJRIvfJEeAzOmoBBTNfi+fExf+3bu26yDEMoGg1bPSIRmTWEhphfOqdVFh8m7wILrUXIKqwl/6KVQzEVNn2HGYlEOM9qSLUmO0cHjIG8MqVIBD7K2mkmVUQuTCeTlW38USdx1Hj9smMZZ7YWm00iSFEUUEYrg2/74N4+Pz5++6PYbJjnxfGLp0HeBvRgLEFhG5N/89/Fh95b/+XoDm1/KRB2vg/jh6dhXJiF1CqPmLixczT/byRD89SaZ1cfa81yRtZtSJEpvou9UIf0NsiAWeMVrcT0fi0ej6RTR+379H62mSWiRqpsh2l2WFIlpmKy3MI7oF+gD1Gee2GHpSBNntrHsXVogiqNlmlgHE2kU5PFyfhEbJJDGencV/Fjc/S1IoFkqUz5V3KzXW6uuX5tifYytC2UdOpnXImkL8CQKxGKcVOhzNHHYilT2CjcleWNQ3OtShOLGo0fDqQ71JmtkUcPVQijUS/y8dc/tlKjEeQ2a2o0FOE3fjAP5k3jwdkleh4u0uRQaHxUqcYohnV8C/1cCyhrjSHoFShDWHpJCLkqFUkNnCdlSsikk6nSilHLbJalPQyAH8ZwVyFV6PnpW48gIccFagY7yIZsLYlV9f7C0vp5oe0yJCAhbYIyGAKgqaTJmLGvRALWgzSAhtA7rwJCIM9eq9Y3a8jLjKCWRpbIuhMYJitHrRiu4G3aBIJgdRNdBpJKW4859AEZxDzEJJ49On4Cpma2dh4rhs0CoWxUjiGBzOYIITYph2BySDEQOPZFZRhYaWO0zeaxgEWjNTjLM0NJDbbY85HFyUsTCuvr1pe+BtuEOW95ZWDr4Gh0G5ArfKnMPExHowdzBPdbXN1hGhTh7Lu+BZbL5RPoP9uXOVf0U5PCL+hsUGT9aiddKqqaNLbLUMn2T6vpHA1G/AyaYacjt1l42n1MnVSo3eQaiRESJqdXF3HMPoOPH36DS5TeQGWXLVqzxqNeQdmb4sy1lW/Ttp2SUNgIvIoznrXg8/i+wUB9Bu8qSR8//B7gNS5Bma6lOJTR6KpJtcrgBmunJWEYjabwyiObpJ4GVEmCTBpIEUIlGUoLJUGCa6W1MvMxnJoVNLyOloqqCAamR7m9MDgv23IHSGXAHKyJEr3N8c4jptcB9QID6+JdlyJgrogRXXnblK21oTNdcB4LpTXcqbxEirGd5jm4jrxsyZzwgTtYcENQhSuQHiGgoTFcHYjEl8Y569kL1TpfWL6kuABocmeVoTCF3MuCdvqTHdAzTrOy5hOkNoVym46kU7MtSduJXcRb6viBh/LBIN+ftx4L9GwwtNdeXxenOjjd97AERuu/gTXvZ55aMovnA9ZS6XajvDzUE1c5+jq8Ka7RL1TWH26f6ehJZJ6IRGiVoQk4OBFOz68uYfH9+Fgkg/X4N5p7cnnx6uz19Rk7w4O0TdjJ+GR8zCRnA9XSDCwNDunDvbbeHU7/5Obuli/hI02clireOjGYdXen3G+P31kiKhuISes1N9Ot15sNk9836Pn6mSViIb2SKe/k+9km6Vc2HzZzXHHSsgwdX0ELqZt27x8ce3sX0/nZjUgET539U2EeT4XuB2vvn8xqoHv/hmgd4E8+aD4psF63Z8hms+Vvnz4r0QXYc3MCZ5vN5k/S/6Sj",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},k=void 0,I={},E=[];function g(e){const o={p:"p",...(0,s.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)(a(),{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)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{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:{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 j(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.b86e5973.js b/assets/js/9c9cb35e.b86e5973.js new file mode 100644 index 000000000..0d5aeba27 --- /dev/null +++ b/assets/js/9c9cb35e.b86e5973.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:()=>g,contentTitle:()=>j,default:()=>f,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":"eJztPNtyG7eSv4Kd2qrE3CFFUpLtaF9WyfFJvMcbq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsK4m9xTw44uDWaHQDfb+NLJ+Z6OgsOoWizLkFE13EUQom0aK0QsnoKDrNgIVm9o0Gjt/Z8clLxvNczQ2rDGjDrGIJNgJLKmNVIX7hkxyYDRPHbJ6JJGMG9DUwbtgkr6DUQlrDpkqzGUjQ3Ao5Y6lKqgKwYS5sxkoNKUyFhJQZq6vEVhrMgL0tlWSmShIwZlrl9UoODKFkzGwGBKgGW2lpGGeVFD9XwHq90PtSpL0esxm3LOGSTQC3k+JuPEDQAmfCsU1JmtiUkIipwM5+rsG5PJenojxib8tc8ZQtVKXZyZ/+XE+B8+K3s17vTzCpZuzty17v4svM2tIc7e3xshyoEqQRM5nziRkkqthLsWOZTp8gBkEDzkqwAjciXzCepmwu0hlYQzuWLFHlgiVK6VRIh/qSz4DJqpiANjHjMmWF0sCEZJxp4Omib1W/MsD+/c3r7/E4Cm4H7CSvTFwvlwoNic0XbnrEQNjVFw4zTw/wfIScxazgV3iQwrKfK5Fc4bYNSEKrPxPCVa/3pipLpS2k7Ee3haNeD1u+hlzNGddA/RNVFEqykmtegCVqwwPDZg0/V0JD6kiF53nAxdG57OM5L0o46vXYS5mKBJFBE+JXpqa+78B1RSRh1zf+YF3XFurw5B0RI07m3J1nmfPEgakBacKKa+hOfBOzBU78J5AqQJApLX5R0vKcjuMatBUJz9vHhgASoVmuiS9KJaQNX/0K7L/88eDp0aF4ukLQUkRWISS1GGDXPK/AeKjmMcsQqh+g1GCIvv28iEiZsgzELNu6Hk/fVcZ2JmaVQTDbUPi1wikReoHQNuW5ASamHVwW/ApaqzFFlxDPB+zrBUthyqvcxkwgxVldwYB9ryzjZZmLhG4bvEiQeTjeEX06ZU8OHhDJCzrjE62uRQp4JaRiOgWNzImNNIUfE6BDOitpAG6POMdmXDIlVw46UbnS6yREn7t4ZImSFqQdsONrLnIC3m3WMCGTvEqBTXKeXMV0T8ZMQ+oYdwF468aO3qkLXqYO54QfZiBHKlQS4ZfKLy9Mc2MN2GkmTMNP2BhQTYsI08aq59qpwpURBYHFGBRc5DEhLmbv1IRZYXOIkWFLLhcxS7mFmFm4sRN1E7Mkg+SK/tI8FYpNKmvxosY1U63KVM2lx+VUSWvELxs4MrS8P0bHMTuI2dOYPY/ZaBiz0Thmo4OYjZ7GbPQ8ZuNhzMbjmI0PYjZ+6sAaP/e45jWC2wCMxg7L9vPBLt67r4QhzsYL09R38LxzB48GrNeruQm//fTTT+fy9lwydh4hc51HR+w8qrucR7FrwzsT20b+9w3+2B8/8z8X+PPp+Ln/OaeuowP/M8Of49G5XPoFz+WYILG8KO+AApsfFQL/yxMRfqNF8Vu4z/AjXkRxaMCz6sCDDcv2XvZxL0IKK3hutm8n9PiEdtSAtLapA9wUkev2HVHzJ7SdNjzYQteka6JrtdUUGJ6gGK/t/nDgX5btm3fLfjJ7b4HzcVt/ilvHq+kUr6bt+69vr08ICaswfRwmng1IAKCbeTsefIdPCAtdiD4OB88RB/gobUcAtn5Cu2+Bgw3+hXdtw4P+6LA/Ho4POhhA3ch1KIp+mvYXi8VjYA9lHr88ijxBQnWSHaqhU62KDeoHaQdNLy8T0d9BZP8PFNQnQYaFFPW+rgYbNL62lG1VyhdfGDdVGFoLZ9i/Ec0WLTCpCeEg7TfJlEg88NgniGQTVPAGiIM+YXIvTfdamMSPadoviv7KR/zZJ8S3PhbFIE0HKz3XTsd9LFiaxmz988bvacqKotjy2X3vfN4rivVdDIrCw0bC11cDMj+QzLadT3yH34tVGo7oLnwnG6HlQMmc1iZ1bjMfrTw2mZC+wRMVW+mgYVblXMMN6qVGKOl6Pz6PBRZrJHvSY0kFJCuBQwX78rWX3p948sctdCfAL/ePW9sZTnLsDWZMwwxuWMmtBS1psmuei9TZ2/r0AW54UaIKsPfX8/P0X/55jwwQqONbhifBUjETaAfa++vZcf+/Lzb0qMoSdMINsBxwJRMzsMmAnWWQl40paj6fD+b7JsmUyp0d6p3RMHX/XqrJu0sCtxxwUz7ZtFNHGi2FH0lnVd83YDsY44aFkRtUfqIx4qHRkF5br+/c8dz6Hp/Qi7MCEjY66wk2n51HBSeBBEkZmr+VzUCfRxf1GKfkQ3rP2IsHMGsmUsj5BPL1pgczWv055wtVef4ORq3uVj1Ft/CGDYWQtd2CtjOMW438ZqXRtS038LdDSJs7w5MT2DOcAMuFCZabLjrbo71piwyOEpxpeAIsDGCTmko/mgtqwB7GBu4m8md3zxLYj1HH2qwYVrtnhc7BtBGDcxRCiqIqavvotJ41oKzwskcbXzgSnQZhhfbprq3Ab+5ZwZvttyxwLkdkxwj2jzskU9/jE7orVkC6m40/5BbpvNOP9MDez4BhW20G3PAsY1f3INfMZ7Zz34C9xucNbbJuEFrZkgRKixa5j2XNGuQHv1Bks2rb4bZTXrvXJ0R9G8D6jSnQ93vs1+eDiLS9+8+IUDtgP5hYnVGy4LM7NHdq/oTI08OzZoTo9U40TEWet1yKLHwKnh106UAOhXd7eWciPnVkCBfSKlQLgtt2AlPyl1pyo2S8cTi6d8Ydadsn6rzQSrOMGyd/k8CPR4UOW5tBsWKKD6A15nghA9x4KqPH0xvHXw3b5zR6etg5p8Nh55yG287pDrURT9CUSpra1gZNU4uv6YjD9/WnZZVtw6R4pC8k+laC9uCYQVV5ynJxRV6VVJgy5ws81cClHspVd903mVKm6eE9Zl/6DR91PXFKozPuyaB2TDzE4LVyGK2zGD3bbx3F4fPnXY7pMMxD9PdmvfVTGB7sjQ73nEVrs0GrMcNsv4TvkAQYe8h5kZ3oQedFPZsD25mdPtTs9Djkvv+YWvfo2bjzWOwPP/SxeHTlus0196jVj6E8P5oW22a3B+qvv5se+fHUd/BbSNSjZ/ttKnw2egQT6hbB+WMpcU0+fjTaY48lHG8iwAdIx3eKxB9NoG1gf3MiPXwcSXo07EhoX3UEtK/GbaI8PHwQUbYXXaGs80j859evf5gP//LtTB0fHx9//+Zt9uLt7Pj4uMDfg8FgoxK16bRpGZRcfUSgf5fpjd+yymAwQBSm3PIjGr5Xytm/uvHx9jED733+jSw7h4/hTNlgwPn4W6Du+sdZa347Pv84DmT+v3MZxZEqKaBYyZdpdBS54OQQqhvFpGKCsV+rdBEd3UY+fAz/9MFZOHTvncEg6NvIJBkUHP8KqimGTU9FjlNhBBRoE8URxRNgDDVSX3QUqck7SGwUo6+rRIMEGJyDxh3dhl4ubDaKvTAeHUWO+qM48h6f+hMDmSj04ZbpNFqGBe+aqv7STGXojzpuGefByNQPnIaGLlfCxj9opvYMywatzWRca76IViPUQ0hq8Ce6cXXMXb4Ij4SwaBKp4ySpWxRHwkLRXmXLoWn1/phOQOFOKNbofcfSsfDivdfEcWWm5AcN9OEgHzL0nZpcfhA54mBv/dhw1g88Hde6vnCXVI4xyBLSIBX3m2jhmFHE3uA+Sg39Cct81l7T+SjW1jzdFkXeCl41GanCvCyB6wEFc39wngClYvA8qSgbor6WOzurQa13NlrG0c39m7lhieqHEHX2ZQ5T61zKLFFagn7SjlP5ZDY3PjhYxtHi/u0tPsvtPcPDm9+/ux8ptr/Je/gjYN1/voyj7H5Yv6uzD/5AYA+eLps3dkWEuJyodHEZ7q3lfR3DY4b9MBfmpXytU9AtREyUyoHLNUy8nDrrvmJfoMbzRewCOShoXGgTHjI2RwO3hgQwAYXiu8Jdxbys4yLKmQ/kRafAC/xAYpqpJgZ7yTCfcRNOgFktZjNAm7fvQYN9WDxwSuqSPryET4OVr9RwLVRlAnhoCMfXJQe0bdsMhMvVEHLW1cpa2CFze3vvg/bp4Bd8XCXG0b8+PXkALkll7DOb1TH5bpduDvb69ARTccTUi38D9tbUmAio5Z0uDMUxdi14CNev7/aFc36Ds3sq2mzHRzDwSTB9tg5QKsxGiGKXdYd5AnXe3drETa4WHpGqLPochM9AMBZK08EjQVEj8lRVD6HKezDJ2ayiWEOLLBvycijcqEmlEdIl9JG+kVY6ZA95ssCemN3X4ClgBTu15o8ZSOOGczblxoKOMdUPMa8r1C7qKeGmBC1AJrARBRoc6i4rvVFe6+Kgm5fy9odXPkMv7CEw5QQ50E0MKatKohrihDpfKpzc6tbXBCXkDtCX2wTDddGDspq8KaQEbZREdUnpGZfiF0fCJJGgtjWBjOeuq78q0GSO8CCHd4EJd+2vf/9HC66tku46YG4FnqYYDHcPhKRSOoJHSV9DiTeg6kKE84H+t9VHAKEjprksVFozknk4jZ9Q+Jyp70Xvw6v9h6ZKMlQs6vvWxOGONV6sNKSjkiJLTsAS9ws3wthWxk+Iy12/H34AxGPSgoHEEORqpHm5aDN449dUK9NRXpLoZovVz+AaL/DKqksNhZAPe6faVjmr6ougsqrgViQsTGUG3RxA5/oJfF2wLwNoSI3XQuknW1gVp7tUMoFLIS/hGvQDBLzv6ziilC+QuO0cQLZhC0hyz1mTpzXH1NoOTlqvE2UjtqE8RPXAOW836S53K7CBHtxTQrm+xQSDCJwbGlmNLg7V6LBdZehz0aa8P3anS31GysZoOPz/rEvtDz8fXepg+BnpUs8RWG++vf8C2ibfbLw7gjn67gHvFDgLV6703T3RuruMa+P5JgQ37DBeuv8a9S/c+/eohE5nbMzJXp0JmyE0jIdD/N/KJdipdIHCbV0FI1/8UxQ/3JZ99xm4z2g9vwtZX2fj70wpiyRDnBVgTPcm3zDkng208SZkLiRcBqRcjofDy8PI4ftgE3LeqAJsRlIVytNzrbAgRZkDpjxYvWB8xoVkuLx+RFyB1vdR1ftBdhcSDobDy1GNhMN1JLyUFGhPxU9O1RXI33en7eWtWx5BvSnyhrUj4TpRe9TZbPu726SBpNLCLqKjs9vops9L0XftR2cXywukOpsp9PKUyhDE3GbRUbS35vSh6jPoUji7jUjFi8KVZ7hMMYph7drjpdi7Hg1G0TJeHbPxmryjP1T99x1iLJ8JObtv3EWDozd4ju6oOphqRMFS/AVQFvQH0e4VRwLpJwOOMj+iHsnjh8ZV9iIccnBibfJLNYe56mkKjqaO72j1udrgDWo5g86CJ4acK7VvJWo2FNX+jyhqeTTwR8tHgT9rOfmsIefawB9k0hEJc+ODA5J6no1IPNh/Ti/vwdPlhUN+y6JHAatts5SLzejYV/ynrr0hilb0+46Svapjb9V3t6i7fskVta4GZJM2ddhRYjZgKzzCXVxh9ALian9IuDoYEq6eDzvvv99hM0PzitNTXb/U9By3X2N8ci+QNoWcKiJsf6KvS5Bv0BiGFw8xxprUBnmiirroRq8Xhvz693/Uo3q9Wmd2VkAM7HhdaVaqOWisNYUVNaY53AhUDHEYFNRmyM1I4di8yMEY9D1KCzNXSAqT89AC5208CS/5ROQCb1YXckyxi63L2QzYjxlgOAA2faFdruI15Hgh16p1q2QWmyt9NcWyXDHjbIIFedC4AjLjMnF2HHdLkD0CFUu0kZVaGKwzpBFq4WBT0mqeWFZwyWdkUIhZG1kp5AKvUqbVBM2cRuWVM+RZLnKlXaQZbYhCAQiJL25KbCLRE/lSQ4a0e+2teSZ21lR3AfhKVRM0XJcIi0iAjBqVzBUWlUIDeJXnrFTWGaVRwm3DiMOt5tKgWOpgCWdQI8wb2sD4cOy3BvCEXwl55Qqh9NlZTVc/wsQIC900yVX+e9Id862w31UTLLOkjLBKL5rRM2GzakJXeXuS+oeb6dtQiKx1UTdzpCoxG2R1lZg9zOjcewMWKcTsHZ+8JFHgCfv1b//DXgHXkmVq7qg1qTTki6bmGZUIo5N3aKtfcjLl8grrjFkiUjkL3oWAwR8zbn/92/8a9j3M0aTlWMqFd5xUk1wkdT050+sduZpyrUpx3bQuF2yP9nXOSjc6F/JqwI7lgiyCzg2BxIDfaVxnG2Qd31LDra7c1kBENigD+TWQqREr+0yAQSqc10KrauZWawPjN9fNO8C9HacpK1dyD9De1YDjTDrkLuDOtoOV1zakK3TyAroVg0CmVBvMHLFU86lt5o9XEhLIg7D2KeQyBHTEfppW8T7EpN9x/XVAYTYrQkb3vtUwBY0Lmk5JPV4KT05ngSxZN//4/cna6XbS8oRE3PBI8lJstAhjZTTzevoG9LVIwEtcWzh6jzrvRXGUiwS8ounfr+NvT16x6/3BMIpbotsDmHvv1ctvXnz/5gUCgxepQ9hoMBwMyR6mjC24bK3k+eS0kaVWIm5qAX9Xs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FtU7uajbuajbuajbuajbuajbuajbvk+V3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxkc1R+5qNu5qNu5qNu5qNu7MTruajbuajbuajbuajbuajbuajbuajbuajbuajRhM3kor2itzLigz0NdicUl9Z6uVHC/iKMOsv6Oz6PYWKfCtzpdL/PxzRUlMZxdxdM21wMgtShiMQ34bJjJdAaaGfeMC0fqnuH7sDpyCx1fyJDFBz404Jhzc2bedmHjy+s1pFEcTX22yUCklGvM5Jj7xucv9amVH0bfbKOdyVlFmVeTmXLrCHFk3n++K8vn8H630LMx7ayDsJvq5beC/uKmNA25vXa7gcln3d01bR3jEht54fhfL5fL/AAfnXNw=","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),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const 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:"eJztPNtyG7eSv4Kd2qrE3CFFUpLtaF9WyfFJvMcbq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsK4m9xTw44uDWaHQDfb+NLJ+Z6OgsOoWizLkFE13EUQom0aK0QsnoKDrNgIVm9o0Gjt/Z8clLxvNczQ2rDGjDrGIJNgJLKmNVIX7hkxyYDRPHbJ6JJGMG9DUwbtgkr6DUQlrDpkqzGUjQ3Ao5Y6lKqgKwYS5sxkoNKUyFhJQZq6vEVhrMgL0tlWSmShIwZlrl9UoODKFkzGwGBKgGW2lpGGeVFD9XwHq90PtSpL0esxm3LOGSTQC3k+JuPEDQAmfCsU1JmtiUkIipwM5+rsG5PJenojxib8tc8ZQtVKXZyZ/+XE+B8+K3s17vTzCpZuzty17v4svM2tIc7e3xshyoEqQRM5nziRkkqthLsWOZTp8gBkEDzkqwAjciXzCepmwu0hlYQzuWLFHlgiVK6VRIh/qSz4DJqpiANjHjMmWF0sCEZJxp4Omib1W/MsD+/c3r7/E4Cm4H7CSvTFwvlwoNic0XbnrEQNjVFw4zTw/wfIScxazgV3iQwrKfK5Fc4bYNSEKrPxPCVa/3pipLpS2k7Ee3haNeD1u+hlzNGddA/RNVFEqykmtegCVqwwPDZg0/V0JD6kiF53nAxdG57OM5L0o46vXYS5mKBJFBE+JXpqa+78B1RSRh1zf+YF3XFurw5B0RI07m3J1nmfPEgakBacKKa+hOfBOzBU78J5AqQJApLX5R0vKcjuMatBUJz9vHhgASoVmuiS9KJaQNX/0K7L/88eDp0aF4ukLQUkRWISS1GGDXPK/AeKjmMcsQqh+g1GCIvv28iEiZsgzELNu6Hk/fVcZ2JmaVQTDbUPi1wikReoHQNuW5ASamHVwW/ApaqzFFlxDPB+zrBUthyqvcxkwgxVldwYB9ryzjZZmLhG4bvEiQeTjeEX06ZU8OHhDJCzrjE62uRQp4JaRiOgWNzImNNIUfE6BDOitpAG6POMdmXDIlVw46UbnS6yREn7t4ZImSFqQdsONrLnIC3m3WMCGTvEqBTXKeXMV0T8ZMQ+oYdwF468aO3qkLXqYO54QfZiBHKlQS4ZfKLy9Mc2MN2GkmTMNP2BhQTYsI08aq59qpwpURBYHFGBRc5DEhLmbv1IRZYXOIkWFLLhcxS7mFmFm4sRN1E7Mkg+SK/tI8FYpNKmvxosY1U63KVM2lx+VUSWvELxs4MrS8P0bHMTuI2dOYPY/ZaBiz0Thmo4OYjZ7GbPQ8ZuNhzMbjmI0PYjZ+6sAaP/e45jWC2wCMxg7L9vPBLt67r4QhzsYL09R38LxzB48GrNeruQm//fTTT+fy9lwydh4hc51HR+w8qrucR7FrwzsT20b+9w3+2B8/8z8X+PPp+Ln/OaeuowP/M8Of49G5XPoFz+WYILG8KO+AApsfFQL/yxMRfqNF8Vu4z/AjXkRxaMCz6sCDDcv2XvZxL0IKK3hutm8n9PiEdtSAtLapA9wUkev2HVHzJ7SdNjzYQteka6JrtdUUGJ6gGK/t/nDgX5btm3fLfjJ7b4HzcVt/ilvHq+kUr6bt+69vr08ICaswfRwmng1IAKCbeTsefIdPCAtdiD4OB88RB/gobUcAtn5Cu2+Bgw3+hXdtw4P+6LA/Ho4POhhA3ch1KIp+mvYXi8VjYA9lHr88ijxBQnWSHaqhU62KDeoHaQdNLy8T0d9BZP8PFNQnQYaFFPW+rgYbNL62lG1VyhdfGDdVGFoLZ9i/Ec0WLTCpCeEg7TfJlEg88NgniGQTVPAGiIM+YXIvTfdamMSPadoviv7KR/zZJ8S3PhbFIE0HKz3XTsd9LFiaxmz988bvacqKotjy2X3vfN4rivVdDIrCw0bC11cDMj+QzLadT3yH34tVGo7oLnwnG6HlQMmc1iZ1bjMfrTw2mZC+wRMVW+mgYVblXMMN6qVGKOl6Pz6PBRZrJHvSY0kFJCuBQwX78rWX3p948sctdCfAL/ePW9sZTnLsDWZMwwxuWMmtBS1psmuei9TZ2/r0AW54UaIKsPfX8/P0X/55jwwQqONbhifBUjETaAfa++vZcf+/Lzb0qMoSdMINsBxwJRMzsMmAnWWQl40paj6fD+b7JsmUyp0d6p3RMHX/XqrJu0sCtxxwUz7ZtFNHGi2FH0lnVd83YDsY44aFkRtUfqIx4qHRkF5br+/c8dz6Hp/Qi7MCEjY66wk2n51HBSeBBEkZmr+VzUCfRxf1GKfkQ3rP2IsHMGsmUsj5BPL1pgczWv055wtVef4ORq3uVj1Ft/CGDYWQtd2CtjOMW438ZqXRtS038LdDSJs7w5MT2DOcAMuFCZabLjrbo71piwyOEpxpeAIsDGCTmko/mgtqwB7GBu4m8md3zxLYj1HH2qwYVrtnhc7BtBGDcxRCiqIqavvotJ41oKzwskcbXzgSnQZhhfbprq3Ab+5ZwZvttyxwLkdkxwj2jzskU9/jE7orVkC6m40/5BbpvNOP9MDez4BhW20G3PAsY1f3INfMZ7Zz34C9xucNbbJuEFrZkgRKixa5j2XNGuQHv1Bks2rb4bZTXrvXJ0R9G8D6jSnQ93vs1+eDiLS9+8+IUDtgP5hYnVGy4LM7NHdq/oTI08OzZoTo9U40TEWet1yKLHwKnh106UAOhXd7eWciPnVkCBfSKlQLgtt2AlPyl1pyo2S8cTi6d8Ydadsn6rzQSrOMGyd/k8CPR4UOW5tBsWKKD6A15nghA9x4KqPH0xvHXw3b5zR6etg5p8Nh55yG287pDrURT9CUSpra1gZNU4uv6YjD9/WnZZVtw6R4pC8k+laC9uCYQVV5ynJxRV6VVJgy5ws81cClHspVd903mVKm6eE9Zl/6DR91PXFKozPuyaB2TDzE4LVyGK2zGD3bbx3F4fPnXY7pMMxD9PdmvfVTGB7sjQ73nEVrs0GrMcNsv4TvkAQYe8h5kZ3oQedFPZsD25mdPtTs9Djkvv+YWvfo2bjzWOwPP/SxeHTlus0196jVj6E8P5oW22a3B+qvv5se+fHUd/BbSNSjZ/ttKnw2egQT6hbB+WMpcU0+fjTaY48lHG8iwAdIx3eKxB9NoG1gf3MiPXwcSXo07EhoX3UEtK/GbaI8PHwQUbYXXaGs80j859evf5gP//LtTB0fHx9//+Zt9uLt7Pj4uMDfg8FgoxK16bRpGZRcfUSgf5fpjd+yymAwQBSm3PIjGr5Xytm/uvHx9jED733+jSw7h4/hTNlgwPn4W6Du+sdZa347Pv84DmT+v3MZxZEqKaBYyZdpdBS54OQQqhvFpGKCsV+rdBEd3UY+fAz/9MFZOHTvncEg6NvIJBkUHP8KqimGTU9FjlNhBBRoE8URxRNgDDVSX3QUqck7SGwUo6+rRIMEGJyDxh3dhl4ubDaKvTAeHUWO+qM48h6f+hMDmSj04ZbpNFqGBe+aqv7STGXojzpuGefByNQPnIaGLlfCxj9opvYMywatzWRca76IViPUQ0hq8Ce6cXXMXb4Ij4SwaBKp4ySpWxRHwkLRXmXLoWn1/phOQOFOKNbofcfSsfDivdfEcWWm5AcN9OEgHzL0nZpcfhA54mBv/dhw1g88Hde6vnCXVI4xyBLSIBX3m2jhmFHE3uA+Sg39Cct81l7T+SjW1jzdFkXeCl41GanCvCyB6wEFc39wngClYvA8qSgbor6WOzurQa13NlrG0c39m7lhieqHEHX2ZQ5T61zKLFFagn7SjlP5ZDY3PjhYxtHi/u0tPsvtPcPDm9+/ux8ptr/Je/gjYN1/voyj7H5Yv6uzD/5AYA+eLps3dkWEuJyodHEZ7q3lfR3DY4b9MBfmpXytU9AtREyUyoHLNUy8nDrrvmJfoMbzRewCOShoXGgTHjI2RwO3hgQwAYXiu8Jdxbys4yLKmQ/kRafAC/xAYpqpJgZ7yTCfcRNOgFktZjNAm7fvQYN9WDxwSuqSPryET4OVr9RwLVRlAnhoCMfXJQe0bdsMhMvVEHLW1cpa2CFze3vvg/bp4Bd8XCXG0b8+PXkALkll7DOb1TH5bpduDvb69ARTccTUi38D9tbUmAio5Z0uDMUxdi14CNev7/aFc36Ds3sq2mzHRzDwSTB9tg5QKsxGiGKXdYd5AnXe3drETa4WHpGqLPochM9AMBZK08EjQVEj8lRVD6HKezDJ2ayiWEOLLBvycijcqEmlEdIl9JG+kVY6ZA95ssCemN3X4ClgBTu15o8ZSOOGczblxoKOMdUPMa8r1C7qKeGmBC1AJrARBRoc6i4rvVFe6+Kgm5fy9odXPkMv7CEw5QQ50E0MKatKohrihDpfKpzc6tbXBCXkDtCX2wTDddGDspq8KaQEbZREdUnpGZfiF0fCJJGgtjWBjOeuq78q0GSO8CCHd4EJd+2vf/9HC66tku46YG4FnqYYDHcPhKRSOoJHSV9DiTeg6kKE84H+t9VHAKEjprksVFozknk4jZ9Q+Jyp70Xvw6v9h6ZKMlQs6vvWxOGONV6sNKSjkiJLTsAS9ws3wthWxk+Iy12/H34AxGPSgoHEEORqpHm5aDN449dUK9NRXpLoZovVz+AaL/DKqksNhZAPe6faVjmr6ougsqrgViQsTGUG3RxA5/oJfF2wLwNoSI3XQuknW1gVp7tUMoFLIS/hGvQDBLzv6ziilC+QuO0cQLZhC0hyz1mTpzXH1NoOTlqvE2UjtqE8RPXAOW836S53K7CBHtxTQrm+xQSDCJwbGlmNLg7V6LBdZehz0aa8P3anS31GysZoOPz/rEvtDz8fXepg+BnpUs8RWG++vf8C2ibfbLw7gjn67gHvFDgLV6703T3RuruMa+P5JgQ37DBeuv8a9S/c+/eohE5nbMzJXp0JmyE0jIdD/N/KJdipdIHCbV0FI1/8UxQ/3JZ99xm4z2g9vwtZX2fj70wpiyRDnBVgTPcm3zDkng208SZkLiRcBqRcjofDy8PI4ftgE3LeqAJsRlIVytNzrbAgRZkDpjxYvWB8xoVkuLx+RFyB1vdR1ftBdhcSDobDy1GNhMN1JLyUFGhPxU9O1RXI33en7eWtWx5BvSnyhrUj4TpRe9TZbPu726SBpNLCLqKjs9vops9L0XftR2cXywukOpsp9PKUyhDE3GbRUbS35vSh6jPoUji7jUjFi8KVZ7hMMYph7drjpdi7Hg1G0TJeHbPxmryjP1T99x1iLJ8JObtv3EWDozd4ju6oOphqRMFS/AVQFvQH0e4VRwLpJwOOMj+iHsnjh8ZV9iIccnBibfJLNYe56mkKjqaO72j1udrgDWo5g86CJ4acK7VvJWo2FNX+jyhqeTTwR8tHgT9rOfmsIefawB9k0hEJc+ODA5J6no1IPNh/Ti/vwdPlhUN+y6JHAatts5SLzejYV/ynrr0hilb0+46Svapjb9V3t6i7fskVta4GZJM2ddhRYjZgKzzCXVxh9ALian9IuDoYEq6eDzvvv99hM0PzitNTXb/U9By3X2N8ci+QNoWcKiJsf6KvS5Bv0BiGFw8xxprUBnmiirroRq8Xhvz693/Uo3q9Wmd2VkAM7HhdaVaqOWisNYUVNaY53AhUDHEYFNRmyM1I4di8yMEY9D1KCzNXSAqT89AC5208CS/5ROQCb1YXckyxi63L2QzYjxlgOAA2faFdruI15Hgh16p1q2QWmyt9NcWyXDHjbIIFedC4AjLjMnF2HHdLkD0CFUu0kZVaGKwzpBFq4WBT0mqeWFZwyWdkUIhZG1kp5AKvUqbVBM2cRuWVM+RZLnKlXaQZbYhCAQiJL25KbCLRE/lSQ4a0e+2teSZ21lR3AfhKVRM0XJcIi0iAjBqVzBUWlUIDeJXnrFTWGaVRwm3DiMOt5tKgWOpgCWdQI8wb2sD4cOy3BvCEXwl55Qqh9NlZTVc/wsQIC900yVX+e9Id862w31UTLLOkjLBKL5rRM2GzakJXeXuS+oeb6dtQiKx1UTdzpCoxG2R1lZg9zOjcewMWKcTsHZ+8JFHgCfv1b//DXgHXkmVq7qg1qTTki6bmGZUIo5N3aKtfcjLl8grrjFkiUjkL3oWAwR8zbn/92/8a9j3M0aTlWMqFd5xUk1wkdT050+sduZpyrUpx3bQuF2yP9nXOSjc6F/JqwI7lgiyCzg2BxIDfaVxnG2Qd31LDra7c1kBENigD+TWQqREr+0yAQSqc10KrauZWawPjN9fNO8C9HacpK1dyD9De1YDjTDrkLuDOtoOV1zakK3TyAroVg0CmVBvMHLFU86lt5o9XEhLIg7D2KeQyBHTEfppW8T7EpN9x/XVAYTYrQkb3vtUwBY0Lmk5JPV4KT05ngSxZN//4/cna6XbS8oRE3PBI8lJstAhjZTTzevoG9LVIwEtcWzh6jzrvRXGUiwS8ounfr+NvT16x6/3BMIpbotsDmHvv1ctvXnz/5gUCgxepQ9hoMBwMyR6mjC24bK3k+eS0kaVWIm5qAX9Xs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FtU7uajbuajbuajbuajbuajbuajbvk+V3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxkc1R+5qNu5qNu5qNu5qNu7MTruajbuajbuajbuajbuajbuajbuajbuajbuajRhM3kor2itzLigz0NdicUl9Z6uVHC/iKMOsv6Oz6PYWKfCtzpdL/PxzRUlMZxdxdM21wMgtShiMQ34bJjJdAaaGfeMC0fqnuH7sDpyCx1fyJDFBz404Jhzc2bedmHjy+s1pFEcTX22yUCklGvM5Jj7xucv9amVH0bfbKOdyVlFmVeTmXLrCHFk3n++K8vn8H630LMx7ayDsJvq5beC/uKmNA25vXa7gcln3d01bR3jEht54fhfL5fL/AAfnXNw=",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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"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.p,{children:[(0,i.jsx)(n.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,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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded 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},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",description:"Allowed values - signature, stamp.",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)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(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.ed86382c.js b/assets/js/9c9cb35e.ed86382c.js deleted file mode 100644 index d31d01808..000000000 --- a/assets/js/9c9cb35e.ed86382c.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:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>y});const i=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":"eJztPNtyG7eSv4Kd2qrE3CFFUpLtaF9WyfFJvMcbq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsK4m9xTw44uDW3egGuhvdfRtZPjPR0Vl0CkWZcwsmuoijFEyiRWmFktFRdJoBC83sGw0cv7Pjk5eM57maG1YZ0IZZxRJsBJZUxqpC/MInOTAbJo7ZPBNJxgzoa2DcsEleQamFtIZNlWYzkKC5FXLGUpVUBWDDXNiMlRpSmAoJKTNWV4mtNJgBe1sqyUyVJGDMtMrrlRwYQsmY2QwIUA220tIwziopfq6A9Xqh96VIez1mM25ZwiWbAKKTIjYeIGiBM+HYpiRNbEpIxFRgZz/X4Fyey1NRHrG3Za54yhaq0uzkT3+up8B58dtZr/cnmFQz9vZlr3fxZWZtaY729nhZDlQJ0oiZzPnEDBJV7KXYsUynT5CCoAFnJViBG5EvGE9TNhfpDKwhjCVLVLlgiVI6FdKRvuQzYLIqJqBNzLhMWaE0MCEZZxp4uuhb1a8MsH9/8/p73I6C2wE7ySsT18ulQkNi84WbHikQsPrCUebpAe6PkLOYFfwKN1JY9nMlkitE24Aksvo9IVr1em+qslTaQsp+dCgc9XrY8jXkas64BuqfqKJQkpVc8wIscRtuGDZr+LkSGlLHKjzPAy2OzmUf93lRwlGvx17KVCRIDJoQvzI19X0HrisSCbu+8RvrurZIhzvvmBhpMuduP8ucJw5MDcgTVlxDd+KbmC1w4j+BVAGCTGnxi5KW57Qd16CtSHje3jYEkBjNck1yUSohbfjqV2D/5bcHd482xfMVgpYisQohqcUAu+Z5BcZDNY9ZhlD9AKUGQ/zt50VCypRlIGbZ1vV4+q4ytjMxqwyC2YbCrxV2icgLRLYpzw0wMe3QsuBX0FqNKTqEeD5gXy9YClNe5TZmAjnO6goG7HtlGS/LXCR02uBBgsLD8Yzo0y57dvCASF7QHp9odS1SwCMhFdMpaBRObKQp/JgAHfJZSQMQPZIcm3HJlFzZ6ETlSq+zEH3u0pElSlqQdsCOr7nICXiHrGFCJnmVApvkPLmK6ZyMmYbUCe4C8NSNHb9TFzxMHc2JPsxAjlyoJMIvlV9emObEGrDTTJhGnrAxkJoWEaZNVS+1U4UrIwmCiDEouMhjIlzM3qkJs8LmEKPAllwuYpZyCzGzcGMn6iZmSQbJFf2leSoUm1TW4kGNa6ZalamaS0/LqZLWiF82SGRoeX+KjmN2ELOnMXses9EwZqNxzEYHMRs9jdnoeczGw5iNxzEbH8Rs/NSBNX7uac1rArcBGI0dle3nQ108d18JQ5KNB6apz+B55wweDVivV0sTfvvpp5/O5e25ZOw8QuE6j47YeVR3OY9i14ZnJraN/O8b/LE/fuZ/LvDn0/Fz/3NOXUcH/meGP8ejc7n0C57LMUFieVHeAQU2PyoE/pdnIvxGi+K3cJ7hRzyI4tCAe9WBBxuWbVz2ERchhRU8N9vRCT0+IYwakNaQOkCkiF23Y0TNnxA6bXiwhY5J10THaqspCDxBMV7D/nDgb5btyLtlPxncW+B8HOpPEXU8mk7xaNqOf316fUJEWIXp4yjxbEAKAJ3M2+ngO3xCVOhC9HE0eI40wEtpOwGw9RPCvgUONvgb3rUND/qjw/54OD7oUABtI9ehKPpp2l8sFo9BPdR5/PKo8gQN1Wl2aIZOtSo2mB9kHTS9vE5EfweV/T9QUZ8EHRZStPu6Fmyw+NpatlUpX3xh3FRhaK2cYf9GNVu0wKQmhIOs3yRTIvHAY5+gkk3QwBsgDfpEyb003WtREj+mab8o+isf8WefCN/6WBSDNB2s9FzbHfexYGkas/XPG7+nKSuKYstn973zea8o1rEYFIWHjZSvrwbkfiCdbbuc+A6/l6g0EtFd+E4xQs+BkjmtTebcZjlauWwyIX2DZyq20kHDrMq5hhu0S41Q0vV+fBkLItZo9mTHkglIXgJHCvbla6+9P/Hsjyh0J8Av949bwwwnOfYOM6ZhBjes5NaCljTZNc9F6vxtffoAN7wo0QTY++v5efov/7xHDgi08S3DnWCpmAn0A+399ey4/98XG3pUZQk64QZYDriSiRnYZMDOMsjLxhU1n88H832TZErlzg/1zmiYun8v1eTdJYFbDrgpn2zC1LFGy+BH1lm19w3YDsW4YWHkBpOfeIxkaDSk29bbO3dct77HJ3TjrICEjc57gs1n51HBSSFBVobmb2Uz0OfRRT3GGfmQ3jP24gHCmokUcj6BfL3pwYJWf875QlVevoNTq4uq5+gW3bChELL2WxA6w7jVyG9WGl3bcoN8O4K0pTNcOUE8ww6wXJjguemSsz3au7bI4SjBuYYnwMIANqm59KOloAbsYWLgTiK/d/csgf0YdazdimG1e1bobEybMDhHIaQoqqL2j07rWQPJCq97tOmFI/HRIKzQ3t21FfjNPSt4t/2WBc7liPwYwf9xh2bqe3xCZ8UKSHeL8YecIp17+pEu2PsFMKDVFsAN1zJ2dRdyLXxmu/QN2Gu83tAn6wahly1JoLTokftY0axBfvANRT6rth9uO+e1e31C3LcBrN+YA32/x759PohJ29h/RozaAfvBzOqckgWf3WG5U/MnxJ4enjUnRK93omEq8rz1pMjCp/Cyg086kEPhn738YyJedeQIF9IqNAvCs+0EpvReaukZJePNg6O7Z9yWtt9E3Su00izjxunfpPDjVuGDrc2gWHHFB9Aad7yQAW7cldHj2Y3jr4btfRo9Pezs0+Gws0/Dbft0h9mIO2hKJU3ta4OmqSXXtMXh+/rVsiq2YVLc0hcS31aC9eCEQVV5ynJxRa8qqTBlzhe4q0FKPZSrz3XfZEqZpod/MfvSI3zUfYlTGh/jngzqh4mHOLxWNqO1F6Nn+62tOHz+vCsxHYF5iP3erLe+C8ODvdHhnvNobXZoNW6Y7YfwHZoAYw/ZL/ITPWi/qGezYTu304e6nR6H3fcf0+oePRt3Lov94YdeFo9uXLel5h6z+jGM50ezYtvi9kD79XezIz+e+w5+C4169Gy/zYXPRo/gQt2iOH8sJ67px4/Ge+yxlONNDPgA7fhOlfijGbQN7G/OpIePo0mPhh0N7auOgvbVuM2Uh4cPYsr2oiucdR6J//z69Q/z4V++nanj4+Pj79+8zV68nR0fHxf4ezAYbDSiNu02LYOaq48I9Pcy3fFbVhkMBkjClFt+RMP3Sjn7Vzc+3j5m4F+ffyPPzuFjPKZscOB8/ClQd/3jvDW/nZx/nAQy/9+5jOJIlRRQrOTLNDqKXHByCNWNYjIxwdivVbqIjm4jHz6Gf/rgLBy6985gEPRtZJIMCo5/BdMUw6anIsepMAIKtIniiOIJMIYauS86itTkHSQ2ivGtq0SHBBicg8Yd3YZeLmw2ir0yHh1FjvujOPIvPvUnBjJR+IZbptNoGRa8a6r6SzOVoT/quGWcByNTP3AaGrpcCRv/oJnaMywbsjaTca35IlqNUA8hqeE90Y2rY+7yRbgkhEWXSB0nSd2iOBIWivYqWzZNq/endAIKMaFYo/cdS9vCi/deE8eVmZIfNNB7ITbQ/IFUcq3rC3e37BiDHSEN2mm/idqNGUXODe7jmNCfsOWz9prurWBtzdNt0dytIFKTkUnKyxK4HlBQ9QfH61NKBM+TirIS6uOxg1kNao3ZaBlHN/cjc8MS1Q+h4uzLHKbWPe2yRGkJ+kk7XuSTQW58cLCMo8X96C0+S/Se4ebN78fuR4qxb/IP/ghY958v4yi7H9bv6iyAPxDYg6fL5q5bucovJypdXIZza3lfx3CpYD/MSXkpX+sUdIsQE6Vy4HKNEi+nzsuu2BdoeXwRu4AKCt4W2oQLhc3R0awhAUwEoTircFYxr3O4yG7mA2rROf8CP5C6ZKqJwV4yzGfchBNgVovZDND37HvQYB+eDpySq6QP8+DT4G0rNVwLVZkAHjqkMegvB/Qx2wyEy5kQcta1jlrUIbd3G/dBe3fwC15yEuPZX5+ePICWZLr1mc3q2HiHpZuDvT49wZQYMfVq2IC9NTUlAml5pwtDtYhdCx7C5uuzfeEeocH5HxUh2/HVD3wySp+tA5QKsxGi2GW/Ybx+nf+2NnGTM4VbpCqLvn/hMwGMhdJ06EhQ1IQ8VdVDuPIeSnI2qyjmz6LIhvwYCvtpUlqEdIl1pPenlQ5ZPJ4tsCdm2TV0ClTBTq35YwbSuOGcTbmxoGNMuUPK6wq1/HpKuClBC5AJbCSBBke6y0pv1Ju6NOjmh7z94ZXPlAs4BKGcoAS6iSFlVUlcQ5JQ5y2FnVtFfU1RQukAfblNQVtXPSi7yLskStBGSTRblJ5xKX5xLEwaCVo9E8h47rr6owJd1wgPSngXmHDW/vr3f7Tg2qpxrgPmVuBpikFp90BIpp1jeNS4NZR4AqouRDgf6H9bvQQQOhKay0KltSCZh/P4CYWxmfpc9G9p9TueqZIMFfz6vDVxOGONVysN2YpkUNJjXIn4wo0wtpV5E+Jj18+HHwDpmLRgIDUEpRp5Xi7aAt68L6qV6Sg/SHSztuprcE0WeGXVpYZCyIfdU23vmFX1QVBZVXArEhamMoNuLp57gglyXbAvA2jIjddC6SdbRBWnu1QygUshL+Ea9AMUvO/reJ6UL5C57RxAtmELRHLXWZMvNccU1w5NWrcTZQW2oTxE88A9om6yXe42JAM/uKuEcm6LCT7mu+dgFDU6OFRjS3aNoc/FmvLvojtb6jMyNkbD4f9nW2p/+PnYUgfDz8iWeo7Aejfq/QfQNv1m49kR3MJ3D3inyGlDDt27e6KXdRnXTuxNBG7EYbx0/zXmXzj37zEJnc3YuHW9OROQITKMh0P838oh2Kk4gcptXY0iX/xTFD/cp3z3HrjP6MW+i1hfZ+PvTCmLJEOaFWBM9yTfMOQeBNp0EzIXEi4DUS7Hw+HlYeTofbCJOG9UATYjrQr16blWWBiizAFTD6xeMD7jQjJcXj8irUDr+7jq/SC7iwgHw+HlqCbC4ToRXkoKeKciJKfqCuTvi2l7eeuWR1BvirwR7Ui4TtQedZBtf3dIGkgqLewiOjq7jW76vBR91350drG8QK6zmcLXllIZgpjbLDqK9tYeX6gKDLr2z24jMvGicOQZLlOMJlg79ngp9q5Hg1G0jFfHbDwm7+gPVf99hxjLZ0LO7ht30dDoDe6j26oOpRpVsBR/AdQF/Ua0e8WRQP7JgKPOj6RH9vihebJ6ETY5PCZteh9qNnP1xSc8+HTecFavqw2vMq1HmbPwIkKPHPUbR9QgFNXvEPhnrQufNSxbO/GD3jkihW18cECazbMRqQD7z+l2PXi6vHAEbnntKDi07XpycRAdH4r/1PUpRNGKDd8xpFft6K027RaT1i+5YrrVgGyymA47hsoGaoWLtksrjBRAWu0PiVYHQ6LV82HnjvcYNjM0NzVdx/VtTFdu+8bFa/UC+U/IqSLm9Rz1ugT5Bh1eeLgQ869pZpAnqqgLXPR6Ycivf/9HParXq+1i5+nDIIrXlWalmoPGuk5YvWKaw41A4w+HQUFthp70KPSZFzkYg+980sLMFW3CRDj0snk/TsJLPhG5wNPThfdSnGDrADYD9mMG+PSOTV9olxd4DTkeurX53CpPxeZKX02xBFbMOJtg8Rt0oIDMuEycr8adBORzQOMR/WClFgZr+miEWjjYlLSaJ5YVXPIZOQ1i1iZWCrnA45JpNUFXplF55Zx1lotcaRfVRQjRszsR8cVNiU2kXqKXS0OGvHvtPXYmdh5TJ+S+KtQEndMlwiISIMdFJXOFBZzQyV3lOSuVdY5n1GLbMOJwq7k0qHo6WMIe1ATzzjQwPvT5rQHc4VdCXrmiI312VvPVjzAxwkI3JXFV/p50x3wr7HfVBEsaKSOs0otm9EzYrJrQcd2epP7hZvo2FP1qHcbNHKlKzAZ9XCVmD7Mn996ARQ4xe8cnL+m6f8J+/dv/sFfAtWSZmjtuTSoN+aKpL0bluGjnHdnq25rctbzCml6WmFTOwgtCoOCPGbe//u1/Dfse5ui2ciLlQilOqkkukrp2m+n1jlz9tlZVtm4KlQtsRx86Z6UbnQt5NWDHckFeP/fUgMyA32lcBw3ygG+pl1ZXSWsgIj+TgfwayJ2IVXQmwCAV7mVCq2rmVmsD45HrxvgjbsdpysqVOH/0aTXgOLcNPQlw57/BKmcbUgM6Mfjd6jwgU6rDZY5YqvnUNvPHK8H/9Eqw9inkDQRyxH6aVqE8pKTHuP46oJCWFUWie95qmILGBU2nfB0vhWens8CWrJvr+/5s7ew3aXlCamy4JHkpNnp9sQqZeT19A/paJOC1qi0SvUed96I4ykUC3pj099fxtyev2PX+YBjFLfXsAcK99+rlNy++f/MCgcGD1BFsNBgNhuTzUsYWXLZW8nJy2uhLK9EttRK/q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4htSuPuKuPuKuPuKuPuKuPuKuPuIuUX1XH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH/FR3ZG7+oi7+oi7+oi7+og7t9OuPuKuPuKuPuKuPuKuPuKuPuKuPuKuPuKuPiIGk7fSivbKnAvK/vP1Vlzi3tlq1cSLOMows+/oLLq9RQ58q/PlEj//XFES09lFHF1zLTByi5IC45DDholMV7DA2GoXiNY/xfVjt+EUPL6SC4lJeG7EMdHgzr7t5MOT129Oozia+MqOhUopmZjPMfGJz13uVys7ir7dRjmXs4oyqyI359IV38i6OXtXlLPn/2ilZ3G5aEHYTeZzaOC/iNTGAbe3Lh9wuaz7u6atIzxhQ2/cv4vlcvl/xbMsUQ==","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 s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"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:"eJztPNtyG7eSv4Kd2qrE3CFFUpLtaF9WyfFJvMcbq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsK4m9xTw44uDW3egGuhvdfRtZPjPR0Vl0CkWZcwsmuoijFEyiRWmFktFRdJoBC83sGw0cv7Pjk5eM57maG1YZ0IZZxRJsBJZUxqpC/MInOTAbJo7ZPBNJxgzoa2DcsEleQamFtIZNlWYzkKC5FXLGUpVUBWDDXNiMlRpSmAoJKTNWV4mtNJgBe1sqyUyVJGDMtMrrlRwYQsmY2QwIUA220tIwziopfq6A9Xqh96VIez1mM25ZwiWbAKKTIjYeIGiBM+HYpiRNbEpIxFRgZz/X4Fyey1NRHrG3Za54yhaq0uzkT3+up8B58dtZr/cnmFQz9vZlr3fxZWZtaY729nhZDlQJ0oiZzPnEDBJV7KXYsUynT5CCoAFnJViBG5EvGE9TNhfpDKwhjCVLVLlgiVI6FdKRvuQzYLIqJqBNzLhMWaE0MCEZZxp4uuhb1a8MsH9/8/p73I6C2wE7ySsT18ulQkNi84WbHikQsPrCUebpAe6PkLOYFfwKN1JY9nMlkitE24Aksvo9IVr1em+qslTaQsp+dCgc9XrY8jXkas64BuqfqKJQkpVc8wIscRtuGDZr+LkSGlLHKjzPAy2OzmUf93lRwlGvx17KVCRIDJoQvzI19X0HrisSCbu+8RvrurZIhzvvmBhpMuduP8ucJw5MDcgTVlxDd+KbmC1w4j+BVAGCTGnxi5KW57Qd16CtSHje3jYEkBjNck1yUSohbfjqV2D/5bcHd482xfMVgpYisQohqcUAu+Z5BcZDNY9ZhlD9AKUGQ/zt50VCypRlIGbZ1vV4+q4ytjMxqwyC2YbCrxV2icgLRLYpzw0wMe3QsuBX0FqNKTqEeD5gXy9YClNe5TZmAjnO6goG7HtlGS/LXCR02uBBgsLD8Yzo0y57dvCASF7QHp9odS1SwCMhFdMpaBRObKQp/JgAHfJZSQMQPZIcm3HJlFzZ6ETlSq+zEH3u0pElSlqQdsCOr7nICXiHrGFCJnmVApvkPLmK6ZyMmYbUCe4C8NSNHb9TFzxMHc2JPsxAjlyoJMIvlV9emObEGrDTTJhGnrAxkJoWEaZNVS+1U4UrIwmCiDEouMhjIlzM3qkJs8LmEKPAllwuYpZyCzGzcGMn6iZmSQbJFf2leSoUm1TW4kGNa6ZalamaS0/LqZLWiF82SGRoeX+KjmN2ELOnMXses9EwZqNxzEYHMRs9jdnoeczGw5iNxzEbH8Rs/NSBNX7uac1rArcBGI0dle3nQ108d18JQ5KNB6apz+B55wweDVivV0sTfvvpp5/O5e25ZOw8QuE6j47YeVR3OY9i14ZnJraN/O8b/LE/fuZ/LvDn0/Fz/3NOXUcH/meGP8ejc7n0C57LMUFieVHeAQU2PyoE/pdnIvxGi+K3cJ7hRzyI4tCAe9WBBxuWbVz2ERchhRU8N9vRCT0+IYwakNaQOkCkiF23Y0TNnxA6bXiwhY5J10THaqspCDxBMV7D/nDgb5btyLtlPxncW+B8HOpPEXU8mk7xaNqOf316fUJEWIXp4yjxbEAKAJ3M2+ngO3xCVOhC9HE0eI40wEtpOwGw9RPCvgUONvgb3rUND/qjw/54OD7oUABtI9ehKPpp2l8sFo9BPdR5/PKo8gQN1Wl2aIZOtSo2mB9kHTS9vE5EfweV/T9QUZ8EHRZStPu6Fmyw+NpatlUpX3xh3FRhaK2cYf9GNVu0wKQmhIOs3yRTIvHAY5+gkk3QwBsgDfpEyb003WtREj+mab8o+isf8WefCN/6WBSDNB2s9FzbHfexYGkas/XPG7+nKSuKYstn973zea8o1rEYFIWHjZSvrwbkfiCdbbuc+A6/l6g0EtFd+E4xQs+BkjmtTebcZjlauWwyIX2DZyq20kHDrMq5hhu0S41Q0vV+fBkLItZo9mTHkglIXgJHCvbla6+9P/Hsjyh0J8Av949bwwwnOfYOM6ZhBjes5NaCljTZNc9F6vxtffoAN7wo0QTY++v5efov/7xHDgi08S3DnWCpmAn0A+399ey4/98XG3pUZQk64QZYDriSiRnYZMDOMsjLxhU1n88H832TZErlzg/1zmiYun8v1eTdJYFbDrgpn2zC1LFGy+BH1lm19w3YDsW4YWHkBpOfeIxkaDSk29bbO3dct77HJ3TjrICEjc57gs1n51HBSSFBVobmb2Uz0OfRRT3GGfmQ3jP24gHCmokUcj6BfL3pwYJWf875QlVevoNTq4uq5+gW3bChELL2WxA6w7jVyG9WGl3bcoN8O4K0pTNcOUE8ww6wXJjguemSsz3au7bI4SjBuYYnwMIANqm59KOloAbsYWLgTiK/d/csgf0YdazdimG1e1bobEybMDhHIaQoqqL2j07rWQPJCq97tOmFI/HRIKzQ3t21FfjNPSt4t/2WBc7liPwYwf9xh2bqe3xCZ8UKSHeL8YecIp17+pEu2PsFMKDVFsAN1zJ2dRdyLXxmu/QN2Gu83tAn6wahly1JoLTokftY0axBfvANRT6rth9uO+e1e31C3LcBrN+YA32/x759PohJ29h/RozaAfvBzOqckgWf3WG5U/MnxJ4enjUnRK93omEq8rz1pMjCp/Cyg086kEPhn738YyJedeQIF9IqNAvCs+0EpvReaukZJePNg6O7Z9yWtt9E3Su00izjxunfpPDjVuGDrc2gWHHFB9Aad7yQAW7cldHj2Y3jr4btfRo9Pezs0+Gws0/Dbft0h9mIO2hKJU3ta4OmqSXXtMXh+/rVsiq2YVLc0hcS31aC9eCEQVV5ynJxRa8qqTBlzhe4q0FKPZSrz3XfZEqZpod/MfvSI3zUfYlTGh/jngzqh4mHOLxWNqO1F6Nn+62tOHz+vCsxHYF5iP3erLe+C8ODvdHhnvNobXZoNW6Y7YfwHZoAYw/ZL/ITPWi/qGezYTu304e6nR6H3fcf0+oePRt3Lov94YdeFo9uXLel5h6z+jGM50ezYtvi9kD79XezIz+e+w5+C4169Gy/zYXPRo/gQt2iOH8sJ67px4/Ge+yxlONNDPgA7fhOlfijGbQN7G/OpIePo0mPhh0N7auOgvbVuM2Uh4cPYsr2oiucdR6J//z69Q/z4V++nanj4+Pj79+8zV68nR0fHxf4ezAYbDSiNu02LYOaq48I9Pcy3fFbVhkMBkjClFt+RMP3Sjn7Vzc+3j5m4F+ffyPPzuFjPKZscOB8/ClQd/3jvDW/nZx/nAQy/9+5jOJIlRRQrOTLNDqKXHByCNWNYjIxwdivVbqIjm4jHz6Gf/rgLBy6985gEPRtZJIMCo5/BdMUw6anIsepMAIKtIniiOIJMIYauS86itTkHSQ2ivGtq0SHBBicg8Yd3YZeLmw2ir0yHh1FjvujOPIvPvUnBjJR+IZbptNoGRa8a6r6SzOVoT/quGWcByNTP3AaGrpcCRv/oJnaMywbsjaTca35IlqNUA8hqeE90Y2rY+7yRbgkhEWXSB0nSd2iOBIWivYqWzZNq/endAIKMaFYo/cdS9vCi/deE8eVmZIfNNB7ITbQ/IFUcq3rC3e37BiDHSEN2mm/idqNGUXODe7jmNCfsOWz9prurWBtzdNt0dytIFKTkUnKyxK4HlBQ9QfH61NKBM+TirIS6uOxg1kNao3ZaBlHN/cjc8MS1Q+h4uzLHKbWPe2yRGkJ+kk7XuSTQW58cLCMo8X96C0+S/Se4ebN78fuR4qxb/IP/ghY958v4yi7H9bv6iyAPxDYg6fL5q5bucovJypdXIZza3lfx3CpYD/MSXkpX+sUdIsQE6Vy4HKNEi+nzsuu2BdoeXwRu4AKCt4W2oQLhc3R0awhAUwEoTircFYxr3O4yG7mA2rROf8CP5C6ZKqJwV4yzGfchBNgVovZDND37HvQYB+eDpySq6QP8+DT4G0rNVwLVZkAHjqkMegvB/Qx2wyEy5kQcta1jlrUIbd3G/dBe3fwC15yEuPZX5+ePICWZLr1mc3q2HiHpZuDvT49wZQYMfVq2IC9NTUlAml5pwtDtYhdCx7C5uuzfeEeocH5HxUh2/HVD3wySp+tA5QKsxGi2GW/Ybx+nf+2NnGTM4VbpCqLvn/hMwGMhdJ06EhQ1IQ8VdVDuPIeSnI2qyjmz6LIhvwYCvtpUlqEdIl1pPenlQ5ZPJ4tsCdm2TV0ClTBTq35YwbSuOGcTbmxoGNMuUPK6wq1/HpKuClBC5AJbCSBBke6y0pv1Ju6NOjmh7z94ZXPlAs4BKGcoAS6iSFlVUlcQ5JQ5y2FnVtFfU1RQukAfblNQVtXPSi7yLskStBGSTRblJ5xKX5xLEwaCVo9E8h47rr6owJd1wgPSngXmHDW/vr3f7Tg2qpxrgPmVuBpikFp90BIpp1jeNS4NZR4AqouRDgf6H9bvQQQOhKay0KltSCZh/P4CYWxmfpc9G9p9TueqZIMFfz6vDVxOGONVysN2YpkUNJjXIn4wo0wtpV5E+Jj18+HHwDpmLRgIDUEpRp5Xi7aAt68L6qV6Sg/SHSztuprcE0WeGXVpYZCyIfdU23vmFX1QVBZVXArEhamMoNuLp57gglyXbAvA2jIjddC6SdbRBWnu1QygUshL+Ea9AMUvO/reJ6UL5C57RxAtmELRHLXWZMvNccU1w5NWrcTZQW2oTxE88A9om6yXe42JAM/uKuEcm6LCT7mu+dgFDU6OFRjS3aNoc/FmvLvojtb6jMyNkbD4f9nW2p/+PnYUgfDz8iWeo7Aejfq/QfQNv1m49kR3MJ3D3inyGlDDt27e6KXdRnXTuxNBG7EYbx0/zXmXzj37zEJnc3YuHW9OROQITKMh0P838oh2Kk4gcptXY0iX/xTFD/cp3z3HrjP6MW+i1hfZ+PvTCmLJEOaFWBM9yTfMOQeBNp0EzIXEi4DUS7Hw+HlYeTofbCJOG9UATYjrQr16blWWBiizAFTD6xeMD7jQjJcXj8irUDr+7jq/SC7iwgHw+HlqCbC4ToRXkoKeKciJKfqCuTvi2l7eeuWR1BvirwR7Ui4TtQedZBtf3dIGkgqLewiOjq7jW76vBR91350drG8QK6zmcLXllIZgpjbLDqK9tYeX6gKDLr2z24jMvGicOQZLlOMJlg79ngp9q5Hg1G0jFfHbDwm7+gPVf99hxjLZ0LO7ht30dDoDe6j26oOpRpVsBR/AdQF/Ua0e8WRQP7JgKPOj6RH9vihebJ6ETY5PCZteh9qNnP1xSc8+HTecFavqw2vMq1HmbPwIkKPHPUbR9QgFNXvEPhnrQufNSxbO/GD3jkihW18cECazbMRqQD7z+l2PXi6vHAEbnntKDi07XpycRAdH4r/1PUpRNGKDd8xpFft6K027RaT1i+5YrrVgGyymA47hsoGaoWLtksrjBRAWu0PiVYHQ6LV82HnjvcYNjM0NzVdx/VtTFdu+8bFa/UC+U/IqSLm9Rz1ugT5Bh1eeLgQ869pZpAnqqgLXPR6Ycivf/9HParXq+1i5+nDIIrXlWalmoPGuk5YvWKaw41A4w+HQUFthp70KPSZFzkYg+980sLMFW3CRDj0snk/TsJLPhG5wNPThfdSnGDrADYD9mMG+PSOTV9olxd4DTkeurX53CpPxeZKX02xBFbMOJtg8Rt0oIDMuEycr8adBORzQOMR/WClFgZr+miEWjjYlLSaJ5YVXPIZOQ1i1iZWCrnA45JpNUFXplF55Zx1lotcaRfVRQjRszsR8cVNiU2kXqKXS0OGvHvtPXYmdh5TJ+S+KtQEndMlwiISIMdFJXOFBZzQyV3lOSuVdY5n1GLbMOJwq7k0qHo6WMIe1ATzzjQwPvT5rQHc4VdCXrmiI312VvPVjzAxwkI3JXFV/p50x3wr7HfVBEsaKSOs0otm9EzYrJrQcd2epP7hZvo2FP1qHcbNHKlKzAZ9XCVmD7Mn996ARQ4xe8cnL+m6f8J+/dv/sFfAtWSZmjtuTSoN+aKpL0bluGjnHdnq25rctbzCml6WmFTOwgtCoOCPGbe//u1/Dfse5ui2ciLlQilOqkkukrp2m+n1jlz9tlZVtm4KlQtsRx86Z6UbnQt5NWDHckFeP/fUgMyA32lcBw3ygG+pl1ZXSWsgIj+TgfwayJ2IVXQmwCAV7mVCq2rmVmsD45HrxvgjbsdpysqVOH/0aTXgOLcNPQlw57/BKmcbUgM6Mfjd6jwgU6rDZY5YqvnUNvPHK8H/9Eqw9inkDQRyxH6aVqE8pKTHuP46oJCWFUWie95qmILGBU2nfB0vhWens8CWrJvr+/5s7ew3aXlCamy4JHkpNnp9sQqZeT19A/paJOC1qi0SvUed96I4ykUC3pj099fxtyev2PX+YBjFLfXsAcK99+rlNy++f/MCgcGD1BFsNBgNhuTzUsYWXLZW8nJy2uhLK9EttRK/q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4htSuPuKuPuKuPuKuPuKuPuKuPuIuUX1XH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH/FR3ZG7+oi7+oi7+oi7+og7t9OuPuKuPuKuPuKuPuKuPuKuPuKuPuKuPuKuPiIGk7fSivbKnAvK/vP1Vlzi3tlq1cSLOMows+/oLLq9RQ58q/PlEj//XFES09lFHF1zLTByi5IC45DDholMV7DA2GoXiNY/xfVjt+EUPL6SC4lJeG7EMdHgzr7t5MOT129Oozia+MqOhUopmZjPMfGJz13uVys7ir7dRjmXs4oyqyI359IV38i6OXtXlLPn/2ilZ3G5aEHYTeZzaOC/iNTGAbe3Lh9wuaz7u6atIzxhQ2/cv4vlcvl/xbMsUQ==",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={},y=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.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.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)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",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:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.b0d1b7a3.js b/assets/js/9cd612ce.b75be620.js similarity index 77% rename from assets/js/9cd612ce.b0d1b7a3.js rename to assets/js/9cd612ce.b75be620.js index 0aec144e2..e41578926 100644 --- a/assets/js/9cd612ce.b0d1b7a3.js +++ b/assets/js/9cd612ce.b75be620.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>u,default:()=>P,frontMatter:()=>D,metadata:()=>n,toc:()=>b});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+T87MvT7y9P2RlupG3CDseH4ymTnA1US7Nj6avd9+TDybbeLlJ/7PHZDWDCe5o4LVXcfmJA625tuRHD2zHdvjtniahsIGav13y5fvR6s2Hy+wY970azRCykVzLjGX2zFoUK/LsYHpbPBvLpD90b9RU8+YR90ud+kzC8RiykbvhLJOIOV3sP5s1sk/TLBLvV8k/yHB3tSD5aSvc2u69Oz0+vTkUiuCXu7zF3cY/pfrCBJx3bX3BaH/gvb1tPCqzX7Y602QznW9azEl2M/WnO0myz2fwP+criCg==","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 s=o(74848),a=o(28453),l=o(33617),i=o.n(l),r=o(17543),d=o.n(r),p=o(86013),c=o.n(p),y=o(63723),m=o.n(y),f=(o(18766),o(79329),o(9303));const D={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+T87MvT7y9P2RlupG3CDseH4ymTnA1US7Nj6avd9+TDybbeLlJ/7PHZDWDCe5o4LVXcfmJA625tuRHD2zHdvjtniahsIGav13y5fvR6s2Hy+wY970azRCykVzLjGX2zFoUK/LsYHpbPBvLpD90b9RU8+YR90ud+kzC8RiykbvhLJOIOV3sP5s1sk/TLBLvV8k/yHB3tSD5aSvc2u69Oz0+vTkUiuCXu7zF3cY/pfrCBJx3bX3BaH/gvb1tPCqzX7Y602QznW9azEl2M/WnO0myz2fwP+criCg==",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,v={},b=[];function x(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,s.jsx)(i(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,s.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{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,s.jsx)(c(),{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:{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 P(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file +"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.68a5f06c.js b/assets/js/ac7da374.4a1b8c9b.js similarity index 82% rename from assets/js/ac7da374.68a5f06c.js rename to assets/js/ac7da374.4a1b8c9b.js index fd029d9dd..f38eb6e75 100644 --- a/assets/js/ac7da374.68a5f06c.js +++ b/assets/js/ac7da374.4a1b8c9b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>y,contentTitle:()=>g,default:()=>D,frontMatter:()=>u,metadata:()=>a,toc:()=>h});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+uLlgZ3iQdgk7nZ5O50xyNlAtzcjS0aPveLdt93Dq/+qN2G92wieaOS1VhFYxU9seE93vnoQiEen4ebhIRGUDMct2yzf3J6/blsm/NOgZfC0SsZJeySUDgPutyFXg3/numffZHH3zY/9ifAVf99J8MaABvxgGLyupG/4SiXjEzdGTt120yQBi2OOO4zzL0NFI9hkgPkCV7y6uLm4vRCJ4FB/ip8eIn/ofbOBF1w6BVecD/2WU96LAdtths7bd8XdHn5XoYxy4OU+Ltm3/BcUq8Dc=","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),m=i(86013),r=i.n(m),c=i(63723),f=i.n(c),v=(i(18766),i(79329),i(9303));const u={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+uLlgZ3iQdgk7nZ5O50xyNlAtzcjS0aPveLdt93Dq/+qN2G92wieaOS1VhFYxU9seE93vnoQiEen4ebhIRGUDMct2yzf3J6/blsm/NOgZfC0SsZJeySUDgPutyFXg3/numffZHH3zY/9ifAVf99J8MaABvxgGLyupG/4SiXjEzdGTt120yQBi2OOO4zzL0NFI9hkgPkCV7y6uLm4vRCJ4FB/ip8eIn/ofbOBF1w6BVecD/2WU96LAdtths7bd8XdHn5XoYxy4OU+Ltm3/BcUq8Dc=",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,y={},h=[];function S(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(v.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)(v.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)(r(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(f(),{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 D(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(S,{...e})}):S(e)}}}]); \ No newline at end of file +"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.fc3ba422.js b/assets/js/b2e6bd40.fc3ba422.js deleted file mode 100644 index 61d489111..000000000 --- a/assets/js/b2e6bd40.fc3ba422.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:()=>v,contentTitle:()=>h,default:()=>q,frontMatter:()=>b,metadata:()=>i,toc:()=>y});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":"eJztWM1uIzcSfpUKL5MIbcmenb0IjhGvdzAxdpAxxg6MhccQqO5qNWM2yfBHslYQkMO+wZ5yzaPNkyyK7D/Jykwmg90FFrkYcpFVrPqqWPU1N8zzhWPTO/ZXnYcalXfsPmMFutwK44VWbMreokNVgMUfAzoPNRcSvIbg0EKpLTixUEItoGhMjN8pljFt0HKycFl0NhoTZIFlrPnvL7pYs+mG5Vp5VJ5+cmOkyKP25AdHTmyYyyusOf0iPWGxILfbM2eiYBnDaPk+Y35tkE2Znv+AuWcZM5bc8QIdGRgqTTftZuetUAuy8shrI0lkrF6KArvIQBRs2x5zQHMXt1Y7AhVRK62uI1xoHUFo8egJtAm93gfS/qb5d5zrunNg5kIK76OOXATnm4O5Dxa786IdaOyAUODx0U8qX0tKbM39GC64AqFyGQqEUkupV5TqJbeCzyU6gM2mg9MLL3G7hc2GokI7U7zG7TbrBXTejsBUWjVbLOYoljtanQh7xU42UMVHI+x6VnDfCHJdG67WQwdSkc6CbewoTZvHO1jvOQ4Vdy1WWMBaB0oaWToQdZ+XeVPQn5UUMvJHRtipOftWHHDldGLOTs3ZLUKlDYKvhGuAK4UqXMzVCqUcw6nzVqvF2R4Ep5NGfjjJFpcCV8BVkfLdW9nHtjM0bnz6uw52kFbhILchFzw2TWN1jljASvgKfIWg8NGD82gccAfCp25aCowxWOALixh7D/nCg6+0Ff+IrbE98JRDZbH8+tkeps/Orsn1Ci2eTvhZs/uyjDFWfInA1Rpi4EIrB9qCIt/KYH2FFnLJrSibPpyBkcgdArVpnvvofEK09eOm4urBZadze3aDvIY3BhV58P6fv9AOtt1mLILGpszGedBfly0t9o3d24BR4IxWLnXt58fHsXnv3CKW/fa58eGhYNEFebCZpot3eEKkBkrpcSHP0bkySLke78QqlBQKZ20ws+fHx7OTYwp5m7EX/9mo0FptPzWoa12jr6irrCiyFZX3h0N6cXw8e95F9OJpREf9DFXaQ6mDKkCUw8lKN4XWcm0t5sQijtLo3FFohmqRltKVbxRNLKo4x9KMBSmcB92fEkfr/xLZAyBouxflx5B+MTvpkP7zU6Qv1ZJLUcD51SXc6AdUX/wXYu4jHB7v0/Hk6mMdCRP13hhU3BTX2U6wQ3kK0mEerPBrNr3bsMcjbsRRWp/e3W/vM0alqoliGu2ix9xXbMomfYdhZMQu0bpoI1jJpqzy3rjpZOK4Kub6cawNKqoayeeOaNaEGzFZnoxP2Dbb1+HGfNJ+DEefquI8Xwi1+JjefY/PNeUwpWkHpS5Z3Ii/4ZplbRKGuzImqHYq5AXamDAqjbc9QX/ZJniPPR+kyB1Dfkpen3DXz+Ncu5TrD7bw/8QWqCZLHQu4aQ/tlthc4gXYJ9W3KHNdI2FHJ45GA6ud1mjUVWtC5p16p94EC0av0JZBRvBKiY9iLjGqYR3XXFePyGuJzkni6B4XlnuEQiyE57L7Hs654XMhBXVP2qabHPUN2I3htsII31qHZxaBQ4FLlNR0KX265n74aQ0rbR9KqVcuAw7z4IRC5wBVxVVOG9tukFF+uAJUHq2xwiE4b8lrkXzTyltKTM0VX8SSyYYpgAIl3SAHVs+D8+C0DCnxngupLRbQBkRl4CKILx8NLQFJifBbrKh1LREWQRToMsh1geBiP6AQVAFz+uYx5IvIMX4VByV1/hATSGwKjKbZRVdClzs+krq3XDkaucmXNgcdYPEKOYfJwdHoe4eU4ddCPbjpaEQk466rq1ucO+Hx/su2Da9Wqyft96tdnVfCfxvm8BaNdsJru+61F8JXYR5b9tBI90+y9AoVxvoZNOTeRqFz93QCkHRSoTSTa/RUIW5yfnUZx/1X8P6nf8Fr5FZBpVepWvNgUa5h0R5FyKXMJ9i6aR0fdKhvEOJ5Kr6m3bUI3lbcv//pZwff4Yq4VrpSFMpodBXmUuRwg7WR3KMbjaZwYZGO9K0MfMU95FzBHMFVnEppKThwMElbCvUwhnO1TsSoa34kj3o7YcSG26bbwZw7LECrqNGeOe49InntUC7RkS1iXXMELAS1c19ZHRbptKEzTXAWSyEl3IpigT7Gdl4URDujeJXEBPjAHSzpQvgK18Bt7IF+DFd7KnElGKMteSGS8/23ParCaKG8m0Jheel7+1lf6DnBHFvvE1GCkHdwZI2ZLiXpJjYRd9L0ErVHJnb7rcUSLR0Yw+7zYkRTTndtWQJV6+eUNQ2EZppEKtowDG7EN/t2IqVEW7s35TXapcixYVa/cqMncfOEZUyKHJXDAVU9f3X1GpZ/Gh+zbEDRfsPlnry+vHj53fVLcoYaaQLsZHwyPiYRsdWaq8FJB55Z9+fb4JH0d77KNlwwvioZyUWk3zGuTcOc7wbf5vSUWhGtnt6xzYau1vdEFUj8Y0BLnPw+Y+3TU2TkWUsiiWo/ILGyi+Tz0Q2dTdtlSHx070OEWHDSOM9zNP6De4fM/+rN9Q3LWPvuVusiPjHwFT0y81X6oNYRw/SpT7INk1wtAl/Q3mSTeC/1vl3S/BBJc/ODomqX1Hrg4S6bTmHQXwrqoMJmkwh5ZLFpf1r6VY0G2HY35e5+u93+G9tajmM=","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),p=n(17543),d=n.n(p),l=n(86013),c=n.n(l),u=n(63723),m=n.n(u),f=(n(18766),n(79329),n(9303));const b={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:"eJztWM1uIzcSfpUKL5MIbcmenb0IjhGvdzAxdpAxxg6MhccQqO5qNWM2yfBHslYQkMO+wZ5yzaPNkyyK7D/Jykwmg90FFrkYcpFVrPqqWPU1N8zzhWPTO/ZXnYcalXfsPmMFutwK44VWbMreokNVgMUfAzoPNRcSvIbg0EKpLTixUEItoGhMjN8pljFt0HKycFl0NhoTZIFlrPnvL7pYs+mG5Vp5VJ5+cmOkyKP25AdHTmyYyyusOf0iPWGxILfbM2eiYBnDaPk+Y35tkE2Znv+AuWcZM5bc8QIdGRgqTTftZuetUAuy8shrI0lkrF6KArvIQBRs2x5zQHMXt1Y7AhVRK62uI1xoHUFo8egJtAm93gfS/qb5d5zrunNg5kIK76OOXATnm4O5Dxa786IdaOyAUODx0U8qX0tKbM39GC64AqFyGQqEUkupV5TqJbeCzyU6gM2mg9MLL3G7hc2GokI7U7zG7TbrBXTejsBUWjVbLOYoljtanQh7xU42UMVHI+x6VnDfCHJdG67WQwdSkc6CbewoTZvHO1jvOQ4Vdy1WWMBaB0oaWToQdZ+XeVPQn5UUMvJHRtipOftWHHDldGLOTs3ZLUKlDYKvhGuAK4UqXMzVCqUcw6nzVqvF2R4Ep5NGfjjJFpcCV8BVkfLdW9nHtjM0bnz6uw52kFbhILchFzw2TWN1jljASvgKfIWg8NGD82gccAfCp25aCowxWOALixh7D/nCg6+0Ff+IrbE98JRDZbH8+tkeps/Orsn1Ci2eTvhZs/uyjDFWfInA1Rpi4EIrB9qCIt/KYH2FFnLJrSibPpyBkcgdArVpnvvofEK09eOm4urBZadze3aDvIY3BhV58P6fv9AOtt1mLILGpszGedBfly0t9o3d24BR4IxWLnXt58fHsXnv3CKW/fa58eGhYNEFebCZpot3eEKkBkrpcSHP0bkySLke78QqlBQKZ20ws+fHx7OTYwp5m7EX/9mo0FptPzWoa12jr6irrCiyFZX3h0N6cXw8e95F9OJpREf9DFXaQ6mDKkCUw8lKN4XWcm0t5sQijtLo3FFohmqRltKVbxRNLKo4x9KMBSmcB92fEkfr/xLZAyBouxflx5B+MTvpkP7zU6Qv1ZJLUcD51SXc6AdUX/wXYu4jHB7v0/Hk6mMdCRP13hhU3BTX2U6wQ3kK0mEerPBrNr3bsMcjbsRRWp/e3W/vM0alqoliGu2ix9xXbMomfYdhZMQu0bpoI1jJpqzy3rjpZOK4Kub6cawNKqoayeeOaNaEGzFZnoxP2Dbb1+HGfNJ+DEefquI8Xwi1+JjefY/PNeUwpWkHpS5Z3Ii/4ZplbRKGuzImqHYq5AXamDAqjbc9QX/ZJniPPR+kyB1Dfkpen3DXz+Ncu5TrD7bw/8QWqCZLHQu4aQ/tlthc4gXYJ9W3KHNdI2FHJ45GA6ud1mjUVWtC5p16p94EC0av0JZBRvBKiY9iLjGqYR3XXFePyGuJzkni6B4XlnuEQiyE57L7Hs654XMhBXVP2qabHPUN2I3htsII31qHZxaBQ4FLlNR0KX265n74aQ0rbR9KqVcuAw7z4IRC5wBVxVVOG9tukFF+uAJUHq2xwiE4b8lrkXzTyltKTM0VX8SSyYYpgAIl3SAHVs+D8+C0DCnxngupLRbQBkRl4CKILx8NLQFJifBbrKh1LREWQRToMsh1geBiP6AQVAFz+uYx5IvIMX4VByV1/hATSGwKjKbZRVdClzs+krq3XDkaucmXNgcdYPEKOYfJwdHoe4eU4ddCPbjpaEQk466rq1ucO+Hx/su2Da9Wqyft96tdnVfCfxvm8BaNdsJru+61F8JXYR5b9tBI90+y9AoVxvoZNOTeRqFz93QCkHRSoTSTa/RUIW5yfnUZx/1X8P6nf8Fr5FZBpVepWvNgUa5h0R5FyKXMJ9i6aR0fdKhvEOJ5Kr6m3bUI3lbcv//pZwff4Yq4VrpSFMpodBXmUuRwg7WR3KMbjaZwYZGO9K0MfMU95FzBHMFVnEppKThwMElbCvUwhnO1TsSoa34kj3o7YcSG26bbwZw7LECrqNGeOe49InntUC7RkS1iXXMELAS1c19ZHRbptKEzTXAWSyEl3IpigT7Gdl4URDujeJXEBPjAHSzpQvgK18Bt7IF+DFd7KnElGKMteSGS8/23ParCaKG8m0Jheel7+1lf6DnBHFvvE1GCkHdwZI2ZLiXpJjYRd9L0ErVHJnb7rcUSLR0Yw+7zYkRTTndtWQJV6+eUNQ2EZppEKtowDG7EN/t2IqVEW7s35TXapcixYVa/cqMncfOEZUyKHJXDAVU9f3X1GpZ/Gh+zbEDRfsPlnry+vHj53fVLcoYaaQLsZHwyPiYRsdWaq8FJB55Z9+fb4JH0d77KNlwwvioZyUWk3zGuTcOc7wbf5vSUWhGtnt6xzYau1vdEFUj8Y0BLnPw+Y+3TU2TkWUsiiWo/ILGyi+Tz0Q2dTdtlSHx070OEWHDSOM9zNP6De4fM/+rN9Q3LWPvuVusiPjHwFT0y81X6oNYRw/SpT7INk1wtAl/Q3mSTeC/1vl3S/BBJc/ODomqX1Hrg4S6bTmHQXwrqoMJmkwh5ZLFpf1r6VY0G2HY35e5+u93+G9tajmM=",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,v={},y=[];function I(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["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 q(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.a0b3573e.js b/assets/js/b93339ed.bc214206.js similarity index 78% rename from assets/js/b93339ed.a0b3573e.js rename to assets/js/b93339ed.bc214206.js index 23bede688..12a3043e1 100644 --- a/assets/js/b93339ed.a0b3573e.js +++ b/assets/js/b93339ed.bc214206.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>I,default:()=>g,frontMatter:()=>j,metadata:()=>d,toc:()=>w});const d=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/Pj+TI8jrTzDVeTmw4e1Q87224/jv0qL/C+0Xu89wsjuQgjVrB3149HwxuSJSzdP75XCau187S921HufbKy62j55xYtDWCrhK25FTyjFn6zY4Vw9LkYX9dftfObj/0D9hU8+Y5/EvMwsSgaV9ZctuEtmbA73B78atCtumQYWghW3H8dLz+6Ii17+UfzL01dUeIsz9H4Z89OB86LT1csYVn/G0ATfmVglm/oZwm+iVB14CKMY2FtxyRXVcsrOhtV0phFVfpwRrsLM1r/gYx6kozD4S1aQX/JpicFdrs4/3XdeD5ufVWi53U4TZ5ZdV33L6Z8b6s=","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 s=o(74848),a=o(28453),i=o(33617),n=o.n(i),l=o(17543),r=o.n(l),p=o(86013),c=o.n(p),m=o(63723),u=o.n(m),f=(o(18766),o(79329),o(9303));const j={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/Pj+TI8jrTzDVeTmw4e1Q87224/jv0qL/C+0Xu89wsjuQgjVrB3149HwxuSJSzdP75XCau187S921HufbKy62j55xYtDWCrhK25FTyjFn6zY4Vw9LkYX9dftfObj/0D9hU8+Y5/EvMwsSgaV9ZctuEtmbA73B78atCtumQYWghW3H8dLz+6Ii17+UfzL01dUeIsz9H4Z89OB86LT1csYVn/G0ATfmVglm/oZwm+iVB14CKMY2FtxyRXVcsrOhtV0phFVfpwRrsLM1r/gYx6kozD4S1aQX/JpicFdrs4/3XdeD5ufVWi53U4TZ5ZdV33L6Z8b6s=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},I=void 0,h={},w=[];function P(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,s.jsx)(n(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,s.jsx)(f.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:"bK1cfd2hpb"}}]}),"\n",(0,s.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,s.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:"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 g(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 +"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/c195e1f1.0541c66c.js b/assets/js/c195e1f1.0541c66c.js new file mode 100644 index 000000000..effca4e26 --- /dev/null +++ b/assets/js/c195e1f1.0541c66c.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:()=>b,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>f});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":"eJztW19vG7m1/yq88+LEGEuy4+zdGrlBvUnurtFgbSTODQrL0HJmjjR0ZsgpyZGsNQT0od+gT33tR9tPUpxDzgxHli07u0B7Wy8WuxaH5Dk8/3j4O+RNZPnMREcX0VuV1iVIa6LLOMrApFpUVigZHUXnObA3GrgF1vRiU61KZqGsCmw+PjthvCjUwrClqplVbAYSNH6SsGBZMzdLluyqNpZVWs1FJuSsnWMiMiakscAzpqasrgrFqQOnKaaigGdCMpsDmypdYp+EG/jmkCnNEiG5Xj5nMAe9ZFaUQHxIgAyZSR3zvGVkwM49WYOzMQ0V9siKJasNZETNsJRLloAfnbkl1wY0E9KCnvIUGLfsYnf3LST1jH062d29fJZbW5mj4ZBX1UBVII2YyYInZpCqcphhxyqbPkema0Pr74R7HohzMJZj+UdVExNOWsAymPK6sGzOi5rEgEJnC5HNAGXLkXVFMhKaSV5C77upq0ppy+A6hcoyZIzbWkPMjOVlFTMhhRW8MDETJZ/BYCz3B2x3F0ouit3dsfzpp5/G8mYsGRtHOPs4OmLjiD6Po9i1a+CZksUSv015YcC3e9aDIb+Ha15WBaBgxtFYrjyBsTxAqkjgbqLur8fQvFLQp/ICqVyphJ0LW9xDCrtY7PI4eimoPr1DpJeqsuJyeTc13+GR8nSSZNXcssJmfbovkW7G7T1LxK+Po7i/vzd6uXcwOnjZJ/YNErNwbRN1fTc93+FxJMslw3F9ev9NQs0h/XIvwabHYyhejCNFEXDvYBxddkT3UJyu29HuLmt8NOdzYEoCenapNDCbc0kNzlttzi0FJIMRKQFmoIAU40qybBybnP5b0pdWVaYW8h6d+R6PE6Jb0X5fiL9DippnQrGktlbdQ5V6/QYkd3fPNExFUbDPLjqhKJumJmBxDQwKcDsHyQ9bhDSgUW5CWhXEdJbAFOUuLBOGmZxryNhC2JxxitoDdiqLJcXbdgiFdqVZzg2rQJfCGIEBVDGeZdi1JJWgyjWYSkkDjlEXj3GuQLsmV3WR4WZS4N6AX+FaGIthvhk+cKt/L4zFLWwtNtOqGjmgFva3+9Mmd3K06COXmYYFS6AX/g4eGhRuzcjG0ehwuP9yeDA6OAynfPHVrtjNfTGOSk6Rlo2jKbi/A987fKSl+l4baTWkutkpUtLWd/e09HmzpMX/fXf6YTH6w/czdXx8fPzjx0/5u0+z4+PjEn8PBgNPy0/9zVf7ebiGRkjdKqI4UhXmXkLJkyw6inz+4m0ePaLJuUQWxVHFNS/BgsY08IYoR0dRkJZFcSQwDay4zaP13FAlV5DaE8rZmvwliiMNf6qFhiw6srqGODJ2WeC0RuBGFcURXFeFyiA6cnEjMmkOJY+ObiK7rKin1ULOojjCbI/bsMVvd8jSD/tJnh7kVRKtVpeOLBj7ncqWOFWqpAVp8U9eVYVISSjDK4Os3wQ0O3YvIsyLUBiXccOKWyOKSqNkrQBDjGJS8FiOfwzSYZdW3BLpsWQuZvKCtcphpoJUTJdNykhDKQXEXxIWxbJNVLss92TKVCmshSx2o7yGfvnz34yfYoERNwGX9/a2omgVt8LoVsm15ks0CQtl2H6HkLTaLKNOIsdpqmorubRIkFLDe4VKHcIJrhSEuSTO4oz4PqpXCjAmYucqV3JL7/2DF/jvi33s71O0x2q+OQzgFFcqmXyV+WQwx/F+2/h6tWwXkN9UJrTkZqMPhiRKFcBlOIZceRU32//98/t0LlHX0WoVN860FqyCKDT56Exx0qx99ahhRGSqigw0BsX7OCO7B5lN1m2xW/L6+ViYwFP7B2Hvt2yRg81BU/OCS8to9i4ZxHCgmPe3AcMzd/+4JwxmzrqGcUSO3SUfCn/0WAj6Mi4zJhXbIXoTU5NB7Az970Rly51upEu6HM8CQ4lngTq34cP0osZg3LMCJNs4ckNuk8D7MnxTG6tKRmT8IIpu7SmV+dg+YG+4ZEKmRe0zsKlCgWNgZDc3jQk491qt2M0N6hL0BE1+tYq7BqTVa6BA4Fo0pCDmvVFtE3QD27ZgKFxXQi8nmD65Bh8vQgbETAo5m9TazyMVdh70zHCNccpRvQwga61LzOSGVbeRlPT7YOnfErbXO07yHyP3V9XrH8QGVl4Nq9evqtefgeWqAudxTjxTITPn7wsoigF7ZaxWcvZ6TQSvhr59syo1zAUsyF1Jq90s67JtJxp4nv6o6tBThGGprlPBC5y30iqF5ijkkoVry4yFyjBu8LhEYpkKoDVoxmca6NBFvPDa5kqLnyl1agi+4izXMP2fnTWZ7rzGcMty0PBqyF/73idTWiOdkLlcMlq4UNLgWZkwummtKTimBddi6vO0mFUFcAMM0zieWmLeSbTh4zzn8ouJXyX69Tnwkp1WIJGDX/7yd+zRRPITeaoz0A8I5SdTZoAi8Q7GsZ2YqebQOBXaWB+gXfzzFuL4usN1PKZWLAfsXRvwTZ0Y7CWb+bqAarWYzQCPrr4HDY6d9oCnudsqiCs+xViP1Cs0HlWbhj00MDT/AtDAHB7oFTVg37VJXswC6dCpOVz7YENUR2j1XL3xU7/lyzDXkHWZgL4lU4JjEYX1o1jGlwapUcqJH3iR1gR8Oh9m6MO4q5E5NtYfZkYtpZa//ZcY8iRPCjg9P3uApnFBbM+5sUu3nQ7cHOz0/IzNoTPGAftkWj01iue9LixVGbC54E71MVvkIiWXW7ISQW+QpC8ftUMgYuDgE7bHbjOUCbORo9glGhh/a2Jt08QsExpSWyzJgFRtEdgQ/nBBMWCwKYNzQjhX9UN8ZoskOZvVIiNN17rd00GbOKgCIPKv69RFhazWzTHHG60LYsZ0cmqkgp2C+WMG0rjhnE25saBjVksC7HVdoTc0U8J1BVqATGGjCILQvX3/xGyN8Hbl8rIKtFESw5vSMy599ERsfpErgyePnBeuqw8ThiWAXKF3DzaeG375y9+jjq87z0m3GXMUeJZpMGYLh4RjOXNCUBOhrCWzqs8Rzgf69+vVDeSOTHJSqqw1U/NwCzpDBM6aNiZ6GK6FAE2d5rhltbHWhDULKmKYGJeEBwsqhKgK19uCcA3aJu7yvg+AckwDHqjogz6DFiWXoft00KRam44OBMK41jCJ32hpWGzarknEmUu+bGtBOLcvgIHEyJOxs7f/S5Url01sACHxnBtEUTf81tmH11ZNNJRCPmzP/Og2DVKiVa3b11aV3IqUNVOZAfNdnbitCr24ZM8aUaF3zIXSzzeKy003UTKFiZATKvlt34R+pGa0Btp9ErALABny1ijNba0OLkLeFjlI1pNJsFPiontc4jZUOfx20yn8tk7D+l5jn27jwC9QJgjLOGQbXZ8CY3NOvHWs/9W4gPu6zRaP0cshczZt2N6tWuJgC4zRnvwRfpzBdvVhHMOeTHo9ym539WJr4HdeVcD1AKMYwx3n6+qzvbSkPWoPtiQhqzi63r6Ya5aqPaUzIXHyZwVMLaurCvNfpSXo5y7quAX+6yxuNFrF0QNcbfn/cnkvcHWL7av7LDKbd6Wbfwqvh8hrvp3XH0DMcvtPZvZbZNblhb8lMOlgSVcK2Qr1Oti2UPr+nlgBIJhQWiN+3hiWOnc4WLl/OhCyift3A5OTEJkkaIYm6FdLgoWRSA5GI/xfX7VveyVMTGvrFDPkaV0Uy/+K4ofXPu7XR1PfeSxQnV+Jg5+v0/nBWVNGqHXx9fvS9rLAJoh57ZYJctLn4mFL8c5R62LPqj1cy16b69G0gb6FLISESaPASabSSbN67FeCMf0d70E8tOqm039f11vIR85IDzdZUYDMyB06G3bFd49DYRKM+XJzNwkhG2XblKXpwgtFCbbDmIRmWPihkWTmv5k9gtabvfg+6Z05HMmAratuJW7ibRI8HI0maSfElxuEKOe8EBldgjtXX0D+hu5353K7xYXkrSOPrF6XRRdPI+E60feot9qw3S3SQFprYZdUDr7e45XYc9+PLi6xyFqCzRUWlitliGOsCx9Fw36oG94EsW4V4bR63hSZyQtbxzJcZom6vr3z8EoM5/sDLEGtj9m4U93TH+q9xw4xls+EnG0bd9lJ7CNq1SmuJ7cu6lXiD4De4NUS9vJV9hw4HrtQEWgsH7qK9rtG5W3peXM1ua3ZXjTl17DG2pZYb9VNW66a2mhbGg3qn0H5s6to9gqaVKMMSpThnYKmpBhWFP0FgLZo2KsMksF1Zbso6pfm3OWCtVLTr6uc9AsnT9WAf6NqwFoxwBnPJkR7/2UPS/YWGoKiza2VECTsIXXrQN2doNkdmJkn4LAhNPs1VMZ/3wyGvOxhEKEn+jjU+Fdz/N6nc+v+aEQHvBcjOgkdjuiQ8e2ol773fTkKk3DKtNtEm7LpMJnGjPkS45qQUxVGsUZPtIVRUL116IIiVa6KgGrf3Q1U247a3W1joTNPvGp1WmtWqQXoaV2QBU8LuBaI6+AwKOlbV6wHXhZgTLGkO94zusGeiZmwCJd74DjlFU9EIXCPdpcQnaN027wZsM9duX9H09VzmEOBW3uLjMlZF7sXSn+Z4rWBmHGW4M1wxGpB5lymDhZ2OwzBm4gLIaBdaYFZjdXItXC8KWk1ekfJJZ+R38ahH7AMCgxjhmmVYE3CqKJ23me5KJR2FRlaEF1WJSG+w8ta2p0cMfxryNGK5x56N7ErfRjaS3AJEjEruubPUytSIIy0loVKv7haWl0UrFLW1bfwgBryiMOt5tLQRX9XBPI6aAXmCwJg/IXKTwZQw++F/IJ3SfHO5kVrV58hMcJCd85dLBa3tvTn/THfC/tDnbAPUCkjrNLLbvRM2LxOKA0IJ2l/uJm+b15ABJt8N0emUrPhqK1SM8yhqIYfwaKFmOHx2Qkllc/ZL3/+K3sPXEuWq4Wz1rTWUCy7xxYoOad5J7Y2J3SPBWqbo8RT7q+kUuhtJPg555buhWFSIaR3KXf59axOCpF2jyZ2d4+aRwvdnRCqHfg3E/76LRbDOKvc6ELILwN2LJfuEUW7A2E7jestg3a94OFI8LihpRk+40AI2UAxd+828IiSAINMuAKoVvXMUQuZ8Yvr30TGtR1nGavWbiMjXN2x4xBZqu1xB83awcYLzL2bvf1rEyCzSglpzRHLNJ/abv547Yoy7X+3mprbzY04Yj9NqxLniX7Fbau7r7OWoPbjrYYpUOXV9N7y8Ep4c7pozJKhtf4as3bQDG3pwUEfM+WNBSYLujSn04+g5yJtTud3ePSQOg+jOCpECh4n8vvX8fdn79n8xWAUxUHa/wDnHr4/efPux4/vkBkMpE5g+4PRYERwtjK25DKgtPHlVHBVtif54M7q07Orp2dXT8+unp5dPT27enp29fTs6unZ1dOzq3/1Z1cBuDKsCi5kUHByIPnFWj0wiqOj8KXVZRzlCKofXUQ3N5hYfEIcDZv/VBOyc3EZR3OuBSJRBOj4GzRZgKPekU4+++CrjM/ZHY+2NvLfINcSYWvyOodHfYHl2jOx1SVWpR18jay5Hm8cA3vnOE83w62iCOLvbsRxionSvX3DKsTZ6cfzKI6ai+4lvSqLNF8gNsUXjtsAwKK2m6jgclYT+BW5OVfu6lPeh+u/EFzv/wgQtL48+ji+Wwb+Fxe1ccDNjSsFEODs+rtPd47wgm16o3IuV6vVPwDClwzW","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),p=n(86013),c=n.n(p),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:"eJztW19vG7m1/yq88+LEGEuy4+zdGrlBvUnurtFgbSTODQrL0HJmjjR0ZsgpyZGsNQT0od+gT33tR9tPUpxDzgxHli07u0B7Wy8WuxaH5Dk8/3j4O+RNZPnMREcX0VuV1iVIa6LLOMrApFpUVigZHUXnObA3GrgF1vRiU61KZqGsCmw+PjthvCjUwrClqplVbAYSNH6SsGBZMzdLluyqNpZVWs1FJuSsnWMiMiakscAzpqasrgrFqQOnKaaigGdCMpsDmypdYp+EG/jmkCnNEiG5Xj5nMAe9ZFaUQHxIgAyZSR3zvGVkwM49WYOzMQ0V9siKJasNZETNsJRLloAfnbkl1wY0E9KCnvIUGLfsYnf3LST1jH062d29fJZbW5mj4ZBX1UBVII2YyYInZpCqcphhxyqbPkema0Pr74R7HohzMJZj+UdVExNOWsAymPK6sGzOi5rEgEJnC5HNAGXLkXVFMhKaSV5C77upq0ppy+A6hcoyZIzbWkPMjOVlFTMhhRW8MDETJZ/BYCz3B2x3F0ouit3dsfzpp5/G8mYsGRtHOPs4OmLjiD6Po9i1a+CZksUSv015YcC3e9aDIb+Ha15WBaBgxtFYrjyBsTxAqkjgbqLur8fQvFLQp/ICqVyphJ0LW9xDCrtY7PI4eimoPr1DpJeqsuJyeTc13+GR8nSSZNXcssJmfbovkW7G7T1LxK+Po7i/vzd6uXcwOnjZJ/YNErNwbRN1fTc93+FxJMslw3F9ev9NQs0h/XIvwabHYyhejCNFEXDvYBxddkT3UJyu29HuLmt8NOdzYEoCenapNDCbc0kNzlttzi0FJIMRKQFmoIAU40qybBybnP5b0pdWVaYW8h6d+R6PE6Jb0X5fiL9DippnQrGktlbdQ5V6/QYkd3fPNExFUbDPLjqhKJumJmBxDQwKcDsHyQ9bhDSgUW5CWhXEdJbAFOUuLBOGmZxryNhC2JxxitoDdiqLJcXbdgiFdqVZzg2rQJfCGIEBVDGeZdi1JJWgyjWYSkkDjlEXj3GuQLsmV3WR4WZS4N6AX+FaGIthvhk+cKt/L4zFLWwtNtOqGjmgFva3+9Mmd3K06COXmYYFS6AX/g4eGhRuzcjG0ehwuP9yeDA6OAynfPHVrtjNfTGOSk6Rlo2jKbi/A987fKSl+l4baTWkutkpUtLWd/e09HmzpMX/fXf6YTH6w/czdXx8fPzjx0/5u0+z4+PjEn8PBgNPy0/9zVf7ebiGRkjdKqI4UhXmXkLJkyw6inz+4m0ePaLJuUQWxVHFNS/BgsY08IYoR0dRkJZFcSQwDay4zaP13FAlV5DaE8rZmvwliiMNf6qFhiw6srqGODJ2WeC0RuBGFcURXFeFyiA6cnEjMmkOJY+ObiK7rKin1ULOojjCbI/bsMVvd8jSD/tJnh7kVRKtVpeOLBj7ncqWOFWqpAVp8U9eVYVISSjDK4Os3wQ0O3YvIsyLUBiXccOKWyOKSqNkrQBDjGJS8FiOfwzSYZdW3BLpsWQuZvKCtcphpoJUTJdNykhDKQXEXxIWxbJNVLss92TKVCmshSx2o7yGfvnz34yfYoERNwGX9/a2omgVt8LoVsm15ks0CQtl2H6HkLTaLKNOIsdpqmorubRIkFLDe4VKHcIJrhSEuSTO4oz4PqpXCjAmYucqV3JL7/2DF/jvi33s71O0x2q+OQzgFFcqmXyV+WQwx/F+2/h6tWwXkN9UJrTkZqMPhiRKFcBlOIZceRU32//98/t0LlHX0WoVN860FqyCKDT56Exx0qx99ahhRGSqigw0BsX7OCO7B5lN1m2xW/L6+ViYwFP7B2Hvt2yRg81BU/OCS8to9i4ZxHCgmPe3AcMzd/+4JwxmzrqGcUSO3SUfCn/0WAj6Mi4zJhXbIXoTU5NB7Az970Rly51upEu6HM8CQ4lngTq34cP0osZg3LMCJNs4ckNuk8D7MnxTG6tKRmT8IIpu7SmV+dg+YG+4ZEKmRe0zsKlCgWNgZDc3jQk491qt2M0N6hL0BE1+tYq7BqTVa6BA4Fo0pCDmvVFtE3QD27ZgKFxXQi8nmD65Bh8vQgbETAo5m9TazyMVdh70zHCNccpRvQwga61LzOSGVbeRlPT7YOnfErbXO07yHyP3V9XrH8QGVl4Nq9evqtefgeWqAudxTjxTITPn7wsoigF7ZaxWcvZ6TQSvhr59syo1zAUsyF1Jq90s67JtJxp4nv6o6tBThGGprlPBC5y30iqF5ijkkoVry4yFyjBu8LhEYpkKoDVoxmca6NBFvPDa5kqLnyl1agi+4izXMP2fnTWZ7rzGcMty0PBqyF/73idTWiOdkLlcMlq4UNLgWZkwummtKTimBddi6vO0mFUFcAMM0zieWmLeSbTh4zzn8ouJXyX69Tnwkp1WIJGDX/7yd+zRRPITeaoz0A8I5SdTZoAi8Q7GsZ2YqebQOBXaWB+gXfzzFuL4usN1PKZWLAfsXRvwTZ0Y7CWb+bqAarWYzQCPrr4HDY6d9oCnudsqiCs+xViP1Cs0HlWbhj00MDT/AtDAHB7oFTVg37VJXswC6dCpOVz7YENUR2j1XL3xU7/lyzDXkHWZgL4lU4JjEYX1o1jGlwapUcqJH3iR1gR8Oh9m6MO4q5E5NtYfZkYtpZa//ZcY8iRPCjg9P3uApnFBbM+5sUu3nQ7cHOz0/IzNoTPGAftkWj01iue9LixVGbC54E71MVvkIiWXW7ISQW+QpC8ftUMgYuDgE7bHbjOUCbORo9glGhh/a2Jt08QsExpSWyzJgFRtEdgQ/nBBMWCwKYNzQjhX9UN8ZoskOZvVIiNN17rd00GbOKgCIPKv69RFhazWzTHHG60LYsZ0cmqkgp2C+WMG0rjhnE25saBjVksC7HVdoTc0U8J1BVqATGGjCILQvX3/xGyN8Hbl8rIKtFESw5vSMy599ERsfpErgyePnBeuqw8ThiWAXKF3DzaeG375y9+jjq87z0m3GXMUeJZpMGYLh4RjOXNCUBOhrCWzqs8Rzgf69+vVDeSOTHJSqqw1U/NwCzpDBM6aNiZ6GK6FAE2d5rhltbHWhDULKmKYGJeEBwsqhKgK19uCcA3aJu7yvg+AckwDHqjogz6DFiWXoft00KRam44OBMK41jCJ32hpWGzarknEmUu+bGtBOLcvgIHEyJOxs7f/S5Url01sACHxnBtEUTf81tmH11ZNNJRCPmzP/Og2DVKiVa3b11aV3IqUNVOZAfNdnbitCr24ZM8aUaF3zIXSzzeKy003UTKFiZATKvlt34R+pGa0Btp9ErALABny1ijNba0OLkLeFjlI1pNJsFPiontc4jZUOfx20yn8tk7D+l5jn27jwC9QJgjLOGQbXZ8CY3NOvHWs/9W4gPu6zRaP0cshczZt2N6tWuJgC4zRnvwRfpzBdvVhHMOeTHo9ym539WJr4HdeVcD1AKMYwx3n6+qzvbSkPWoPtiQhqzi63r6Ya5aqPaUzIXHyZwVMLaurCvNfpSXo5y7quAX+6yxuNFrF0QNcbfn/cnkvcHWL7av7LDKbd6Wbfwqvh8hrvp3XH0DMcvtPZvZbZNblhb8lMOlgSVcK2Qr1Oti2UPr+nlgBIJhQWiN+3hiWOnc4WLl/OhCyift3A5OTEJkkaIYm6FdLgoWRSA5GI/xfX7VveyVMTGvrFDPkaV0Uy/+K4ofXPu7XR1PfeSxQnV+Jg5+v0/nBWVNGqHXx9fvS9rLAJoh57ZYJctLn4mFL8c5R62LPqj1cy16b69G0gb6FLISESaPASabSSbN67FeCMf0d70E8tOqm039f11vIR85IDzdZUYDMyB06G3bFd49DYRKM+XJzNwkhG2XblKXpwgtFCbbDmIRmWPihkWTmv5k9gtabvfg+6Z05HMmAratuJW7ibRI8HI0maSfElxuEKOe8EBldgjtXX0D+hu5353K7xYXkrSOPrF6XRRdPI+E60feot9qw3S3SQFprYZdUDr7e45XYc9+PLi6xyFqCzRUWlitliGOsCx9Fw36oG94EsW4V4bR63hSZyQtbxzJcZom6vr3z8EoM5/sDLEGtj9m4U93TH+q9xw4xls+EnG0bd9lJ7CNq1SmuJ7cu6lXiD4De4NUS9vJV9hw4HrtQEWgsH7qK9rtG5W3peXM1ua3ZXjTl17DG2pZYb9VNW66a2mhbGg3qn0H5s6to9gqaVKMMSpThnYKmpBhWFP0FgLZo2KsMksF1Zbso6pfm3OWCtVLTr6uc9AsnT9WAf6NqwFoxwBnPJkR7/2UPS/YWGoKiza2VECTsIXXrQN2doNkdmJkn4LAhNPs1VMZ/3wyGvOxhEKEn+jjU+Fdz/N6nc+v+aEQHvBcjOgkdjuiQ8e2ol773fTkKk3DKtNtEm7LpMJnGjPkS45qQUxVGsUZPtIVRUL116IIiVa6KgGrf3Q1U247a3W1joTNPvGp1WmtWqQXoaV2QBU8LuBaI6+AwKOlbV6wHXhZgTLGkO94zusGeiZmwCJd74DjlFU9EIXCPdpcQnaN027wZsM9duX9H09VzmEOBW3uLjMlZF7sXSn+Z4rWBmHGW4M1wxGpB5lymDhZ2OwzBm4gLIaBdaYFZjdXItXC8KWk1ekfJJZ+R38ahH7AMCgxjhmmVYE3CqKJ23me5KJR2FRlaEF1WJSG+w8ta2p0cMfxryNGK5x56N7ErfRjaS3AJEjEruubPUytSIIy0loVKv7haWl0UrFLW1bfwgBryiMOt5tLQRX9XBPI6aAXmCwJg/IXKTwZQw++F/IJ3SfHO5kVrV58hMcJCd85dLBa3tvTn/THfC/tDnbAPUCkjrNLLbvRM2LxOKA0IJ2l/uJm+b15ABJt8N0emUrPhqK1SM8yhqIYfwaKFmOHx2Qkllc/ZL3/+K3sPXEuWq4Wz1rTWUCy7xxYoOad5J7Y2J3SPBWqbo8RT7q+kUuhtJPg555buhWFSIaR3KXf59axOCpF2jyZ2d4+aRwvdnRCqHfg3E/76LRbDOKvc6ELILwN2LJfuEUW7A2E7jestg3a94OFI8LihpRk+40AI2UAxd+828IiSAINMuAKoVvXMUQuZ8Yvr30TGtR1nGavWbiMjXN2x4xBZqu1xB83awcYLzL2bvf1rEyCzSglpzRHLNJ/abv547Yoy7X+3mprbzY04Yj9NqxLniX7Fbau7r7OWoPbjrYYpUOXV9N7y8Ep4c7pozJKhtf4as3bQDG3pwUEfM+WNBSYLujSn04+g5yJtTud3ePSQOg+jOCpECh4n8vvX8fdn79n8xWAUxUHa/wDnHr4/efPux4/vkBkMpE5g+4PRYERwtjK25DKgtPHlVHBVtif54M7q07Orp2dXT8+unp5dPT27enp29fTs6unZ1dOzq3/1Z1cBuDKsCi5kUHByIPnFWj0wiqOj8KXVZRzlCKofXUQ3N5hYfEIcDZv/VBOyc3EZR3OuBSJRBOj4GzRZgKPekU4+++CrjM/ZHY+2NvLfINcSYWvyOodHfYHl2jOx1SVWpR18jay5Hm8cA3vnOE83w62iCOLvbsRxionSvX3DKsTZ6cfzKI6ai+4lvSqLNF8gNsUXjtsAwKK2m6jgclYT+BW5OVfu6lPeh+u/EFzv/wgQtL48+ji+Wwb+Fxe1ccDNjSsFEODs+rtPd47wgm16o3IuV6vVPwDClwzW",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,b={},f=[];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.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.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n"]}),"\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.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.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.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)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},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},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",description:"Allowed values - signature, stamp.",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_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.abecfe08.js b/assets/js/c195e1f1.abecfe08.js deleted file mode 100644 index 8f0b178d2..000000000 --- a/assets/js/c195e1f1.abecfe08.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:()=>x,contentTitle:()=>g,default:()=>j,frontMatter:()=>f,metadata:()=>s,toc:()=>b});const s=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":"eJztW1FvHDeS/iu8frEttGYk2c5lBZ+xiu1LhDUiwZbPWGiECae7ZpoWm+wl2TOaCAPsw/6DfdrX/Wn5JYsqsrvZo5FGcgLs3q6CINGwyapisapY/Iq8Thyf2eTwPHmrs7oE5WxykSY52MyIygmtksPkrAD2xgB3wJpebGp0yRyUlcTmo9NjxqXUC8uWumZOsxkoMPhJwYLlDW02WbIvtXWsMnoucqFmLY2xyJlQ1gHPmZ6yupKaUwdOJKZCwlOhmCuATbUpsc+EW/jmBdOGTYTiZvmMwRzMkjlRAsmhAHIUJvPC81aQATsLbC1SYwYq7JHLJast5MTNsowrNoEwOvdTri0YJpQDM+UZMO7Y+c7OW5jUM/bpeGfn4mnhXGUPh0NeVQNdgbJipiSf2EGmy2GOHat8+gyFri3Nv1PuWaTOwUiN1B91TUJ4bQHLYcpr6dicy5rUgEpnC5HPAHXLUXRNOhKGKV5C77utq0obx+Aqg8oxFIy72kDKrONllTKhhBNc2pSJks9gMFL7A7azAyUXcmdnpH766aeRuh4pxkYJUh8lh2yU0OdRkvp2AzzXSi7x25RLC6E9iB4N+T1c8bKSgIoZJSO1CgxG6gC5IoPbmfq/HsLzi4Y+l+fI5YuesDPh5B2ssIvDLg/jl4Hu83uB/DJdVlwtb+cWOjxQn16TrJo7Jl3e5/sS+ebc3TFF/Powjvv7u3svdw/2Dl72mX2DzBxcuYm+up1f6PAwluWS4bg+v/8mpRaQXd7JsOnxEI7no0RTBNw9GCUXHdNdVKfvdrizwxofLfgcmFaAnl1qA8wVXFGD91ZXcEcByWJEmgCzICHDuDJZNo5NTv8trZfRVa4X6o41Cz0epkQ/o/2+En+HHA3PhWaT2jl9B1fq9Ruw3Nk5NTAVUrLPPjqhKpumJmBxAwwk+J2D9IctQlkwqDehnI5iOpvAFPUuHBOW2YIbyNlCuIJxitoDdqLkkuJtO4RCuzas4JZVYEphrcAAqhnPc+xa0pLgkhuwlVYWvKA+HiOtaHVtoWuZ42YicW/Ar3AlrMMw3wwf+Nm/F9bhFrYWm2lWjR5wFfa3+9Mmd/K86CNXuYEFm0Av/B3cNyjcoMhGyd6L4f7L4cHewYuY5POvdsWO9vkoKTlFWjZKpuD/jnzvxQMtNfTayKth1VGnSElb3+1k6fNmTYv/++7kw2LvD9/P9NHR0dGPHz8V7z7Njo6OSvw9GAwCr0D6m6/283gOjZK6WSRpoivMvYRWx3lymIT8Jdg8ekSTc4k8SZOKG16CA4Np4DVxTg6TKC1L0kRgGlhxVyTruaGefIHMHVPO1uQvSZoY+FMtDOTJoTM1pIl1S4lkrcCNKkkTuKqkziE59HEjsVkBJU8OrxO3rKinM0LNkjTBbI+7uCVsdyjSD/uTIjsoqkmyWl14tmDddzpfIqlMKwfK4Z+8qqTISCnDLxZFv454duKeJ5gXoTIu0kYUP0dUlUHNOgGWBMWk4KES/xilwz6tuKHSI8V8zOSStYvDbAWZmC6blJGGUgqIvxQs5LJNVLss93jKdCmcgzz1o8IK/fLnv9lAYoERdwI+7+1tRckqbZXRzZIbw5doEg7KuP0WJRm9WUedRo6yTNdOceWQIaWGdyqVOsQEvmiIc0mk4o34Lq5fNGBMxM5VodWW3vsHz/Hf5/vYP8Tsr9fJdulCRB8Tv2aXjYZMtJbAVTyG/GiVNnvv3fRDLjXRV8lqlTaWvBYpohAw/ujtYNzMffWgYcRkqmUOBiPSXZKR0YHKx+uG0E15/XAqbOQm/VNocBq2KMAVYKh5wZVjRL3LxNAXNQvGPmB44O2ftYTFtNXUMErIq7qdX+OPnghRX8ZVzpRmT4jf2NZkEE+G4fdE58sn3Uif8XiZBfpxEIE6t75rey47GPWsANk2XtSw26Twvg7f1NbpkhGbMIhCS3tEZCGwDtgbrphQmaxD+jPVqHCMSuz6ujGBMVnGasWur3EtwYzR5FertGtAXr0G8kLfYiADMe+NapugG9i2RUPhqhJmOcbcxTeE81QsgJgpoWbj2gQ6SmPnQc8M1wSnBDHoAPLWusRMbZh1G8Zofe+t/RvKDuuORP5j9P6qev2D2CDKq2H1+lX1+jOwQlfgPc6rZypU7v19AVIO2CvrjFaz12sqeDUM7ZuX0sBcwILclVa1o7Ku25bQIMj0R13HniIsy0ydCS6RbmV0Bs05xO/UV45ZB5Vl3OJZhdQyFUBzMIzPDNCJh2ThtSu0ET9T3tIwfMVZYWD6P0/WdPrkNYZbVoCBV0P+OvQ+ntIc6XjK1ZLRxIVWFg+qBJBNa0PBMZPciGlIklJWSeAWGOZQPHMkvNdoI8dZwdWlTV9NzOsz4CU7qUChBL/85e/Yo4nkx+rE5GDuEcqPp8wCReInGMeepEw3J7apMNaFAO3jX7AQL9ctrhMALbkcsHdtwLf1xGIv1dDrAqozYjYDPDeGHjQ49asHPCv8VkFS8SnGeuReofHo2jbioYGh+UtAA/NgXFioAfuuzbBSFmmHjqzx3Acbojrimmf6TSD9li/jXEPV5QTMDZ0SFooQaBjFcr60yI3yPfzAZVYT6uh9mKEP465G5thYf5yAtZxa+fZfYshTfCLh5Oz0HiuNE2K73o19ruvXwNNgJ2enbA6dMQ7YJ9uuU7PwvNeFZToHNhfcL33KFoXIyOWWrETEGRStV4jaMQow8NgF22U3BcqF3ShR6hMNjL81ibaJMMuFgczJJRmQrh2iCiJk9hQDBpsyOK+EM13fx2e2aJKzWS1yWunatHs6GJtGEDzC7qbOfFTIa9OcMYLR+iBmbaenRivYKaKfMlDWD+dsyq0Dk7JaEVpu6gq9oSEJVxUYASqDjSqIQvf2/ROzNQK7tc/LKjBWKwxv2sy4CtETgfFFoS2m/QWXvmsIE5ZNAKVC7+7vRw2C/8tf/p50ct16SLkpmOfA89yAtVskJBDJmxMiiogjLZnTfYmQHpjfr5cWUDoyyXGp89ZM7f0t6BThL2fbmBgwsBZ/s3VW4JbVxlobFwyogmBTnBIeLKgKoSucb4uANVCXuM37PgDqMYtkoIoL+gxalFrG7tPhgnqNHB0IhPWtcRK/0dKw0rN9JRHkLfmyLcQg7VB9AoWRJ2enb/+XykY+m9iAAOIhM4qifviNsw+vnR4bKIW635750W8atIhOt25fO11yJzLWkLIDFrp6dTsde3HJnjaqQu+YC22ebVSXJzfWKoOxUGOqt23fhH6kZrQG2n0m4BYAKpatWTS/tXqsBmVbFKBYTyfRTomT7kmJ21DlwdNNp/CbaxoX1xr79BsHfoFygpiIh5XR9SkwNufEG8f6X40L+K/bbPEIvRxyb9OW7d4o5A22QFDtyR+xvxlsXz6MY9iTqbCOqttdg9oa7JtXFXAzwCjGcMf5uuJoLy1pj9qDLUnIKk2utk/mimV6V5tcKCT+VMLUsbqqMP/VRoF55qOOn+C/zuT29lZpcg9XW/6/nN5znN1i++w+i9wVXd3knyLrC5S12C7rDyBmhfsnC/stCuvzwt8SmPSwpK9DbMVZsXOmpTZ390T4nWBC5az4eWNY6tzhYOX/6UDIJu7fDkyOY2SSoBki0C9VRBMjlRzs7eH/+kv7tlc/xLS2zjBDntZSLv8rSe9feLh7PZriykOLDMUXcfDzVTY/OG0w/NrIr9+XtmPymyDmtSseKElfivtNJThHbeSu07s4l9021yOy0XoLJYWCcbOA41xn42b22K8Ea/s73r1kaJebTv/9td7CPvFG+mKTFUXIjHpCZ8Ou8h1wKEyCMV9uLgYhZKNdm7I0XbjUlGB7jEkYhlUXGklm/pvZIxiz2Yvv0t6px5EsuLrqZuIJb9Pgi729cdYp8eUGJao5lyKnG2hn+hLUb+h+t063m1zM3nn2KOpVKbt4mgjfib4nvdnG7X6SFrLaCLekWuzVLq/Erv9+eH6BFc4SXKGxqltpSxJjUfYwGfZD3fA6inWrBMmaeVPhJS9sHctylU/01c2dh1diON8fYAlqfczGneqO/lDvPnSIdXwm1GzbuItOYx9xVf3C9fTWRb1K/AHQG8KyxL1CibsAjscuXAg0lg9dOflds+Rt3XdzKbctmJ43tc+4wNnWN28ULVupmsJkW5eMio9R7TGu1De1wrhUGMrqbTWwV/IjS+rqcUnSr7n5kv1aDenXlUT6FZFHmP/fCOZfQ/m98WyCqvdf9kDiYKEx2tncBYnRvx4Et47A3YqG3QKGBQYe9EGzX4NbwvfNKMfLHrgQe2IIMI1/NefqfTqQ7u/t0cnt+R4dcV7s0enh271eXt735STOrimFbjNoSpPjLBlT4QsMWEJNdRyemnWivYmi5Y3TFMhM+/IALvvOTrS07aidnTbIefPEC0wntWGVXoCZ1pIseCrhSiBgg8OgpG9dFR54KcFauaSb0zO6F56LmXCIgwdEOOMVnwgpcPP1V/u8o3T7tx2wz10d/4mhC90wB4l7dgt5qVkXlBfaXE7xPkDKOJvgfWsEYUEVXGUe7/VbB+GWCPggUl0ZgemKMyi18LJp5Qx6R8kVn5HfprEfsBwkhjHLjJ5gscFqWXvvc1xIbXyphSZEV0BJie/wCpTxR0Iszxgo0IrnAVO3qa9pWNokcAoKwSi6PM8zJzIg8LNWUmeXvkhWS8kq7XzhCk+esYw43BmuLF2f99WdsAatwgLSDzZcU/xkAVf4vVCXeEMTb0Ket3b1GSZWOOgOsIvF4sZe/aw/5nvhfqgn7ANU2gqnzbIbPROuqCe0v8dE2h+e0vfNu4Jo9+5o5DqzG87QOrPDAmQ1/AgOLcQOj06PKVt8xn7581/Ze+BGsUIvvLVmtQG57J4woOb8ynu1tcmev4JfuwI1nvFw0ZNCb6PBzwV3dNsKswWhgkv5K6Wn9USKrHuKsLNz2DwF6C57UFEgvEQIl1qxysVZ5UdLoS4H7Egt/dOEdgfCdhrXmwbtetFzjOjJQMszfhyB2LAFOfevIfDsMQEGufCVTaPrmecWCxMm17/fi3M7ynNWrd3xRRy6E8dDrVS04x5zdYON14J792X79yFA5ZUWytlDlhs+dR39dO3iL+1/N5qaO8ONOtJApl0S74lhxm2rv4izlnn2462BKVBJ1fZeyPBKBHM6b8ySobX+GrP2mAtt6dEJHlPgjZUjB6a0J9OPYOYia47dt3j0kDoPkzSRIoMAAIX96+j70/ds/nywl6RRPn8P5x6+P37z7seP71AYDKReYfuD/cEe4dTaupKriNPG90jRBdSe5qOboI+PmR4fMz0+Znp8zPT4mOnxMdPjY6bHx0yPj5n+1R8zReDKsJJcqKiS5NHv87VCX5Imh/H7pYs0KRAtPzxPrq8xsfiEOBo2/6kmZOf8Ik3m3AhEogjQCVdj8ghHvSWdfPohlA+fsVueQm2Uv4GkFeLR5HUej7qE5drjq9UFlps9Lo2i+R5vvAC7Z0ino3Cj2oHAuh9xlGGidGffuLxwevLxLEmT5gZ7SW+1EsMXiE3xhZc2ArCo7TqRXM1qAr8ST3Pl7zQVfRz+knD48EeEoPX10Qfo/TTwvzipjQOurz3GT4Cz7+8/3ToiKLbpjYtzsVqt/gGn69L4","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 i=n(74848),o=n(28453),r=n(33617),a=n.n(r),l=n(17543),d=n.n(l),p=n(86013),c=n.n(p),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const f={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW1FvHDeS/iu8frEttGYk2c5lBZ+xiu1LhDUiwZbPWGiECae7ZpoWm+wl2TOaCAPsw/6DfdrX/Wn5JYsqsrvZo5FGcgLs3q6CINGwyapisapY/Iq8Thyf2eTwPHmrs7oE5WxykSY52MyIygmtksPkrAD2xgB3wJpebGp0yRyUlcTmo9NjxqXUC8uWumZOsxkoMPhJwYLlDW02WbIvtXWsMnoucqFmLY2xyJlQ1gHPmZ6yupKaUwdOJKZCwlOhmCuATbUpsc+EW/jmBdOGTYTiZvmMwRzMkjlRAsmhAHIUJvPC81aQATsLbC1SYwYq7JHLJast5MTNsowrNoEwOvdTri0YJpQDM+UZMO7Y+c7OW5jUM/bpeGfn4mnhXGUPh0NeVQNdgbJipiSf2EGmy2GOHat8+gyFri3Nv1PuWaTOwUiN1B91TUJ4bQHLYcpr6dicy5rUgEpnC5HPAHXLUXRNOhKGKV5C77utq0obx+Aqg8oxFIy72kDKrONllTKhhBNc2pSJks9gMFL7A7azAyUXcmdnpH766aeRuh4pxkYJUh8lh2yU0OdRkvp2AzzXSi7x25RLC6E9iB4N+T1c8bKSgIoZJSO1CgxG6gC5IoPbmfq/HsLzi4Y+l+fI5YuesDPh5B2ssIvDLg/jl4Hu83uB/DJdVlwtb+cWOjxQn16TrJo7Jl3e5/sS+ebc3TFF/Powjvv7u3svdw/2Dl72mX2DzBxcuYm+up1f6PAwluWS4bg+v/8mpRaQXd7JsOnxEI7no0RTBNw9GCUXHdNdVKfvdrizwxofLfgcmFaAnl1qA8wVXFGD91ZXcEcByWJEmgCzICHDuDJZNo5NTv8trZfRVa4X6o41Cz0epkQ/o/2+En+HHA3PhWaT2jl9B1fq9Ruw3Nk5NTAVUrLPPjqhKpumJmBxAwwk+J2D9IctQlkwqDehnI5iOpvAFPUuHBOW2YIbyNlCuIJxitoDdqLkkuJtO4RCuzas4JZVYEphrcAAqhnPc+xa0pLgkhuwlVYWvKA+HiOtaHVtoWuZ42YicW/Ar3AlrMMw3wwf+Nm/F9bhFrYWm2lWjR5wFfa3+9Mmd/K86CNXuYEFm0Av/B3cNyjcoMhGyd6L4f7L4cHewYuY5POvdsWO9vkoKTlFWjZKpuD/jnzvxQMtNfTayKth1VGnSElb3+1k6fNmTYv/++7kw2LvD9/P9NHR0dGPHz8V7z7Njo6OSvw9GAwCr0D6m6/283gOjZK6WSRpoivMvYRWx3lymIT8Jdg8ekSTc4k8SZOKG16CA4Np4DVxTg6TKC1L0kRgGlhxVyTruaGefIHMHVPO1uQvSZoY+FMtDOTJoTM1pIl1S4lkrcCNKkkTuKqkziE59HEjsVkBJU8OrxO3rKinM0LNkjTBbI+7uCVsdyjSD/uTIjsoqkmyWl14tmDddzpfIqlMKwfK4Z+8qqTISCnDLxZFv454duKeJ5gXoTIu0kYUP0dUlUHNOgGWBMWk4KES/xilwz6tuKHSI8V8zOSStYvDbAWZmC6blJGGUgqIvxQs5LJNVLss93jKdCmcgzz1o8IK/fLnv9lAYoERdwI+7+1tRckqbZXRzZIbw5doEg7KuP0WJRm9WUedRo6yTNdOceWQIaWGdyqVOsQEvmiIc0mk4o34Lq5fNGBMxM5VodWW3vsHz/Hf5/vYP8Tsr9fJdulCRB8Tv2aXjYZMtJbAVTyG/GiVNnvv3fRDLjXRV8lqlTaWvBYpohAw/ujtYNzMffWgYcRkqmUOBiPSXZKR0YHKx+uG0E15/XAqbOQm/VNocBq2KMAVYKh5wZVjRL3LxNAXNQvGPmB44O2ftYTFtNXUMErIq7qdX+OPnghRX8ZVzpRmT4jf2NZkEE+G4fdE58sn3Uif8XiZBfpxEIE6t75rey47GPWsANk2XtSw26Twvg7f1NbpkhGbMIhCS3tEZCGwDtgbrphQmaxD+jPVqHCMSuz6ujGBMVnGasWur3EtwYzR5FertGtAXr0G8kLfYiADMe+NapugG9i2RUPhqhJmOcbcxTeE81QsgJgpoWbj2gQ6SmPnQc8M1wSnBDHoAPLWusRMbZh1G8Zofe+t/RvKDuuORP5j9P6qev2D2CDKq2H1+lX1+jOwQlfgPc6rZypU7v19AVIO2CvrjFaz12sqeDUM7ZuX0sBcwILclVa1o7Ku25bQIMj0R13HniIsy0ydCS6RbmV0Bs05xO/UV45ZB5Vl3OJZhdQyFUBzMIzPDNCJh2ThtSu0ET9T3tIwfMVZYWD6P0/WdPrkNYZbVoCBV0P+OvQ+ntIc6XjK1ZLRxIVWFg+qBJBNa0PBMZPciGlIklJWSeAWGOZQPHMkvNdoI8dZwdWlTV9NzOsz4CU7qUChBL/85e/Yo4nkx+rE5GDuEcqPp8wCReInGMeepEw3J7apMNaFAO3jX7AQL9ctrhMALbkcsHdtwLf1xGIv1dDrAqozYjYDPDeGHjQ49asHPCv8VkFS8SnGeuReofHo2jbioYGh+UtAA/NgXFioAfuuzbBSFmmHjqzx3Acbojrimmf6TSD9li/jXEPV5QTMDZ0SFooQaBjFcr60yI3yPfzAZVYT6uh9mKEP465G5thYf5yAtZxa+fZfYshTfCLh5Oz0HiuNE2K73o19ruvXwNNgJ2enbA6dMQ7YJ9uuU7PwvNeFZToHNhfcL33KFoXIyOWWrETEGRStV4jaMQow8NgF22U3BcqF3ShR6hMNjL81ibaJMMuFgczJJRmQrh2iCiJk9hQDBpsyOK+EM13fx2e2aJKzWS1yWunatHs6GJtGEDzC7qbOfFTIa9OcMYLR+iBmbaenRivYKaKfMlDWD+dsyq0Dk7JaEVpu6gq9oSEJVxUYASqDjSqIQvf2/ROzNQK7tc/LKjBWKwxv2sy4CtETgfFFoS2m/QWXvmsIE5ZNAKVC7+7vRw2C/8tf/p50ct16SLkpmOfA89yAtVskJBDJmxMiiogjLZnTfYmQHpjfr5cWUDoyyXGp89ZM7f0t6BThL2fbmBgwsBZ/s3VW4JbVxlobFwyogmBTnBIeLKgKoSucb4uANVCXuM37PgDqMYtkoIoL+gxalFrG7tPhgnqNHB0IhPWtcRK/0dKw0rN9JRHkLfmyLcQg7VB9AoWRJ2enb/+XykY+m9iAAOIhM4qifviNsw+vnR4bKIW635750W8atIhOt25fO11yJzLWkLIDFrp6dTsde3HJnjaqQu+YC22ebVSXJzfWKoOxUGOqt23fhH6kZrQG2n0m4BYAKpatWTS/tXqsBmVbFKBYTyfRTomT7kmJ21DlwdNNp/CbaxoX1xr79BsHfoFygpiIh5XR9SkwNufEG8f6X40L+K/bbPEIvRxyb9OW7d4o5A22QFDtyR+xvxlsXz6MY9iTqbCOqttdg9oa7JtXFXAzwCjGcMf5uuJoLy1pj9qDLUnIKk2utk/mimV6V5tcKCT+VMLUsbqqMP/VRoF55qOOn+C/zuT29lZpcg9XW/6/nN5znN1i++w+i9wVXd3knyLrC5S12C7rDyBmhfsnC/stCuvzwt8SmPSwpK9DbMVZsXOmpTZ390T4nWBC5az4eWNY6tzhYOX/6UDIJu7fDkyOY2SSoBki0C9VRBMjlRzs7eH/+kv7tlc/xLS2zjBDntZSLv8rSe9feLh7PZriykOLDMUXcfDzVTY/OG0w/NrIr9+XtmPymyDmtSseKElfivtNJThHbeSu07s4l9021yOy0XoLJYWCcbOA41xn42b22K8Ea/s73r1kaJebTv/9td7CPvFG+mKTFUXIjHpCZ8Ou8h1wKEyCMV9uLgYhZKNdm7I0XbjUlGB7jEkYhlUXGklm/pvZIxiz2Yvv0t6px5EsuLrqZuIJb9Pgi729cdYp8eUGJao5lyKnG2hn+hLUb+h+t063m1zM3nn2KOpVKbt4mgjfib4nvdnG7X6SFrLaCLekWuzVLq/Erv9+eH6BFc4SXKGxqltpSxJjUfYwGfZD3fA6inWrBMmaeVPhJS9sHctylU/01c2dh1diON8fYAlqfczGneqO/lDvPnSIdXwm1GzbuItOYx9xVf3C9fTWRb1K/AHQG8KyxL1CibsAjscuXAg0lg9dOflds+Rt3XdzKbctmJ43tc+4wNnWN28ULVupmsJkW5eMio9R7TGu1De1wrhUGMrqbTWwV/IjS+rqcUnSr7n5kv1aDenXlUT6FZFHmP/fCOZfQ/m98WyCqvdf9kDiYKEx2tncBYnRvx4Et47A3YqG3QKGBQYe9EGzX4NbwvfNKMfLHrgQe2IIMI1/NefqfTqQ7u/t0cnt+R4dcV7s0enh271eXt735STOrimFbjNoSpPjLBlT4QsMWEJNdRyemnWivYmi5Y3TFMhM+/IALvvOTrS07aidnTbIefPEC0wntWGVXoCZ1pIseCrhSiBgg8OgpG9dFR54KcFauaSb0zO6F56LmXCIgwdEOOMVnwgpcPP1V/u8o3T7tx2wz10d/4mhC90wB4l7dgt5qVkXlBfaXE7xPkDKOJvgfWsEYUEVXGUe7/VbB+GWCPggUl0ZgemKMyi18LJp5Qx6R8kVn5HfprEfsBwkhjHLjJ5gscFqWXvvc1xIbXyphSZEV0BJie/wCpTxR0Iszxgo0IrnAVO3qa9pWNokcAoKwSi6PM8zJzIg8LNWUmeXvkhWS8kq7XzhCk+esYw43BmuLF2f99WdsAatwgLSDzZcU/xkAVf4vVCXeEMTb0Ket3b1GSZWOOgOsIvF4sZe/aw/5nvhfqgn7ANU2gqnzbIbPROuqCe0v8dE2h+e0vfNu4Jo9+5o5DqzG87QOrPDAmQ1/AgOLcQOj06PKVt8xn7581/Ze+BGsUIvvLVmtQG57J4woOb8ynu1tcmev4JfuwI1nvFw0ZNCb6PBzwV3dNsKswWhgkv5K6Wn9USKrHuKsLNz2DwF6C57UFEgvEQIl1qxysVZ5UdLoS4H7Egt/dOEdgfCdhrXmwbtetFzjOjJQMszfhyB2LAFOfevIfDsMQEGufCVTaPrmecWCxMm17/fi3M7ynNWrd3xRRy6E8dDrVS04x5zdYON14J792X79yFA5ZUWytlDlhs+dR39dO3iL+1/N5qaO8ONOtJApl0S74lhxm2rv4izlnn2462BKVBJ1fZeyPBKBHM6b8ySobX+GrP2mAtt6dEJHlPgjZUjB6a0J9OPYOYia47dt3j0kDoPkzSRIoMAAIX96+j70/ds/nywl6RRPn8P5x6+P37z7seP71AYDKReYfuD/cEe4dTaupKriNPG90jRBdSe5qOboI+PmR4fMz0+Znp8zPT4mOnxMdPjY6bHx0yPj5n+1R8zReDKsJJcqKiS5NHv87VCX5Imh/H7pYs0KRAtPzxPrq8xsfiEOBo2/6kmZOf8Ik3m3AhEogjQCVdj8ghHvSWdfPohlA+fsVueQm2Uv4GkFeLR5HUej7qE5drjq9UFlps9Lo2i+R5vvAC7Z0ino3Cj2oHAuh9xlGGidGffuLxwevLxLEmT5gZ7SW+1EsMXiE3xhZc2ArCo7TqRXM1qAr8ST3Pl7zQVfRz+knD48EeEoPX10Qfo/TTwvzipjQOurz3GT4Cz7+8/3ToiKLbpjYtzsVqt/gGn69L4",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,x={},b=[];function y(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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,i.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"7",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"8",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"9",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.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,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date"\n "response": "04/15/2024"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{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},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",description:"Allowed values - signature, stamp.",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_template_id_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.1bb5b9be.js b/assets/js/c4fbe420.1bb5b9be.js deleted file mode 100644 index 38532ac52..000000000 --- a/assets/js/c4fbe420.1bb5b9be.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:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>f});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":"eJztPNtyG7eSv4Kd2qrEPEOKpC6WtS+rOIojx5a0lnyVdBRwBuTAmgHGAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrTj2LvMQi4Nbo9Hd6G5091Vg6EgHW8fBEcvylBqmg9MwiJmOFM8NlyLYCo4SRnwz+VnRoeFiRLYPdgkTdJAyTQrNlCZGkkgx6BQV2siMf4RWYvzMIdFMXcBYqskgLViuuDCaDKUiIyaYojhxLKMiY9Aw5iYhuWIxG3LBYqKNKiJTKKY75GUuBdFFFDGth0VqV+ZSEDkktFwzJCZhCKpiplBCE0oKwT8UjLRacvCeRWY3brXIjzHTfCSoYTEA54ef8fhBSMYJjxISUUEGDLYaw04dwKwG7oBCmxS4ps5ZxIccOrvJOmQ7jjnASNN0EhJKWq1Cpa0W4ZrkSl7wmMV+NTkcAkopopZwYZga0oghrhjMIka4jJ+cUBGTIY14yk0TjSTm2ig+KGDlzok4EUc83yIv81TSmExkocjBz79U3Y0k8O241fqZDYoRebnbap3+mBiT662VFZrnHZkzAdhK6UB3IpmtxNAxj4eIK6YYzIr4YlTzdEJoHJMxj0fMaDwQQSKZT0gkpYq5sKSR0xEjosgGTOkQd5NJxQgXhBLFaDxpG9kuNCNPD/f3AA0ZNR1ykBY6LJeLuWKRSSd2ekCP39UP9nQ21oCGuBiFJKPngCVuyIeCR+ewbc0EHq0jGcRVq/Ua4C2xw7Wj8ZgQk3BNxmyQSHlO2AU0j3maEqP4aMRUq3Uifv/99xNxdSIIOQmwx0mwRU4CN8VJENomM8mZbfl5//HL5zt7R2dHbw92ynZPqVN9dn8uewx5Oj3DyxfPymZBs+nmve3n1QJCGtd+kDKqGVHsgrMxngMctd2rx0I5rCYn7OiyBQYxpeHrMXwh5Mr+04TmcPfJ3s6LOiy2B8soTxtddp5v7z5r9MkTKZrTHPy6v9ecp1C1WXb3nlik2PZr+OfUwetOZNsd0NHu853Do+3nB9D52p0jUMNhkedSwfG/tgS9Bcd8In5iqRwTqhhSTySzTAqSU0UzZlA2JtRgs2IfCq5YbIUbTVPPGVsnok1aLSCFrVaL7IqYR8Aals0nOQPJZvt2bFdgGeh66ESN7VpjJJBFVpwAh4yp5e48BUECXRUDKWX4BWtOfBmSCUz8MwO6sNMmUvGPUhiaIlFcMGV4RNM6EwOAKPoMVSiCcsmF8V/dCuStY1bgZWRRJ2UAtBiQlXGBLZqRC5oWTDuoxiFJAKoXLFdMo8R18wIiRUwSxkfJwvVo/L7QpjExKbSXox4Kt5Y/JUQvQ7QNaaoZ4cMGLjN6zmqrEZlb+d4hP01IzIa0SE1IOMgfowrWIXvSEJrnKY/wbgRxbi+eQrE2nrIjBwcIsAoAcWDvB7gRYg53A0gbaMQp3BgPHdCZvVBgeyhHTUIFkWLqoCOZSjVLQvi5iUcSSWGYMB2yfUF5isDbzWrCRZQWMSODlEbnId7sIVFwl8GpTFiaynFo6R274A2LOEf8EM1SoEIpAH4h3fJcV3dohxyB/Cn5CRo9qnERrutYdTJ8KGFlQIFnMYJyJUTEheS9HBDDTcpCYNiciklIYqs0sEszkJchiRIWneNfisZckkFhjBR2Y7GSeSzHwuFyKIXR/OMcjvQtn47RfkjWQrIRks2Q9Loh6fVD0lsLSW8jJL3NkPS7Ien3Q9JfC0l/w4LV33S4piWC6wD0+hbL5vvBLsjdZ1wjZ4PA1KUMHjdkcK9DWq2Sm6av3+qOLbuUtxXITGjrud+X8GO1/9D9nMDPjf6m+znGrr019zOBn/1e/Z7oIySGZvkNUEDzvULglQVLRPDN3bkngZdn8BEEUegbqqvYwQMN1/W9rMJeuOCG01Qv3o7v8Q3tqAJpZlNrsCkk18U7cjrIN7OdOjyosoCYtE0oVmtNnuERiv7M7tc77mZZvHm77Dez9xo4X7b1Ddg6iKYjEE2L919Kr28ICdMwfRkmHnZQAUDJvBgPrsM3hIUmRF+Gg03AAVxKixEArd/Q7mvgWAMMb3jb1l1r99bb/W5/rYEBsJRthyxrx3F7MpncB/ZA53HLg8rjNVSr2YFHYqhkNsf8QOug6uV0Ivzbq+zPQVEfsNIpAl6Apk/F2/91LdvImE5+0HYqP7RUzqB/pZpNamBiE8CBvpAokTxywEMfr5INwMDrAA7aiMmVOF6pYRI+xnE7y9pTH+FnGxFf+5hlnTjuTPWcOR37MSNxHJLZz3O/xzHJsmzBZ/u98Xkly2Z30ckyBxsqX4+ASZzOtphPXIevxSoVRzQXvpGNwI8kRYprozk3n4+mLpuEe7eNIyoy1UGxUZFSxS7BLtXTvpB75DHPYpVmj3YsmoDWGYioID/uO+39gSN/2EJzAvhy+7iZncEk2869SxQbsUuSU2OYEjjZBU15bN2wbeuqvKRZDibAyt9PTuK//fsKOiDAxjcEToLEfMTBK7jy9+Pt9rvTOT2KPGcqAp9UymAlHRJmog45TliaV47J8XjcGa/qKJEytV7J91qxof3/mRy8P0Nw8w7V+YN5O7WkUTP4gXSm7X3NTANjVBM/co7JjzSGPNTr4m3r7J0brlvX4xu6caZAgkbrPbG+vSCjqJAAKbPqb2kSpk6C03KMNfJZfMvY0zswa8JjltIBS2eb7sxo5eeUTmTh+Ns7tZpbdRRdwxs0ZFyUfgvcTrfmdszo5VTjSeVynOJvi5A6d/orx7OnPwGScu09N0101kc71xY6HAWzjxUDRvwAMiip9Iu5oATsbmxgJZE7u1uWgH4EO5ZuRb/aLSs0DqaOGJgj44JnRVb6R4flrB5lmdM96viCkfAO41eon+7MCvTylhXcQ9KCBU5ED/0Y3v9xg2bqenxDsmIKpJvZ+HOkSOOevqcL9nYG9NuqM+Ccaxm62gu5ZD69mPs6ZB+uN/DJ2kHgZYsilhvwyH0pa5Yg3/mGQp9V3Q+3mPLqvb4h6psD1p9Mga7ffd8+n0Wk9d1/R4TaAPvOxGqdkhkd3WC5Y/M3RJ4OnhknRKt1oNgQHo6rJ0XiP/mXHXjSYSnL3LOXe0yEqw4d4VwYCWaBf6YesCG+nuODtU5o9eBo7xl7pPUXcvusLRVJqLb6Nyr8cFTwfG8Slk254j1olTueCw83nErv/uzG/qNu/Zx6G+uNc1rvNs6pu+icbjAb4QR1LoUufW2saqrxtSpf7edeLdNs6yeFI92BII7SerDMIIs0Jik/x1eVmOs8pRM4Vc+lDsrp57rHiZS66uFezH50G95qvsRJBY9xDzrlw8RdHF5Th1E7i97D1dpRrG9uNjmmwTB3sd+r9WZPobu20ltfsR6t+Q6tyg2zWAjfoAkQcpfzQj/Rnc4Le1YHtnQ7fa7b6X7IffU+re7ew37jsljtfu5lce/GdZ1rbjGr78N4vjcrts5ud7Rfv5od+eXUt/ZnaNS9h6t1KnzYuwcX6gLF+UspcUY/vjfaI/elHM8jwDtoxzeqxF9MoHVg/3QiXb8fTbrXbWhojxoK2qN+nSjX1+9ElPVFpyjrJOCvftp/Me7+9mQkt7e3t/cOXyY7L0fb29sZ/O50OnONqHmnjcuA5uriQ929jHf8glU6nQ6gMKaGbuHwlVyM/sOODxeP6bjX5z/Js7N+H48pcxw4Xy4Fyq5/nbfmz+PzL+XAIAxkjqHvUuzGwVYQQ4C9D+sOQrQsmTY/yXgSbF0FLmoM/nQxWTBy5b2GUP2rQEcJyyj85S1SCO6H6OAg9EG5QRhgGAFE+gPRBVsuwDgI4YkrBz8E0zAHjtu68r1s7HQQOh082Aos0Qdh4B56yk+EiUjC020eD4Nrv+BNU5Vfqqk0/lHGuMM8EJD6mdPg0Oup5IbPmqk+w3WF1moyqhSdBNN5FD4S1T8j2nFlqF068XcDN+AJKcMjsVsQBtywrL7KgkNT8tMxHTEJO8EQo08di8dCs09eE8ZhDPfnDHTOhzk4vyOWbOvsws0j24YYRxZ7pbRdBeuGBAPmOrdRjO+Pu6Wj+pr2iWBmzaNFQdy12FGdoCVK85xR1cFY6s9O2sC8HZpGBeaRlFKxsbMS1HJnveswuLx9M5ckkm0fIU5+TNnQ2BddEkklmHpQDxP5ZjbXX1u7DoPJ7dubfJfbewiHN759d68xtL5KO/grYF3dvA6D5HZYfy2D//9CYNc2rqu7zuWUlLlkAxlPzrzcur6to79UoB8kJu2KfRUzVUPEQMqUUTGDid2hda5L8gMYHD+ENo4CY7a50v5CsblKikUM8j8wvMrLKuJ0DhvQTVwcLfjkd+ADakm6GGjoJfx82k44YD7/CRL2bA9uE97QAc1olECmlYvuoEPvZMsh5UgW2oMHfmiI9UsZuJZNwrhNleBi1DSKathBb3d975366cAXuOQwaXH/6OAOuESLrW2zn+w9bXdp5yD7RweQCcOHTg3rkJe6xIRHLW10IaAWkQtOfbR8Kdsn9u2ZWbej9HlXlYu+43JQ2mQWoJjruRCFEDFvw/TLJM2ZiavEOTgiWRhw+btMRaINy3UDjwhFicgjWdyFKm/BJCWjAkP9DLCsT4vBaJ8qk4ULmwGK6n5cKJ+848gCekI6aIUnjxXoVJs/JExoO5ySIdWGqRDSQgHzqgDlvpySXeZMcSYiNhcFilnUnRVqrt7UxEEzLeTli2cuXdLvwTPlADjQTsxiUuRINcgJZbqSP7nprc8oSsAdTJ0tUtBmVQ9MKnKeiJwpDSm1ikg1ooJ/dCm2oJGAsTNgCU1tVycqwGMN8ACHN4HxsvaPf/6rBtdCjXMWMLsCjWOIRbsFQrToLMGDxq1YDhJQNiGC+Zj6z+lLAKBDpjnLZFwykr47jR9g9Jou5aJ7Qiuf73QRJaDgl/JWh17GaqdWajQR0Y7EN7gc9ssuuTa1hBsfFjsrH14wwGNUgwHVEOBqoHkxqTN49awop6bDtCDeTNYqr8EZXqCFkWeKZVzc7Z6qO8WMLAVBYWRGDY+In0p3mil49uXF83UGudsWNKDGCy7VgwWsCtOdSRGxMy7O2AVTd1Dw9sownphOgLjNmDFRh80jyV5nVZrUGPKGGzip3U6YDFiHch3MA/t2Os92udmQ9PRQJaqzbABv+PYVGFgNBYesbMmmMfS9WFPuOXRpS31Hxkav2/2/bEutdr8fW2qt+x3ZUpsArPOe3i6AFuk3c2WH9wbfPOC9RKcN+nFv7gle1uuw9F3PQ3DFDv1r+19l/nm5f4tJaG3Gyq3rzBm/GURDv9uFf6aEoK8R4itXVGVT0sm/BeHdfco3n4GvUnEzsn5K+r/qXGRRAjhboDdX3W8msbqvfIVNniaDJxHf5093X37c7e3xXb0rXqxHj3c3ds/zN68eP33UYZOnvaj/avKm/8q8fZ3q3feSR78+Td6JV3rweL14++adevtmV719/cLQ1+vbA5GIwZNfeDRZfz/od/mzx0+77173xoMnv3TfvXqUv8PJf+m+Oz/vRtne44HYhj752zf/xfff76w+/7jz8fnRzuXzj+mjDt378P7xZfTo+fnORvvdrmo/3x/89v6DyV+sx6t7b/jGJnvOXouj7rOoQQ1cpFywM3/UZ7jvMzhsS0lr8479UGbMJKgvYmkSJaHuSW7rexg1IXREuSCAOnWPVMCUuo1fPg2ymxCx1u2e9UokrM8iYVdgBD+WADqS50x83Z3Wlzd2eQD1MksroRVw2wnbg8Zm69/tJjWLCsXNJNg6vgou2zTnbdu+dXx6fRoGgFgJz0i51AgxNUmwFaxMvypBJSZ8szi+sjxYMpqmIoboiBlmozlfueh1esF1OD1mLnPe0J8V7U8dog0dcTG6bdxphaJDOEZ7Ug1EVTpuzn9joOS6c6j3CgMO5JMwCsYMYB6o40X1Frfjz9i/ks17+KrOcvopy79kNR6npu/hOc9NtdemY//Ug6835eNNUG0oKB9Y4M9SyT+uKLZ8nfAKdQ810f7aGqpsD3uo26xuotqwtnF9ahFcc0disGvdp2bjOhrOIfep6SwJginnRMNDMO0gWGisL7DV3ZJTNmkJyDxTcL1hgc3BltcgmriCyAfA1WoXcbXWRVxtdhvKi9thNUOlgqCeUaoZqEvUVQnQF06B/rgYSiReR1H7OROH4MkD2YLEP6NysjSSWVmwo9XyQ/7457/KUa1WafDTskLYfqFILsdMQWU1rCyWsksOVi1WfcuwTeNbJYZy0yxlWsMDpjBsZMuiQWIfuA+dgyqiOR1AdTJwf2G4MsY91uSv7pDXCYNQAmj6Qdk8xwuWgswt/QL1ymZjqc6HqRxDwTAygGI+4BliIqEisk4oKwnQmQJWMTj4csU11ChSADW3sElhFI0MyaigI/SGhKSOrJilHMQlUXIAPlot08J6IQ3lqVQ2Sg03hGEEiMSdyxyaUG8G951iCdDuhXNF6tC6gi2Tu5pnA/C65wALjxh6ZAqRSihPBt77Ik1JLo31qIN6XocRhhtFhQad2sLiz6BEmPMSMu1CuV9qBif8jItzW0SlTY5LunrNBpob1kyxnOa/B80xT7j5tRhAiSapuZFqUo0ecZMUAxTX9UnKH3amJ76sXk0YV3PEMtJztEAZ6RXIBl05ZAYoRK9sH+zibf+A/PGP/ybPGFWCJHJsqTUqFEsnVQU/LDaHJ2/RVl7W6IemBVSsM0ikYuSfRnRZHY6aP/7xP5rssTH44yxL2dCQg2KQ8qgsnahbrS3y2BZILGsiNlPCbKA+PA5QktvRKRfnHbItJrYSIL6hADHAdxzX2Aa69hdUJKzqEB7VVmeZZukFQz8pVAUaMKwviE8uShYju1odGLe5Zs4C7G07jkk+lbcAzroKHOuPwrcOah1TUMNvTqpDI6egWW2IiRjriuktgkpNNX84lcyAzx8zn3weRFUi0k5TK1MJmHQ7Lr/aUJ0pRaIpbxUbMgUL6kaBSJpzR07HnixJM3f508naGqbC0Ai1WH9J0pzPdWdDVTW9PzyE8puRt6oWcPQKdl4JwiDlEXNWsru/tp8cPCMXq51uENbUszsw98qz3cc7e4c7AAwIUouwXqfX6aIzT2qTUVFbCcuMloQ6fbXVwqCW1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UnJsjrpsjrpV9r7sjrpsjrpsjrpsjrpsjrpsjrpsjrpsjrpsjrp17tvl9VJl9VJl9VJl9VJl9VJv6Oij8vqpF+DApfVSZfVSZfVSZfVSZfVSZfVSZfVSZfVST/ZebWsTrqsTrqsTrqsTrqsTrqsTrqsTvr/tDppLfltJU8pF7W0bZtdejxVs/Q0DBLIPt06Dq6ugPBeqvT6Gj5/KDDT7vg0DC6o4hCwhYmroU+0hGy7czYJtoLHNv6sfQTLh/acMcNhKl8XMkXtiG3c+o196wmyB/uHR0EYDFxd1UzGmMpPx5CdR8c2QbGWwoffroKUilGB6X+BnfPalr5Jmoml55hY6v6o5RBSMalB2Mw4tduA/8Om5g64urJJq9fXZX/btHCEQ6zvDcd3en19/b9ATyW9","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),p=t.n(c),h=t(63723),u=t.n(h),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:"eJztPNtyG7eSv4Kd2qrEPEOKpC6WtS+rOIojx5a0lnyVdBRwBuTAmgHGAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrTj2LvMQi4Nbo9Hd6G5091Vg6EgHW8fBEcvylBqmg9MwiJmOFM8NlyLYCo4SRnwz+VnRoeFiRLYPdgkTdJAyTQrNlCZGkkgx6BQV2siMf4RWYvzMIdFMXcBYqskgLViuuDCaDKUiIyaYojhxLKMiY9Aw5iYhuWIxG3LBYqKNKiJTKKY75GUuBdFFFDGth0VqV+ZSEDkktFwzJCZhCKpiplBCE0oKwT8UjLRacvCeRWY3brXIjzHTfCSoYTEA54ef8fhBSMYJjxISUUEGDLYaw04dwKwG7oBCmxS4ps5ZxIccOrvJOmQ7jjnASNN0EhJKWq1Cpa0W4ZrkSl7wmMV+NTkcAkopopZwYZga0oghrhjMIka4jJ+cUBGTIY14yk0TjSTm2ig+KGDlzok4EUc83yIv81TSmExkocjBz79U3Y0k8O241fqZDYoRebnbap3+mBiT662VFZrnHZkzAdhK6UB3IpmtxNAxj4eIK6YYzIr4YlTzdEJoHJMxj0fMaDwQQSKZT0gkpYq5sKSR0xEjosgGTOkQd5NJxQgXhBLFaDxpG9kuNCNPD/f3AA0ZNR1ykBY6LJeLuWKRSSd2ekCP39UP9nQ21oCGuBiFJKPngCVuyIeCR+ewbc0EHq0jGcRVq/Ua4C2xw7Wj8ZgQk3BNxmyQSHlO2AU0j3maEqP4aMRUq3Uifv/99xNxdSIIOQmwx0mwRU4CN8VJENomM8mZbfl5//HL5zt7R2dHbw92ynZPqVN9dn8uewx5Oj3DyxfPymZBs+nmve3n1QJCGtd+kDKqGVHsgrMxngMctd2rx0I5rCYn7OiyBQYxpeHrMXwh5Mr+04TmcPfJ3s6LOiy2B8soTxtddp5v7z5r9MkTKZrTHPy6v9ecp1C1WXb3nlik2PZr+OfUwetOZNsd0NHu853Do+3nB9D52p0jUMNhkedSwfG/tgS9Bcd8In5iqRwTqhhSTySzTAqSU0UzZlA2JtRgs2IfCq5YbIUbTVPPGVsnok1aLSCFrVaL7IqYR8Aals0nOQPJZvt2bFdgGeh66ESN7VpjJJBFVpwAh4yp5e48BUECXRUDKWX4BWtOfBmSCUz8MwO6sNMmUvGPUhiaIlFcMGV4RNM6EwOAKPoMVSiCcsmF8V/dCuStY1bgZWRRJ2UAtBiQlXGBLZqRC5oWTDuoxiFJAKoXLFdMo8R18wIiRUwSxkfJwvVo/L7QpjExKbSXox4Kt5Y/JUQvQ7QNaaoZ4cMGLjN6zmqrEZlb+d4hP01IzIa0SE1IOMgfowrWIXvSEJrnKY/wbgRxbi+eQrE2nrIjBwcIsAoAcWDvB7gRYg53A0gbaMQp3BgPHdCZvVBgeyhHTUIFkWLqoCOZSjVLQvi5iUcSSWGYMB2yfUF5isDbzWrCRZQWMSODlEbnId7sIVFwl8GpTFiaynFo6R274A2LOEf8EM1SoEIpAH4h3fJcV3dohxyB/Cn5CRo9qnERrutYdTJ8KGFlQIFnMYJyJUTEheS9HBDDTcpCYNiciklIYqs0sEszkJchiRIWneNfisZckkFhjBR2Y7GSeSzHwuFyKIXR/OMcjvQtn47RfkjWQrIRks2Q9Loh6fVD0lsLSW8jJL3NkPS7Ien3Q9JfC0l/w4LV33S4piWC6wD0+hbL5vvBLsjdZ1wjZ4PA1KUMHjdkcK9DWq2Sm6av3+qOLbuUtxXITGjrud+X8GO1/9D9nMDPjf6m+znGrr019zOBn/1e/Z7oIySGZvkNUEDzvULglQVLRPDN3bkngZdn8BEEUegbqqvYwQMN1/W9rMJeuOCG01Qv3o7v8Q3tqAJpZlNrsCkk18U7cjrIN7OdOjyosoCYtE0oVmtNnuERiv7M7tc77mZZvHm77Dez9xo4X7b1Ddg6iKYjEE2L919Kr28ICdMwfRkmHnZQAUDJvBgPrsM3hIUmRF+Gg03AAVxKixEArd/Q7mvgWAMMb3jb1l1r99bb/W5/rYEBsJRthyxrx3F7MpncB/ZA53HLg8rjNVSr2YFHYqhkNsf8QOug6uV0Ivzbq+zPQVEfsNIpAl6Apk/F2/91LdvImE5+0HYqP7RUzqB/pZpNamBiE8CBvpAokTxywEMfr5INwMDrAA7aiMmVOF6pYRI+xnE7y9pTH+FnGxFf+5hlnTjuTPWcOR37MSNxHJLZz3O/xzHJsmzBZ/u98Xkly2Z30ckyBxsqX4+ASZzOtphPXIevxSoVRzQXvpGNwI8kRYprozk3n4+mLpuEe7eNIyoy1UGxUZFSxS7BLtXTvpB75DHPYpVmj3YsmoDWGYioID/uO+39gSN/2EJzAvhy+7iZncEk2869SxQbsUuSU2OYEjjZBU15bN2wbeuqvKRZDibAyt9PTuK//fsKOiDAxjcEToLEfMTBK7jy9+Pt9rvTOT2KPGcqAp9UymAlHRJmog45TliaV47J8XjcGa/qKJEytV7J91qxof3/mRy8P0Nw8w7V+YN5O7WkUTP4gXSm7X3NTANjVBM/co7JjzSGPNTr4m3r7J0brlvX4xu6caZAgkbrPbG+vSCjqJAAKbPqb2kSpk6C03KMNfJZfMvY0zswa8JjltIBS2eb7sxo5eeUTmTh+Ns7tZpbdRRdwxs0ZFyUfgvcTrfmdszo5VTjSeVynOJvi5A6d/orx7OnPwGScu09N0101kc71xY6HAWzjxUDRvwAMiip9Iu5oATsbmxgJZE7u1uWgH4EO5ZuRb/aLSs0DqaOGJgj44JnRVb6R4flrB5lmdM96viCkfAO41eon+7MCvTylhXcQ9KCBU5ED/0Y3v9xg2bqenxDsmIKpJvZ+HOkSOOevqcL9nYG9NuqM+Ccaxm62gu5ZD69mPs6ZB+uN/DJ2kHgZYsilhvwyH0pa5Yg3/mGQp9V3Q+3mPLqvb4h6psD1p9Mga7ffd8+n0Wk9d1/R4TaAPvOxGqdkhkd3WC5Y/M3RJ4OnhknRKt1oNgQHo6rJ0XiP/mXHXjSYSnL3LOXe0yEqw4d4VwYCWaBf6YesCG+nuODtU5o9eBo7xl7pPUXcvusLRVJqLb6Nyr8cFTwfG8Slk254j1olTueCw83nErv/uzG/qNu/Zx6G+uNc1rvNs6pu+icbjAb4QR1LoUufW2saqrxtSpf7edeLdNs6yeFI92BII7SerDMIIs0Jik/x1eVmOs8pRM4Vc+lDsrp57rHiZS66uFezH50G95qvsRJBY9xDzrlw8RdHF5Th1E7i97D1dpRrG9uNjmmwTB3sd+r9WZPobu20ltfsR6t+Q6tyg2zWAjfoAkQcpfzQj/Rnc4Le1YHtnQ7fa7b6X7IffU+re7ew37jsljtfu5lce/GdZ1rbjGr78N4vjcrts5ud7Rfv5od+eXUt/ZnaNS9h6t1KnzYuwcX6gLF+UspcUY/vjfaI/elHM8jwDtoxzeqxF9MoHVg/3QiXb8fTbrXbWhojxoK2qN+nSjX1+9ElPVFpyjrJOCvftp/Me7+9mQkt7e3t/cOXyY7L0fb29sZ/O50OnONqHmnjcuA5uriQ929jHf8glU6nQ6gMKaGbuHwlVyM/sOODxeP6bjX5z/Js7N+H48pcxw4Xy4Fyq5/nbfmz+PzL+XAIAxkjqHvUuzGwVYQQ4C9D+sOQrQsmTY/yXgSbF0FLmoM/nQxWTBy5b2GUP2rQEcJyyj85S1SCO6H6OAg9EG5QRhgGAFE+gPRBVsuwDgI4YkrBz8E0zAHjtu68r1s7HQQOh082Aos0Qdh4B56yk+EiUjC020eD4Nrv+BNU5Vfqqk0/lHGuMM8EJD6mdPg0Oup5IbPmqk+w3WF1moyqhSdBNN5FD4S1T8j2nFlqF068XcDN+AJKcMjsVsQBtywrL7KgkNT8tMxHTEJO8EQo08di8dCs09eE8ZhDPfnDHTOhzk4vyOWbOvsws0j24YYRxZ7pbRdBeuGBAPmOrdRjO+Pu6Wj+pr2iWBmzaNFQdy12FGdoCVK85xR1cFY6s9O2sC8HZpGBeaRlFKxsbMS1HJnveswuLx9M5ckkm0fIU5+TNnQ2BddEkklmHpQDxP5ZjbXX1u7DoPJ7dubfJfbewiHN759d68xtL5KO/grYF3dvA6D5HZYfy2D//9CYNc2rqu7zuWUlLlkAxlPzrzcur6to79UoB8kJu2KfRUzVUPEQMqUUTGDid2hda5L8gMYHD+ENo4CY7a50v5CsblKikUM8j8wvMrLKuJ0DhvQTVwcLfjkd+ADakm6GGjoJfx82k44YD7/CRL2bA9uE97QAc1olECmlYvuoEPvZMsh5UgW2oMHfmiI9UsZuJZNwrhNleBi1DSKathBb3d975366cAXuOQwaXH/6OAOuESLrW2zn+w9bXdp5yD7RweQCcOHTg3rkJe6xIRHLW10IaAWkQtOfbR8Kdsn9u2ZWbej9HlXlYu+43JQ2mQWoJjruRCFEDFvw/TLJM2ZiavEOTgiWRhw+btMRaINy3UDjwhFicgjWdyFKm/BJCWjAkP9DLCsT4vBaJ8qk4ULmwGK6n5cKJ+848gCekI6aIUnjxXoVJs/JExoO5ySIdWGqRDSQgHzqgDlvpySXeZMcSYiNhcFilnUnRVqrt7UxEEzLeTli2cuXdLvwTPlADjQTsxiUuRINcgJZbqSP7nprc8oSsAdTJ0tUtBmVQ9MKnKeiJwpDSm1ikg1ooJ/dCm2oJGAsTNgCU1tVycqwGMN8ACHN4HxsvaPf/6rBtdCjXMWMLsCjWOIRbsFQrToLMGDxq1YDhJQNiGC+Zj6z+lLAKBDpjnLZFwykr47jR9g9Jou5aJ7Qiuf73QRJaDgl/JWh17GaqdWajQR0Y7EN7gc9ssuuTa1hBsfFjsrH14wwGNUgwHVEOBqoHkxqTN49awop6bDtCDeTNYqr8EZXqCFkWeKZVzc7Z6qO8WMLAVBYWRGDY+In0p3mil49uXF83UGudsWNKDGCy7VgwWsCtOdSRGxMy7O2AVTd1Dw9sownphOgLjNmDFRh80jyV5nVZrUGPKGGzip3U6YDFiHch3MA/t2Os92udmQ9PRQJaqzbABv+PYVGFgNBYesbMmmMfS9WFPuOXRpS31Hxkav2/2/bEutdr8fW2qt+x3ZUpsArPOe3i6AFuk3c2WH9wbfPOC9RKcN+nFv7gle1uuw9F3PQ3DFDv1r+19l/nm5f4tJaG3Gyq3rzBm/GURDv9uFf6aEoK8R4itXVGVT0sm/BeHdfco3n4GvUnEzsn5K+r/qXGRRAjhboDdX3W8msbqvfIVNniaDJxHf5093X37c7e3xXb0rXqxHj3c3ds/zN68eP33UYZOnvaj/avKm/8q8fZ3q3feSR78+Td6JV3rweL14++adevtmV719/cLQ1+vbA5GIwZNfeDRZfz/od/mzx0+77173xoMnv3TfvXqUv8PJf+m+Oz/vRtne44HYhj752zf/xfff76w+/7jz8fnRzuXzj+mjDt378P7xZfTo+fnORvvdrmo/3x/89v6DyV+sx6t7b/jGJnvOXouj7rOoQQ1cpFywM3/UZ7jvMzhsS0lr8479UGbMJKgvYmkSJaHuSW7rexg1IXREuSCAOnWPVMCUuo1fPg2ymxCx1u2e9UokrM8iYVdgBD+WADqS50x83Z3Wlzd2eQD1MksroRVw2wnbg8Zm69/tJjWLCsXNJNg6vgou2zTnbdu+dXx6fRoGgFgJz0i51AgxNUmwFaxMvypBJSZ8szi+sjxYMpqmIoboiBlmozlfueh1esF1OD1mLnPe0J8V7U8dog0dcTG6bdxphaJDOEZ7Ug1EVTpuzn9joOS6c6j3CgMO5JMwCsYMYB6o40X1Frfjz9i/ks17+KrOcvopy79kNR6npu/hOc9NtdemY//Ug6835eNNUG0oKB9Y4M9SyT+uKLZ8nfAKdQ810f7aGqpsD3uo26xuotqwtnF9ahFcc0disGvdp2bjOhrOIfep6SwJginnRMNDMO0gWGisL7DV3ZJTNmkJyDxTcL1hgc3BltcgmriCyAfA1WoXcbXWRVxtdhvKi9thNUOlgqCeUaoZqEvUVQnQF06B/rgYSiReR1H7OROH4MkD2YLEP6NysjSSWVmwo9XyQ/7457/KUa1WafDTskLYfqFILsdMQWU1rCyWsksOVi1WfcuwTeNbJYZy0yxlWsMDpjBsZMuiQWIfuA+dgyqiOR1AdTJwf2G4MsY91uSv7pDXCYNQAmj6Qdk8xwuWgswt/QL1ymZjqc6HqRxDwTAygGI+4BliIqEisk4oKwnQmQJWMTj4csU11ChSADW3sElhFI0MyaigI/SGhKSOrJilHMQlUXIAPlot08J6IQ3lqVQ2Sg03hGEEiMSdyxyaUG8G951iCdDuhXNF6tC6gi2Tu5pnA/C65wALjxh6ZAqRSihPBt77Ik1JLo31qIN6XocRhhtFhQad2sLiz6BEmPMSMu1CuV9qBif8jItzW0SlTY5LunrNBpob1kyxnOa/B80xT7j5tRhAiSapuZFqUo0ecZMUAxTX9UnKH3amJ76sXk0YV3PEMtJztEAZ6RXIBl05ZAYoRK9sH+zibf+A/PGP/ybPGFWCJHJsqTUqFEsnVQU/LDaHJ2/RVl7W6IemBVSsM0ikYuSfRnRZHY6aP/7xP5rssTH44yxL2dCQg2KQ8qgsnahbrS3y2BZILGsiNlPCbKA+PA5QktvRKRfnHbItJrYSIL6hADHAdxzX2Aa69hdUJKzqEB7VVmeZZukFQz8pVAUaMKwviE8uShYju1odGLe5Zs4C7G07jkk+lbcAzroKHOuPwrcOah1TUMNvTqpDI6egWW2IiRjriuktgkpNNX84lcyAzx8zn3weRFUi0k5TK1MJmHQ7Lr/aUJ0pRaIpbxUbMgUL6kaBSJpzR07HnixJM3f508naGqbC0Ai1WH9J0pzPdWdDVTW9PzyE8puRt6oWcPQKdl4JwiDlEXNWsru/tp8cPCMXq51uENbUszsw98qz3cc7e4c7AAwIUouwXqfX6aIzT2qTUVFbCcuMloQ6fbXVwqCW1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UnJsjrpsjrpV9r7sjrpsjrpsjrpsjrpsjrpsjrpsjrpsjrpsjrp17tvl9VJl9VJl9VJl9VJl9VJv6Oij8vqpF+DApfVSZfVSZfVSZfVSZfVSZfVSZfVSZfVST/ZebWsTrqsTrqsTrqsTrqsTrqsTrqsTvr/tDppLfltJU8pF7W0bZtdejxVs/Q0DBLIPt06Dq6ugPBeqvT6Gj5/KDDT7vg0DC6o4hCwhYmroU+0hGy7czYJtoLHNv6sfQTLh/acMcNhKl8XMkXtiG3c+o196wmyB/uHR0EYDFxd1UzGmMpPx5CdR8c2QbGWwoffroKUilGB6X+BnfPalr5Jmoml55hY6v6o5RBSMalB2Mw4tduA/8Om5g64urJJq9fXZX/btHCEQ6zvDcd3en19/b9ATyW9",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,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:"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.p,{children:[(0,i.jsx)(n.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,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)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",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/c4fbe420.8c4aab4f.js b/assets/js/c4fbe420.8c4aab4f.js new file mode 100644 index 000000000..fbcb3be78 --- /dev/null +++ b/assets/js/c4fbe420.8c4aab4f.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:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=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":"eJztPNl2G7eSv4LpM+ck5m1SJCV50byM4iiOHGsZS14lXQXsLrIhdQNtAC2K1tE59+H+wTzN6/20fMmcwtILF0m2FceeYR5isbEVClWFWlB1FWg6UsHGUXAIWZ5SDSo4CYMYVCRZrpngwUZwmADxzeRnSYea8RHZ3N8mwOkgBUUKBVIRLUgkATtFhdIiYx+xlWg/c0gUyAscSxUZpAXkknGtyFBIMgIOkpqJYxEVGWDDmOmE5BJiGDIOMVFaFpEuJKgOeZULTlQRRaDUsEjtykxwIoaElmuGRCdgQJWgC8kVoaTg7EMBpNUSgzOI9HbcapEfY1BsxKmGGIHzw09Z/CAk44RFCYkoJwPArca4Uwcw1MAdUGwT3KypcojYkGFnN1mHbMYxQxhpmk5CQkmrVci01SJMkVyKCxZD7FcTwyGilBrUEsY1yCGNwOAKcBY+Msv4yQnlMRnSiKVMN9FIYqa0ZIMCV+4c82N+yPIN8ipPBY3JRBSS7P/8S9VdC4Lfjlqtn2FQjMir7Vbr5MdE61xtrKzQPO+IHDhiK6UD1YlEthJjxzweGlyBBJzV4AuoYumE0DgmYxaPQCtzIJxEIp+QSAgZM25JI6cjILzIBiBVaHaTCQmEcUKJBBpP2lq0CwXk+cHeLqIho7pD9tNCheVyMZMQ6XRip0f0+F39YE/n4RrSEOOjkGT0HLHENPlQsOgct62Am6N1JGNw1Wq9QXhL7DDlaDwmRCdMkTEMEiHOCVxg85ilKdGSjUYgW61j/vvvvx/zq2NOyHFgehwHG+Q4cFMcB6Ft0pMcbMvPe09f7WztHp4evtvfKts9pU712f657DFk6fQMr16+KJs5zaabdzd3qgW40K59PwWqgEi4YDA254BHbffqsVAOq8kJO7pswUEgFX49wi+EXNl/mtAcbD/b3XpZh8X2gIyytNFla2dz+0WjT54I3pxm/9e93eY8hazNsr37zCLFtl/jPycOXncim+6ADrd3tg4ON3f2sfO1O0ekhoMiz4XE439jCXoDj/mY/wSpGBMqwVBPJLJMcJJTSTPQRjYmVJtmCR8KJiG2wo2mqeeMjWPeJq0WksJGq0W2ecwiZA3L5pMcULLZvh3bFVkGux44UWO71hgJZZEVJ8ghY2q5O09RkGBXCSilNLuA5sSXIZngxD8D0oWdNhGSfRRc09QQxQVIzSKa1pkYATSiT1NpRFAuGNf+q1uBvHPMirxsWNRJGQQtRmRljJsWBeSCpgUoB9U4JAlC9RJyCcpIXDcvIpLHJAE2ShauR+OzQunGxKRQXo56KNxa/pQMesGgbUhTBYQNG7jM6DnUViMit/K9Q36akBiGtEh1SBjKHy0L6JBdoQnN85RF5m5EcW4vnkJC25yyIwcHCLIKArFv7we8EWKGdwNKG2w0U7gxHjqkM3uh4PaMHNUJ5UTwqYOORCrkLAmZz008kkhwDVx3yOYFZakB3m5WEcajtIiBDFIanYfmZg+JxLsMT2UCaSrGoaV308XcsAbnBj9EQYpUKDjCz4VbnqnqDu2QQ5Q/JT9ho0e1WYSpOladDB8KXBlR4FmMGLkSGsSF5EwMiGY6hRAZNqd8EpLYKg1wqQfiMiRRAtG5+UvSmAkyKLQW3G4sliKPxZg7XA4F14p9nMORvuXTMdoPyVpIHobkcUh63ZD0+iHprYWk9zAkvcch6XdD0u+HpL8Wkv5DC1b/scM1LRFcB6DXt1jW3w92Ue6+YMpwNgpMVcrgcUMG9zqk1Sq5afr6re7Yskt5W6HMxLae+32JP1b7j9zPCf582H/sfo5N196a+5ngz36vfk/0DSSaZvkNUGDzvULglQVLRPjN3bnHgZdn+BEFUegbqqvYwYMN1/W9rOJeGGea0VQt3o7v8Q3tqAJpZlNruClDrot35HSQb2Y7dXiMyoJi0jYZsVpr8gxvoOjP7H69426WxZu3y34ze6+B82Vbf4hbR9F0iKJp8f5L6fUNIWEapi/DxKOOUQCMZF6MB9fhG8JCE6Ivw8FjxAFeSosRgK3f0O5r4FgDzNzwtq271u6tt/vd/loDA2gp2w5Z1o7j9mQyuQ/soc7jlkeVx2uoVrNDj8RQimyO+WGsg6qX04nM315l30FFfQClUwS9AE2firf/61q2FjGd/KDsVH5oqZxh/0o1m9TANE0Ih/GFRIlgkQMe+3iVbIAGXgdx0DaYXInjlRom8WMct7OsPfURf7YN4msfs6wTx52pnjOnYz9mJI5DMvt57vc4JlmWLfhsvzc+r2TZ7C46WeZgM8rXE2QSp7Mt5hPX4WuxSsURzYVvZCP0IwmemrWNOTefj6Yum4R5t40jKjLVQcKoSKmES7RL1bQv5B55zLNYpdkbO9aYgNYZaFBBftxz2vsDR/64heYE+OX2cTM7w0k2nXuXSBjBJcmp1iC5meyCpiy2bti2dVVe0ixHE2Dl78fH8d/+fcU4INDG1wRPgsRsxNAruPL3o832+5M5PYo8BxmhTyoFXEmFBHTUIUcJpHnlmByPx53xqooSIVLrlTxTEob2/6dicHZqwM07VOUP5u3UkkbN4EfSmbb3FegGxqgifuQck9/QmOGhXtfcts7eueG6dT2+oRtnCiRstN4T69sLMmoUEiRlqP4WOgF5HJyUY6yRD/EtY0/uwKwJiyGlA0hnm+7MaOXnlE5E4fjbO7WaW3UUXcMbNmSMl34Ls51uze2Y0cupxuPK5TjF3xYhde70V45nT38CJGXKe26a6KyPdq4t43DkYIMVAyB+ABmUVPrFXFACdjc2sJLInd0tS2A/YjqWbkW/2i0rNA6mjhicI2OcZUVW+keH5aweZZnTPer4wpEYh/Er1E93ZgV6ecsKLpC0YIFj3jN+DO//uEEzdT2+IVkxBdLNbPw5UqRxT9/TBXs7A/pt1RlwzrWMXe2FXDKfWsx9HbKH1xv6ZO0g9LJFEeQaPXJfypolyHe+oYzPqu6HW0x59V7fEPXNAetPpkDX775vn88i0vruvyNCbYB9Z2K1TsmMjm6w3E3zN0SeDp4ZJ0SrtS9hiIHjKqRI/Ccf2cGQDqSQubCXCybiVWcc4YxrgWaBD1MPYGii5yZgrRJaBRztPWOPtB4ht2FtIUlCldW/jcKPR4Xhe51ANuWK96BV7njGPdx4Kr37sxv7T7r1c+o9XG+c03q3cU7dRed0g9mIJ6hywVXpa4OqqcbXsozaz71aptnWT4pHuoWPOErrwTKDKNKYpOzcRFVipvKUTvBUPZc6KKfDdU8TIVTVw0XMfnQb3mhG4oTEYNyDThmYuIvDa+owamfRe7RaO4r1x4+bHNNgmLvY79V6s6fQXVvpra9Yj9Z8h1blhlkshG/QBAi5y3kZP9Gdzsv0rA5s6Xb6XLfT/ZD76n1a3b1H/cZlsdr93Mvi3o3rOtfcYlbfh/F8b1Zsnd3uaL9+NTvyy6lv7c/QqHuPVutU+Kh3Dy7UBYrzl1LijH58b7RH7ks5nkeAd9COb1SJv5hA68D+6US6fj+adK/b0NCeNBS0J/06Ua6v34ko64tOUdZxwF7/tPdy3P3t2Uhsbm5u7h68SrZejTY3NzP83el05hpR807bLIOaq3sf6u5lc8cvWKXT6SAKY6rphhm+kvPRf9jx4eIxHRd9/pM8O+v3EUyZ48D5cilQdv3rvDV/Hp9/KQcGYSBy8/Rd8O042AhifGDvn3UHobEsQemfRDwJNq4C92oM/3RvsnDkypnCp/pXgYoSyCj+5S1SfNyPr4OD0D/KDcLAPCPAl/5IdMGGe2AchBjiytEPAQrnMOM2rnwv+3Y6CJ0OHmwEluiDMHCBnvITAR4JDN3m8TC49gveNFX5pZpKmT/KN+44Dz5I/cxpzNDrqeSGz5qpPsN1hdZqMiolnQTTeRT+JaoPI9px5VO7dOLvBqbRE1I+jzTdgjBgGrL6KgsOTYpPx3QEAndinhh96lhzLDT75DVxnHnD/TkD3SuQzxl6Jgann0WOONg5Peac9R1Px7bOLtwklU18WwmxV4bb1SPhkJiHep3bKNX3N1imo/qaNjQxs+bhosfjtTerKjEWMM1zoLJj3nB/drKIyReiaVSY/JVSGjd2VoJa7qx3HQaXt2/mkkSi7V+mkx9TGGobSSaRkBzkg/rzlG9mc/21teswmNy+vcl3ub1HeHjj23f3xjzpr9Id/gpYVx9fh0FyO6y/lkkHfyGwaw+vqzvW5bKUOWwDEU9Ovdy6vq2jv8ywHyZEbfM9GYOsIWIgRAqUz2Bie2id+oL8gIbOD6F9v2HeijOp/EVmc6QkRIB5J+ZZl5dVxOk69iE5ce93MRawhR+MdqaKgcJe3M+n7IQD8HlXmChoezCbaGcc30CjBDO83KsSOvTOvRxTnUShPHjo/8bbJQV0aesEmE3RYHzUNMZq2DFe9vreO/XTwS94uZpkyb3D/Tvg0liKbZt1ZfUDu0s7B9k73McMHDZ06l+HvFIlJjxqaaMLQXWMXDDqX+mXsn1iY95g3Z3C53tVoYGOy31pk1mAYqbmQhTiS32bHlAmh85MXCXs4RGJQmOowWVIEqUhVw08GihKRB6K4i5UeQsmKRkV5omhRpb16TjmlVGVQcO4zTw1ZkZcSJ805MgCe2IaaoUnjxXsVJs/JMCVHU7JkCoNMsR0VMS8LNCoKKeEyxwkAx7BXBRIsKg7LeRcfa2Jg2Y6yquXL1yapt+DZ8oBcqCdGGJS5IZqDCeUaVL+5Ka3PqMoIXeAPF2kGM6qHiaZyXlAcpAKU3klEXJEOfvoUntRI0EjawAJTW1XJyrQU47wIIc3gfGy9o9//qsG10JNdxYwuwKNY3wDdwuExpK0BI+avoQcJaBoQoTzgfzP6UsAoTNMc5qJuGQkdXca3zev5lQpF13orgwbqiJK0LAo5a0KvYxVTq1UxjQ19quJ/eW4X7hkStcSffxz3Fn58BIQj1ENBqOGIFcjzfNJncGrcKaYms6kI7Fmklh5Dc7wAi20OJWQMX63e6rujNOiFASFFhnVLCJ+KtVppv7ZiI/n6wxzxi1oSI0XTMgHC1gVpzsVPIJTxk/hAuQdFLzd8vlQTCdI3HoMwOuweSTZ66xKzxpjvnIDJ7XbySQh1qFcR/PAxmzn2S43G7CeHqoEecgG+HbARp+R1YzgEJUN2zSGvhdryoVhl7bUd2Rs9Lrd/8u21Gr3+7Gl1rrfkS31GIF1XtvbBdAi/Wau7PBe6JsHnAmwHq5UyJt7onf3Oix95vMQXLFD/9r+V5l/Xu7fYhJam7FyJztzxm/GoKHf7eI/U0LQ1ybxFTOqci3p5N+C8O6+7JvPwFfHuBlZPyX9X1XOsyhBnC3Qm6vuN5NY3Ue/ApPnyeBZxPbY8+1XH7d7u2xbbfOX69HT7Yfb5/nb10+fP+nA5Hkv6r+evO2/1u/epGr7TLDo1+fJe/5aDZ6uF+/evpfv3m7Ld29eavpmfXPAEz549guLJutng36XvXj6vPv+TW88ePZL9/3rJ/l7M/kv3ffn590o23064JvYJ3/39r/Y3tnW6s7HrY87h1uXOx/TJx26++Hs6WX0ZOd862H7/bZs7+wNfjv7oPOX6/Hq7lv28DHswBt+2H0RNaiB8ZRxOPVHfWr2fYqHbSlpbd6xH4gMdGL0RVMSRQqst5LbuiJaTggdUcYJok7eIxWAlLfxy6dBdhMi1rrd016JhPVZJGxzkzlgSg8dinPgX3en9eW1XR5BvczSSmgFzHYy7UFjs/XvdpMKokIyPQk2jq6CyzbNWdu2bxydXJ+EASJWYPgqF8pATHUSbAQr09EsrABlYiVHV5YHS0ZTlMf4KmOG2WjOVi56nV5wHU6PmcucN/SHov2pQ5SmI8ZHt407qVB0gMdoT6qBqErHzdlvgEquO4d6rzBgSD4JUDRmEPNIHS+rGOCWP2MfnZsXcKvOcjqE5iNojaDY9D08J8xVi3Id+RCTiRqVQaOg2lBQBnaCoBaqwR+14Av+LA2Ao4qay8iFV7Z7Rkvtr60Zde5Rz+g9q4+NSrH28PrEIr/mqjQPcOv+NvvWpOE4cp+ajpQgmHJcNLwH086DhYb8AjveLTllr5aAzDMT1xvW2Rxsee2iiSt8jYG4Wu0aXK11Da4edxuKjdthNUOlnhgdpFRBjJ5RVzNQlzhB2mR8KAxhuxPdy4EfoJcP5Y5hjBl1FNJIZGURkVbLD/njn/8qR7VapTOAllXL9gpJcjEGidXeTLWzFC4ZWrymEl1m2pSJn5rn5TRLQSkMqnINI1uqDZMN0bXonFcRzekAK6aha8w8oTZvMWuyWXXImwTweQM2/SBt7uUFpCiPS59BvdraWMjzYSrGWMSMDLDAEHqNgCeUR9ZBZaWEcbSgxYzOv1wyhXWTJELNLGyCa0kjTTLK6ch4SkJSR1YMKUNRSqQYoP9WibSwHkpNWSqkfTlnNmSeNhgkbl3m2GR0auRLCQnS7oVzU6rQuomtAHB12Abokc8RFhaB8dYUPBVYMg09+0Waklxo621H1b0OIw7XknKF+raFxZ9BiTDnQQTlnpe/UoAn/ILxc1vYpU2OSrp6AwPFNDTTPqf570FzzDOmfy0GWDZKKKaFnFSjR0wnxcCI8vok5Q870zNf6q8mqKs5YhGpORqiiNQKZqiuHIBGClErm/vbRhN4QP74x3+TF0AlJ4kYW2qNCgnppKoqaArgmZO3aCsvcuOjpgVW0dOGSPnIh01UWbGO6j/+8T+K7MIYfXWWpexzlf1ikLKoLOeoWq0N8tQWbSzrNDbT1GzyAAYOKMnt6JTx8w7Z5BNbndDEV5AY8LsZ19iGcfsvqJJY1UY8rK0OmYL0AowPFSsVDcDUPDThGCmKkV2tDozbXDOPAve2Gcckn8qlQEdeBY71VZk4CLVOK6wrOCf9opHn0KyABDw2tc7UBjEKTzV/OJVgYUIjM598bkZVttJOUyudiZh0Oy6/2udDU0pGU95KGILEBVWjaCXNmSOnI0+WpJlP/elkbY1WrmlkNFx/SdKczXV1Y6U3tTc8wJKgkbe4FnD0ium8EoRByiJwFrS7vzaf7b8gF6udbhDWVLc7MPfKi+2nW7sHWwgMClKLsF6n2+kaR59QOqO8tpIpfVoS6vTVVnuatayYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYSpYVU5cVU7/S3pcVU5cVU5cVU5cVU5cVU5cVU5cVU5cVU5cVU7/efbusmLqsmLqsmLqsmLqsmPodFaJcVkz9GhS4rJi6rJi6rJi6rJi6rJi6rJi6rJi6rJj6yc6rZcXUZcXUZcXUZcXUZcXUZcXUZcXU/6cVU2vJbyt5ShmvpXTbzNOjqTqqJ2GQYGbqxlFwdYWE90qm19f4+UNhMu2OTsLggkqGD7ZMUmvokzAx2+4cMH/xqX1/1j7E5UN7zibDYSqXF7NI7YhNs/Ub+9aTZ/f3Dg6DMBi4Wq+ZiE2aPx1jdh4d2wTFWgqf+XYVpJSPCpP+F9g5r21ZnKSZdHpukk7dH7UcQkzOrCBsZqPabeD/cVNzB1xd2YTW6+uyv21aOMIh1vfG4zu5vr7+X8+xVkg=","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 s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const 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:"eJztPNl2G7eSv4LpM+ck5m1SJCV50byM4iiOHGsZS14lXQXsLrIhdQNtAC2K1tE59+H+wTzN6/20fMmcwtILF0m2FceeYR5isbEVClWFWlB1FWg6UsHGUXAIWZ5SDSo4CYMYVCRZrpngwUZwmADxzeRnSYea8RHZ3N8mwOkgBUUKBVIRLUgkATtFhdIiYx+xlWg/c0gUyAscSxUZpAXkknGtyFBIMgIOkpqJYxEVGWDDmOmE5BJiGDIOMVFaFpEuJKgOeZULTlQRRaDUsEjtykxwIoaElmuGRCdgQJWgC8kVoaTg7EMBpNUSgzOI9HbcapEfY1BsxKmGGIHzw09Z/CAk44RFCYkoJwPArca4Uwcw1MAdUGwT3KypcojYkGFnN1mHbMYxQxhpmk5CQkmrVci01SJMkVyKCxZD7FcTwyGilBrUEsY1yCGNwOAKcBY+Msv4yQnlMRnSiKVMN9FIYqa0ZIMCV+4c82N+yPIN8ipPBY3JRBSS7P/8S9VdC4Lfjlqtn2FQjMir7Vbr5MdE61xtrKzQPO+IHDhiK6UD1YlEthJjxzweGlyBBJzV4AuoYumE0DgmYxaPQCtzIJxEIp+QSAgZM25JI6cjILzIBiBVaHaTCQmEcUKJBBpP2lq0CwXk+cHeLqIho7pD9tNCheVyMZMQ6XRip0f0+F39YE/n4RrSEOOjkGT0HLHENPlQsOgct62Am6N1JGNw1Wq9QXhL7DDlaDwmRCdMkTEMEiHOCVxg85ilKdGSjUYgW61j/vvvvx/zq2NOyHFgehwHG+Q4cFMcB6Ft0pMcbMvPe09f7WztHp4evtvfKts9pU712f657DFk6fQMr16+KJs5zaabdzd3qgW40K59PwWqgEi4YDA254BHbffqsVAOq8kJO7pswUEgFX49wi+EXNl/mtAcbD/b3XpZh8X2gIyytNFla2dz+0WjT54I3pxm/9e93eY8hazNsr37zCLFtl/jPycOXncim+6ADrd3tg4ON3f2sfO1O0ekhoMiz4XE439jCXoDj/mY/wSpGBMqwVBPJLJMcJJTSTPQRjYmVJtmCR8KJiG2wo2mqeeMjWPeJq0WksJGq0W2ecwiZA3L5pMcULLZvh3bFVkGux44UWO71hgJZZEVJ8ghY2q5O09RkGBXCSilNLuA5sSXIZngxD8D0oWdNhGSfRRc09QQxQVIzSKa1pkYATSiT1NpRFAuGNf+q1uBvHPMirxsWNRJGQQtRmRljJsWBeSCpgUoB9U4JAlC9RJyCcpIXDcvIpLHJAE2ShauR+OzQunGxKRQXo56KNxa/pQMesGgbUhTBYQNG7jM6DnUViMit/K9Q36akBiGtEh1SBjKHy0L6JBdoQnN85RF5m5EcW4vnkJC25yyIwcHCLIKArFv7we8EWKGdwNKG2w0U7gxHjqkM3uh4PaMHNUJ5UTwqYOORCrkLAmZz008kkhwDVx3yOYFZakB3m5WEcajtIiBDFIanYfmZg+JxLsMT2UCaSrGoaV308XcsAbnBj9EQYpUKDjCz4VbnqnqDu2QQ5Q/JT9ho0e1WYSpOladDB8KXBlR4FmMGLkSGsSF5EwMiGY6hRAZNqd8EpLYKg1wqQfiMiRRAtG5+UvSmAkyKLQW3G4sliKPxZg7XA4F14p9nMORvuXTMdoPyVpIHobkcUh63ZD0+iHprYWk9zAkvcch6XdD0u+HpL8Wkv5DC1b/scM1LRFcB6DXt1jW3w92Ue6+YMpwNgpMVcrgcUMG9zqk1Sq5afr6re7Yskt5W6HMxLae+32JP1b7j9zPCf582H/sfo5N196a+5ngz36vfk/0DSSaZvkNUGDzvULglQVLRPjN3bnHgZdn+BEFUegbqqvYwYMN1/W9rOJeGGea0VQt3o7v8Q3tqAJpZlNruClDrot35HSQb2Y7dXiMyoJi0jYZsVpr8gxvoOjP7H69426WxZu3y34ze6+B82Vbf4hbR9F0iKJp8f5L6fUNIWEapi/DxKOOUQCMZF6MB9fhG8JCE6Ivw8FjxAFeSosRgK3f0O5r4FgDzNzwtq271u6tt/vd/loDA2gp2w5Z1o7j9mQyuQ/soc7jlkeVx2uoVrNDj8RQimyO+WGsg6qX04nM315l30FFfQClUwS9AE2firf/61q2FjGd/KDsVH5oqZxh/0o1m9TANE0Ih/GFRIlgkQMe+3iVbIAGXgdx0DaYXInjlRom8WMct7OsPfURf7YN4msfs6wTx52pnjOnYz9mJI5DMvt57vc4JlmWLfhsvzc+r2TZ7C46WeZgM8rXE2QSp7Mt5hPX4WuxSsURzYVvZCP0IwmemrWNOTefj6Yum4R5t40jKjLVQcKoSKmES7RL1bQv5B55zLNYpdkbO9aYgNYZaFBBftxz2vsDR/64heYE+OX2cTM7w0k2nXuXSBjBJcmp1iC5meyCpiy2bti2dVVe0ixHE2Dl78fH8d/+fcU4INDG1wRPgsRsxNAruPL3o832+5M5PYo8BxmhTyoFXEmFBHTUIUcJpHnlmByPx53xqooSIVLrlTxTEob2/6dicHZqwM07VOUP5u3UkkbN4EfSmbb3FegGxqgifuQck9/QmOGhXtfcts7eueG6dT2+oRtnCiRstN4T69sLMmoUEiRlqP4WOgF5HJyUY6yRD/EtY0/uwKwJiyGlA0hnm+7MaOXnlE5E4fjbO7WaW3UUXcMbNmSMl34Ls51uze2Y0cupxuPK5TjF3xYhde70V45nT38CJGXKe26a6KyPdq4t43DkYIMVAyB+ABmUVPrFXFACdjc2sJLInd0tS2A/YjqWbkW/2i0rNA6mjhicI2OcZUVW+keH5aweZZnTPer4wpEYh/Er1E93ZgV6ecsKLpC0YIFj3jN+DO//uEEzdT2+IVkxBdLNbPw5UqRxT9/TBXs7A/pt1RlwzrWMXe2FXDKfWsx9HbKH1xv6ZO0g9LJFEeQaPXJfypolyHe+oYzPqu6HW0x59V7fEPXNAetPpkDX775vn88i0vruvyNCbYB9Z2K1TsmMjm6w3E3zN0SeDp4ZJ0SrtS9hiIHjKqRI/Ccf2cGQDqSQubCXCybiVWcc4YxrgWaBD1MPYGii5yZgrRJaBRztPWOPtB4ht2FtIUlCldW/jcKPR4Xhe51ANuWK96BV7njGPdx4Kr37sxv7T7r1c+o9XG+c03q3cU7dRed0g9mIJ6hywVXpa4OqqcbXsozaz71aptnWT4pHuoWPOErrwTKDKNKYpOzcRFVipvKUTvBUPZc6KKfDdU8TIVTVw0XMfnQb3mhG4oTEYNyDThmYuIvDa+owamfRe7RaO4r1x4+bHNNgmLvY79V6s6fQXVvpra9Yj9Z8h1blhlkshG/QBAi5y3kZP9Gdzsv0rA5s6Xb6XLfT/ZD76n1a3b1H/cZlsdr93Mvi3o3rOtfcYlbfh/F8b1Zsnd3uaL9+NTvyy6lv7c/QqHuPVutU+Kh3Dy7UBYrzl1LijH58b7RH7ks5nkeAd9COb1SJv5hA68D+6US6fj+adK/b0NCeNBS0J/06Ua6v34ko64tOUdZxwF7/tPdy3P3t2Uhsbm5u7h68SrZejTY3NzP83el05hpR807bLIOaq3sf6u5lc8cvWKXT6SAKY6rphhm+kvPRf9jx4eIxHRd9/pM8O+v3EUyZ48D5cilQdv3rvDV/Hp9/KQcGYSBy8/Rd8O042AhifGDvn3UHobEsQemfRDwJNq4C92oM/3RvsnDkypnCp/pXgYoSyCj+5S1SfNyPr4OD0D/KDcLAPCPAl/5IdMGGe2AchBjiytEPAQrnMOM2rnwv+3Y6CJ0OHmwEluiDMHCBnvITAR4JDN3m8TC49gveNFX5pZpKmT/KN+44Dz5I/cxpzNDrqeSGz5qpPsN1hdZqMiolnQTTeRT+JaoPI9px5VO7dOLvBqbRE1I+jzTdgjBgGrL6KgsOTYpPx3QEAndinhh96lhzLDT75DVxnHnD/TkD3SuQzxl6Jgann0WOONg5Peac9R1Px7bOLtwklU18WwmxV4bb1SPhkJiHep3bKNX3N1imo/qaNjQxs+bhosfjtTerKjEWMM1zoLJj3nB/drKIyReiaVSY/JVSGjd2VoJa7qx3HQaXt2/mkkSi7V+mkx9TGGobSSaRkBzkg/rzlG9mc/21teswmNy+vcl3ub1HeHjj23f3xjzpr9Id/gpYVx9fh0FyO6y/lkkHfyGwaw+vqzvW5bKUOWwDEU9Ovdy6vq2jv8ywHyZEbfM9GYOsIWIgRAqUz2Bie2id+oL8gIbOD6F9v2HeijOp/EVmc6QkRIB5J+ZZl5dVxOk69iE5ce93MRawhR+MdqaKgcJe3M+n7IQD8HlXmChoezCbaGcc30CjBDO83KsSOvTOvRxTnUShPHjo/8bbJQV0aesEmE3RYHzUNMZq2DFe9vreO/XTwS94uZpkyb3D/Tvg0liKbZt1ZfUDu0s7B9k73McMHDZ06l+HvFIlJjxqaaMLQXWMXDDqX+mXsn1iY95g3Z3C53tVoYGOy31pk1mAYqbmQhTiS32bHlAmh85MXCXs4RGJQmOowWVIEqUhVw08GihKRB6K4i5UeQsmKRkV5omhRpb16TjmlVGVQcO4zTw1ZkZcSJ805MgCe2IaaoUnjxXsVJs/JMCVHU7JkCoNMsR0VMS8LNCoKKeEyxwkAx7BXBRIsKg7LeRcfa2Jg2Y6yquXL1yapt+DZ8oBcqCdGGJS5IZqDCeUaVL+5Ka3PqMoIXeAPF2kGM6qHiaZyXlAcpAKU3klEXJEOfvoUntRI0EjawAJTW1XJyrQU47wIIc3gfGy9o9//qsG10JNdxYwuwKNY3wDdwuExpK0BI+avoQcJaBoQoTzgfzP6UsAoTNMc5qJuGQkdXca3zev5lQpF13orgwbqiJK0LAo5a0KvYxVTq1UxjQ19quJ/eW4X7hkStcSffxz3Fn58BIQj1ENBqOGIFcjzfNJncGrcKaYms6kI7Fmklh5Dc7wAi20OJWQMX63e6rujNOiFASFFhnVLCJ+KtVppv7ZiI/n6wxzxi1oSI0XTMgHC1gVpzsVPIJTxk/hAuQdFLzd8vlQTCdI3HoMwOuweSTZ66xKzxpjvnIDJ7XbySQh1qFcR/PAxmzn2S43G7CeHqoEecgG+HbARp+R1YzgEJUN2zSGvhdryoVhl7bUd2Rs9Lrd/8u21Gr3+7Gl1rrfkS31GIF1XtvbBdAi/Wau7PBe6JsHnAmwHq5UyJt7onf3Oix95vMQXLFD/9r+V5l/Xu7fYhJam7FyJztzxm/GoKHf7eI/U0LQ1ybxFTOqci3p5N+C8O6+7JvPwFfHuBlZPyX9X1XOsyhBnC3Qm6vuN5NY3Ue/ApPnyeBZxPbY8+1XH7d7u2xbbfOX69HT7Yfb5/nb10+fP+nA5Hkv6r+evO2/1u/epGr7TLDo1+fJe/5aDZ6uF+/evpfv3m7Ld29eavpmfXPAEz549guLJutng36XvXj6vPv+TW88ePZL9/3rJ/l7M/kv3ffn590o23064JvYJ3/39r/Y3tnW6s7HrY87h1uXOx/TJx26++Hs6WX0ZOd862H7/bZs7+wNfjv7oPOX6/Hq7lv28DHswBt+2H0RNaiB8ZRxOPVHfWr2fYqHbSlpbd6xH4gMdGL0RVMSRQqst5LbuiJaTggdUcYJok7eIxWAlLfxy6dBdhMi1rrd016JhPVZJGxzkzlgSg8dinPgX3en9eW1XR5BvczSSmgFzHYy7UFjs/XvdpMKokIyPQk2jq6CyzbNWdu2bxydXJ+EASJWYPgqF8pATHUSbAQr09EsrABlYiVHV5YHS0ZTlMf4KmOG2WjOVi56nV5wHU6PmcucN/SHov2pQ5SmI8ZHt407qVB0gMdoT6qBqErHzdlvgEquO4d6rzBgSD4JUDRmEPNIHS+rGOCWP2MfnZsXcKvOcjqE5iNojaDY9D08J8xVi3Id+RCTiRqVQaOg2lBQBnaCoBaqwR+14Av+LA2Ao4qay8iFV7Z7Rkvtr60Zde5Rz+g9q4+NSrH28PrEIr/mqjQPcOv+NvvWpOE4cp+ajpQgmHJcNLwH086DhYb8AjveLTllr5aAzDMT1xvW2Rxsee2iiSt8jYG4Wu0aXK11Da4edxuKjdthNUOlnhgdpFRBjJ5RVzNQlzhB2mR8KAxhuxPdy4EfoJcP5Y5hjBl1FNJIZGURkVbLD/njn/8qR7VapTOAllXL9gpJcjEGidXeTLWzFC4ZWrymEl1m2pSJn5rn5TRLQSkMqnINI1uqDZMN0bXonFcRzekAK6aha8w8oTZvMWuyWXXImwTweQM2/SBt7uUFpCiPS59BvdraWMjzYSrGWMSMDLDAEHqNgCeUR9ZBZaWEcbSgxYzOv1wyhXWTJELNLGyCa0kjTTLK6ch4SkJSR1YMKUNRSqQYoP9WibSwHkpNWSqkfTlnNmSeNhgkbl3m2GR0auRLCQnS7oVzU6rQuomtAHB12Abokc8RFhaB8dYUPBVYMg09+0Waklxo621H1b0OIw7XknKF+raFxZ9BiTDnQQTlnpe/UoAn/ILxc1vYpU2OSrp6AwPFNDTTPqf570FzzDOmfy0GWDZKKKaFnFSjR0wnxcCI8vok5Q870zNf6q8mqKs5YhGpORqiiNQKZqiuHIBGClErm/vbRhN4QP74x3+TF0AlJ4kYW2qNCgnppKoqaArgmZO3aCsvcuOjpgVW0dOGSPnIh01UWbGO6j/+8T+K7MIYfXWWpexzlf1ikLKoLOeoWq0N8tQWbSzrNDbT1GzyAAYOKMnt6JTx8w7Z5BNbndDEV5AY8LsZ19iGcfsvqJJY1UY8rK0OmYL0AowPFSsVDcDUPDThGCmKkV2tDozbXDOPAve2Gcckn8qlQEdeBY71VZk4CLVOK6wrOCf9opHn0KyABDw2tc7UBjEKTzV/OJVgYUIjM598bkZVttJOUyudiZh0Oy6/2udDU0pGU95KGILEBVWjaCXNmSOnI0+WpJlP/elkbY1WrmlkNFx/SdKczXV1Y6U3tTc8wJKgkbe4FnD0ium8EoRByiJwFrS7vzaf7b8gF6udbhDWVLc7MPfKi+2nW7sHWwgMClKLsF6n2+kaR59QOqO8tpIpfVoS6vTVVnuatayYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYSpYVU5cVU7/S3pcVU5cVU5cVU5cVU5cVU5cVU5cVU5cVU5cVU7/efbusmLqsmLqsmLqsmLqsmPodFaJcVkz9GhS4rJi6rJi6rJi6rJi6rJi6rJi6rJi6rJj6yc6rZcXUZcXUZcXUZcXUZcXUZcXUZcXU/6cVU2vJbyt5ShmvpXTbzNOjqTqqJ2GQYGbqxlFwdYWE90qm19f4+UNhMu2OTsLggkqGD7ZMUmvokzAx2+4cMH/xqX1/1j7E5UN7zibDYSqXF7NI7YhNs/Ub+9aTZ/f3Dg6DMBi4Wq+ZiE2aPx1jdh4d2wTFWgqf+XYVpJSPCpP+F9g5r21ZnKSZdHpukk7dH7UcQkzOrCBsZqPabeD/cVNzB1xd2YTW6+uyv21aOMIh1vfG4zu5vr7+X8+xVkg=",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={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"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.p,{children:[(0,s.jsx)(n.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.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)(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 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},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",description:"Allowed values - signature, stamp.",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)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.0a9740c7.js b/assets/js/c7e3ab5f.cf9a081c.js similarity index 84% rename from assets/js/c7e3ab5f.0a9740c7.js rename to assets/js/c7e3ab5f.cf9a081c.js index 5e2d7999d..555ade2bb 100644 --- a/assets/js/c7e3ab5f.0a9740c7.js +++ b/assets/js/c7e3ab5f.cf9a081c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>h,default:()=>I,frontMatter:()=>f,metadata:()=>n,toc:()=>P});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/U5O8ONtAXseHw8njLJu0i1tHuWDl+KT0fbZrdL/Wnfld0SQPhIE2+kTjtYAnXTLU93YvfOnO09Ke8zUblIzLDZ8BX/KZjtlsm/NBh4R7vPxFIGLXPeFO42QunIv9XwQPwoml/+2L01X8HvfZ2+GEi/4ljeb5bSNPwlMrHA9eH7eHu/zfo1h11tGc6KAj3tiT5bmA+2zm/PL89vzkUmuFkfbliLtGF1P9jAi54drl6tD/yX98AXBTabdnvbbgf+9uijEl2MPTfDdL/dbv8LlLoOMA==","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),l=o(33617),r=o.n(l),c=o(17543),s=o.n(c),d=o(86013),p=o.n(d),m=o(63723),u=o.n(m),b=(o(18766),o(79329),o(9303));const f={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/U5O8ONtAXseHw8njLJu0i1tHuWDl+KT0fbZrdL/Wnfld0SQPhIE2+kTjtYAnXTLU93YvfOnO09Ke8zUblIzLDZ8BX/KZjtlsm/NBh4R7vPxFIGLXPeFO42QunIv9XwQPwoml/+2L01X8HvfZ2+GEi/4ljeb5bSNPwlMrHA9eH7eHu/zfo1h11tGc6KAj3tiT5bmA+2zm/PL89vzkUmuFkfbliLtGF1P9jAi54drl6tD/yX98AXBTabdnvbbgf+9uijEl2MPTfDdL/dbv8LlLoOMA==",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,v={},P=[];function k(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(b.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)(b.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 I(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file +"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.388e6290.js b/assets/js/d0524430.5aa106b8.js similarity index 98% rename from assets/js/d0524430.388e6290.js rename to assets/js/d0524430.5aa106b8.js index 607a4f696..f362b59ea 100644 --- a/assets/js/d0524430.388e6290.js +++ b/assets/js/d0524430.5aa106b8.js @@ -1 +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/1TmH3XPGRR7fT6E5u7ddo76Z5fdUkZSqTBYUfNo+YhDdF1Y8pVbaWropV3vdHK2z7iluvL2L4BuC+e7BuA++7PvgG4h8C+AbhvAO4bgPsG4JeXNPYNwD2ivrIGYFEUdfjoWpnkwhehi95aqB/flm0w6smlVFlu37LlkooT10auVjT8a46GytJ3EZtxI/iIapy3d6uoLKVSwfkBF6zNTsKT72BACxO5zENVdqsWT7XgwNGJY8zcTtp68bt/cTVgERsV/cqpTojH8Dn1MvmctZnve/oCoO+o0diSSa4mOZ8QbZBJ1V+qHm2Wjh986bj4QVaVU2pR03CzphzMoE8y6lmG5TKUpVerij5MvZejcGxJTYG7W61WfwAgfhsY","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/1TmH3XPGRR7fT6E5u7ddo76Z5fdUkZSqTBYUfNo+YhDdF1Y8pVbaWropV3vdHK2z7iluvL2L4BuC+e7BuA++7PvgG4h8C+AbhvAO4bgPsG4JeXNPYNwD2ivrIGYFEUdfjoWpnkwhehi95aqB/flm0w6smlVFlu37LlkooT10auVjT8a46GytJ3EZtxI/iIapy3d6uoLKVSwfkBF6zNTsKT72BACxO5zENVdqsWT7XgwNGJY8zcTtp68bt/cTVgERsV/cqpTojH8Dn1MvmctZnve/oCoO+o0diSSa4mOZ8QbZBJ1V+qHm2Wjh986bj4QVaVU2pR03CzphzMoE8y6lmG5TKUpVerij5MvZejcGxJTYG7W61WfwAgfhsY",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 +"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/d480dde9.1c9a3b71.js b/assets/js/d480dde9.1c9a3b71.js deleted file mode 100644 index 7f1e01c38..000000000 --- a/assets/js/d480dde9.1c9a3b71.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:()=>j,contentTitle:()=>B,default:()=>f,frontMatter:()=>u,metadata:()=>l,toc:()=>y});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/isTXtoIa8lO00N1qpEYqVEjMWobPthCwN0daRlxSYYzK1kQBOTQf9BTr/1p+SXFcLV6OUmbtuhFj+G855vHUrGekBreqVvMK++napSpEqmIJrDxTg3VdYXwEi0ywpoHTi/PQVvr57DwDbCHsn2fr9+baFWmfMCoRcl5qYaqZemsZCoiBe8ISQ2X6tnxsXztG75qigKJxo2FjSqVqcI7RsfCr0OwpkgPg3ckQktFRYW1ll+8CKiGyufvsGCVqRBFDZvWZERqLO/wEUfjJipT+KDrYIXUxdv6XgJtPLKLJ2q1yhQbTpzGWePwbRfU22fHx29/UKuV8Dw/fv44uBvCCM4zjH3jyif/XVwYo49fDuvQ9pcCEee7ML5/HMa5m2lryoSIaz9F9/9GsmueW/Pi6kNtRc7pug0pMaV3tRfqLr0NkrBoouGFGt4t1cORDuaofR/ejVajTNXIld/CWXzWXKmhGsw3yCaMM4yUVEgnDFXFHGg4GJB2Ze4f+j6gIzNxVufUL3w90MEMZif9E7XKDmV0CF/Fj83R14oQ64lxk7+SG23TcyUlbKu0l6RNrXQwP+NCZV0NdrkyZQQ6FeoSY6qXcWOfhNeVeRPQXZmJS3VNxg+H0i3awtcos4crhF6vE/n46x8bqV4PSl80NTpOCOzfu3v3pokQ/ByjzBXtShhbfDC5xSSGdXqjbrAR6toikV2AcYyTqBmhNBPD2oLkybgJFDro3FgjwBU2L9IRdrBPfbitkCuM8vRNRNBQ4gyt4B10w77WLKo6f2Hu43Rs/Zwy0JA3ZBwSAbpKu0IYu0pk4CNoB+gYY4iGEIijeG1a37zjqAuGWjs9QdGdwW6ySrRG4ArR5w0xkLdNchlYG+sjltAF5BBLSkk8ewjyBEItfB0iVgKbGcKkMSVSBoUvESj1qYTgSsiRGIL4YgokUdo464tpKqCMVAhexobRFvx4z0cR56gdjX2sW1+6GmwSFqKX2Yytg73eDaFU+MK4KQ17vXt3BHcbXN1iToZx9G3XAvP5/BH0n+7LvDL8U5PDLxg8GfZxsZWeGK6aPLXLrpLNn1bTK3SY8LPTDFsdpS/ocfcJdVChDYMrZEEIDU4vz9OkfQofP/wGF6ijg8rPW7QWTUS7gElnSjLXVr5N22ZQwtgn4FWS8aIFX8T3DRJ3GbytNH/88DvBa5yDceuWklB6vcsmt6aAa6yD1YzU6w3hRUQxyR0NuNIMhXaQI1ClBUozo0FDaKWtcdM+nLoFNLKR5oarBAahJ7m9MCQvm3IT5JqwBO+SRGezv/VI6DWhnSGJLll3OQKWRhY5V9E3k9barjPr4CKOjbVwa8oJcorttCwhrMnzlpzunq07OJaG4AoXoCMCoeM+XB6IpJcmBB/FC9M6P/ZySkkB0JXBG8c0hDLqMW/1Z1ugF5Jm490nSG0K9SYd2VrNpiRtJ64j3lD79zKUDwb5/ryNOMYoBlPY27oEs4bTXQdLELT+G1jLipappYt0QWCtjW03yo+HetI2x1jTm/EVxpkpcL3VPtPRg8Q8UJmypkBHuHMlnL66vIDZd/1jle2sx7/R3IOL8xdnr6/OxBkZpG3CTvon/WMhBU9ca7djaf+YPlxty+359M9P7/UWZnzgQbDapLsnRbVcHyx3ar49+CtPLKTlUrrqJtrVSsjvG4xyCY0yNdPR6FyW891olXW7Wy6cKS4ke0WBQU64mbZNewAcHH5719PLs4uz6zOVKZlA+2fDNJ0N6x9ioHtyix31+/dE64N8ynHzSYHlsj1JVqsNf/v0WYl1jB235HC0Wq3+BHmpquo=","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=t(74848),r=t(28453),i=t(33617),n=t.n(i),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),k=t(63723),b=t.n(k),h=(t(18766),t(79329),t(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/isTXtoIa8lO00N1qpEYqVEjMWobPthCwN0daRlxSYYzK1kQBOTQf9BTr/1p+SXFcLV6OUmbtuhFj+G855vHUrGekBreqVvMK++napSpEqmIJrDxTg3VdYXwEi0ywpoHTi/PQVvr57DwDbCHsn2fr9+baFWmfMCoRcl5qYaqZemsZCoiBe8ISQ2X6tnxsXztG75qigKJxo2FjSqVqcI7RsfCr0OwpkgPg3ckQktFRYW1ll+8CKiGyufvsGCVqRBFDZvWZERqLO/wEUfjJipT+KDrYIXUxdv6XgJtPLKLJ2q1yhQbTpzGWePwbRfU22fHx29/UKuV8Dw/fv44uBvCCM4zjH3jyif/XVwYo49fDuvQ9pcCEee7ML5/HMa5m2lryoSIaz9F9/9GsmueW/Pi6kNtRc7pug0pMaV3tRfqLr0NkrBoouGFGt4t1cORDuaofR/ejVajTNXIld/CWXzWXKmhGsw3yCaMM4yUVEgnDFXFHGg4GJB2Ze4f+j6gIzNxVufUL3w90MEMZif9E7XKDmV0CF/Fj83R14oQ64lxk7+SG23TcyUlbKu0l6RNrXQwP+NCZV0NdrkyZQQ6FeoSY6qXcWOfhNeVeRPQXZmJS3VNxg+H0i3awtcos4crhF6vE/n46x8bqV4PSl80NTpOCOzfu3v3pokQ/ByjzBXtShhbfDC5xSSGdXqjbrAR6toikV2AcYyTqBmhNBPD2oLkybgJFDro3FgjwBU2L9IRdrBPfbitkCuM8vRNRNBQ4gyt4B10w77WLKo6f2Hu43Rs/Zwy0JA3ZBwSAbpKu0IYu0pk4CNoB+gYY4iGEIijeG1a37zjqAuGWjs9QdGdwW6ySrRG4ArR5w0xkLdNchlYG+sjltAF5BBLSkk8ewjyBEItfB0iVgKbGcKkMSVSBoUvESj1qYTgSsiRGIL4YgokUdo464tpKqCMVAhexobRFvx4z0cR56gdjX2sW1+6GmwSFqKX2Yytg73eDaFU+MK4KQ17vXt3BHcbXN1iToZx9G3XAvP5/BH0n+7LvDL8U5PDLxg8GfZxsZWeGK6aPLXLrpLNn1bTK3SY8LPTDFsdpS/ocfcJdVChDYMrZEEIDU4vz9OkfQofP/wGF6ijg8rPW7QWTUS7gElnSjLXVr5N22ZQwtgn4FWS8aIFX8T3DRJ3GbytNH/88DvBa5yDceuWklB6vcsmt6aAa6yD1YzU6w3hRUQxyR0NuNIMhXaQI1ClBUozo0FDaKWtcdM+nLoFNLKR5oarBAahJ7m9MCQvm3IT5JqwBO+SRGezv/VI6DWhnSGJLll3OQKWRhY5V9E3k9barjPr4CKOjbVwa8oJcorttCwhrMnzlpzunq07OJaG4AoXoCMCoeM+XB6IpJcmBB/FC9M6P/ZySkkB0JXBG8c0hDLqMW/1Z1ugF5Jm490nSG0K9SYd2VrNpiRtJ64j3lD79zKUDwb5/ryNOMYoBlPY27oEs4bTXQdLELT+G1jLipappYt0QWCtjW03yo+HetI2x1jTm/EVxpkpcL3VPtPRg8Q8UJmypkBHuHMlnL66vIDZd/1jle2sx7/R3IOL8xdnr6/OxBkZpG3CTvon/WMhBU9ca7djaf+YPlxty+359M9P7/UWZnzgQbDapLsnRbVcHyx3ar49+CtPLKTlUrrqJtrVSsjvG4xyCY0yNdPR6FyW891olXW7Wy6cKS4ke0WBQU64mbZNewAcHH5719PLs4uz6zOVKZlA+2fDNJ0N6x9ioHtyix31+/dE64N8ynHzSYHlsj1JVqsNf/v0WYl1jB235HC0Wq3+BHmpquo=",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,j={},y=[];function v(e){const o={p:"p",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,s.jsx)(n(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{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 f(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(v,{...e})}):v(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.78d6bb4e.js b/assets/js/da66eb9c.78d6bb4e.js deleted file mode 100644 index 185695e27..000000000 --- a/assets/js/da66eb9c.78d6bb4e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>f,default:()=>w,frontMatter:()=>y,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":"eJzdWF9vG7kR/ypTvjQx1pKcOFdUT3VzQWI0SITYRoA6hkAtZ7U8c0keyZUsCALu4b5Bn/raj5ZPUgy5u1r9iZP0Di3QF0PmDoczvxlyfjNrFvjcs/Et+9HkdYU6eHaXMYE+d9IGaTQbs+sS4cYKHhBaKbiYXAJXyiw91B6dh2CgMkIWK+BaQJ3EQ4kgMHCpPJgCOHiLuSxkDqJRNIB3JgryAKGUPio2Wq1a7cG0yjgUuATLHa8woPMZrEwNOdfaBMhLrufpwEIqBKNzBBmSBa3R0kPukAcUA5YxY9FxcvFSsDFLh7T+sYxtD2Lj2zXTvEI2Zq2uqRQsY5LgsTyUbB+zyx/J4Z3To48aUUSnZtj4RXoc/lxLh4KNg6sxYz6sFJ3mZWUVsozhg1VGIBsXXHkSyEusOBuvWVjZKBmc1HOWscK4ioftymZzl/SjD381YkV7dk2dOLOQAmGGyvTw7SEfsLKKB/TwhAdQyH0Ao7En2zrwlGUsNzoQhOM149YqmUeQhz95Om19aLqZ/YR5RNxRSIJET18T4F93kMDhEaYx8/FHBznbZEyb8N1qJuQigsOFxGXMZy/nOuVnX/cOjt93RJcVfR0b2qMEOsrIQ33b3SSJms8Uvr+e9ERnxijk+iAbKavgNDlg4iIspVKQdMD76wks0NHFjLEawE2801HGYY5yQdevLwK5EQgLyQErLlUGy1LmJSX8CqraB0Dd5FADHfaufExiOIVDg4T0Ry3K0nMg9Xz73BwoBiEd5kGtYClDaeoAXAhJ27kCH9D6QR/FaEUH5LWp3W9HksO8lgIFBFM7KIyLVsbHysZrRh5I7YOrc9rsQdQU3egHidJv60yO3m9xalEhoZ7+DFD7tJ1DwX1Al0GtJSHvahtQdCrxwaKTqHM8CkEEdxrf7wZw/+1YTNBVMvjWUwoNFwJQYawn4Ou8BJ6+81A79BlILYPkymfgA6+sz8A4CPhA7woEY+nxxAfpAxm/lGKOwYP8Uh59QLojec+GwpkqRp+w0at+InR2BbOn7pqCKn1TtQpeqwALrurjmDlM6TatnTp2W3exukqFD5P2mw9vYVmiwy7u6FIezejZSYqRymi8aXRwaLOky/b9dDl4IXgdzNRhJbXAb8ntKwwRFAprMF1K18FUPMgcWlV+AI1oCkAw/Qyt4EkL3gxLvpDGPf0CgKRuSpV6KvUUF+hWPSt1Xc3QHRj5Li5Tfgi+8jDDsETUfdvaMCYWkSoQ2bYsUcMOJiTlt07vWPlis8lYkGHntZ72yv90RtV0s9lEV7w12qfC9Ww0OiyyHXFqij7dCopaUSu1+sPvVzXT8tfqB/fi2Rs/OX9jKU8aky7C45uejZ49Pz0bnY7+dH32w/j8z+MXPwxGo9HfWcYeKrUt2Yy0sT568f/egtRKapy2qE2fjUbT5w2U58fQawqybZjKgispoJCoBNCZ/ncEEJ0z7j8kDI/Y95j75HLr/PkjqUM8tzC1Fv9rd49Z9LiD59PzzsUXhy5e6gQZkf9rc4/6v+Hh1p/+8SEdT6buZrVMQvE723G2v56c9JjXToZV7BweTrmVp+n7+PaO+HiFoTTUddg6tRqhZGM2bF+X4br3zmwY6XOLthGJ5YaVIVg/Hg4912JmHgbGoqaCoPjMD3JTDbmVw8XZ4Ixtsv093Nrvksf69Hu3+MDnUs+/tu9uC9UVhTNFbAewLm7cyr/himVtPPpSTSdWIqdKRxGgLPmw7XpetbHuwrnfKrSdwreR//2qdJTO99k8YzuMvWnj+tSzWTpKxZpvu5SDVO6V+E7uWGV9sSGYChMxbZL3vUV9Re5R6seY7Hv2EVVuKmzZ0slJu+Xzr//qdp2cdNCkBuKT/qTf1w6sWaIrahVxLBQ+SKrEtA2r+M3HJp7YPPJKofdqBURg544aTyHnMhB5b6hOzi2fSSXpbpOYod0Oes+DH8DHEkOJjj790RElF7hARU9Cx2X0fEujlsbdFzRqyIDDrPZSo/eAuuQ6J8E2QSNF5To1NtZJj+CDI6tlss3o4HgeoOKazyPHzKAPlkAl6RaDMzPqkLxRdeoBaEBiXGT1yaE4JYggvqLG3yHQKhFBhyXdpkXTCPgsNWIpm8kFLWCGPoAlW2SOaYKilcnv03SkVgqsoZdVckU8qm8jbQ+Oa0/Pf7KljUEHWMM3MRl4cnLjkSL8Vup7Pz45+aRP4bbLq4848zLg3ZP2ZVgulwcvwtPdPa9leFPP4ANa42UwbrXdPZehrGfxFekr6f5Jml6jxpg/vTdiq0OY3B8+SrQ6LFHZ4RUGyhA/vJhcxmL0FD7/8g94i9xpKM0yZWteO1QrmLdHEXIp8gm2rpbELpDXoSTE85R8zTymRfBjycPnX/7p4R0uqctJV4pcOTmZ1DMlc7huRzAnJ2N4GYdYvbFMHC3lXFP74EtOqUStOQebdiup7wdwoVexe47tcUwGWo/7dtyI710bbg8z7lHEvqzcnjnYWhRJv0e1QN9O42YIKCTR3FA6U8/TaX1jGuccFtT1fEwdHvl2IQTYZrlt/KjB2JqDhUmN0wq4Q/Cxd5vsbYlfamuNIyuazrEw7RABtbBG6uDHIBwvwlZ/tk30OCuMw4eDpQQh7+DIGjVdSNJNbDzuVgefqCrs1bfd99ZhgY4OjG5v42Jlk063bVoCZetvSWtiMfRq8TySrDjISYX2L/t6IuFBV/n3xRW6hcyxKfZfuNHDKDxkGVMyR+37lffi9eQtLJ4PRizrsYZvuNzDt5cvX727ekXG0EOaADsbnA1GtGSNDxXXvZP2htb7tW29pZj/rzPuhjvRZGVoFZeRuTYDi8Q6b1mP1Iz74+27jJXGBxJZr+kRuHFqs6Hln+tIKG7vMrbgThKHidS0mQKIjoh8Ee4nH9qBMXzfpPyoQy1D1EQP48QmsaN7XO2N7Dd3m6yliWRxkniZ7Dq9Jj1bDQddB/HctOMiz9GGR2X7NH9yc80yNmvG71Wc5DPHlzT658tkbJomRgIc19ZMcT2v+Zxkk8pNGuqUu6z4PrLi5gc5dRSOXbqcvKC/5NPRDet1YtybTSefPn1xR4NrK02xudtsNv8GPK5Ukw==","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 s=i(74848),n=i(28453),a=i(33617),d=i.n(a),r=i(17543),c=i.n(r),p=i(86013),l=i.n(p),u=i(63723),m=i.n(u),h=(i(18766),i(79329),i(9303));const y={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:"eJzdWF9vG7kR/ypTvjQx1pKcOFdUT3VzQWI0SITYRoA6hkAtZ7U8c0keyZUsCALu4b5Bn/raj5ZPUgy5u1r9iZP0Di3QF0PmDoczvxlyfjNrFvjcs/Et+9HkdYU6eHaXMYE+d9IGaTQbs+sS4cYKHhBaKbiYXAJXyiw91B6dh2CgMkIWK+BaQJ3EQ4kgMHCpPJgCOHiLuSxkDqJRNIB3JgryAKGUPio2Wq1a7cG0yjgUuATLHa8woPMZrEwNOdfaBMhLrufpwEIqBKNzBBmSBa3R0kPukAcUA5YxY9FxcvFSsDFLh7T+sYxtD2Lj2zXTvEI2Zq2uqRQsY5LgsTyUbB+zyx/J4Z3To48aUUSnZtj4RXoc/lxLh4KNg6sxYz6sFJ3mZWUVsozhg1VGIBsXXHkSyEusOBuvWVjZKBmc1HOWscK4ioftymZzl/SjD381YkV7dk2dOLOQAmGGyvTw7SEfsLKKB/TwhAdQyH0Ao7En2zrwlGUsNzoQhOM149YqmUeQhz95Om19aLqZ/YR5RNxRSIJET18T4F93kMDhEaYx8/FHBznbZEyb8N1qJuQigsOFxGXMZy/nOuVnX/cOjt93RJcVfR0b2qMEOsrIQ33b3SSJms8Uvr+e9ERnxijk+iAbKavgNDlg4iIspVKQdMD76wks0NHFjLEawE2801HGYY5yQdevLwK5EQgLyQErLlUGy1LmJSX8CqraB0Dd5FADHfaufExiOIVDg4T0Ry3K0nMg9Xz73BwoBiEd5kGtYClDaeoAXAhJ27kCH9D6QR/FaEUH5LWp3W9HksO8lgIFBFM7KIyLVsbHysZrRh5I7YOrc9rsQdQU3egHidJv60yO3m9xalEhoZ7+DFD7tJ1DwX1Al0GtJSHvahtQdCrxwaKTqHM8CkEEdxrf7wZw/+1YTNBVMvjWUwoNFwJQYawn4Ou8BJ6+81A79BlILYPkymfgA6+sz8A4CPhA7woEY+nxxAfpAxm/lGKOwYP8Uh59QLojec+GwpkqRp+w0at+InR2BbOn7pqCKn1TtQpeqwALrurjmDlM6TatnTp2W3exukqFD5P2mw9vYVmiwy7u6FIezejZSYqRymi8aXRwaLOky/b9dDl4IXgdzNRhJbXAb8ntKwwRFAprMF1K18FUPMgcWlV+AI1oCkAw/Qyt4EkL3gxLvpDGPf0CgKRuSpV6KvUUF+hWPSt1Xc3QHRj5Li5Tfgi+8jDDsETUfdvaMCYWkSoQ2bYsUcMOJiTlt07vWPlis8lYkGHntZ72yv90RtV0s9lEV7w12qfC9Ww0OiyyHXFqij7dCopaUSu1+sPvVzXT8tfqB/fi2Rs/OX9jKU8aky7C45uejZ49Pz0bnY7+dH32w/j8z+MXPwxGo9HfWcYeKrUt2Yy0sT568f/egtRKapy2qE2fjUbT5w2U58fQawqybZjKgispoJCoBNCZ/ncEEJ0z7j8kDI/Y95j75HLr/PkjqUM8tzC1Fv9rd49Z9LiD59PzzsUXhy5e6gQZkf9rc4/6v+Hh1p/+8SEdT6buZrVMQvE723G2v56c9JjXToZV7BweTrmVp+n7+PaO+HiFoTTUddg6tRqhZGM2bF+X4br3zmwY6XOLthGJ5YaVIVg/Hg4912JmHgbGoqaCoPjMD3JTDbmVw8XZ4Ixtsv093Nrvksf69Hu3+MDnUs+/tu9uC9UVhTNFbAewLm7cyr/himVtPPpSTSdWIqdKRxGgLPmw7XpetbHuwrnfKrSdwreR//2qdJTO99k8YzuMvWnj+tSzWTpKxZpvu5SDVO6V+E7uWGV9sSGYChMxbZL3vUV9Re5R6seY7Hv2EVVuKmzZ0slJu+Xzr//qdp2cdNCkBuKT/qTf1w6sWaIrahVxLBQ+SKrEtA2r+M3HJp7YPPJKofdqBURg544aTyHnMhB5b6hOzi2fSSXpbpOYod0Oes+DH8DHEkOJjj790RElF7hARU9Cx2X0fEujlsbdFzRqyIDDrPZSo/eAuuQ6J8E2QSNF5To1NtZJj+CDI6tlss3o4HgeoOKazyPHzKAPlkAl6RaDMzPqkLxRdeoBaEBiXGT1yaE4JYggvqLG3yHQKhFBhyXdpkXTCPgsNWIpm8kFLWCGPoAlW2SOaYKilcnv03SkVgqsoZdVckU8qm8jbQ+Oa0/Pf7KljUEHWMM3MRl4cnLjkSL8Vup7Pz45+aRP4bbLq4848zLg3ZP2ZVgulwcvwtPdPa9leFPP4ANa42UwbrXdPZehrGfxFekr6f5Jml6jxpg/vTdiq0OY3B8+SrQ6LFHZ4RUGyhA/vJhcxmL0FD7/8g94i9xpKM0yZWteO1QrmLdHEXIp8gm2rpbELpDXoSTE85R8zTymRfBjycPnX/7p4R0uqctJV4pcOTmZ1DMlc7huRzAnJ2N4GYdYvbFMHC3lXFP74EtOqUStOQebdiup7wdwoVexe47tcUwGWo/7dtyI710bbg8z7lHEvqzcnjnYWhRJv0e1QN9O42YIKCTR3FA6U8/TaX1jGuccFtT1fEwdHvl2IQTYZrlt/KjB2JqDhUmN0wq4Q/Cxd5vsbYlfamuNIyuazrEw7RABtbBG6uDHIBwvwlZ/tk30OCuMw4eDpQQh7+DIGjVdSNJNbDzuVgefqCrs1bfd99ZhgY4OjG5v42Jlk063bVoCZetvSWtiMfRq8TySrDjISYX2L/t6IuFBV/n3xRW6hcyxKfZfuNHDKDxkGVMyR+37lffi9eQtLJ4PRizrsYZvuNzDt5cvX727ekXG0EOaADsbnA1GtGSNDxXXvZP2htb7tW29pZj/rzPuhjvRZGVoFZeRuTYDi8Q6b1mP1Iz74+27jJXGBxJZr+kRuHFqs6Hln+tIKG7vMrbgThKHidS0mQKIjoh8Ee4nH9qBMXzfpPyoQy1D1EQP48QmsaN7XO2N7Dd3m6yliWRxkniZ7Dq9Jj1bDQddB/HctOMiz9GGR2X7NH9yc80yNmvG71Wc5DPHlzT658tkbJomRgIc19ZMcT2v+Zxkk8pNGuqUu6z4PrLi5gc5dRSOXbqcvKC/5NPRDet1YtybTSefPn1xR4NrK02xudtsNv8GPK5Ukw==",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={},b=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,s.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.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,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(c(),{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,s.jsx)(l(),{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,s.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 w(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/runtime~main.2b1efa87.js b/assets/js/runtime~main.a9b37470.js similarity index 88% rename from assets/js/runtime~main.2b1efa87.js rename to assets/js/runtime~main.a9b37470.js index befa66656..f1971d81e 100644 --- a/assets/js/runtime~main.2b1efa87.js +++ b/assets/js/runtime~main.a9b37470.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,d,f,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,d,f)=>{if(!c){var b=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,d,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&d&&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(f,b),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",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",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",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",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",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",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"171e57a2",89:"67599f09",108:"b9723cd9",157:"be2f595e",285:"9ad181d3",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2e9f4f9b",849:"6a6bc5e1",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"f969e353",1665:"65cb2696",1679:"40b50d00",1688:"2582d322",1706:"4249218d",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"68a5f06c",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"78d6bb4e",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"1c9a3b71",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"9e9eb20c",3460:"60832077",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3795:"1bb5b9be",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"e4fd7cb0",4240:"ed86382c",4372:"b0d1b7a3",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"0a9740c7",4865:"93721c1a",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"47aa6633",5373:"eb16148c",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"320fba40",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"abecfe08",6235:"388e6290",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:"257eca44",7054:"cab4fa5c",7068:"b64a0c73",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:"79e73705",7910:"5b11649a",7960:"fc3ba422",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"eb383529",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:"66f4fead",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"a0b3573e",8901:"9642dc06",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"8c63ba6b",9099:"1df317b0",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"2a78d705",9426:"4597631d",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),d={},f="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","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",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","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",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",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",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426","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 d=t.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",r.name="ChunkLoadError",r.type=f,r.request=b,d[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(d in r)t.o(r,d)&&(t.m[d]=r[d]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,d,f,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,d,f)=>{if(!c){var b=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,d,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&d&&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(f,b),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",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",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",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",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",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",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"04d03f97",89:"67599f09",108:"b9723cd9",157:"be2f595e",285:"e170b9c6",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2e9f4f9b",849:"6a6bc5e1",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:"2ff83df9",1688:"2582d322",1706:"33c9f705",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"4a1b8c9b",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"717af639",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"a2cfa06b",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"fd769b08",3460:"827e01c6",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3795:"8c4aab4f",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"804e9e11",4240:"b86e5973",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:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"9f2d8c5b",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"0541c66c",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:"b64a0c73",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:"d7ccdb73",7910:"5b11649a",7960:"102fca2b",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"eb383529",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:"b07419f4",9099:"e3542020",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"4db3ade4",9426:"4597631d",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),d={},f="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","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",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","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",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",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",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426","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 d=t.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",r.name="ChunkLoadError",r.type=f,r.request=b,d[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(d in r)t.o(r,d)&&(t.m[d]=r[d]);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 30fe8fcdd..7865df688 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 605d3ceee..11bf934d7 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 8d605c1de..c41864203 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 745f58d0f..adbf68eb4 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 c284fed2a..86159209d 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 629a7f21b..f65ed26a4 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 ca247a6ee..bee578585 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 d9727bb02..991e492e3 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 fb7e87aba..1915f7b5f 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 aba152eb2..84f1f4077 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 82f7d3c7f..e549c26d9 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 0e8b75adf..cbc209c21 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 a46260705..91868ec3f 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 561a97bbc..f17cbc2ac 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 1d0471727..fdfd810b1 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 8ec5ba0fc..3776cc9c8 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 ac6d96278..47cd54744 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 e76ba7955..c38dcddcc 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 8ac37093b..9db9474ef 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 65e00a994..4be9a21c4 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 d00bff832..872d154d0 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 789d936d3..034be77a6 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 efa723bed..5ce1ba8c9 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 e4d1cfbc0..10cef5fd2 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 00fb7162a..bd3600d45 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 05f258bac..a002ecd3f 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 1d70f2ba1..63de8a53f 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 8c2a3270f..06b620072 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 592b862c1..155ed0ecb 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 582c3e939..4bc6fa2a6 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/getdocument/index.html b/docs/API-docs/v1.1/getdocument/index.html index de2ef551a..67faf8163 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 cbc6b8c19..b57194450 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 e6ee9f608..e03cd1182 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 834936ea4..9c82347c8 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 9ffbea44c..d8a0482a0 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 25d7cdb91..155f56f7f 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 a4234c925..2fc4ca8b1 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,11 +5,11 @@ OpenSign API v1.1 | OpenSign™ - + -
Version: 1.1.0 +
Version: 1.0.0

OpenSign API v1.1

Welcome to the OpenSign™ API v1.1 documentation.

Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign™ delivers robust solutions tailored to your needs.

diff --git a/docs/API-docs/v1.1/publictemplate/index.html b/docs/API-docs/v1.1/publictemplate/index.html index 996131aca..0c8ff36fe 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 1f606ef17..89f79208e 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 7fdfaeca7..77837b5a8 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 eedfae78f..91bfa3666 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 bdbbb29fc..d70ca96c2 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 e5db64187..7a63b9b8d 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 15f5c1a30..e09021530 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 dcf40bef1..80a68cfb7 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 803b2debb..03a1ab05a 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 03d6ad6c1..e6885102b 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 1767496ef..cada19f74 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 0b90df086..35ddb5063 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 541887cb2..c8ec1fb56 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 28c4db6d9..1b0befdd9 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 2d34f4be6..ec343bbb8 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 035f4f213..10e4f8229 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 20376776f..1c6ba1cff 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 e26f66587..11f6923ed 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 eb648d746..73a2148ad 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 f91d5e6d0..34c1f2a82 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 267b532cd..b45fce64a 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 886fe5217..cc71b3925 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 0458ef2cf..0d265bbf5 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 d5ebdf914..06545f99f 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 8b9abd2a3..55f6931f9 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 3e4aae5a4..e90ce4541 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 99b43c71a..f7ae719bc 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 cb0cc7d2f..76cd6d12a 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 0eea3f5bd..b3b955c5c 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 e1c8b331f..f55cf8d44 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 b7ec3b311..06c5af86b 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 ae6683962..ee3ad6709 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 76ca26505..4d827ee5c 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 99f8e925b..4f51277df 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 b29f7b9d0..97a11025d 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 5de0f7f8c..2b477125d 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 f06ea0dce..88762a09c 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 ab3193d24..079e00638 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 d0943cb70..d74d7f962 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 ce2b98943..41695cb9b 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 d26662a33..aca4ffa3d 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 44e73adb4..a10736fe3 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 8f6d3eac0..46e8ce896 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 9a68cb307..0e2209bea 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 51629cc3d..46acfc49d 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 44c18a14d..a0d7b501f 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 dfe4113cd..274970718 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 ee18ddfd7..473c0853c 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 cd6a6c523..d6e95fa9e 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 43bde9805..c8f6129da 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 fcc15bd73..f3ebbc9a9 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 c78051db9..6a97f1328 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 655299f7e..b8c8378e7 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 476d92c44..544297810 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 4747ea0fe..894169e89 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index 48286f553..5d063fb5d 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 63d84f099..0263e5639 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 e95504f8e..abd18d64a 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index 9e8e1f80f..640d46460 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 3b89fd645..1d223c008 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 98a421426..fb6ed73c2 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 11da23dc8..8ef191ca9 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 89c30a030..26f1bfcd7 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 9e83103d9..30af423c3 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 8dba661ec..83ba3fca0 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 c54306183..589024ef5 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 8eb26087d..329ed8ffe 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 493020559..cc013d767 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 90aa5bb05..a708c35fe 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 0f61f3a29..d523a6bdb 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 498724f19..45709b737 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 0eb1fe003..488b90985 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 8dbbdc2ca..7584a96ce 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 c3e8115f5..3f5cd76dc 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 605943552..0249b5434 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 94f4137eb..6ba1e7a59 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 1fdc55944..c51fddaf7 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 b86036f4d..acbe58553 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 69190a393..1d8fc40fd 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 4cc2e0962..28933fb18 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 c8601209f..c15501990 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 595d49dfa..15afb8d91 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 e9cca41c3..8ef814146 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 82a86518f..6b69dfeac 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 15ab8aa8c..534a8494d 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 c64119d29..1df706b98 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 c981082c1..894ae3267 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index fa5a10f18..4a13ef3d3 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 32d577175..eb793ac9e 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 c0b3de150..be07ed79f 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 27c5fa7e5..6dc528bb4 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 3212f05d1..96d3785c7 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 cd0791300..23cabf0aa 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 de83a1a88..2c139c016 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 50c7b8126..9ee56685e 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 6a759feb2..70dbe6d33 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 f5c642466..4597fe012 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 34961490b..7da587bb6 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 33e635271..9435f164e 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 334739c5d..737eaf815 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +