From 1b6eb9f73b863ffbc3e04f18bbe210a27ee69245 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 15 Oct 2024 06:22:47 +0000 Subject: [PATCH] deploy: 747c7c549c9ac747444b7844634bbef58349160d --- 404.html | 2 +- assets/js/28b19cd2.bc4974db.js | 1 + assets/js/28b19cd2.d669ec3e.js | 1 - assets/js/2c586be5.84ff4b21.js | 1 + assets/js/2c586be5.dff34c6e.js | 1 - assets/js/5a2de241.2b8fccd7.js | 1 - assets/js/5a2de241.34493030.js | 1 + assets/js/bbdfc22d.52af9f43.js | 1 - assets/js/bbdfc22d.a84b1389.js | 1 + assets/js/bfe4b778.941ae0bf.js | 1 + assets/js/bfe4b778.a2c58921.js | 1 - .../js/{runtime~main.460c9d43.js => runtime~main.26c11ea6.js} | 2 +- blog/archive/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 2 +- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 4 ++-- docs/API-docs/createdocumentwithtemplateid/index.html | 4 ++-- docs/API-docs/createfolder/index.html | 2 +- docs/API-docs/createtemplate/index.html | 4 ++-- docs/API-docs/delete-template/index.html | 2 +- docs/API-docs/delete-webhook/index.html | 2 +- docs/API-docs/deletecontact/index.html | 2 +- docs/API-docs/deletedocument/index.html | 2 +- docs/API-docs/deletefolder/index.html | 2 +- docs/API-docs/folderlist/index.html | 2 +- docs/API-docs/get-template/index.html | 2 +- docs/API-docs/get-user/index.html | 2 +- docs/API-docs/get-webhook/index.html | 2 +- docs/API-docs/getcontact/index.html | 2 +- docs/API-docs/getdocument/index.html | 2 +- docs/API-docs/getdocumentlist/index.html | 2 +- docs/API-docs/getfolder/index.html | 2 +- docs/API-docs/gettemplatelist/index.html | 2 +- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/resendrequestmail/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 2 +- docs/API-docs/update-document/index.html | 4 ++-- docs/API-docs/update-template/index.html | 4 ++-- docs/API-docs/updatefolder/index.html | 2 +- docs/category/cloud-storage/index.html | 2 +- docs/category/create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- docs/category/manage-docs-using-opensign-drive/index.html | 2 +- docs/category/reports/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/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/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/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/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/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 +- 97 files changed, 97 insertions(+), 97 deletions(-) create mode 100644 assets/js/28b19cd2.bc4974db.js delete mode 100644 assets/js/28b19cd2.d669ec3e.js create mode 100644 assets/js/2c586be5.84ff4b21.js delete mode 100644 assets/js/2c586be5.dff34c6e.js delete mode 100644 assets/js/5a2de241.2b8fccd7.js create mode 100644 assets/js/5a2de241.34493030.js delete mode 100644 assets/js/bbdfc22d.52af9f43.js create mode 100644 assets/js/bbdfc22d.a84b1389.js create mode 100644 assets/js/bfe4b778.941ae0bf.js delete mode 100644 assets/js/bfe4b778.a2c58921.js rename assets/js/{runtime~main.460c9d43.js => runtime~main.26c11ea6.js} (94%) diff --git a/404.html b/404.html index 216193dfb..36d3c5ba4 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/28b19cd2.bc4974db.js b/assets/js/28b19cd2.bc4974db.js new file mode 100644 index 000000000..a381cde92 --- /dev/null +++ b/assets/js/28b19cd2.bc4974db.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>f,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=s(85893),n=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),m=(s(82723),s(9487)),o=s(41429),d=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document 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:"eJztWNtuG8kR/ZVyv/iCESlp7TwQQbCObGyEXayElQw/SARRnCmSLfV0z/aF1ITgW74kn5YvCap7Zji8WLaDYF8SwLDNnqrqunXVqVoLj3MnRnfig8lDSdo7Mc5EQS63svLSaDEStwuCC0voCVoqeH99CaiUWTmoTQBvYE6aLNNoWkHRSoNpDQ/BeaisWcpC6jl4KiuFniayAKmdJyzAzCBUymAkwChiJhW9khr8gmBmbMk0U3T0p7dgLEylRlu/BlqSrcHLkqIemqhgZfKkLnaKDOC2udaxNLBUMUWhagiOinibgxw1TKnhLmBmTcmfLUjtyc4wJ0APd2/efKBpmMOnyzdvxq8W3lduNBxiVQ1MRdrJuVY4dYPclMOCCati9pqVDi7av3VnqxO7c3CvRSZMxU6URl8WYiQaRRobVtIvWufJQmSiQoslebIcwbXQWJIYiZ5/RSYkR7BCvxD7YTXTB8r9ZXR+q4jIhKXfg7RUiJG3gTLhfK1YrJNlpZiAniplChKjGSrHBPmCShSjtfB1FSm9lXouMsFhQ98/oSeMUkai+tvZdJGfL6qp2GzG6Vpy/q+mqFlUbrQn7fm/WFVK5tEpwwfHqq97d27VvRPseXbGOGtVSTayqyx71ktykb0h3OqM1mLN7vJU9s+/IMAaNuLQ4q197/PcBK9Re7HJBJUo1bMuigR9AQ+Gfmx+cSaxlBTg5259MARTIiauFkZ/hfrs/Af+88OZ2Gwy4aWPp7tJ18umyU3jNqaeGVWQ5Sx97gZWxJEuJvsOmBqjCPVBUt4upIMur/dKjKsol7MaVgvyC7LxeIXaQ5TumGRK4Lg+MXXSdgBcvwqaYVAelqgCgXRwLzi978UALmfxSaYvhn/sqNCjBdQFaAMv430TF2JyvBw2v6emqF9uOR2gpUZnSUWnQiTuqqCDlVSK9eY6lIpA5z++ts2e9rpjDt/14UVw3pQQr2mYYs1jh6APlqB5bAO4QA1S5yoU1BRadjhXKViv2xSYxMzYbGC95liSnXAibjbZ9oDv2jmI2ZdOLOUklztc3RFtGbuzHis9VdLWkwJ9c5CbskJd9xWQcy31fBKs2mwGB8m3jcw3++3ATU3EWMj/gMdYnUt9ZQuyR9/rfnJy7701F4YPPX3Aul8+dSinZA88Hfs1t+mGCwqsHb+02Iv5A6o8xM6YDAI2iB9nbYLtmnq/fnY3dfqdveP4a5wqurq9ft6WppXtaWkDwUmqByYepreaZMLV7TUsycpZ05wG8Mnxq480TWwAd0ggNwXBUmJKqQxWC5kvOI9qKBklEeOMtnjF/NoCmKgjnMChQoV0RzXKUv3k5AxRtWOCoZCWcq9qYHxhggcsCsnsqMB5qtxAdI68NeErWfGfeBJhHmQRIx9sV6rIuqwHGxkq2pAzs4Mi2BZKNenMlDk5t/VT6xUm6snPgLRL7AgzdJ5sBkFHhGdDxbivFUlPFVlJOqfBMx1y0m+RsdJsmHgXR8UDVxntEoA4Pz3lf3bddKnBhZytgJY49Tj21Zw8BKtA6u1HGR9E7DOoXNvymKSLruFOuZKOwGhVRykt8MugJOcczhnVfTPgeh4YtbK/Fw4uHuT535/y5fk1J1uwz4OlYwIaFL4HmdhCNvA7pXVzTgQTTVBmQan6xU4mSK2kpkkbkMn56enknOO/ycTboyFOEVvgkvTL+NRgJYs5eRfBRZP3HME2q3hw0KYdoKgjQWX0PL5ZznBpgTFp5Iw5+F+LKFlr7Pf671oROoZiPlRbS5Lgr/nw7enpJM87J7479k6WqGQRh9Bb80j6xR9g7ta4/vU+Xc+qPpUxaZspTCai+F3sWNs/T0Y6yoOVvo5T3NMJVvIkfR/djXk2KskvDM+DlXFRYx7nRmK4W4eG614h2ggWa5ftbBhfVPdIHOpiap4Ox1Ws5HB5JjbZPsfR4faL1M7jXOr5ybNc463hNxyc5P8d87fjWSV/Jk7qxrt9qmbGXRAyZGF/csx/286TH9vI9Qa/u3aG6w9q3Zx2MHx1F7cDVjdf9YeocX8sEmJ39EnT9B6UF2IXorZMHQBLXMcw1tm7HXTT9N1+m45HG3bPzERfNil4VZHmUS4m8PLsAJ19JpWbBNC4d7bk//rHPyNHm2/xfb2Aq2ChMiuys6BiDZspepLceA93RI6wVOScquNGZR73RYWcS89Yo+m6OVY4lUryi2Qyk0Bf71G7AXzejoAvbVz00JIUP2RQxjxGcGAAgzdlvKOt5ytjH2esUgYIU17IcLd1RC0L6QXqnEtXSs2M6y/qhMwqy40UZcnEjFNoNpO5ZMFcfizmHkrUOCe+LAPWm73Q1G4H1kwZ5jmjQgIy3kBJ5JOJvL1yA/jAwDEaHsEueZSKioRhXJYwZJOcbIYuYEpxw4a5lzklmOfRelC8HotPMc0qQSmoDJdJiYrhdD+2LMhb1C5u2xLQbkLTua8BWfGOAusB3Ot7fcPJEhxxAiipH93oXp/AXZdmn2nqpKftpmy1Wh2Uhde7PD9JvwhTXtOZLd88HsYi0mfvfrwWmfBkS3c1uyG7lHkLDL5w5zASD5vmgWm2bksAVvLHfQYu5ErmpB31Sv37n65/gSX8MDgVWa8QfoPCw18uLz7+evOR5XKpTu/vbHA6OI0rHON8ibp31f4aNm4oe8u7nYfc26L9f4f7B+5wm57l6ckPK4VS9yBtat13eyOEyMSov7YdZ2LBrX50J9ZrdtgnntX5+PdAlnHCOBNLtJKLfWxmzbBTHB/A+pnw6rdmMHkNX9gAH9W/bcSau3DclaVu9Uj13s55M95kbTdm1RLFRVLg5JblbCUcQDUGE4njfZ5T5Z+l7WOj66ubW5GJdtVTxhW1sLjinTauxEjci3sRV+yx9MY1Lp+vhUI9D3FKEEkugwgMHKk+AnmMCKT5D1t21Ce70CSZwn+zYUcZ/szv8Geq/9KRpy9fZGh821JzfMabzebfbJAljA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,x={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document 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:"eJztWNtuG8kR/ZVyv/iCESlp7TwQQbCObGyEXayElQw/SARRnCmSLfV0z/aF1ITgW74kn5YvCap7Zji8WLaDYF8SwLDNnqrqunXVqVoLj3MnRnfig8lDSdo7Mc5EQS63svLSaDEStwuCC0voCVoqeH99CaiUWTmoTQBvYE6aLNNoWkHRSoNpDQ/BeaisWcpC6jl4KiuFniayAKmdJyzAzCBUymAkwChiJhW9khr8gmBmbMk0U3T0p7dgLEylRlu/BlqSrcHLkqIemqhgZfKkLnaKDOC2udaxNLBUMUWhagiOinibgxw1TKnhLmBmTcmfLUjtyc4wJ0APd2/efKBpmMOnyzdvxq8W3lduNBxiVQ1MRdrJuVY4dYPclMOCCati9pqVDi7av3VnqxO7c3CvRSZMxU6URl8WYiQaRRobVtIvWufJQmSiQoslebIcwbXQWJIYiZ5/RSYkR7BCvxD7YTXTB8r9ZXR+q4jIhKXfg7RUiJG3gTLhfK1YrJNlpZiAniplChKjGSrHBPmCShSjtfB1FSm9lXouMsFhQ98/oSeMUkai+tvZdJGfL6qp2GzG6Vpy/q+mqFlUbrQn7fm/WFVK5tEpwwfHqq97d27VvRPseXbGOGtVSTayqyx71ktykb0h3OqM1mLN7vJU9s+/IMAaNuLQ4q197/PcBK9Re7HJBJUo1bMuigR9AQ+Gfmx+cSaxlBTg5259MARTIiauFkZ/hfrs/Af+88OZ2Gwy4aWPp7tJ18umyU3jNqaeGVWQ5Sx97gZWxJEuJvsOmBqjCPVBUt4upIMur/dKjKsol7MaVgvyC7LxeIXaQ5TumGRK4Lg+MXXSdgBcvwqaYVAelqgCgXRwLzi978UALmfxSaYvhn/sqNCjBdQFaAMv430TF2JyvBw2v6emqF9uOR2gpUZnSUWnQiTuqqCDlVSK9eY6lIpA5z++ts2e9rpjDt/14UVw3pQQr2mYYs1jh6APlqB5bAO4QA1S5yoU1BRadjhXKViv2xSYxMzYbGC95liSnXAibjbZ9oDv2jmI2ZdOLOUklztc3RFtGbuzHis9VdLWkwJ9c5CbskJd9xWQcy31fBKs2mwGB8m3jcw3++3ATU3EWMj/gMdYnUt9ZQuyR9/rfnJy7701F4YPPX3Aul8+dSinZA88Hfs1t+mGCwqsHb+02Iv5A6o8xM6YDAI2iB9nbYLtmnq/fnY3dfqdveP4a5wqurq9ft6WppXtaWkDwUmqByYepreaZMLV7TUsycpZ05wG8Mnxq480TWwAd0ggNwXBUmJKqQxWC5kvOI9qKBklEeOMtnjF/NoCmKgjnMChQoV0RzXKUv3k5AxRtWOCoZCWcq9qYHxhggcsCsnsqMB5qtxAdI68NeErWfGfeBJhHmQRIx9sV6rIuqwHGxkq2pAzs4Mi2BZKNenMlDk5t/VT6xUm6snPgLRL7AgzdJ5sBkFHhGdDxbivFUlPFVlJOqfBMx1y0m+RsdJsmHgXR8UDVxntEoA4Pz3lf3bddKnBhZytgJY49Tj21Zw8BKtA6u1HGR9E7DOoXNvymKSLruFOuZKOwGhVRykt8MugJOcczhnVfTPgeh4YtbK/Fw4uHuT535/y5fk1J1uwz4OlYwIaFL4HmdhCNvA7pXVzTgQTTVBmQan6xU4mSK2kpkkbkMn56enknOO/ycTboyFOEVvgkvTL+NRgJYs5eRfBRZP3HME2q3hw0KYdoKgjQWX0PL5ZznBpgTFp5Iw5+F+LKFlr7Pf671oROoZiPlRbS5Lgr/nw7enpJM87J7479k6WqGQRh9Bb80j6xR9g7ta4/vU+Xc+qPpUxaZspTCai+F3sWNs/T0Y6yoOVvo5T3NMJVvIkfR/djXk2KskvDM+DlXFRYx7nRmK4W4eG614h2ggWa5ftbBhfVPdIHOpiap4Ox1Ws5HB5JjbZPsfR4faL1M7jXOr5ybNc463hNxyc5P8d87fjWSV/Jk7qxrt9qmbGXRAyZGF/csx/286TH9vI9Qa/u3aG6w9q3Zx2MHx1F7cDVjdf9YeocX8sEmJ39EnT9B6UF2IXorZMHQBLXMcw1tm7HXTT9N1+m45HG3bPzERfNil4VZHmUS4m8PLsAJ19JpWbBNC4d7bk//rHPyNHm2/xfb2Aq2ChMiuys6BiDZspepLceA93RI6wVOScquNGZR73RYWcS89Yo+m6OVY4lUryi2Qyk0Bf71G7AXzejoAvbVz00JIUP2RQxjxGcGAAgzdlvKOt5ytjH2esUgYIU17IcLd1RC0L6QXqnEtXSs2M6y/qhMwqy40UZcnEjFNoNpO5ZMFcfizmHkrUOCe+LAPWm73Q1G4H1kwZ5jmjQgIy3kBJ5JOJvL1yA/jAwDEaHsEueZSKioRhXJYwZJOcbIYuYEpxw4a5lzklmOfRelC8HotPMc0qQSmoDJdJiYrhdD+2LMhb1C5u2xLQbkLTua8BWfGOAusB3Ot7fcPJEhxxAiipH93oXp/AXZdmn2nqpKftpmy1Wh2Uhde7PD9JvwhTXtOZLd88HsYi0mfvfrwWmfBkS3c1uyG7lHkLDL5w5zASD5vmgWm2bksAVvLHfQYu5ErmpB31Sv37n65/gSX8MDgVWa8QfoPCw18uLz7+evOR5XKpTu/vbHA6OI0rHON8ibp31f4aNm4oe8u7nYfc26L9f4f7B+5wm57l6ckPK4VS9yBtat13eyOEyMSov7YdZ2LBrX50J9ZrdtgnntX5+PdAlnHCOBNLtJKLfWxmzbBTHB/A+pnw6rdmMHkNX9gAH9W/bcSau3DclaVu9Uj13s55M95kbTdm1RLFRVLg5JblbCUcQDUGE4njfZ5T5Z+l7WOj66ubW5GJdtVTxhW1sLjinTauxEjci3sRV+yx9MY1Lp+vhUI9D3FKEEkugwgMHKk+AnmMCKT5D1t21Ce70CSZwn+zYUcZ/szv8Geq/9KRpy9fZGh821JzfMabzebfbJAljA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document 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)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.d669ec3e.js b/assets/js/28b19cd2.d669ec3e.js deleted file mode 100644 index be528a7c3..000000000 --- a/assets/js/28b19cd2.d669ec3e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>f,toc:()=>j});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),m=(s(82723),s(9487)),o=s(41429),c=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document 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:"eJztWM1uG8kRfpVyX2QZI1KS7RyIIFhHNjbCLiJhpYUPEkHUzBSHLfV0z3b3kJwQc8uT5NHyJEH1/HD4I60NBHtJgIVX7Kn/qq76ujbCY+bE5EF8NkmZk/ZOTCORkkusLLw0WkzE/YLgyhJ6go4KPt1eAyplVg4qU4I3kJEmyzSaVpB20iCu4Kl0HgprljKVOgNPeaHQ00ymILXzhCmYOZSFMhgIMIiYS0VvpQa/IJgbmzNNjI7+9AGMhVhqtNUp0JJsBV7mFOzQRCkbkzTmYm/ICO5btY6lgaWCKVJVQekoDdocJKghppY7hbk1OX+2ILUnO8eEAD08vHv3meIyg1+v372bvl14X7jJeIxFMTIFaSczrTB2o8Tk45QJi3R+ykaXLvi/DWdnE4dz9KhFJEzBQZRGX6diIlpDWh9W0i+64MlURKJAizl5spzBjdCYk5iIQXxFJCRnsEC/EPtpNfETJf46BL8zRETC0m+ltJSKibclRcL5SrFYJ/NCMQGtC2VSEpM5KscEyYJyFJON8FURKL2VOhOR4LShH57QGoOUiSj+dhEvkstFEYu6njZqyfm/mrRiUYnRnrTnP7EolExCUMZPjk3fDHRuzX0QHHkOxjTqTGl85FBZjqyX5AJ7S7i1Ga3FisPlKR+evyDAGnbi0OOtf5+SxJReo/aijgTlKNWrIQoEQwFPhn5of3ElsZQmwa9pfTIEMRETFwujf4f64vI9//f+QtR1JLz04XS36AbVNLtrw8bUc6NSslylr2lgQxzpdLYfgNgYRagPivJ+IR30db3XYlxBiZxXsFqQX5ANxyvUHoJ0xyQxgeP+xNSNtSPg/pXSHEvlYYmqJJAOHgWX96MYwfU8XMnmi+EfOyYMaAF1CtrASdA3c2UojpNx+zs2aXWy5XSAllqbJaW9CYG474IOVlIptpv7UNME+vix2q56OnXHAr4bw6vSeZNDUNMyhZ7HAUFfWoL2so3gCjVInagypbbRcsC5S8Fm05XALFRGXcNmw7kkO+NCrOtoe8C6dg5C9TUnlhKSyx2u/oi2jP3ZgJXWhbTVLEXfHiQmL1BXQwNkpqXOZqVVdT06KL5tZr45bgdhajPGQv4HIsbmXOsbm5I9el/3i5Nn7725Mnzo6TNWw/apyzwmexDpMK95TLdckGLl+KaFWcwfUCVlmIyNQ8AO8eWsTGn7oT7sn72m3r6Lj5x/jbGim/vb130Jo+zlJjgbdsFQTDUT747KcOAKo10zIy7Pz/l/u55fa3BlkpBz0BE3bYybQEYeSqtA6u1HGXwOrQSV67oak3TGgeFmuJKOwGhVBSndbI8gJ+ccZjy4v3mmvj77OtnfO/EXT/LyH+tkeXnLZVba1+fhMQEt0NqbiuwhO/id0nooG+ZFm5R5qVT1ZmccSq2kplmXkNnl+fnskvNfR+LD0RQ3GVvgkvSJB0xTWMk0I+/C/GjHEmewqyrGhtp0GJl6ElRGZ8Cwj1uNtMCwI3CGGvyvZZSsNfZ743erCB1PW18WW08awb8Xww/n57Mk6YP48dg9WaKSaXhn3Jtn0m/+AHe3zg3V+0Y9m7rOQ9G2QFs2ROG72PF2eN446SgprfRVAOrrMyzkWfN98jBl+JuTXxiG/IVxwWJG7BMx3u1D482gEdWCxdplB//DjeoviUOdxmZ9+CLBQo6XF6KO9jmOvl9epHYeM6mzs1e5plvH7zg5Tfx33N8i8EL+RFzUbXSHVO0zZkHIU4njyTn/Zftk+NJlboDtHzqYPsTiPRQ/wNe94g5D9xB6iJOnQ+QrxC66bR5Me2hNiF0U0jH1M7bhOjZGLz7uDLBmSHEs5iYErq23m4I0Q/NQrcuLg2n7lVRimoHLiKUj//c//xU4uuIKl+kN3JQWCrMiOy9VaFhzRWsZKzry5neEuSLnVBVeyFl4/6cykx4VtDgDEiwwlkry9WMy0wzxwQ12I/i6hfQnNjzcaUmKby0oY57Du9kAlt7kQUfXvFfGPs/ZpAgQYn5g82h1RB0L6QXqhPtUU4cRN1vUQPyiLyxPTZQ5EzNEpvlcJpIFc6+xmHjIUWNGrCwCtpuj0DZqB9bEvNxwRpXBEdaYE/nGRd5GuBF8lktqHA/ghTxKRSlkJYuIIDEpw5xQieyGTiGmsDHBxMuEglDn0XpQvO4I967BnqVSUBjuiRIVw6NhblmQt6hd2J40wKlNTR++whoee0FHitUIHvWjvuNiKR1xASipn93kUZ/BQ19mXyl20tN287FarQ56wOkuz4/SL8qY1y5my5eFw9Axhuz9j1MRCU82dzfzO7JLmXQo4AWd40A8bicFNm+l7r5jIX/YZ+CurWRC2tGgr3/68fZnWML70bmIBl3vGwwe/3x99eXvd19YLvfl5v5djM5H5+FJbpzPUQ9U7a/VwsZpsIzZuciDrcj/d3J/4E6uHVCe1n5cKJR6gF+bOf2w914QkZgM13DTSCx4rk8exGbDAfuV3158/FtJlkHBNBJLtJJ7fZhcqXT8d9pv2V6shLe/tK+QU3hho3fU/m7qah65YffRjKZnqvZ2iPW0jrrRy6Y1FFeNAWf3LGcr4QCXMXJoOD4lCRX+VdohELq9ubsXkeie7nlYOQqLK95R4kpMxKN4FGFlGlpvWMvx+UYo1FkZngSikcuIAUvO1BBuPAe40f7Bnh2NyS4OaVzhf9mxowx/5nv4E1V/6cmbLy8ytLHtqDk/07qu/wPgfVob",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document 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:"eJztWM1uG8kRfpVyX2QZI1KS7RyIIFhHNjbCLiJhpYUPEkHUzBSHLfV0z3b3kJwQc8uT5NHyJEH1/HD4I60NBHtJgIVX7Kn/qq76ujbCY+bE5EF8NkmZk/ZOTCORkkusLLw0WkzE/YLgyhJ6go4KPt1eAyplVg4qU4I3kJEmyzSaVpB20iCu4Kl0HgprljKVOgNPeaHQ00ymILXzhCmYOZSFMhgIMIiYS0VvpQa/IJgbmzNNjI7+9AGMhVhqtNUp0JJsBV7mFOzQRCkbkzTmYm/ICO5btY6lgaWCKVJVQekoDdocJKghppY7hbk1OX+2ILUnO8eEAD08vHv3meIyg1+v372bvl14X7jJeIxFMTIFaSczrTB2o8Tk45QJi3R+ykaXLvi/DWdnE4dz9KhFJEzBQZRGX6diIlpDWh9W0i+64MlURKJAizl5spzBjdCYk5iIQXxFJCRnsEC/EPtpNfETJf46BL8zRETC0m+ltJSKibclRcL5SrFYJ/NCMQGtC2VSEpM5KscEyYJyFJON8FURKL2VOhOR4LShH57QGoOUiSj+dhEvkstFEYu6njZqyfm/mrRiUYnRnrTnP7EolExCUMZPjk3fDHRuzX0QHHkOxjTqTGl85FBZjqyX5AJ7S7i1Ga3FisPlKR+evyDAGnbi0OOtf5+SxJReo/aijgTlKNWrIQoEQwFPhn5of3ElsZQmwa9pfTIEMRETFwujf4f64vI9//f+QtR1JLz04XS36AbVNLtrw8bUc6NSslylr2lgQxzpdLYfgNgYRagPivJ+IR30db3XYlxBiZxXsFqQX5ANxyvUHoJ0xyQxgeP+xNSNtSPg/pXSHEvlYYmqJJAOHgWX96MYwfU8XMnmi+EfOyYMaAF1CtrASdA3c2UojpNx+zs2aXWy5XSAllqbJaW9CYG474IOVlIptpv7UNME+vix2q56OnXHAr4bw6vSeZNDUNMyhZ7HAUFfWoL2so3gCjVInagypbbRcsC5S8Fm05XALFRGXcNmw7kkO+NCrOtoe8C6dg5C9TUnlhKSyx2u/oi2jP3ZgJXWhbTVLEXfHiQmL1BXQwNkpqXOZqVVdT06KL5tZr45bgdhajPGQv4HIsbmXOsbm5I9el/3i5Nn7725Mnzo6TNWw/apyzwmexDpMK95TLdckGLl+KaFWcwfUCVlmIyNQ8AO8eWsTGn7oT7sn72m3r6Lj5x/jbGim/vb130Jo+zlJjgbdsFQTDUT747KcOAKo10zIy7Pz/l/u55fa3BlkpBz0BE3bYybQEYeSqtA6u1HGXwOrQSV67oak3TGgeFmuJKOwGhVBSndbI8gJ+ccZjy4v3mmvj77OtnfO/EXT/LyH+tkeXnLZVba1+fhMQEt0NqbiuwhO/id0nooG+ZFm5R5qVT1ZmccSq2kplmXkNnl+fnskvNfR+LD0RQ3GVvgkvSJB0xTWMk0I+/C/GjHEmewqyrGhtp0GJl6ElRGZ8Cwj1uNtMCwI3CGGvyvZZSsNfZ743erCB1PW18WW08awb8Xww/n57Mk6YP48dg9WaKSaXhn3Jtn0m/+AHe3zg3V+0Y9m7rOQ9G2QFs2ROG72PF2eN446SgprfRVAOrrMyzkWfN98jBl+JuTXxiG/IVxwWJG7BMx3u1D482gEdWCxdplB//DjeoviUOdxmZ9+CLBQo6XF6KO9jmOvl9epHYeM6mzs1e5plvH7zg5Tfx33N8i8EL+RFzUbXSHVO0zZkHIU4njyTn/Zftk+NJlboDtHzqYPsTiPRQ/wNe94g5D9xB6iJOnQ+QrxC66bR5Me2hNiF0U0jH1M7bhOjZGLz7uDLBmSHEs5iYErq23m4I0Q/NQrcuLg2n7lVRimoHLiKUj//c//xU4uuIKl+kN3JQWCrMiOy9VaFhzRWsZKzry5neEuSLnVBVeyFl4/6cykx4VtDgDEiwwlkry9WMy0wzxwQ12I/i6hfQnNjzcaUmKby0oY57Du9kAlt7kQUfXvFfGPs/ZpAgQYn5g82h1RB0L6QXqhPtUU4cRN1vUQPyiLyxPTZQ5EzNEpvlcJpIFc6+xmHjIUWNGrCwCtpuj0DZqB9bEvNxwRpXBEdaYE/nGRd5GuBF8lktqHA/ghTxKRSlkJYuIIDEpw5xQieyGTiGmsDHBxMuEglDn0XpQvO4I967BnqVSUBjuiRIVw6NhblmQt6hd2J40wKlNTR++whoee0FHitUIHvWjvuNiKR1xASipn93kUZ/BQ19mXyl20tN287FarQ56wOkuz4/SL8qY1y5my5eFw9Axhuz9j1MRCU82dzfzO7JLmXQo4AWd40A8bicFNm+l7r5jIX/YZ+CurWRC2tGgr3/68fZnWML70bmIBl3vGwwe/3x99eXvd19YLvfl5v5djM5H5+FJbpzPUQ9U7a/VwsZpsIzZuciDrcj/d3J/4E6uHVCe1n5cKJR6gF+bOf2w914QkZgM13DTSCx4rk8exGbDAfuV3158/FtJlkHBNBJLtJJ7fZhcqXT8d9pv2V6shLe/tK+QU3hho3fU/m7qah65YffRjKZnqvZ2iPW0jrrRy6Y1FFeNAWf3LGcr4QCXMXJoOD4lCRX+VdohELq9ubsXkeie7nlYOQqLK95R4kpMxKN4FGFlGlpvWMvx+UYo1FkZngSikcuIAUvO1BBuPAe40f7Bnh2NyS4OaVzhf9mxowx/5nv4E1V/6cmbLy8ytLHtqDk/07qu/wPgfVob",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function y(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,l.jsxs)(a.p,{children:["The Create Document 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,l.jsx)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,l.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})}),(0,l.jsx)("span",{className:"openapi-schema__divider"}),(0,l.jsx)("span",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.84ff4b21.js b/assets/js/2c586be5.84ff4b21.js new file mode 100644 index 000000000..7890a482f --- /dev/null +++ b/assets/js/2c586be5.84ff4b21.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>g,frontMatter:()=>p,metadata:()=>x,toc:()=>y});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztG9tyG7f1V07x4lizXImy7KScTqeOnaaeNJGnVibTETUKuHvIhb0LbACsyK2Gb/2Sflq/pHNw2V1SpBQ7mUad0g8yFzgAzg04N+CWWb4wbHLJXqusqVBaw64SlqPJtKitUJJN2EWB8EojtwgRCl6+fQO8LNXSQGNQG7AKFihRE5TEJeRxPpi1UGt1I3IhF5Bzy2EpbAEzbvDFGaDMVI45zEWJ6VRO5fd1qXgOrWqgzucgJKhGw+XR0WucNQv4/s3R0dVnhbW1mRwf87pOVY3SiIUs+cykmaqOcwKs8/lTKFCjmynjEnLNl7AU+QKtAS5zyFTdQqZGSotccosJ1HyBIJtqhhrUHGyBVQq8NKqbxI0JqKs5vH39Z8L56OhLLNVgdo1gmrpW2mJOJNgCO45Mjo5ozCtVVUpCzTWv0BIL1TxOMJnKERwd2bbGydERvJG5yLhF4+ah1h429aCEOYG+qzETcxFAN+iRsCxEVjhSllxaElld8gwdqEZTY2bFDW5OvEqgpYlfo1QRg0Jp8Q8lLS8dH29QW5HxEjKldC6kw9SzD4zl2pLgayWkja1hBfh74GpjPBJ5EDGhlhNTKiFdj0G44WWDJmC1TKAgrP6GtUbj1CzMawuHU4FiUexdj+fvG2M3JobGEJpDLMJaGn9qhMbcsRcd2+a8NAhivsHLin/AwWqg3P7hZQpftpDjnDelTUDYJwasbjCF75QFXtelyPisRJgrDaTH3DYaR07KQR0CIpJXTsZv3W5CAxxyMZ+jpg1JnW6KqIMBO1LFfvtVShOOXIKSA0GPUzg66tZ2Cvrjjz9O5e1UAkwZ4TJlkynrQKYsAd9HKjZlk3ECoWE1ZRN4dvp5BGjp+8XpF/F7Sd/j8Vn8Luj7dDyV67Aokfqdso7UlxZK5MY6dLvVQRiIUnE0I88K1406hZdlOQCdCyxzvyMzVdVNaZRu6UwKEkmn8tRRb3lV30M5df/6VMdPryuGGt3K1BYppEZSGA9LPSRrau3Qoo51z8FnRJCQwgpemv00RYjHR1aP2RZlZ0QZVlyU+8ly3Y+PpoDWFkHP035j76HHT/HYyPG/tqh5QdS8VzOwwpb3kNSBPD66BqhtEfc5EUdnCJftftICwOMjrENsi6wviKyc23vERb2Pj6CAVewI57nvOzkbjZ+PTk9OzwYQc6UrHgCqapTno7Zt2ymDniPQWaAwHRmhaHC9c0AO7lyraoc35ZydHio4H+539EC+Jb9jFk1y7xya4Lc5e1Zxu+k0WJXz9onxU8WhwSvw8L3v1w7QdF2ER0s+dFYokQXkCSYwHmbku6bEhBHxMT/+9ttjz5mkbxxVVWCXlwW10vfIcXLYWlVpnqfbsEOGD1sryPMEdrTv7shzqKpqX7vvIBWfyt+TXltc2Zla7VftAPD4tLtHbKeCB6MQ+wohQ0fQDtgC0LhoSq5xRf6yEUo66u8cBluaHxWfR1X0zrLzuVwo4pGEz86Dr/s0KCXhszkBtTw87g6aw0k0LnDl5sgaY1VFyIic0wwJmCYrgBsflJKrq2TZhtjHJP4r47WgoKVEa10r2izdRGIqxyfunC8w+3Cv5kSIx6c6A8xip49xqPtyyioeDC+bY/9b2QL1lF11YwyWmFnMB2Nh12C4GmgZz4nTBOxipB69QuRY8hmWfd8AuSDGAanUUQnpkYhsOInzuV6+2uoNnesdSu2JGGpTPP2iTkauQSlMDH43WTAcHYJGW3ALEjGn43+GEAcMAoxdSu65NAgoSZTb8aRBu4kYp6jHD90RUzqext0XeP3ACgQHDrCL1+Ni+xYIJGxIZsgXmqMSUlRNNUikxFkjx6pgBYfsopGUSoorDKV7ZwW+emAFivL3LzCVYxfy5lrVuVpKt8tht+8TQB7fNh9g9ku2+YZZ8XC/ZBtFrIbbaIdFIVBvS7otZPbvoRTO6fymJIAfJAzwLMPaYr51gI9dNK95LhTMGmuV3H+ED6Een3y3sPsvyJgI/nlSHuL2m0napzkqn/ncl+OonDQfm2wDWrs3GkuYqimTLpR8k7MJy1zyPeaPWeKWQGO/VHnLJrcsU9JSx+SWhXwiDT1+byh9f8tMVmDF6VdEjRL+lHBnCfNZM8MS5qJeyv4T89iEqdl7zGi1WhM6VqChOdy4yW2EMlYLuWBJiK7YhPnsOEsYrnhVEzDbyvXX+Zyt44L3TdW19FMZ96NLptM8G9WKT5rt9WCGdcIo0/2JM1Hi0tNW4YV6pajR4mvemsGE3myx7ToLjaGdkYVRkPPW0AZojHcwMl5mTUmRHa5qodsuzHTh3UA/OkS7lTpEx8/XvdB7lLjWvGUJExarYfseJdDq4yWXoSLOuDzYx459r3CG+KfQQFUeJydefTQW7xXCDJ2M6kLJjx4/Pn02Ph0/G5/SDCHX/ul89L13MdhUjJcU02Aenc5Rn95OwGWA04eUM8I7svkCH1bGi33lo0GFwxSqKXOqYSDXqavifHqtbkO/O6ORPqDN64StHiZm5ct8vjYFn5U4t9DUNWrIlJaonw4zOo+GuNOzs3XC2ofJa/8nyfuchLd8mLofXFGvL3j+Frg++2KdsOJhXP/SlR1/Q2TPXqx767rlPFzPVN5ex3Nr/RBgNBQEN1dljpockrvnVX/U0AljUObX2+f8TKkSudxx0AjTV8HjpQIKUykGDinNZYHk0/bRq5u99yNDxOyxTeHCVXGHGSthyCvUDU5ZCm/mA6/UBb4bKAxgXS1ZKnji1rs2jTvGnxyHb+LRk2EJ3xX+u1RuRMEBg8WqLl1tfCnKkvAmu55C9895fh0nCYFoLuPCD5uKVz4z5hYMgzYLyxB8xxRecQlCZmUTnPS5iqkzuL3t1MBpx3oNt7ckVdTXZHTX66RvoLU2Gpxd9S0aMxQ3G6O6JuwHdm2Dod7FuSYXxzeEAsYQAbGQQi6uG12u1+kdNexl9LP5dodNQXY0yf8BxwidN/Jc56h37tw7yinp5sL5xdv7oX26b9vbpYTUyO89H0b5feHnhPOLt3SxRMxDNJPC9+6ekYMJ1APfAAGKLuBGcC+0pHdYWp9xQknbOxwUG3dy0nClYwR3EcqF2YlR0ueauytQdyaGXGjMbNm6S0+qscDzXPggFozF2qSsY+SFah7g+6dwksOicaUmS3YoHgYu/91fDBHSWN34bBvkjY53YYLCEGSGxvR8ilwhoMH8CaA0fjiHOTcWdQKNFMR53VAU302Jqxq1QJlhyh6wQ95Q9dFrUD+6s6Sk8a706ckJ/bfJmu6+WpiUygREx7wpy/Z3LPn5ofP9frxv3m0b73PMi/fi9B+r7Ob0LWlBoz86MIp+RKPLkVUj4u2oU2oXJg04K2QpJF5Htl2fnpxcj4m364Sd7WLfO1WhLUhYS2LiUiu5SKCmKzkIVrfAF1xIIKumf0VuotZK3+9mfBxm9zHhbIMJz+8y4Y10BQp35fFCfUD536V0uLz1yxOqq8rpig+BmfBArp9tEDts90QazBotbMsml7dsNeK1GPn+yeXV+iphxFhFaadaGYcxtwWbsOM7WSiD+sZlES5vvep22mi4zKmIcMez5bU4vhmzdbI9YqcfvBfaWL4QcjG6d9RVT+o7Eofn+AbBfdhei2+Q4vbAzyFUwgSpQYGczCJxkKT8tz4F91WUVUyO7cp39TLZzmBtH+c7clIxJbWRZdqdZBo/H6R3LmOmxiVfutzLrnRKR3pMkHT5kUHKY5DxuOx1tksuxNzC2AXlp2dnLnr9fOzCvGdfuAjq7MXaaVkfTTC2GTG4nOm238vYpj8XB3XeShjVOyTBVA4tq2takzznygk/SOS8RvmOLDftsZvx3QgUy0z53ByZuwj+73/+y42IknRHwO/gvNFQqyXqeePvx85LXAmylYNL0zG+QV6VaEzZApnIhbs+nYuFK1NHQ5nxms9EKejQIDDl832Dc8ek8EMfIT3RvmJ/gyWdNVAq9cHZcwW8sapya0TDuFT6w5xQSoDDjC7BojFgEOMQlAWXGQVZfi8loDRw6Z2pWguDwEVFwO4m5nwuMuEsrpJW88xCxSVfIC2WuEiYuFDHK6xazcgzM6psvO9BF2kRrSfRFQtSeE2+niPc5TnRclFi7t0Ok3i3L+gykSFzmJHrXtPyIkPT380p8Qa1Ozu8A9+UJdSKTnLBSwoFh7Kliazm0pABDjnWIJqOfcEvcmvkvE2BiotknMgnJAUohfzg73Nfdmr2A86MsNhnAZbL5Z1z7OnmmK+FLZoZaKxVP27hGt2pNxzefTylQwJ1Zc7n71DfiCy6DHvWPHbAx8G+cR9wxkOD1+JP2wPI1pQiQ2lwYI1efv32r3ADz9ITlgxO7p+B8PFf37z66rt3X9G8ZFv8/hunJ+mJS10qYysuB0ttvUvY3rqD2sjhGcPhGcPhGcPhGcPhGcPjK4cfnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjHsUOrDM4bDM4bDM4bDMwY4PGM4PGP47WX70DOGUCEkP+m4LrmQg1sOvqx8uf244SphBdWdJ5fs9pYy1N/TVSVq/qlBTUXrq4TdcC0o2ehK1kkszVJN8gNScfCVT/qPLmj9xOuaq2BsVeqpsuxHvHTCuRd2WBp/e/7ugiUs3i2rVE5jNF/S4wy+ZBPySZl7yOE46+7Mc3fZteRy0bgyKfPzUkWZN7bYLEd/cOXo8GNQbeWyHWC5Waf2pNBfImzngD9QxeMbbP/YgfuevQMCbyM0ifBqvV7/B7clbE4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztG9tyG7f1V07x4lizXImy7KScTqeOnaaeNJGnVibTETUKuHvIhb0LbACsyK2Gb/2Sflq/pHNw2V1SpBQ7mUad0g8yFzgAzg04N+CWWb4wbHLJXqusqVBaw64SlqPJtKitUJJN2EWB8EojtwgRCl6+fQO8LNXSQGNQG7AKFihRE5TEJeRxPpi1UGt1I3IhF5Bzy2EpbAEzbvDFGaDMVI45zEWJ6VRO5fd1qXgOrWqgzucgJKhGw+XR0WucNQv4/s3R0dVnhbW1mRwf87pOVY3SiIUs+cykmaqOcwKs8/lTKFCjmynjEnLNl7AU+QKtAS5zyFTdQqZGSotccosJ1HyBIJtqhhrUHGyBVQq8NKqbxI0JqKs5vH39Z8L56OhLLNVgdo1gmrpW2mJOJNgCO45Mjo5ozCtVVUpCzTWv0BIL1TxOMJnKERwd2bbGydERvJG5yLhF4+ah1h429aCEOYG+qzETcxFAN+iRsCxEVjhSllxaElld8gwdqEZTY2bFDW5OvEqgpYlfo1QRg0Jp8Q8lLS8dH29QW5HxEjKldC6kw9SzD4zl2pLgayWkja1hBfh74GpjPBJ5EDGhlhNTKiFdj0G44WWDJmC1TKAgrP6GtUbj1CzMawuHU4FiUexdj+fvG2M3JobGEJpDLMJaGn9qhMbcsRcd2+a8NAhivsHLin/AwWqg3P7hZQpftpDjnDelTUDYJwasbjCF75QFXtelyPisRJgrDaTH3DYaR07KQR0CIpJXTsZv3W5CAxxyMZ+jpg1JnW6KqIMBO1LFfvtVShOOXIKSA0GPUzg66tZ2Cvrjjz9O5e1UAkwZ4TJlkynrQKYsAd9HKjZlk3ECoWE1ZRN4dvp5BGjp+8XpF/F7Sd/j8Vn8Luj7dDyV67Aokfqdso7UlxZK5MY6dLvVQRiIUnE0I88K1406hZdlOQCdCyxzvyMzVdVNaZRu6UwKEkmn8tRRb3lV30M5df/6VMdPryuGGt3K1BYppEZSGA9LPSRrau3Qoo51z8FnRJCQwgpemv00RYjHR1aP2RZlZ0QZVlyU+8ly3Y+PpoDWFkHP035j76HHT/HYyPG/tqh5QdS8VzOwwpb3kNSBPD66BqhtEfc5EUdnCJftftICwOMjrENsi6wviKyc23vERb2Pj6CAVewI57nvOzkbjZ+PTk9OzwYQc6UrHgCqapTno7Zt2ymDniPQWaAwHRmhaHC9c0AO7lyraoc35ZydHio4H+539EC+Jb9jFk1y7xya4Lc5e1Zxu+k0WJXz9onxU8WhwSvw8L3v1w7QdF2ER0s+dFYokQXkCSYwHmbku6bEhBHxMT/+9ttjz5mkbxxVVWCXlwW10vfIcXLYWlVpnqfbsEOGD1sryPMEdrTv7shzqKpqX7vvIBWfyt+TXltc2Zla7VftAPD4tLtHbKeCB6MQ+wohQ0fQDtgC0LhoSq5xRf6yEUo66u8cBluaHxWfR1X0zrLzuVwo4pGEz86Dr/s0KCXhszkBtTw87g6aw0k0LnDl5sgaY1VFyIic0wwJmCYrgBsflJKrq2TZhtjHJP4r47WgoKVEa10r2izdRGIqxyfunC8w+3Cv5kSIx6c6A8xip49xqPtyyioeDC+bY/9b2QL1lF11YwyWmFnMB2Nh12C4GmgZz4nTBOxipB69QuRY8hmWfd8AuSDGAanUUQnpkYhsOInzuV6+2uoNnesdSu2JGGpTPP2iTkauQSlMDH43WTAcHYJGW3ALEjGn43+GEAcMAoxdSu65NAgoSZTb8aRBu4kYp6jHD90RUzqext0XeP3ACgQHDrCL1+Ni+xYIJGxIZsgXmqMSUlRNNUikxFkjx6pgBYfsopGUSoorDKV7ZwW+emAFivL3LzCVYxfy5lrVuVpKt8tht+8TQB7fNh9g9ku2+YZZ8XC/ZBtFrIbbaIdFIVBvS7otZPbvoRTO6fymJIAfJAzwLMPaYr51gI9dNK95LhTMGmuV3H+ED6Een3y3sPsvyJgI/nlSHuL2m0napzkqn/ncl+OonDQfm2wDWrs3GkuYqimTLpR8k7MJy1zyPeaPWeKWQGO/VHnLJrcsU9JSx+SWhXwiDT1+byh9f8tMVmDF6VdEjRL+lHBnCfNZM8MS5qJeyv4T89iEqdl7zGi1WhM6VqChOdy4yW2EMlYLuWBJiK7YhPnsOEsYrnhVEzDbyvXX+Zyt44L3TdW19FMZ96NLptM8G9WKT5rt9WCGdcIo0/2JM1Hi0tNW4YV6pajR4mvemsGE3myx7ToLjaGdkYVRkPPW0AZojHcwMl5mTUmRHa5qodsuzHTh3UA/OkS7lTpEx8/XvdB7lLjWvGUJExarYfseJdDq4yWXoSLOuDzYx459r3CG+KfQQFUeJydefTQW7xXCDJ2M6kLJjx4/Pn02Ph0/G5/SDCHX/ul89L13MdhUjJcU02Aenc5Rn95OwGWA04eUM8I7svkCH1bGi33lo0GFwxSqKXOqYSDXqavifHqtbkO/O6ORPqDN64StHiZm5ct8vjYFn5U4t9DUNWrIlJaonw4zOo+GuNOzs3XC2ofJa/8nyfuchLd8mLofXFGvL3j+Frg++2KdsOJhXP/SlR1/Q2TPXqx767rlPFzPVN5ex3Nr/RBgNBQEN1dljpockrvnVX/U0AljUObX2+f8TKkSudxx0AjTV8HjpQIKUykGDinNZYHk0/bRq5u99yNDxOyxTeHCVXGHGSthyCvUDU5ZCm/mA6/UBb4bKAxgXS1ZKnji1rs2jTvGnxyHb+LRk2EJ3xX+u1RuRMEBg8WqLl1tfCnKkvAmu55C9895fh0nCYFoLuPCD5uKVz4z5hYMgzYLyxB8xxRecQlCZmUTnPS5iqkzuL3t1MBpx3oNt7ckVdTXZHTX66RvoLU2Gpxd9S0aMxQ3G6O6JuwHdm2Dod7FuSYXxzeEAsYQAbGQQi6uG12u1+kdNexl9LP5dodNQXY0yf8BxwidN/Jc56h37tw7yinp5sL5xdv7oX26b9vbpYTUyO89H0b5feHnhPOLt3SxRMxDNJPC9+6ekYMJ1APfAAGKLuBGcC+0pHdYWp9xQknbOxwUG3dy0nClYwR3EcqF2YlR0ueauytQdyaGXGjMbNm6S0+qscDzXPggFozF2qSsY+SFah7g+6dwksOicaUmS3YoHgYu/91fDBHSWN34bBvkjY53YYLCEGSGxvR8ilwhoMH8CaA0fjiHOTcWdQKNFMR53VAU302Jqxq1QJlhyh6wQ95Q9dFrUD+6s6Sk8a706ckJ/bfJmu6+WpiUygREx7wpy/Z3LPn5ofP9frxv3m0b73PMi/fi9B+r7Ob0LWlBoz86MIp+RKPLkVUj4u2oU2oXJg04K2QpJF5Htl2fnpxcj4m364Sd7WLfO1WhLUhYS2LiUiu5SKCmKzkIVrfAF1xIIKumf0VuotZK3+9mfBxm9zHhbIMJz+8y4Y10BQp35fFCfUD536V0uLz1yxOqq8rpig+BmfBArp9tEDts90QazBotbMsml7dsNeK1GPn+yeXV+iphxFhFaadaGYcxtwWbsOM7WSiD+sZlES5vvep22mi4zKmIcMez5bU4vhmzdbI9YqcfvBfaWL4QcjG6d9RVT+o7Eofn+AbBfdhei2+Q4vbAzyFUwgSpQYGczCJxkKT8tz4F91WUVUyO7cp39TLZzmBtH+c7clIxJbWRZdqdZBo/H6R3LmOmxiVfutzLrnRKR3pMkHT5kUHKY5DxuOx1tksuxNzC2AXlp2dnLnr9fOzCvGdfuAjq7MXaaVkfTTC2GTG4nOm238vYpj8XB3XeShjVOyTBVA4tq2takzznygk/SOS8RvmOLDftsZvx3QgUy0z53ByZuwj+73/+y42IknRHwO/gvNFQqyXqeePvx85LXAmylYNL0zG+QV6VaEzZApnIhbs+nYuFK1NHQ5nxms9EKejQIDDl832Dc8ek8EMfIT3RvmJ/gyWdNVAq9cHZcwW8sapya0TDuFT6w5xQSoDDjC7BojFgEOMQlAWXGQVZfi8loDRw6Z2pWguDwEVFwO4m5nwuMuEsrpJW88xCxSVfIC2WuEiYuFDHK6xazcgzM6psvO9BF2kRrSfRFQtSeE2+niPc5TnRclFi7t0Ok3i3L+gykSFzmJHrXtPyIkPT380p8Qa1Ozu8A9+UJdSKTnLBSwoFh7Kliazm0pABDjnWIJqOfcEvcmvkvE2BiotknMgnJAUohfzg73Nfdmr2A86MsNhnAZbL5Z1z7OnmmK+FLZoZaKxVP27hGt2pNxzefTylQwJ1Zc7n71DfiCy6DHvWPHbAx8G+cR9wxkOD1+JP2wPI1pQiQ2lwYI1efv32r3ADz9ITlgxO7p+B8PFf37z66rt3X9G8ZFv8/hunJ+mJS10qYysuB0ttvUvY3rqD2sjhGcPhGcPhGcPhGcPhGcPjK4cfnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjHsUOrDM4bDM4bDM4bDMwY4PGM4PGP47WX70DOGUCEkP+m4LrmQg1sOvqx8uf244SphBdWdJ5fs9pYy1N/TVSVq/qlBTUXrq4TdcC0o2ehK1kkszVJN8gNScfCVT/qPLmj9xOuaq2BsVeqpsuxHvHTCuRd2WBp/e/7ugiUs3i2rVE5jNF/S4wy+ZBPySZl7yOE46+7Mc3fZteRy0bgyKfPzUkWZN7bYLEd/cOXo8GNQbeWyHWC5Waf2pNBfImzngD9QxeMbbP/YgfuevQMCbyM0ifBqvV7/B7clbE4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},y=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Upload you pdf in our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,i.jsx)(n.p,{children:"Common parameters of 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"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\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 }\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 }\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 }\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 }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.dff34c6e.js b/assets/js/2c586be5.dff34c6e.js deleted file mode 100644 index 3f811b5b9..000000000 --- a/assets/js/2c586be5.dff34c6e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var a=s(85893),i=s(11151),l=s(58219),r=(s(62316),s(51039)),t=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7Ri4PGRbGwDJeaOdIwmSGnJMfS1NDbfsl+2n7J4vAyM5IlO0mL1otVHhwNeUieG3muN8zyuWHjC/ZapXWJ0hp2mbAMTapFZYWSbMzOc4RXGrlFiFDw8s0p8KJQCwO1QW3AKpijRE1QEheQxf1g2kCl1bXIhJxDxi2HhbA5TLnBZyeAMlUZZjATBQ4nciJ/rArFM2hUDVU2AyFB1RouDg5e47Sew4+nBweXn+fWVmZ8eMiraqgqlEbMZcGnZpiq8jAjwCqbPYYcNbqdUi4h03wBC5HN0RrgMoNUVQ2kaqC0yCS3mEDF5wiyLqeoQc3A5lgOgRdGtZu4NQF1NYM3r/9OOB8cfImF6u2uEUxdVUpbzIgEm2PLkfHBAa15pcpSSai45iVaYqGaxQ3GEzmAgwPbVDg+OIBTmYmUWzRuHxrtYIcelDAn0LcVpmImAugaPRIWuUhzR8qCS0siqwqeogPVaCpMrbjG9Y2XCTS08WuUKmKQKy1+VdLywvHxGrUVKS8gVUpnQjpMPfvAWK4tCb5SQto4Gk6Afwau1sYjkQURE2oZMaUU0s0YhGte1GgCVosEcsLqB6w0GqdmYV+bO5xyFPN853k8e1cbu7Yx1IbQ7GMRztL4Sy00Zo696Ng244VBELM1Xpb8PfZOA+XuDy+G8GUDGc54XdgEhH1kwOoah/C9ssCrqhApnxYIM6WB9JjbWuPASTmoQ0BE8tLJ+I27TWiAQyZmM9R0IWnSbRF1MGBHqthdv1JpwpFLULIn6NEQDg7as52C/vzzzxN5M5EAE0a4TNh4wlqQCUvAz5GKTdh4lEAYWE7YGJ4cP48ADX0/O34Rvxf0PRqdxO+cvo9HE7kKhxKp3yvrSH1poUBurEO3PR2EgSgVRzPyNHfTqIfwsih6oDOBReZvZKrKqi6M0g29SUEiw4k8dtRbXlZ3UE7Tvz/V8dPriqFBdzKNRQppkBTGw9IMyZpGW7RoYtVx8AkRJKSwghdmN00R4uGR1WG2QdkJUYYlF8Vustz0w6MpoLVB0NNhd7F30OO3eGjk+F8b1Dwjat6pKVhhiztIakEeHl091DaIe07E0RvCZbObtADw8AhrEdsg6wWRlXF7h7ho9uERFLCKE+E993NHJ4PR08Hx0fFJD2KmdMkDQFkOsmzQNE0zYdBxBFoLFLYjIxQNrncOyMGdaVVu8aacs9NBBefD/Y4eyHfkd0yjSe6cQxP8NmfPSm7XnQarMt48Mn6ruDR4BR6+8/2aHppuivBoyIdOcyXSgDzBBMbDlHzXITFhQHzMDr/77tBzJukGB2UZ2OVlQaP0PXCc7I+W5TDLhpuwfYb3R0vIsgS2jG+fyDIoy3LXuJ8gFZ/Iv5BeW1zaqVruVu0A8PC0u0Nsq4IHoxDnciHDRNAO2ADQOK8LrnFJ/rIRSjrqbz0GG5ofFZ9HVfTOsvO5XCjikYTPz4Kv+zgoJeGzvgGN3L/uFpr9TTTOcen2SGtjVUnIiIzTDgmYOs2BGx+UkqurZNGE2Mck/ivllaCgpUBr3SjadLiOxESOjtw7n2P6/k7NiRAPT3V6mMVJH+PQ9MWElTwYXjbD7reyOeoJu2zXGCwwtZj11sK2xXDZ0zKeEacJ2MVIHXq5yLDgUyy6uR5yQYw9UmmiFNIjEdlwFPdzs3y5MRsmV1uU2hPR16b4+kWdjFyDQpgY/K6zoL86BI025xYkYkbP/xQhLugFGNuU3HOpF1CSKDfjSYN2HTFOUY9fuiWmdDyNty/w+p4TCA4cYBuvx8N2HRBIWJNMny+0RymkKOuyl0iJu0aOlcEK9tlFKymVFE/oS/fWCXx5zwkU5e8+YCJHLuTNtKoytZDulsN23yeAPLxr3sPst1zzNbPi4X7LNYpY9a/RFotCoN6WtFfI7L5DQzij95uSAH6RMMDTFCuL2cYDPnLRvOaZUDCtrVVy9xPeh3p48t3A7g+QMRH8YVLu4/anSdqnOUqf+dyV4yidNB+abANa2y8aS5iqKJMulDzN2JilLvke88cscUegsV+qrGHjG5YqaWlifMNCPpGWHr4zlL6/YSbNseT0K6JGCX9KuLOE+ayZYQlzUS9l/4l5bMzU9B2mdFqlCR0r0NAebt34JkIZq4WcsyREV2zMfHacJQyXvKwImG3k+qtsxlbxwLu2ake6rYz70SbTaZ+1asUn7fa6t8MqYZTp/sSdKHHpaSvxXL1SNGjxNW9Mb0NvtthmnYXW0M1IwyrIeGPoAtTGOxgpL9K6oMgOl5XQTRtmuvCupx8tou1JLaKjp6tO6B1KXGvesIQJi2V/fIcSaPXxkktREWdcHuxj175TOEX8IgxQlcfJiZcfjcU7hTBFJ6MqV/Kj14+On4yOR09Gx7RDyLV/Oh/97G0M1hXjJcU0mEWnc9CltxNwGeDhfcoZ4R3ZfI73K+P5rvJRr8JhclUXGdUwkOuhq+J8eq1uTb9bozG8R5tXCVveT8zSl/l8bQo+L3Bmoa4q1JAqLVE/7md0Hgxxxycnq4Q195PX/E+S95yEt7ifup9cUa8reP4ZuD55sUpYfj+u/2jLjn8isifPVp113XAerqYqa67iu7W6DzAaCoKbqSJDTQ7J7feqe2rohTEos6vNd36qVIFcbnlohOmq4LGpgMJUioFDSnORI/m0XfTqdu/8yBAxe2yHcO6quP2MlTDkFeoaJ2wIp7OeV+oC3zUUerCuliwVPHLnXZnaPeOPDsM38ehRv4TvCv9tKjei4IDBYlkVrja+EEVBeJNdH0L7z3l+LScJgWgu48H3m4pXPjPmDgyL1gvLEHzHIbziEoRMizo46TMVU2dwc9OqgdOO1QpubkiqqK/I6K5WSTdAZ60NOLvqRzSmKK7XVrVD2C1sx3pLvYtzRS6OHwgFjD4CYi6FnF/VulithrfUsJPRB/PtFpuC7GiT/wOOETqn8kxnqLfe3FvKKalz4ez8zd3QLnN0z1Pj36IuQAknUFuKksZ7S8dHR/TfuuTalqSwKWWCUzRmVhdF8xlLPjw6uttV88Pbn7+7fK/8nTj+dZleH78hDtf6o33faCpqXQysGpAIB5F13hPucVbIQki8imy7Oj46uhoRb1cJO9nGvreqRJuTDi+IiQut5DyBirouEKxugM+5kEAPl/4duYlaK323Jfk4zO5iwskaE57eZsKpdDlo19V2rt6j/GMp7R9v/fGE6rJ0uuKjHCY8kJtna8T2xz2RBtNaC9uw8cUNWw54JQZ+fnxxubpMGDFWUWahUsZhzG3OxuzwVqLBoL52geLFjVfdVhsNlxnliW85L7wSh9cjtko2V2x1dXZCG8vnQs4Hd6667Eh9S+LwHF8juIvMKvENUmgW+NmHSpggNciR08tHHCQp/9BlWb6Ksor5j20pjU4mm0mKTWuzJe0Qsw5riYTteYTR014EfxGDcRdft+H1toi5JT3GwG0I3Itqe0HtRaezbfwYw8eRi7uOT05cgPJ85Dz5Jy+ck3zybOW0rHMYGVt3Cl1abNO1YWzdZMdFrUEKqzqb4+0KCW+mnKQD+88qlG/FXLoLdT26HVFgkSqfayEzHsH/869/uxVRbO6+fwZntYZKLVDPat/vOCtwKahjr9cEG/1V5GWBxhQNCGlx7tphMzF3ZcdgfKkMyaeiEPRCEJjy+ZveI2OG8FPn8T7SvgJ7jQU9LFAo9d71KirgtVWlOyNawYXS72eEUgIcptTUiMaAQYxLUOZcpuQ0+4uTgNLAJaC0qCstDAIXJQG7zrrZTKTCmVclreaphZJLPkc6LHGRDXGhii2JWk2ptmNUUfuMMTVGIlpPokv+DuE1dZk6wl3eCi0XBWYwr2mLBOhGQVBcIkNmMCVXrKLjRYqm67Uo8Bq1eyi8Q1YXBVSKnm3BC3Lt+7Kljazm0pC1DTmzIJqWfZVW5Dy4MzLeDIGKRWSJyFknBSiEfO/7cy9aNfsJp0ZY7KK6xWJx69F6vL7ma2HzegoaK9Wtm7tB98T1l7cfj+lFQF2as9lb1Ncijf7BjjMPHfBhMGbcBxDxheCV+GJzARmWQqQoDfZMz8uv33wL1/BkeMSS3jP9AQgffnv66qvv335F+5Ih8fdvNDwaHrlUlDK25LJ31Eaf+ebV7eW6923p+7b0fVv6vi1935b+8Mqb+7b0fVv6vi1935a+b0vft6Xv29L3ben7tvR9W/q+LX2LUu/b0vdt6fu29H1bOuzb0vdt6X++bO9rSw/lQPKTDquCC9lrafA15IvNZvXLhOVUZB5fsJsbylD/SK0nNPxLjZoq1JcJu+ZaULLR1aeTWIelAuR7pErgK5/0H5zT+YnXNVfB2CjLUxnZr3jphHMnbL8O/ubs7TlLWOwVKlVGazRfULM9X7Ax+aTMNeY7zroeaO6aFwsu57WriTK/L5WPeW3z9drze1d7Dj96pVUumx6W60VpTwr9JcK2LvgrVTy+weZvLbif2bkg8DZCkwgvV6vVfwHlJKDd",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7Ri4PGRbGwDJeaOdIwmSGnJMfS1NDbfsl+2n7J4vAyM5IlO0mL1otVHhwNeUieG3muN8zyuWHjC/ZapXWJ0hp2mbAMTapFZYWSbMzOc4RXGrlFiFDw8s0p8KJQCwO1QW3AKpijRE1QEheQxf1g2kCl1bXIhJxDxi2HhbA5TLnBZyeAMlUZZjATBQ4nciJ/rArFM2hUDVU2AyFB1RouDg5e47Sew4+nBweXn+fWVmZ8eMiraqgqlEbMZcGnZpiq8jAjwCqbPYYcNbqdUi4h03wBC5HN0RrgMoNUVQ2kaqC0yCS3mEDF5wiyLqeoQc3A5lgOgRdGtZu4NQF1NYM3r/9OOB8cfImF6u2uEUxdVUpbzIgEm2PLkfHBAa15pcpSSai45iVaYqGaxQ3GEzmAgwPbVDg+OIBTmYmUWzRuHxrtYIcelDAn0LcVpmImAugaPRIWuUhzR8qCS0siqwqeogPVaCpMrbjG9Y2XCTS08WuUKmKQKy1+VdLywvHxGrUVKS8gVUpnQjpMPfvAWK4tCb5SQto4Gk6Afwau1sYjkQURE2oZMaUU0s0YhGte1GgCVosEcsLqB6w0GqdmYV+bO5xyFPN853k8e1cbu7Yx1IbQ7GMRztL4Sy00Zo696Ng244VBELM1Xpb8PfZOA+XuDy+G8GUDGc54XdgEhH1kwOoah/C9ssCrqhApnxYIM6WB9JjbWuPASTmoQ0BE8tLJ+I27TWiAQyZmM9R0IWnSbRF1MGBHqthdv1JpwpFLULIn6NEQDg7as52C/vzzzxN5M5EAE0a4TNh4wlqQCUvAz5GKTdh4lEAYWE7YGJ4cP48ADX0/O34Rvxf0PRqdxO+cvo9HE7kKhxKp3yvrSH1poUBurEO3PR2EgSgVRzPyNHfTqIfwsih6oDOBReZvZKrKqi6M0g29SUEiw4k8dtRbXlZ3UE7Tvz/V8dPriqFBdzKNRQppkBTGw9IMyZpGW7RoYtVx8AkRJKSwghdmN00R4uGR1WG2QdkJUYYlF8Vustz0w6MpoLVB0NNhd7F30OO3eGjk+F8b1Dwjat6pKVhhiztIakEeHl091DaIe07E0RvCZbObtADw8AhrEdsg6wWRlXF7h7ho9uERFLCKE+E993NHJ4PR08Hx0fFJD2KmdMkDQFkOsmzQNE0zYdBxBFoLFLYjIxQNrncOyMGdaVVu8aacs9NBBefD/Y4eyHfkd0yjSe6cQxP8NmfPSm7XnQarMt48Mn6ruDR4BR6+8/2aHppuivBoyIdOcyXSgDzBBMbDlHzXITFhQHzMDr/77tBzJukGB2UZ2OVlQaP0PXCc7I+W5TDLhpuwfYb3R0vIsgS2jG+fyDIoy3LXuJ8gFZ/Iv5BeW1zaqVruVu0A8PC0u0Nsq4IHoxDnciHDRNAO2ADQOK8LrnFJ/rIRSjrqbz0GG5ofFZ9HVfTOsvO5XCjikYTPz4Kv+zgoJeGzvgGN3L/uFpr9TTTOcen2SGtjVUnIiIzTDgmYOs2BGx+UkqurZNGE2Mck/ivllaCgpUBr3SjadLiOxESOjtw7n2P6/k7NiRAPT3V6mMVJH+PQ9MWElTwYXjbD7reyOeoJu2zXGCwwtZj11sK2xXDZ0zKeEacJ2MVIHXq5yLDgUyy6uR5yQYw9UmmiFNIjEdlwFPdzs3y5MRsmV1uU2hPR16b4+kWdjFyDQpgY/K6zoL86BI025xYkYkbP/xQhLugFGNuU3HOpF1CSKDfjSYN2HTFOUY9fuiWmdDyNty/w+p4TCA4cYBuvx8N2HRBIWJNMny+0RymkKOuyl0iJu0aOlcEK9tlFKymVFE/oS/fWCXx5zwkU5e8+YCJHLuTNtKoytZDulsN23yeAPLxr3sPst1zzNbPi4X7LNYpY9a/RFotCoN6WtFfI7L5DQzij95uSAH6RMMDTFCuL2cYDPnLRvOaZUDCtrVVy9xPeh3p48t3A7g+QMRH8YVLu4/anSdqnOUqf+dyV4yidNB+abANa2y8aS5iqKJMulDzN2JilLvke88cscUegsV+qrGHjG5YqaWlifMNCPpGWHr4zlL6/YSbNseT0K6JGCX9KuLOE+ayZYQlzUS9l/4l5bMzU9B2mdFqlCR0r0NAebt34JkIZq4WcsyREV2zMfHacJQyXvKwImG3k+qtsxlbxwLu2ake6rYz70SbTaZ+1asUn7fa6t8MqYZTp/sSdKHHpaSvxXL1SNGjxNW9Mb0NvtthmnYXW0M1IwyrIeGPoAtTGOxgpL9K6oMgOl5XQTRtmuvCupx8tou1JLaKjp6tO6B1KXGvesIQJi2V/fIcSaPXxkktREWdcHuxj175TOEX8IgxQlcfJiZcfjcU7hTBFJ6MqV/Kj14+On4yOR09Gx7RDyLV/Oh/97G0M1hXjJcU0mEWnc9CltxNwGeDhfcoZ4R3ZfI73K+P5rvJRr8JhclUXGdUwkOuhq+J8eq1uTb9bozG8R5tXCVveT8zSl/l8bQo+L3Bmoa4q1JAqLVE/7md0Hgxxxycnq4Q195PX/E+S95yEt7ifup9cUa8reP4ZuD55sUpYfj+u/2jLjn8isifPVp113XAerqYqa67iu7W6DzAaCoKbqSJDTQ7J7feqe2rohTEos6vNd36qVIFcbnlohOmq4LGpgMJUioFDSnORI/m0XfTqdu/8yBAxe2yHcO6quP2MlTDkFeoaJ2wIp7OeV+oC3zUUerCuliwVPHLnXZnaPeOPDsM38ehRv4TvCv9tKjei4IDBYlkVrja+EEVBeJNdH0L7z3l+LScJgWgu48H3m4pXPjPmDgyL1gvLEHzHIbziEoRMizo46TMVU2dwc9OqgdOO1QpubkiqqK/I6K5WSTdAZ60NOLvqRzSmKK7XVrVD2C1sx3pLvYtzRS6OHwgFjD4CYi6FnF/VulithrfUsJPRB/PtFpuC7GiT/wOOETqn8kxnqLfe3FvKKalz4ez8zd3QLnN0z1Pj36IuQAknUFuKksZ7S8dHR/TfuuTalqSwKWWCUzRmVhdF8xlLPjw6uttV88Pbn7+7fK/8nTj+dZleH78hDtf6o33faCpqXQysGpAIB5F13hPucVbIQki8imy7Oj46uhoRb1cJO9nGvreqRJuTDi+IiQut5DyBirouEKxugM+5kEAPl/4duYlaK323Jfk4zO5iwskaE57eZsKpdDlo19V2rt6j/GMp7R9v/fGE6rJ0uuKjHCY8kJtna8T2xz2RBtNaC9uw8cUNWw54JQZ+fnxxubpMGDFWUWahUsZhzG3OxuzwVqLBoL52geLFjVfdVhsNlxnliW85L7wSh9cjtko2V2x1dXZCG8vnQs4Hd6667Eh9S+LwHF8juIvMKvENUmgW+NmHSpggNciR08tHHCQp/9BlWb6Ksor5j20pjU4mm0mKTWuzJe0Qsw5riYTteYTR014EfxGDcRdft+H1toi5JT3GwG0I3Itqe0HtRaezbfwYw8eRi7uOT05cgPJ85Dz5Jy+ck3zybOW0rHMYGVt3Cl1abNO1YWzdZMdFrUEKqzqb4+0KCW+mnKQD+88qlG/FXLoLdT26HVFgkSqfayEzHsH/869/uxVRbO6+fwZntYZKLVDPat/vOCtwKahjr9cEG/1V5GWBxhQNCGlx7tphMzF3ZcdgfKkMyaeiEPRCEJjy+ZveI2OG8FPn8T7SvgJ7jQU9LFAo9d71KirgtVWlOyNawYXS72eEUgIcptTUiMaAQYxLUOZcpuQ0+4uTgNLAJaC0qCstDAIXJQG7zrrZTKTCmVclreaphZJLPkc6LHGRDXGhii2JWk2ptmNUUfuMMTVGIlpPokv+DuE1dZk6wl3eCi0XBWYwr2mLBOhGQVBcIkNmMCVXrKLjRYqm67Uo8Bq1eyi8Q1YXBVSKnm3BC3Lt+7Kljazm0pC1DTmzIJqWfZVW5Dy4MzLeDIGKRWSJyFknBSiEfO/7cy9aNfsJp0ZY7KK6xWJx69F6vL7ma2HzegoaK9Wtm7tB98T1l7cfj+lFQF2as9lb1Ncijf7BjjMPHfBhMGbcBxDxheCV+GJzARmWQqQoDfZMz8uv33wL1/BkeMSS3jP9AQgffnv66qvv335F+5Ih8fdvNDwaHrlUlDK25LJ31Eaf+ebV7eW6923p+7b0fVv6vi1935b+8Mqb+7b0fVv6vi1935a+b0vft6Xv29L3ben7tvR9W/q+LX2LUu/b0vdt6fu29H1bOuzb0vdt6X++bO9rSw/lQPKTDquCC9lrafA15IvNZvXLhOVUZB5fsJsbylD/SK0nNPxLjZoq1JcJu+ZaULLR1aeTWIelAuR7pErgK5/0H5zT+YnXNVfB2CjLUxnZr3jphHMnbL8O/ubs7TlLWOwVKlVGazRfULM9X7Ax+aTMNeY7zroeaO6aFwsu57WriTK/L5WPeW3z9drze1d7Dj96pVUumx6W60VpTwr9JcK2LvgrVTy+weZvLbif2bkg8DZCkwgvV6vVfwHlJKDd",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Document"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,a.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(l.Z,{children:[(0,a.jsxs)(p.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Document created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.2b8fccd7.js b/assets/js/5a2de241.2b8fccd7.js deleted file mode 100644 index a339e65df..000000000 --- a/assets/js/5a2de241.2b8fccd7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>v});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),u=s(85162);const h={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:"eJzFV+9u2zYQf5Urv6wFFNtJ0xYThmFdW7RBiyVoUhRYYgQn6WyzoUiWpOwYhr7tSfZoe5LhKMmWnTRthm77EjjU/fvdHe93XImAUy/Sc3FGpVUYyItxIgryuZM2SKNFKs5mBB9sgYGgk4LnJ0dAGjNFHpamgmCgNIWcLAF1AVUjHWYEBQWUyoOZAIK3lMuJzCG0dgYiEcaSQ3Z1VIhUNKqdH5EIiw5LCuQ4zJXQWJJIRWfgUhYiEZLDtBhmYjf2o5fsmQPpNCDMMIAmKjxHnVEbLdtx9LmSjgqRBldRInxYKvbmZWkVB0PXVpmCRDpB5Vkgn1GJIl2JsLRRMjippyIRE+NKDJuTuh439smHX02xZJ3tUE+cmcuCICNlFrCGzUF2+exqBA8xgCL0AYymnmwH4JFIRG50IB3YEVqrZB6TPPzk2dvqZugm+0R54Iw7LkmQ5Plrk/CvA+TkYExTKnz8sY5X1InQJtzbzAlDJHA0l7SIjeXlVEOYSQ+FyauS4dU7Jb+fi3VX9G3UrKMKctyRN+1ttFmyuQXHZyc90cwYRaj7srFh6joRQYYtz5e9Vr7MuDPqmuUceWu0b4pwMBrdbJj1ZWwbGHyV5+T9pFJq+eD7dUBz/LVcoC8O3viTwzeWs9KG9DzcrXQwOni8tz/aGz0723+aHv6YPnk6GI1Gv4tEXJdq036iaNuoy17zf+9AaiU1XXZZuzwYjS4ft6k8vC17bXPZ9tbNUckCJpJUAezTf8cEknPG/cPmvyO+u+Az5A784R2to02Aial08X/DvS2iuwEeXj5bQ3xyE+KRblLGTHVmrkj/Fwg3ePruQ+OeQ93uatkIxe9iC2z/vAHpKa+cDMvIgtd7aOVe8z09HzO3lBRmhhnUVjFgZsNUDLvpMlz15kwt2J6bd6RaOSVSMQvB+nQ49KiLzFwPjCXNA1dh5ge5KYdo5XC+L+pkVwOtvYe0DziVerp3p9Z4g/iUq9Ikfgv3Ov1o5VtaiqRLa1+qXQ5mhAW5WAIu9vsNEb/qSrauyi57deT1bXy0u4HcyjB9ghFii0QaouCwJyZibHvi2JI+ZXfcUfP9G34+kspNSbwu8LrTif/1x59Ro4svNvwDOK4cWLMgN6lURDJRdC0z1Wx2qJRZrBc7T1gq8l4tQepAUxfRyKkMqGIGpJ5CjhYzqSRfERYzrO2gd8v8AD7OKMzI8acfHAFCQXNSfLNAGXPFdoIBrIIpo482ZlgYdzXhkBJAyCovNXkPnqhTIT1DnRN0LZOAcYAaSAdy1klPgLJk4YlxQJOJzCUb5nngMA9QosYpsbMEOG7OQjt6PTiTVT6AN6qKQOK2SxQaiHGVHMBLOacGOB82ay8VMK3YRAK5KQja8cAwdAEZ+QCW3cucolEf0PFiNycXr0isJNM5WMNzS6LidbZfWzYUHGrPw7UJqCvNOn3WGd4Loo8ClwO40Bf6lJul8sQNoKS+8umF3oPzdZt9pMzLQOOH3bVdLBY3ruujbZ3XMsyqDBxZs9GbxsN4ufvq6394Vw3kSn88OSU3lzm1s+ILPodReNhOc8zjNKcSpWpGwS+7CjxZlcxJ+/4tf/765B3M4fFgJJLegPqGgIfvjl68+u30FdvlEdrcv/3BaDDiI2t8KFH3XO08nnav7mpDS//2W6sdmIGuw9AqlJF1IvhVyxjnojf30v4za5yImfGBRVarDD19cKqu+fhzRY55aZyIOTrJkUZaKaTn38X6ufRF2A/fdw8XuN+L7VZAHS1o5oQ5qoqaKXtFy52nYz2uk44bOOJG4kUT194Z29lYuLExMLU1Gs/znGy4U7ZP0ScfzkQisvYZWMYXpXC44CcoLkQqLsSFiE/jOG9YKJ6vhEI9rXDK8o1ZZjSsuHJ9OryKdNj+YGC3pmSbJxsk/Jdx3arwE7fiW1r+vBZvvnxRoU1tJ83lGdd1/Tf6s7z3",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/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/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJzFV+9u2zYQf5Urv6wFFNtJ0xYThmFdW7RBiyVoUhRYYgQn6WyzoUiWpOwYhr7tSfZoe5LhKMmWnTRthm77EjjU/fvdHe93XImAUy/Sc3FGpVUYyItxIgryuZM2SKNFKs5mBB9sgYGgk4LnJ0dAGjNFHpamgmCgNIWcLAF1AVUjHWYEBQWUyoOZAIK3lMuJzCG0dgYiEcaSQ3Z1VIhUNKqdH5EIiw5LCuQ4zJXQWJJIRWfgUhYiEZLDtBhmYjf2o5fsmQPpNCDMMIAmKjxHnVEbLdtx9LmSjgqRBldRInxYKvbmZWkVB0PXVpmCRDpB5Vkgn1GJIl2JsLRRMjippyIRE+NKDJuTuh439smHX02xZJ3tUE+cmcuCICNlFrCGzUF2+exqBA8xgCL0AYymnmwH4JFIRG50IB3YEVqrZB6TPPzk2dvqZugm+0R54Iw7LkmQ5Plrk/CvA+TkYExTKnz8sY5X1InQJtzbzAlDJHA0l7SIjeXlVEOYSQ+FyauS4dU7Jb+fi3VX9G3UrKMKctyRN+1ttFmyuQXHZyc90cwYRaj7srFh6joRQYYtz5e9Vr7MuDPqmuUceWu0b4pwMBrdbJj1ZWwbGHyV5+T9pFJq+eD7dUBz/LVcoC8O3viTwzeWs9KG9DzcrXQwOni8tz/aGz0723+aHv6YPnk6GI1Gv4tEXJdq036iaNuoy17zf+9AaiU1XXZZuzwYjS4ft6k8vC17bXPZ9tbNUckCJpJUAezTf8cEknPG/cPmvyO+u+Az5A784R2to02Aial08X/DvS2iuwEeXj5bQ3xyE+KRblLGTHVmrkj/Fwg3ePruQ+OeQ93uatkIxe9iC2z/vAHpKa+cDMvIgtd7aOVe8z09HzO3lBRmhhnUVjFgZsNUDLvpMlz15kwt2J6bd6RaOSVSMQvB+nQ49KiLzFwPjCXNA1dh5ge5KYdo5XC+L+pkVwOtvYe0DziVerp3p9Z4g/iUq9Ikfgv3Ov1o5VtaiqRLa1+qXQ5mhAW5WAIu9vsNEb/qSrauyi57deT1bXy0u4HcyjB9ghFii0QaouCwJyZibHvi2JI+ZXfcUfP9G34+kspNSbwu8LrTif/1x59Ro4svNvwDOK4cWLMgN6lURDJRdC0z1Wx2qJRZrBc7T1gq8l4tQepAUxfRyKkMqGIGpJ5CjhYzqSRfERYzrO2gd8v8AD7OKMzI8acfHAFCQXNSfLNAGXPFdoIBrIIpo482ZlgYdzXhkBJAyCovNXkPnqhTIT1DnRN0LZOAcYAaSAdy1klPgLJk4YlxQJOJzCUb5nngMA9QosYpsbMEOG7OQjt6PTiTVT6AN6qKQOK2SxQaiHGVHMBLOacGOB82ay8VMK3YRAK5KQja8cAwdAEZ+QCW3cucolEf0PFiNycXr0isJNM5WMNzS6LidbZfWzYUHGrPw7UJqCvNOn3WGd4Loo8ClwO40Bf6lJul8sQNoKS+8umF3oPzdZt9pMzLQOOH3bVdLBY3ruujbZ3XMsyqDBxZs9GbxsN4ufvq6394Vw3kSn88OSU3lzm1s+ILPodReNhOc8zjNKcSpWpGwS+7CjxZlcxJ+/4tf/765B3M4fFgJJLegPqGgIfvjl68+u30FdvlEdrcv/3BaDDiI2t8KFH3XO08nnav7mpDS//2W6sdmIGuw9AqlJF1IvhVyxjnojf30v4za5yImfGBRVarDD19cKqu+fhzRY55aZyIOTrJkUZaKaTn38X6ufRF2A/fdw8XuN+L7VZAHS1o5oQ5qoqaKXtFy52nYz2uk44bOOJG4kUT194Z29lYuLExMLU1Gs/znGy4U7ZP0ScfzkQisvYZWMYXpXC44CcoLkQqLsSFiE/jOG9YKJ6vhEI9rXDK8o1ZZjSsuHJ9OryKdNj+YGC3pmSbJxsk/Jdx3arwE7fiW1r+vBZvvnxRoU1tJ83lGdd1/Tf6s7z3",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},v=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{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,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.34493030.js b/assets/js/5a2de241.34493030.js new file mode 100644 index 000000000..421e91b2d --- /dev/null +++ b/assets/js/5a2de241.34493030.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),p=s(41429),m=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={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:"eJzFWOuO4zQUfpWD/7BI6WVmBxARQiywgtEiZsR0tRI71ciNTxozjm1sp52qyj+ehEfjSdCxkzadloFFC/ypUufcvnN3tizwpWf5WzbD2ioe0LN5xgT6wkkbpNEsZ7MK4bUVPCD0VPDi+hJQ84VCDxvTQDBQGyHLDXAtoEnUoUIQGLhUHkwJHLzFQpaygNDJGbOMGYuOk6pLwXKWWHs9LGOWO15jQEdmbpnmNbKc9QLupGAZk2Sm5aFij22//IY0kyE9B4SKB9CIwpPVC+ysJTkOf2mkQ8Hy4BrMmA8bRdq8rK0iY/DBKiOQ5SVXngiKCmvO8i0LGxspg5N6yTJWGlfzsD9p23mSjz58ZcSGeA5NvXZmJQXCApVZww42Gdn7s48RPOMBFHIfwGgc0PYAPmIZK4wOqAMp4tYqWUQnT372pG17bLpZ/IxFII87CkmQ6OltcvhfAyTn8OimnPn4sLOXtRnTJryzmGuCiOBwJXEdE8vLpYZQSQ/CFE1N8NpHIX83FbusGMpoiUcJdJSRx/L23ESZquBqdj0gXRijkOshbZcwhyGnLINRAmTiIaylUl1lwdXsGlboqGJi7Mbw2qPzicZhgXKFwA9IoDACYSU5YM2lymBdyaKiAthA3fgAqLuc6lyJO0+OIdoIIzg2SEh/0qIMuFJmLfUSmmjaKcEgpMMiqA2sZahME4ALIYmdK/ABrR/vHTkzjXv/nuSwbKRAAcE0DkrjopXofAY2lh0hkNoH1xTE7EE0FO2Ig0jp2TpToPd7P/VeIaKB/AxQ+8TOoeQ+oMug0ZI87xobUOxE4oNFJ1EXOGZtm7Egw0Fa3g363N2C2kbbEp1Db432qULPp9PjbrLr1F13A98UZH3ZKLX54P21h3T8V4XCvTj/zl9ffGcp0p1JL8LTTOfT8+ejs+lo+uns7JP84rP840/G0+n0J5axh1rtexMTXY/pvZf+Dw6kVlLjXe+1u/Pp9O5558qLU97rOo/tWvKKKymglKgEkE7/Hh2Izhn3DzvjE/Y9BZ8g9+AvnkgdbQKUptHi/4Z7yqKnAV7cfbqD+PExxEudXEZrzMzco/4vEO7xDNWHpJ5MPcxqmYjie3YAdnieQHosGifDJq5IDyNu5Si9z9/OafGoMVSG1ivbRINpVcrZpO8uk+2gz7SM5LlVv3E1TrGcVSFYn08mnmuxMA9jY1FTF1N84ceFqSfcysnqjLXZYw5u7TtQ+8CXUi9HT3LN94hvKCrJ8Qe4d+7nVr7CDct6tw6pus2xQi7QxRBQsH/cb2kv+5DtovJ4tek3m7+3rByNrVPrx3D7YOxgw+hm33BUxqOWkJQmwu7S5MqiviELKMlWZ0eq36AqTI00sWl+9eS///pb5OhNjjXwAVw1DqxZoysbFcGVCh8kDT8ijkvA7iLgkdcKvVcboJm3dBGgXMpA876bfAW3fCGVpKohMkPcDgaF58fwpsJQoaNXHzqa4gJXqKjYQBlzHwe0Ad4EU0cd/cKxNu6+JJMy4LBovNToPXjEngV1xXWB0GdRBsYB12k7sk56BC5rIqZdActSFpIEU4twvAhQc82XSMoyILvJC1039uDMglYtb1STlgm6HSGGBDFePcbwDS1vETgdpmsSirRH+CztcV3HIBhawAJ9AEvqZYFp1Qrc0UVghS5WTYwkTXiwhlqZ5IquP8PYkqDguPbUb5NBfWh27usWnahD8M0YbvWtvqFkaTxSAiip731+q0fwdpdmb3DhZcD5s76S1+v1UQV/dMjzrQxVswCH1uz5lvEw1vuQffeH7jYBXe2vyht0K1lg1z7+ROckEk+6Bs+L2ODjdpy6w5ePGajZKlmg9sPCf/Ht9fewgufjKcsGPetvGDz5/vLrlz/cvCS51FVT/Z2Np+MpHVnjQ831QNWjy/bj0t3uJ9W/fTfvemjAhzCxiss4iCL4bTdE3rJBK8yH1/J5xirjA5Fstwvu8bVTbUvHvzToaFTNM7biTpKlcdJ0+7Q4veMPYT/7sb/owrvd8E8C6ieFpjGx4qrB1HjvcfPoU0M7b7N+XJDFieLrZNdoRnL2Eo6WCJp2ieNFUaANT9IOp/b16xnL2KL7bFDHLxDM8TV9suBrlrNbdsvip5TYb4gonm+Z4nrZ8CXRJ7E05HhDkRtOyPs4IbsHAnbSJYejMyGhX8J1kuFzSsVXuPliR57e/ClD59qemsIzb9v2D41miGg=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/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/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJzFWOuO4zQUfpWD/7BI6WVmBxARQiywgtEiZsR0tRI71ciNTxozjm1sp52qyj+ehEfjSdCxkzadloFFC/ypUufcvnN3tizwpWf5WzbD2ioe0LN5xgT6wkkbpNEsZ7MK4bUVPCD0VPDi+hJQ84VCDxvTQDBQGyHLDXAtoEnUoUIQGLhUHkwJHLzFQpaygNDJGbOMGYuOk6pLwXKWWHs9LGOWO15jQEdmbpnmNbKc9QLupGAZk2Sm5aFij22//IY0kyE9B4SKB9CIwpPVC+ysJTkOf2mkQ8Hy4BrMmA8bRdq8rK0iY/DBKiOQ5SVXngiKCmvO8i0LGxspg5N6yTJWGlfzsD9p23mSjz58ZcSGeA5NvXZmJQXCApVZww42Gdn7s48RPOMBFHIfwGgc0PYAPmIZK4wOqAMp4tYqWUQnT372pG17bLpZ/IxFII87CkmQ6OltcvhfAyTn8OimnPn4sLOXtRnTJryzmGuCiOBwJXEdE8vLpYZQSQ/CFE1N8NpHIX83FbusGMpoiUcJdJSRx/L23ESZquBqdj0gXRijkOshbZcwhyGnLINRAmTiIaylUl1lwdXsGlboqGJi7Mbw2qPzicZhgXKFwA9IoDACYSU5YM2lymBdyaKiAthA3fgAqLuc6lyJO0+OIdoIIzg2SEh/0qIMuFJmLfUSmmjaKcEgpMMiqA2sZahME4ALIYmdK/ABrR/vHTkzjXv/nuSwbKRAAcE0DkrjopXofAY2lh0hkNoH1xTE7EE0FO2Ig0jp2TpToPd7P/VeIaKB/AxQ+8TOoeQ+oMug0ZI87xobUOxE4oNFJ1EXOGZtm7Egw0Fa3g363N2C2kbbEp1Db432qULPp9PjbrLr1F13A98UZH3ZKLX54P21h3T8V4XCvTj/zl9ffGcp0p1JL8LTTOfT8+ejs+lo+uns7JP84rP840/G0+n0J5axh1rtexMTXY/pvZf+Dw6kVlLjXe+1u/Pp9O5558qLU97rOo/tWvKKKymglKgEkE7/Hh2Izhn3DzvjE/Y9BZ8g9+AvnkgdbQKUptHi/4Z7yqKnAV7cfbqD+PExxEudXEZrzMzco/4vEO7xDNWHpJ5MPcxqmYjie3YAdnieQHosGifDJq5IDyNu5Si9z9/OafGoMVSG1ivbRINpVcrZpO8uk+2gz7SM5LlVv3E1TrGcVSFYn08mnmuxMA9jY1FTF1N84ceFqSfcysnqjLXZYw5u7TtQ+8CXUi9HT3LN94hvKCrJ8Qe4d+7nVr7CDct6tw6pus2xQi7QxRBQsH/cb2kv+5DtovJ4tek3m7+3rByNrVPrx3D7YOxgw+hm33BUxqOWkJQmwu7S5MqiviELKMlWZ0eq36AqTI00sWl+9eS///pb5OhNjjXwAVw1DqxZoysbFcGVCh8kDT8ijkvA7iLgkdcKvVcboJm3dBGgXMpA876bfAW3fCGVpKohMkPcDgaF58fwpsJQoaNXHzqa4gJXqKjYQBlzHwe0Ad4EU0cd/cKxNu6+JJMy4LBovNToPXjEngV1xXWB0GdRBsYB12k7sk56BC5rIqZdActSFpIEU4twvAhQc82XSMoyILvJC1039uDMglYtb1STlgm6HSGGBDFePcbwDS1vETgdpmsSirRH+CztcV3HIBhawAJ9AEvqZYFp1Qrc0UVghS5WTYwkTXiwhlqZ5IquP8PYkqDguPbUb5NBfWh27usWnahD8M0YbvWtvqFkaTxSAiip731+q0fwdpdmb3DhZcD5s76S1+v1UQV/dMjzrQxVswCH1uz5lvEw1vuQffeH7jYBXe2vyht0K1lg1z7+ROckEk+6Bs+L2ODjdpy6w5ePGajZKlmg9sPCf/Ht9fewgufjKcsGPetvGDz5/vLrlz/cvCS51FVT/Z2Np+MpHVnjQ831QNWjy/bj0t3uJ9W/fTfvemjAhzCxiss4iCL4bTdE3rJBK8yH1/J5xirjA5Fstwvu8bVTbUvHvzToaFTNM7biTpKlcdJ0+7Q4veMPYT/7sb/owrvd8E8C6ieFpjGx4qrB1HjvcfPoU0M7b7N+XJDFieLrZNdoRnL2Eo6WCJp2ieNFUaANT9IOp/b16xnL2KL7bFDHLxDM8TV9suBrlrNbdsvip5TYb4gonm+Z4nrZ8CXRJ7E05HhDkRtOyPs4IbsHAnbSJYejMyGhX8J1kuFzSsVXuPliR57e/ClD59qemsIzb9v2D41miGg=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},b=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(p.Z,{className:"paramsItem",param:{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,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.52af9f43.js b/assets/js/bbdfc22d.52af9f43.js deleted file mode 100644 index e1ef00dbd..000000000 --- a/assets/js/bbdfc22d.52af9f43.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var a=s(85893),r=s(11151),i=s(58219),l=(s(62316),s(51039)),t=s.n(l),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UHGg2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3N2hmVVcIuGXSQsQ5NqUVmhJBuxsxwhTsMrjZzG4cWbE+BFoeYGaoPagFWQ0iRCWhurSvErnxQINiJOYJ6LNAeD+hqBG5gUNVZaSGtgqjTMUKLmVsgZZCqtS6SJubA5VBoznAqJGRir69TWGs0A3lVKgqnTFI2Z1kWzkydDKJmAzdERqtHWWhrgUEvxoUbo9SL0pch6PbA5t5ByCRMkdjLiJhCEHXImnOaUdIhNhamYCgIOuAZjOZbvqkLxDJaqhiqbgpCgag3nvd5rnNQzeHfS6118lVtbmdHBAa+qgapQGjGTBZ+YQarKg4wAq2z6CHLU6DARaZnmc5iLbIbWAJcZpKpaQqr6SotMcosJVHyGIOtyghrUlKgsB8ALoxokbg2x8fSYIN68/ocjutd7iYXqoNcIpq4qpS1mxAMxHOUw6vVozStVlkpCxTUv0ZIJqGlEMCKAPol5WeGo14MTmYmUzMBhotEWeuBBiXgCfRvk6kHXWJLBhoibOZeW1FQVPEUHqpFUYsU1riNeJLAkxK9RqkhBrrT4VUnLCyfKa9RWpLyAVCmdCeko9RIEY7l2ZlkpIW0cDTvAP4Nga+OJyIKWibSMxFIK6WYMwjUvajSBqnkCOVH1E1YajTOvgNfmjqYcxSzfuR/P3tfGriGG2hCZXSrCXho/1EJj5sSLTmxTXhgEMV2TZcmvsLMbKOcDeDGAl0vIcMrrwiYg7JcGrK5xAD8qC7yqCpG6w07nmEyZ0xHtOy0HgwiESF46Hb/R6lpkSCcyE9MpapQWaNKhiFYYqCNjrNwCYq9UmmjkEpTsKHo4gF6v2duZ6C+//DKWN2MJMGZEy5iNxqwBGbME/ByZ2JiNhgmEgcWYjeDx0bMIsKTvp0fP4/ecvofD4/id0/fRcCxXYdMjR4zlZXUHITT9+xMRP73qDA26nWksmgENkv48LM2Q6Gm0IYsmVi1Dj4khIYUVvDC7eYoQD4+tlrINzo6JMyy5KHaz5aYfHk+BrA2Gngzac7aDH4/iobHjf21w85S4ea8mYIUt7mCpAXl4fHVI22DuGTGXqrLicrmbtQDw8BhrCNtg6zmxlXF7h7po9uExFKiKE+HC83OHx/3hk/7R4dFxB2KqdMkDQFn2s6y/XC6XYwatRMDxT3dfQEfXX7z//F1NMeZUq3JLcONijxYqxALudwwIfqAwYBJvyDZaa8NTT+X6HW5VxpdfGo8qLg2XtIdvQ7Flh0w3RXQsKapNcyXSQDzBBMHDhILJAQmhT3LMDn744cBLJmkH+2UZxOV1QaP03XeS7I6W5SDLBpuwXYF3R0vIsgS2jG+fyDIoy3LXuJ8gEx/Lvwzcu2FhJ2qx27QDwMOz7pawrQYeLoU4lwsZJoJ1wAaAxlldcI0LCl+NUNJxf8sZbFh+NHweTdHHri7scy8DTyR8dRpCz0fBKImedQQ0cv+6W2R2kWic4cLh8G9WIkZk4fFo6jSnd6p75VLkqWSxDE8Rk/ivlFeC3hAFWutG0aaDdSLGcnjo/HyO6dWdlhMhHp7pdCiLk/7JQdPnY1bycPGyKba/lc1Rj9lFs8ZgganFrLMWti2Gi46V8YwkTcDuydKSl4sMCz7Bop3rEBfU2GGVJkohPRFRDIcRn5vli43ZMLnaYtSeia41Re8XbTJKDQph4lt0XQTd1eEN5zIREn0KYoIQF8Ck8d7bjNxLqfO+I1VuPu8M2nXCuIG4dMsTz8k0nr4g63t2IDhwgM3zOW62a4PAwppmunIhHKWQoqzLTmojYo0SK8Mt2BUXraTcVNyhq91bO/DFPTuE7NCODcZy6F6gmVZVpubSnXLYHvsEkId3zDuU/ZZjvnateLjfcowiVd1jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Eenn43qPsDdEwMf5yWu7T9WZoey6FPdJQ+Fbkry1E6fT407QaytqshXHGSJUxVLs+u5EnGRszn7GMGmyVuKzT2pcqWbHTDUiUtSks/Q6KPlh68N1QbuGEmzbHk9CuSSNWEqSgIFeXaUBuWMPf+pdICCZGNmJq8x9SyhILLinKvaAiHWze6iVDGaiFnLAnvLDZiPnPNEoYLXlYEHIYAZaro9eNQrOKOd+FqRlpcxv1o8vmEh1LGn4nGLV1tlFM+C1MXw6qVa4uMa82XbLNyE3PFMYL365qsbrGM17ewFArE8MKDsYQJi2V3lx1a0+rTJZ2iIk5cCutT1zq18PKT96R1Va7kZy0MOektMv9IKfnZ2xuvq+wFPTYwi9Fgv02nJ+BSs4P7LCbCO275rLunD25u7Xm2q8zSqQSYXNVFRrl+5Hrgqh2fX9aiUiEv0tpV6xpvvsZZQ2rD2XCVsMX9zCx8RczXcOCrAqcW6qpCDanSEvWjbqrlwTB3dHy8StjyfvaW/5PsPSPlze/n7mdX/GoLg38GrY+frxKW30/rt0157k8k9vjpqr3rNu7yy4nKlpfRb63uA4yXCsEZlNmJPNUZ6o4gJkoVyGV3f4pFyI1LKv+dnr25G9q99+6hwxPaBhNhB6rtKmm8Kz06PKR/G15srfxPvQJNa0Cx/IIlHx/J3O3H/TDFTrd9eeuGX+ZH35pKlmlOfrhEY9Zd8ZYl9zDQlZuQhZB4GYVyeXR4ePmEJLdK2PE24bxVJdqcklhzqrTOtZKzBKoCOZWt9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9LlhVxHyJm6QvnHctrd3vrtidRF6QIgH9Aw4YHcPFtjtjvumTSY1lrYJRud37BFn1ei7+dH5xerC7I6myuK8StlHMXc5mzEDm6F/K4lh+LJ8xtW64KNWPRZhsuMcje3/BavxMH1kK2SzRVbvdxOaGP5TMhZ/85VFy2rb0kdXuJrDLdBWSW+Q4rKgjy7UAkTZAY5cvJrJEHS8k/te+frqKv4Etn6uGiVsvlciK+FtQfA5r2xJaTvRPTnMZx2EXITILOWI9YEsfSzCUvPW9NrIsAYAA5d5HR0fOxCjGdDdxc/fu6uueOnqwsv4Y7Ld0/Mrlf3npsEOFVO2kECpxXKt2Lm28Guh7cvdCxSVaJLF+YIEfw///q3WxE7ityZ+wJOaw2VmqOmdi5qgZkWuBDUWNLpNqP3istl8rJAY+gRIy3OfKeWmLl0PImAXErKKz4RhaBTSmDKl606B90M4OccKbtBU19qX5m4xoIONxRKXbmWGgW8tqrsdoPBXOmrKZGUAIcJ9d6gMWAQ4xKUOZcpJSW88SagNHAJKC3qSguDwEVJwJQEwelUpIIQk0vSPLVQcslnSJslLrAgKVSxc0arCeU8jSpqn0mh/h1E61l0SZEBvKZmKMc4DWZouSgwg1lNKBIgq4bgoYgNmcEEjYWKthcpmrYGWeA1andYnSbpUoJKkesUvKAoqKtbQmQ1l4ZCF09QVE0jvkorut3cHhlfDoDyL3QbUBxFBlAIeUWNZH04b8zsZ5wYYbENqubz+S3H8Wh9zTfC5vUENFaqXTdzg87NdJc3H4/omKMuzen0LeprkWLwWjv2PHDAB+FC4am7UOLh5ZX4++YCcu6FSFEa7Lj/F9+8+R6u4fHgkCUdV/kRBB98f/Lq6x/ffk14yZn78zccHA4O3UtQGVty2dnqlW/WPGud10aeorkZ9x2g+w7QfQfovgN03wG67wDdd4A+JJ72HaD7DtB9B+jv2QGx7wDdd4CO9x2gsO8A3XeA7jtA9x2g+w7QfQfovgN03wG67wD9P+oADYVCipgOqoILV2l21YabUCQ+3+wLvUhYTlXk0Tm7uaHs8TtdrFY0/KFGTSXoi4Rdcy0oC+gK0EkstFJp8gqXVHLwFYX+Ge2feKtz5ZGNujvVif2KF05Nd8J2C91vTt+esYRNQu9qqTJao/mc+lr5nI0oOmWuB9ZJ2HUvcteYVHA5q121lHm8VB/mtc3Xi8tXrrgcfnSKrlwuO1SuV509K/SXGNu64K9Uo/gOl39rwP3MzgVBthGaVHixWq3+Czi1HRI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UHGg2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3N2hmVVcIuGXSQsQ5NqUVmhJBuxsxwhTsMrjZzG4cWbE+BFoeYGaoPagFWQ0iRCWhurSvErnxQINiJOYJ6LNAeD+hqBG5gUNVZaSGtgqjTMUKLmVsgZZCqtS6SJubA5VBoznAqJGRir69TWGs0A3lVKgqnTFI2Z1kWzkydDKJmAzdERqtHWWhrgUEvxoUbo9SL0pch6PbA5t5ByCRMkdjLiJhCEHXImnOaUdIhNhamYCgIOuAZjOZbvqkLxDJaqhiqbgpCgag3nvd5rnNQzeHfS6118lVtbmdHBAa+qgapQGjGTBZ+YQarKg4wAq2z6CHLU6DARaZnmc5iLbIbWAJcZpKpaQqr6SotMcosJVHyGIOtyghrUlKgsB8ALoxokbg2x8fSYIN68/ocjutd7iYXqoNcIpq4qpS1mxAMxHOUw6vVozStVlkpCxTUv0ZIJqGlEMCKAPol5WeGo14MTmYmUzMBhotEWeuBBiXgCfRvk6kHXWJLBhoibOZeW1FQVPEUHqpFUYsU1riNeJLAkxK9RqkhBrrT4VUnLCyfKa9RWpLyAVCmdCeko9RIEY7l2ZlkpIW0cDTvAP4Nga+OJyIKWibSMxFIK6WYMwjUvajSBqnkCOVH1E1YajTOvgNfmjqYcxSzfuR/P3tfGriGG2hCZXSrCXho/1EJj5sSLTmxTXhgEMV2TZcmvsLMbKOcDeDGAl0vIcMrrwiYg7JcGrK5xAD8qC7yqCpG6w07nmEyZ0xHtOy0HgwiESF46Hb/R6lpkSCcyE9MpapQWaNKhiFYYqCNjrNwCYq9UmmjkEpTsKHo4gF6v2duZ6C+//DKWN2MJMGZEy5iNxqwBGbME/ByZ2JiNhgmEgcWYjeDx0bMIsKTvp0fP4/ecvofD4/id0/fRcCxXYdMjR4zlZXUHITT9+xMRP73qDA26nWksmgENkv48LM2Q6Gm0IYsmVi1Dj4khIYUVvDC7eYoQD4+tlrINzo6JMyy5KHaz5aYfHk+BrA2Gngzac7aDH4/iobHjf21w85S4ea8mYIUt7mCpAXl4fHVI22DuGTGXqrLicrmbtQDw8BhrCNtg6zmxlXF7h7po9uExFKiKE+HC83OHx/3hk/7R4dFxB2KqdMkDQFn2s6y/XC6XYwatRMDxT3dfQEfXX7z//F1NMeZUq3JLcONijxYqxALudwwIfqAwYBJvyDZaa8NTT+X6HW5VxpdfGo8qLg2XtIdvQ7Flh0w3RXQsKapNcyXSQDzBBMHDhILJAQmhT3LMDn744cBLJmkH+2UZxOV1QaP03XeS7I6W5SDLBpuwXYF3R0vIsgS2jG+fyDIoy3LXuJ8gEx/Lvwzcu2FhJ2qx27QDwMOz7pawrQYeLoU4lwsZJoJ1wAaAxlldcI0LCl+NUNJxf8sZbFh+NHweTdHHri7scy8DTyR8dRpCz0fBKImedQQ0cv+6W2R2kWic4cLh8G9WIkZk4fFo6jSnd6p75VLkqWSxDE8Rk/ivlFeC3hAFWutG0aaDdSLGcnjo/HyO6dWdlhMhHp7pdCiLk/7JQdPnY1bycPGyKba/lc1Rj9lFs8ZgganFrLMWti2Gi46V8YwkTcDuydKSl4sMCz7Bop3rEBfU2GGVJkohPRFRDIcRn5vli43ZMLnaYtSeia41Re8XbTJKDQph4lt0XQTd1eEN5zIREn0KYoIQF8Ck8d7bjNxLqfO+I1VuPu8M2nXCuIG4dMsTz8k0nr4g63t2IDhwgM3zOW62a4PAwppmunIhHKWQoqzLTmojYo0SK8Mt2BUXraTcVNyhq91bO/DFPTuE7NCODcZy6F6gmVZVpubSnXLYHvsEkId3zDuU/ZZjvnateLjfcowiVd1jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Eenn43qPsDdEwMf5yWu7T9WZoey6FPdJQ+Fbkry1E6fT407QaytqshXHGSJUxVLs+u5EnGRszn7GMGmyVuKzT2pcqWbHTDUiUtSks/Q6KPlh68N1QbuGEmzbHk9CuSSNWEqSgIFeXaUBuWMPf+pdICCZGNmJq8x9SyhILLinKvaAiHWze6iVDGaiFnLAnvLDZiPnPNEoYLXlYEHIYAZaro9eNQrOKOd+FqRlpcxv1o8vmEh1LGn4nGLV1tlFM+C1MXw6qVa4uMa82XbLNyE3PFMYL365qsbrGM17ewFArE8MKDsYQJi2V3lx1a0+rTJZ2iIk5cCutT1zq18PKT96R1Va7kZy0MOektMv9IKfnZ2xuvq+wFPTYwi9Fgv02nJ+BSs4P7LCbCO275rLunD25u7Xm2q8zSqQSYXNVFRrl+5Hrgqh2fX9aiUiEv0tpV6xpvvsZZQ2rD2XCVsMX9zCx8RczXcOCrAqcW6qpCDanSEvWjbqrlwTB3dHy8StjyfvaW/5PsPSPlze/n7mdX/GoLg38GrY+frxKW30/rt0157k8k9vjpqr3rNu7yy4nKlpfRb63uA4yXCsEZlNmJPNUZ6o4gJkoVyGV3f4pFyI1LKv+dnr25G9q99+6hwxPaBhNhB6rtKmm8Kz06PKR/G15srfxPvQJNa0Cx/IIlHx/J3O3H/TDFTrd9eeuGX+ZH35pKlmlOfrhEY9Zd8ZYl9zDQlZuQhZB4GYVyeXR4ePmEJLdK2PE24bxVJdqcklhzqrTOtZKzBKoCOZWt9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9LlhVxHyJm6QvnHctrd3vrtidRF6QIgH9Aw4YHcPFtjtjvumTSY1lrYJRud37BFn1ei7+dH5xerC7I6myuK8StlHMXc5mzEDm6F/K4lh+LJ8xtW64KNWPRZhsuMcje3/BavxMH1kK2SzRVbvdxOaGP5TMhZ/85VFy2rb0kdXuJrDLdBWSW+Q4rKgjy7UAkTZAY5cvJrJEHS8k/te+frqKv4Etn6uGiVsvlciK+FtQfA5r2xJaTvRPTnMZx2EXITILOWI9YEsfSzCUvPW9NrIsAYAA5d5HR0fOxCjGdDdxc/fu6uueOnqwsv4Y7Ld0/Mrlf3npsEOFVO2kECpxXKt2Lm28Guh7cvdCxSVaJLF+YIEfw///q3WxE7ityZ+wJOaw2VmqOmdi5qgZkWuBDUWNLpNqP3istl8rJAY+gRIy3OfKeWmLl0PImAXErKKz4RhaBTSmDKl606B90M4OccKbtBU19qX5m4xoIONxRKXbmWGgW8tqrsdoPBXOmrKZGUAIcJ9d6gMWAQ4xKUOZcpJSW88SagNHAJKC3qSguDwEVJwJQEwelUpIIQk0vSPLVQcslnSJslLrAgKVSxc0arCeU8jSpqn0mh/h1E61l0SZEBvKZmKMc4DWZouSgwg1lNKBIgq4bgoYgNmcEEjYWKthcpmrYGWeA1andYnSbpUoJKkesUvKAoqKtbQmQ1l4ZCF09QVE0jvkorut3cHhlfDoDyL3QbUBxFBlAIeUWNZH04b8zsZ5wYYbENqubz+S3H8Wh9zTfC5vUENFaqXTdzg87NdJc3H4/omKMuzen0LeprkWLwWjv2PHDAB+FC4am7UOLh5ZX4++YCcu6FSFEa7Lj/F9+8+R6u4fHgkCUdV/kRBB98f/Lq6x/ffk14yZn78zccHA4O3UtQGVty2dnqlW/WPGud10aeorkZ9x2g+w7QfQfovgN03wG67wDdd4A+JJ72HaD7DtB9B+jv2QGx7wDdd4CO9x2gsO8A3XeA7jtA9x2g+w7QfQfovgN03wG67wD9P+oADYVCipgOqoILV2l21YabUCQ+3+wLvUhYTlXk0Tm7uaHs8TtdrFY0/KFGTSXoi4Rdcy0oC+gK0EkstFJp8gqXVHLwFYX+Ge2feKtz5ZGNujvVif2KF05Nd8J2C91vTt+esYRNQu9qqTJao/mc+lr5nI0oOmWuB9ZJ2HUvcteYVHA5q121lHm8VB/mtc3Xi8tXrrgcfnSKrlwuO1SuV509K/SXGNu64K9Uo/gOl39rwP3MzgVBthGaVHixWq3+Czi1HRI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Template"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/createtemplate"}),"\n",(0,a.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,a.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.a84b1389.js b/assets/js/bbdfc22d.a84b1389.js new file mode 100644 index 000000000..d3e3fc486 --- /dev/null +++ b/assets/js/bbdfc22d.a84b1389.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var a=s(85893),i=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztGmtvGzfyr0z5pY2wki3HeZxwOFwevTbow0HjoDhYRkrtjrSMd8kNybW8NfTtfsn9tPslh+FjdyVLdpIWre+gL7aWHA5nhkPO85pZvjBscsZOsawKbtGw84RlaFItKiuUZBN2miPEaXihkdM4PHv9CnhRqKWB2qA2YBWkNImQ1saqUvzKZwWCjYgTWOYizcGgvkTgBmZFjZUW0hqYKw0LlKi5FXIBmUrrEmliKWwOlcYM50JiBsbqOrW1RjOCt5WSYOo0RWPmddHu5MkQSiZgc3SEarS1lgY41FJ8qBEGgwj9TmSDAdicW0i5hBkSOxlxEwjCHjkzTnNKOsSmwlTMBQEHXKOpnMq3VaF4Bo2qocrmICSoWsPZYPASZ/UC3r4aDM6/yq2tzOTggFfVSFUojVjIgs/MKFXlQUaAVTZ/ADlqdJiItEzzJSxFtkBrgMsMUlU1kKqh0iKT3GICFV8gyLqcoQY1JyrLEfDCqBaJW0NsPD4miNcv/+GIHgyeY6F66DWCqatKaYsZ8UAMRzlMBgNa80KVpZJQcc1LtKQCah4RTAhgSGJuKpwMBvBKZiIlNXCYaLSDHnlQIp5A3wS5etA1lmTQIeJmyaWlY6oKnqID1UhHYsUlriO+SqAhxC9RqkhBrrT4VUnLCyfKS9RWpLyAVCmdCeko9RIEY7l2alkpIW0cDTvAP4Nga+OJyMIpE2kZiaUU0s0YhEte1GgCVcsEcqLqJ6w0GqdeAa/NHU05ikW+cz+eva+NXUMMtSEy+1SEvTR+qIXGzIkXndjmvDAIYr4my5JfYG83UO4N4MUInjeQ4ZzXhU1A2C8NWF3jCH5UFnhVFSJ1l53uMakypys6dKccFCIQInnpzvi1VpciQ7qRmZjPUaO0QJMORdTCQB0pY+UWEHul0kQjl6Bk76DHIxgM2r2div7yyy9TeT2VAFNGtEzZZMpakClLwM+Rik3ZZJxAGLiasgk8PHoSARr6fnz0NH4v6Xs8Po7fOX0fjadyFTY9csRYXla3EELTvz8R8dMfnaFBtzONRTWgQTo/D0szJHoabcmiiVXH0ENiSEhhBS/Mbp4ixP1jq6Nsg7Nj4gxLLordbLnp+8dTIGuDoUej7p7t4MejuG/s+F8b3Dwmbt6rGVhhi1tYakHuH1890jaYe0LMpaqsuGx2sxYA7h9jLWEbbD0ltjJubzkumr1/DAWq4kQweH7u8Hg4fjQ8Ojw67kHMlS55ACjLYZYNm6Zppgw6iYDjn2xfQEfmL9o/b6vJx5xrVW5xbpzv0UEFX8D9jg7BD+QGzKKF7Ly1zj31VK7bcKsy3nxpPKq4NBhpD9+5Yk2PTDdFdDTk1aa5EmkgnmCC4GFGzuSIhDAkOWYHP/xw4CWTdIPDsgzi8mdBo/Q9dJLsj5blKMtGm7B9gfdHS8iyBLaMb5/IMijLcte4nyAVn8q/jFzccGVn6mq3ageA+6fdHWFbFTwYhTiXCxkmgnbABoDGRV1wjVfkvhqhpOP+xmOwoflR8XlURe+7OrfPRQaeSPjqJLieD4JSEj3rCGjk7nU3yOwj0bjAK4fDx6xEjMhC8GjqNKc41UW55HkqWTQhFDGJ/0p5JSiGKNBaN4o2Ha0TMZXjQ/fO55he3Ko5EeL+qU6PsjjpQw6aPpuykgfDy+bY/VY2Rz1l5+0agwWmFrPeWti2GM57WsYzkjQBu5ClIy8XGRZ8hkU31yMuHGOPVZoohfRERDEcRnxull9tzIbJ1Ral9kz0tSm+flEno9SgECbGousi6K8OMZzLREj0KYgZQlwAs/b13qbkXkq9+I6OcjO8M2jXCeMG4tItIZ6Tabx9QdZ37EBw4ADb8DlutmuDwMLayfTlQjhKIUVZl73URsQaJVYGK9gXF62k3FTcoX+6N3bgV3fsELJDOzaYyrGLQDOtqkwtpbvlsN33CSD375r3KPst13zNrHi433KNIlX9a7TFohCotyXtFTK779AITuj9phSCXyQM8DTFymK28YCPXTSveSYUzGprldz9hPeh7t/5blD3B5wxMfxxp9yn7c866akc+0RH6VORu7IcpTvP+3a6gaztxxBMnGQJU5XLsyv5KmMT5nP2MYPNErcVGvtcZQ2bXLNUSYvS0s+Q6KOlB+8N1QaumUlzLDn9iiRSNWEuCkJFuTbUhiXMxb9UWiAhsglTs/eYWpaQc1lR7hUN4XDrJtcRylgt5IIlIc5iE+Yz1yxheMXLioDDEKBMFUU/DsUq7ngbrnakw2XcjzafT3goZfyZaNzS1UY55bMw9TGsOrl2yLjWvGGblZuYK44evF/XZnWLJppvYckViO6FB2MJExbL/i47Tk2rT5d0ioo4cSmsT13rjoWXn7wnratyJT9rYchJb5H5R0rJz97ceP3InlGwgVn0BoddOj0Bl5od3aUxEd5xyxf9Pb1zc2PP011lll4lwOSqLjLK9SPXI1ft+PyyFpUKeZHWrlrXvuZrnLWktpyNVwm7upuZK18R8zUc+KrAuYW6qlBDqrRE/aCfark3zB0dH68S1tzNXvM/yd4TOrzl3dz97IpfXWHwz6D14dNVwvK7af22Lc/9icQeP151tm7Dlr+bqax5F9+t1V2A0agQnEGZvZInOkPdE8RMqQK57O9Pvgg945LKfyenr2+H9kH6hhxdGDkEmwsTLBMsRVGAxwknp6+pOivmwfMYwVvXbuBgNKZI5V6+BgLkCcCl4ODMS9K9Zo2PE1Fa1C4gFov10vYo1EWHcJOgTJitFCVdhqjthLiBGDKhMbVF41oaVG2BZ5nwdhiMxcqMWCvIU1XfIffPkSSHRe0SxJaUNJZqXdaqq64K6VssnG+e1ToWlAnU1cC1on6LTk5RKgTUw58ASuOXc5hzY1En1HxBktc1+d4tSryqUAuUKY7YHUrqtbjzNIP6UeFfSePt7NHhIf3bMHFrvSG0eds3UjRfsOTj3dzbjbwfJsf6pqHvbPTz/OhbU8kyzenMSzRm3U5vWXIHA325CVkIie+iUN4dHR6+e0SSWyXseJtw3qgSbU5HsSRNXWolFwlUBXLqadAN8AUXEmh7/TvKCrVW+nauP42y24RwfHj4btwK4dFNIbySLmno2oVO1QXKP5bT/vbWb0+kXpXOO/beLhMeyM2zNWb7455Jg2mthW3Y5OyaXQ15JYZ+fnJ2vjonrbO5ogCwUsZRzG3OJuzgRjzo+rUo2Di7ZrUu2IRFg2a4zCixd8Oo8UocXI7ZKtlcsdUE7oQ2li+EXAxvXXXesfqGjsNLfI3hzmOvxHdILnuQZx8qYYLUIEdORo8kSKf8UxcMfx3PKoapWyPP7lA2Y8kYSq5Fh5tP+JZ4rxfuncVYy4VPbfTEOo5YG+HQzzZmOetUrw0PYnQwdm710fGx8z+fjJ2j9vCp84GOH6/OvYR7/oDLP/RNfjBGfdvlhlYk07lyBxCEclKhfEO2kfT8cnzTAcQiVSW69HKOEMH/869/uxXRmrpr+AWc1BoqtURN7X/UMjUv8EqQNep1J1J863LfvCzQGAp6pcWF7+wTC1e+iaYo5RWfiULQxSUw5cucvbtvRvBzjpQNo6kvta9kXWJB9x0KpS6cxVTAa6vKfvcgLJW+mBNJCXCYUa8WGgMGMS5BmXOZUhLL63MCSgOX3l2ptDAIXJQETMYb53ORCkJMr5TmqYWSS75A2ixxjihJoYqdVlrNyPcxqqi9dad+L0TrWXRJtBG8JG/KMU6DGVouCsy8YTeJd6zCo0VsyAxmaCxUtL1I0XQ16wIvUbv7606S7BRUil5TwQvymvtnS4is5tKQq+sJikfTii94Hm6PjDcjoHwdGQjyukgBCiEvqPFwCGetmv2MMyMsdk74crm88ZY8WF/zjbB5PQONlerWLdyge3n6y9uPB3TzUZfmZP4G9aVIMTxkO/Y8cMAHwcbw1NmYeJ95Jf6+uYDe+0KkKA32LMKzb15/D5fwcHTIkt7r+REEH3z/6sXXP775mvDS++7v33h0ODp0mQNlbMllb6sXvrn3tHvPNvJarbHcdwzvO4b3HcP7juF9x/C+Y3jfMXyfeNp3DO87hvcdw79nx8y+Y3jfMTzddwzDvmN43zG87xjedwzvO4b3HcP7juF9x/C+Y/j/qGM41A7JYzqoCi5c8dlVG65D3fhss4/4PGE5FZYnZ+z6mrLHb3WxWtHwhxo1VaXPE3bJtaAsoKtJJ7H2StXKC2yo5OArCsNT2j/xWufKIxuleCod+xXP3DHdCtuvfb8+eXPKEjYLvc6lymiN5kvqg+ZLNiHvlLmeaSdh1+3KXSNbweWidgVU5vFSyZjXNl+vN1+4enP40avDctn0qFwvRHtW6C8xtnXBX6lG8R02f2vB/czOBUG2EZqO8Hy1Wv0XugLodA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGmtvGzfyr0z5pY2wki3HeZxwOFwevTbow0HjoDhYRkrtjrSMd8kNybW8NfTtfsn9tPslh+FjdyVLdpIWre+gL7aWHA5nhkPO85pZvjBscsZOsawKbtGw84RlaFItKiuUZBN2miPEaXihkdM4PHv9CnhRqKWB2qA2YBWkNImQ1saqUvzKZwWCjYgTWOYizcGgvkTgBmZFjZUW0hqYKw0LlKi5FXIBmUrrEmliKWwOlcYM50JiBsbqOrW1RjOCt5WSYOo0RWPmddHu5MkQSiZgc3SEarS1lgY41FJ8qBEGgwj9TmSDAdicW0i5hBkSOxlxEwjCHjkzTnNKOsSmwlTMBQEHXKOpnMq3VaF4Bo2qocrmICSoWsPZYPASZ/UC3r4aDM6/yq2tzOTggFfVSFUojVjIgs/MKFXlQUaAVTZ/ADlqdJiItEzzJSxFtkBrgMsMUlU1kKqh0iKT3GICFV8gyLqcoQY1JyrLEfDCqBaJW0NsPD4miNcv/+GIHgyeY6F66DWCqatKaYsZ8UAMRzlMBgNa80KVpZJQcc1LtKQCah4RTAhgSGJuKpwMBvBKZiIlNXCYaLSDHnlQIp5A3wS5etA1lmTQIeJmyaWlY6oKnqID1UhHYsUlriO+SqAhxC9RqkhBrrT4VUnLCyfKS9RWpLyAVCmdCeko9RIEY7l2alkpIW0cDTvAP4Nga+OJyMIpE2kZiaUU0s0YhEte1GgCVcsEcqLqJ6w0GqdeAa/NHU05ikW+cz+eva+NXUMMtSEy+1SEvTR+qIXGzIkXndjmvDAIYr4my5JfYG83UO4N4MUInjeQ4ZzXhU1A2C8NWF3jCH5UFnhVFSJ1l53uMakypys6dKccFCIQInnpzvi1VpciQ7qRmZjPUaO0QJMORdTCQB0pY+UWEHul0kQjl6Bk76DHIxgM2r2div7yyy9TeT2VAFNGtEzZZMpakClLwM+Rik3ZZJxAGLiasgk8PHoSARr6fnz0NH4v6Xs8Po7fOX0fjadyFTY9csRYXla3EELTvz8R8dMfnaFBtzONRTWgQTo/D0szJHoabcmiiVXH0ENiSEhhBS/Mbp4ixP1jq6Nsg7Nj4gxLLordbLnp+8dTIGuDoUej7p7t4MejuG/s+F8b3Dwmbt6rGVhhi1tYakHuH1890jaYe0LMpaqsuGx2sxYA7h9jLWEbbD0ltjJubzkumr1/DAWq4kQweH7u8Hg4fjQ8Ojw67kHMlS55ACjLYZYNm6Zppgw6iYDjn2xfQEfmL9o/b6vJx5xrVW5xbpzv0UEFX8D9jg7BD+QGzKKF7Ly1zj31VK7bcKsy3nxpPKq4NBhpD9+5Yk2PTDdFdDTk1aa5EmkgnmCC4GFGzuSIhDAkOWYHP/xw4CWTdIPDsgzi8mdBo/Q9dJLsj5blKMtGm7B9gfdHS8iyBLaMb5/IMijLcte4nyAVn8q/jFzccGVn6mq3ageA+6fdHWFbFTwYhTiXCxkmgnbABoDGRV1wjVfkvhqhpOP+xmOwoflR8XlURe+7OrfPRQaeSPjqJLieD4JSEj3rCGjk7nU3yOwj0bjAK4fDx6xEjMhC8GjqNKc41UW55HkqWTQhFDGJ/0p5JSiGKNBaN4o2Ha0TMZXjQ/fO55he3Ko5EeL+qU6PsjjpQw6aPpuykgfDy+bY/VY2Rz1l5+0agwWmFrPeWti2GM57WsYzkjQBu5ClIy8XGRZ8hkU31yMuHGOPVZoohfRERDEcRnxull9tzIbJ1Ral9kz0tSm+flEno9SgECbGousi6K8OMZzLREj0KYgZQlwAs/b13qbkXkq9+I6OcjO8M2jXCeMG4tItIZ6Tabx9QdZ37EBw4ADb8DlutmuDwMLayfTlQjhKIUVZl73URsQaJVYGK9gXF62k3FTcoX+6N3bgV3fsELJDOzaYyrGLQDOtqkwtpbvlsN33CSD375r3KPst13zNrHi433KNIlX9a7TFohCotyXtFTK779AITuj9phSCXyQM8DTFymK28YCPXTSveSYUzGprldz9hPeh7t/5blD3B5wxMfxxp9yn7c866akc+0RH6VORu7IcpTvP+3a6gaztxxBMnGQJU5XLsyv5KmMT5nP2MYPNErcVGvtcZQ2bXLNUSYvS0s+Q6KOlB+8N1QaumUlzLDn9iiRSNWEuCkJFuTbUhiXMxb9UWiAhsglTs/eYWpaQc1lR7hUN4XDrJtcRylgt5IIlIc5iE+Yz1yxheMXLioDDEKBMFUU/DsUq7ngbrnakw2XcjzafT3goZfyZaNzS1UY55bMw9TGsOrl2yLjWvGGblZuYK44evF/XZnWLJppvYckViO6FB2MJExbL/i47Tk2rT5d0ioo4cSmsT13rjoWXn7wnratyJT9rYchJb5H5R0rJz97ceP3InlGwgVn0BoddOj0Bl5od3aUxEd5xyxf9Pb1zc2PP011lll4lwOSqLjLK9SPXI1ft+PyyFpUKeZHWrlrXvuZrnLWktpyNVwm7upuZK18R8zUc+KrAuYW6qlBDqrRE/aCfark3zB0dH68S1tzNXvM/yd4TOrzl3dz97IpfXWHwz6D14dNVwvK7af22Lc/9icQeP151tm7Dlr+bqax5F9+t1V2A0agQnEGZvZInOkPdE8RMqQK57O9Pvgg945LKfyenr2+H9kH6hhxdGDkEmwsTLBMsRVGAxwknp6+pOivmwfMYwVvXbuBgNKZI5V6+BgLkCcCl4ODMS9K9Zo2PE1Fa1C4gFov10vYo1EWHcJOgTJitFCVdhqjthLiBGDKhMbVF41oaVG2BZ5nwdhiMxcqMWCvIU1XfIffPkSSHRe0SxJaUNJZqXdaqq64K6VssnG+e1ToWlAnU1cC1on6LTk5RKgTUw58ASuOXc5hzY1En1HxBktc1+d4tSryqUAuUKY7YHUrqtbjzNIP6UeFfSePt7NHhIf3bMHFrvSG0eds3UjRfsOTj3dzbjbwfJsf6pqHvbPTz/OhbU8kyzenMSzRm3U5vWXIHA325CVkIie+iUN4dHR6+e0SSWyXseJtw3qgSbU5HsSRNXWolFwlUBXLqadAN8AUXEmh7/TvKCrVW+nauP42y24RwfHj4btwK4dFNIbySLmno2oVO1QXKP5bT/vbWb0+kXpXOO/beLhMeyM2zNWb7455Jg2mthW3Y5OyaXQ15JYZ+fnJ2vjonrbO5ogCwUsZRzG3OJuzgRjzo+rUo2Di7ZrUu2IRFg2a4zCixd8Oo8UocXI7ZKtlcsdUE7oQ2li+EXAxvXXXesfqGjsNLfI3hzmOvxHdILnuQZx8qYYLUIEdORo8kSKf8UxcMfx3PKoapWyPP7lA2Y8kYSq5Fh5tP+JZ4rxfuncVYy4VPbfTEOo5YG+HQzzZmOetUrw0PYnQwdm710fGx8z+fjJ2j9vCp84GOH6/OvYR7/oDLP/RNfjBGfdvlhlYk07lyBxCEclKhfEO2kfT8cnzTAcQiVSW69HKOEMH/869/uxXRmrpr+AWc1BoqtURN7X/UMjUv8EqQNep1J1J863LfvCzQGAp6pcWF7+wTC1e+iaYo5RWfiULQxSUw5cucvbtvRvBzjpQNo6kvta9kXWJB9x0KpS6cxVTAa6vKfvcgLJW+mBNJCXCYUa8WGgMGMS5BmXOZUhLL63MCSgOX3l2ptDAIXJQETMYb53ORCkJMr5TmqYWSS75A2ixxjihJoYqdVlrNyPcxqqi9dad+L0TrWXRJtBG8JG/KMU6DGVouCsy8YTeJd6zCo0VsyAxmaCxUtL1I0XQ16wIvUbv7606S7BRUil5TwQvymvtnS4is5tKQq+sJikfTii94Hm6PjDcjoHwdGQjyukgBCiEvqPFwCGetmv2MMyMsdk74crm88ZY8WF/zjbB5PQONlerWLdyge3n6y9uPB3TzUZfmZP4G9aVIMTxkO/Y8cMAHwcbw1NmYeJ95Jf6+uYDe+0KkKA32LMKzb15/D5fwcHTIkt7r+REEH3z/6sXXP775mvDS++7v33h0ODp0mQNlbMllb6sXvrn3tHvPNvJarbHcdwzvO4b3HcP7juF9x/C+Y3jfMXyfeNp3DO87hvcdw79nx8y+Y3jfMTzddwzDvmN43zG87xjedwzvO4b3HcP7juF9x/C+Y/j/qGM41A7JYzqoCi5c8dlVG65D3fhss4/4PGE5FZYnZ+z6mrLHb3WxWtHwhxo1VaXPE3bJtaAsoKtJJ7H2StXKC2yo5OArCsNT2j/xWufKIxuleCod+xXP3DHdCtuvfb8+eXPKEjYLvc6lymiN5kvqg+ZLNiHvlLmeaSdh1+3KXSNbweWidgVU5vFSyZjXNl+vN1+4enP40avDctn0qFwvRHtW6C8xtnXBX6lG8R02f2vB/czOBUG2EZqO8Hy1Wv0XugLodA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.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,a.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(l.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.941ae0bf.js b/assets/js/bfe4b778.941ae0bf.js new file mode 100644 index 000000000..6acb69893 --- /dev/null +++ b/assets/js/bfe4b778.941ae0bf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),o=(s(82723),s(9487)),r=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={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:"eJzdWOtuHDUUfpVT/6GVZi9JA4gRQpS2gghEIpKqEskq8o7P7Jh4bGN7drNazT+ehEfjSdCxZ3Zns2naogok/kQbz7l9n30u9oYFvvAsv2KvTNHUqINns4wJ9IWTNkijWc4uK4Q3VvCA0EvBi/NT4EqZlYfGo/MQDNRGyHINXAtoknioEAQGLpUHUwIHb7GQpSxAdIbG8LOJgjxAqKSPho1W6956ML0xDiWuwHLHawzofAZr00DBtTYBiorrRXJYSoVgdIEgQ4qgD1p6KBzygGLMMmYsOk4QTwXLWXLS42MZ2zli+dWGaV4jy1lv60YKljFJ9FgeKnafs9NXBHjPe8SoEUUENccOF9lx+HsjHQqWB9dgxnxYK/LmZW0VsozhnVVGIMtLrjwJFBXWnOUbFtY2SgYn9YJlrDSu5mG30razZB99+M6INensh3ruzFIKhDkqM+B3wHzA2ioe0MNTHkAh9wGMxoFsD+AZy1hhdCAK8w3j1ipZRJInv3nytjkM3cx/wyIy7mhLgkRPXxPh7wdI5PBIU858/LGlnLUZ0yZ8tJlzgojgcClxFc+zlwudzufQ9h6PH+dieyqGNlrSUQIdnchDezttkkTN5wrPLs8HonNjFHI9lO0OzP6W0ymDUQJk4iKspFKQbMLZ5Tks0VGixr0bw5uY41HGYYFySek4FIHCCISl5IA1lyqDVSWLihJgDXXjA6DuzlRHJQ5KQIwRRnAYkJD+wYiyVB6kXuzKz4FhENJhEdQaVjJUpgnAhZCkzhX4gNaPd0RemsZ9eiY5LBopUEAwjYPSuBhlLF42ph0hkNoH1xSk7EE0tNsRB4nSb+tMgd7veOpZIaGB/QxQ+6TOoeQ+oMug0ZKYd40NKLYm8c6ik6gLHLO2zViQYe9Y3gzq3M2cykbbkpxDb432KUOPp9PDarLtEF11A98UFH3ZKLV+8unKQ1p+X6JwL45/8OcnP1ja6S6kF+FxpePp8fPR0XQ0/fLy6Iv85Kv88y/G0+n0V5axu1rtahMja2zIXvx/sCC1khpvetZujqfTm+cdlScPsddVHtuV5CVXUkApUQkgn/4TEojOGfcPK+Mj8T0GnyD34E8eOTrU0EvTaPFfw30ooscBntycbCF+fgjxVCfKaMq5NLeo/w2EOzxD9yG5p1D3T7VMQvE72wM7XE8gPRaNk2EdR6S7EbdylL7nVzMaPGoMlaHxyjZppgoVy9mkry6TzaDOtIzsuWU/cTVOsZxVIVifTyaeazE3d2NjUVMVU3zux4WpJ9zKyfKItdl9DW7tR0j7wBdSL0aPas12iC9oVxLxe7i39HMrf8Q1y3pah1Ld5FghF+jiFtBm/7Kb0l73W7bdlfujTT/ZfNiwcr9tPTh+DKcPxvYmjK73DVtlXGoJSWki7O6YnFnUFxQBHbLl0YHrt6gKUyN1bOpfvfhff/wZNfrIYg48gbPGgTUrdGWjIrhS4Z2k5je4gdA9gAYA5LVC79UaqOctHM2uQi5koH7fdb6CWz6XSlLWkJghbQeDxPNjeFthqNDRp88cdXGBS1SUbKCMuY0N2gBvgqmjj57NlXG3JYWUAYd546VG78Ej9iqoK043k/4UZWAccJ2mI+ukR+CyJmGaFbAsZSHJMJUIx4sANdd8geQsA4qbWOiqsQdn5jRqeaOaNEzQpQwxJIjx6jGGVzS8ReC0mG5nKNIc4bM0x3UVg2BoAXP0ASy5lwWmUStwRxeBJbqYNene1SgF1lApk1zR9We4t2QoOK491dsUUL81W/q6QSf6EHw9hmt9rS/osDQe6QAoqW99fq1HcLU9Zm9x7mXA2dM+k1er1UEGP9vX+V6GqpmDQ2t2eou4GPN9qL79h+42AV3tz8oLdEtZYFc+3uFzEoUnXYHnRSzwcTpO1eHb+wpUbJUsUPth4r/4/vwnWMLz8ZRlg5r1AQFPfjp9+frni9dkl6pqyr+j8XQ8pSVrfKi5Hri6d8m/n7qbXaf6v74JdLU74F2YWMVlbICR9E3XvK7YoKjmw+eAWcYq4wOJbDZz7vGNU21Ly7836KhFzjK25E5SDY0drpvjxcN3iyHdT3/pL9jwcS8LDwLqO5Sm9rTkqsFU8G9xfe+Jo521Wd+mKOIk8TLFNbokOzsLB8MLddmk8aIo0IZHZYfTwvmbS5axefdcUceXD+b4ip5K+Irl7Jpds/iEE+scCcX1DVNcLxq+IPlklporb2jnhp35Nnbm7gcBe5CS/ZadkNBfwvWgwtd0Un/E9Tdb8fTlnQodtb00bc+sbdu/AUEm3sk=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/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/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJzdWOtuHDUUfpVT/6GVZi9JA4gRQpS2gghEIpKqEskq8o7P7Jh4bGN7drNazT+ehEfjSdCxZ3Zns2naogok/kQbz7l9n30u9oYFvvAsv2KvTNHUqINns4wJ9IWTNkijWc4uK4Q3VvCA0EvBi/NT4EqZlYfGo/MQDNRGyHINXAtoknioEAQGLpUHUwIHb7GQpSxAdIbG8LOJgjxAqKSPho1W6956ML0xDiWuwHLHawzofAZr00DBtTYBiorrRXJYSoVgdIEgQ4qgD1p6KBzygGLMMmYsOk4QTwXLWXLS42MZ2zli+dWGaV4jy1lv60YKljFJ9FgeKnafs9NXBHjPe8SoEUUENccOF9lx+HsjHQqWB9dgxnxYK/LmZW0VsozhnVVGIMtLrjwJFBXWnOUbFtY2SgYn9YJlrDSu5mG30razZB99+M6INensh3ruzFIKhDkqM+B3wHzA2ioe0MNTHkAh9wGMxoFsD+AZy1hhdCAK8w3j1ipZRJInv3nytjkM3cx/wyIy7mhLgkRPXxPh7wdI5PBIU858/LGlnLUZ0yZ8tJlzgojgcClxFc+zlwudzufQ9h6PH+dieyqGNlrSUQIdnchDezttkkTN5wrPLs8HonNjFHI9lO0OzP6W0ymDUQJk4iKspFKQbMLZ5Tks0VGixr0bw5uY41HGYYFySek4FIHCCISl5IA1lyqDVSWLihJgDXXjA6DuzlRHJQ5KQIwRRnAYkJD+wYiyVB6kXuzKz4FhENJhEdQaVjJUpgnAhZCkzhX4gNaPd0RemsZ9eiY5LBopUEAwjYPSuBhlLF42ph0hkNoH1xSk7EE0tNsRB4nSb+tMgd7veOpZIaGB/QxQ+6TOoeQ+oMug0ZKYd40NKLYm8c6ik6gLHLO2zViQYe9Y3gzq3M2cykbbkpxDb432KUOPp9PDarLtEF11A98UFH3ZKLV+8unKQ1p+X6JwL45/8OcnP1ja6S6kF+FxpePp8fPR0XQ0/fLy6Iv85Kv88y/G0+n0V5axu1rtahMja2zIXvx/sCC1khpvetZujqfTm+cdlScPsddVHtuV5CVXUkApUQkgn/4TEojOGfcPK+Mj8T0GnyD34E8eOTrU0EvTaPFfw30ooscBntycbCF+fgjxVCfKaMq5NLeo/w2EOzxD9yG5p1D3T7VMQvE72wM7XE8gPRaNk2EdR6S7EbdylL7nVzMaPGoMlaHxyjZppgoVy9mkry6TzaDOtIzsuWU/cTVOsZxVIVifTyaeazE3d2NjUVMVU3zux4WpJ9zKyfKItdl9DW7tR0j7wBdSL0aPas12iC9oVxLxe7i39HMrf8Q1y3pah1Ld5FghF+jiFtBm/7Kb0l73W7bdlfujTT/ZfNiwcr9tPTh+DKcPxvYmjK73DVtlXGoJSWki7O6YnFnUFxQBHbLl0YHrt6gKUyN1bOpfvfhff/wZNfrIYg48gbPGgTUrdGWjIrhS4Z2k5je4gdA9gAYA5LVC79UaqOctHM2uQi5koH7fdb6CWz6XSlLWkJghbQeDxPNjeFthqNDRp88cdXGBS1SUbKCMuY0N2gBvgqmjj57NlXG3JYWUAYd546VG78Ej9iqoK043k/4UZWAccJ2mI+ukR+CyJmGaFbAsZSHJMJUIx4sANdd8geQsA4qbWOiqsQdn5jRqeaOaNEzQpQwxJIjx6jGGVzS8ReC0mG5nKNIc4bM0x3UVg2BoAXP0ASy5lwWmUStwRxeBJbqYNene1SgF1lApk1zR9We4t2QoOK491dsUUL81W/q6QSf6EHw9hmt9rS/osDQe6QAoqW99fq1HcLU9Zm9x7mXA2dM+k1er1UEGP9vX+V6GqpmDQ2t2eou4GPN9qL79h+42AV3tz8oLdEtZYFc+3uFzEoUnXYHnRSzwcTpO1eHb+wpUbJUsUPth4r/4/vwnWMLz8ZRlg5r1AQFPfjp9+frni9dkl6pqyr+j8XQ8pSVrfKi5Hri6d8m/n7qbXaf6v74JdLU74F2YWMVlbICR9E3XvK7YoKjmw+eAWcYq4wOJbDZz7vGNU21Ly7836KhFzjK25E5SDY0drpvjxcN3iyHdT3/pL9jwcS8LDwLqO5Sm9rTkqsFU8G9xfe+Jo521Wd+mKOIk8TLFNbokOzsLB8MLddmk8aIo0IZHZYfTwvmbS5axefdcUceXD+b4ip5K+Irl7Jpds/iEE+scCcX1DVNcLxq+IPlklporb2jnhp35Nnbm7gcBe5CS/ZadkNBfwvWgwtd0Un/E9Tdb8fTlnQodtb00bc+sbdu/AUEm3sk=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Document"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.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,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{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,l.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.a2c58921.js b/assets/js/bfe4b778.a2c58921.js deleted file mode 100644 index 659b047a8..000000000 --- a/assets/js/bfe4b778.a2c58921.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(85162);const u={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:"eJzdV+9u2zYQf5Urv6wFFNtJ0w4ThmFdW7RBizZoUhRYYgQn6WSzoUiWpOwYhr7tSfZoe5LhKMmWkzRth2ID9sWQyfv3+/F4d1yLgDMv0jPxzOR1RTp4MU1EQT530gZptEjF6ZzgvS0wEPRS8OT4CFAps/RQe3IegoHKFLJcAeoC6lY8zAkKCiiVB1MCgreUy1LmUHSGRvDGREEMEObSR8NGq1VvPZjeGEJJS7DosKJAziewMjXkqLUJkM9Rz1qHpVQERucEMrQR9EFLD7kjDFSMRCKMJYcM8agQqWid9PhEIraORHq2FhorEqnobV3IQiRCMj0Ww1xc5+zoGQPe8R4xaqIigsqow8V2HH2qpaNCpMHVlAgfVoq9eVlZRSIRdGWVKUikJSrPAvmcKhTpWoSVjZLBST0TiSiNqzBsV5pm2tonH34zxYp1dkM9dmYhC4KMlBnwO2A+UGUVBvJwHwMoQh/AaBrI9gAeiETkRgemMF0LtFbJPJI8/ujZ2/pm6Cb7SHlk3PGRBEmed1vCvwyQycFIUyp8/NhQLppEaBO+2cwxQyRwtJC0jPns5Uy3+Tm0vcPjt7nYZMXQRsM6qiDHGXnT3labJUljpujt6fFANDNGEeqhbEyYpklEkGHH88UglS8yzoymYTlH3hrt20M4mExuJsymCHQJDL7Oc/K+rJVa3ft+GdAuf4kL9MXBS398+NIyK11IT8LdSgeTg4d7+5O9yY+n+4/Tw5/SR49Hk8nkd5GIq0pt00+wNTFkL/4fLEitpKaLnrWLg8nk4mFH5eFt7HXJZbtbt0AlCyglqQLYp/+OBJJzxv3D5L8jvrvgM+Qe/OEdqcM1uzS1Lv5ruLdFdDfAw4vDDcRHNyEe6ZYybmSn5pL0v4Fwi2foPrTuOdTdrJatUNwXO2CH6y1IT3ntZFjFLni1h1butfvp2ZR7S0VhbriD2rptm2EuUjHuq8t4PagzjWB7btE31dopkYp5CNan47FHXWTmamQsaS64CjM/yk01RivHi33RJNc10NpvkPYBZ1LP9u7Umm4Rn/CptMTv4N7Qj1a+opVIelqHUt1wMCcsyMUj4MN+t23Ez/sj25zK9e7VN6+v60fXJ5BbO8ywwQix00TaRsFhlyZi7HLirSV9wu44oxb7N/x8IJWbinhc4HGnF//rjz+jRh9GTPh78LZ2YM2SXFmriKRUdCUzRcOJkue6YMATVoq8VyuQOtDM8SxSyJkMqCIDUs8gR4uZVJKvCIsZ1nYwuGV+BB/mFObkeOsHx5NkQQtSfLNAGXPJdoIBrIOpoo+euqVxlyWHlABCVnupyXvwRL0K6TnypNmnTALGAWogHchZJz0ByoqFS+OAylLmkg1zPXCYB6hQ44zYWQIcN7PQlV4PzmS1D+CNqiOQOGQThRZiHCVH8EwuqAXOi+20TQXMajaRQG4Kgq48MAxdQEY+gGX3Mqdo1Ad0PNgtyMUr0s7RtVJgDdctiYrH2eHZsqHgUHsurm1A/dFs6LPO8FwQfRS4GsG5PtcnnCy1J04AJfWlT8/1Hpxt0uwDZV4Gmt7vr+1yubxxXR/s6ryQYV5n4Miard4sLsbLPVTf/OFZNZCr/NvyhNxC5tTVis/4HEfhcVfNMY/VnCqUqi0Fv15X4MqqZE7aD2/5kxfHr2EBD0cTkQwK1FcEPH599PT5m5PnbJdLaHv/9keT0YSXrPGhQj1wde3Rdv3qrrdt6f/6xusKdaCrMLYKZex2kfR116nOxKCCpsPn3TQRc+MDi6zXGXp671TT8PKnmhz3w2kiFugkl9DYzgrp+bvYPNM+S/f9d/2DCb7tpXgroL4dae5FC1Q1tdX9klbXnqzNtEn6nsQRtxJP27j2TtnO1sKNSYVbaqvxJM/Jhjtlh6PB8ftTkYise35W8SUrHC756YtLkYpzcS7ikzzWORaK62uhUM9qnLF8a5Y7KdZ8csM2fBnbcPfBwG6lZLc/t0j4l3HdqvAzZ+orWv2yEW93PqvQUdtL8/FMm6b5G+h5E2c=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/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/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJzdV+9u2zYQf5Urv6wFFNtJ0w4ThmFdW7RBizZoUhRYYgQn6WSzoUiWpOwYhr7tSfZoe5LhKMmWkzRth2ID9sWQyfv3+/F4d1yLgDMv0jPxzOR1RTp4MU1EQT530gZptEjF6ZzgvS0wEPRS8OT4CFAps/RQe3IegoHKFLJcAeoC6lY8zAkKCiiVB1MCgreUy1LmUHSGRvDGREEMEObSR8NGq1VvPZjeGEJJS7DosKJAziewMjXkqLUJkM9Rz1qHpVQERucEMrQR9EFLD7kjDFSMRCKMJYcM8agQqWid9PhEIraORHq2FhorEqnobV3IQiRCMj0Ww1xc5+zoGQPe8R4xaqIigsqow8V2HH2qpaNCpMHVlAgfVoq9eVlZRSIRdGWVKUikJSrPAvmcKhTpWoSVjZLBST0TiSiNqzBsV5pm2tonH34zxYp1dkM9dmYhC4KMlBnwO2A+UGUVBvJwHwMoQh/AaBrI9gAeiETkRgemMF0LtFbJPJI8/ujZ2/pm6Cb7SHlk3PGRBEmed1vCvwyQycFIUyp8/NhQLppEaBO+2cwxQyRwtJC0jPns5Uy3+Tm0vcPjt7nYZMXQRsM6qiDHGXnT3labJUljpujt6fFANDNGEeqhbEyYpklEkGHH88UglS8yzoymYTlH3hrt20M4mExuJsymCHQJDL7Oc/K+rJVa3ft+GdAuf4kL9MXBS398+NIyK11IT8LdSgeTg4d7+5O9yY+n+4/Tw5/SR49Hk8nkd5GIq0pt00+wNTFkL/4fLEitpKaLnrWLg8nk4mFH5eFt7HXJZbtbt0AlCyglqQLYp/+OBJJzxv3D5L8jvrvgM+Qe/OEdqcM1uzS1Lv5ruLdFdDfAw4vDDcRHNyEe6ZYybmSn5pL0v4Fwi2foPrTuOdTdrJatUNwXO2CH6y1IT3ntZFjFLni1h1butfvp2ZR7S0VhbriD2rptm2EuUjHuq8t4PagzjWB7btE31dopkYp5CNan47FHXWTmamQsaS64CjM/yk01RivHi33RJNc10NpvkPYBZ1LP9u7Umm4Rn/CptMTv4N7Qj1a+opVIelqHUt1wMCcsyMUj4MN+t23Ez/sj25zK9e7VN6+v60fXJ5BbO8ywwQix00TaRsFhlyZi7HLirSV9wu44oxb7N/x8IJWbinhc4HGnF//rjz+jRh9GTPh78LZ2YM2SXFmriKRUdCUzRcOJkue6YMATVoq8VyuQOtDM8SxSyJkMqCIDUs8gR4uZVJKvCIsZ1nYwuGV+BB/mFObkeOsHx5NkQQtSfLNAGXPJdoIBrIOpoo+euqVxlyWHlABCVnupyXvwRL0K6TnypNmnTALGAWogHchZJz0ByoqFS+OAylLmkg1zPXCYB6hQ44zYWQIcN7PQlV4PzmS1D+CNqiOQOGQThRZiHCVH8EwuqAXOi+20TQXMajaRQG4Kgq48MAxdQEY+gGX3Mqdo1Ad0PNgtyMUr0s7RtVJgDdctiYrH2eHZsqHgUHsurm1A/dFs6LPO8FwQfRS4GsG5PtcnnCy1J04AJfWlT8/1Hpxt0uwDZV4Gmt7vr+1yubxxXR/s6ryQYV5n4Miard4sLsbLPVTf/OFZNZCr/NvyhNxC5tTVis/4HEfhcVfNMY/VnCqUqi0Fv15X4MqqZE7aD2/5kxfHr2EBD0cTkQwK1FcEPH599PT5m5PnbJdLaHv/9keT0YSXrPGhQj1wde3Rdv3qrrdt6f/6xusKdaCrMLYKZex2kfR116nOxKCCpsPn3TQRc+MDi6zXGXp671TT8PKnmhz3w2kiFugkl9DYzgrp+bvYPNM+S/f9d/2DCb7tpXgroL4dae5FC1Q1tdX9klbXnqzNtEn6nsQRtxJP27j2TtnO1sKNSYVbaqvxJM/Jhjtlh6PB8ftTkYise35W8SUrHC756YtLkYpzcS7ikzzWORaK62uhUM9qnLF8a5Y7KdZ8csM2fBnbcPfBwG6lZLc/t0j4l3HdqvAzZ+orWv2yEW93PqvQUdtL8/FMm6b5G+h5E2c=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update Document"})}),"\n",(0,t.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.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,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{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,t.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document updated successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.460c9d43.js b/assets/js/runtime~main.26c11ea6.js similarity index 94% rename from assets/js/runtime~main.460c9d43.js rename to assets/js/runtime~main.26c11ea6.js index d50f39a95..3f04eeacc 100644 --- a/assets/js/runtime~main.460c9d43.js +++ b/assets/js/runtime~main.26c11ea6.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"3e74cd33",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",533:"2d5f5b1d",762:"74ae2291",792:"01714e3e",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"52af9f43",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"a2c58921",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f3cca27d",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"5bd0eb92",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"fcf78bcd",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"910d4a50",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"000e7fdc",5900:"e113e88d",6011:"6de743c9",6033:"d669ec3e",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6238:"4daa52ac",6344:"29bab824",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"14209b93",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"cde5db0f",8106:"cdd769c8",8140:"901b2f91",8141:"60a9b3b8",8163:"2b8fccd7",8215:"c6b04c16",8468:"7cfe3494",8474:"a75e5064",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"bbadc29e",8784:"fb16cf6f",8866:"381cdff2",8878:"eda4ae1c",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"002f0dec",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"dff34c6e",9700:"ad032cc8",9817:"424c677a",9914:"13b02ad4"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"3e74cd33",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",533:"2d5f5b1d",762:"74ae2291",792:"01714e3e",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"a84b1389",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"941ae0bf",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f3cca27d",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"5bd0eb92",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"fcf78bcd",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"910d4a50",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"000e7fdc",5900:"e113e88d",6011:"6de743c9",6033:"bc4974db",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6238:"4daa52ac",6344:"29bab824",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"14209b93",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"cde5db0f",8106:"cdd769c8",8140:"901b2f91",8141:"60a9b3b8",8163:"34493030",8215:"c6b04c16",8468:"7cfe3494",8474:"a75e5064",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"bbadc29e",8784:"fb16cf6f",8866:"381cdff2",8878:"eda4ae1c",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"002f0dec",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"84ff4b21",9700:"ad032cc8",9817:"424c677a",9914:"13b02ad4"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 6951b7159..7951e388f 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 1e9515877..3bd47c94e 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 1a777455d..d81497159 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 fff0dc16f..0e70ab648 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 016f115bf..eaef63899 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 30522250d..c47b4bb5a 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 28a1af5f9..05e47b21a 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 303872e51..e641f12d6 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 10444b980..7b014660d 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 16b57b6eb..980d4a40e 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index ff1b906b5..92606d9d8 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 14e92a04a..e87b8dfa6 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 8aa0919d6..da70ee80e 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -116,7 +116,7 @@
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}
}

Request

-

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

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

    signers

    object[]

    required

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

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

    x number

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

    y number

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

    w number

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

    h number

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

  • ]

  • ]

  • folderId string
    send_email boolean

    This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean
    enableOTP boolean
+

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

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

    signers

    object[]

    required

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

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

    x number

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

    y number

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

    w number

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

    h number

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

  • ]

  • ]

  • folderId string
    send_email boolean

    This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean
    enableOTP boolean

    true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.

    enableTour boolean

    true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.

Responses

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index c1bc2bb0b..e02232b16 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + @@ -14,7 +14,7 @@

The Create Document 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 or using the Create Template API.

Request

Path Parameters

    template_id stringrequired

    objectId of Template

-

Body

required

    signers

    object[]

    required

  • Array [

  • role string
    email mail
    name string
    phone string
  • ]

  • folderId string
    send_email boolean

    This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean
    timeToCompleteDays number

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

    enableOTP boolean
+

Body

required

    signers

    object[]

    required

  • Array [

  • role string
    email mail
    name string
    phone string
  • ]

  • folderId string
    send_email boolean

    This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean
    timeToCompleteDays number

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

    enableOTP boolean

    true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.

    enableTour boolean

    true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.

Responses

In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage

Schema

    objectId string
    url string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index 8dd01b2a5..6b3c3c31b 100644 --- a/docs/API-docs/createfolder/index.html +++ b/docs/API-docs/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index c98730bff..f75cf741a 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -113,7 +113,7 @@
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}
}

Request

-

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

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

    x number

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

    y number

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

    w number

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

    h number

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

  • ]

  • ]

  • sendInOrder boolean
    enableOTP boolean
+

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

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

    x number

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

    y number

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

    w number

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

    h number

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

  • ]

  • ]

  • sendInOrder boolean
    enableOTP boolean

    true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.

    enableTour boolean

    true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.

Responses

Template created successfully!

Schema

    objectId string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index fb3be58c3..50665cd22 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index 843fbcff7..cea90b003 100644 --- a/docs/API-docs/delete-webhook/index.html +++ b/docs/API-docs/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index aefc75834..089920f79 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index 3f8bc9b0c..5919b7412 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/deletefolder/index.html b/docs/API-docs/deletefolder/index.html index e533b1b70..991747c61 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index 1d8512407..cd22feb9e 100644 --- a/docs/API-docs/folderlist/index.html +++ b/docs/API-docs/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 2d859e1f5..c09757604 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index c9cb428fc..ba0d2303c 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index 562e3decb..eb1039638 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index b9ddfc1aa..f10afdad1 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 4dac0676b..605e2e69c 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index ad1441055..cd85d7020 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/getfolder/index.html b/docs/API-docs/getfolder/index.html index 8dd703fb4..c6293bbba 100644 --- a/docs/API-docs/getfolder/index.html +++ b/docs/API-docs/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index 1edd7ab33..d157f55e6 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index 442ef53fa..d6fe91495 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index 88101d552..2b1b980e6 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index 765e35473..3eaee95a9 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 83f40a515..b7e5fa4a1 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index e8d4810be..18b77068b 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + @@ -14,7 +14,7 @@

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.

Request

Path Parameters

    document_id stringrequired

    ID of the document that needs to be updated

-

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean
+

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean

    true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.

    enableTour boolean

    true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.

Responses

Document updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 08a447ebe..04d5b223f 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + @@ -14,7 +14,7 @@

The Update Template API enables you to modify and update the details of a specific template.

Request

Path Parameters

    template_id stringrequired

    ID of the template that needs to be updated

-

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean
+

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean

    true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.

    enableTour boolean

    true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.

Responses

Template updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index ea6285702..3b7511e19 100644 --- a/docs/API-docs/updatefolder/index.html +++ b/docs/API-docs/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index ed2bba921..5dfae0730 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 acf42273e..6e5e18c24 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 331c1a7a1..8914ab33b 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 5f476105e..7f3a55f50 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 9816e4262..a2824255d 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 109df3cea..31a667d58 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index ba46845e2..5f6339400 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index bd0dc8052..2a04eba10 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 16349b811..bfb01c833 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 97ae74bcf..2fd8688da 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 a954dc2be..af9918bc5 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 7f87a0b2b..b6798ab68 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 04b7f7896..ef211beed 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 f9b0a3c8b..8d78becce 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 300a760b4..94127356f 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 45c1fcdd2..11c3e59a7 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/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index e6dbfcc18..4945d91a0 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 d84d50959..f7186a10d 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 27fec78de..8b3f2ad36 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 98bc0c554..76375ac00 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 2bd224ccd..94c5db256 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 4aa2a5913..dd422fd4a 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 a1ba81365..32373fb8d 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 30293e195..5d4272e4a 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/declined/index.html b/docs/help/Reports/declined/index.html index 68f75eb54..372da0bd1 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 f9f600f25..3f85d84c8 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 ad05747d7..8dc380b1b 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 8f0ce9a1e..be2a744dd 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 4bf582060..6707abea0 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index ad93f8744..382ded6da 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 54dfe37a7..e4c1a86e3 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 889091be3..cef5f2d7f 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 1ba221658..0ebbab57f 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/quick-send/index.html b/docs/help/Templates/quick-send/index.html index 5c90a729d..df211304c 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 418ec42f5..42dc01b02 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 39576d741..037c8ea24 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 db339d826..5cbad83c8 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 2f6ba4ba7..36a061dcd 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 10831d527..bb9fbc382 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 40d82adee..3f7ea6494 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 b74dd6576..48170c934 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 57e356f33..fc73a4b4e 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 0edc9dbb4..ee34b32dd 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 4ce69d5f2..c08a81579 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 3ef8b8b48..4fc500d16 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 febd4a6fd..46416237a 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 4dbf69626..f62152422 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +