From 9354823ba4c013976d322f6832004b6a20a71d4e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 27 May 2025 12:43:24 +0000 Subject: [PATCH] deploy: 69e679982a9d979137496909e245f85add073211 --- 404.html | 2 +- assets/js/0028a090.7094d241.js | 1 + assets/js/0028a090.f2e37798.js | 1 - .../{0058b4c6.c75adfba.js => 0058b4c6.d66f92df.js} | 2 +- assets/js/05632a52.ecfd1686.js | 1 - assets/js/05632a52.f39cb8ab.js | 1 + assets/js/13fdae3b.27c9c261.js | 1 + assets/js/13fdae3b.64fc90ce.js | 1 - assets/js/1f73ca32.21256d76.js | 1 + assets/js/1f73ca32.89441e90.js | 1 - assets/js/2304e9ae.531003b7.js | 1 - assets/js/2304e9ae.bb7f0628.js | 1 + assets/js/28b19cd2.20fd84d2.js | 1 - assets/js/28b19cd2.6d63629e.js | 1 + assets/js/2c586be5.29f1f4c8.js | 1 - assets/js/2c586be5.ae975503.js | 1 + assets/js/377084eb.1793addd.js | 1 - assets/js/377084eb.a6437b0c.js | 1 + assets/js/38e3d9c8.69204c41.js | 1 + assets/js/38e3d9c8.73b1ae3a.js | 1 - assets/js/451a5132.5eff7d00.js | 1 + assets/js/451a5132.63947840.js | 1 - assets/js/4d665321.3e8376ec.js | 1 + assets/js/4d665321.9d8377ce.js | 1 - assets/js/52d5c0f9.4cc28061.js | 1 + assets/js/52d5c0f9.ab1067bd.js | 1 - assets/js/5a2de241.85cab8cc.js | 1 + assets/js/5a2de241.fbd45b06.js | 1 - assets/js/5c04ee3b.24d5c460.js | 1 + assets/js/5c04ee3b.f55f760f.js | 1 - assets/js/5ce9853b.336a8868.js | 1 - assets/js/5ce9853b.e5a454ea.js | 1 + assets/js/70853c19.1727838e.js | 1 - assets/js/70853c19.b02fe1ab.js | 1 + assets/js/770b40a9.64935506.js | 1 + assets/js/770b40a9.e63b830b.js | 1 - assets/js/78b2b753.05461463.js | 1 - assets/js/78b2b753.5a4dcd6c.js | 1 + assets/js/7b076186.74d6bcf5.js | 1 + assets/js/7b076186.d801eba3.js | 1 - assets/js/8a725248.a786571b.js | 1 + assets/js/8a725248.ec40bb7e.js | 1 - assets/js/8a855f99.b5c8d3ca.js | 1 + assets/js/8a855f99.d1b9f1c1.js | 1 - assets/js/a2bc1463.504ac772.js | 1 - assets/js/a2bc1463.b30f8ee5.js | 1 + assets/js/a88a3db3.168a453c.js | 1 - assets/js/a88a3db3.b00e16a9.js | 1 + assets/js/a9f09360.09056bb0.js | 1 + assets/js/a9f09360.f206504f.js | 1 - assets/js/ada7accb.0a9d5bbe.js | 1 + assets/js/ada7accb.5ec1ab32.js | 1 - assets/js/ae010e44.101476aa.js | 1 + assets/js/ae010e44.7182f56e.js | 1 - assets/js/bbdfc22d.a23572a7.js | 1 + assets/js/bbdfc22d.cb265dda.js | 1 - assets/js/bfe4b778.911cc9c6.js | 1 - assets/js/bfe4b778.c60c5a5d.js | 1 + assets/js/f0ff4a36.4600e4ad.js | 1 - assets/js/f0ff4a36.4e6daff2.js | 1 + assets/js/fa40969b.4a2b9b90.js | 1 - assets/js/fa40969b.ac3256b6.js | 1 + ...me~main.c43d8780.js => runtime~main.505599aa.js} | 2 +- blog/archive/index.html | 2 +- blog/authors/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 2 +- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 2 +- .../createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/createfolder/index.html | 2 +- docs/API-docs/createtemplate/index.html | 2 +- docs/API-docs/delete-template/index.html | 2 +- docs/API-docs/delete-webhook/index.html | 2 +- docs/API-docs/deletecontact/index.html | 2 +- docs/API-docs/deletedocument/index.html | 2 +- docs/API-docs/deletefolder/index.html | 2 +- docs/API-docs/draftdocument/index.html | 2 +- docs/API-docs/drafttemplate/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 | 13 ++++++++----- docs/API-docs/resendrequestmail/index.html | 2 +- docs/API-docs/revokedocument/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 2 +- docs/API-docs/selfsign/index.html | 2 +- docs/API-docs/update-document/index.html | 2 +- docs/API-docs/update-template/index.html | 2 +- docs/API-docs/updatefolder/index.html | 2 +- docs/category/cloud-storage/index.html | 2 +- .../create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/documents/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- .../manage-docs-using-opensign-drive/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/index.html | 2 +- .../edit-document-before-sending/index.html | 2 +- .../enforce-email-verification/index.html | 2 +- .../New-Document/navigate-between-pages/index.html | 2 +- .../help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- .../help/OpenSign™ Drive/create-document/index.html | 2 +- docs/help/OpenSign™ Drive/list-grid-view/index.html | 2 +- .../OpenSign™ Drive/organize-documents/index.html | 2 +- .../help/OpenSign™ Drive/rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/contactbook/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- docs/help/Settings/APIToken/index.html | 2 +- docs/help/Settings/Teams/index.html | 2 +- docs/help/Settings/Webhook/index.html | 2 +- docs/help/Settings/disabledocumentid/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- docs/help/Templates/create-template/index.html | 2 +- docs/help/Templates/embed-template/index.html | 2 +- docs/help/Templates/publicTemplate/index.html | 2 +- docs/help/Templates/quick-send/index.html | 2 +- docs/help/Templates/use-template/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- .../One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/cloud-storage/s3/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- docs/self-host/docker/upgrade-deployment/index.html | 2 +- docs/self-host/guides/azure-vm-setup/index.html | 2 +- docs/self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- docs/self-host/guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 162 files changed, 139 insertions(+), 136 deletions(-) create mode 100644 assets/js/0028a090.7094d241.js delete mode 100644 assets/js/0028a090.f2e37798.js rename assets/js/{0058b4c6.c75adfba.js => 0058b4c6.d66f92df.js} (53%) delete mode 100644 assets/js/05632a52.ecfd1686.js create mode 100644 assets/js/05632a52.f39cb8ab.js create mode 100644 assets/js/13fdae3b.27c9c261.js delete mode 100644 assets/js/13fdae3b.64fc90ce.js create mode 100644 assets/js/1f73ca32.21256d76.js delete mode 100644 assets/js/1f73ca32.89441e90.js delete mode 100644 assets/js/2304e9ae.531003b7.js create mode 100644 assets/js/2304e9ae.bb7f0628.js delete mode 100644 assets/js/28b19cd2.20fd84d2.js create mode 100644 assets/js/28b19cd2.6d63629e.js delete mode 100644 assets/js/2c586be5.29f1f4c8.js create mode 100644 assets/js/2c586be5.ae975503.js delete mode 100644 assets/js/377084eb.1793addd.js create mode 100644 assets/js/377084eb.a6437b0c.js create mode 100644 assets/js/38e3d9c8.69204c41.js delete mode 100644 assets/js/38e3d9c8.73b1ae3a.js create mode 100644 assets/js/451a5132.5eff7d00.js delete mode 100644 assets/js/451a5132.63947840.js create mode 100644 assets/js/4d665321.3e8376ec.js delete mode 100644 assets/js/4d665321.9d8377ce.js create mode 100644 assets/js/52d5c0f9.4cc28061.js delete mode 100644 assets/js/52d5c0f9.ab1067bd.js create mode 100644 assets/js/5a2de241.85cab8cc.js delete mode 100644 assets/js/5a2de241.fbd45b06.js create mode 100644 assets/js/5c04ee3b.24d5c460.js delete mode 100644 assets/js/5c04ee3b.f55f760f.js delete mode 100644 assets/js/5ce9853b.336a8868.js create mode 100644 assets/js/5ce9853b.e5a454ea.js delete mode 100644 assets/js/70853c19.1727838e.js create mode 100644 assets/js/70853c19.b02fe1ab.js create mode 100644 assets/js/770b40a9.64935506.js delete mode 100644 assets/js/770b40a9.e63b830b.js delete mode 100644 assets/js/78b2b753.05461463.js create mode 100644 assets/js/78b2b753.5a4dcd6c.js create mode 100644 assets/js/7b076186.74d6bcf5.js delete mode 100644 assets/js/7b076186.d801eba3.js create mode 100644 assets/js/8a725248.a786571b.js delete mode 100644 assets/js/8a725248.ec40bb7e.js create mode 100644 assets/js/8a855f99.b5c8d3ca.js delete mode 100644 assets/js/8a855f99.d1b9f1c1.js delete mode 100644 assets/js/a2bc1463.504ac772.js create mode 100644 assets/js/a2bc1463.b30f8ee5.js delete mode 100644 assets/js/a88a3db3.168a453c.js create mode 100644 assets/js/a88a3db3.b00e16a9.js create mode 100644 assets/js/a9f09360.09056bb0.js delete mode 100644 assets/js/a9f09360.f206504f.js create mode 100644 assets/js/ada7accb.0a9d5bbe.js delete mode 100644 assets/js/ada7accb.5ec1ab32.js create mode 100644 assets/js/ae010e44.101476aa.js delete mode 100644 assets/js/ae010e44.7182f56e.js create mode 100644 assets/js/bbdfc22d.a23572a7.js delete mode 100644 assets/js/bbdfc22d.cb265dda.js delete mode 100644 assets/js/bfe4b778.911cc9c6.js create mode 100644 assets/js/bfe4b778.c60c5a5d.js delete mode 100644 assets/js/f0ff4a36.4600e4ad.js create mode 100644 assets/js/f0ff4a36.4e6daff2.js delete mode 100644 assets/js/fa40969b.4a2b9b90.js create mode 100644 assets/js/fa40969b.ac3256b6.js rename assets/js/{runtime~main.c43d8780.js => runtime~main.505599aa.js} (82%) diff --git a/404.html b/404.html index 43ce2ce56..1848dddd9 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.7094d241.js b/assets/js/0028a090.7094d241.js new file mode 100644 index 000000000..2071330ba --- /dev/null +++ b/assets/js/0028a090.7094d241.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/drafttemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/drafttemplate","permalink":"/docs/API-docs/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyGzmuv8Ltl0xULdlSHE/GT8eTeDLKxpeNncnFdnnY3ZCacTfZIdmWFZeqzsP+wfmD/bT5klPgpS+62M5kdtZTq5fEaoIgAAIgCAI3gaZjFeycBieQFxnVoILzMEhAxZIVmgke7AQnKRA/TF5IOtKMj8nu0ZAAp1EGipQKpCJakFgCAsWl0iJnX3CUaI85JArkFc6likRZCYVkXCsyEpKMgYOkBnEi4jIHHJgwnZJCQgIjxiEhSssy1qUE1SNvC8GJKuMYlBqVmV2ZCU7EiNBqzZDoFAypEnQpuSKUlJx9LoF0OiL6BLEeJp0O+S4BxcacakiQOD/9giWPQzJJWZySmHISAbKaIKeOYGiQG1EcE9ysqQqI2YghsEPWI7tJwpBGmmXTkFDS6ZQy63QIU6SQ4oolkPjVxGiEIqVGtIRxDXJEYzCyAsTCx2YZj5xQnpARjVnGdFuMJGFKSxaVuHLvjJ/xE1bskLdFJmhCpqKU5OjFTzW4FgS/nXY6LyAqx+TtsNM5/y7VulA7Gxu0KHqiAI7SymikerHINxIELJKRkRVIQKxGXkAVy6aEJgmZsGQMWpkN4SQWxZTEQsiEcasaBR0D4WUegVSh4SYXEgjjhBIJNJl2teiWCsir48MDFENOdY8cZaUKq+USJiHW2dSiR/F4rh7Z3dneQh1ifBySnF6ilJgmn0sWXyLbCrjZWqcyRladzjukt5IOU07HE0J0yhSZQJQKcUngCocnLMuIlmw8BtnpnPFff/31jN+ccULOAgNxFuyQs8ChOAtCO6SnBdiRF4fP3+7vHZxcnHw42qvGvabOwQxfVBAjls1jePvmdTXMaT4/fLC7Xy/AhXbjRxlQBUTCFYOJ2Qfcasurl0I1reEn7OxqBCeBVPj1FL8QcmP/a1NzPHx5sPemSYuFgJyyrAWyt787fN2CKVLB22iOfj48aOMpZQPL8OClFYodn+F/545etyO7boNOhvt7xye7+0cIPHP7iNpwXBaFkLj976xC7+A2n/EfIRMTQiUY7YlFngtOCippDtr4xpRqMyzhc8kkJNa50SzzlrFzxruk00FV2Ol0yJAnLEbTsGY+LQA9m4XtWVA0GQQ9dq7GgjYMCX2RdSdoIRNqrbvI0JEgqAT0UppdQRvxdUimiPgFoF5YtKmQ7IvgmmZGKa5AahbTrGnESKBxfZpK44IKwbj2X90K5IMzVrRlY6LOyyBpCQorZ9yMKCBXNCtBOaomIUmRqjdQSFDG4zq8KEiekBTYOF25Hk0+lUq3EJNSeT/qqXBr+V0y4gUjthHNFBA2askyp5fQWI2Iwvr3HvlxShIY0TLTIWHof7QsoUcOhCa0KDIWm7MR3bk9eEoJXbPLTh0cIWgqSMSRPR/wREgYng3obXDQoHBzPHWoZ/ZAQfaMH9Up5UTwuY2ORSbkogqZz205klhwDVz3yO4VZZkh3jKrCONxViZAoozGl6E52UMi8SzDXZlClolJaPXdgJgT1sjcyIcoyFALBUf6uXDLM1WfoT1ygv6nsicc9KI2izDVlKrz4SOBK6MIvIkR41dCI7iQfBIR0UxnEKLBFpRPQ5LYoAGudSSuQxKnEF+avyRNmCBRqbXglrFEiiIRE+5kORJcK/ZliUX6ka+X6CAkWyHZDsmzkPQ3Q9IfhKS/FZL+dkj6z0Iy2AzJYBCSwVZIBtuWrMEzJ2taCbhJQH9gpaz/OtJFv/uaKWPZ6DBV5YMnLR/c75FOp7Km+eO3PmMrkOq0Qp+JY333+xp/PBl8735O8ef24Jn7OTGg/S33M8Wfg37znBgYSjTNi1uowOE/lAIfLFglwm/uzD0LvD/Dj+iIQj9QH8WOHhyYNXl5grwwzjSjmVrNjod4QBzVJC0wtYVMGXVdzZGLQR4MO016TMiCbtIOGbfaGPIGb6gYLHD/tOdOltXM22UfDO8Ncr6N9W1kHV3TCbqm1fxX3usBCWGepm+TxPc9EwAYz7xaDg7gAUmhTdG3yeAZygAPpdUCwNEHxH2DHHsBMye8Hdvc6vafdgebg62WBPCmbAHyvJsk3el0+kdID2MetzyGPD5CtZEdZiRGUuRLrh/mdlBDuZjI/O1D9n0M1COokiKYBWjnVPz9vxlla5HQ6SNlUfmpVXCG8HVoNm2QaYaQDpMLiVPBYkc8wviQLMILXg9l0DWS3EiSjYYk8WOSdPO8O/cRf3aN4Bsf87yXJL05yIXdsR9zkiQhWfy89HuSkDzPV3y2388CE1L9gKrvIrHV2u8A/iwDqPW8vfCtxoHZIcEzs7a5pC23jrkjJGU+GeNUhcwBSBiXGZVwjbdNNZ/h+AMtxxtOHa+b26m52NkUnxEF+e7QxeSPnVIjC20E+OXueQucNZFIGMO1wWGTuEgMS0xqNcR8a4q3N+pDf5R7nbUzv2JaMMwSZKC1+Qo67i0jwu5a44aNuzp/wVagW8xQRfzMJXdss/1Gvfub5nhzF4xbzjcH8YBc/BxJOGjTFTaZFuTURACoZVD/LXQK8iw4r+bYWzUkd8w9v4cdpSyBjEaQLQ7d2waavDh9aggGB3LGq0yAoXezkcjL6fXc4FmdxJuzLctxU6m9E/em4UVMMqZ8LqQtr+ZslywyKTwONv0fAfETSFSp4TereUXY/fTcegG3OXcsgXDEAFaJOr/aHSu0NqYpGMSRM87yMq8yjqMKqxdZ7k7zprxwJr5s+BWau7uwAr2+YwX3NLNigTPeN5kBn1G4JdZzEA/IGcyRdLud/h430Toj/6DD7W4D9Gw1DXDJkYig9jCsjE+ttr4eOcQDCLOcdhLmreIYCo05rm81zYrkex9BJgvUzGyt1rwm1APSviVk/Zs10MH9OVrYZO8vpIktsu+tjTaPl9PxLZddM/yA9M/RM7e5QRiIwlQLCD5Mgp0gwZoE/xIehAYzKP2jSKbBzk3gEu34p0tj48yNTwqrG24CFaeQU/zLU4T1EPigGoT+HTMIA5N5weIIFFew495kgxDvDwW+hoFCHGbezo2Hss/NQeju4cFOYN+hgzCAa5oXCOw+EeCxwNtukYyCmV/wNlTVlxqVMn9UZQGIB9/wficaM3U2Vw/yuzA1McxqsdbIqJR0GsyXnvjHO39Hs/Oq14ls6m2EabSE6kXJgAVhwDTkzVVWbJoUXy/pGARyYrKyXzvXbAvNv3pNnGeevX/PRPdYskTm95SSHV1cuL1lu3g3hMRHzd36fTMk5o2hd5fGeHjDLR0317Qx4MKaJ6vevRvPbSoVZZbgQxZQ2TPPz7+7zsWUOtEsLk3pTXU2tDirSK0468/C4PpuZq5JLLr+UZ18l8FIk7IoQJJYSA7ycTOz9mCYG2xtzcJgejd7078ke9/j5k3u5u6dqUaoKzX+E7Q+eTYLg/RuWn+u6iX+g8Rubc/qs86V4VTld5FIphfeb83uAvSHCsJhLdeQH8oEZEMQkRAZUL4gieHIBleCPMJI5JFLZZlnbiaVP1BseZeEGLBkxmSkva8iLuawb+DEPT1iTLaHH0ysqMpIIRT3+JRFGIEvGcMaRwvBbI2gecgHGqdYnKYtVXSEb/Sm1AertESpPHkpVeatPQMMR3UKzFaXMD5ux4YN6Zg6iybvvebu4Bc85Eyd5+HJ0T1kaSLXri0Ys+e05dLiIIcnR1g8xEYuDOuRt6qShBctbYEQDIvIFaO+wKDy7VObXABuJCJ8qVpd99dzZTtdskhQwtRSisI6vVnVtS4grmsNcYtEqbHI0RV3EqWhUC05GioqQZ6I8j5aeYckKRmX5nVEo8n6SiKTcq2Lfxi3RbPm3pOU0tc7ObVASKygreXkpYJADfwhAa7sdEpGVGmQIVbSouRlifeaCiVcFyAZ8BiWikCCFd1FKZfGTW0ZtCtp3r557SpMPQ/eKCO0QIsYElIWRmuMJVQVXn7n5llfCJTQOkBerArQFkMPU4flcmoFSIVVyJIIOaacfXFVyRiRCAUkgpRmFtS5CnxbQnrQwtvEeF/72z//1aBrZcS5SJhdgSYJJvrvoNDca63CY8QtoUAPKNoUIT6Q/zN/CCB1xmgucpFUhqTur+NHWPanVeUXtTBFw5CBLa32Dw+Vv1Wh97HKhZX4/iDNO4EpwRYF8gvXTOlGjZJ/SVz0D28A5Rg3aDBhCFo16jyfNg28osvVQtXoTCUVa9e3Vcfggi3QUosLCTnj9zunmskBLSpHUGqRU81i4lGpXrtqEUsra7vOsdzdkobaeMWEfLzCVBHdheAxXDB+AVcg7xHgHVR52oROUbn1BIA3afNCssdZXVk2wVLrlkwap5Opn2xS+fSOeMAGDPWd3p1lWPQquLJXmsHmJv43Zzm+pt5XetdtBtn0b0F4/4TC7fcpX9W9zJZrk/sxHfysCp7HKVrZCqdZg98eqzUTJRswfZVGL2N2yF4N334Z9g/YUA35m6fx8+H28LJ4/8vzVz/0YPqqHw9+mb4f/KI/vMvU8JNg8c+v0o/8FxU9f1p+eP9Rfng/lB/evdH03dPdiKc8evkTi6dPP0WDTfb6+avNj+/6k+jlT5sff/mh+GiQ/7T58fJyM84Pnkd8F2GKD+//wQ4/7T3Z/7L3Zf9k73r/S/ZDjx58/vT8Ov5h/3Jvu/txKLv7h9HfP33WxZunyZOD92z7GezDO36y+ToOmtrAeMY4XPitvjB8X+Bmz4xSbC3b9mORg06NszCl/FJgn0Bh6+G1nBI6powTFJ38A7UApBTy9j39OspuE8TW5uZFvxLC00UhDLl5nzMtMyfiEvify2lzeW2XR1Kvc6P19kQOmAUy40GL2eZ3y6SCuJRMT4Od05vguksL1rXjO6fns/MwQMEKzCEWQhmKqU6DnWBjPqWInUsmYXV6Y22wMjRFeYJvaAvGRgu2cdUPZuH8jKWmuRIayu7XTVCajhkf3z7rvBbNMW6f3aGWgOo0UcH+DpgncvJvQoUBQ7VJgeIJhhJHrXhTJ2D3/N761OiybGe9h/P5S5++bGUk50+cJTnGRorx1Of3TMquytgFNUNBlVXDP6s82WmtqVVKymek+iaVM9jaMjmP7/smOfDkmbl3b23Pzq2AG3dQk+FuXqTsw0nrRuA+tSPkIJiLSFth4XxUuDJCWxGguSXnApGKkGXn/9MZbvpIGA1x23ZYAD/GOxIa7lV/MS0CWSzyqnbcg//2z3+ZGT5+MlT9DZ8rDktJCjEBib19prctg2uGQYLpO8zNmDKpX/MyQvMMlMJ8MNcwto15bGwKUXy8H9OCRtgfh7cJxrWwBV8Nj6Z65F0K+D6FQ4+krcm5ggy9WBVmNXvrJkJejjIxwZY1EmE7CQbawFPKYxvTWxszsSk2xOF9qZBMYZeMRKqZpU1wLWmsSU45HZvgMmxJKYGMoQMiUkR45VUiK+2lTlOWCWmrEgxD5m3KvPnsXRc4ZFI6eBuSkKJWXLmbnQrtzdqaj+u6izCJUSAtLAYT4JY8E9ggh8mQMstIIbRNUGCI16QRp2tJucJ0j6XF70ElMHfpAuXq+t8qwB1+zfilLePvktNKmd5BpJiGOgE1mUwWXNrj9pyXTP9cRtgkJBTTQk7r2WOm0zIybrCJpPphMb30jZ0NN1fjSESslsRVIlYbKWTFxjFo1BC1sXs0NOfnY/Lb//4feQ1UcpKKidXWuJSQTeseUtPuaHbeiq06/sy1npbYM6mNkvKxzzShBINw3mW3zU7CCCQKX7VaVmnBHPpTTyZB6r+FTTyIUYtpbOIE745owZbeFrHPSx2OjrEhOPZx64od3jDAG0EYZCwGrqARC+y+PHpNrsiT3mYQNs7Be+z2xuvh872D4z2kBi3LSqzf2+xtmocHoXROeWMp0/lcNULPu7jGM+O6YXrdML1umF43TK8bptcN0+uG6XXD9Lphet0wvW6YXjdMk3XD9Lph+k/ifd0wvW6YXjdMrxum1w3T64bpdcP0umF63TC9bpheN0yvG6bXDdPrhul1w/S6YXrdMP3f1TDtCtkwKtwoMsp4o5jY1jyezrVRn4dBijWRO6fBzQ2+Bb+V2WyGnz+Xpg7s9DwMrqhkmOM25ZShLwPEyrlLmAY7wXObsu+e4PKh1XZTFTJXRYpVjHbGrtn1W2GbZZtHh8cnQRhErtU7FwnOkXSCbeB0YsvnnDBNpy81TXwZ5ePSFPIFFufMVuOn7bLHS1P26P5o1ANSPm1Q2K6HtGzgv8jU0gk3N7akcjar4O3QyhlOsB4at+98Npv9P3wTw70=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"}}');var s=t(74848),r=t(28453),a=t(33617),o=t.n(a),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzmuv8Ltl0xULdlSHE/GT8eTeDLKxpeNncnFdnnY3ZCacTfZIdmWFZeqzsP+wfmD/bT5klPgpS+62M5kdtZTq5fEaoIgAAIgCAI3gaZjFeycBieQFxnVoILzMEhAxZIVmgke7AQnKRA/TF5IOtKMj8nu0ZAAp1EGipQKpCJakFgCAsWl0iJnX3CUaI85JArkFc6likRZCYVkXCsyEpKMgYOkBnEi4jIHHJgwnZJCQgIjxiEhSssy1qUE1SNvC8GJKuMYlBqVmV2ZCU7EiNBqzZDoFAypEnQpuSKUlJx9LoF0OiL6BLEeJp0O+S4BxcacakiQOD/9giWPQzJJWZySmHISAbKaIKeOYGiQG1EcE9ysqQqI2YghsEPWI7tJwpBGmmXTkFDS6ZQy63QIU6SQ4oolkPjVxGiEIqVGtIRxDXJEYzCyAsTCx2YZj5xQnpARjVnGdFuMJGFKSxaVuHLvjJ/xE1bskLdFJmhCpqKU5OjFTzW4FgS/nXY6LyAqx+TtsNM5/y7VulA7Gxu0KHqiAI7SymikerHINxIELJKRkRVIQKxGXkAVy6aEJgmZsGQMWpkN4SQWxZTEQsiEcasaBR0D4WUegVSh4SYXEgjjhBIJNJl2teiWCsir48MDFENOdY8cZaUKq+USJiHW2dSiR/F4rh7Z3dneQh1ifBySnF6ilJgmn0sWXyLbCrjZWqcyRladzjukt5IOU07HE0J0yhSZQJQKcUngCocnLMuIlmw8BtnpnPFff/31jN+ccULOAgNxFuyQs8ChOAtCO6SnBdiRF4fP3+7vHZxcnHw42qvGvabOwQxfVBAjls1jePvmdTXMaT4/fLC7Xy/AhXbjRxlQBUTCFYOJ2Qfcasurl0I1reEn7OxqBCeBVPj1FL8QcmP/a1NzPHx5sPemSYuFgJyyrAWyt787fN2CKVLB22iOfj48aOMpZQPL8OClFYodn+F/545etyO7boNOhvt7xye7+0cIPHP7iNpwXBaFkLj976xC7+A2n/EfIRMTQiUY7YlFngtOCippDtr4xpRqMyzhc8kkJNa50SzzlrFzxruk00FV2Ol0yJAnLEbTsGY+LQA9m4XtWVA0GQQ9dq7GgjYMCX2RdSdoIRNqrbvI0JEgqAT0UppdQRvxdUimiPgFoF5YtKmQ7IvgmmZGKa5AahbTrGnESKBxfZpK44IKwbj2X90K5IMzVrRlY6LOyyBpCQorZ9yMKCBXNCtBOaomIUmRqjdQSFDG4zq8KEiekBTYOF25Hk0+lUq3EJNSeT/qqXBr+V0y4gUjthHNFBA2askyp5fQWI2Iwvr3HvlxShIY0TLTIWHof7QsoUcOhCa0KDIWm7MR3bk9eEoJXbPLTh0cIWgqSMSRPR/wREgYng3obXDQoHBzPHWoZ/ZAQfaMH9Up5UTwuY2ORSbkogqZz205klhwDVz3yO4VZZkh3jKrCONxViZAoozGl6E52UMi8SzDXZlClolJaPXdgJgT1sjcyIcoyFALBUf6uXDLM1WfoT1ygv6nsicc9KI2izDVlKrz4SOBK6MIvIkR41dCI7iQfBIR0UxnEKLBFpRPQ5LYoAGudSSuQxKnEF+avyRNmCBRqbXglrFEiiIRE+5kORJcK/ZliUX6ka+X6CAkWyHZDsmzkPQ3Q9IfhKS/FZL+dkj6z0Iy2AzJYBCSwVZIBtuWrMEzJ2taCbhJQH9gpaz/OtJFv/uaKWPZ6DBV5YMnLR/c75FOp7Km+eO3PmMrkOq0Qp+JY333+xp/PBl8735O8ef24Jn7OTGg/S33M8Wfg37znBgYSjTNi1uowOE/lAIfLFglwm/uzD0LvD/Dj+iIQj9QH8WOHhyYNXl5grwwzjSjmVrNjod4QBzVJC0wtYVMGXVdzZGLQR4MO016TMiCbtIOGbfaGPIGb6gYLHD/tOdOltXM22UfDO8Ncr6N9W1kHV3TCbqm1fxX3usBCWGepm+TxPc9EwAYz7xaDg7gAUmhTdG3yeAZygAPpdUCwNEHxH2DHHsBMye8Hdvc6vafdgebg62WBPCmbAHyvJsk3el0+kdID2MetzyGPD5CtZEdZiRGUuRLrh/mdlBDuZjI/O1D9n0M1COokiKYBWjnVPz9vxlla5HQ6SNlUfmpVXCG8HVoNm2QaYaQDpMLiVPBYkc8wviQLMILXg9l0DWS3EiSjYYk8WOSdPO8O/cRf3aN4Bsf87yXJL05yIXdsR9zkiQhWfy89HuSkDzPV3y2388CE1L9gKrvIrHV2u8A/iwDqPW8vfCtxoHZIcEzs7a5pC23jrkjJGU+GeNUhcwBSBiXGZVwjbdNNZ/h+AMtxxtOHa+b26m52NkUnxEF+e7QxeSPnVIjC20E+OXueQucNZFIGMO1wWGTuEgMS0xqNcR8a4q3N+pDf5R7nbUzv2JaMMwSZKC1+Qo67i0jwu5a44aNuzp/wVagW8xQRfzMJXdss/1Gvfub5nhzF4xbzjcH8YBc/BxJOGjTFTaZFuTURACoZVD/LXQK8iw4r+bYWzUkd8w9v4cdpSyBjEaQLQ7d2waavDh9aggGB3LGq0yAoXezkcjL6fXc4FmdxJuzLctxU6m9E/em4UVMMqZ8LqQtr+ZslywyKTwONv0fAfETSFSp4TereUXY/fTcegG3OXcsgXDEAFaJOr/aHSu0NqYpGMSRM87yMq8yjqMKqxdZ7k7zprxwJr5s+BWau7uwAr2+YwX3NLNigTPeN5kBn1G4JdZzEA/IGcyRdLud/h430Toj/6DD7W4D9Gw1DXDJkYig9jCsjE+ttr4eOcQDCLOcdhLmreIYCo05rm81zYrkex9BJgvUzGyt1rwm1APSviVk/Zs10MH9OVrYZO8vpIktsu+tjTaPl9PxLZddM/yA9M/RM7e5QRiIwlQLCD5Mgp0gwZoE/xIehAYzKP2jSKbBzk3gEu34p0tj48yNTwqrG24CFaeQU/zLU4T1EPigGoT+HTMIA5N5weIIFFew495kgxDvDwW+hoFCHGbezo2Hss/NQeju4cFOYN+hgzCAa5oXCOw+EeCxwNtukYyCmV/wNlTVlxqVMn9UZQGIB9/wficaM3U2Vw/yuzA1McxqsdbIqJR0GsyXnvjHO39Hs/Oq14ls6m2EabSE6kXJgAVhwDTkzVVWbJoUXy/pGARyYrKyXzvXbAvNv3pNnGeevX/PRPdYskTm95SSHV1cuL1lu3g3hMRHzd36fTMk5o2hd5fGeHjDLR0317Qx4MKaJ6vevRvPbSoVZZbgQxZQ2TPPz7+7zsWUOtEsLk3pTXU2tDirSK0468/C4PpuZq5JLLr+UZ18l8FIk7IoQJJYSA7ycTOz9mCYG2xtzcJgejd7078ke9/j5k3u5u6dqUaoKzX+E7Q+eTYLg/RuWn+u6iX+g8Rubc/qs86V4VTld5FIphfeb83uAvSHCsJhLdeQH8oEZEMQkRAZUL4gieHIBleCPMJI5JFLZZlnbiaVP1BseZeEGLBkxmSkva8iLuawb+DEPT1iTLaHH0ysqMpIIRT3+JRFGIEvGcMaRwvBbI2gecgHGqdYnKYtVXSEb/Sm1AertESpPHkpVeatPQMMR3UKzFaXMD5ux4YN6Zg6iybvvebu4Bc85Eyd5+HJ0T1kaSLXri0Ys+e05dLiIIcnR1g8xEYuDOuRt6qShBctbYEQDIvIFaO+wKDy7VObXABuJCJ8qVpd99dzZTtdskhQwtRSisI6vVnVtS4grmsNcYtEqbHI0RV3EqWhUC05GioqQZ6I8j5aeYckKRmX5nVEo8n6SiKTcq2Lfxi3RbPm3pOU0tc7ObVASKygreXkpYJADfwhAa7sdEpGVGmQIVbSouRlifeaCiVcFyAZ8BiWikCCFd1FKZfGTW0ZtCtp3r557SpMPQ/eKCO0QIsYElIWRmuMJVQVXn7n5llfCJTQOkBerArQFkMPU4flcmoFSIVVyJIIOaacfXFVyRiRCAUkgpRmFtS5CnxbQnrQwtvEeF/72z//1aBrZcS5SJhdgSYJJvrvoNDca63CY8QtoUAPKNoUIT6Q/zN/CCB1xmgucpFUhqTur+NHWPanVeUXtTBFw5CBLa32Dw+Vv1Wh97HKhZX4/iDNO4EpwRYF8gvXTOlGjZJ/SVz0D28A5Rg3aDBhCFo16jyfNg28osvVQtXoTCUVa9e3Vcfggi3QUosLCTnj9zunmskBLSpHUGqRU81i4lGpXrtqEUsra7vOsdzdkobaeMWEfLzCVBHdheAxXDB+AVcg7xHgHVR52oROUbn1BIA3afNCssdZXVk2wVLrlkwap5Opn2xS+fSOeMAGDPWd3p1lWPQquLJXmsHmJv43Zzm+pt5XetdtBtn0b0F4/4TC7fcpX9W9zJZrk/sxHfysCp7HKVrZCqdZg98eqzUTJRswfZVGL2N2yF4N334Z9g/YUA35m6fx8+H28LJ4/8vzVz/0YPqqHw9+mb4f/KI/vMvU8JNg8c+v0o/8FxU9f1p+eP9Rfng/lB/evdH03dPdiKc8evkTi6dPP0WDTfb6+avNj+/6k+jlT5sff/mh+GiQ/7T58fJyM84Pnkd8F2GKD+//wQ4/7T3Z/7L3Zf9k73r/S/ZDjx58/vT8Ov5h/3Jvu/txKLv7h9HfP33WxZunyZOD92z7GezDO36y+ToOmtrAeMY4XPitvjB8X+Bmz4xSbC3b9mORg06NszCl/FJgn0Bh6+G1nBI6powTFJ38A7UApBTy9j39OspuE8TW5uZFvxLC00UhDLl5nzMtMyfiEvify2lzeW2XR1Kvc6P19kQOmAUy40GL2eZ3y6SCuJRMT4Od05vguksL1rXjO6fns/MwQMEKzCEWQhmKqU6DnWBjPqWInUsmYXV6Y22wMjRFeYJvaAvGRgu2cdUPZuH8jKWmuRIayu7XTVCajhkf3z7rvBbNMW6f3aGWgOo0UcH+DpgncvJvQoUBQ7VJgeIJhhJHrXhTJ2D3/N761OiybGe9h/P5S5++bGUk50+cJTnGRorx1Of3TMquytgFNUNBlVXDP6s82WmtqVVKymek+iaVM9jaMjmP7/smOfDkmbl3b23Pzq2AG3dQk+FuXqTsw0nrRuA+tSPkIJiLSFth4XxUuDJCWxGguSXnApGKkGXn/9MZbvpIGA1x23ZYAD/GOxIa7lV/MS0CWSzyqnbcg//2z3+ZGT5+MlT9DZ8rDktJCjEBib19prctg2uGQYLpO8zNmDKpX/MyQvMMlMJ8MNcwto15bGwKUXy8H9OCRtgfh7cJxrWwBV8Nj6Z65F0K+D6FQ4+krcm5ggy9WBVmNXvrJkJejjIxwZY1EmE7CQbawFPKYxvTWxszsSk2xOF9qZBMYZeMRKqZpU1wLWmsSU45HZvgMmxJKYGMoQMiUkR45VUiK+2lTlOWCWmrEgxD5m3KvPnsXRc4ZFI6eBuSkKJWXLmbnQrtzdqaj+u6izCJUSAtLAYT4JY8E9ggh8mQMstIIbRNUGCI16QRp2tJucJ0j6XF70ElMHfpAuXq+t8qwB1+zfilLePvktNKmd5BpJiGOgE1mUwWXNrj9pyXTP9cRtgkJBTTQk7r2WOm0zIybrCJpPphMb30jZ0NN1fjSESslsRVIlYbKWTFxjFo1BC1sXs0NOfnY/Lb//4feQ1UcpKKidXWuJSQTeseUtPuaHbeiq06/sy1npbYM6mNkvKxzzShBINw3mW3zU7CCCQKX7VaVmnBHPpTTyZB6r+FTTyIUYtpbOIE745owZbeFrHPSx2OjrEhOPZx64od3jDAG0EYZCwGrqARC+y+PHpNrsiT3mYQNs7Be+z2xuvh872D4z2kBi3LSqzf2+xtmocHoXROeWMp0/lcNULPu7jGM+O6YXrdML1umF43TK8bptcN0+uG6XXD9Lphet0wvW6YXjdMk3XD9Lph+k/ifd0wvW6YXjdMrxum1w3T64bpdcP0umF63TC9bpheN0yvG6bXDdPrhul1w/S6YXrdMP3f1TDtCtkwKtwoMsp4o5jY1jyezrVRn4dBijWRO6fBzQ2+Bb+V2WyGnz+Xpg7s9DwMrqhkmOM25ZShLwPEyrlLmAY7wXObsu+e4PKh1XZTFTJXRYpVjHbGrtn1W2GbZZtHh8cnQRhErtU7FwnOkXSCbeB0YsvnnDBNpy81TXwZ5ePSFPIFFufMVuOn7bLHS1P26P5o1ANSPm1Q2K6HtGzgv8jU0gk3N7akcjar4O3QyhlOsB4at+98Npv9P3wTw70=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.f2e37798.js b/assets/js/0028a090.f2e37798.js deleted file mode 100644 index cc3c0ec91..000000000 --- a/assets/js/0028a090.f2e37798.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>f,default:()=>y,frontMatter:()=>g,metadata:()=>i,toc:()=>x});const i=JSON.parse('{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/drafttemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/drafttemplate","permalink":"/docs/API-docs/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9122zbSr4LlTRodSrYUx019tW7ipsrGPxs7zY/tk0LkSERMAgwAWlZ8dLdPso+2T7JnBgBFSZbttP267vl0k1jEAJgZzB8GM9eR5SMT7ZxGJ1CUObdgovM4SsEkWpRWKBntRCcZsDDMXmg+tEKO2O5Rn4HkgxwMqwxow6xiiQYESipjVSG+4iizYeWYGdCXOJcbNsgrKLWQ1rCh0mwEEjSnhVOVVAXgwFjYjJUaUhgKCSkzVleJrTSYDntbKslMlSRgzLDK3c5CSaaGjNd7xsxmQKhqsJWWhnFWSfGlAtZqqcFnSGw/bbXYdykYMZLcQorIhemfRPo4ZuNMJBlLuGQDQFJTpNQjDA10BxzHlKQ9TQmJGAoE9ot12G6aCsSR5/kkZpy1WpXOWy0mDCu1uhQppGE3NRwiSzmxlglpQQ95AsQrwFXkiLYJizMuUzbkiciFnWcjS4WxWgwq3LlzJs/kiSh32NsyVzxlE1VpdvTipxm4VQy/nbZaL2BQjdjbfqt1/l1mbWl2NjZ4WXZUCRK5lfOB6SSq2EgRsEyHxCvQgKsSv4AbkU8YT1M2FukIrKEDkSxR5YQlSulUSCcaJR8Bk1UxAG1ioqZQGpiQjDMNPJ20rWpXBtir48MDZEPBbYcd5ZWJ6+1SoSGx+cQtj+wJVD1yp7O9hTIk5ChmBb9ALgnLvlQiuUCyDUg6Wi8yxKtW6x3iW3NHGC/jKWM2E4aNYZApdcHgEofHIs+Z1WI0At1qnclff/31TF6fScbOIoI4i3bYWeSXOItiN2QnJbiRF4fP3+7vHZx8OvlwtFePB0ldgOm/qCGGIl9c4e2b1/Ww5MXi8MHu/mwDqawfP8qBG2AaLgWM6RzwqB2tgQv1tIadcLPrEZwE2uDXU/zC2LX7bx6b4/7Lg703TVwcBBRc5HMge/u7/ddzMGWm5PwyRz8fHsyvU+nGKv2Dl44pbnyK/517fP2J7PoDOunv7x2f7O4fIfDUnyNKw3FVlkrj8b9zAr2Dx3wmf4RcjRnXQNKTqKJQkpVc8wIs2caMWxrW8KUSGlJn3HieB83YOZNt1mqhKOy0WqwvU5Ggajg1n5SAls3BdhwoqgyCHntT40AbioS2yJkT1JAxd9pd5mhIEFQDWikrLmF+4auYTXDhF4By4ZbNlBZflbQ8J6G4BG1FwvOmEiOCZPos12SCSiWkDV/9DuyDV1bUZVJRb2UQtRSZVQhJIwbYJc8rMB6rccwyxOoNlBoMWVy/LjJSpiwDMcpW7sfTz5WxcwuzygQ7GrDwe4VTIvYCsW3IcwNMDOd4WfALaOzGVOnse4f9OGEpDHmV25gJtD9WV9BhB8oyXpa5SMg3ojl3jqfS0KZT9uLgEUFVQSSOnH9Aj5AK9A1obXCQlvBzAnYoZ86hIHlkR23GJVNy4aATlSu9LEL0eZ6PLFHSgrQdtnvJRU7IO2INEzLJqxTYIOfJRUyePWYafRmeygTyXI1jJ+8EQh6WeE78YQZylEIlEX+p/PbCzHxoh52g/an1CQcDq2kTYZpc9TZ8qHBnZEFQMUZ2JSbGxeyzGjArbA4xKmzJ5SRmqQsa4MoO1FXMkgySC/pL81QoNqisVdIRlmpVpmosPS+HSlojvt6gkWHk2znai9lWzLZj9ixm3c2YdXsx627FrLsds+6zmPU2Y9brxay3FbPetkOr98zzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnR/c58bA1Seyu0mTjW9b+v8MeT3vf+5wR/bvee+Z9jAu1u+Z8Z/ux1m36iR5hYXpS3YIHDfygGIVhwQoTfvM89i4I9w49oiOIwMHPFHh8cmDZpeYK0CCms4LlZTU6AeEAUzVBaImoLiSJxXU2Rj0EeDDlNfChkQTPphsisNoaCwhMWvSXqn3a8Z1lNvNv2wdDeQOf3kb6NpKNpOkHTtJr+2no9ICYs4vT7OPF9hwIAssyr+eABHhAX5jH6fTx4hjxAp7SaATj6gKhvoOMuYOTh3djmVrv7tN3b7G3NcQBvyg6gKNpp2p5MJn8E9zDm8dtjyBMiVBfZYUZiqFVxw/WDbgczKB8T0d8hZN/HQH0AdVIEswDzOZVw/29G2ValfPLIuKXC1Do4Q/hZaDZpoElDiAflQpJMicQjjzAhJBvgBa+DPGgTJzfSdKPBSfyYpu2iaC98xJ9tYnzjY1F00rSzALl0Ou5jwdI0Zsufb/yepqwoihWf3feziEKqH1D0fSS2Wvo9wJ+lADM5n9/4VuXA7JCSOe1Nl7SbtWPBhWQiJGO8qLAFAA2jKucarvC2aRYzHH+g5gTFmcXrdDuli51L8REr2HeHPiZ/7IUaSZhfAL/cPW+JsuYiGkZwRWu4JC4iI1JKrcaYb83w9sZD6I98n2Xt6FfCS4FZghyspa9gk85NSLhTa9yw8VQXL9gG7Bwx3LAw84Y7Nh0/iXd3k9ybv2Dc4t88xAMy8Qso4aBLV7hkWlRwigBQymD2t7IZ6LPovJ7jbtWQ3jH3/B56lIkUcj6AfHno3jrQpMXLU4MxOFAIWWcCCN/NRiKv4FcLg2ezJN6CbjmKm0IdjHhQjcBilgsTciHz/GrO9skiSuFJcOn/AbAwgQ1qMfzdYl4jdj85d1bAH84dWyAcI8A6URd2u2OHuYNpMgbXKIQURVXUGcdhvWpgWeG9eZNfOBNfNsIOzdNd2oFf3bGDf5pZscGZ7FJmIGQUbon1PMQDMgYLKN2up7/FTMz5yD/Iud2tgIGspgLe4BIR1DnDWvnMau3rsEN0QJjldJMwb5UkUFrMcf1e1axRvrcLoixQM7O1WvKaUA9I+m5A6/9YAj3cnyOFTfL+QpI4h/a9pdHl8Qo+uuWyS8MPSP48PguHG8WRKqlaQMl+Gu1EKdYkhJfwKKaVwdgfVTqJdq4jn2jHP30aG2dufDZY3XAdmSSDguNfASOsh8AH1SgO75hRHFHmBYsjkF3Rjn+TjWK8P5T4GgYG16B5O9cByj03R7G/h0c7kXuHjuIIrnhRIrD/xEAmCm+7ZTqMpmHD25aqv8yWMvRHXRaA6+Ab3m9chqZOF+pBftNKzRWmM7bOFuNa80m0WHoSHu/CHc3Nq18n8knQEWFRE+oXJQKL4khYKJq7rDg0rb6d0wkopISyst86l46FF9+8J86jZ+/fMtE/ltzA83tyyY0ubzx/ZLt4N4Q0RM3t2ftmzOiNoXOXxAR4opaPmnu6GHBpz5NV796N5zaTqSpP8SELuO7Q8/NvrnOhUieeJxWV3tS+YY6yGtWasu40jq7uJuaKJaodHtXZdzkMLavKEjRLlJagHzczaw+GuN7W1jSOJneTN/lLkvc9Ht74bureUTXCrFLjf4Hrk2fTOMruxvXnul7if4js1vZ05ut8GU5dfjdQ6eRTsFvTuwCDU0E4rOXqy0Odgm4wYqBUDlwucaI/dMGVYo8wEnnkU1n0zC20CQ7FlXdpSABLZigjHWwV8zGHewNn/ukRY7I9/ECxoqkGBqFkWM+4BQcQSsawxtFBCFcjSA/5wJMMi9Osw4oP8Y2eSn2wSktVJqCXcUNv7TlgOGozEK66RMjRfGzY4A7VWTRp7zRPB7+gk6M6z8OTo3vwkiLXtisYc37aUenWYIcnR1g8JIY+DOuwt6bmRGAtnwNhGBaxS8FDgUFt2ycuuQCSOKJCqdqs7q/jy3babBmhVJgbMYpn6c26rnVp4VmtIR6RqiwWOfriTmYslGaOj4RFzcgTVd1HKu/gJGejil5HLKpsqCSilOus+EdIVzRL95600qHeyYsFQmIF7YxPgSsI1Fg/ZiCNm87ZkBsLOsZKWuS8rvBeUy8JVyVoATKBG1mgwbHuU6VvjJvmeTBfSfP2zWtfYRpoCEo5QA10C0PKqpKkhjShrvAKJ7dI+lKghNoB+tOqAG059KA6LJ9TK0EbrELWTOkRl+Krr0rGiEQZYAPIeO5AvanAtyXEBzV8Hplga//zr3838FoZcS4j5nbgaYqJ/jswpHutE3iMuDWUaAHVPEa4Hui/LzoBxI6U5lOh0lqRzP1l/AjL/qyp7aJVVDQMObjS6vDwUNtbEwcba3xYie8Pmt4JqARblUgvXAljGzVK4SVx2T68AeRj0sCBwhDUapR5OWkqeI2Xr4WaLUeVVGK+vq12gwu6cLs7c/5udiX1phhrNpU0LiLvbW7ifwsHH0rCQ6HyrEo+n/wtiu9/H779OhCKkm8SxZnE/Jj1fjalLJIMhWSFzs/Abw81mvf8DZi8ygYvE3EoXvXffu13D0Tf9OWbp8nz/nb/onz/y/NXP3Rg8qqb9H6ZvO/9Yj+8y03/sxLJz6+yj/IXM3j+tPrw/qP+8L6vP7x7Y/m7p7sDmcnBy59EMnn6edDbFK+fv9r8+K47Hrz8afPjLz+UH2nxnzY/XlxsJsXB84HcRZjyw/t/isPPe0/2v+593T/Zu9r/mv/Q4QdfPj+/Sn7Yv9jbbn/s6/b+4eAfn7/Y8s3T9MnBe7H9DPbhnTzZfJ1ETWkQMhcSPoWj/kR0f8LDnpJQbN107MeqAJuRrFMlulZY5l66cm6rJ4yPuJAMWaf/QCkArZW+/Uy/DbPbGLG1ufmpWzPh6TIT+pKel6jj40RdgPxzKW1ub932iOpVQVLvHEokHBCNR3PENr87Ig0klRZ2Eu2cXkdXbV6KthvfOT2fnscRMlZhCqxUhjDmNot2oo3FjBg23lC+5fTa6WCtaIbLFJ+AlpSNl2LjshtN48UZN6rmSmio2t82wVg+EnJ0+6zzGWuO8fjcCc0xaJblKMU/ANMcnv9NqDgSKDYZcLwoIMdRKt7M8od74WxDZu+mZN3sDBfTbyH7NpdQW/SBN6TIGhmy05CeooxTnXCKZgRFdVII/6zTPKczSa0zKiGh0qVMRG9ri67s33fpbvvkGV0bt7an547BjSsUJWib9wCX958LaP2n+QAvihYCqrmoZjGoWRlgrIgvQlAp5FDRkftzOCxBHmPMjpp42V2+pkOeqKKuZQ7g//nXv2lG8Oe0zd/YYaVZqcagsdGMGq1yuBIYJSMwIWYoC0lJel7kYAymJqWFkesREyOqiQihZ8JLPsBWLQxshbTK1R41rJPpsHcZ4FMJDj3SrjzkEnK0SCxXirqXMEyqrCqafWhsrPTFEFHCFrMBtjhg8GcAwhSQGZcJPlw4DaLACbu1MJgvtTDAuCgQmLrNhkORCFwY7ajmiWUFl3xEEVBM6QLkQhkaFLQa4J3MqLxytw5skwCwjkR6OOmwF3jLI8LxYwoWjz11Fw4TuwufN6u+G2yAl+sStxcJmFkhWQ6XoMliuOt6leesVNZdoTEEbJ4tLmQ1lwYTEg6hcDQ1+/y1gPZI+aTD8PUEXRgGxygAuZAXrlvntBazdzAwwsIsVTIej5es1+P5OS+FzaoBBtpqNm9EH8nWNafXPx5H8aKZm5dsDUPQSI2Z61LkpXAeiZ3uHvXJNbIM8nK2M065IeRSidlAwI1jsBhJm40w/zE6L5QJnpBvDSrMS3HjBQFbe8zh8Bh7QJMQ661g1QYBb0RxlIsEpIGG/9x9efSaXbInnc0obviOezBv43X/+d7B8R5ig+7Qcazb2exsUq5ZGVtw2diKml3r3tdFK9J4WVr3yK57ZNc9suse2XWP7LpHdt0ju+6RXffIrntk1z2y6x5Ztu6RXffI/km0r3tk1z2y6x7ZdY/sukd23SO77pFd98iue2TXPbLrHtl1j+y6R3bdI7vukV33yK57ZP9/9cj64i+MCjfKnAvZKMB1dYKnC52z53GUYR3hzml0fY1vwW91Pp3i5y8VaCxCPI+jS64F5ripBDEOpXNYbXYBk2gneu5S9u0T3D520k5VIQuVl1j552bs0qnfCtssdTw6PD6J4mjgu3sLleIczcfY+cvHruTMM5OaOzn1beVcjioqfovcmljtxyubzZcKXlCpoP+jUUPH5aSB4XwNoSMD/0Wibpxwfe3KEKfTGt4NrZzhGRug8fjOp9PpfwG+AwMD","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"}}');var s=t(74848),r=t(28453),l=t(33617),a=t.n(l),o=t(17543),d=t.n(o),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9122zbSr4LlTRodSrYUx019tW7ipsrGPxs7zY/tk0LkSERMAgwAWlZ8dLdPso+2T7JnBgBFSZbttP267vl0k1jEAJgZzB8GM9eR5SMT7ZxGJ1CUObdgovM4SsEkWpRWKBntRCcZsDDMXmg+tEKO2O5Rn4HkgxwMqwxow6xiiQYESipjVSG+4iizYeWYGdCXOJcbNsgrKLWQ1rCh0mwEEjSnhVOVVAXgwFjYjJUaUhgKCSkzVleJrTSYDntbKslMlSRgzLDK3c5CSaaGjNd7xsxmQKhqsJWWhnFWSfGlAtZqqcFnSGw/bbXYdykYMZLcQorIhemfRPo4ZuNMJBlLuGQDQFJTpNQjDA10BxzHlKQ9TQmJGAoE9ot12G6aCsSR5/kkZpy1WpXOWy0mDCu1uhQppGE3NRwiSzmxlglpQQ95AsQrwFXkiLYJizMuUzbkiciFnWcjS4WxWgwq3LlzJs/kiSh32NsyVzxlE1VpdvTipxm4VQy/nbZaL2BQjdjbfqt1/l1mbWl2NjZ4WXZUCRK5lfOB6SSq2EgRsEyHxCvQgKsSv4AbkU8YT1M2FukIrKEDkSxR5YQlSulUSCcaJR8Bk1UxAG1ioqZQGpiQjDMNPJ20rWpXBtir48MDZEPBbYcd5ZWJ6+1SoSGx+cQtj+wJVD1yp7O9hTIk5ChmBb9ALgnLvlQiuUCyDUg6Wi8yxKtW6x3iW3NHGC/jKWM2E4aNYZApdcHgEofHIs+Z1WI0At1qnclff/31TF6fScbOIoI4i3bYWeSXOItiN2QnJbiRF4fP3+7vHZx8OvlwtFePB0ldgOm/qCGGIl9c4e2b1/Ww5MXi8MHu/mwDqawfP8qBG2AaLgWM6RzwqB2tgQv1tIadcLPrEZwE2uDXU/zC2LX7bx6b4/7Lg703TVwcBBRc5HMge/u7/ddzMGWm5PwyRz8fHsyvU+nGKv2Dl44pbnyK/517fP2J7PoDOunv7x2f7O4fIfDUnyNKw3FVlkrj8b9zAr2Dx3wmf4RcjRnXQNKTqKJQkpVc8wIs2caMWxrW8KUSGlJn3HieB83YOZNt1mqhKOy0WqwvU5Ggajg1n5SAls3BdhwoqgyCHntT40AbioS2yJkT1JAxd9pd5mhIEFQDWikrLmF+4auYTXDhF4By4ZbNlBZflbQ8J6G4BG1FwvOmEiOCZPos12SCSiWkDV/9DuyDV1bUZVJRb2UQtRSZVQhJIwbYJc8rMB6rccwyxOoNlBoMWVy/LjJSpiwDMcpW7sfTz5WxcwuzygQ7GrDwe4VTIvYCsW3IcwNMDOd4WfALaOzGVOnse4f9OGEpDHmV25gJtD9WV9BhB8oyXpa5SMg3ojl3jqfS0KZT9uLgEUFVQSSOnH9Aj5AK9A1obXCQlvBzAnYoZ86hIHlkR23GJVNy4aATlSu9LEL0eZ6PLFHSgrQdtnvJRU7IO2INEzLJqxTYIOfJRUyePWYafRmeygTyXI1jJ+8EQh6WeE78YQZylEIlEX+p/PbCzHxoh52g/an1CQcDq2kTYZpc9TZ8qHBnZEFQMUZ2JSbGxeyzGjArbA4xKmzJ5SRmqQsa4MoO1FXMkgySC/pL81QoNqisVdIRlmpVpmosPS+HSlojvt6gkWHk2znai9lWzLZj9ixm3c2YdXsx627FrLsds+6zmPU2Y9brxay3FbPetkOr98zzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnR/c58bA1Seyu0mTjW9b+v8MeT3vf+5wR/bvee+Z9jAu1u+Z8Z/ux1m36iR5hYXpS3YIHDfygGIVhwQoTfvM89i4I9w49oiOIwMHPFHh8cmDZpeYK0CCms4LlZTU6AeEAUzVBaImoLiSJxXU2Rj0EeDDlNfChkQTPphsisNoaCwhMWvSXqn3a8Z1lNvNv2wdDeQOf3kb6NpKNpOkHTtJr+2no9ICYs4vT7OPF9hwIAssyr+eABHhAX5jH6fTx4hjxAp7SaATj6gKhvoOMuYOTh3djmVrv7tN3b7G3NcQBvyg6gKNpp2p5MJn8E9zDm8dtjyBMiVBfZYUZiqFVxw/WDbgczKB8T0d8hZN/HQH0AdVIEswDzOZVw/29G2ValfPLIuKXC1Do4Q/hZaDZpoElDiAflQpJMicQjjzAhJBvgBa+DPGgTJzfSdKPBSfyYpu2iaC98xJ9tYnzjY1F00rSzALl0Ou5jwdI0Zsufb/yepqwoihWf3feziEKqH1D0fSS2Wvo9wJ+lADM5n9/4VuXA7JCSOe1Nl7SbtWPBhWQiJGO8qLAFAA2jKucarvC2aRYzHH+g5gTFmcXrdDuli51L8REr2HeHPiZ/7IUaSZhfAL/cPW+JsuYiGkZwRWu4JC4iI1JKrcaYb83w9sZD6I98n2Xt6FfCS4FZghyspa9gk85NSLhTa9yw8VQXL9gG7Bwx3LAw84Y7Nh0/iXd3k9ybv2Dc4t88xAMy8Qso4aBLV7hkWlRwigBQymD2t7IZ6LPovJ7jbtWQ3jH3/B56lIkUcj6AfHno3jrQpMXLU4MxOFAIWWcCCN/NRiKv4FcLg2ezJN6CbjmKm0IdjHhQjcBilgsTciHz/GrO9skiSuFJcOn/AbAwgQ1qMfzdYl4jdj85d1bAH84dWyAcI8A6URd2u2OHuYNpMgbXKIQURVXUGcdhvWpgWeG9eZNfOBNfNsIOzdNd2oFf3bGDf5pZscGZ7FJmIGQUbon1PMQDMgYLKN2up7/FTMz5yD/Iud2tgIGspgLe4BIR1DnDWvnMau3rsEN0QJjldJMwb5UkUFrMcf1e1axRvrcLoixQM7O1WvKaUA9I+m5A6/9YAj3cnyOFTfL+QpI4h/a9pdHl8Qo+uuWyS8MPSP48PguHG8WRKqlaQMl+Gu1EKdYkhJfwKKaVwdgfVTqJdq4jn2jHP30aG2dufDZY3XAdmSSDguNfASOsh8AH1SgO75hRHFHmBYsjkF3Rjn+TjWK8P5T4GgYG16B5O9cByj03R7G/h0c7kXuHjuIIrnhRIrD/xEAmCm+7ZTqMpmHD25aqv8yWMvRHXRaA6+Ab3m9chqZOF+pBftNKzRWmM7bOFuNa80m0WHoSHu/CHc3Nq18n8knQEWFRE+oXJQKL4khYKJq7rDg0rb6d0wkopISyst86l46FF9+8J86jZ+/fMtE/ltzA83tyyY0ubzx/ZLt4N4Q0RM3t2ftmzOiNoXOXxAR4opaPmnu6GHBpz5NV796N5zaTqSpP8SELuO7Q8/NvrnOhUieeJxWV3tS+YY6yGtWasu40jq7uJuaKJaodHtXZdzkMLavKEjRLlJagHzczaw+GuN7W1jSOJneTN/lLkvc9Ht74bureUTXCrFLjf4Hrk2fTOMruxvXnul7if4js1vZ05ut8GU5dfjdQ6eRTsFvTuwCDU0E4rOXqy0Odgm4wYqBUDlwucaI/dMGVYo8wEnnkU1n0zC20CQ7FlXdpSABLZigjHWwV8zGHewNn/ukRY7I9/ECxoqkGBqFkWM+4BQcQSsawxtFBCFcjSA/5wJMMi9Osw4oP8Y2eSn2wSktVJqCXcUNv7TlgOGozEK66RMjRfGzY4A7VWTRp7zRPB7+gk6M6z8OTo3vwkiLXtisYc37aUenWYIcnR1g8JIY+DOuwt6bmRGAtnwNhGBaxS8FDgUFt2ycuuQCSOKJCqdqs7q/jy3babBmhVJgbMYpn6c26rnVp4VmtIR6RqiwWOfriTmYslGaOj4RFzcgTVd1HKu/gJGejil5HLKpsqCSilOus+EdIVzRL95600qHeyYsFQmIF7YxPgSsI1Fg/ZiCNm87ZkBsLOsZKWuS8rvBeUy8JVyVoATKBG1mgwbHuU6VvjJvmeTBfSfP2zWtfYRpoCEo5QA10C0PKqpKkhjShrvAKJ7dI+lKghNoB+tOqAG059KA6LJ9TK0EbrELWTOkRl+Krr0rGiEQZYAPIeO5AvanAtyXEBzV8Hplga//zr3838FoZcS4j5nbgaYqJ/jswpHutE3iMuDWUaAHVPEa4Hui/LzoBxI6U5lOh0lqRzP1l/AjL/qyp7aJVVDQMObjS6vDwUNtbEwcba3xYie8Pmt4JqARblUgvXAljGzVK4SVx2T68AeRj0sCBwhDUapR5OWkqeI2Xr4WaLUeVVGK+vq12gwu6cLs7c/5udiX1phhrNpU0LiLvbW7ifwsHH0rCQ6HyrEo+n/wtiu9/H779OhCKkm8SxZnE/Jj1fjalLJIMhWSFzs/Abw81mvf8DZi8ygYvE3EoXvXffu13D0Tf9OWbp8nz/nb/onz/y/NXP3Rg8qqb9H6ZvO/9Yj+8y03/sxLJz6+yj/IXM3j+tPrw/qP+8L6vP7x7Y/m7p7sDmcnBy59EMnn6edDbFK+fv9r8+K47Hrz8afPjLz+UH2nxnzY/XlxsJsXB84HcRZjyw/t/isPPe0/2v+593T/Zu9r/mv/Q4QdfPj+/Sn7Yv9jbbn/s6/b+4eAfn7/Y8s3T9MnBe7H9DPbhnTzZfJ1ETWkQMhcSPoWj/kR0f8LDnpJQbN107MeqAJuRrFMlulZY5l66cm6rJ4yPuJAMWaf/QCkArZW+/Uy/DbPbGLG1ufmpWzPh6TIT+pKel6jj40RdgPxzKW1ub932iOpVQVLvHEokHBCNR3PENr87Ig0klRZ2Eu2cXkdXbV6KthvfOT2fnscRMlZhCqxUhjDmNot2oo3FjBg23lC+5fTa6WCtaIbLFJ+AlpSNl2LjshtN48UZN6rmSmio2t82wVg+EnJ0+6zzGWuO8fjcCc0xaJblKMU/ANMcnv9NqDgSKDYZcLwoIMdRKt7M8od74WxDZu+mZN3sDBfTbyH7NpdQW/SBN6TIGhmy05CeooxTnXCKZgRFdVII/6zTPKczSa0zKiGh0qVMRG9ri67s33fpbvvkGV0bt7an547BjSsUJWib9wCX958LaP2n+QAvihYCqrmoZjGoWRlgrIgvQlAp5FDRkftzOCxBHmPMjpp42V2+pkOeqKKuZQ7g//nXv2lG8Oe0zd/YYaVZqcagsdGMGq1yuBIYJSMwIWYoC0lJel7kYAymJqWFkesREyOqiQihZ8JLPsBWLQxshbTK1R41rJPpsHcZ4FMJDj3SrjzkEnK0SCxXirqXMEyqrCqafWhsrPTFEFHCFrMBtjhg8GcAwhSQGZcJPlw4DaLACbu1MJgvtTDAuCgQmLrNhkORCFwY7ajmiWUFl3xEEVBM6QLkQhkaFLQa4J3MqLxytw5skwCwjkR6OOmwF3jLI8LxYwoWjz11Fw4TuwufN6u+G2yAl+sStxcJmFkhWQ6XoMliuOt6leesVNZdoTEEbJ4tLmQ1lwYTEg6hcDQ1+/y1gPZI+aTD8PUEXRgGxygAuZAXrlvntBazdzAwwsIsVTIej5es1+P5OS+FzaoBBtpqNm9EH8nWNafXPx5H8aKZm5dsDUPQSI2Z61LkpXAeiZ3uHvXJNbIM8nK2M065IeRSidlAwI1jsBhJm40w/zE6L5QJnpBvDSrMS3HjBQFbe8zh8Bh7QJMQ661g1QYBb0RxlIsEpIGG/9x9efSaXbInnc0obviOezBv43X/+d7B8R5ig+7Qcazb2exsUq5ZGVtw2diKml3r3tdFK9J4WVr3yK57ZNc9suse2XWP7LpHdt0ju+6RXffIrntk1z2y6x5Ztu6RXffI/km0r3tk1z2y6x7ZdY/sukd23SO77pFd98iue2TXPbLrHtl1j+y6R3bdI7vukV33yK57ZP9/9cj64i+MCjfKnAvZKMB1dYKnC52z53GUYR3hzml0fY1vwW91Pp3i5y8VaCxCPI+jS64F5ripBDEOpXNYbXYBk2gneu5S9u0T3D520k5VIQuVl1j552bs0qnfCtssdTw6PD6J4mjgu3sLleIczcfY+cvHruTMM5OaOzn1beVcjioqfovcmljtxyubzZcKXlCpoP+jUUPH5aSB4XwNoSMD/0Wibpxwfe3KEKfTGt4NrZzhGRug8fjOp9PpfwG+AwMD",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,j={},x=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/0058b4c6.c75adfba.js b/assets/js/0058b4c6.d66f92df.js similarity index 53% rename from assets/js/0058b4c6.c75adfba.js rename to assets/js/0058b4c6.d66f92df.js index e356d9223..d9b38d57d 100644 --- a/assets/js/0058b4c6.c75adfba.js +++ b/assets/js/0058b4c6.d66f92df.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[849],{86164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign your-self","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","label":"Navigate between pages of a document","href":"/docs/help/New-Document/navigate-between-pages","docId":"help/New-Document/navigate-between-pages","unlisted":false},{"type":"link","label":"Editing Your Document Before Sending","href":"/docs/help/New-Document/edit-document-before-sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","label":"Enforce email OTP verification","href":"/docs/help/New-Document/enforce-email-verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Documents","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"Contactbook","href":"/docs/help/Reports/contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send the Document for Signature Using Template","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","label":"Setting up an OpenSign template for public signing","href":"/docs/help/Templates/publicTemplate","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","label":"Embedding OpenSign templates","href":"/docs/help/Templates/embed-template","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"API Token","href":"/docs/help/Settings/APIToken","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","label":"Webhook","href":"/docs/help/Settings/Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","label":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Manage Teams","href":"/docs/help/Settings/Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","href":"/docs/self-host/docker/upgrade-deployment","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"OpenSign Deployment Guide on Azure VM via command-line","href":"/docs/self-host/guides/azure-vm-setup","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","label":"How to upgrade self-hosted OpenSign to v2.1.0?","href":"/docs/self-host/guides/upgrade-to-v2.1.0","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/selfsign","className":"api-method post","docId":"API-docs/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftdocument","className":"api-method post","docId":"API-docs/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/revokedocument","className":"api-method post","docId":"API-docs/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/resendrequestmail","className":"api-method post","docId":"API-docs/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/drafttemplate","className":"api-method post","docId":"API-docs/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/createfolder","className":"api-method post","docId":"API-docs/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/getfolder","className":"api-method get","docId":"API-docs/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/updatefolder","className":"api-method put","docId":"API-docs/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/deletefolder","className":"api-method delete","docId":"API-docs/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/folderlist","className":"api-method get","docId":"API-docs/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"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.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/createfolder":{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/deletefolder":{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/draftdocument":{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/drafttemplate":{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/folderlist":{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/getfolder":{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you\'re a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.","sidebar":"apiSidebar"},"API-docs/resendrequestmail":{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/revokedocument":{"id":"API-docs/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/selfsign":{"id":"API-docs/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/update-document":{"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.","sidebar":"apiSidebar"},"API-docs/update-template":{"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.","sidebar":"apiSidebar"},"API-docs/updatefolder":{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/edit-document-before-sending":{"id":"help/New-Document/edit-document-before-sending","title":"Editing Your Document Before Sending","description":"OpenSign\u2122 lets you polish your PDF before you send it out\u2014whether you\u2019re signing it yourself, requesting signatures, or saving it as a template. You get three core editing controls right in the preview:","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/navigate-between-pages":{"id":"help/New-Document/navigate-between-pages","title":"Navigate between pages of a document","description":"To navigate between pages of a document that you have uploaded either click on the previous page > buttons at the top or click on any of the page previews loaded on the left side -","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/APIToken":{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on Self-Hosted, Teams, and Enterprise plans.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Settings/Teams":{"id":"help/Settings/Teams","title":"Manage Teams","description":"The Teams feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.","sidebar":"tutorialSidebar"},"help/Settings/Webhook":{"id":"help/Settings/Webhook","title":"Webhook","description":"\ud83d\udd14 What is a Webhook?","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send the Document for Signature Using Template","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/azure-vm-setup":{"id":"self-host/guides/azure-vm-setup","title":"OpenSign Deployment Guide on Azure VM via command-line","description":"\ud83e\uddf1 Prerequisites","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[849],{86164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign your-self","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","label":"Navigate between pages of a document","href":"/docs/help/New-Document/navigate-between-pages","docId":"help/New-Document/navigate-between-pages","unlisted":false},{"type":"link","label":"Editing Your Document Before Sending","href":"/docs/help/New-Document/edit-document-before-sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","label":"Enforce email OTP verification","href":"/docs/help/New-Document/enforce-email-verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Documents","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"Contactbook","href":"/docs/help/Reports/contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send the Document for Signature Using Template","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","label":"Setting up an OpenSign template for public signing","href":"/docs/help/Templates/publicTemplate","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","label":"Embedding OpenSign templates","href":"/docs/help/Templates/embed-template","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"API Token","href":"/docs/help/Settings/APIToken","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","label":"Webhook","href":"/docs/help/Settings/Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","label":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Manage Teams","href":"/docs/help/Settings/Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","href":"/docs/self-host/docker/upgrade-deployment","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"OpenSign Deployment Guide on Azure VM via command-line","href":"/docs/self-host/guides/azure-vm-setup","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","label":"How to upgrade self-hosted OpenSign to v2.1.0?","href":"/docs/self-host/guides/upgrade-to-v2.1.0","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/selfsign","className":"api-method post","docId":"API-docs/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftdocument","className":"api-method post","docId":"API-docs/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/revokedocument","className":"api-method post","docId":"API-docs/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/resendrequestmail","className":"api-method post","docId":"API-docs/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/drafttemplate","className":"api-method post","docId":"API-docs/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/createfolder","className":"api-method post","docId":"API-docs/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/getfolder","className":"api-method get","docId":"API-docs/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/updatefolder","className":"api-method put","docId":"API-docs/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/deletefolder","className":"api-method delete","docId":"API-docs/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/folderlist","className":"api-method get","docId":"API-docs/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"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.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/createfolder":{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/deletefolder":{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/draftdocument":{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/drafttemplate":{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/folderlist":{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/getfolder":{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar":"apiSidebar"},"API-docs/resendrequestmail":{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/revokedocument":{"id":"API-docs/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/selfsign":{"id":"API-docs/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/update-document":{"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.","sidebar":"apiSidebar"},"API-docs/update-template":{"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.","sidebar":"apiSidebar"},"API-docs/updatefolder":{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/edit-document-before-sending":{"id":"help/New-Document/edit-document-before-sending","title":"Editing Your Document Before Sending","description":"OpenSign\u2122 lets you polish your PDF before you send it out\u2014whether you\u2019re signing it yourself, requesting signatures, or saving it as a template. You get three core editing controls right in the preview:","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/navigate-between-pages":{"id":"help/New-Document/navigate-between-pages","title":"Navigate between pages of a document","description":"To navigate between pages of a document that you have uploaded either click on the previous page > buttons at the top or click on any of the page previews loaded on the left side -","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/APIToken":{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on Self-Hosted, Teams, and Enterprise plans.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Settings/Teams":{"id":"help/Settings/Teams","title":"Manage Teams","description":"The Teams feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.","sidebar":"tutorialSidebar"},"help/Settings/Webhook":{"id":"help/Settings/Webhook","title":"Webhook","description":"\ud83d\udd14 What is a Webhook?","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send the Document for Signature Using Template","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/azure-vm-setup":{"id":"self-host/guides/azure-vm-setup","title":"OpenSign Deployment Guide on Azure VM via command-line","description":"\ud83e\uddf1 Prerequisites","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/05632a52.ecfd1686.js b/assets/js/05632a52.ecfd1686.js deleted file mode 100644 index 801c2a18c..000000000 --- a/assets/js/05632a52.ecfd1686.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8669],{72558:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>g,contentTitle:()=>I,default:()=>f,frontMatter:()=>b,metadata:()=>a,toc:()=>j});const a=JSON.parse('{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/getcontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getcontact","permalink":"/docs/API-docs/getcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar_label":"Get Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V21v2zYQ/itXflkDKJadph2mTw26IgtWrMWSocBSI6Ckk8SEIlmS8gsMfdsv2U/bLxmOkmw5dotlKAoEjk3ec2+8e47cMM9Lx5Jb9kYrzzPv2DxiObrMCuOFVixhNxXCJXroJeDiwxVwKfXSwVo34DVY9FbgAiFHz4V0wFPdeODgDGaiEBlkHXbCIqYNWk6qr3KWsBJ9v8ciZrjlNXq05NGGKV4jS1i/fydyFjFBHhnuK/bYTZ3eY+avctAF7FRa/NwIizlLvG0wYs6vJSl1ojYSWcRwZaTOkSUFl44EsgprzpIN82sTJL0VqmQRK7StuR+v4IoHLQkzv8zSKjurTMradk5mndHKoSNFZ9Mp/dt31zVZhs4VjYRtRlgUgkXlSZ4bI0UWNuJ7R6DNoXdd1JQ7S2q86EwOyXhyHNUsrVZn94a1UZ//pym41wgpIsGx5kL+D3yK+LpfmGS6JlWm0urJrpzPXszOwh+pyCxyj/mFP6ZmBzqbnr04nU1Ppz/ezF4l5z8lL19NptPpnyxiqzpE01dlzn2I0gsvx78bk38HO+1jsb7i+wYcA4ZeaFtCnR+rxWtdo6+EKmGJysPSalVGYCRyh+DtGnjJhQLJPdpn365I0Vptv56mp3nWjsIWSgqFd0Mj3p1Pp3ezbRLOD5Mw0JvSHgrdqPz7RnrE/NfDOb8724bz8jCcK7XgUuSBrW/0A6rvG87YvO/MHxat6ITCPtsLdrzeBekwa6zw6zAZVqfciNNuP7mdE+NSneh+ooRR4iuWsLiv/nizmyItI212MYyZxkqWsMp745I4dlzlqV5NtEHlRKkkTx3RUMyNiBdEJY8R3JgnSGNz+jSA87wUqvw6ar5L0DUdYndOe2nanhY34ldcs4Hf96T6AVshz9GGExOq0AHcn817g+palCqc7GJ2MIY/osx0jXQt8BXCIP7PX38HRK6zpkblQ+E9g/eNBaOXaGkOcpVDIXElUolHbhkOeS3RObkGoTyWlnuEXJTCcwmUFaKJjBueCimoVElME9rCqNrdBD5W6Cu0tPWDReCQ4wIlVThIrR9Ij9fAG6/rYKP3GZbaPhTkUgQc0sYJhc6BQxwgqCquMoThLCLQFrgCVB6tscIhcFGTcKEtYFGITJBiKk5L3V9zxUskYxGQ35QFY/VC5OjA6rRxHpyWTQiELNaIvgtRIeZuAj+LBXaB02I3DzCHsiEVEWQ6R+jblMJQOaToPBgyLzIMSp3n1oPEBdpQe+Eki0ZKMJr4Q3BJt6zx2ZIib7lyNJE7h4aj2abPWE1XnmAj5+sJfFKfFDE8NA6pAKRQDy75pE7hdltmHzF1wuP8+dAPy+XyoA9O9jGXwldNChaN3uHKsBi6Zgzf/jih0bvfMPuVbbFAS9GEHJWoMFQgN6JjOLi9+HAVqBYqlGZnmSCHrUurMQnG1+i9UKWLB/xJuLD0c5v4trtJUee+fqwn8Cba2r0vrtEuRIY9d3whVXEQjlnEpMhQORzx8cXlh3ewgBeTKYtGLPQfkhe/u3rz9rfrt+QNEWuXsdlkOpmG+5t2vuZqZGr0oHhMIZvdmPrWb4+eAT2ufGwkF2HqhEA3/cS4Zbu3QzJ6ecwjVmnnSWCzSbnDP6xsW1r+3KClqTSP2IJbwVOiydsNy4Wj7/n2ZfHFIJ//3j9STuD4I+ao2wObK6LyBZcN/WIRe8D1/qOpnbfRwOjkWCdwkWVo/Ah6cCHYm6qXb29YxHhDORpPkocwSfovpP2oW/sjpnOAPmnaHQVsNt2UatutfLf1RUQf4CBNOZq3bfsveUImkQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/deletecontact"}}');var o=n(74848),i=n(28453),s=n(33617),c=n.n(s),r=n(17543),l=n.n(r),p=n(86013),d=n.n(p),m=n(63723),h=n.n(m),u=(n(18766),n(79329),n(9303));const b={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/itXflkDKJadph2mTw26IgtWrMWSocBSI6Ckk8SEIlmS8gsMfdsv2U/bLxmOkmw5dotlKAoEjk3ec2+8e47cMM9Lx5Jb9kYrzzPv2DxiObrMCuOFVixhNxXCJXroJeDiwxVwKfXSwVo34DVY9FbgAiFHz4V0wFPdeODgDGaiEBlkHXbCIqYNWk6qr3KWsBJ9v8ciZrjlNXq05NGGKV4jS1i/fydyFjFBHhnuK/bYTZ3eY+avctAF7FRa/NwIizlLvG0wYs6vJSl1ojYSWcRwZaTOkSUFl44EsgprzpIN82sTJL0VqmQRK7StuR+v4IoHLQkzv8zSKjurTMradk5mndHKoSNFZ9Mp/dt31zVZhs4VjYRtRlgUgkXlSZ4bI0UWNuJ7R6DNoXdd1JQ7S2q86EwOyXhyHNUsrVZn94a1UZ//pym41wgpIsGx5kL+D3yK+LpfmGS6JlWm0urJrpzPXszOwh+pyCxyj/mFP6ZmBzqbnr04nU1Ppz/ezF4l5z8lL19NptPpnyxiqzpE01dlzn2I0gsvx78bk38HO+1jsb7i+wYcA4ZeaFtCnR+rxWtdo6+EKmGJysPSalVGYCRyh+DtGnjJhQLJPdpn365I0Vptv56mp3nWjsIWSgqFd0Mj3p1Pp3ezbRLOD5Mw0JvSHgrdqPz7RnrE/NfDOb8724bz8jCcK7XgUuSBrW/0A6rvG87YvO/MHxat6ITCPtsLdrzeBekwa6zw6zAZVqfciNNuP7mdE+NSneh+ooRR4iuWsLiv/nizmyItI212MYyZxkqWsMp745I4dlzlqV5NtEHlRKkkTx3RUMyNiBdEJY8R3JgnSGNz+jSA87wUqvw6ar5L0DUdYndOe2nanhY34ldcs4Hf96T6AVshz9GGExOq0AHcn817g+palCqc7GJ2MIY/osx0jXQt8BXCIP7PX38HRK6zpkblQ+E9g/eNBaOXaGkOcpVDIXElUolHbhkOeS3RObkGoTyWlnuEXJTCcwmUFaKJjBueCimoVElME9rCqNrdBD5W6Cu0tPWDReCQ4wIlVThIrR9Ij9fAG6/rYKP3GZbaPhTkUgQc0sYJhc6BQxwgqCquMoThLCLQFrgCVB6tscIhcFGTcKEtYFGITJBiKk5L3V9zxUskYxGQ35QFY/VC5OjA6rRxHpyWTQiELNaIvgtRIeZuAj+LBXaB02I3DzCHsiEVEWQ6R+jblMJQOaToPBgyLzIMSp3n1oPEBdpQe+Eki0ZKMJr4Q3BJt6zx2ZIib7lyNJE7h4aj2abPWE1XnmAj5+sJfFKfFDE8NA6pAKRQDy75pE7hdltmHzF1wuP8+dAPy+XyoA9O9jGXwldNChaN3uHKsBi6Zgzf/jih0bvfMPuVbbFAS9GEHJWoMFQgN6JjOLi9+HAVqBYqlGZnmSCHrUurMQnG1+i9UKWLB/xJuLD0c5v4trtJUee+fqwn8Cba2r0vrtEuRIY9d3whVXEQjlnEpMhQORzx8cXlh3ewgBeTKYtGLPQfkhe/u3rz9rfrt+QNEWuXsdlkOpmG+5t2vuZqZGr0oHhMIZvdmPrWb4+eAT2ufGwkF2HqhEA3/cS4Zbu3QzJ6ecwjVmnnSWCzSbnDP6xsW1r+3KClqTSP2IJbwVOiydsNy4Wj7/n2ZfHFIJ//3j9STuD4I+ao2wObK6LyBZcN/WIRe8D1/qOpnbfRwOjkWCdwkWVo/Ah6cCHYm6qXb29YxHhDORpPkocwSfovpP2oW/sjpnOAPmnaHQVsNt2UatutfLf1RUQf4CBNOZq3bfsveUImkQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},I=void 0,g={},j=[];function x(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,o.jsx)(c(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,o.jsx)(e.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,o.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,o.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(x,{...t})}):x(t)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.f39cb8ab.js b/assets/js/05632a52.f39cb8ab.js new file mode 100644 index 000000000..561921b88 --- /dev/null +++ b/assets/js/05632a52.f39cb8ab.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8669],{72558:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>I,contentTitle:()=>J,default:()=>h,frontMatter:()=>b,metadata:()=>n,toc:()=>u});const n=JSON.parse('{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/getcontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getcontact","permalink":"/docs/API-docs/getcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar_label":"Get Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oY8t7ipKieYgSGY9RogthBgDoLg5JmJdoUyZDUXrAQ0If+Qf+gn5YvKYaSdrXeTVC3QQBjvUvODM9cOGe4Zp7njsU37LVWnqfesWnEMnSpFcYLrVjMrguEc/TQSsDpuwvgUuqFg5WuwGuw6K3AOUKGngvpgCe68sDBGUzFTKSQNroDFjFt0HIyfZGxmOXo2z0WMcMtL9GjJURrpniJLGbt/q3IWMQEITLcF+whTJ3cYeovMtAz2Jq0+LkSFjMWe1thxJxfSTLqRGkksojh0kidIYtnXDoSSAssOYvXzK9MkPRWqJxFbKZtyX1/BZc8WImZeTNOinRSmITV9ZSOdUYrh44MTUYj+rcL11Vpis7NKgmbiLAoOIvKkzw3Roo0bAzvHCmt99E1XlPsLJnxojmyC8aj/SjGSbGc3BlWR238H2fgTiMkiKSOJRfyP+gniK/ahUGqSzJlCq0eDeVk/Hw8CX9kIrXIPWan/pCZrdJkNHl+PB4dj36+Hr+MT36JX7wcjEaj31nElmXwpq3KjPvgpRde9n9XJvsB59QPxdqKby9gX6G7C3VNWieHavFKl+gLoXJYoPKwsFrlERiJ3CF4uwKec6FAco/2yfcrUrRW22+H6XHI6p7bQkmh8La7iLcno9HteBOEk/0gdO1NaQ8zXansx3p64Phvu3NyO9m482LfnQs151JkoVtf63tUP9ad/vG+OX6/aEUjFPbZjrP99cZJh2llhV8FZlgecyOOm/34Zkodl+pEt4wSqMQXLGbDtvqH6y2L1Iys2XlHM5WVLGaF98bFw6HjKkv0cqANKidyJXniqA0NuRHDObWShxrcmEdIY3X8OAXneS5U/m2t6TZAV5TEJk87YdpkixvxK65Y1993pFqCLZBnaEPGhJrpoNzm5q1BdSVyFTI7H+/R8EeUqS6RxgJfIHTiX/78O2hkOq1KVD4U3pNP6pN6W1kweoGWqJCrDGYSlyKRGOSxDHubUcMhLyU6J1cglMfcco+QiVx4LoFCQ70i5YYnQgqqVxLTpG2hV/JuAB8L9AVa2vrJInDIcI6Syhx45XXJPZnq8MJC2/sZDT0RcEgqJxQ6B6gKrlIS7MIfgbbAFaDyaI0VDsF5S6hFg00rb+mil1zxHMl2tBOlDKWg2gSrk8p5cFpWATJQa9cWM+gcUoiZG1AQz2iKsQi0murSWCyoUuYIeSUydBGkOkNw4XqSCyqDBJ0HQ1hEio6MVkrq9D7kbVZJCUZTtxBc0kzVx0jq3nLliH8bLF0ONgEzVtOAgw3Ao6MPDinDl0Ldu/jo6JM6hptNMX3ExAmP06dd1S8Wi71qf7arcy78myqB92i0E17b1VY7F76oknBD+kY2PxpL56gw1E/vBmxtZDp1+xeOVocFSjO8Qk8V4oan7y5Cg30GX/74Cy6RWwWFXjTVmlYW5Qry7iiKXJP5Jmyb/ggzHQqvoIinTfHR8IrOUwRpLti9zbvXzuIMLQU/JHJ7nBGt+ZsOJhD6/+NmmKbaoYLIoBnzqK28emgnNHW0pXs7u0I7Fym2je0rGR4G4SGLmBQpKoc9sjg9f3cJc3g+GLGo1yL/RbaHlxevz367OiM0dLOaiI0Ho8EoDJfa+ZKr3lG9187D/rbecuj3fhi17dnj0g+N5CJQYnB03dLZDds+bOLes2gasUI7TwLrdcIdfrCyrmn5c4WWKHMasTm3gifUw2/WLBOOvmebZ89XnXz6vn1BPYPDL6yDsDuqUcQzcy4r+sUido+r3RddPa2jjm4IWCNwmqZofE91b1rZofzzs2sWMbo8uzR3H2iu/ULWD8La5b8GAH0SFR9UWK8bCq3rjXyz9VWN1sFOmmI0rev6H+wQY1o=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/deletecontact"}}');var i=o(74848),a=o(28453),c=o(33617),s=o.n(c),r=o(17543),p=o.n(r),l=o(86013),d=o.n(l),m=o(63723),g=o.n(m),y=(o(18766),o(79329),o(9303));const b={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oY8t7ipKieYgSGY9RogthBgDoLg5JmJdoUyZDUXrAQ0If+Qf+gn5YvKYaSdrXeTVC3QQBjvUvODM9cOGe4Zp7njsU37LVWnqfesWnEMnSpFcYLrVjMrguEc/TQSsDpuwvgUuqFg5WuwGuw6K3AOUKGngvpgCe68sDBGUzFTKSQNroDFjFt0HIyfZGxmOXo2z0WMcMtL9GjJURrpniJLGbt/q3IWMQEITLcF+whTJ3cYeovMtAz2Jq0+LkSFjMWe1thxJxfSTLqRGkksojh0kidIYtnXDoSSAssOYvXzK9MkPRWqJxFbKZtyX1/BZc8WImZeTNOinRSmITV9ZSOdUYrh44MTUYj+rcL11Vpis7NKgmbiLAoOIvKkzw3Roo0bAzvHCmt99E1XlPsLJnxojmyC8aj/SjGSbGc3BlWR238H2fgTiMkiKSOJRfyP+gniK/ahUGqSzJlCq0eDeVk/Hw8CX9kIrXIPWan/pCZrdJkNHl+PB4dj36+Hr+MT36JX7wcjEaj31nElmXwpq3KjPvgpRde9n9XJvsB59QPxdqKby9gX6G7C3VNWieHavFKl+gLoXJYoPKwsFrlERiJ3CF4uwKec6FAco/2yfcrUrRW22+H6XHI6p7bQkmh8La7iLcno9HteBOEk/0gdO1NaQ8zXansx3p64Phvu3NyO9m482LfnQs151JkoVtf63tUP9ad/vG+OX6/aEUjFPbZjrP99cZJh2llhV8FZlgecyOOm/34Zkodl+pEt4wSqMQXLGbDtvqH6y2L1Iys2XlHM5WVLGaF98bFw6HjKkv0cqANKidyJXniqA0NuRHDObWShxrcmEdIY3X8OAXneS5U/m2t6TZAV5TEJk87YdpkixvxK65Y1993pFqCLZBnaEPGhJrpoNzm5q1BdSVyFTI7H+/R8EeUqS6RxgJfIHTiX/78O2hkOq1KVD4U3pNP6pN6W1kweoGWqJCrDGYSlyKRGOSxDHubUcMhLyU6J1cglMfcco+QiVx4LoFCQ70i5YYnQgqqVxLTpG2hV/JuAB8L9AVa2vrJInDIcI6Syhx45XXJPZnq8MJC2/sZDT0RcEgqJxQ6B6gKrlIS7MIfgbbAFaDyaI0VDsF5S6hFg00rb+mil1zxHMl2tBOlDKWg2gSrk8p5cFpWATJQa9cWM+gcUoiZG1AQz2iKsQi0murSWCyoUuYIeSUydBGkOkNw4XqSCyqDBJ0HQ1hEio6MVkrq9D7kbVZJCUZTtxBc0kzVx0jq3nLliH8bLF0ONgEzVtOAgw3Ao6MPDinDl0Ldu/jo6JM6hptNMX3ExAmP06dd1S8Wi71qf7arcy78myqB92i0E17b1VY7F76oknBD+kY2PxpL56gw1E/vBmxtZDp1+xeOVocFSjO8Qk8V4oan7y5Cg30GX/74Cy6RWwWFXjTVmlYW5Qry7iiKXJP5Jmyb/ggzHQqvoIinTfHR8IrOUwRpLti9zbvXzuIMLQU/JHJ7nBGt+ZsOJhD6/+NmmKbaoYLIoBnzqK28emgnNHW0pXs7u0I7Fym2je0rGR4G4SGLmBQpKoc9sjg9f3cJc3g+GLGo1yL/RbaHlxevz367OiM0dLOaiI0Ho8EoDJfa+ZKr3lG9187D/rbecuj3fhi17dnj0g+N5CJQYnB03dLZDds+bOLes2gasUI7TwLrdcIdfrCyrmn5c4WWKHMasTm3gifUw2/WLBOOvmebZ89XnXz6vn1BPYPDL6yDsDuqUcQzcy4r+sUido+r3RddPa2jjm4IWCNwmqZofE91b1rZofzzs2sWMbo8uzR3H2iu/ULWD8La5b8GAH0SFR9UWK8bCq3rjXyz9VWN1sFOmmI0rev6H+wQY1o=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},J=void 0,I={},u=[];function L(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,i.jsx)(s(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,i.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(p(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function h(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(L,{...e})}):L(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.27c9c261.js b/assets/js/13fdae3b.27c9c261.js new file mode 100644 index 000000000..b3106ab89 --- /dev/null +++ b/assets/js/13fdae3b.27c9c261.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8472],{20080:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>m,contentTitle:()=>h,default:()=>z,frontMatter:()=>u,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/delete-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/delete-webhook","permalink":"/docs/API-docs/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vs2O2zYQfpUJL20WWstJ00N9atAs0kUXzaKbYA+OEVDUWGJMkQyH8g8MAT30DfoGfbQ8STGU5b9tgqYterElzv/Mx2+0FVFWJCZTcY9F7dxCzDJRIqmgfdTOiol4XSO8QIMRYacDz2+vQRrjVrBxLUQHZS9f7eRtMCITzmOQ7OS6FBPRqwxRMhGQvLOEJCZb8XQ85r/TwHetUkg0bw3sXYlMKGcj2sj60nujVRLk74mNtoJUjY3kp7jxKCbCFe9RRZEJH9hN1H3IgNSaeKRHMWhbiUzgWjbe8NFQb597CbTPyGweia7LRNQxaWprtMV3Q1Hvno7H774TXcc6z8bPHhb3hjCAdRHmrrXlo/+uLgzBhc+XdR77c4Vw8kMZ3z4s49oupdFlQsRrt0D7/1ZyHD724TnVdWPYzsqmLykpJbk4KfX4vC+SULVBx42YTLdifSm9vuzlk+msm2WiwVi7A5w5ZxlrMRH5ao9swrDEQMkF34SJqGP0NMlzkrYs3HrkPFrSlTWyoJFyTS69zpdPRJedW0jvv0Ab28svM6AoK22rz1vNDm2549H10zlpzn5G0uufcCOyoffHWpnQDJkaZYkhzUnbuUvGu4m88mjvdGXTPJdPxDkV3aNRrkFmnFgjDOoff/sjWZROtQ3amOD26K19a1+1AbxbYWASkbaEucG1LgwmfWySjAYWI5SNQSKzAW0jVkFGhFJXOkoD3BptK1DSy0IbzShlNcfWAY6ATiO4rzHWGFj0VUCQUOISDYMbZBtdIyO7GvKFlQuLuXErykBC0ZK2SARoa2kVKw7tz8AFkBbQRgw+aEKgGDhr3efmbAxSRWiklRWy7+ykSyUazdiE4IqWIpAzbUoZotTGBSxhKMgiljTiJl6tPYuAT5VrfMCakbJEqFpdImWgXIlA6VJyCbaEAimC51y0QmKnrTVOLdLcmD/BO+YILQ24+UmObB6DtDR3oelzGWawb5gPjokY+wQvLt4Q8oRvtF3Q5OLirb2E6R5M91iQjjj7ekD9arV6gPbHpzYvdfyxLeAX9I50dGFzsK50rNsi3ZBjJ/uX3tNLtJjwc3QDDj5Kp+jhhePTvEbj8zuMjBDKn99eJ1p9DB9//R1uUAYLtVv1aFVtQLOBagjFnesn37dtz4owdwl4NXdc9eAL+KFFitxBkZ3f5tNrF3COgZufBnkI5/XO/XRIEzj7f1Mm8zOjWKq0PrCR2vS08v25n0TlGBp6Nb/DsNQKd8T2iQnnSTkXmTBaoSU8WhHPX97ewBK+GY1FdkSRf2Pa+c31D1c/311xNnyz+o49GY1HYz7yjmIj7VGo00+pc4rbHpbnP//w2nFxxHXMvZE6bb1U1Xa3rqZidfjcqx1FPtpuC0n4Jpiu4+MPLQbeg7NMLGXQsmCKns66bGBw3m8L3HD7lELPC3wpTduvgbO1f7I7X1zdXL2+EplgSJ4uj0VaHrsHDjCI7ObI/elW6XPgX15wf2mw3faLqev2+r3okxa7Ggdt7uGs67o/ASt08/w=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"}}');var s=t(74848),l=t(28453),i=t(33617),d=t.n(i),r=t(17543),a=t.n(r),b=t(86013),p=t.n(b),c=t(63723),k=t.n(c),j=(t(18766),t(79329),t(9303));const u={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs2O2zYQfpUJL20WWstJ00N9atAs0kUXzaKbYA+OEVDUWGJMkQyH8g8MAT30DfoGfbQ8STGU5b9tgqYterElzv/Mx2+0FVFWJCZTcY9F7dxCzDJRIqmgfdTOiol4XSO8QIMRYacDz2+vQRrjVrBxLUQHZS9f7eRtMCITzmOQ7OS6FBPRqwxRMhGQvLOEJCZb8XQ85r/TwHetUkg0bw3sXYlMKGcj2sj60nujVRLk74mNtoJUjY3kp7jxKCbCFe9RRZEJH9hN1H3IgNSaeKRHMWhbiUzgWjbe8NFQb597CbTPyGweia7LRNQxaWprtMV3Q1Hvno7H774TXcc6z8bPHhb3hjCAdRHmrrXlo/+uLgzBhc+XdR77c4Vw8kMZ3z4s49oupdFlQsRrt0D7/1ZyHD724TnVdWPYzsqmLykpJbk4KfX4vC+SULVBx42YTLdifSm9vuzlk+msm2WiwVi7A5w5ZxlrMRH5ao9swrDEQMkF34SJqGP0NMlzkrYs3HrkPFrSlTWyoJFyTS69zpdPRJedW0jvv0Ab28svM6AoK22rz1vNDm2549H10zlpzn5G0uufcCOyoffHWpnQDJkaZYkhzUnbuUvGu4m88mjvdGXTPJdPxDkV3aNRrkFmnFgjDOoff/sjWZROtQ3amOD26K19a1+1AbxbYWASkbaEucG1LgwmfWySjAYWI5SNQSKzAW0jVkFGhFJXOkoD3BptK1DSy0IbzShlNcfWAY6ATiO4rzHWGFj0VUCQUOISDYMbZBtdIyO7GvKFlQuLuXErykBC0ZK2SARoa2kVKw7tz8AFkBbQRgw+aEKgGDhr3efmbAxSRWiklRWy7+ykSyUazdiE4IqWIpAzbUoZotTGBSxhKMgiljTiJl6tPYuAT5VrfMCakbJEqFpdImWgXIlA6VJyCbaEAimC51y0QmKnrTVOLdLcmD/BO+YILQ24+UmObB6DtDR3oelzGWawb5gPjokY+wQvLt4Q8oRvtF3Q5OLirb2E6R5M91iQjjj7ekD9arV6gPbHpzYvdfyxLeAX9I50dGFzsK50rNsi3ZBjJ/uX3tNLtJjwc3QDDj5Kp+jhhePTvEbj8zuMjBDKn99eJ1p9DB9//R1uUAYLtVv1aFVtQLOBagjFnesn37dtz4owdwl4NXdc9eAL+KFFitxBkZ3f5tNrF3COgZufBnkI5/XO/XRIEzj7f1Mm8zOjWKq0PrCR2vS08v25n0TlGBp6Nb/DsNQKd8T2iQnnSTkXmTBaoSU8WhHPX97ewBK+GY1FdkSRf2Pa+c31D1c/311xNnyz+o49GY1HYz7yjmIj7VGo00+pc4rbHpbnP//w2nFxxHXMvZE6bb1U1Xa3rqZidfjcqx1FPtpuC0n4Jpiu4+MPLQbeg7NMLGXQsmCKns66bGBw3m8L3HD7lELPC3wpTduvgbO1f7I7X1zdXL2+EplgSJ4uj0VaHrsHDjCI7ObI/elW6XPgX15wf2mw3faLqev2+r3okxa7Ggdt7uGs67o/ASt08/w=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,m={},f=[];function D(e){const o={p:"p",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(j.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,s.jsx)(d(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(k(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function z(e={}){const{wrapper:o}={...(0,l.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(D,{...e})}):D(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.64fc90ce.js b/assets/js/13fdae3b.64fc90ce.js deleted file mode 100644 index 97f0bbe0d..000000000 --- a/assets/js/13fdae3b.64fc90ce.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8472],{20080:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>S,contentTitle:()=>u,default:()=>q,frontMatter:()=>k,metadata:()=>s,toc:()=>U});const s=JSON.parse('{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/delete-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/delete-webhook","permalink":"/docs/API-docs/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vs1u4zYQfpUJL20AxXK220N9atAEi6BBs4CzyMExAkoaSVxTJMuh7BiGbvskfbQ+STGU5b90g25R9GJL5Px98/ONNiLIisRkJh4xq61diHkiCqTcKxeUNWIiHmqEa9QYELYycPXxFqTWdgVr20KwUPT3q+1967VIhHXoJRu5LcRE9CKDl0R4JGcNIYnJRrwbj/nv2PG0zXMkKlsNO1MiEbk1AU1geemcVnm8SD8TK20E5TU2kp/C2qGYCJt9xjyIRDjPZoLqXXqkVocDOQpemUokAl9k4zQfDXj72AugXUR6fSa6LhFBhSipjFYGnwdQz+/G4+efRNexzPvx+9fgPhF6MDZAaVtTnP13uNB769+Gder7LSAc/ADjx9cwbs1SalXEjniwCzT/L5JD96F3z6G+NJr1jGx6SFEo3osjqIfnPUjCvPUqrMVkthEvF9Kpi/5+Mpt380Q0GGq7b2eOWYZaTES62nU2oV+ip2iCJ2Ei6hAcTdKUpCky+zKyDg2pymiZ0Si3TSqdSpeXoktONaRz3yCN7cW3KVCQlTLV21rzfVqmXLq+OkfJ2dVIOvUrrkUy5P5QKhGKW6ZGWaCPdVKmtFF5W5F7h2aqKhPrubwUp1T0iDq3DTLjhBphEP/zyx9Ro7B526AJsd3O4L714OwKPTOINAWUGl9UpnHPXzQQGKFsNBLpNSgTsPIyIBSqUkFq4KwoU0EuncyUVtygLGZZ28NBj9MIHmsMNXq++s4jSChwiZr7GrS1C7YTLMg22Cb62MYMK+sXJYeUgISsJWWQCAhxUEFTS5MjDLVIwHqQBtAE9M4rQpCqYeHSesCyVLliwzyNXuYBGmlkhewsAY6bs+C8XaoCCbzNWgpAVrcRCHtsEEMP0SAWNIJrtcQeOB8WGKTSWEDVsokEclsgbIeTYZgCMqQAjt2rHKNRCtIH0LhEH3svVpIZFZxl1lBSgy2PasuGgpeGSuubPqChNLv0OW+ZmqOPQq5H8GSezJSbpSXkBtDKLGjyZC5gtmuzR8xIBZx/P8zDarV6NQfnxzofVKjbDDw6u9er4mGcmkP13cu5SE4H5rizPZboGU3MUYUGYwdKp3peg9nVx9tIsFCjdnvPrPJ6dPk0ZcF0iiEoU1E66J8zBXJPyDwyNDZS6X5yfz61E9kSfUP35RT9UuW45Y6vpCqNwqlIhFY5GsIDFr768PEOlvDDaCySAxb6B8lL725/ufltesPRMLH2GbscjUdjPnKWQiPNgavjr5VTFtns99O//7bZ0l3Al5A6LVVcLBHVZrsRZmK1/6KqLQU+2mwySfjJ667j499b9Lxq5olYSq9kxiw4m3fJQJK8Qha45vTlOTrekUup255pTzbr0Xq6vrm7ebgRiZAtB3PIz4vIz9sHdjBcmfWB+WPi7mPgX94hf6uw2fTc33U7+f7qqxpbjIM053Dedd1fjxS3Mw==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"}}');var i=t(74848),l=t(28453),n=t(33617),r=t.n(n),d=t(17543),p=t.n(d),a=t(86013),c=t.n(a),h=t(63723),b=t.n(h),P=(t(18766),t(79329),t(9303));const k={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfpUJL20AxXK220N9atAEi6BBs4CzyMExAkoaSVxTJMuh7BiGbvskfbQ+STGU5b90g25R9GJL5Px98/ONNiLIisRkJh4xq61diHkiCqTcKxeUNWIiHmqEa9QYELYycPXxFqTWdgVr20KwUPT3q+1967VIhHXoJRu5LcRE9CKDl0R4JGcNIYnJRrwbj/nv2PG0zXMkKlsNO1MiEbk1AU1geemcVnm8SD8TK20E5TU2kp/C2qGYCJt9xjyIRDjPZoLqXXqkVocDOQpemUokAl9k4zQfDXj72AugXUR6fSa6LhFBhSipjFYGnwdQz+/G4+efRNexzPvx+9fgPhF6MDZAaVtTnP13uNB769+Gder7LSAc/ADjx9cwbs1SalXEjniwCzT/L5JD96F3z6G+NJr1jGx6SFEo3osjqIfnPUjCvPUqrMVkthEvF9Kpi/5+Mpt380Q0GGq7b2eOWYZaTES62nU2oV+ip2iCJ2Ei6hAcTdKUpCky+zKyDg2pymiZ0Si3TSqdSpeXoktONaRz3yCN7cW3KVCQlTLV21rzfVqmXLq+OkfJ2dVIOvUrrkUy5P5QKhGKW6ZGWaCPdVKmtFF5W5F7h2aqKhPrubwUp1T0iDq3DTLjhBphEP/zyx9Ro7B526AJsd3O4L714OwKPTOINAWUGl9UpnHPXzQQGKFsNBLpNSgTsPIyIBSqUkFq4KwoU0EuncyUVtygLGZZ28NBj9MIHmsMNXq++s4jSChwiZr7GrS1C7YTLMg22Cb62MYMK+sXJYeUgISsJWWQCAhxUEFTS5MjDLVIwHqQBtAE9M4rQpCqYeHSesCyVLliwzyNXuYBGmlkhewsAY6bs+C8XaoCCbzNWgpAVrcRCHtsEEMP0SAWNIJrtcQeOB8WGKTSWEDVsokEclsgbIeTYZgCMqQAjt2rHKNRCtIH0LhEH3svVpIZFZxl1lBSgy2PasuGgpeGSuubPqChNLv0OW+ZmqOPQq5H8GSezJSbpSXkBtDKLGjyZC5gtmuzR8xIBZx/P8zDarV6NQfnxzofVKjbDDw6u9er4mGcmkP13cu5SE4H5rizPZboGU3MUYUGYwdKp3peg9nVx9tIsFCjdnvPrPJ6dPk0ZcF0iiEoU1E66J8zBXJPyDwyNDZS6X5yfz61E9kSfUP35RT9UuW45Y6vpCqNwqlIhFY5GsIDFr768PEOlvDDaCySAxb6B8lL725/ufltesPRMLH2GbscjUdjPnKWQiPNgavjr5VTFtns99O//7bZ0l3Al5A6LVVcLBHVZrsRZmK1/6KqLQU+2mwySfjJ667j499b9Lxq5olYSq9kxiw4m3fJQJK8Qha45vTlOTrekUup255pTzbr0Xq6vrm7ebgRiZAtB3PIz4vIz9sHdjBcmfWB+WPi7mPgX94hf6uw2fTc33U7+f7qqxpbjIM053Dedd1fjxS3Mw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,S={},U=[];function j(e){const o={p:"p",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(P.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,i.jsx)(r(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,i.jsx)(p(),{parameters:void 0}),"\n",(0,i.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function q(e={}){const{wrapper:o}={...(0,l.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.21256d76.js b/assets/js/1f73ca32.21256d76.js new file mode 100644 index 000000000..847e25f28 --- /dev/null +++ b/assets/js/1f73ca32.21256d76.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8211],{54472:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>T,contentTitle:()=>x,default:()=>f,frontMatter:()=>b,metadata:()=>o,toc:()=>y});const o=JSON.parse('{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/get-user.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-user","permalink":"/docs/API-docs/get-user","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar_label":"Get your account details","hide_title":true,"hide_table_of_contents":true,"api":"eJy9VttuGzcQ/ZUJX9oYa0m+Ja2e4hau6sRogtpGgDpCwOWOdmlxSYbk6gJBQB/6B/2Dflq+pBhSK0tyElRIkRdbS86cuc/hggVeeta/Y7ceHRtmrEAvnLRBGs367KZCGGAAuoXzN5eAmucKPcxNA8FAiYF+OjBTDVwI0+gABQYule+wjBmLjhPWZcH6rMQQzWTMobdGe/Ssv2DHvR7927Z83QiB3o8aBWsQljFhdEAdSJ5bq6SIF917T0oL5kWFNadfYW6R9ZnJ71EEljHrCCbIZDIdk1NrSR+c1CXL2Mi4mofNE5zx2ioS+mUgx8cneXX7ki0zpnmN+yK8NAg/IZI61lyqffXvDeaIL1YHHWFqgrKV0Xu7cnr27PkPJ8dHxycEcW/yGxnU3igFTkhdmNpyPd9X21jUXpY6QjjkAYvz8CmQB5Xj3vHJ4VHvsPf85uhZ//TH/tmzTq/X+4NlbFbHfKa6sIKHmOeQwlp/N7b4BnaWu2INtf6GWPpekuBp7/TxBMSZ0ybAyDS6ePL/NT86Z9yXY9+1vdzwW2olNb5vR/g9Od+GcfY4jEs94UoWcXvcmDHqbxvJpvmQzD8ujUxC8Z5thbp5noL0KBonw5z17xZsdsitPEz3/bvhcpixGkNlVtuOHOahYn3WLTE0afd5dBN0Puo3TrE+q0Kwvt/teq6L3Mw67VAonnua8C63sjs5YstsV4Nbu4c0Nof7KfjAS6nLL2sNH3JyTXVLpdnKzLpA3MpXOGft6tySypikfqmQF3Ew6HtkovKqHK8t6mtZ6ljMyRHbZau3qISpkYgpVAit+Me//okahRFNjTrEXnvyTr/TrxsH1kzREc1wXcBI4UzmChPX1fFuTXYeea3QezUHqQOWjgeEQpYycAWUGqlLENzyXCpJLUpiJvHjRpf7DrytMFTo6Oo7h8ChwAkq6mzgTTA1DwTV+gtT48YjZaY+Aw5546VG7wF1xbUgwTb9GRgHXAPqgM466RF8cOS1TL4ZHRwXAWqueYmEnW1lqUAlqTfBmbzxAbxRTXQZiNGNwwLagDRi4TuUxIuZpSugU2IBhxV1ygShbGSBPgNhCgQfJ5JC0AXk6ANY8kUK9ATaaGXEONZt1CgF1tCCkFyBGW35SOrBce2JVpIvbQ3WCbPO0OMBk4MHB7ceqcJXUo99/+DgnT6Eu3UzvcXcy4DD79uun06nj7r96bbOQIZfmxx+R2u8DMbNH7RLGaomjxOyCbL+SEgD1Bj7Z2MCHjAKI/zjgaPTboXKdq8xUIf47vmby7hTn8LHP/+GK+ROQ2WmqVtF41DNoWxNUeZS5VPa1isRRiY2XkUZF6n5HH5o0AfKIBHe9jRvj53DETpKvk9PwtaclSv4u9ZNIO+/Jsz00tCBi8gdqxcUrZUXuzhxj6Or/evRNbqJFLhabJ+pcDcKd1nGlBSoPW7ww/ngzRVM4KTTY9nGivwP1e5eXf588dv1BXlDk5UydtTpdXrx3WZ8qLneMDVoX9Q7r+ndZbd44NCvfqWvlnPAWehaxWXkwBjmYsVfd6zlr2HGKuMDHS0WOfd469RySccfGnTEisOMTbiT5EHkxKxd6UR4Y5xTPoVAS+w44apJvLDzCNhi0sHFDcsYNeg2lYwjlax+EHp7pecb2Nsckxygv0R3n1RYLBJNLZdr+XT1WY1VgK00JXC4XC7/BRSmo2c=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/opensign-api-v-1"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/createcontact"}}');var s=n(74848),a=n(28453),i=n(33617),c=n.n(i),r=n(17543),p=n.n(r),d=n(86013),l=n.n(d),u=n(63723),g=n.n(u),m=(n(18766),n(79329),n(9303));const b={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VttuGzcQ/ZUJX9oYa0m+Ja2e4hau6sRogtpGgDpCwOWOdmlxSYbk6gJBQB/6B/2Dflq+pBhSK0tyElRIkRdbS86cuc/hggVeeta/Y7ceHRtmrEAvnLRBGs367KZCGGAAuoXzN5eAmucKPcxNA8FAiYF+OjBTDVwI0+gABQYule+wjBmLjhPWZcH6rMQQzWTMobdGe/Ssv2DHvR7927Z83QiB3o8aBWsQljFhdEAdSJ5bq6SIF917T0oL5kWFNadfYW6R9ZnJ71EEljHrCCbIZDIdk1NrSR+c1CXL2Mi4mofNE5zx2ioS+mUgx8cneXX7ki0zpnmN+yK8NAg/IZI61lyqffXvDeaIL1YHHWFqgrKV0Xu7cnr27PkPJ8dHxycEcW/yGxnU3igFTkhdmNpyPd9X21jUXpY6QjjkAYvz8CmQB5Xj3vHJ4VHvsPf85uhZ//TH/tmzTq/X+4NlbFbHfKa6sIKHmOeQwlp/N7b4BnaWu2INtf6GWPpekuBp7/TxBMSZ0ybAyDS6ePL/NT86Z9yXY9+1vdzwW2olNb5vR/g9Od+GcfY4jEs94UoWcXvcmDHqbxvJpvmQzD8ujUxC8Z5thbp5noL0KBonw5z17xZsdsitPEz3/bvhcpixGkNlVtuOHOahYn3WLTE0afd5dBN0Puo3TrE+q0Kwvt/teq6L3Mw67VAonnua8C63sjs5YstsV4Nbu4c0Nof7KfjAS6nLL2sNH3JyTXVLpdnKzLpA3MpXOGft6tySypikfqmQF3Ew6HtkovKqHK8t6mtZ6ljMyRHbZau3qISpkYgpVAit+Me//okahRFNjTrEXnvyTr/TrxsH1kzREc1wXcBI4UzmChPX1fFuTXYeea3QezUHqQOWjgeEQpYycAWUGqlLENzyXCpJLUpiJvHjRpf7DrytMFTo6Oo7h8ChwAkq6mzgTTA1DwTV+gtT48YjZaY+Aw5546VG7wF1xbUgwTb9GRgHXAPqgM466RF8cOS1TL4ZHRwXAWqueYmEnW1lqUAlqTfBmbzxAbxRTXQZiNGNwwLagDRi4TuUxIuZpSugU2IBhxV1ygShbGSBPgNhCgQfJ5JC0AXk6ANY8kUK9ATaaGXEONZt1CgF1tCCkFyBGW35SOrBce2JVpIvbQ3WCbPO0OMBk4MHB7ceqcJXUo99/+DgnT6Eu3UzvcXcy4DD79uun06nj7r96bbOQIZfmxx+R2u8DMbNH7RLGaomjxOyCbL+SEgD1Bj7Z2MCHjAKI/zjgaPTboXKdq8xUIf47vmby7hTn8LHP/+GK+ROQ2WmqVtF41DNoWxNUeZS5VPa1isRRiY2XkUZF6n5HH5o0AfKIBHe9jRvj53DETpKvk9PwtaclSv4u9ZNIO+/Jsz00tCBi8gdqxcUrZUXuzhxj6Or/evRNbqJFLhabJ+pcDcKd1nGlBSoPW7ww/ngzRVM4KTTY9nGivwP1e5eXf588dv1BXlDk5UydtTpdXrx3WZ8qLneMDVoX9Q7r+ndZbd44NCvfqWvlnPAWehaxWXkwBjmYsVfd6zlr2HGKuMDHS0WOfd469RySccfGnTEisOMTbiT5EHkxKxd6UR4Y5xTPoVAS+w44apJvLDzCNhi0sHFDcsYNeg2lYwjlax+EHp7pecb2Nsckxygv0R3n1RYLBJNLZdr+XT1WY1VgK00JXC4XC7/BRSmo2c=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,T={},y=[];function A(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,s.jsx)(c(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,s.jsx)(p(),{parameters:void 0}),"\n",(0,s.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"Joe Bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4567832123"},jobTitle:{type:"string",format:"string",example:"dev"},company:{type:"string",format:"string",example:"opensign"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"user"},title:"user"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(A,{...e})}):A(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.89441e90.js b/assets/js/1f73ca32.89441e90.js deleted file mode 100644 index 06a02f799..000000000 --- a/assets/js/1f73ca32.89441e90.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8211],{54472:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>C,contentTitle:()=>g,default:()=>j,frontMatter:()=>h,metadata:()=>s,toc:()=>I});const s=JSON.parse('{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/get-user.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-user","permalink":"/docs/API-docs/get-user","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar_label":"Get your account details","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vt1u2zYUfpVT3mwFFMv5abv5qtnWBdmKtYBTFFhqFJR0JDGmSI48smMYutuT7NH2JMOhLMd22mLGht4kFnn+f76Pa0GyCmJyK94F9GKWiAJD7pUjZY2YiJsa4QoJ+BYu314DGplpDLCyLZCFCol/erBLAzLPbWsICiSpdBiJRFiHXrKt60JMRIUU3STCY3DWBAxishZn4zH/2/c8bfMcQyhbDVsjIhG5NYSGWF46p1UeL9K7wEprEfIaG8m/aOVQTITN7jAnkQjn2Qyp3mV/zEFtJQN5ZSqRiNL6RtLuCd7LxmkW+vlKzc/Os/rdL6JLhJENHmvhF4vwAyKrYyOVPlb/zmKG+HJzMMptw6Zcbc3RoVw8e/7iu/Oz07NzNnFnsxtF+mgrBS5YPbeNk2Z1rLZ1aIKqTDThURIWl/QpIw8qZ+Oz85PT8cn4xc3p88nF95Nnz0fj8fh3kYj7Jtaz74soJMU6U5/W9rt1xVfw0x2KtTz6O2L9d8eCF+OLxxsQd85YgtK2pnjy/w0/em/9l3M/9N3txK2MVgY/Div8kYMf0nj2OI1rs5BaFRE9buwczdfNZNc99e4ft0b1QvFe7KW6e94nGTBvvaKVmNyuxf2JdOqkv5/czrpZIhqk2m7QjgOWVIuJSCuktse+gH6BPkT91msxETWRC5M0DdIUmb0fDUuhZRZ4w1PpVLo4FV1yqCGdO0Ia25PjFALJSpnqy1qzh5pMuW99a/Yqs22QdOpXXIkBOvekEqF4XmqURVwM/i5tVN60441DM1WVic1cnIpDtnqPOrcNMjFRjTCI//3nX1GjsHnboKE4a0/gTevB2SV65hhpCig13qtMYxSWWtvllucCykZjCHoFyhBWXhJCoSpFUgNXRZkKculkprTi6WQx21PjzoCHEbyvkWr0fPWNR5BQ4AI1DzVoa+dshyzIlmwTfWxihqX185JDSkBC1gZlMAQIiIMKmlqaHGHoRQLWgzSAhtA7rwKCVA0Ll9YDlqXKFRvmVfQyJ2ikkRWyswQ4bq6C83ahCgzgbdYGgmB1GxNhjw0O7G8QizCCn9QC+8T5sH8GYAFVyyYSyG2BsNlMTsMUkGEgcOxe5RiNBpKeQOMCfZy92Mmy1RqcZchQUoMt93rLhshLE5ho+oCG1mzL57zl50T0UcjVCD6YD2bKw9IG5AHQyszD5IM5gdvtmL3HLCjC2bfDPiyXy0d78HRf50pR3Wbg0dkHvSoexq3ZVd9+PGVO2V+Y/cn2WKLnbEL/6jIYJ1A61YMa3F6+vY7oCjVq9+CZVR6vLp+mLJhOkUiZKqSD/tOezA3JPMLz5pHCm/vy0E6ESvRNeFNO0S9Ujhvs+Eyp0iicikRolaMJuAPBl1dvX8MCzkdjkeyg0L8oXvr6+sdXv01fcTQMrH3FTkfj0Tg+jWygRpodV1fD2B48WA/xZP1AU//5IbzBP8J7Sp2WKtJMTHO9oYhbMVDELBG1DcRH63UmA77zuuv4+I8WPRPPLBEL6RVHEGknGVCTOWWOK65nnqNjAlpI3fbQe8Cze2R19epGJEK2HMkuWs8jWm9+sPXhyqx2bO/DeB8A/2VG+aTCet0zQddt5furz2psEhykuYCzruv+AeHcZp4=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/opensign-api-v-1"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/createcontact"}}');var o=n(74848),i=n(28453),a=n(33617),r=n.n(a),p=n(17543),c=n.n(p),d=n(86013),l=n.n(d),m=n(63723),u=n.n(m),y=(n(18766),n(79329),n(9303));const h={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vt1u2zYUfpVT3mwFFMv5abv5qtnWBdmKtYBTFFhqFJR0JDGmSI48smMYutuT7NH2JMOhLMd22mLGht4kFnn+f76Pa0GyCmJyK94F9GKWiAJD7pUjZY2YiJsa4QoJ+BYu314DGplpDLCyLZCFCol/erBLAzLPbWsICiSpdBiJRFiHXrKt60JMRIUU3STCY3DWBAxishZn4zH/2/c8bfMcQyhbDVsjIhG5NYSGWF46p1UeL9K7wEprEfIaG8m/aOVQTITN7jAnkQjn2Qyp3mV/zEFtJQN5ZSqRiNL6RtLuCd7LxmkW+vlKzc/Os/rdL6JLhJENHmvhF4vwAyKrYyOVPlb/zmKG+HJzMMptw6Zcbc3RoVw8e/7iu/Oz07NzNnFnsxtF+mgrBS5YPbeNk2Z1rLZ1aIKqTDThURIWl/QpIw8qZ+Oz85PT8cn4xc3p88nF95Nnz0fj8fh3kYj7Jtaz74soJMU6U5/W9rt1xVfw0x2KtTz6O2L9d8eCF+OLxxsQd85YgtK2pnjy/w0/em/9l3M/9N3txK2MVgY/Div8kYMf0nj2OI1rs5BaFRE9buwczdfNZNc99e4ft0b1QvFe7KW6e94nGTBvvaKVmNyuxf2JdOqkv5/czrpZIhqk2m7QjgOWVIuJSCuktse+gH6BPkT91msxETWRC5M0DdIUmb0fDUuhZRZ4w1PpVLo4FV1yqCGdO0Ia25PjFALJSpnqy1qzh5pMuW99a/Yqs22QdOpXXIkBOvekEqF4XmqURVwM/i5tVN60441DM1WVic1cnIpDtnqPOrcNMjFRjTCI//3nX1GjsHnboKE4a0/gTevB2SV65hhpCig13qtMYxSWWtvllucCykZjCHoFyhBWXhJCoSpFUgNXRZkKculkprTi6WQx21PjzoCHEbyvkWr0fPWNR5BQ4AI1DzVoa+dshyzIlmwTfWxihqX185JDSkBC1gZlMAQIiIMKmlqaHGHoRQLWgzSAhtA7rwKCVA0Ll9YDlqXKFRvmVfQyJ2ikkRWyswQ4bq6C83ahCgzgbdYGgmB1GxNhjw0O7G8QizCCn9QC+8T5sH8GYAFVyyYSyG2BsNlMTsMUkGEgcOxe5RiNBpKeQOMCfZy92Mmy1RqcZchQUoMt93rLhshLE5ho+oCG1mzL57zl50T0UcjVCD6YD2bKw9IG5AHQyszD5IM5gdvtmL3HLCjC2bfDPiyXy0d78HRf50pR3Wbg0dkHvSoexq3ZVd9+PGVO2V+Y/cn2WKLnbEL/6jIYJ1A61YMa3F6+vY7oCjVq9+CZVR6vLp+mLJhOkUiZKqSD/tOezA3JPMLz5pHCm/vy0E6ESvRNeFNO0S9Ujhvs+Eyp0iicikRolaMJuAPBl1dvX8MCzkdjkeyg0L8oXvr6+sdXv01fcTQMrH3FTkfj0Tg+jWygRpodV1fD2B48WA/xZP1AU//5IbzBP8J7Sp2WKtJMTHO9oYhbMVDELBG1DcRH63UmA77zuuv4+I8WPRPPLBEL6RVHEGknGVCTOWWOK65nnqNjAlpI3fbQe8Cze2R19epGJEK2HMkuWs8jWm9+sPXhyqx2bO/DeB8A/2VG+aTCet0zQddt5furz2psEhykuYCzruv+AeHcZp4=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,C={},I=[];function f(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,o.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,o.jsx)(c(),{parameters:void 0}),"\n",(0,o.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"Joe Bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4567832123"},jobTitle:{type:"string",format:"string",example:"dev"},company:{type:"string",format:"string",example:"opensign"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"user"},title:"user"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2304e9ae.531003b7.js b/assets/js/2304e9ae.531003b7.js deleted file mode 100644 index 4184b56a6..000000000 --- a/assets/js/2304e9ae.531003b7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8790],{3924:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>C,contentTitle:()=>y,default:()=>N,frontMatter:()=>x,metadata:()=>a,toc:()=>k});const a=JSON.parse('{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/createfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createfolder","permalink":"/docs/API-docs/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tuGzcQ/ZUJX9oAa0l2LkX3qW6aBm6D2KhdBKgiBLO7o13GXJIluZIFYd/6Jf20fkkxpNbWxTHqogj6YljkXM/MnFmuRcDai3wqfjSqIidmmajIl07aII0WubhqCF45wkCQROD04gxQKbP0sDIdBANlup/H+5HIhLHkkA2cVSIX6Trdikw4+r0jH7431Urk6z13F84sZEVQkDJLsOiwpUDuwIvIRGl0IB3YBlqrZBk9jj95NrQWvmyoRf6PHUpHFaeZtDW2xKmGlSWRC1N8ojKITFjHkQdJnvWS7DuWzdeDrA9O6lpkYm5ci2H7hG6wtYqFNC2HOPtMWHSkQ0KPAXmcLdH3mQgyxB/J6MeCsev54i634DqKB94a7VMGJ5PJIcTJxgbOCnxXluT9vFNq9eQxsD4MXjp+fLq2OS6am5NPlpH7f1TgpxON/sW1vCC2tcHtNNxn5k7pZHLy7Oh4cjT55ur4Zf782/zFy9FkMvlNZOKmVawbmzAXFYZodyjx8Luz1Rfw0++LJdAqCiiVFwetx13XZ+L5fY11aVoKjdQ1LEkHWDqj6wysIvQEwa0Aa5QaFAZy/2GnkXPGPQzS4yLbHjipldT0cZiqj88nk4/HtyC8OAThTC9QySqy5JW5Jv1lM912H5L7wxrLJBTvxU6y2+cpSU9l52RYiXy6FjdHaOVRus+ns36WCQbWMMtb42PEGBqRi/Ee6XtyC3I+WumcErloQrA+H4896qowNyNjSXtZa4WFH5WmHaOV48Wx6LN9DbT2EdLUHT1OwQespa4f1prdIXPJ1UsF2sHntkxo5c+0EtkA/7ZUJiR3TUOYhisT3BS/3K3I10Npd/fRNsEd8pvgqko9NzGKTXXPLelLWevYG4tjsb/p35MqTUu8akNDMIj/9cefUaMyZdeSDrF1n8B558CaJbl5pwB1BXNFN7JQdM/3gSdsFXmvViB1oNrxHq9kLQMqYHh5Mku0WEgludlZzLC2g6158SN431BoyPHVV44AoaIFKZ4RUMZcs51gALtg2uhjEzMsjbuec0gZIBSdl5q8B080qJBuUJcEQ1EzMA5QA+lAzjrpCVC2LDw3Dmg+l6VkwzzZDssALWqsiZ1lwHEzCjZ9zHhwpuh8AG9UFxNhjy1RSClqosqP4Ae5oJQ4HyYGpgrqjk1kUJqKYDPonIauoCAfwLJ7WVI06gO6AIoW5GITx0ryagdrmIEkKjDzndqyoeBQe16BKaChNLfwWWf4GyH6qHA1gg/6g2ZShc4TN4CS+trnH/QRTG/b7D0VXgaafT0M1nK5PBiop7s6b2RougIcWXOnV8fDOH7b6rc/nvKu25283c52NCfH2USMatIUOxCtTBwJ09OLs0jW0JCyd55Z5ZAD+HTMguNLCkHq2o8H/afxC8HogGVke2pRqkQB3+3bicxLrvXn80tyC1nShoQ+A9U4Co9FJpQsSXvaYvTTNxdvYQHPRhORbdHZPwBv/Pbs1et3l685GmbohNjxaDKaxC8n40OLesvVzmNgn0TWd6vu370cNpQZ6CaMrUIZ91NMaL1ZLdPd98QsEw1vnnwq1usCPf3qVN/z8e8dOV5bs0ws0EksmAWnsz4b2JZ30TWtOKcU9NEVe2dx1SXi3tvVvCySxmlZkg0Pym4vx4vzyyuRiWLz5mlNxToOl/wewiUzNr+aIjnEJwufrYVCXXdYs2yyyQsCO4Zhe7tcx+2y+YezGq70aivC3bWT0uC/nNS9Cut12lx9fyufrj6rsQF2kObqzfq+/xuvyQAN","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/getfolder"}}');var r=o(74848),s=o(28453),l=o(33617),d=o.n(l),n=o(17543),i=o.n(n),p=o(86013),c=o.n(p),u=o(63723),m=o.n(u),f=(o(18766),o(79329),o(9303));const x={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/ZUJX9oAa0l2LkX3qW6aBm6D2KhdBKgiBLO7o13GXJIluZIFYd/6Jf20fkkxpNbWxTHqogj6YljkXM/MnFmuRcDai3wqfjSqIidmmajIl07aII0WubhqCF45wkCQROD04gxQKbP0sDIdBANlup/H+5HIhLHkkA2cVSIX6Trdikw4+r0jH7431Urk6z13F84sZEVQkDJLsOiwpUDuwIvIRGl0IB3YBlqrZBk9jj95NrQWvmyoRf6PHUpHFaeZtDW2xKmGlSWRC1N8ojKITFjHkQdJnvWS7DuWzdeDrA9O6lpkYm5ci2H7hG6wtYqFNC2HOPtMWHSkQ0KPAXmcLdH3mQgyxB/J6MeCsev54i634DqKB94a7VMGJ5PJIcTJxgbOCnxXluT9vFNq9eQxsD4MXjp+fLq2OS6am5NPlpH7f1TgpxON/sW1vCC2tcHtNNxn5k7pZHLy7Oh4cjT55ur4Zf782/zFy9FkMvlNZOKmVawbmzAXFYZodyjx8Luz1Rfw0++LJdAqCiiVFwetx13XZ+L5fY11aVoKjdQ1LEkHWDqj6wysIvQEwa0Aa5QaFAZy/2GnkXPGPQzS4yLbHjipldT0cZiqj88nk4/HtyC8OAThTC9QySqy5JW5Jv1lM912H5L7wxrLJBTvxU6y2+cpSU9l52RYiXy6FjdHaOVRus+ns36WCQbWMMtb42PEGBqRi/Ee6XtyC3I+WumcErloQrA+H4896qowNyNjSXtZa4WFH5WmHaOV48Wx6LN9DbT2EdLUHT1OwQespa4f1prdIXPJ1UsF2sHntkxo5c+0EtkA/7ZUJiR3TUOYhisT3BS/3K3I10Npd/fRNsEd8pvgqko9NzGKTXXPLelLWevYG4tjsb/p35MqTUu8akNDMIj/9cefUaMyZdeSDrF1n8B558CaJbl5pwB1BXNFN7JQdM/3gSdsFXmvViB1oNrxHq9kLQMqYHh5Mku0WEgludlZzLC2g6158SN431BoyPHVV44AoaIFKZ4RUMZcs51gALtg2uhjEzMsjbuec0gZIBSdl5q8B080qJBuUJcEQ1EzMA5QA+lAzjrpCVC2LDw3Dmg+l6VkwzzZDssALWqsiZ1lwHEzCjZ9zHhwpuh8AG9UFxNhjy1RSClqosqP4Ae5oJQ4HyYGpgrqjk1kUJqKYDPonIauoCAfwLJ7WVI06gO6AIoW5GITx0ryagdrmIEkKjDzndqyoeBQe16BKaChNLfwWWf4GyH6qHA1gg/6g2ZShc4TN4CS+trnH/QRTG/b7D0VXgaafT0M1nK5PBiop7s6b2RougIcWXOnV8fDOH7b6rc/nvKu25283c52NCfH2USMatIUOxCtTBwJ09OLs0jW0JCyd55Z5ZAD+HTMguNLCkHq2o8H/afxC8HogGVke2pRqkQB3+3bicxLrvXn80tyC1nShoQ+A9U4Co9FJpQsSXvaYvTTNxdvYQHPRhORbdHZPwBv/Pbs1et3l685GmbohNjxaDKaxC8n40OLesvVzmNgn0TWd6vu370cNpQZ6CaMrUIZ91NMaL1ZLdPd98QsEw1vnnwq1usCPf3qVN/z8e8dOV5bs0ws0EksmAWnsz4b2JZ30TWtOKcU9NEVe2dx1SXi3tvVvCySxmlZkg0Pym4vx4vzyyuRiWLz5mlNxToOl/wewiUzNr+aIjnEJwufrYVCXXdYs2yyyQsCO4Zhe7tcx+2y+YezGq70aivC3bWT0uC/nNS9Cut12lx9fyufrj6rsQF2kObqzfq+/xuvyQAN",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,C={},k=[];function H(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,r.jsx)(d(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,r.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(i(),{parameters:void 0}),"\n",(0,r.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,r.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function N(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(H,{...e})}):H(e)}}}]); \ No newline at end of file diff --git a/assets/js/2304e9ae.bb7f0628.js b/assets/js/2304e9ae.bb7f0628.js new file mode 100644 index 000000000..c851a9d6a --- /dev/null +++ b/assets/js/2304e9ae.bb7f0628.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8790],{3924:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>h,default:()=>y,frontMatter:()=>g,metadata:()=>r,toc:()=>x});const r=JSON.parse('{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/createfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createfolder","permalink":"/docs/API-docs/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tuGzcQ/ZUJX9oYa0l2LkX3qW7gpm6M2IgcBKgiGNzd0S5jLsmQXF0gLNCH/kH/oJ+WLymG1OqaGHVbBH0RtOTMcObM5ZBL5nnpWDpiP2lZoGXjhBXociuMF1qxlN1UCC8sco8QReDs+gK4lHrmYKEb8BryuD8J+z2WMG3QcjJwUbCUxe24yxJm8WODzv+oiwVLl3vHXVs9FQVChlLPwHDLa/RoD05hCcu18qg82eDGSJGHE/sfHBlaMpdXWHP6RwcKiwWFGbUVr5FC9QuDLGU6+4C5Zwkzljz3Ah3pRdnXJJsuO1nnrVAlS9hE25r77RWc89pIElI46/xsE2a4ReUjegTIw2yxtk2YFz58RKO3GWHX0sYmNm8bDAvOaOViBKeDwSHE0cYKzgJck+fo3KSRcvHoIbDeD15cfni4pjrJqvnpB0PI/T8y8Mup4u7ZnbhGsrXC7cx/zsxG6XRw+uT4ZHA8+O7m5Hn69Pv02fPeYDD4lSVsXkvSDUWYsoL7YLdLcffdmOIrnNPui0XQCvRcSMcOSo+qrk3Y088V1lDX6CuhSpih8jCzWpUJGIncIXi7AF5yoUByj/Y/rDS0Vtv7QXqYZ9sNJ5QUCm+7rrp9OhjcnqxBeHYIwoWacimKMCVv9B2qrxvp9vE+Hn+YYxGFwj7bCXZ7PQbpMG+s8AuWjpZsfsyNOI776WjcjhNGwGqa8ka74DH3FUtZf2/oO7RTtC5YaaxkKau8Ny7t9x1XRabnPW1QOVEqyTPXy3Xd50b0pyesTfY1uDEPkMbm+GEKzvNSqPJ+rfEGmSFlLyZoB591mrgRr3DBkg7+bamECaqaCnlsroRRUbzZUOR5l9pdPtoecIfzjVFWhZro4MUqu1cG1VCUKtTG9ITtM/07lLmukajWVwid+Kff/wwahc6bGpUPpfvovXqvrhoLRs/QThoJXBUwkTgXmcQgj3XYW18SHPJaonNyAUJ5LC2ReSFK4bkEwpjaM+eGZ0IKqngS06RtYatpXA/eVegrtLT1jUXgUOAUJTUK8Mbrmnsy1fkLM23vJnRdSYBD1jih0DlAVXGVk2CXxwS0Ba4AlUdrrHAIzlvyWkTftPKW5x5qrniJZDvZQalAKajIweqscR6clk1wGWiYaosFdAEpxML1CMTzuaEtoNVc18ZiRSU3RSgbUaBLINcFggtVQCGoAjJ0Hgz5InJ0ZLRRUud3IW9E5GA0zRvBJejJjo+k7i1Xjggv+tLlYA2YsZpuBBgdPDp665AyfCnUnUuPjt6rYxiti+kdZk54HH/btc9sNjtom8e7Oi+F/7nJ4A0a7YTXdrHRLoWvmiy02raR9Ue09BIVhvrZaqWNjULn7rBzabVfoTT9IXqqENc/u74II/oxfPrtD7hEbhVUeharNW8sygWU3VGEXMx8hG09YWGiQ+FVhHgei291xyUEiYh3x8Ju21mcoCXwQyI3xxmxMj/q3ATy/t+EGa4vWnmeByrCmgsZ59MP+3YCLaCt3dVkiHYqclxNyC9kuB+E+yxhUuSoHG7RzdnL60uYwpPegCVbs/ZvZLt/efHi/PXwnLyhzoqInfQGvUG41mnna662jtp5qexPuOWGh//Zs2Y1zz3Ofd9ILgJ5hoCWK94b7T52xgmriBbTEVsuM+7wrZVtS8sfG7TEqeOETbkVPKMRPRq3SUcFRJR3uKCYotPHN3Q6icsmssreRYKYLGqc5Tkaf6/sNnNfXw1vWMKy1YOs1gXpWD6jxxqfEZ3Qky6MsvCeorUlk1yVDS9JNtok9qI+2KW+u0B9qz8UVbelFlse7nJiDIN+KajPKiyXkVbbdi0ft76osQK2k6bsjdu2/QuwcTzW","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/getfolder"}}');var a=o(74848),s=o(28453),n=o(33617),i=o.n(n),l=o(17543),c=o.n(l),d=o(86013),p=o.n(d),m=o(63723),u=o.n(m),f=(o(18766),o(79329),o(9303));const g={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/ZUJX9oYa0l2LkX3qW7gpm6M2IgcBKgiGNzd0S5jLsmQXF0gLNCH/kH/oJ+WLymG1OqaGHVbBH0RtOTMcObM5ZBL5nnpWDpiP2lZoGXjhBXociuMF1qxlN1UCC8sco8QReDs+gK4lHrmYKEb8BryuD8J+z2WMG3QcjJwUbCUxe24yxJm8WODzv+oiwVLl3vHXVs9FQVChlLPwHDLa/RoD05hCcu18qg82eDGSJGHE/sfHBlaMpdXWHP6RwcKiwWFGbUVr5FC9QuDLGU6+4C5Zwkzljz3Ah3pRdnXJJsuO1nnrVAlS9hE25r77RWc89pIElI46/xsE2a4ReUjegTIw2yxtk2YFz58RKO3GWHX0sYmNm8bDAvOaOViBKeDwSHE0cYKzgJck+fo3KSRcvHoIbDeD15cfni4pjrJqvnpB0PI/T8y8Mup4u7ZnbhGsrXC7cx/zsxG6XRw+uT4ZHA8+O7m5Hn69Pv02fPeYDD4lSVsXkvSDUWYsoL7YLdLcffdmOIrnNPui0XQCvRcSMcOSo+qrk3Y088V1lDX6CuhSpih8jCzWpUJGIncIXi7AF5yoUByj/Y/rDS0Vtv7QXqYZ9sNJ5QUCm+7rrp9OhjcnqxBeHYIwoWacimKMCVv9B2qrxvp9vE+Hn+YYxGFwj7bCXZ7PQbpMG+s8AuWjpZsfsyNOI776WjcjhNGwGqa8ka74DH3FUtZf2/oO7RTtC5YaaxkKau8Ny7t9x1XRabnPW1QOVEqyTPXy3Xd50b0pyesTfY1uDEPkMbm+GEKzvNSqPJ+rfEGmSFlLyZoB591mrgRr3DBkg7+bamECaqaCnlsroRRUbzZUOR5l9pdPtoecIfzjVFWhZro4MUqu1cG1VCUKtTG9ITtM/07lLmukajWVwid+Kff/wwahc6bGpUPpfvovXqvrhoLRs/QThoJXBUwkTgXmcQgj3XYW18SHPJaonNyAUJ5LC2ReSFK4bkEwpjaM+eGZ0IKqngS06RtYatpXA/eVegrtLT1jUXgUOAUJTUK8Mbrmnsy1fkLM23vJnRdSYBD1jih0DlAVXGVk2CXxwS0Ba4AlUdrrHAIzlvyWkTftPKW5x5qrniJZDvZQalAKajIweqscR6clk1wGWiYaosFdAEpxML1CMTzuaEtoNVc18ZiRSU3RSgbUaBLINcFggtVQCGoAjJ0Hgz5InJ0ZLRRUud3IW9E5GA0zRvBJejJjo+k7i1Xjggv+tLlYA2YsZpuBBgdPDp665AyfCnUnUuPjt6rYxiti+kdZk54HH/btc9sNjtom8e7Oi+F/7nJ4A0a7YTXdrHRLoWvmiy02raR9Ue09BIVhvrZaqWNjULn7rBzabVfoTT9IXqqENc/u74II/oxfPrtD7hEbhVUeharNW8sygWU3VGEXMx8hG09YWGiQ+FVhHgei291xyUEiYh3x8Ju21mcoCXwQyI3xxmxMj/q3ATy/t+EGa4vWnmeByrCmgsZ59MP+3YCLaCt3dVkiHYqclxNyC9kuB+E+yxhUuSoHG7RzdnL60uYwpPegCVbs/ZvZLt/efHi/PXwnLyhzoqInfQGvUG41mnna662jtp5qexPuOWGh//Zs2Y1zz3Ofd9ILgJ5hoCWK94b7T52xgmriBbTEVsuM+7wrZVtS8sfG7TEqeOETbkVPKMRPRq3SUcFRJR3uKCYotPHN3Q6icsmssreRYKYLGqc5Tkaf6/sNnNfXw1vWMKy1YOs1gXpWD6jxxqfEZ3Qky6MsvCeorUlk1yVDS9JNtok9qI+2KW+u0B9qz8UVbelFlse7nJiDIN+KajPKiyXkVbbdi0ft76osQK2k6bsjdu2/QuwcTzW",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,b={},x=[];function j(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,a.jsx)(i(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(c(),{parameters:void 0}),"\n",(0,a.jsx)(p(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.20fd84d2.js b/assets/js/28b19cd2.20fd84d2.js deleted file mode 100644 index 6af55c50d..000000000 --- a/assets/js/28b19cd2.20fd84d2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5772],{98681:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>j,frontMatter:()=>f,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocumentwithtemplateid","permalink":"/docs/API-docs/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztWm1v4zYS/itTfkk3UOwku9u786dud/d6QYtL0KQoDnHgUtLYYpYiVZKyrRr+1l/Sn9ZfchhSr46dl16/3QKLbCLNcIbzxpmH2jDHF5ZNbtkHnZQ5KmfZXcRStIkRhRNasQm7yRDeG+QOoaGCudE5OMwLSY/fXV0Al1KvLFS6BKdhgQoNvVK4grRZG+IK7kvroDB6KVKhFu0aM5GCUNYhT0HPoSyk5p6A+yXmQuKXQoHLEOba5EQTc4tfvQFtIBaKm+oV4BJNBU7k6PVQiCkpkwTleavICG5qsZZWA4MFUaSygtJi6qVZSLiCGGvuNGy5tGhAKIdmzhME7uD2+PgDxuUCfrw4Pr77MnOusJPxmBfFSBeorFgoyWM7SnQ+TomwSOevSOnS+v13xr3pmXM0VVP1H116JYK1EFKc81I6WHJZejOQ0WEl0gWSbTmprr2NhAHFcxy8t2VRaOMA1wkWDkgx7kqDEVjH8yICoYQTXNoIRM4XOJqqsxEcH2POhTw+nqqff/55qjZTBTBltPqUTWDK/Ospi8JzgzzVSlb0bs6lxfp5rXqP5Wtc87yQSIaZsqna1gKm6pykkoDDQsNvL5F5r3Eo5TVJudcx3AgnHxFFJI5IXiYvQT2U94bkJTovuKoOS6sJXmjPYEkolg6kS4dy35LclLtHtkhvXybx7Ozk9O3J+en526Gwr0iYw7WL9fqwvJrgZSLzCohvKO9v3qgZJp8eFdhQvETi7ZRpXwFPzqfsrhN6QuYMZJPjY2hyNONLBK2QMjvXBsFlXPkHIVtdxp0vSJYqUoxgUWJCdSWumsT2Sf937y+ji1Sv1CM+qyleZsSwo7OhEf9BEg1PhYa4dE4/ItVT/c8iWcR0QceD0OoiZRNWl9i6Oq+Ey5pjQaQsYgU3PEeHhk6qjVeHTVjv5GARE3RSFdxlbPf40vE9Ju7CHytNiWURM/hLKQymbOJMiRGzrpK0rBWUSyxiuC6kTpFNwtaYTTLMOZtsmKsKT+mMUAsWMTqQuOs/qTOSVPrXWZwl51kRs+32LohF677RaUVLJVo5VI5+5UUhReKNMr63pPqmJ7NT95ZR6SZj3EWNKmGPZCpDlnUCrWevCTuduTG8InM5zPvPDyxgNG3i4Y67/b1LEl06xZVj2yhU9kdN5An6C9xr7B8FtEpw8GNS7zVCjEjERabVE9Rn56/p3+szoq+Pwz9vk6e1q+vbzMtrkqTHEmstkas+j4+xbdSkzuPr16Uw1mu23UbMn04PsqiXHrPrEAezZu/bF7F5IXMtUzSUrY9pRhu2qNLZbiB0W97tLYWFNr93mkhbYCLmFawydBka/3jFlQO/eldIlfPUQdsRUL86bJWEpVPHlDhlI7iY+6YrvNH0x0CFHi1wlYLScOTlzWzpA+JoXP8d67Q66jgtcIO1zgLTVgVP3Pa5FlZCStKbOs3RdBAFJLbJokbcPoMPbfi+tE7n4MXUTL45bDs8qIvOCN5zBUIlskyxbqXJ4NSHwmbThMDMR8Z2C5sN+RLNjEJ+u426ByRr8MBnYXhiMEGxHHC1j7BjbJ/1WHFdCFPNqB8JD+p2qK+AWCihFrPS1OsoTcSjB2HY+ejZFnxgsNp3tMj/le1IsQt1aVI0z8jhizlY9Cl4RAF8FAHVu2AjYayrMzMEfq26f3vI3vUgIqsRfGwz3ZaxJSrVrNdlkjNisUCDKdQUnjkCaiQAeZKFGuG14nNKcpJeGFwKXdpGvYxbIJtJpK4sDFG1xUbwTdukRdCzDlWLwd5He9KZ5tEb/b5e+gOv+oeMKvMYzQOb+hmWRteaC1JeWZLm51N6wWVS+mkxOB7I8VTOKl2adtDtn7ytpFa/s7eUJ4rHEi9vrp7hadoQnISKGfq64IOwBlzeXMESjZjXbcwIfrStnxrH8wEJJDpFWAoeXB/BKhNJRtavICekAJX3Vyjv3m/dEO8PTTiBhwqlwu7VKAonDCVt6VXbtzCkwmDiZOUDSJcOeJoKYucSrMPCjvYd3cEIN7p8Ts48YUkOi1Kk3tOlaYs5Ghv1oBOCS0yZELOFtDQNnFAHLVEmaG1np8YqRNRbPwJUNrBzmHPr0ERQKo9ymLKgbGiWxHWBRqBKcK8JeiXv6aJLx7QHKXQ4kAs0Viuan7RZcCV+DQFClsm0pX4v4zKQ1mXCQoykFWX3sIg1yMsfv/3OOr0OdqcPFQsSeJoatPYJDf1oF8KJJkGDBVU/PdSI1kPz9S4kRNr5kJzlOm3D1D4/gq7Q5MLZtiY6TVoDSgyImy2TDLjtaq3tAz0e+bERbYk6So8e6YL2i2thHRm3gY/Eoez7AcmOSU8Hj5RRzlBEqaqfPq1eTu8s5ztBYcPTfve2N9IIoXvakzSc57xqATRau0YNUVHlSeHqwz893EcKkecI1fMh1uyfpoteFQ3sOyfmwW561m+nfS/iW+/h7Okf2EIrGwaM89NT+m+4lRZ5beBIWyaU3fNSyuoLFj1/knx8ummm5ZfOudm9OP91nSzPr3zCiYUqjfzzQ9bTg+S+uWgHViRNhlo8bys1hFsaeeL0Ce3lpI1Tv2zP30JJoXDWOHCW6mTW7J7ocrSWL/bG6mM6tO72ncvQ10+IpxDbRuzNvii68P2BB6vUkT/X2vymWadJYMr1BozWBpR2bQo1JFxqXxxcVrdKBBV4Th/mf1k8ojHavNR6VxK5pcnQlUW3k7DwUxZ8c3o6Szojvt1jRLXkUqT+1uNGf0L1F6bfwe12m+uLd0E8qbrOZYdOMBGI/Hs22G3/edikxaQ0wlUeXFuf8EKchPeT2zuCrHJ0mSaYrtDWa0wo24SNh6VuvOnVui2jZc2ygex8FraJZblKY71+eD/CCzFeEmqyy7H3NuUgNZYnL2Owji+EWjzOdddZ6pq8GRw2sFdX7QrxHVIW1O7oU9VYZYacxityAAXJDx0u+LFxdQ/Au22wuD7g1uJtD0C0VnADlLU4WQ8M62FhfVS1wa760FUNgbbo1ACC8kHS4UOMDTGgAK/uYBqMDSf0hqmdOgPXvtHp7O1gaKlV63ffDWDb70YHLeFuR3iwOzvQnNUCQhPiJ2ah5tr7v86zywIVwWc+S5dnDzqTn1AmOox41G005H/89rvnaJLKC/wCLksDhV6hmZfSF+q5xLWgVv7hzatFnku0Vlb+nnLhb2FTsRCOppe6j094wWMhBZUdItNhbOxVLjuCnzrY7cj461NcoqRqBVLrT37c0MBLp3MvozmyVtp8mpNKEXCI6ZqTemiL2LCgyrhKqD6HdPL9J1dh1iuMsAhc5ERMkw/O5yIRvvXRyhmeOMi54gvfSEZAepMV6gPKgtExDY5WyzKMRk5DjujCFv0VzAg+0CjqN+7HZXQUAGmYimwUptI6oWgbKoUY/b01T5xIMAyOjhsHki6dffkIiEcpJRTaBRSCOum+b2khZ7iy/g47jOq1a1rz1WObl5HyagR0R3NNwVJapACQQn2yE7qJum3D7CeMrXDY3T+vVqsHpezVkOdb4bIypq5Xd3wL/9AXvj57+8crFu3WvGFkG5yjByDs4DsAXohwWsHtu6sLf2xChrLoJBPLnitzndgxEY6v0VFDbscN/ytKPIoJHlDSJpl5IfbOWQ5Nbi/n12iWImkavQOmGnviMYuYFAkqi72z9d23V9/DEl6PTlnUO0ieYbzx9xfvP/77+iNpQ2djsNjZ6HR06q8ytHU5Vz1Rez+76F1iDUzfu036/M3G5282Pn+z8fmbjc/fbHz+ZuMv+2ajnm3Io+NCcqF6+EqYCW934C8WsUn/M427iGU0Q05u2WZDte9Huomix7+UaGgAvYvYkhtBvbyfSmrIOu2NIAdOvC9/qEG1V3Dgi4+9+jcDm6Jpzbs9DCOfsNr5xmR7t42aqY1UCxTvgwInN7ROt8IDDICGzsDxLqFa/ihtf+i+ury+YRFrLjJz/0kKM3xFAxpfBW2Dw8InG/RswyRXi9IDTyysSYMmL8lL/Sn1k59S619oV3vtMRxfwzboJ21qL8NmEybg7balD68OctSGbajJOXfb7fa/hJrx9A==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"}}');var r=n(74848),a=n(28453),s=n(33617),o=n.n(s),l=n(17543),d=n.n(l),m=n(86013),p=n.n(m),c=n(63723),u=n.n(c),h=(n(18766),n(79329),n(9303));const f={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWm1v4zYS/itTfkk3UOwku9u786dud/d6QYtL0KQoDnHgUtLYYpYiVZKyrRr+1l/Sn9ZfchhSr46dl16/3QKLbCLNcIbzxpmH2jDHF5ZNbtkHnZQ5KmfZXcRStIkRhRNasQm7yRDeG+QOoaGCudE5OMwLSY/fXV0Al1KvLFS6BKdhgQoNvVK4grRZG+IK7kvroDB6KVKhFu0aM5GCUNYhT0HPoSyk5p6A+yXmQuKXQoHLEOba5EQTc4tfvQFtIBaKm+oV4BJNBU7k6PVQiCkpkwTleavICG5qsZZWA4MFUaSygtJi6qVZSLiCGGvuNGy5tGhAKIdmzhME7uD2+PgDxuUCfrw4Pr77MnOusJPxmBfFSBeorFgoyWM7SnQ+TomwSOevSOnS+v13xr3pmXM0VVP1H116JYK1EFKc81I6WHJZejOQ0WEl0gWSbTmprr2NhAHFcxy8t2VRaOMA1wkWDkgx7kqDEVjH8yICoYQTXNoIRM4XOJqqsxEcH2POhTw+nqqff/55qjZTBTBltPqUTWDK/Ospi8JzgzzVSlb0bs6lxfp5rXqP5Wtc87yQSIaZsqna1gKm6pykkoDDQsNvL5F5r3Eo5TVJudcx3AgnHxFFJI5IXiYvQT2U94bkJTovuKoOS6sJXmjPYEkolg6kS4dy35LclLtHtkhvXybx7Ozk9O3J+en526Gwr0iYw7WL9fqwvJrgZSLzCohvKO9v3qgZJp8eFdhQvETi7ZRpXwFPzqfsrhN6QuYMZJPjY2hyNONLBK2QMjvXBsFlXPkHIVtdxp0vSJYqUoxgUWJCdSWumsT2Sf937y+ji1Sv1CM+qyleZsSwo7OhEf9BEg1PhYa4dE4/ItVT/c8iWcR0QceD0OoiZRNWl9i6Oq+Ey5pjQaQsYgU3PEeHhk6qjVeHTVjv5GARE3RSFdxlbPf40vE9Ju7CHytNiWURM/hLKQymbOJMiRGzrpK0rBWUSyxiuC6kTpFNwtaYTTLMOZtsmKsKT+mMUAsWMTqQuOs/qTOSVPrXWZwl51kRs+32LohF677RaUVLJVo5VI5+5UUhReKNMr63pPqmJ7NT95ZR6SZj3EWNKmGPZCpDlnUCrWevCTuduTG8InM5zPvPDyxgNG3i4Y67/b1LEl06xZVj2yhU9kdN5An6C9xr7B8FtEpw8GNS7zVCjEjERabVE9Rn56/p3+szoq+Pwz9vk6e1q+vbzMtrkqTHEmstkas+j4+xbdSkzuPr16Uw1mu23UbMn04PsqiXHrPrEAezZu/bF7F5IXMtUzSUrY9pRhu2qNLZbiB0W97tLYWFNr93mkhbYCLmFawydBka/3jFlQO/eldIlfPUQdsRUL86bJWEpVPHlDhlI7iY+6YrvNH0x0CFHi1wlYLScOTlzWzpA+JoXP8d67Q66jgtcIO1zgLTVgVP3Pa5FlZCStKbOs3RdBAFJLbJokbcPoMPbfi+tE7n4MXUTL45bDs8qIvOCN5zBUIlskyxbqXJ4NSHwmbThMDMR8Z2C5sN+RLNjEJ+u426ByRr8MBnYXhiMEGxHHC1j7BjbJ/1WHFdCFPNqB8JD+p2qK+AWCihFrPS1OsoTcSjB2HY+ejZFnxgsNp3tMj/le1IsQt1aVI0z8jhizlY9Cl4RAF8FAHVu2AjYayrMzMEfq26f3vI3vUgIqsRfGwz3ZaxJSrVrNdlkjNisUCDKdQUnjkCaiQAeZKFGuG14nNKcpJeGFwKXdpGvYxbIJtJpK4sDFG1xUbwTdukRdCzDlWLwd5He9KZ5tEb/b5e+gOv+oeMKvMYzQOb+hmWRteaC1JeWZLm51N6wWVS+mkxOB7I8VTOKl2adtDtn7ytpFa/s7eUJ4rHEi9vrp7hadoQnISKGfq64IOwBlzeXMESjZjXbcwIfrStnxrH8wEJJDpFWAoeXB/BKhNJRtavICekAJX3Vyjv3m/dEO8PTTiBhwqlwu7VKAonDCVt6VXbtzCkwmDiZOUDSJcOeJoKYucSrMPCjvYd3cEIN7p8Ts48YUkOi1Kk3tOlaYs5Ghv1oBOCS0yZELOFtDQNnFAHLVEmaG1np8YqRNRbPwJUNrBzmHPr0ERQKo9ymLKgbGiWxHWBRqBKcK8JeiXv6aJLx7QHKXQ4kAs0Viuan7RZcCV+DQFClsm0pX4v4zKQ1mXCQoykFWX3sIg1yMsfv/3OOr0OdqcPFQsSeJoatPYJDf1oF8KJJkGDBVU/PdSI1kPz9S4kRNr5kJzlOm3D1D4/gq7Q5MLZtiY6TVoDSgyImy2TDLjtaq3tAz0e+bERbYk6So8e6YL2i2thHRm3gY/Eoez7AcmOSU8Hj5RRzlBEqaqfPq1eTu8s5ztBYcPTfve2N9IIoXvakzSc57xqATRau0YNUVHlSeHqwz893EcKkecI1fMh1uyfpoteFQ3sOyfmwW561m+nfS/iW+/h7Okf2EIrGwaM89NT+m+4lRZ5beBIWyaU3fNSyuoLFj1/knx8ummm5ZfOudm9OP91nSzPr3zCiYUqjfzzQ9bTg+S+uWgHViRNhlo8bys1hFsaeeL0Ce3lpI1Tv2zP30JJoXDWOHCW6mTW7J7ocrSWL/bG6mM6tO72ncvQ10+IpxDbRuzNvii68P2BB6vUkT/X2vymWadJYMr1BozWBpR2bQo1JFxqXxxcVrdKBBV4Th/mf1k8ojHavNR6VxK5pcnQlUW3k7DwUxZ8c3o6Szojvt1jRLXkUqT+1uNGf0L1F6bfwe12m+uLd0E8qbrOZYdOMBGI/Hs22G3/edikxaQ0wlUeXFuf8EKchPeT2zuCrHJ0mSaYrtDWa0wo24SNh6VuvOnVui2jZc2ygex8FraJZblKY71+eD/CCzFeEmqyy7H3NuUgNZYnL2Owji+EWjzOdddZ6pq8GRw2sFdX7QrxHVIW1O7oU9VYZYacxityAAXJDx0u+LFxdQ/Au22wuD7g1uJtD0C0VnADlLU4WQ8M62FhfVS1wa760FUNgbbo1ACC8kHS4UOMDTGgAK/uYBqMDSf0hqmdOgPXvtHp7O1gaKlV63ffDWDb70YHLeFuR3iwOzvQnNUCQhPiJ2ah5tr7v86zywIVwWc+S5dnDzqTn1AmOox41G005H/89rvnaJLKC/wCLksDhV6hmZfSF+q5xLWgVv7hzatFnku0Vlb+nnLhb2FTsRCOppe6j094wWMhBZUdItNhbOxVLjuCnzrY7cj461NcoqRqBVLrT37c0MBLp3MvozmyVtp8mpNKEXCI6ZqTemiL2LCgyrhKqD6HdPL9J1dh1iuMsAhc5ERMkw/O5yIRvvXRyhmeOMi54gvfSEZAepMV6gPKgtExDY5WyzKMRk5DjujCFv0VzAg+0CjqN+7HZXQUAGmYimwUptI6oWgbKoUY/b01T5xIMAyOjhsHki6dffkIiEcpJRTaBRSCOum+b2khZ7iy/g47jOq1a1rz1WObl5HyagR0R3NNwVJapACQQn2yE7qJum3D7CeMrXDY3T+vVqsHpezVkOdb4bIypq5Xd3wL/9AXvj57+8crFu3WvGFkG5yjByDs4DsAXohwWsHtu6sLf2xChrLoJBPLnitzndgxEY6v0VFDbscN/ytKPIoJHlDSJpl5IfbOWQ5Nbi/n12iWImkavQOmGnviMYuYFAkqi72z9d23V9/DEl6PTlnUO0ieYbzx9xfvP/77+iNpQ2djsNjZ6HR06q8ytHU5Vz1Rez+76F1iDUzfu036/M3G5282Pn+z8fmbjc/fbHz+ZuMv+2ajnm3Io+NCcqF6+EqYCW934C8WsUn/M427iGU0Q05u2WZDte9Huomix7+UaGgAvYvYkhtBvbyfSmrIOu2NIAdOvC9/qEG1V3Dgi4+9+jcDm6Jpzbs9DCOfsNr5xmR7t42aqY1UCxTvgwInN7ROt8IDDICGzsDxLqFa/ihtf+i+ury+YRFrLjJz/0kKM3xFAxpfBW2Dw8InG/RswyRXi9IDTyysSYMmL8lL/Sn1k59S619oV3vtMRxfwzboJ21qL8NmEybg7balD68OctSGbajJOXfb7fa/hJrx9A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,y={},g=[];function x(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,r.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,r.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,r.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,r.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,r.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"2",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"3",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"4",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"5",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"6",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"7",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,r.jsxs)(t.ol,{start:"8",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"9",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,r.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.6d63629e.js b/assets/js/28b19cd2.6d63629e.js new file mode 100644 index 000000000..f7500da78 --- /dev/null +++ b/assets/js/28b19cd2.6d63629e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5772],{98681:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>f,default:()=>x,frontMatter:()=>g,metadata:()=>r,toc:()=>b});const r=JSON.parse('{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocumentwithtemplateid","permalink":"/docs/API-docs/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztWl1uHDcSvkqFL7KF1owkW9ndeYpjexNhjUiwZAQLjTBhd9dMU2aTHZI9o85ggH3IDfYGOVpOsiiyf6UZ/SR5WwOGLLGLrGL9seoj18zxhWWTK/ZOJ2WOyll2HbEUbWJE4YRWbMIuM4S3BrlDaKhgbnQODvNC0vCb81PgUuqVhUqX4DQsUKGhTwpXkDZrQ1zBTWkdFEYvRSrUol1jJlIQyjrkKeg5lIXU3BNwv8RcSHwhFLgMYa5NTjQxt/j1a9AGYqG4qV4CLtFU4ESOXg6FmJIwSRCet4KM4LJma2k1MFgQRSorKC2mnpuFhCuIsZ6dhi2XFg0I5dDMeYLAHVzt77/DuFzAp9P9/esXmXOFnYzHvChGukBlxUJJHttRovNxSoRFOn9JQpfW779T7mVPnaOpmqp/69ILEbSFkOKcl9LBksvSq4GUDiuRLpB0y0l07XUkDCie4+C7LYtCGwd4m2DhgATjrjQYgXU8LyIQSjjBpY1A5HyBo6k6GsH+PuZcyP39qfrpp5+maj1VAFNGq0/ZBKbMf56yKIwb5KlWsqJvcy4t1uO16L0p3+AtzwuJpJgpm6pNzWCqjokrMdjNNPz2HJ43GodcXhGXGx3DpXDyAVZE4ojkefwS1EN+r4lfovOCq2o3t5rgmfoMmoRi6UC6dMj3hPim3D2wRfr6PI5HRweHJwfHh8cnQ2ZfEzOHty7Wt7v51QTPY5lXQPOG/P7mlZph8vlBhg3FczheTZn2GfDgeMquO6YHpM5ANtnfhyZGM75E0AopsnNtEFzGlR8I0eoy7nxCspSRYgSLEhPKK3HVBLYP+r97exldpHqlHrBZTfE8JYYdHQ2V+A/iaHgqNMSlc/oBrp7qT7NkEdMFHQ9Cq9OUTVidYuvsvBIua44FkbKIFdzwHB0aOqnWXhw2Yb2Tg0VM0ElVcJexu8eXjm8wcaf+WGlSLIuYwZ9LYTBlE2dKjJh1laRlraBYYhHD20LqFNkkbI3ZJMOcs8mauarwlM4ItWARowOJu/5IHZEk0vdHcZYcZ0XMNpvrwBat+1anFS2VaOVQOfqVF4UUiVfK+MaS6Osez07cK0apm5RxHTWihD2Sqgxp1gm0fnpN2MnMjeEVqcth3h/fsYDRtIn7O+729yZJdOkUV45topDZH1SRJ+gvcKOxfxTQKsHAD3G90QgxIhEXmVaPUB8dv6J/r46Ivj4O/7hOHpeuzm8zz68Jkt6UWGuJXPXneB/bRE3oPLx+nQpjfcs2m4j50+leFPXCY3YR/GDW7H3zrGmeyVzLFA1F60OS0YYtqnR21xG6Ld+tLYWFNr7vFJG2wETMK1hl6DI0fnjFlQO/epdIlfPUQdoRUL06LJWEpVPHlDhlIzid+6IrfNH0x0CEHi1wlYLSsOf5zWzpHWJvXP8d67Ta62Za4AZrmQWmrQieuK1zLayElCQ3VZqj6cALiG0TRQ27bQof6vBtaZ3OwbOpJ/nisK3woE46I3jLFQiVyDLFupQmhVMdCut14wIz7xmbDazXZEs0M3L5zSbqBojXYMBHYRgxmKBYDma1Q9hNbMd6U/G2EKaaUT0SBupyqC+AWCihFrPS1OsoTcSje27Y2ejJGrynsNp2tMj/le5IsFN1ZlI0T4jh0zlY9CG4Rw68FwHlu6AjYayrIzM4fi26/7pL33UjIqsRvG8j3ZaxJSrVrNdFkjNisUCDKdQUfnIEVEgA8iQLOcJLxecU5MS9MLgUurSNeBm3QDqTSFVZaKJqjY3g27ZIi6CnHcoWg72PtoQz9aOX+m299Dte9Q8ZVeYxmns69T0sta71LEh5ZYmb70/pA5dJ6bvFYHggw1M6q3Rp2ka3f/K2nFr5jk4oThSPJZ5dnj/B0rQhOAgZM9R1wQZhDTi7PIclGjGvy5gRfLKtnRrD8wEJJDpFWAoeTB/BKhNJRtqvICekAJW3V0jv3m5dE+8PTTiA+wKlwm6VKAonDAVt6UXbtjCkwmDiZOUdSJcOeJoKms4lWIeFHW07uoMSLnX5lJh5RJMcFqVIvaVL0yZzNDbqQScEl5gyockW0tI0cELttESZoLWdnhqtEFFv/QhQ2TCdw5xbhyaCUnmUw5QFRUOzJN4WaASqBLeqoJfyHk+6dEx7kEKHA7lAY7Wi/kmbBVfil+AgpJlMW6r3Mi4DaZ0mLMRIUlF0D5NYg7z8/utvrJNrZ3V6X7DAgaepQWsfkdC3dsGdqBM0WFD200OJaD0039yFhEg675KzXKetm9qne9A5mlw42+ZEp0lqQIkBcbNlkgG3Xa61faDHIz82oi1RRenRI13QfvFWWEfKbeAjsSv6PiLpMenJ4JEyihnyKFX1w6eVy+k7y/lKUNgw2q/etnoaIXSPW5Ka85xXLYBGa9eoISrKPCmcv/unh/tIILIcoXrexZr9U3fRy6Jh+r0Tk5dOzwzmQj3tzLwIh4Y3otNt2JdO59yJBJql7Ahq0qBup/tRnMOLRlUUHUuhzcut6grLzbRKcCbUzOOkjx9CP/hh8gZ/+sToVoiqL1tjtHC0hgaWZFtlqGCgk95JSZseSHmyux2Z9fsRX8z53mXYvPsBW2hlQ4d2fHhI/w0300LXDZ5ry4TS47yUsvqKRU9vxR9uDxu44blAQXYjjn+5TZbH5z5jiYUqjfzjXerjnfi2xvIOLkuSDKV42lZqDLw08sDpA9rLQRvoftmevYWSQuGsMeAs1cms2T3R5WgtX2wN9odkaM3tS7+hrR9hTy62idjrbV506gssj/apPV8YtAmSmsUmA1KybNB8bUBp1+aghoRL7bOry+pak7AWP9O7+V/mj2iMNs/V3rlEbqm1dmXR7SQs/JgGXx8ezpJOiSdblKiWXIrUXxtd6s+o/sLw27ndbnN99i6wJ1Fvc9nBO0wEIv+dDXbbHw+btJiURrjKo5O3B7wQB+H75OqaML8cXaYJ5yy09RITTDlh42GqG697uW7DaFmzbDBPH4VtYFmu0ljf3r9g4oUYLwl2ujtj63XUTmosD543wTq+EGrx8KzrTlMXZM1gsIG+umxXiH8hRUFtjj5VDfZmyOmsJQOQk3zsgNX3jal7COhVA2b2EcsWsLyHQraMG6SxBRp7aGIPTOzD0g3418f+agy5hfcGGJ53kg5gY2wIogV8+g4oxNgQ4mgmtW17mLWt9zw6GXR9tWj99qVBvPvl/KCmvltS7yxvd1S3NYNQxZHod+qn+vv2soW6VqHm2rtLHZZnBSqCK31QL4/ulTI/okx0aKmpumvIf//1Nz+jiUEv31d0KXJWGij0Cs28lD61zyXeCqptiB5z/61DKpHnEq2Vlb8cXvir71QshKOWsW6eEl7wWEhBqYrIdOjVe9nOjuDHDuvcM/7OGpcoKcO11aFadK3qSpvPc8JMI+AQ05Uy9SuoMq6S0BqFgPMlPlehnS6MoOTuDEktgmxaOcMTBzlXfOFr9GigpRQlIU4WjI6pL7dalqHzdFxIbQIq4Tfkb7n8XdZ7ukIxCDRKSIbBjPxjWbefNgrtv/VxR1tQKcTo3wfwxIkEfZ9QKqmTzwFPKqWEQruA8VBl2peRpjvDlfUvBAIQUtugVVjdFGMQcH//k0Wy8AehPtsJXXwdwFXrTD9ibIXD7lZ/tVrdy28vh3O+E+77MoaPWGgrnDZVN3shXFbGPif2F2n/CCt91zyd6OW8bo1UJ3bLwwKd2HGGshhfoCMPseM356f+bH0Jv//nv/ABuVGQ6VXw1qQ0KKvulQZpLlg+qK09GsMrg9JlpPEkOF8N1tkAXt/J38OwMzhHj0bZwaMQXoh6+atGTCDp/8w26ZAmL+YBMm8SEy/E1qbbocnt2fwCzVIkTdG6w8JjTzxmEZMiQWWxVye8+e78Ayzh1eiQRb1D8QnWHn84ffv+h4v3JA1FVtDY0ehwdOjvtbR1OVc9Vlvf4PRuNAeq710tfnnA8+UBz5cHPF8e8Hx5wPPlAc9f9oCn7tPIouNCcqF6WFHob6/uQHksYpP+m53riGXUD0+u2HpNue8TXUvS8M+lr/OvriO25EZQX+I7rBr5THvt1I4T78XHGiB8CTue/2yVv2k+FXWe3uyhO/mM1Z0HR5vrTdR0oCRaoHgbBDi4pHW6Fe7hGdRAhxlvEsrlD9L2AYTzs4tLFrHmVjv375OY4StqNvkqSBsMFt7v0NiaSa4WpQfRWFhzEyDrbNhxf/Ydd/0L7WqrPoateNgG/aRNbZ2wXodufrNp6cOnnTNqxTbUZJzrzWbzPxTUsr0=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"}}');var i=n(74848),a=n(28453),o=n(33617),s=n.n(o),l=n(17543),d=n.n(l),p=n(86013),m=n.n(p),c=n(63723),u=n.n(c),h=(n(18766),n(79329),n(9303));const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWl1uHDcSvkqFL7KF1owkW9ndeYpjexNhjUiwZAQLjTBhd9dMU2aTHZI9o85ggH3IDfYGOVpOsiiyf6UZ/SR5WwOGLLGLrGL9seoj18zxhWWTK/ZOJ2WOyll2HbEUbWJE4YRWbMIuM4S3BrlDaKhgbnQODvNC0vCb81PgUuqVhUqX4DQsUKGhTwpXkDZrQ1zBTWkdFEYvRSrUol1jJlIQyjrkKeg5lIXU3BNwv8RcSHwhFLgMYa5NTjQxt/j1a9AGYqG4qV4CLtFU4ESOXg6FmJIwSRCet4KM4LJma2k1MFgQRSorKC2mnpuFhCuIsZ6dhi2XFg0I5dDMeYLAHVzt77/DuFzAp9P9/esXmXOFnYzHvChGukBlxUJJHttRovNxSoRFOn9JQpfW779T7mVPnaOpmqp/69ILEbSFkOKcl9LBksvSq4GUDiuRLpB0y0l07XUkDCie4+C7LYtCGwd4m2DhgATjrjQYgXU8LyIQSjjBpY1A5HyBo6k6GsH+PuZcyP39qfrpp5+maj1VAFNGq0/ZBKbMf56yKIwb5KlWsqJvcy4t1uO16L0p3+AtzwuJpJgpm6pNzWCqjokrMdjNNPz2HJ43GodcXhGXGx3DpXDyAVZE4ojkefwS1EN+r4lfovOCq2o3t5rgmfoMmoRi6UC6dMj3hPim3D2wRfr6PI5HRweHJwfHh8cnQ2ZfEzOHty7Wt7v51QTPY5lXQPOG/P7mlZph8vlBhg3FczheTZn2GfDgeMquO6YHpM5ANtnfhyZGM75E0AopsnNtEFzGlR8I0eoy7nxCspSRYgSLEhPKK3HVBLYP+r97exldpHqlHrBZTfE8JYYdHQ2V+A/iaHgqNMSlc/oBrp7qT7NkEdMFHQ9Cq9OUTVidYuvsvBIua44FkbKIFdzwHB0aOqnWXhw2Yb2Tg0VM0ElVcJexu8eXjm8wcaf+WGlSLIuYwZ9LYTBlE2dKjJh1laRlraBYYhHD20LqFNkkbI3ZJMOcs8mauarwlM4ItWARowOJu/5IHZEk0vdHcZYcZ0XMNpvrwBat+1anFS2VaOVQOfqVF4UUiVfK+MaS6Osez07cK0apm5RxHTWihD2Sqgxp1gm0fnpN2MnMjeEVqcth3h/fsYDRtIn7O+729yZJdOkUV45topDZH1SRJ+gvcKOxfxTQKsHAD3G90QgxIhEXmVaPUB8dv6J/r46Ivj4O/7hOHpeuzm8zz68Jkt6UWGuJXPXneB/bRE3oPLx+nQpjfcs2m4j50+leFPXCY3YR/GDW7H3zrGmeyVzLFA1F60OS0YYtqnR21xG6Ld+tLYWFNr7vFJG2wETMK1hl6DI0fnjFlQO/epdIlfPUQdoRUL06LJWEpVPHlDhlIzid+6IrfNH0x0CEHi1wlYLSsOf5zWzpHWJvXP8d67Ta62Za4AZrmQWmrQieuK1zLayElCQ3VZqj6cALiG0TRQ27bQof6vBtaZ3OwbOpJ/nisK3woE46I3jLFQiVyDLFupQmhVMdCut14wIz7xmbDazXZEs0M3L5zSbqBojXYMBHYRgxmKBYDma1Q9hNbMd6U/G2EKaaUT0SBupyqC+AWCihFrPS1OsoTcSje27Y2ejJGrynsNp2tMj/le5IsFN1ZlI0T4jh0zlY9CG4Rw68FwHlu6AjYayrIzM4fi26/7pL33UjIqsRvG8j3ZaxJSrVrNdFkjNisUCDKdQUfnIEVEgA8iQLOcJLxecU5MS9MLgUurSNeBm3QDqTSFVZaKJqjY3g27ZIi6CnHcoWg72PtoQz9aOX+m299Dte9Q8ZVeYxmns69T0sta71LEh5ZYmb70/pA5dJ6bvFYHggw1M6q3Rp2ka3f/K2nFr5jk4oThSPJZ5dnj/B0rQhOAgZM9R1wQZhDTi7PIclGjGvy5gRfLKtnRrD8wEJJDpFWAoeTB/BKhNJRtqvICekAJW3V0jv3m5dE+8PTTiA+wKlwm6VKAonDAVt6UXbtjCkwmDiZOUdSJcOeJoKms4lWIeFHW07uoMSLnX5lJh5RJMcFqVIvaVL0yZzNDbqQScEl5gyockW0tI0cELttESZoLWdnhqtEFFv/QhQ2TCdw5xbhyaCUnmUw5QFRUOzJN4WaASqBLeqoJfyHk+6dEx7kEKHA7lAY7Wi/kmbBVfil+AgpJlMW6r3Mi4DaZ0mLMRIUlF0D5NYg7z8/utvrJNrZ3V6X7DAgaepQWsfkdC3dsGdqBM0WFD200OJaD0039yFhEg675KzXKetm9qne9A5mlw42+ZEp0lqQIkBcbNlkgG3Xa61faDHIz82oi1RRenRI13QfvFWWEfKbeAjsSv6PiLpMenJ4JEyihnyKFX1w6eVy+k7y/lKUNgw2q/etnoaIXSPW5Ka85xXLYBGa9eoISrKPCmcv/unh/tIILIcoXrexZr9U3fRy6Jh+r0Tk5dOzwzmQj3tzLwIh4Y3otNt2JdO59yJBJql7Ahq0qBup/tRnMOLRlUUHUuhzcut6grLzbRKcCbUzOOkjx9CP/hh8gZ/+sToVoiqL1tjtHC0hgaWZFtlqGCgk95JSZseSHmyux2Z9fsRX8z53mXYvPsBW2hlQ4d2fHhI/w0300LXDZ5ry4TS47yUsvqKRU9vxR9uDxu44blAQXYjjn+5TZbH5z5jiYUqjfzjXerjnfi2xvIOLkuSDKV42lZqDLw08sDpA9rLQRvoftmevYWSQuGsMeAs1cms2T3R5WgtX2wN9odkaM3tS7+hrR9hTy62idjrbV506gssj/apPV8YtAmSmsUmA1KybNB8bUBp1+aghoRL7bOry+pak7AWP9O7+V/mj2iMNs/V3rlEbqm1dmXR7SQs/JgGXx8ezpJOiSdblKiWXIrUXxtd6s+o/sLw27ndbnN99i6wJ1Fvc9nBO0wEIv+dDXbbHw+btJiURrjKo5O3B7wQB+H75OqaML8cXaYJ5yy09RITTDlh42GqG697uW7DaFmzbDBPH4VtYFmu0ljf3r9g4oUYLwl2ujtj63XUTmosD543wTq+EGrx8KzrTlMXZM1gsIG+umxXiH8hRUFtjj5VDfZmyOmsJQOQk3zsgNX3jal7COhVA2b2EcsWsLyHQraMG6SxBRp7aGIPTOzD0g3418f+agy5hfcGGJ53kg5gY2wIogV8+g4oxNgQ4mgmtW17mLWt9zw6GXR9tWj99qVBvPvl/KCmvltS7yxvd1S3NYNQxZHod+qn+vv2soW6VqHm2rtLHZZnBSqCK31QL4/ulTI/okx0aKmpumvIf//1Nz+jiUEv31d0KXJWGij0Cs28lD61zyXeCqptiB5z/61DKpHnEq2Vlb8cXvir71QshKOWsW6eEl7wWEhBqYrIdOjVe9nOjuDHDuvcM/7OGpcoKcO11aFadK3qSpvPc8JMI+AQ05Uy9SuoMq6S0BqFgPMlPlehnS6MoOTuDEktgmxaOcMTBzlXfOFr9GigpRQlIU4WjI6pL7dalqHzdFxIbQIq4Tfkb7n8XdZ7ukIxCDRKSIbBjPxjWbefNgrtv/VxR1tQKcTo3wfwxIkEfZ9QKqmTzwFPKqWEQruA8VBl2peRpjvDlfUvBAIQUtugVVjdFGMQcH//k0Wy8AehPtsJXXwdwFXrTD9ibIXD7lZ/tVrdy28vh3O+E+77MoaPWGgrnDZVN3shXFbGPif2F2n/CCt91zyd6OW8bo1UJ3bLwwKd2HGGshhfoCMPseM356f+bH0Jv//nv/ABuVGQ6VXw1qQ0KKvulQZpLlg+qK09GsMrg9JlpPEkOF8N1tkAXt/J38OwMzhHj0bZwaMQXoh6+atGTCDp/8w26ZAmL+YBMm8SEy/E1qbbocnt2fwCzVIkTdG6w8JjTzxmEZMiQWWxVye8+e78Ayzh1eiQRb1D8QnWHn84ffv+h4v3JA1FVtDY0ehwdOjvtbR1OVc9Vlvf4PRuNAeq710tfnnA8+UBz5cHPF8e8Hx5wPPlAc9f9oCn7tPIouNCcqF6WFHob6/uQHksYpP+m53riGXUD0+u2HpNue8TXUvS8M+lr/OvriO25EZQX+I7rBr5THvt1I4T78XHGiB8CTue/2yVv2k+FXWe3uyhO/mM1Z0HR5vrTdR0oCRaoHgbBDi4pHW6Fe7hGdRAhxlvEsrlD9L2AYTzs4tLFrHmVjv375OY4StqNvkqSBsMFt7v0NiaSa4WpQfRWFhzEyDrbNhxf/Ydd/0L7WqrPoateNgG/aRNbZ2wXodufrNp6cOnnTNqxTbUZJzrzWbzPxTUsr0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,j={},b=[];function y(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,i.jsx)(s(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,i.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"7",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"8",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"9",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(m(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.29f1f4c8.js b/assets/js/2c586be5.29f1f4c8.js deleted file mode 100644 index 392a1247a..000000000 --- a/assets/js/2c586be5.29f1f4c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9599],{60112:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/createdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocument","permalink":"/docs/API-docs/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztG9lyHLfxV5B5kcWaXXJXlKzwKbLkJEwck2VS5UqRLBo707sDcQYYA5g9zNo3f0k+LV+S6gYwxx5c6ohDV1YP4g7QABqN7kZfuI8sn5jo5Cp6p5KqAGlNdBNHKZhEi9IKJaOT6DID9lYDt8ACFHtzfsp4nquZYZUBbZhVbAISNEJJmLE0zMdGC1ZqNRWpkBOWcsvZTNiMjbiBV8cMZKJSSNlY5NC/ltfyUpQn7H2ZK56yhao0O3/353o2XAbbrg4O3sGomrD3pwcHN19l1pbm5PCQl2VflSCNmMicj0w/UcVhioBlOn4es1kGGnBWlnDJgBuRLxhPUzYT6QSsiZnNQLJElQuWKKVTIbkFE7OST4DJqhiBNjHjMmWF0sCEZJxp4OmiZ1WvMsD+dnH2PRsrXXDbZ+d5ZeJ6uVRoSGy+cNPbDOpdPTOBGsZqIScxK/gdUktY9nMlkjvctgGZ4l8c+Ob8lGh1cHBRlaXSFlL2o9vCycEB9nwDuZoxroHgE1UUSrKSa16ApePKuKVuDT9XQkPqDoXneaDFybXssYMDuyjh5OCAncpUJEgMmhBbmRp72L4DRSIh6EUJiRgLD9oiHVOSzTKRZESTGXfnWeY8cWhqMCUkVkyhO/E8Zguc+B1IFTDIlBa/KGl5TscxBW1FwvP2sSGCCGos1xbJWSohbWj1K7B/+uPB06ND8XyFqKVIrEJI6jHApjyvwHisZjHLEKsfoNRgiNX9vEhImbIMxCTbuh5PP1TGdiZmlUE021j4tcIpEXmByDbmuQEmxh1aFvwOWqsxRTLM8z77ZsFSGPMqtzETyHFWV9Bn3yvLeFnmIuGjHJBzGQoPt5WGHp2yZwePiOQFnfE5STQYxlkqxmPQKJzYSVP4MQE75LNGBZDk2IxLpuTKQScqV3qdhai5S0eWKGlB2j57M+UiJ+TdZg0TMsmrFNgo58ldzEZ5BTHTkDrBXQCqrdgrIQRh3HiaE32YgRy5UEnEXyq/vDDMeKzSPrvMhGnkCTsDqWkRYdpU9VI7VrgykiCIGIOCizwmwsXsgxoxK2wOMQpsyeUiRn0JMbMwtyM1j1mSQXJHvzRPhWKjylol3cZSrcpUzaSn5VhJa8QvGyQy9Hw8RYcxO47Zq5i9jtngKGaDYcwGxzEbvIrZ4HXMhkcxGw5jNjyO2fCVQ2v42tOa1wRuIzAYOirb3w91Ue9+JwxJNipMU+vgWUcHD/rs4KCWJmz76aefruX9tWTsOkLhuo5O2HVUg1xHsetDnYl9A/89x48Xw6/95wI/Xw1f+88ZgQ6O/WeGn8PBtVz6Ba/lkDCxvCgfwAK7vygG/sszEbbRotgW9Bk2oiKKQweeVQcf7Fi29/IC9yKksILnZvt2AsQT2lGD0tqmjnFTxK7bd0TdT2g7bXywh9Sk6yK12uoKAk9YDNd2/7Lvb5btm3fLPpm9t9D5vK2/wq2jarpE1bR9/7X2ekJEWMXp8yjxdZ8MANLM2+ngAZ4QFboYfR4NXiMN8FLaTgDsfUK7b6GDHf6Gd31Hx73By97waHjcoQD6Rg6gKHpp2lssFl+Cemjz+OXR5AkWqrPs0Csda1VscD/IO2igvE1Ev4PJ/g801EfBhoUU/T5yLILFUnt8bSvbqpQvnhk3VRhaG2cI35hmixaa1IV4kPebZEokHnmECSbZCB28PtKgR5Q8TNPDFiWxMU17RdFbacTPHhG+1VgU/TTtr0CunY5rLFiaxmy9eWN7mrKiKLY0u/briEyqPyLre0tsO/d7gN9KABo+7y78oHBgPEDJnNYmJ22zdKxcIZmQvsOzClsB0DCpcq5hjt6mEUo66C8vOUFwGnudvFNy7Mj3d6RgX515m/y5Z2rcQncCbNk9bm1n7Uk0TGBOcySVsapAZETKcYaYmSrJ0HvjwfRHujdxGvpKeCkwSpCDtdQKNulvQsKdWsvDxlNddbAN2M5muGFh5AYfm46f2HtwRNebdzAeuN88xBNS8SsoYacLV2D31XVUcLIAkMug+a1sBvo6uqnHOK8a0h1jbx4hR5lIIecjyNe7Hi0D7b14fmoRBjsKIetIAOF7FLc6+Xyl0/UtN8iW23GbqYMSD6IRSMxyYUIspEuv9mgfLKIQngSgqOAIWBiAAdcguZ/L5jVij+NzpwX84exYAuEYAdaBurDajhU6B9MmDM5RCCmKqqgjjuN61kCywt/mbXrhSIxjhxXap7u2Ap/vWAHDe9sXuJYDigyEiMIDtp6HeELKYAWlh+X0U9RE5478QpfbbgEM22oL4IYrEUHdZVgLn9kufX12hhcQRjndIIxbJQmUFmNcnyuaNcqPvoIoCtSObG3nvDbUE+K+DWj9lznQw/02XNje3u+IEztoP5obXRyv4JMHnF3qfkL85/FZOdwojlSJmU+h5GkanUQJJUtDdi+KaWow9huVLqKT+8hH2vGnj2Pj0MMPBtOt95FJMig4/gooYYIWE6RRTMFi0CaKIwq9YLYW6RWdRGr0ARJcrdSIjhVgcA4ad3IfoFyGMYq9Ix6dRC71GMURzHlRInC0kpst03G0DAs+NFXd0kxl6Eed6sR5MIn3idN8j0OXKwnqT5rpXWsG2lsBl+qtwj4L7/jCtOZ1N320mhfHMSgHiR/FUr4wKFqVcUZZwvOkytGph3kp9KKOMJBn3+KPGt96pRrfwctlc+gNSlxrvojiSFgo2u1bmECrjz+5BBRShsK8Hzv2g4IRwJ98A6bh6eB58dFYfFDARkCHXmZKfvT4wfDFYDh4MRjiDD4/8+l0dL3rGHQZ4w26o5AGQ73XpFRjRmmN/i4eDfC0bT6B3cx4uS3V3srwmUxVeYq5M+C6TxnvTy6m6PJ3fR31d3DzMo7muzczZ4nqhTw++yqHsWVVWYJmidIS9PN2MO/JbG54fLyMo8Xu7S1+l9v7Gg9vtnt3P1IBRFMc8r/A9cXrZRxlu3H9a12i8T9E9vjVsrldV4yH25FKF7dBby13AYaLAuHGKk9Bo0Gyrq8aVYMaBkuLblf1/EipHLjcoGg6uXlfBIZ2IZqEPpo9ywDN6sZcpNkbC9UbkA5bzPfDSrBRGDQEdQXXUZ+djlv2LsUKVssDAiyl6qViz2i9W1ORGn926L+RRs/aZVBYmdJE8QMKBMwsFGVOdUQzkeeIN97rfVb/I8uvpiQiEK7LsPDuq+KtC2rSgn5QtwiHeduxz95yWRdidAse2P19zQbEHcslu7/HUwV9i5fuchk3DbhWp4HuVdeiIQEx7Yyqm6AZWLe1hjoT5xZNHNfgE2NtBMRECjm5rbSfBy3B5bK/xpDNaT2agmsE86eIk/xf0Q4RO5VnOgX9CGk+HTs3TrFnyMDPfNCcaCS0sV5GnQh41F3uawu9fZEDen/f1jJvqpFBKBnma2TKajGZABYgegga7EuGgCeZ0xaEFR+juFNRoYapUJUJ6GXc1GZ4ihDCiZCQk64X2qIOVXS1997fJM4Sa4zOLs8fQUvykXtOOzkH0+3SzcHOLs+xTFGMvb/XZ+9NTYlAWt4BYeh/sangoZSpNukWLowJkijiVGmnprTvCwR7bB2hVJiNGMVNIqUu6l2buKljxSNSlcUCWuGrs4yF0nToSFjUhLxU1WO4cgclOZtUlIe1eFMHdUnJnabMUEhjdeVCuCytdKis9GyBkAkY09ApUAWBWvPHDKRxwzkbc2NBx6ySAimvK4yg1FPCvAQtQCawkQQaHOlQhnfrtW7N3vsfvvPVy2EPQShHKIFuYkhZVRLXkCTUtaTh5Fa3vlF3eAW2G0G8tKni00fvS9BGSYaVmnrCpfjFsTA5IsqgF5fx3IF6VYFZbMQHJbyLTDCx/v3rv1p4bXVF1xFzK/A0xZTiDgwpguYYHiP3GkrUgKqLEc4H+k+rth9iR0JzW6i0FiTzeB4/xwJja2q9aBUVpEMOrno+pDhrfWvioGON9yYx06kpI4nEtqrE/cJcGNuqhgw1C+v64QdAOiYtHMj7QKlGnpeLtoDXePmqy2Y6sgtFt5K2tn5XZOFhK9aZuU3sy6tirA5X0jhHfHh0hH+6JK1fJ/hJkXjI6OMqzxd/iOLHB94ejgK45s2W9UNuffZBDH+ZJ9PheeSDOl1N8JHBiE+KzOCY1bjMFn304Fa8P1TpHJ8+4F56NS/QtK0zFjIXEm7DAd6mKrkNu0e4AozpBjkehUN93GQhdM96x/LIYss4Ot7ERReqAJuR6OC8M63wRUaZA8cXAnrB+IQLydA10F+QqUBrpR/21T4Os4dIcHx0dDuoifBynQinkvLi9M7nUt2B/G132l7euuUR1XlBjOrup0g4IOqPOpttt7tNGkgqLewiOrm6j+Y9Xoqe6z+5ulneIAvaTGHsvlSGMOY2i06iw7VQvgE9pVDs1b2Tm1oUDJcpJq/XwgO8FIfTQbSMV0dsDCZshYaq93EDjOUTIScPj7ppaHOB5+eOqEOhRj+V4u+ACsofQBsqjgTyTQYcHQ8kObLFD03i49twuCElsSnL0Bziat4gpA06mYDVO3VDbH9zaH/wshVUvwrxcQp51xHvTUHseushLF1HpVuB5lac+aph8jqkGyK6AwqFDo+PKWb49YCCay9eU9zq+NWS2LKJ4URRN05DGarVaEMUdX3nMKj2B/2oxqlx6dKOde6butZqmKm2Djsm2qqFttVa2mIsBQtZyLEifvNMcFaCvEAHBPXAdLAeaoQ8UUX9BCSA//vXf9GIwDy0zB/YWaVZqWagx5V7RzLOYS7Q5G+9ZgyBLOBFDsbkC4aW/oTeNaZiQqVkwY5OeMlHIheo2BBMucROSzeaPvuxCYU9066qbgo56kOWK0XP/NDmq6wqaI1wqc2UvhsjSjHjbIQvw9CSNQBhCMiMywSjaU58yQrEZ43omZRaGGBcFAiMHhKMxyIRZBwpaTVPLCu45BMy52IKeSIVyvCuS6sROphG5ZVzofB1GYB1W6R8c5+9Q5eVNk4JLbB47KnznkzsvFcvPv7Z5AgjBSUuLxIwTf1tDlPQpK5c7KHKc1Yq6+IBaM+2zxYnsppLg9aBT6b5o6nJ530cWiPliz7DpDNeoGjpIwPkQt65R45XNZv9CCMjLDTh3tlstqY6n3fH/EXYrBqh16CacRNqJEXbHl5/PI/iVR3b5WwNY6AUYfdlLS+Fuw/Z1ZvzU7qYWQZ52ayMQzZEqFViDhHw8AIsugXmMIx/jlcn8gR38cogwrwUG70dfBFpzsYXoKciCabgFlIdEvBhFEe5SEAaaN3eb/5y/h2bshf9oyhuXVyPIN7hd6dvv/3+4lvEBu9iR7FB/6h/RPkyZWzBZWuplcfLq2qklZDfv3Xev3Xev3Xev3Xev3X+3bzG3b913r913r913r913r913r91/u8RYf/Wef/Wef/Wef/Wef/Wef/Wef/Wef/Wef/Wef/Wef/Wef/W+cu9NN2/dd6/dd6/dX7qnLh/6xwKWtAqPCxzLmSrhNCVTV2tvoC+iaMM66pOrqL7e0z/vcdXDNj8cwUai7Ju4mjKtcAgN5VkxaGSCEto7gBrWd66mH3vEtePHbtTnnqlEg0LodyIN3TsD8K2S7/Ozy4uozgKz04KleIYzWf4gpvPXBGMpyY9quX0Gi7nclJRRU/k5sTiJ17ZrFs5dUeVU/5HqzCIy0ULw25JldsG/o+b2jjg/t5VZS2XNbzr2jrCEzZA4/ndLJfL/wClD6Z6","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztG9lyHLfxV5B5kcWaXXJXlKzwKbLkJEwck2VS5UqRLBo707sDcQYYA5g9zNo3f0k+LV+S6gYwxx5c6ohDV1YP4g7QABqN7kZfuI8sn5jo5Cp6p5KqAGlNdBNHKZhEi9IKJaOT6DID9lYDt8ACFHtzfsp4nquZYZUBbZhVbAISNEJJmLE0zMdGC1ZqNRWpkBOWcsvZTNiMjbiBV8cMZKJSSNlY5NC/ltfyUpQn7H2ZK56yhao0O3/353o2XAbbrg4O3sGomrD3pwcHN19l1pbm5PCQl2VflSCNmMicj0w/UcVhioBlOn4es1kGGnBWlnDJgBuRLxhPUzYT6QSsiZnNQLJElQuWKKVTIbkFE7OST4DJqhiBNjHjMmWF0sCEZJxp4OmiZ1WvMsD+dnH2PRsrXXDbZ+d5ZeJ6uVRoSGy+cNPbDOpdPTOBGsZqIScxK/gdUktY9nMlkjvctgGZ4l8c+Ob8lGh1cHBRlaXSFlL2o9vCycEB9nwDuZoxroHgE1UUSrKSa16ApePKuKVuDT9XQkPqDoXneaDFybXssYMDuyjh5OCAncpUJEgMmhBbmRp72L4DRSIh6EUJiRgLD9oiHVOSzTKRZESTGXfnWeY8cWhqMCUkVkyhO/E8Zguc+B1IFTDIlBa/KGl5TscxBW1FwvP2sSGCCGos1xbJWSohbWj1K7B/+uPB06ND8XyFqKVIrEJI6jHApjyvwHisZjHLEKsfoNRgiNX9vEhImbIMxCTbuh5PP1TGdiZmlUE021j4tcIpEXmByDbmuQEmxh1aFvwOWqsxRTLM8z77ZsFSGPMqtzETyHFWV9Bn3yvLeFnmIuGjHJBzGQoPt5WGHp2yZwePiOQFnfE5STQYxlkqxmPQKJzYSVP4MQE75LNGBZDk2IxLpuTKQScqV3qdhai5S0eWKGlB2j57M+UiJ+TdZg0TMsmrFNgo58ldzEZ5BTHTkDrBXQCqrdgrIQRh3HiaE32YgRy5UEnEXyq/vDDMeKzSPrvMhGnkCTsDqWkRYdpU9VI7VrgykiCIGIOCizwmwsXsgxoxK2wOMQpsyeUiRn0JMbMwtyM1j1mSQXJHvzRPhWKjylol3cZSrcpUzaSn5VhJa8QvGyQy9Hw8RYcxO47Zq5i9jtngKGaDYcwGxzEbvIrZ4HXMhkcxGw5jNjyO2fCVQ2v42tOa1wRuIzAYOirb3w91Ue9+JwxJNipMU+vgWUcHD/rs4KCWJmz76aefruX9tWTsOkLhuo5O2HVUg1xHsetDnYl9A/89x48Xw6/95wI/Xw1f+88ZgQ6O/WeGn8PBtVz6Ba/lkDCxvCgfwAK7vygG/sszEbbRotgW9Bk2oiKKQweeVQcf7Fi29/IC9yKksILnZvt2AsQT2lGD0tqmjnFTxK7bd0TdT2g7bXywh9Sk6yK12uoKAk9YDNd2/7Lvb5btm3fLPpm9t9D5vK2/wq2jarpE1bR9/7X2ekJEWMXp8yjxdZ8MANLM2+ngAZ4QFboYfR4NXiMN8FLaTgDsfUK7b6GDHf6Gd31Hx73By97waHjcoQD6Rg6gKHpp2lssFl+Cemjz+OXR5AkWqrPs0Csda1VscD/IO2igvE1Ev4PJ/g801EfBhoUU/T5yLILFUnt8bSvbqpQvnhk3VRhaG2cI35hmixaa1IV4kPebZEokHnmECSbZCB28PtKgR5Q8TNPDFiWxMU17RdFbacTPHhG+1VgU/TTtr0CunY5rLFiaxmy9eWN7mrKiKLY0u/briEyqPyLre0tsO/d7gN9KABo+7y78oHBgPEDJnNYmJ22zdKxcIZmQvsOzClsB0DCpcq5hjt6mEUo66C8vOUFwGnudvFNy7Mj3d6RgX515m/y5Z2rcQncCbNk9bm1n7Uk0TGBOcySVsapAZETKcYaYmSrJ0HvjwfRHujdxGvpKeCkwSpCDtdQKNulvQsKdWsvDxlNddbAN2M5muGFh5AYfm46f2HtwRNebdzAeuN88xBNS8SsoYacLV2D31XVUcLIAkMug+a1sBvo6uqnHOK8a0h1jbx4hR5lIIecjyNe7Hi0D7b14fmoRBjsKIetIAOF7FLc6+Xyl0/UtN8iW23GbqYMSD6IRSMxyYUIspEuv9mgfLKIQngSgqOAIWBiAAdcguZ/L5jVij+NzpwX84exYAuEYAdaBurDajhU6B9MmDM5RCCmKqqgjjuN61kCywt/mbXrhSIxjhxXap7u2Ap/vWAHDe9sXuJYDigyEiMIDtp6HeELKYAWlh+X0U9RE5478QpfbbgEM22oL4IYrEUHdZVgLn9kufX12hhcQRjndIIxbJQmUFmNcnyuaNcqPvoIoCtSObG3nvDbUE+K+DWj9lznQw/02XNje3u+IEztoP5obXRyv4JMHnF3qfkL85/FZOdwojlSJmU+h5GkanUQJJUtDdi+KaWow9huVLqKT+8hH2vGnj2Pj0MMPBtOt95FJMig4/gooYYIWE6RRTMFi0CaKIwq9YLYW6RWdRGr0ARJcrdSIjhVgcA4ad3IfoFyGMYq9Ix6dRC71GMURzHlRInC0kpst03G0DAs+NFXd0kxl6Eed6sR5MIn3idN8j0OXKwnqT5rpXWsG2lsBl+qtwj4L7/jCtOZ1N320mhfHMSgHiR/FUr4wKFqVcUZZwvOkytGph3kp9KKOMJBn3+KPGt96pRrfwctlc+gNSlxrvojiSFgo2u1bmECrjz+5BBRShsK8Hzv2g4IRwJ98A6bh6eB58dFYfFDARkCHXmZKfvT4wfDFYDh4MRjiDD4/8+l0dL3rGHQZ4w26o5AGQ73XpFRjRmmN/i4eDfC0bT6B3cx4uS3V3srwmUxVeYq5M+C6TxnvTy6m6PJ3fR31d3DzMo7muzczZ4nqhTw++yqHsWVVWYJmidIS9PN2MO/JbG54fLyMo8Xu7S1+l9v7Gg9vtnt3P1IBRFMc8r/A9cXrZRxlu3H9a12i8T9E9vjVsrldV4yH25FKF7dBby13AYaLAuHGKk9Bo0Gyrq8aVYMaBkuLblf1/EipHLjcoGg6uXlfBIZ2IZqEPpo9ywDN6sZcpNkbC9UbkA5bzPfDSrBRGDQEdQXXUZ+djlv2LsUKVssDAiyl6qViz2i9W1ORGn926L+RRs/aZVBYmdJE8QMKBMwsFGVOdUQzkeeIN97rfVb/I8uvpiQiEK7LsPDuq+KtC2rSgn5QtwiHeduxz95yWRdidAse2P19zQbEHcslu7/HUwV9i5fuchk3DbhWp4HuVdeiIQEx7Yyqm6AZWLe1hjoT5xZNHNfgE2NtBMRECjm5rbSfBy3B5bK/xpDNaT2agmsE86eIk/xf0Q4RO5VnOgX9CGk+HTs3TrFnyMDPfNCcaCS0sV5GnQh41F3uawu9fZEDen/f1jJvqpFBKBnma2TKajGZABYgegga7EuGgCeZ0xaEFR+juFNRoYapUJUJ6GXc1GZ4ihDCiZCQk64X2qIOVXS1997fJM4Sa4zOLs8fQUvykXtOOzkH0+3SzcHOLs+xTFGMvb/XZ+9NTYlAWt4BYeh/sangoZSpNukWLowJkijiVGmnprTvCwR7bB2hVJiNGMVNIqUu6l2buKljxSNSlcUCWuGrs4yF0nToSFjUhLxU1WO4cgclOZtUlIe1eFMHdUnJnabMUEhjdeVCuCytdKis9GyBkAkY09ApUAWBWvPHDKRxwzkbc2NBx6ySAimvK4yg1FPCvAQtQCawkQQaHOlQhnfrtW7N3vsfvvPVy2EPQShHKIFuYkhZVRLXkCTUtaTh5Fa3vlF3eAW2G0G8tKni00fvS9BGSYaVmnrCpfjFsTA5IsqgF5fx3IF6VYFZbMQHJbyLTDCx/v3rv1p4bXVF1xFzK/A0xZTiDgwpguYYHiP3GkrUgKqLEc4H+k+rth9iR0JzW6i0FiTzeB4/xwJja2q9aBUVpEMOrno+pDhrfWvioGON9yYx06kpI4nEtqrE/cJcGNuqhgw1C+v64QdAOiYtHMj7QKlGnpeLtoDXePmqy2Y6sgtFt5K2tn5XZOFhK9aZuU3sy6tirA5X0jhHfHh0hH+6JK1fJ/hJkXjI6OMqzxd/iOLHB94ejgK45s2W9UNuffZBDH+ZJ9PheeSDOl1N8JHBiE+KzOCY1bjMFn304Fa8P1TpHJ8+4F56NS/QtK0zFjIXEm7DAd6mKrkNu0e4AozpBjkehUN93GQhdM96x/LIYss4Ot7ERReqAJuR6OC8M63wRUaZA8cXAnrB+IQLydA10F+QqUBrpR/21T4Os4dIcHx0dDuoifBynQinkvLi9M7nUt2B/G132l7euuUR1XlBjOrup0g4IOqPOpttt7tNGkgqLewiOrm6j+Y9Xoqe6z+5ulneIAvaTGHsvlSGMOY2i06iw7VQvgE9pVDs1b2Tm1oUDJcpJq/XwgO8FIfTQbSMV0dsDCZshYaq93EDjOUTIScPj7ppaHOB5+eOqEOhRj+V4u+ACsofQBsqjgTyTQYcHQ8kObLFD03i49twuCElsSnL0Bziat4gpA06mYDVO3VDbH9zaH/wshVUvwrxcQp51xHvTUHseushLF1HpVuB5lac+aph8jqkGyK6AwqFDo+PKWb49YCCay9eU9zq+NWS2LKJ4URRN05DGarVaEMUdX3nMKj2B/2oxqlx6dKOde6butZqmKm2Djsm2qqFttVa2mIsBQtZyLEifvNMcFaCvEAHBPXAdLAeaoQ8UUX9BCSA//vXf9GIwDy0zB/YWaVZqWagx5V7RzLOYS7Q5G+9ZgyBLOBFDsbkC4aW/oTeNaZiQqVkwY5OeMlHIheo2BBMucROSzeaPvuxCYU9066qbgo56kOWK0XP/NDmq6wqaI1wqc2UvhsjSjHjbIQvw9CSNQBhCMiMywSjaU58yQrEZ43omZRaGGBcFAiMHhKMxyIRZBwpaTVPLCu45BMy52IKeSIVyvCuS6sROphG5ZVzofB1GYB1W6R8c5+9Q5eVNk4JLbB47KnznkzsvFcvPv7Z5AgjBSUuLxIwTf1tDlPQpK5c7KHKc1Yq6+IBaM+2zxYnsppLg9aBT6b5o6nJ530cWiPliz7DpDNeoGjpIwPkQt65R45XNZv9CCMjLDTh3tlstqY6n3fH/EXYrBqh16CacRNqJEXbHl5/PI/iVR3b5WwNY6AUYfdlLS+Fuw/Z1ZvzU7qYWQZ52ayMQzZEqFViDhHw8AIsugXmMIx/jlcn8gR38cogwrwUG70dfBFpzsYXoKciCabgFlIdEvBhFEe5SEAaaN3eb/5y/h2bshf9oyhuXVyPIN7hd6dvv/3+4lvEBu9iR7FB/6h/RPkyZWzBZWuplcfLq2qklZDfv3Xev3Xev3Xev3Xev3X+3bzG3b913r913r913r913r913r91/u8RYf/Wef/Wef/Wef/Wef/Wef/Wef/Wef/Wef/Wef/Wef/Wef/W+cu9NN2/dd6/dd6/dX7qnLh/6xwKWtAqPCxzLmSrhNCVTV2tvoC+iaMM66pOrqL7e0z/vcdXDNj8cwUai7Ju4mjKtcAgN5VkxaGSCEto7gBrWd66mH3vEtePHbtTnnqlEg0LodyIN3TsD8K2S7/Ozy4uozgKz04KleIYzWf4gpvPXBGMpyY9quX0Gi7nclJRRU/k5sTiJ17ZrFs5dUeVU/5HqzCIy0ULw25JldsG/o+b2jjg/t5VZS2XNbzr2jrCEzZA4/ndLJfL/wClD6Z6",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,y={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.ae975503.js b/assets/js/2c586be5.ae975503.js new file mode 100644 index 000000000..f3f30fcb9 --- /dev/null +++ b/assets/js/2c586be5.ae975503.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9599],{60112:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/createdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocument","permalink":"/docs/API-docs/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9lyGzmSv4KpF7cVRUqkZbdXT+O2vT3a9VqKlhwdG5JCDVYlWbCrgGoAxaMVjNiH+YP9g/m0/pKNTAB18BDlY3rUsfSDxcKZSGQm8ryLLJ+Y6OQqeqOSqgBpTXQTRymYRIvSCiWjk+gyA/ZaA7fAwij26vyU8TxXM8MqA9owq9gEJGgcJWHG0rAeGy1YqdVUpEJOWMotZzNhMzbiBl4cM5CJSiFlY5FD/1pey0tRnrAPZa54yhaq0uz8zb/Xq+E22HZ1cPAGRtWEfTg9OLj5LrO2NCeHh7ws+6oEacRE5nxk+okqDlMcWKbjpzGbZaABV2UJlwy4EfmC8TRlM5FOwJqY2QwkS1S5YIlSOhWSWzAxK/kEmKyKEWgTMy5TVigNTEjGmQaeLnpW9SoD7D8uzt6zsdIFt312nlcmrrdLhYbE5gu3vM2gPtUTE7BhrBZyErOCf0JsCct+rUTyCY9tQKb4Fye+Oj8lXB0cXFRlqbSFlP3sjnBycIA9P0CuZoxroPGJKgolWck1L8DSdWXcUreGXyuhIXWXwvM84OLkWvbYwYFdlHBycMBOZSoSRAYtiK1Mjf3YvhuKSMKhFyUkYiz80BbqmJJslokkI5zMuLvPMueJA1ODKSGxYgrdhecxW+DCb0CqAEGmtPhNSctzuo4paCsSnrevDQHEocZybRGdpRLShla/A/tvfz14e3Qpnq4QtBSRVQhJPQbYlOcVGA/VLGYZQvUTlBoMkbpfFxEpU5aBmGRb9+Ppx8rYzsKsMghmGwq/V7glQi8Q2sY8N8DEuIPLgn+C1m5MEQ/zvM9+WLAUxrzKbcwEUpzVFfTZe2UZL8tcJHyUA1IuQ+bhttLQo1v25OABkbygOz4njgbDOEvFeAwamRM7aQk/J0CHdNaIAOIcm3HJlFy56ETlSq+TEDV38cgSJS1I22evplzkBLw7rGFCJnmVAhvlPPkUs1FeQcw0pI5xF4BiK/ZCCIcwbjzOCT/MQI5UqCTCL5XfXhhmPFRpn11mwjT8hJ0B1bSJMG2seq4dK9wZURBYjEHBRR4T4mL2UY2YFTaHGBm25HIRo7yEmFmY25GaxyzJIPlEvzRPhWKjylol3cFSrcpUzaTH5VhJa8RvGzgy9Hw+RocxO47Zi5i9jNngKGaDYcwGxzEbvIjZ4GXMhkcxGw5jNjyO2fCFA2v40uOa1whuAzAYOizbPw92Ue6+E4Y4GwWmqWXwrCODB312cFBzE7b98ssv1/LuWjJ2HSFzXUcn7Dqqh1xHsetDmYl9A/89x49nw+/95wI/Xwxf+s8ZDR0c+88MP4eDa7n0G17LIUFieVHeAwV2f1MI/JcnImyjTbEtyDNsREEUhw68qw482LFsn+UZnkVIYQXPzfbjhBGP6EQNSGuHOsZDEbluPxF1P6LjtOHBHhKTrovEaqsrMDxBMVw7/fO+f1m2H95t+2jO3gLn647+Ao+OoukSRdP289fS6xEhYRWmr8PE931SAEgyb8eDH/CIsNCF6Otw8BJxgI/SdgRg7yM6fQsc7PAvvOs7Ou4NnveGR8PjDgbQNnIDiqKXpr3FYvEtsIc6j98eVZ6goTrNDq3SsVbFBvODrINmlNeJ6HdQ2f8LFfVR0GEhRbuPDIugsdQWX1vLtirliyfGLRWm1soZjm9Us0ULTOpCOMj6TTIlEg88jgkq2QgNvD7ioEeYPEzTwxYmsTFNe0XRW2nEzx4hvtVYFP007a+MXLsd11iwNI3ZevPG9jRlRVFsaXbt1xGpVP+GpO81se3U7wf8UQzQ0Hl343uZA/0BSua0Nxlpm7lj5QnJhPQdnlTYygANkyrnGuZobRqhpBv97TknME6jr5N1SoYd2f4OFey7M6+TP/VEjUfoLoAtu+etnay9iIYJzGmNpDJWFQiMSDmuEDNTJRlabzyo/oj3xk9DXwkvBXoJcrCWWsEm/U1AuFtrWdh4q6sGtgHbOQw3LMzcYGPT9RN5D47oefMGxj3vmx/xiET8CkjY6dwV2H11HRWcNACkMmh+K5uBvo5u6jnOqoZ0x9ybB/BRJlLI+Qjy9a4H80D7LJ6eWojBjkLI2hNA8B7FrU4+X+l0fcsNvOVO3CbqIMQDawQUs1yY4Avp4qs92zuLyIUnAcgrOAIWJqDDNXDu15J5DdjD6NxJAX85O7bAcYwG1o66sNuOHToX00YMrlEIKYqqqD2O43rVgLLCv+ZtfOFM9GOHHdq3u7YDn+/YAd172ze4lgPyDASPwj26nh/xiITBCkj38+mXiInOG/mNHrfdDBiO1WbADU8iDnWPYc18Zjv39dkZPkDo5XST0G+VJFBa9HF9LWvWID/4CSIvUNuztZ3y2qMeEfVtAOufTIF+3B9Dhe3j/YkosQP2g6nR+fEKPrnH2KXuR0R/Hp6Vy43iSJUY+RRKnqbRSZRQsDRE96KYlgZjf1DpIjq5i7ynHX96PzZOPfxoMNx6F5kkg4LjrwASBmgxQBrF5CwGbaI4ItcLRmsRX9FJpEYfIcHdSo3gWAEG16B5J3dhlIswRrE3xKOTyIUeoziCOS9KHBytxGbLdBwtw4b3LVW3NEsZ+lGHOnEdDOJ94TLvcepyJUD9RSu9aa1AZyvgUr1W2GfhDV+Y1rrupY9W4+I4B/kg8bNYyhcGWasyTilLeJ5UORr1MC+FXtQeBrLsW/RRw1vvVMM7eL5sLr0BiWvNF1EcCQtFu30LEWj1+TeXgELMkJv3c+d+VDAC+KtvwDA8XTwvPhuKjwrYCOjSy0zJz54/GD4bDAfPBkNcwcdnvhyPrncdgi5hvEJzFNKgqPeakGrMKKzR30WjYTwdm09gNzFebgu1tyJ8JlNVnmLsDLjuU8T7i5MpuvRdP0f9HdS8jKP57sPMWaJ6IY7PvsthbFlVlqBZorQE/bTtzHs0hxseHy/jaLH7eIs/5fG+x8ub7T7dz5QA0SSH/CtgffZyGUfZblj/Vqdo/AuBPX6xbF7XFeXhdqTSxW2QW8tdA8NDgePGKk9Bo0KyLq8aUYMSBlOLblfl/EipHLjcIGg6sXmfBIZ6IaqE3ps9ywDV6kZdpNUbDdUrkA5ajPfDirNRGFQEdQXXUZ+djlv6LvkKVtMDwlgK1UvFntB+t6YiMf7k0H8jjp6006AwM6Xx4gcQaDCzUJQ55RHNRJ4j3Piu91n9jzS/GpMIQHguw8a7n4rXzqlJG/pJ3SQc5nXHPnvNZZ2I0U14YHd3NRkQdSyX7O4ObxX0LT66y2XcNOBenQZ6V12LhgTEtDOrboJmYt3WmupUnFtUcVyDD4y1ARATKeTkttJ+HdQEl8v+GkE2t/VgDK4hzN8iLvL/CncI2Kk80ynoB3Dz6diZcYo9QQJ+4p3mhCOhjfU86ljAg+5iX1vw7ZMc0Pp7W/O8qUYGR8mwXsNTVovJBDAB0Y+gyT5lCHiSOWlBUPExsjslFWqYClWZAF7GTa2GpzhCOBYSctK1QlvYoYyu9tn7m9hZYo7R2eX5A3BJNnLPSSdnYLpTujXY2eU5pimKsbf3+uyDqTERUMs7QxjaX2wqeEhlqlW6hXNjgiSMOFHaySnt+wTBHlsHKBVmI0RxE0ipk3rXFm7yWPGKVGUxgVb47CxjoTQdPBIUNSIvVfUQqtyBSc4mFcVhLb7UQVxScKdJMxTSWF05Fy5LKx0yKz1Z4MgEjGnwFLCCg1rrxwykcdM5G3NjQceskgIxryv0oNRLwrwELUAmsBEFGhzqkId3y7Vuzt6Hn9757OVwhsCUI+RAtzCkrCqJaogT6lzScHOrR98oO7wA2w0gPtqU8em99yVooyTDTE094VL85kiYDBFl0IrLeO6GelGBUWyEBzm8C0xQsX7/+z9acG01RdcBczvwNMWQ4g4IyYPmCB499xpKlICqCxGuB/qvq7ofQkdMc1uotGYk83AaP8cEY2tquWgVJaRDDi57PoQ4a3lr4iBjjbcmMdKpKSKJyLaqxPPCXBjbyoYMOQvr8uEnQDwmLRjI+kCuRpqXizaD13D5rMtmOdILRTeTttZ+13iBV1bdaiiEfNg71XZDWlULgsqqgluRsLCU6XfzozGJu+Hrgn0XQENqnAqln25hVVzuVskEboW8hSnoB9h17+uIEHmCRmBnALINW0CSe86aHNYZlh10cNJ6nShTuw3l8x1mgLMTGuehf8swvV5J4zwZw6Mj/NM9QF3e4RdF6kNJMa7yfPGXKH645/J+N4pr3mya3OcXyT6K4W/zZDo8j7xXrCtKP9Ob80WuLZyz6tjaItDvPYo3KCudY+0InqVXMxMt27pjIXMh4TZc4G2qkttwehxXgDFdL9GDYKivm1Ss7l3v2B5JbBlHx5uo6EIVYDOSPbjuTCssaSlz4MiQesH4hAvJ0LbS35CoQGul7zd2Pw+y+1BwfHR0O6iR8HwdCaeSEguoUOpSfQL5x560vb112yOo84II1T3wkXCDqD/qHLbd7g5pIKm0sIvo5Ooumvd4KXqu/+TqZnmDJGgzhcGPUhmCmNssOokO12IhBvSUfNlXd45valYwXKYY/V/zr/BSHE4H0TJenbHRG7N1NFS9z5tgLJ8IObl/1k2Dmwu8P3dFHQw18qkU/wkooPwFtEfFkUC6yYDji4goR7L4qYkcvQ2XG2I6m8I0zSWuBl5C3KUTSll9wTYERzbHRgbPW1GJqxBgoJhBHTLYFAWojx78+rVbv+Wpbznqrxoir33iwSU+IF/y8PiYnK7fD8g7+ewlOf6OXyyJLBsnWBR1HV0U4lt110RR1/kQJtUGtZ/VWIUu3twxb3xTV90PK9XqdUfHXVVxt6qbW7RNv+WKVlUDskmZwbiSkGNF5Olp5qwEeYEGH4qN6WDdtQt5ooq65CYM//3v/6AZgdYIqr9glPes0qxUM9DjypXujHOYC9R4cDwU1Nd4D4EXORiTLxiaVxMqJk3FhPL3gvGS8JKPRC5QGOIw5aJpLXlq+uznxv/4RLtUxinkKENrnRGLUcP7N1P60xj9mDHjbIRVeGg1gMy4TJyB4hicFG2sHEXjr9TCYHGhRqiFg01Jq3liWcEln5CmHHewlEKOvh/DtBqh/W5UXjkL1XKRK+3ihnQgCulTqPztvMQuckujaachQ6qYejPVxM5N4HjXl6eO0CNTIiwiAdLWK5krrCRFz06V56xU1nlbUF9tw4jTrebSoOrgQ5X+DmqEeQsSjC+H+mAAb/idkJ9c9VOPXdXE9DOMjLDQONFns9maPH3anfOjsH+rRlhbqYywSi+a2RNhs2pEMri9SP3hVvoxFCO3ZGyzRqoSs8GPrxJzmEFeHl6ARQoxh6/OT+n1fsp+/5//Ze+Aa8kyNXPUmlQa8kVT90x1wXTzDm3140s+Cl5hcbElIpWT4DZDDEbx6nvRZTsNY6B4cbfMmpfCL38VwGQI/dccE9UApGLunNdBHPFSbDR9sTzWnI0vQE9FEtTaLTd8SIMPozjKRQLSQEsTefXj+Ts2Zc/6R1HceoQfcNuH705fv31/8RahQc5yGBv0j/pHFDxVxhZctrZaqWRflXGt7Ix94fu+8H1f+L4vfN8Xvv9pSrP3he/7wvd94fu+8H1f+L4vfP/nIWFf+L4vfN8Xvu8L3/eF7/vC933h+77wfV/4vi983xe+7wvfv13Z8b7wfV/4vi98f+yUuC98D8k5qBUeljkXspUO6VLArlbL4W/iKMMcsZOr6O4Ow38fsKQFm3+tKDPl6iaOplwLdHJTelkcsqIwHegTYF7Oa+ez713i/rEjd4pTr2TVYVKXm/GKrv3ese00tvOzi8sojkINUqFSnKP5DMv5+cwl9HhsUoU1p9LInMtJRdlJkVtz6ZKds24W2CfKAvM/WklOXC5aEHbTw9wx8H881MYJd3cuw2y5rMe7rq0zPGLDaLy/m+Vy+X+7lmdD","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9lyGzmSv4KpF7cVRUqkZbdXT+O2vT3a9VqKlhwdG5JCDVYlWbCrgGoAxaMVjNiH+YP9g/m0/pKNTAB18BDlY3rUsfSDxcKZSGQm8ryLLJ+Y6OQqeqOSqgBpTXQTRymYRIvSCiWjk+gyA/ZaA7fAwij26vyU8TxXM8MqA9owq9gEJGgcJWHG0rAeGy1YqdVUpEJOWMotZzNhMzbiBl4cM5CJSiFlY5FD/1pey0tRnrAPZa54yhaq0uz8zb/Xq+E22HZ1cPAGRtWEfTg9OLj5LrO2NCeHh7ws+6oEacRE5nxk+okqDlMcWKbjpzGbZaABV2UJlwy4EfmC8TRlM5FOwJqY2QwkS1S5YIlSOhWSWzAxK/kEmKyKEWgTMy5TVigNTEjGmQaeLnpW9SoD7D8uzt6zsdIFt312nlcmrrdLhYbE5gu3vM2gPtUTE7BhrBZyErOCf0JsCct+rUTyCY9tQKb4Fye+Oj8lXB0cXFRlqbSFlP3sjnBycIA9P0CuZoxroPGJKgolWck1L8DSdWXcUreGXyuhIXWXwvM84OLkWvbYwYFdlHBycMBOZSoSRAYtiK1Mjf3YvhuKSMKhFyUkYiz80BbqmJJslokkI5zMuLvPMueJA1ODKSGxYgrdhecxW+DCb0CqAEGmtPhNSctzuo4paCsSnrevDQHEocZybRGdpRLShla/A/tvfz14e3Qpnq4QtBSRVQhJPQbYlOcVGA/VLGYZQvUTlBoMkbpfFxEpU5aBmGRb9+Ppx8rYzsKsMghmGwq/V7glQi8Q2sY8N8DEuIPLgn+C1m5MEQ/zvM9+WLAUxrzKbcwEUpzVFfTZe2UZL8tcJHyUA1IuQ+bhttLQo1v25OABkbygOz4njgbDOEvFeAwamRM7aQk/J0CHdNaIAOIcm3HJlFy56ETlSq+TEDV38cgSJS1I22evplzkBLw7rGFCJnmVAhvlPPkUs1FeQcw0pI5xF4BiK/ZCCIcwbjzOCT/MQI5UqCTCL5XfXhhmPFRpn11mwjT8hJ0B1bSJMG2seq4dK9wZURBYjEHBRR4T4mL2UY2YFTaHGBm25HIRo7yEmFmY25GaxyzJIPlEvzRPhWKjylol3cFSrcpUzaTH5VhJa8RvGzgy9Hw+RocxO47Zi5i9jNngKGaDYcwGxzEbvIjZ4GXMhkcxGw5jNjyO2fCFA2v40uOa1whuAzAYOizbPw92Ue6+E4Y4GwWmqWXwrCODB312cFBzE7b98ssv1/LuWjJ2HSFzXUcn7Dqqh1xHsetDmYl9A/89x49nw+/95wI/Xwxf+s8ZDR0c+88MP4eDa7n0G17LIUFieVHeAwV2f1MI/JcnImyjTbEtyDNsREEUhw68qw482LFsn+UZnkVIYQXPzfbjhBGP6EQNSGuHOsZDEbluPxF1P6LjtOHBHhKTrovEaqsrMDxBMVw7/fO+f1m2H95t+2jO3gLn647+Ao+OoukSRdP289fS6xEhYRWmr8PE931SAEgyb8eDH/CIsNCF6Otw8BJxgI/SdgRg7yM6fQsc7PAvvOs7Ou4NnveGR8PjDgbQNnIDiqKXpr3FYvEtsIc6j98eVZ6goTrNDq3SsVbFBvODrINmlNeJ6HdQ2f8LFfVR0GEhRbuPDIugsdQWX1vLtirliyfGLRWm1soZjm9Us0ULTOpCOMj6TTIlEg88jgkq2QgNvD7ioEeYPEzTwxYmsTFNe0XRW2nEzx4hvtVYFP007a+MXLsd11iwNI3ZevPG9jRlRVFsaXbt1xGpVP+GpO81se3U7wf8UQzQ0Hl343uZA/0BSua0Nxlpm7lj5QnJhPQdnlTYygANkyrnGuZobRqhpBv97TknME6jr5N1SoYd2f4OFey7M6+TP/VEjUfoLoAtu+etnay9iIYJzGmNpDJWFQiMSDmuEDNTJRlabzyo/oj3xk9DXwkvBXoJcrCWWsEm/U1AuFtrWdh4q6sGtgHbOQw3LMzcYGPT9RN5D47oefMGxj3vmx/xiET8CkjY6dwV2H11HRWcNACkMmh+K5uBvo5u6jnOqoZ0x9ybB/BRJlLI+Qjy9a4H80D7LJ6eWojBjkLI2hNA8B7FrU4+X+l0fcsNvOVO3CbqIMQDawQUs1yY4Avp4qs92zuLyIUnAcgrOAIWJqDDNXDu15J5DdjD6NxJAX85O7bAcYwG1o66sNuOHToX00YMrlEIKYqqqD2O43rVgLLCv+ZtfOFM9GOHHdq3u7YDn+/YAd172ze4lgPyDASPwj26nh/xiITBCkj38+mXiInOG/mNHrfdDBiO1WbADU8iDnWPYc18Zjv39dkZPkDo5XST0G+VJFBa9HF9LWvWID/4CSIvUNuztZ3y2qMeEfVtAOufTIF+3B9Dhe3j/YkosQP2g6nR+fEKPrnH2KXuR0R/Hp6Vy43iSJUY+RRKnqbRSZRQsDRE96KYlgZjf1DpIjq5i7ynHX96PzZOPfxoMNx6F5kkg4LjrwASBmgxQBrF5CwGbaI4ItcLRmsRX9FJpEYfIcHdSo3gWAEG16B5J3dhlIswRrE3xKOTyIUeoziCOS9KHBytxGbLdBwtw4b3LVW3NEsZ+lGHOnEdDOJ94TLvcepyJUD9RSu9aa1AZyvgUr1W2GfhDV+Y1rrupY9W4+I4B/kg8bNYyhcGWasyTilLeJ5UORr1MC+FXtQeBrLsW/RRw1vvVMM7eL5sLr0BiWvNF1EcCQtFu30LEWj1+TeXgELMkJv3c+d+VDAC+KtvwDA8XTwvPhuKjwrYCOjSy0zJz54/GD4bDAfPBkNcwcdnvhyPrncdgi5hvEJzFNKgqPeakGrMKKzR30WjYTwdm09gNzFebgu1tyJ8JlNVnmLsDLjuU8T7i5MpuvRdP0f9HdS8jKP57sPMWaJ6IY7PvsthbFlVlqBZorQE/bTtzHs0hxseHy/jaLH7eIs/5fG+x8ub7T7dz5QA0SSH/CtgffZyGUfZblj/Vqdo/AuBPX6xbF7XFeXhdqTSxW2QW8tdA8NDgePGKk9Bo0KyLq8aUYMSBlOLblfl/EipHLjcIGg6sXmfBIZ6IaqE3ps9ywDV6kZdpNUbDdUrkA5ajPfDirNRGFQEdQXXUZ+djlv6LvkKVtMDwlgK1UvFntB+t6YiMf7k0H8jjp6006AwM6Xx4gcQaDCzUJQ55RHNRJ4j3Piu91n9jzS/GpMIQHguw8a7n4rXzqlJG/pJ3SQc5nXHPnvNZZ2I0U14YHd3NRkQdSyX7O4ObxX0LT66y2XcNOBenQZ6V12LhgTEtDOrboJmYt3WmupUnFtUcVyDD4y1ARATKeTkttJ+HdQEl8v+GkE2t/VgDK4hzN8iLvL/CncI2Kk80ynoB3Dz6diZcYo9QQJ+4p3mhCOhjfU86ljAg+5iX1vw7ZMc0Pp7W/O8qUYGR8mwXsNTVovJBDAB0Y+gyT5lCHiSOWlBUPExsjslFWqYClWZAF7GTa2GpzhCOBYSctK1QlvYoYyu9tn7m9hZYo7R2eX5A3BJNnLPSSdnYLpTujXY2eU5pimKsbf3+uyDqTERUMs7QxjaX2wqeEhlqlW6hXNjgiSMOFHaySnt+wTBHlsHKBVmI0RxE0ipk3rXFm7yWPGKVGUxgVb47CxjoTQdPBIUNSIvVfUQqtyBSc4mFcVhLb7UQVxScKdJMxTSWF05Fy5LKx0yKz1Z4MgEjGnwFLCCg1rrxwykcdM5G3NjQceskgIxryv0oNRLwrwELUAmsBEFGhzqkId3y7Vuzt6Hn9757OVwhsCUI+RAtzCkrCqJaogT6lzScHOrR98oO7wA2w0gPtqU8em99yVooyTDTE094VL85kiYDBFl0IrLeO6GelGBUWyEBzm8C0xQsX7/+z9acG01RdcBczvwNMWQ4g4IyYPmCB499xpKlICqCxGuB/qvq7ofQkdMc1uotGYk83AaP8cEY2tquWgVJaRDDi57PoQ4a3lr4iBjjbcmMdKpKSKJyLaqxPPCXBjbyoYMOQvr8uEnQDwmLRjI+kCuRpqXizaD13D5rMtmOdILRTeTttZ+13iBV1bdaiiEfNg71XZDWlULgsqqgluRsLCU6XfzozGJu+Hrgn0XQENqnAqln25hVVzuVskEboW8hSnoB9h17+uIEHmCRmBnALINW0CSe86aHNYZlh10cNJ6nShTuw3l8x1mgLMTGuehf8swvV5J4zwZw6Mj/NM9QF3e4RdF6kNJMa7yfPGXKH645/J+N4pr3mya3OcXyT6K4W/zZDo8j7xXrCtKP9Ob80WuLZyz6tjaItDvPYo3KCudY+0InqVXMxMt27pjIXMh4TZc4G2qkttwehxXgDFdL9GDYKivm1Ss7l3v2B5JbBlHx5uo6EIVYDOSPbjuTCssaSlz4MiQesH4hAvJ0LbS35CoQGul7zd2Pw+y+1BwfHR0O6iR8HwdCaeSEguoUOpSfQL5x560vb112yOo84II1T3wkXCDqD/qHLbd7g5pIKm0sIvo5Ooumvd4KXqu/+TqZnmDJGgzhcGPUhmCmNssOokO12IhBvSUfNlXd45valYwXKYY/V/zr/BSHE4H0TJenbHRG7N1NFS9z5tgLJ8IObl/1k2Dmwu8P3dFHQw18qkU/wkooPwFtEfFkUC6yYDji4goR7L4qYkcvQ2XG2I6m8I0zSWuBl5C3KUTSll9wTYERzbHRgbPW1GJqxBgoJhBHTLYFAWojx78+rVbv+Wpbznqrxoir33iwSU+IF/y8PiYnK7fD8g7+ewlOf6OXyyJLBsnWBR1HV0U4lt110RR1/kQJtUGtZ/VWIUu3twxb3xTV90PK9XqdUfHXVVxt6qbW7RNv+WKVlUDskmZwbiSkGNF5Olp5qwEeYEGH4qN6WDdtQt5ooq65CYM//3v/6AZgdYIqr9glPes0qxUM9DjypXujHOYC9R4cDwU1Nd4D4EXORiTLxiaVxMqJk3FhPL3gvGS8JKPRC5QGOIw5aJpLXlq+uznxv/4RLtUxinkKENrnRGLUcP7N1P60xj9mDHjbIRVeGg1gMy4TJyB4hicFG2sHEXjr9TCYHGhRqiFg01Jq3liWcEln5CmHHewlEKOvh/DtBqh/W5UXjkL1XKRK+3ihnQgCulTqPztvMQuckujaachQ6qYejPVxM5N4HjXl6eO0CNTIiwiAdLWK5krrCRFz06V56xU1nlbUF9tw4jTrebSoOrgQ5X+DmqEeQsSjC+H+mAAb/idkJ9c9VOPXdXE9DOMjLDQONFns9maPH3anfOjsH+rRlhbqYywSi+a2RNhs2pEMri9SP3hVvoxFCO3ZGyzRqoSs8GPrxJzmEFeHl6ARQoxh6/OT+n1fsp+/5//Ze+Aa8kyNXPUmlQa8kVT90x1wXTzDm3140s+Cl5hcbElIpWT4DZDDEbx6nvRZTsNY6B4cbfMmpfCL38VwGQI/dccE9UApGLunNdBHPFSbDR9sTzWnI0vQE9FEtTaLTd8SIMPozjKRQLSQEsTefXj+Ts2Zc/6R1HceoQfcNuH705fv31/8RahQc5yGBv0j/pHFDxVxhZctrZaqWRflXGt7Ix94fu+8H1f+L4vfN8Xvv9pSrP3he/7wvd94fu+8H1f+L4vfP/nIWFf+L4vfN8Xvu8L3/eF7/vC933h+77wfV/4vi983xe+7wvfv13Z8b7wfV/4vi98f+yUuC98D8k5qBUeljkXspUO6VLArlbL4W/iKMMcsZOr6O4Ow38fsKQFm3+tKDPl6iaOplwLdHJTelkcsqIwHegTYF7Oa+ez713i/rEjd4pTr2TVYVKXm/GKrv3ese00tvOzi8sojkINUqFSnKP5DMv5+cwl9HhsUoU1p9LInMtJRdlJkVtz6ZKds24W2CfKAvM/WklOXC5aEHbTw9wx8H881MYJd3cuw2y5rMe7rq0zPGLDaLy/m+Vy+X+7lmdD",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.1793addd.js b/assets/js/377084eb.1793addd.js deleted file mode 100644 index 51c109075..000000000 --- a/assets/js/377084eb.1793addd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9441],{4741:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>h,contentTitle:()=>g,default:()=>j,frontMatter:()=>f,metadata:()=>p,toc:()=>b});const p=JSON.parse('{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/get-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-template","permalink":"/docs/API-docs/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWFtv3LgV/itn+dINIM/FcZztPK3RDVKjiyaoXQSoMzAo6YzEmCK55NFcMNBbf0l/2v6SxaFGGo3HGcdoEaAv9og6H8/9pq0gWQQxuxO3WDktCYOYJyLHkHnlSFkjZuK2RHiPBB0JXH28Bqm1XQXY2BrIgkfyCpcIOZJUOoBMbU0gITjM1EJlQDvwqL8mQEC/RJABUl2j88pQgIX1kHmUpEwBuc3qCvl4pagE5zHHhTKYQyBfZ1R7DCORCOvQS5b2OhczUSB1PEQinPSyQkLPam6FkRWKmejEuVe5SIRiNZ2kUjzW/foXsIteeKBSEhjEPLDWKcICKSuR7/D4W6085mJGvsZEBNpo5hRU5TQLgmunbY5itpA6MEFWYiXFbCto4yIleWUKkYiF9ZWk9sQUomnmfH1w1gQMDDifTPjfoaihzjIMYVFr6O0hEpFZQ2iI6aVzWmXxxfhLYND2WAqbfsGM2HCeryHVsmyP2b6n5W1PcC2j1jOxnv41NVU4/1iIJhGkiE+Pr9gDQvzRm5xRxtIzoN5BkbRhkXSO/nup1QbVKQFbeSASNntD7ONwJzCLrp4zUUnkwmw87sB1QD/KbMVouzIHep8yVswz20mViKAKE/OkR0vv5YYThLAKz1vT2+dEz9B+m8G+WIQUo1hYSaWfpU4Rf94ddLZwpTXPsLl4c3k+ff3T2ynTr1ReIP0X+rdvj/kdJuoVl07MYSl1jQHOgO0uuZglEEhWbvRM8PX0LPR6wNDUVYp+iO5PevT5xUWTiM0LUW+nbJ8Xgl7/1CSifCHo4pI9Jwt8IW76ZFrdtCF937m2OUUVMzOgya/NB39YPlJrNUozZMhlvklETCLMr+h0oJ1Pzl+fTSdnk7e308vZxZ9nby5Hk8nkXyIR6ypG964z5bui1wnZPdcu/y580MhU462tv019j7nymNF97Z/M0VNxzOziHHFf2ZynhNiawmm+sXuyow7VGfaLx/5lrzeJuHiqa97YCqnkYWOFhmDlrSkScBplQCC/AVlIZYCv8T/879opem+fKdMvk2wY18poZfC+GxnuLyaT+2lvhItjI9wO2icsbG3y76vqU/xPK3Rxf9kr9OZYoWuzlFrlcVK9tQ9ovq8+Q/bUsj+OWNUSxffiQNnheatkwKz2ijZxhF2fSafO2vezuzlPhxwpdjf7xpmXSjET/YAw3g7m3UbwfX7ZTcQxcfuZIkiTp3Y9sg4N9xkt08D9dCydGi+5TT5GSOdeQI312csAgWShTHEaNd+b6Ibd2HrqwFD7nu7U35Cb+s4PQ6rdKlCijMNYw88LG8E773xwaLhdRN8up0fN/RPqzFbI6wGVCB357//+T0R0G00MvR/gQ+3B2RV6ntqlyWGhca1S/dSOFVBWGkPQG1CGsPCcMLkqFEkdRwguFZl0MlVacbAymWW0h0G8hxF8KpFK9PzqTx5BQo5L1BzjoK194HvIgqzJVpHHTmZYWf+wYJESkJDWQRkMvMVhB0FTSpMhdL5IwHqQBtAQeudVQJCqYmJe83CxUJniizkzvcwIKmlkgcwsAZabreC8XaocA3ib1oEgWF1HRZhjhUitinErG8Evaomt4nzYrqOYQ1HzFQlkNkfYJSqrYXJIMRA4Zq8yjJcGkp5A4xJ9jL3oyUWtNTjLFURJzVvh0Ld8EXlpAve7VqDONb35nLe8oEUeudyM4LP5bLjKQx2QA0Ar8xBmn80Z3PVh9gnToAjnP3b5sFqtjvLg1SHmvaKyTsGjs3tcEQ9j1gzh/cMrnhAOE+Ywsj0u0LM20UYFGowRKJ1qaxzcXX28jsUWStRuz5khx6nLp2MmHN8g8bYfxh3+FZdDjgmZxWq9WwA4c39+fE+snOir8GFxg36psm5B+oqpxpF4LBKhVYYm4KAiX73/+Css4fVoIpJBFfoG441/vf7Lu7/fvGNpuLC2FpuOJqNJXERsoEqaAavh95THNWS771T/B99edlWVcE1jp6WKvWw3DLZ96G4/iCViNvzyMk9EaQMxyXabyoD/9Lpp+Pi3Gj13u3kiltIrHkljs8pV4N95/xXlq5b78R+7DzKv4Ns/4jypTNc3DDeNuLTx7JqIB9w8+pLUzHnhaZsHS9tSXGUZOhpgj6aPgxb+/t2tSISsqTxsWg+xae1+8O1PynXYzVoB+C831icB223bEJump29ffRWxU7CjZiPNm6b5A1NICSk=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/update-template"}}');var i=a(74848),n=a(28453),s=a(33617),o=a.n(s),l=a(17543),r=a.n(l),m=a(86013),d=a.n(m),c=a(63723),u=a.n(c),x=(a(18766),a(79329),a(9303));const f={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWFtv3LgV/itn+dINIM/FcZztPK3RDVKjiyaoXQSoMzAo6YzEmCK55NFcMNBbf0l/2v6SxaFGGo3HGcdoEaAv9og6H8/9pq0gWQQxuxO3WDktCYOYJyLHkHnlSFkjZuK2RHiPBB0JXH28Bqm1XQXY2BrIgkfyCpcIOZJUOoBMbU0gITjM1EJlQDvwqL8mQEC/RJABUl2j88pQgIX1kHmUpEwBuc3qCvl4pagE5zHHhTKYQyBfZ1R7DCORCOvQS5b2OhczUSB1PEQinPSyQkLPam6FkRWKmejEuVe5SIRiNZ2kUjzW/foXsIteeKBSEhjEPLDWKcICKSuR7/D4W6085mJGvsZEBNpo5hRU5TQLgmunbY5itpA6MEFWYiXFbCto4yIleWUKkYiF9ZWk9sQUomnmfH1w1gQMDDifTPjfoaihzjIMYVFr6O0hEpFZQ2iI6aVzWmXxxfhLYND2WAqbfsGM2HCeryHVsmyP2b6n5W1PcC2j1jOxnv41NVU4/1iIJhGkiE+Pr9gDQvzRm5xRxtIzoN5BkbRhkXSO/nup1QbVKQFbeSASNntD7ONwJzCLrp4zUUnkwmw87sB1QD/KbMVouzIHep8yVswz20mViKAKE/OkR0vv5YYThLAKz1vT2+dEz9B+m8G+WIQUo1hYSaWfpU4Rf94ddLZwpTXPsLl4c3k+ff3T2ynTr1ReIP0X+rdvj/kdJuoVl07MYSl1jQHOgO0uuZglEEhWbvRM8PX0LPR6wNDUVYp+iO5PevT5xUWTiM0LUW+nbJ8Xgl7/1CSifCHo4pI9Jwt8IW76ZFrdtCF937m2OUUVMzOgya/NB39YPlJrNUozZMhlvklETCLMr+h0oJ1Pzl+fTSdnk7e308vZxZ9nby5Hk8nkXyIR6ypG964z5bui1wnZPdcu/y580MhU462tv019j7nymNF97Z/M0VNxzOziHHFf2ZynhNiawmm+sXuyow7VGfaLx/5lrzeJuHiqa97YCqnkYWOFhmDlrSkScBplQCC/AVlIZYCv8T/879opem+fKdMvk2wY18poZfC+GxnuLyaT+2lvhItjI9wO2icsbG3y76vqU/xPK3Rxf9kr9OZYoWuzlFrlcVK9tQ9ovq8+Q/bUsj+OWNUSxffiQNnheatkwKz2ijZxhF2fSafO2vezuzlPhxwpdjf7xpmXSjET/YAw3g7m3UbwfX7ZTcQxcfuZIkiTp3Y9sg4N9xkt08D9dCydGi+5TT5GSOdeQI312csAgWShTHEaNd+b6Ibd2HrqwFD7nu7U35Cb+s4PQ6rdKlCijMNYw88LG8E773xwaLhdRN8up0fN/RPqzFbI6wGVCB357//+T0R0G00MvR/gQ+3B2RV6ntqlyWGhca1S/dSOFVBWGkPQG1CGsPCcMLkqFEkdRwguFZl0MlVacbAymWW0h0G8hxF8KpFK9PzqTx5BQo5L1BzjoK194HvIgqzJVpHHTmZYWf+wYJESkJDWQRkMvMVhB0FTSpMhdL5IwHqQBtAQeudVQJCqYmJe83CxUJniizkzvcwIKmlkgcwsAZabreC8XaocA3ib1oEgWF1HRZhjhUitinErG8Evaomt4nzYrqOYQ1HzFQlkNkfYJSqrYXJIMRA4Zq8yjJcGkp5A4xJ9jL3oyUWtNTjLFURJzVvh0Ld8EXlpAve7VqDONb35nLe8oEUeudyM4LP5bLjKQx2QA0Ar8xBmn80Z3PVh9gnToAjnP3b5sFqtjvLg1SHmvaKyTsGjs3tcEQ9j1gzh/cMrnhAOE+Ywsj0u0LM20UYFGowRKJ1qaxzcXX28jsUWStRuz5khx6nLp2MmHN8g8bYfxh3+FZdDjgmZxWq9WwA4c39+fE+snOir8GFxg36psm5B+oqpxpF4LBKhVYYm4KAiX73/+Css4fVoIpJBFfoG441/vf7Lu7/fvGNpuLC2FpuOJqNJXERsoEqaAavh95THNWS771T/B99edlWVcE1jp6WKvWw3DLZ96G4/iCViNvzyMk9EaQMxyXabyoD/9Lpp+Pi3Gj13u3kiltIrHkljs8pV4N95/xXlq5b78R+7DzKv4Ns/4jypTNc3DDeNuLTx7JqIB9w8+pLUzHnhaZsHS9tSXGUZOhpgj6aPgxb+/t2tSISsqTxsWg+xae1+8O1PynXYzVoB+C831icB223bEJump29ffRWxU7CjZiPNm6b5A1NICSk=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,h={},b=[];function y(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,i.jsx)(o(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,i.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.a6437b0c.js b/assets/js/377084eb.a6437b0c.js new file mode 100644 index 000000000..38c08967a --- /dev/null +++ b/assets/js/377084eb.a6437b0c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9441],{4741:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>b,default:()=>P,frontMatter:()=>u,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/get-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-template","permalink":"/docs/API-docs/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWO9u2zgSf5VZftltofhP6qZ7/rTBXZENrrgWmywKbGoYFDWW2FAkl6T8B4aA+3BvcG9wj7ZPchjKkuU4jRvsocB9SSxqhvOb/zPassBzz6Z37BZLq3hAz2YJy9ALJ22QRrMpuy0QrjBASwKXH66BK2VWHjamgmDAYXASlwgZBi6VB56aKgAHb1HIhRQQdsyD7hoPHt0SgXtIVYXWSR08LIwD4ZAHqXPIjKhKpOOVDAVYhxkupMYMfHCVCJVDP2AJMxYdJ7TXGZuyHEMrgyXMcsdLDOhIzS3TvEQ2ZS2cucxYwiSpaXko2EPdr/8GZtGBh1DwABox86R1irDAIAqkOxz+XkmHGZsGV2HCfNgokuRlaRUBwbVVJkM2XXDliUAUWHI23bKwsZEyOKlzlrCFcSUPzYnOWV3P6HpvjfboieF8NKJ/h1B9JQR6v6gUdPZgCRNGB9SB6Lm1Sor4YvjZE9P2GIVJP6MIZDhH1wTZiGyOyb5P421OcM2j1lO2Hv+c6tKff8hZnbAgA50eX7Fn8PFHZ3Li0iacYOocFElrgqQydN9KrSaongLY4IFIWO8NsY/DHWCCLk+ZqAjB+ulw2DJXHt1AmJK4zUof6P2UsWKemRZVwrzMdcyTjps7xzeUIAFLf9qazpyCLtB8ncE+G4QUIywsuVQnqVPEn3YHrS1sYfQJMZPXF+fjVz++GRP9SmY5hj+hf/P2WN5hol5S6cQMllxV6OEMyO6cilkCPvDSDk4EX0dPoNc9gboqU3R97u6k4z6fTOqEbZ7J9WZM9nkm06sf64QVz2SaXJDneI7P5Bs/mlY3TUjPW9fWT1HFzPSos2v93h2Wj9QYhVz3BVKZrxMWkwizy/B0oJ2Pzl+djUdnoze344vp5C/T1xeD0Wj0G0vYuozRvetM2a7otSDb58pm30QOap4qvDXV16nvMJMORZhX7tEcfSqOSVycI+alyWhKiK3JPy03dk9irIKZOyylPumplqWhnhstcC71HJfoHs2DjnFEAXFotn5fehhHFF11wiaPdecbU2IoaKhZoQ6wckbnCViF3CMEtwGec6mBrnHf/e/aNjpnTrSD5yHr54/USmqct6PJfDIazcedESbHRrjttWlYmEpn31bVx+Q/rdBkftEp9PpYoWu95EpmcSK+Nfeov60+ffGhEX8csbIhiu/ZgbL980ZJj6JyMmziqLw+41aeNe+ndzOaQilSzG7GjrN1KNiUdYPIcNubq2tG97llO3nHAtHNLp7rLDXrgbGoqZ8pnnrq20Nu5XBJ7fghB7f2GdRYnT2PwQeeS50/zTXbm+iG3Nh46sBQ+9nByr8jDQ87P/SpditHgTwOfTU9L0xk3nnnvUVNbSn6djk+GiI+ohKmRFpDQoHQkv/xr/9EjnZziqH33Sf9Sb+vHFizQkcLAtcZLBSuZaqadQ7L+K5b6DzyUqH3agNSB8wdZU0mcxm4ivMK1QvBLU+lkhSxRGaI20Ev6P0APhYYCnT06nuHwCHDJSoKdKASXh5uerAy7n5Bq2UCHNLKS43eA+qCa0GErfkTMA64BtQBnXXSI+2EhFo22IwOjosAJdc8R7o7ObBShkpSbIIzaeUDeKOqCBlogzUOM2gVigvfgIz4lnY4h0CnwpTWYUGRskTIK5mhT0CYDKHZYUgFnUGKPoAlLFJg3BsrrYy4j35bVEqBNVQvJFe0a/YxEntwXHvqog2W1gedwawztPZhA/Dly189koffSX3vpy9fftJncNcF00dMvQw4+6GN+tVqdRTtLw55rmT4uUrhF7TGy2DcZs+dy1BUacyQ/iXdQ3PTFWqM8dPLgP0dmRH+OOHodFigssMbDBQhfnj54TqW2Bfwxz//De+QOw2FWTXRKiqHagN5K4os13i+MVtXIeMHBl6FgiwumuCj1R19IAvSmHSYzYdp53CBjowfHbkXZ+Xu+rsWJhD6P6Mm1WqKYi5iK9ltQVRWfnp4Tyzr6Er/fnGDbilFuyV+wcPDSDxkCVNSoPbYaxeXVx/ewRJeDUYs6ZXIr/D28N31X9/+4+YtoaHMaiw2HowGo7iNGR9Krnui+h+VHha47b6N/h98gNqV/IDrMLSKy9hodxNx0yTv9lNiwqb9z0+zhBXGByLZblPu8Ven6pqOf6/igHo3S9iSO0lzeeykmfT0O+s+JX3Rcj/8svsq9QK+/kvWo8q0TU1TR4ubKw3wCbvHzYPPafWMtr6msxHahuJSCLShx3s0Gh3MF1dvb1mc8YvDjnofO+ruB93+KK7DVtsAoL/U9R9l2G6bbl3XHX3z6oscOwVbajLSrK7r/wKxyGq/","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/update-template"}}');var r=a(74848),o=a(28453),i=a(33617),s=a.n(i),p=a(17543),l=a.n(p),m=a(86013),c=a.n(m),d=a(63723),h=a.n(d),f=(a(18766),a(79329),a(9303));const u={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWO9u2zgSf5VZftltofhP6qZ7/rTBXZENrrgWmywKbGoYFDWW2FAkl6T8B4aA+3BvcG9wj7ZPchjKkuU4jRvsocB9SSxqhvOb/zPassBzz6Z37BZLq3hAz2YJy9ALJ22QRrMpuy0QrjBASwKXH66BK2VWHjamgmDAYXASlwgZBi6VB56aKgAHb1HIhRQQdsyD7hoPHt0SgXtIVYXWSR08LIwD4ZAHqXPIjKhKpOOVDAVYhxkupMYMfHCVCJVDP2AJMxYdJ7TXGZuyHEMrgyXMcsdLDOhIzS3TvEQ2ZS2cucxYwiSpaXko2EPdr/8GZtGBh1DwABox86R1irDAIAqkOxz+XkmHGZsGV2HCfNgokuRlaRUBwbVVJkM2XXDliUAUWHI23bKwsZEyOKlzlrCFcSUPzYnOWV3P6HpvjfboieF8NKJ/h1B9JQR6v6gUdPZgCRNGB9SB6Lm1Sor4YvjZE9P2GIVJP6MIZDhH1wTZiGyOyb5P421OcM2j1lO2Hv+c6tKff8hZnbAgA50eX7Fn8PFHZ3Li0iacYOocFElrgqQydN9KrSaongLY4IFIWO8NsY/DHWCCLk+ZqAjB+ulw2DJXHt1AmJK4zUof6P2UsWKemRZVwrzMdcyTjps7xzeUIAFLf9qazpyCLtB8ncE+G4QUIywsuVQnqVPEn3YHrS1sYfQJMZPXF+fjVz++GRP9SmY5hj+hf/P2WN5hol5S6cQMllxV6OEMyO6cilkCPvDSDk4EX0dPoNc9gboqU3R97u6k4z6fTOqEbZ7J9WZM9nkm06sf64QVz2SaXJDneI7P5Bs/mlY3TUjPW9fWT1HFzPSos2v93h2Wj9QYhVz3BVKZrxMWkwizy/B0oJ2Pzl+djUdnoze344vp5C/T1xeD0Wj0G0vYuozRvetM2a7otSDb58pm30QOap4qvDXV16nvMJMORZhX7tEcfSqOSVycI+alyWhKiK3JPy03dk9irIKZOyylPumplqWhnhstcC71HJfoHs2DjnFEAXFotn5fehhHFF11wiaPdecbU2IoaKhZoQ6wckbnCViF3CMEtwGec6mBrnHf/e/aNjpnTrSD5yHr54/USmqct6PJfDIazcedESbHRrjttWlYmEpn31bVx+Q/rdBkftEp9PpYoWu95EpmcSK+Nfeov60+ffGhEX8csbIhiu/ZgbL980ZJj6JyMmziqLw+41aeNe+ndzOaQilSzG7GjrN1KNiUdYPIcNubq2tG97llO3nHAtHNLp7rLDXrgbGoqZ8pnnrq20Nu5XBJ7fghB7f2GdRYnT2PwQeeS50/zTXbm+iG3Nh46sBQ+9nByr8jDQ87P/SpditHgTwOfTU9L0xk3nnnvUVNbSn6djk+GiI+ohKmRFpDQoHQkv/xr/9EjnZziqH33Sf9Sb+vHFizQkcLAtcZLBSuZaqadQ7L+K5b6DzyUqH3agNSB8wdZU0mcxm4ivMK1QvBLU+lkhSxRGaI20Ev6P0APhYYCnT06nuHwCHDJSoKdKASXh5uerAy7n5Bq2UCHNLKS43eA+qCa0GErfkTMA64BtQBnXXSI+2EhFo22IwOjosAJdc8R7o7ObBShkpSbIIzaeUDeKOqCBlogzUOM2gVigvfgIz4lnY4h0CnwpTWYUGRskTIK5mhT0CYDKHZYUgFnUGKPoAlLFJg3BsrrYy4j35bVEqBNVQvJFe0a/YxEntwXHvqog2W1gedwawztPZhA/Dly189koffSX3vpy9fftJncNcF00dMvQw4+6GN+tVqdRTtLw55rmT4uUrhF7TGy2DcZs+dy1BUacyQ/iXdQ3PTFWqM8dPLgP0dmRH+OOHodFigssMbDBQhfnj54TqW2Bfwxz//De+QOw2FWTXRKiqHagN5K4os13i+MVtXIeMHBl6FgiwumuCj1R19IAvSmHSYzYdp53CBjowfHbkXZ+Xu+rsWJhD6P6Mm1WqKYi5iK9ltQVRWfnp4Tyzr6Er/fnGDbilFuyV+wcPDSDxkCVNSoPbYaxeXVx/ewRJeDUYs6ZXIr/D28N31X9/+4+YtoaHMaiw2HowGo7iNGR9Krnui+h+VHha47b6N/h98gNqV/IDrMLSKy9hodxNx0yTv9lNiwqb9z0+zhBXGByLZblPu8Ven6pqOf6/igHo3S9iSO0lzeeykmfT0O+s+JX3Rcj/8svsq9QK+/kvWo8q0TU1TR4ubKw3wCbvHzYPPafWMtr6msxHahuJSCLShx3s0Gh3MF1dvb1mc8YvDjnofO+ruB93+KK7DVtsAoL/U9R9l2G6bbl3XHX3z6oscOwVbajLSrK7r/wKxyGq/",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,g={},y=[];function S(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,r.jsx)(s(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,r.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(S,{...e})}):S(e)}}}]); \ No newline at end of file diff --git a/assets/js/38e3d9c8.69204c41.js b/assets/js/38e3d9c8.69204c41.js new file mode 100644 index 000000000..4f048262c --- /dev/null +++ b/assets/js/38e3d9c8.69204c41.js @@ -0,0 +1 @@ +(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5378],{4213:function(e,t,n){var r,s,o,a=n(96763);s=[],void 0===(o="function"==typeof(r=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(a.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function r(e,t,n){var r=new XMLHttpRequest;r.open("GET",e),r.responseType="blob",r.onload=function(){l(r.response,t,n)},r.onerror=function(){a.error("could not download file")},r.send()}function s(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function o(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(r){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var i="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof n.g&&n.g.global===n.g?n.g:void 0,c=i.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),l=i.saveAs||("object"!=typeof window||window!==i?function(){}:"download"in HTMLAnchorElement.prototype&&!c?function(e,t,n){var a=i.URL||i.webkitURL,c=document.createElement("a");t=t||e.name||"download",c.download=t,c.rel="noopener","string"==typeof e?(c.href=e,c.origin===location.origin?o(c):s(c.href)?r(e,t,n):o(c,c.target="_blank")):(c.href=a.createObjectURL(e),setTimeout((function(){a.revokeObjectURL(c.href)}),4e4),setTimeout((function(){o(c)}),0))}:"msSaveOrOpenBlob"in navigator?function(e,n,a){if(n=n||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,a),n);else if(s(e))r(e,n,a);else{var i=document.createElement("a");i.href=e,i.target="_blank",setTimeout((function(){o(i)}))}}:function(e,t,n,s){if((s=s||open("","_blank"))&&(s.document.title=s.document.body.innerText="downloading..."),"string"==typeof e)return r(e,t,n);var o="application/octet-stream"===e.type,a=/constructor/i.test(i.HTMLElement)||i.safari,l=/CriOS\/[\d]+/.test(navigator.userAgent);if((l||o&&a||c)&&"undefined"!=typeof FileReader){var u=new FileReader;u.onloadend=function(){var e=u.result;e=l?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),s?s.location.href=e:location=e,s=null},u.readAsDataURL(e)}else{var d=i.URL||i.webkitURL,p=d.createObjectURL(e);s?s.location=p:location.href=p,s=null,setTimeout((function(){d.revokeObjectURL(p)}),4e4)}});i.saveAs=l.saveAs=l,e.exports=l})?r.apply(t,s):r)||(e.exports=o)},18426:(e,t)=>{function n(e){let t,n=[];for(let r of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(r))n.push(parseInt(r,10));else if(t=r.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,r,s,o]=t;if(r&&o){r=parseInt(r),o=parseInt(o);const e=r{e.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),o.default.saveAs(e,t||"openapi.txt")})(`${t}`)},className:"dropdown__link",href:`${t}`},"OpenAPI Spec"))))}},28453:(e,t,n)=>{"use strict";n.d(t,{R:()=>a,x:()=>i});var r=n(96540);const s={},o=r.createContext(s);function a(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:t},e.children)}},31177:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});var r=n(8532),s=n(53115);function o(){const{prism:e}=(0,s.p)(),{colorMode:t}=(0,r.G)(),n=e.theme,o=e.darkTheme||n;return"dark"===t?o:n}},32098:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>d,default:()=>h,frontMatter:()=>u,metadata:()=>r,toc:()=>m});const r=JSON.parse('{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","source":"@site/docs/API-docs/opensign-api-v-1.info.mdx","sourceDirName":"API-docs","slug":"/API-docs/opensign-api-v-1","permalink":"/docs/API-docs/opensign-api-v-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","next":{"title":"Get your account details","permalink":"/docs/API-docs/get-user"}}');var s=n(74848),o=n(28453),a=(n(64624),n(9303)),i=n(12990),c=n.n(i),l=n(79329);n(25383);const u={id:"opensign-api-v-1",title:"OpenSign API v1",description:"Welcome to the OpenSign\u2122 API documentation!",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},d=void 0,p={},m=[];function f(e){const t={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,s.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1"}),"\n",(0,s.jsx)(t.p,{children:"Welcome to the OpenSign\u2122 API documentation!"}),"\n",(0,s.jsx)(t.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,s.jsx)(t.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Useful Links:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,s.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,s.jsx)(c(),{className:"openapi-tabs__security-schemes",children:(0,s.jsx)(l.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,s.jsx)("div",{children:(0,s.jsx)("table",{children:(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(t.p,{children:"apiKey"})})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(t.p,{children:"Header parameter name:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(t.p,{children:"Contact"})}),(0,s.jsx)("span",{children:(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(t.p,{children:"Terms of Service"})}),(0,s.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(t.p,{children:"License"})}),(0,s.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,s.jsx)(t.p,{children:"AGPL v 3.0"})})]})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},60506:(e,t,n)=>{"use strict";n.d(t,{c:()=>o});var r=n(96540),s=n(74848);function o(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=r.Children.toArray(e),n=t.find((e=>r.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),o=t.filter((e=>e!==n)),a=n?.props.children;return{mdxAdmonitionTitle:a,rest:o.length>0?(0,s.jsx)(s.Fragment,{children:o}):null}}(e.children),o=e.title??t;return{...e,...o&&{title:o},children:n}}},61360:(e,t,n)=>{"use strict";n.d(t,{f:()=>i});var r=n(96540),s=n(26849);const o={attributes:!0,characterData:!0,childList:!0,subtree:!0};function a(e,t){const[n,a]=(0,r.useState)(),i=(0,r.useCallback)((()=>{a(e.current?.closest("[role=tabpanel][hidden]"))}),[e,a]);(0,r.useEffect)((()=>{i()}),[i]),function(e,t,n){void 0===n&&(n=o);const a=(0,s._q)(t),i=(0,s.Be)(n);(0,r.useEffect)((()=>{const t=new MutationObserver(a);return e&&t.observe(e,i),()=>t.disconnect()}),[e,a,i])}(n,(e=>{e.forEach((e=>{"attributes"===e.type&&"hidden"===e.attributeName&&(t(),i())}))}),{attributes:!0,characterData:!1,childList:!1,subtree:!1})}function i(){const[e,t]=(0,r.useState)(!1),[n,s]=(0,r.useState)(!1),o=(0,r.useRef)(null),i=(0,r.useCallback)((()=>{const n=o.current.querySelector("code");e?n.removeAttribute("style"):(n.style.whiteSpace="pre-wrap",n.style.overflowWrap="anywhere"),t((e=>!e))}),[o,e]),c=(0,r.useCallback)((()=>{const{scrollWidth:e,clientWidth:t}=o.current,n=e>t||o.current.querySelector("code").hasAttribute("style");s(n)}),[o]);return a(o,c),(0,r.useEffect)((()=>{c()}),[e,c]),(0,r.useEffect)((()=>(window.addEventListener("resize",c,{passive:!0}),()=>{window.removeEventListener("resize",c)})),[c]),{codeBlockRef:o,isEnabled:e,isCodeScrollable:n,toggle:i}}},64566:(e,t,n)=>{"use strict";n.d(t,{Li:()=>f,M$:()=>h,Op:()=>m,_u:()=>p,wt:()=>d});var r=n(18426),s=n.n(r);const o=/title=(?["'])(?.*?)\1/,a=/\{(?<range>[\d,-]+)\}/,i={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}},c={...i,lua:{start:"--",end:""},wasm:{start:"\\;\\;",end:""},tex:{start:"%",end:""},vb:{start:"['\u2018\u2019]",end:""},vbnet:{start:"(?:_\\s*)?['\u2018\u2019]",end:""},rem:{start:"[Rr][Ee][Mm]\\b",end:""},f90:{start:"!",end:""},ml:{start:"\\(\\*",end:"\\*\\)"},cobol:{start:"\\*>",end:""}},l=Object.keys(i);function u(e,t){const n=e.map((e=>{const{start:n,end:r}=c[e];return`(?:${n}\\s*(${t.flatMap((e=>[e.line,e.block?.start,e.block?.end].filter(Boolean))).join("|")})\\s*${r})`})).join("|");return new RegExp(`^\\s*(?:${n})\\s*$`)}function d(e){return e?.match(o)?.groups.title??""}function p(e){return Boolean(e?.includes("showLineNumbers"))}function m(e){const t=e.split(" ").find((e=>e.startsWith("language-")));return t?.replace(/language-/,"")}function f(e,t){let n=e.replace(/\n$/,"");const{language:r,magicComments:o,metastring:i}=t;if(i&&a.test(i)){const e=i.match(a).groups.range;if(0===o.length)throw new Error(`A highlight range has been given in code block's metastring (\`\`\` ${i}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`);const t=o[0].className,r=s()(e).filter((e=>e>0)).map((e=>[e-1,[t]]));return{lineClassNames:Object.fromEntries(r),code:n}}if(void 0===r)return{lineClassNames:{},code:n};const c=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return u(["js","jsBlock"],t);case"jsx":case"tsx":return u(["js","jsBlock","jsx"],t);case"html":return u(["js","jsBlock","html"],t);case"python":case"py":case"bash":return u(["bash"],t);case"markdown":case"md":return u(["html","jsx","bash"],t);case"tex":case"latex":case"matlab":return u(["tex"],t);case"lua":case"haskell":return u(["lua"],t);case"sql":return u(["lua","jsBlock"],t);case"wasm":return u(["wasm"],t);case"vb":case"vba":case"visual-basic":return u(["vb","rem"],t);case"vbnet":return u(["vbnet","rem"],t);case"batch":return u(["rem"],t);case"basic":return u(["rem","f90"],t);case"fsharp":return u(["js","ml"],t);case"ocaml":case"sml":return u(["ml"],t);case"fortran":return u(["f90"],t);case"cobol":return u(["cobol"],t);default:return u(l,t)}}(r,o),d=n.split("\n"),p=Object.fromEntries(o.map((e=>[e.className,{start:0,range:""}]))),m=Object.fromEntries(o.filter((e=>e.line)).map((e=>{let{className:t,line:n}=e;return[n,t]}))),f=Object.fromEntries(o.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.start,t]}))),h=Object.fromEntries(o.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.end,t]})));for(let s=0;s<d.length;){const e=d[s].match(c);if(!e){s+=1;continue}const t=e.slice(1).find((e=>void 0!==e));m[t]?p[m[t]].range+=`${s},`:f[t]?p[f[t]].start=s:h[t]&&(p[h[t]].range+=`${p[h[t]].start}-${s-1},`),d.splice(s,1)}n=d.join("\n");const g={};return Object.entries(p).forEach((e=>{let[t,{range:n}]=e;s()(n).forEach((e=>{g[e]??=[],g[e].push(t)}))})),{lineClassNames:g,code:n}}function h(e){const t={color:"--prism-color",backgroundColor:"--prism-background-color"},n={};return Object.entries(e.plain).forEach((e=>{let[r,s]=e;const o=t[r];o&&"string"==typeof s&&(n[o]=s)})),n}},64624:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e){const{colorMode:t}=(0,o.useColorMode)(),{logo:n,darkLogo:r}=e,c=()=>"dark"===t?r?.altText??n?.altText:n?.altText,l=(0,a.default)(n?.url),u=(0,a.default)(r?.url);if(n&&r)return s.default.createElement(i.default,{alt:c(),sources:{light:l,dark:u},className:"openapi__logo"});if(n||r)return s.default.createElement(i.default,{alt:c(),sources:{light:l??u,dark:l??u},className:"openapi__logo"});return};const s=r(n(96540)),o=n(3489),a=r(n(29030)),i=r(n(24475))},98569:(e,t,n)=>{"use strict";n.d(t,{i:()=>s});var r=n(40797);function s(e){void 0===e&&(e={});const{i18n:{currentLocale:t}}=(0,r.default)(),n=function(){const{i18n:{currentLocale:e,localeConfigs:t}}=(0,r.default)();return t[e].calendar}();return new Intl.DateTimeFormat(t,{calendar:n,...e})}}}]); \ No newline at end of file diff --git a/assets/js/38e3d9c8.73b1ae3a.js b/assets/js/38e3d9c8.73b1ae3a.js deleted file mode 100644 index 6754918fd..000000000 --- a/assets/js/38e3d9c8.73b1ae3a.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5378],{4213:function(e,t,n){var o,r,s,a=n(96763);r=[],void 0===(s="function"==typeof(o=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(a.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function o(e,t,n){var o=new XMLHttpRequest;o.open("GET",e),o.responseType="blob",o.onload=function(){c(o.response,t,n)},o.onerror=function(){a.error("could not download file")},o.send()}function r(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function s(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(o){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var i="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof n.g&&n.g.global===n.g?n.g:void 0,l=i.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),c=i.saveAs||("object"!=typeof window||window!==i?function(){}:"download"in HTMLAnchorElement.prototype&&!l?function(e,t,n){var a=i.URL||i.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?s(l):r(l.href)?o(e,t,n):s(l,l.target="_blank")):(l.href=a.createObjectURL(e),setTimeout((function(){a.revokeObjectURL(l.href)}),4e4),setTimeout((function(){s(l)}),0))}:"msSaveOrOpenBlob"in navigator?function(e,n,a){if(n=n||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,a),n);else if(r(e))o(e,n,a);else{var i=document.createElement("a");i.href=e,i.target="_blank",setTimeout((function(){s(i)}))}}:function(e,t,n,r){if((r=r||open("","_blank"))&&(r.document.title=r.document.body.innerText="downloading..."),"string"==typeof e)return o(e,t,n);var s="application/octet-stream"===e.type,a=/constructor/i.test(i.HTMLElement)||i.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||s&&a||l)&&"undefined"!=typeof FileReader){var u=new FileReader;u.onloadend=function(){var e=u.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),r?r.location.href=e:location=e,r=null},u.readAsDataURL(e)}else{var d=i.URL||i.webkitURL,p=d.createObjectURL(e);r?r.location=p:location.href=p,r=null,setTimeout((function(){d.revokeObjectURL(p)}),4e4)}});i.saveAs=c.saveAs=c,e.exports=c})?o.apply(t,r):o)||(e.exports=s)},18426:(e,t)=>{function n(e){let t,n=[];for(let o of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(o))n.push(parseInt(o,10));else if(t=o.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,o,r,s]=t;if(o&&s){o=parseInt(o),s=parseInt(s);const e=o<s?1:-1;"-"!==r&&".."!==r&&"\u2025"!==r||(s+=e);for(let t=o;t!==s;t+=e)n.push(t)}}return n}t.default=n,e.exports=n},25383:function(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const r=o(n(96540)),s=o(n(4213));t.default=function(e){let{url:t,proxy:n}=e;return r.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},r.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),r.default.createElement("ul",{className:"export-dropdown dropdown__menu"},r.default.createElement("li",null,r.default.createElement("a",{onClick:e=>{e.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),s.default.saveAs(e,t||"openapi.txt")})(`${t}`)},className:"dropdown__link",href:`${t}`},"OpenAPI Spec"))))}},28453:(e,t,n)=>{"use strict";n.d(t,{R:()=>a,x:()=>i});var o=n(96540);const r={},s=o.createContext(r);function a(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),o.createElement(s.Provider,{value:t},e.children)}},31177:(e,t,n)=>{"use strict";n.d(t,{A:()=>s});var o=n(8532),r=n(53115);function s(){const{prism:e}=(0,r.p)(),{colorMode:t}=(0,o.G)(),n=e.theme,s=e.darkTheme||n;return"dark"===t?s:n}},32098:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>d,default:()=>h,frontMatter:()=>u,metadata:()=>o,toc:()=>m});const o=JSON.parse('{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you\'re a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.","source":"@site/docs/API-docs/opensign-api-v-1.info.mdx","sourceDirName":"API-docs","slug":"/API-docs/opensign-api-v-1","permalink":"/docs/API-docs/opensign-api-v-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you\'re a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","next":{"title":"Get your account details","permalink":"/docs/API-docs/get-user"}}');var r=n(74848),s=n(28453),a=(n(64624),n(9303)),i=n(12990),l=n.n(i),c=n(79329);n(25383);const u={id:"opensign-api-v-1",title:"OpenSign API v1",description:"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},d=void 0,p={},m=[];function f(e){const t={a:"a",li:"li",p:"p",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,r.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1"}),"\n",(0,r.jsx)(t.p,{children:"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today."}),"\n",(0,r.jsx)(t.p,{children:"Some useful links:"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign Github repo"})}),"\n"]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,r.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,r.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,r.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,r.jsx)("div",{children:(0,r.jsx)("table",{children:(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"apiKey"})})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Header parameter name:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,r.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Contact"})}),(0,r.jsx)("span",{children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Terms of Service"})}),(0,r.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"License"})}),(0,r.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,r.jsx)(t.p,{children:"AGPL v 3.0"})})]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(f,{...e})}):f(e)}},60506:(e,t,n)=>{"use strict";n.d(t,{c:()=>s});var o=n(96540),r=n(74848);function s(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=o.Children.toArray(e),n=t.find((e=>o.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),s=t.filter((e=>e!==n)),a=n?.props.children;return{mdxAdmonitionTitle:a,rest:s.length>0?(0,r.jsx)(r.Fragment,{children:s}):null}}(e.children),s=e.title??t;return{...e,...s&&{title:s},children:n}}},61360:(e,t,n)=>{"use strict";n.d(t,{f:()=>i});var o=n(96540),r=n(26849);const s={attributes:!0,characterData:!0,childList:!0,subtree:!0};function a(e,t){const[n,a]=(0,o.useState)(),i=(0,o.useCallback)((()=>{a(e.current?.closest("[role=tabpanel][hidden]"))}),[e,a]);(0,o.useEffect)((()=>{i()}),[i]),function(e,t,n){void 0===n&&(n=s);const a=(0,r._q)(t),i=(0,r.Be)(n);(0,o.useEffect)((()=>{const t=new MutationObserver(a);return e&&t.observe(e,i),()=>t.disconnect()}),[e,a,i])}(n,(e=>{e.forEach((e=>{"attributes"===e.type&&"hidden"===e.attributeName&&(t(),i())}))}),{attributes:!0,characterData:!1,childList:!1,subtree:!1})}function i(){const[e,t]=(0,o.useState)(!1),[n,r]=(0,o.useState)(!1),s=(0,o.useRef)(null),i=(0,o.useCallback)((()=>{const n=s.current.querySelector("code");e?n.removeAttribute("style"):(n.style.whiteSpace="pre-wrap",n.style.overflowWrap="anywhere"),t((e=>!e))}),[s,e]),l=(0,o.useCallback)((()=>{const{scrollWidth:e,clientWidth:t}=s.current,n=e>t||s.current.querySelector("code").hasAttribute("style");r(n)}),[s]);return a(s,l),(0,o.useEffect)((()=>{l()}),[e,l]),(0,o.useEffect)((()=>(window.addEventListener("resize",l,{passive:!0}),()=>{window.removeEventListener("resize",l)})),[l]),{codeBlockRef:s,isEnabled:e,isCodeScrollable:n,toggle:i}}},64566:(e,t,n)=>{"use strict";n.d(t,{Li:()=>f,M$:()=>h,Op:()=>m,_u:()=>p,wt:()=>d});var o=n(18426),r=n.n(o);const s=/title=(?<quote>["'])(?<title>.*?)\1/,a=/\{(?<range>[\d,-]+)\}/,i={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}},l={...i,lua:{start:"--",end:""},wasm:{start:"\\;\\;",end:""},tex:{start:"%",end:""},vb:{start:"['\u2018\u2019]",end:""},vbnet:{start:"(?:_\\s*)?['\u2018\u2019]",end:""},rem:{start:"[Rr][Ee][Mm]\\b",end:""},f90:{start:"!",end:""},ml:{start:"\\(\\*",end:"\\*\\)"},cobol:{start:"\\*>",end:""}},c=Object.keys(i);function u(e,t){const n=e.map((e=>{const{start:n,end:o}=l[e];return`(?:${n}\\s*(${t.flatMap((e=>[e.line,e.block?.start,e.block?.end].filter(Boolean))).join("|")})\\s*${o})`})).join("|");return new RegExp(`^\\s*(?:${n})\\s*$`)}function d(e){return e?.match(s)?.groups.title??""}function p(e){return Boolean(e?.includes("showLineNumbers"))}function m(e){const t=e.split(" ").find((e=>e.startsWith("language-")));return t?.replace(/language-/,"")}function f(e,t){let n=e.replace(/\n$/,"");const{language:o,magicComments:s,metastring:i}=t;if(i&&a.test(i)){const e=i.match(a).groups.range;if(0===s.length)throw new Error(`A highlight range has been given in code block's metastring (\`\`\` ${i}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`);const t=s[0].className,o=r()(e).filter((e=>e>0)).map((e=>[e-1,[t]]));return{lineClassNames:Object.fromEntries(o),code:n}}if(void 0===o)return{lineClassNames:{},code:n};const l=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return u(["js","jsBlock"],t);case"jsx":case"tsx":return u(["js","jsBlock","jsx"],t);case"html":return u(["js","jsBlock","html"],t);case"python":case"py":case"bash":return u(["bash"],t);case"markdown":case"md":return u(["html","jsx","bash"],t);case"tex":case"latex":case"matlab":return u(["tex"],t);case"lua":case"haskell":return u(["lua"],t);case"sql":return u(["lua","jsBlock"],t);case"wasm":return u(["wasm"],t);case"vb":case"vba":case"visual-basic":return u(["vb","rem"],t);case"vbnet":return u(["vbnet","rem"],t);case"batch":return u(["rem"],t);case"basic":return u(["rem","f90"],t);case"fsharp":return u(["js","ml"],t);case"ocaml":case"sml":return u(["ml"],t);case"fortran":return u(["f90"],t);case"cobol":return u(["cobol"],t);default:return u(c,t)}}(o,s),d=n.split("\n"),p=Object.fromEntries(s.map((e=>[e.className,{start:0,range:""}]))),m=Object.fromEntries(s.filter((e=>e.line)).map((e=>{let{className:t,line:n}=e;return[n,t]}))),f=Object.fromEntries(s.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.start,t]}))),h=Object.fromEntries(s.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.end,t]})));for(let r=0;r<d.length;){const e=d[r].match(l);if(!e){r+=1;continue}const t=e.slice(1).find((e=>void 0!==e));m[t]?p[m[t]].range+=`${r},`:f[t]?p[f[t]].start=r:h[t]&&(p[h[t]].range+=`${p[h[t]].start}-${r-1},`),d.splice(r,1)}n=d.join("\n");const g={};return Object.entries(p).forEach((e=>{let[t,{range:n}]=e;r()(n).forEach((e=>{g[e]??=[],g[e].push(t)}))})),{lineClassNames:g,code:n}}function h(e){const t={color:"--prism-color",backgroundColor:"--prism-background-color"},n={};return Object.entries(e.plain).forEach((e=>{let[o,r]=e;const s=t[o];s&&"string"==typeof r&&(n[s]=r)})),n}},64624:function(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e){const{colorMode:t}=(0,s.useColorMode)(),{logo:n,darkLogo:o}=e,l=()=>"dark"===t?o?.altText??n?.altText:n?.altText,c=(0,a.default)(n?.url),u=(0,a.default)(o?.url);if(n&&o)return r.default.createElement(i.default,{alt:l(),sources:{light:c,dark:u},className:"openapi__logo"});if(n||o)return r.default.createElement(i.default,{alt:l(),sources:{light:c??u,dark:c??u},className:"openapi__logo"});return};const r=o(n(96540)),s=n(3489),a=o(n(29030)),i=o(n(24475))},98569:(e,t,n)=>{"use strict";n.d(t,{i:()=>r});var o=n(40797);function r(e){void 0===e&&(e={});const{i18n:{currentLocale:t}}=(0,o.default)(),n=function(){const{i18n:{currentLocale:e,localeConfigs:t}}=(0,o.default)();return t[e].calendar}();return new Intl.DateTimeFormat(t,{calendar:n,...e})}}}]); \ No newline at end of file diff --git a/assets/js/451a5132.5eff7d00.js b/assets/js/451a5132.5eff7d00.js new file mode 100644 index 000000000..c037786cd --- /dev/null +++ b/assets/js/451a5132.5eff7d00.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4553],{33487:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>v,frontMatter:()=>g,metadata:()=>i,toc:()=>P});const i=JSON.parse('{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/folderlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/folderlist","permalink":"/docs/API-docs/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V11uGzcQvgrDlzbGWlo5cYrqqUbhum6NxKgdBKgjGNzd0S4jLsmQs/qBICAPvUFv0KPlJMWQWmlly2ncpnmxvOTM8JsfzjdcchSl58Mb/pNRBTg+SngBPnfSojSaD/l1BSzusQvpkZ1cnjOorZmB82xhGoaGOUAnYQpMMEUyZszGUWUmsWIm/poGmRUONEZ75wVPuLHgBB11XvAhj1pkgyfcCidqQHCEb8m1qIEP+T0LklC+b8At+F3sJnsHOZ4XW0A84Q7eN9JBwYdjoTwk3ONCQTjc1TzhMLfKFLDdziuoBR8uOS4syXl0Upc8CQoCuyswF7UNxvhqlWwwK1lLvAv1s3Gga3Zg1GIu66bmw+M0TVpQuqkzcHzVwTBIOxD8RNovhuDhM9PViOx6a7QHT7JHaUo/u4nxTZ6D9+NGsU0B8ITnRiNoJHlhrZJ52Oi/86S0vA8g5pdKxZEZlPFIB75R2JETzglyWCLU/p/127J5bM5tNciq+dE7SyGJ9fYyRP9xZjTM2mpdJXfr/ZG2fjnSwh9P5CXctfVvkfkm66DLHQiE4gT3mdoqHqVHzw4H6WH63fXgxfD598PjF700TX/nCZ/XinTXZVoIDEhRoup+N7b4Cud0FqKLtw48X3XXpVZSw21b4rdHaXo7eEYyq4Q/31frV6YGrKQu2Qw0spkzukyYVSA8MHQLJkohNVMCwT35cpcAnDPu09F6HLJPReE5RWEThOP7QTjXU6FkEdjj2kxAf11Pu8djPJ6g7taEjEJhn+84212PTnrIGydxEZhpfiisPIz7w5sRtUAKrCFGKyFSGVZ8yPs7/ObBTVtya5ziQ14hWj/s973QRWbmPWNBe1lqJTLfy03dF1b2pwNOfX1XQ1j7CGloDh+n4FGUUpef1hptw3JFqYvZ2QnOtiNb+StQS17Hviu1ZqkKRGgyK/oem6C8zsgrC/pKljrkczq4x/tvQOWmBhpNsALWin/846+gUZi8qUFjKLcnb/Vb/apxLIw0xEhCF2ysYC4zBXvHHQ+iVuC9WjCpEUonEFghS4lCMQoNXalcWJFJJalKScyQtmOdQvc99qYCrMDR1jeOxqcCpqCouJlo0NQCyVSLl82Mm4yVmfmECZY1XmrwnoGuhM5JsA1/QiOX0Aw0grNOemAeHaGWEZvR6ESOrBZalEC2k50oFaAk1SZzJms8Mm9UEyAzFFIZBwVrHdIAhe9REE9pXHDAaDU3tXVQUaVMgZWNLMAnLDcFMB8uJbmgC5aBR2YJi8zBk9FGK5NPQt7GjVLMGuoRUiga4roYSR2d0J4YK2Jpc7AJmHWG5gyIAA8OXnugDF9IPfHDg4O3+pDdbIrpDWReIoy+bat+Npvdq/anuzpnEn9uMvYbWOMlGrfYapcSqyYLN6RrZPMRLZ2BhlA/nRuwtVGY3N+/cLTar0DZ/hUgVYjvn1yeh7b6lH388Ce7AOE0q8wsVmveOFALVrZHUeRi5mPYNl2RjU0ovIoinsfioyERPFIEiUV3b/PutXMwBkfBD4ncHmfl2vxNC5MR+v/iZpg9jEaRB/qAWkgV28oPd+2EVg6u9q/GV+CmMod1Y3sgw/0g3OcJVzIH7aFDESdnlxdsyp71Up50WuRnZLt/cf7j6curU0JDNytGbNBLe2mYzIzHWujOUWeA7SNqzRc7wV5u2fP/fqKtWzbCHPtWCRnIMTi/XBPbTffhNkp4ZTzS6nKZCQ+vnVqtaDm+O4juCulFpjovjwd92/uE24toAot9z8OpUE18kCV7zo1K7fvsc2TXD6mt6Ig+nCTZwP5Jy1zkaNQ5yXOw3QPujTs7M8PZ6TVPON3DXcacBMZc/0PW2y296NjepdIIgP6ST3sVlsvIxqvVRj5uPaixdrCVpviPVqvV3+R9qgM=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/deletefolder"}}');var r=o(74848),n=o(28453),s=o(33617),l=o.n(s),a=o(17543),p=o.n(a),d=o(86013),c=o.n(d),m=o(63723),u=o.n(m),f=(o(18766),o(79329),o(9303));const g={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V11uGzcQvgrDlzbGWlo5cYrqqUbhum6NxKgdBKgjGNzd0S4jLsmQs/qBICAPvUFv0KPlJMWQWmlly2ncpnmxvOTM8JsfzjdcchSl58Mb/pNRBTg+SngBPnfSojSaD/l1BSzusQvpkZ1cnjOorZmB82xhGoaGOUAnYQpMMEUyZszGUWUmsWIm/poGmRUONEZ75wVPuLHgBB11XvAhj1pkgyfcCidqQHCEb8m1qIEP+T0LklC+b8At+F3sJnsHOZ4XW0A84Q7eN9JBwYdjoTwk3ONCQTjc1TzhMLfKFLDdziuoBR8uOS4syXl0Upc8CQoCuyswF7UNxvhqlWwwK1lLvAv1s3Gga3Zg1GIu66bmw+M0TVpQuqkzcHzVwTBIOxD8RNovhuDhM9PViOx6a7QHT7JHaUo/u4nxTZ6D9+NGsU0B8ITnRiNoJHlhrZJ52Oi/86S0vA8g5pdKxZEZlPFIB75R2JETzglyWCLU/p/127J5bM5tNciq+dE7SyGJ9fYyRP9xZjTM2mpdJXfr/ZG2fjnSwh9P5CXctfVvkfkm66DLHQiE4gT3mdoqHqVHzw4H6WH63fXgxfD598PjF700TX/nCZ/XinTXZVoIDEhRoup+N7b4Cud0FqKLtw48X3XXpVZSw21b4rdHaXo7eEYyq4Q/31frV6YGrKQu2Qw0spkzukyYVSA8MHQLJkohNVMCwT35cpcAnDPu09F6HLJPReE5RWEThOP7QTjXU6FkEdjj2kxAf11Pu8djPJ6g7taEjEJhn+84212PTnrIGydxEZhpfiisPIz7w5sRtUAKrCFGKyFSGVZ8yPs7/ObBTVtya5ziQ14hWj/s973QRWbmPWNBe1lqJTLfy03dF1b2pwNOfX1XQ1j7CGloDh+n4FGUUpef1hptw3JFqYvZ2QnOtiNb+StQS17Hviu1ZqkKRGgyK/oem6C8zsgrC/pKljrkczq4x/tvQOWmBhpNsALWin/846+gUZi8qUFjKLcnb/Vb/apxLIw0xEhCF2ysYC4zBXvHHQ+iVuC9WjCpEUonEFghS4lCMQoNXalcWJFJJalKScyQtmOdQvc99qYCrMDR1jeOxqcCpqCouJlo0NQCyVSLl82Mm4yVmfmECZY1XmrwnoGuhM5JsA1/QiOX0Aw0grNOemAeHaGWEZvR6ESOrBZalEC2k50oFaAk1SZzJms8Mm9UEyAzFFIZBwVrHdIAhe9REE9pXHDAaDU3tXVQUaVMgZWNLMAnLDcFMB8uJbmgC5aBR2YJi8zBk9FGK5NPQt7GjVLMGuoRUiga4roYSR2d0J4YK2Jpc7AJmHWG5gyIAA8OXnugDF9IPfHDg4O3+pDdbIrpDWReIoy+bat+Npvdq/anuzpnEn9uMvYbWOMlGrfYapcSqyYLN6RrZPMRLZ2BhlA/nRuwtVGY3N+/cLTar0DZ/hUgVYjvn1yeh7b6lH388Ce7AOE0q8wsVmveOFALVrZHUeRi5mPYNl2RjU0ovIoinsfioyERPFIEiUV3b/PutXMwBkfBD4ncHmfl2vxNC5MR+v/iZpg9jEaRB/qAWkgV28oPd+2EVg6u9q/GV+CmMod1Y3sgw/0g3OcJVzIH7aFDESdnlxdsyp71Up50WuRnZLt/cf7j6curU0JDNytGbNBLe2mYzIzHWujOUWeA7SNqzRc7wV5u2fP/fqKtWzbCHPtWCRnIMTi/XBPbTffhNkp4ZTzS6nKZCQ+vnVqtaDm+O4juCulFpjovjwd92/uE24toAot9z8OpUE18kCV7zo1K7fvsc2TXD6mt6Ig+nCTZwP5Jy1zkaNQ5yXOw3QPujTs7M8PZ6TVPON3DXcacBMZc/0PW2y296NjepdIIgP6ST3sVlsvIxqvVRj5uPaixdrCVpviPVqvV3+R9qgM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,y={},P=[];function j(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,r.jsx)(l(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,r.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(p(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/451a5132.63947840.js b/assets/js/451a5132.63947840.js deleted file mode 100644 index 3482ff3ea..000000000 --- a/assets/js/451a5132.63947840.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4553],{33487:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>i,toc:()=>F});const i=JSON.parse('{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/folderlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/folderlist","permalink":"/docs/API-docs/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V19v2zYQ/yosX7YCii2nTYf5acHWBdmKNkAyFFhqBCfpLLGmSI48+Q8Mv+2T7KPtkwxHWbYcJ10zdH2JI/J+d787Hu+Oa0lQBjm+lT9bXaCXk0QWGHKvHClr5FjeVCjaPfFGBRLnV5cCa2cX6INY2UaQFR7JK5yjAKFZxk7FtIUsFFXCtr+2IeHAo6FW32UhE2kdemBTl4UcyxbFOmQiHXiokdAzv7U0UKMcyyMNiln+0aBfyfvcbfYRc7os9oRkIj3+0SiPhRxPQQdMZKCVxmjc1zKRuHTaFrjfziusQY7XklaO5QJ5ZUqZRABQfwWXULuoTG42yY6zVrWi+1Q/mwf55oBGDUtVN7Ucn6Vp0pEyTZ2hl5seh1HaoxBmyn0xBo/bTDcT1hucNQEDy56mKf8cHkxo8hxDmDZa7BJAJjK3htAQy4NzWuVxY/gxMGh9TKA9X04Vz2pItSY9hkZTTw68B3ZYEdbh3/Fd2jz1zF01yqrl6UfHIWnz7W2M/tPUGFx02bpJ7uf7E3X9cmognM3UFd7X9V+ZhSbrscs9AmFxTg+p2gNP09MXJ6P0JP3uZvRq/PL78dmrQZqmv8tELmvN2G2aFkCRKSnS/e/GFV/BTm+hdfHOY5Cb/royWhm861L87jRN70YvWGaTyJcP5fq1rZEqZUqxQENi4a0pE+E0QkBBfiWgBGWEBkL/7MtdAvTe+k9H62nMPhWFlxyFXRDOjoNwaeagVRG7x42dofm6nvbNU2ueqR7mhGqF4r48cLa/3joZMG+8olXsTMsTcOqk3R/fTrgEcmAtd7QS21ZGlRzL4UF/C+jnXXNrvJZjWRG5MB4OA5gis8uBdWiCKo2GLAxyWw/BqeF8JLmuHyLAuSdIY3PyNEAgKJUpP42a7MNyzUfXns5BcPYV2alfkUvyNvZ9qW2XqhBikdnw99RG8PZE3jk016o08Tzno6O+/x51bmvk0YQqFJ3433/+FRGFzZsaDcV0eybeNV7EeYbbEZhCTDUuVaYxCoPWdrGbdAJCrTEEvRLKEJYeCEWhSkWgBUeFb1MODjKlFScoi1lGe9HL8TAQ7yukCj1vfeN5cipwjprzWmhrZ6yHrICGbB1tbDmLhfWzKVNKBIisCcpgCCIgdhA0FZgcRXcWCc9fYAQaQu+8CihA1Sw8tV7gdKpyxYr5NnrISdRgoEQ2lgjmzVFw3s5VgUF4mzWBRLC6iY6wxRqRWhcNYhEG4ic1x9ZxXiyQQGksRNmwikTktkCxvZzshilEhoGEY/Mqx6g0EHgSGufoY+7Fk5w2WgtnuWoo0DzW9c+WFZEHE7iHtYS6o9mFz3nLk0e0UcBqID6YD4YLoWgCcgJoZWZh/MGciNtdmr3HLCjCybfdfVgsFkf34Pkh5kJR1WTCo7N7XBkX463pw3cfz7lRHV6Yw8z2OEXP3sQYlWgwZiA41dY1cXt+dRkLrKhQu71lhhxfXV4dsuDwGomUKcOwwz+P7d0agjxWaKxB6fbm/nBfT6yW6OvwbnqNfq5y3NaOR0I1jMJDmUitcjQBe1X4/OLqjZiLF4NUJr0q9BnBG765/PH12+vXzIYLaxux0SAdpHH4sYFqMD1TF0jdO2Vbkg+Cvd43qP/7FbStioRLGjoNKvaf6Px62ztu+2+jSSIrG4hX1+sMAv7m9WbDy+1ozx2lUAEy3RvuH/XtwVfSg4xmuHroBTYH3bRvnuQBuy2oewJ9juz2rbIXnfCHVywbG2zSNQd2tMWc5zm6voGjieKgLV+8vpGJhIZD229Ks9iUtv+w9m7LrHq6D7tVS4D/sk8PAtbrtuFtNjv5dutRxNbBTprjP9lsNv8AI19tOg==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/deletefolder"}}');var r=o(74848),s=o(28453),d=o(33617),n=o.n(d),a=o(17543),l=o.n(a),c=o(86013),m=o.n(c),p=o(63723),f=o.n(p),h=(o(18766),o(79329),o(9303));const u={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V19v2zYQ/yosX7YCii2nTYf5acHWBdmKNkAyFFhqBCfpLLGmSI48+Q8Mv+2T7KPtkwxHWbYcJ10zdH2JI/J+d787Hu+Oa0lQBjm+lT9bXaCXk0QWGHKvHClr5FjeVCjaPfFGBRLnV5cCa2cX6INY2UaQFR7JK5yjAKFZxk7FtIUsFFXCtr+2IeHAo6FW32UhE2kdemBTl4UcyxbFOmQiHXiokdAzv7U0UKMcyyMNiln+0aBfyfvcbfYRc7os9oRkIj3+0SiPhRxPQQdMZKCVxmjc1zKRuHTaFrjfziusQY7XklaO5QJ5ZUqZRABQfwWXULuoTG42yY6zVrWi+1Q/mwf55oBGDUtVN7Ucn6Vp0pEyTZ2hl5seh1HaoxBmyn0xBo/bTDcT1hucNQEDy56mKf8cHkxo8hxDmDZa7BJAJjK3htAQy4NzWuVxY/gxMGh9TKA9X04Vz2pItSY9hkZTTw68B3ZYEdbh3/Fd2jz1zF01yqrl6UfHIWnz7W2M/tPUGFx02bpJ7uf7E3X9cmognM3UFd7X9V+ZhSbrscs9AmFxTg+p2gNP09MXJ6P0JP3uZvRq/PL78dmrQZqmv8tELmvN2G2aFkCRKSnS/e/GFV/BTm+hdfHOY5Cb/royWhm861L87jRN70YvWGaTyJcP5fq1rZEqZUqxQENi4a0pE+E0QkBBfiWgBGWEBkL/7MtdAvTe+k9H62nMPhWFlxyFXRDOjoNwaeagVRG7x42dofm6nvbNU2ueqR7mhGqF4r48cLa/3joZMG+8olXsTMsTcOqk3R/fTrgEcmAtd7QS21ZGlRzL4UF/C+jnXXNrvJZjWRG5MB4OA5gis8uBdWiCKo2GLAxyWw/BqeF8JLmuHyLAuSdIY3PyNEAgKJUpP42a7MNyzUfXns5BcPYV2alfkUvyNvZ9qW2XqhBikdnw99RG8PZE3jk016o08Tzno6O+/x51bmvk0YQqFJ3433/+FRGFzZsaDcV0eybeNV7EeYbbEZhCTDUuVaYxCoPWdrGbdAJCrTEEvRLKEJYeCEWhSkWgBUeFb1MODjKlFScoi1lGe9HL8TAQ7yukCj1vfeN5cipwjprzWmhrZ6yHrICGbB1tbDmLhfWzKVNKBIisCcpgCCIgdhA0FZgcRXcWCc9fYAQaQu+8CihA1Sw8tV7gdKpyxYr5NnrISdRgoEQ2lgjmzVFw3s5VgUF4mzWBRLC6iY6wxRqRWhcNYhEG4ic1x9ZxXiyQQGksRNmwikTktkCxvZzshilEhoGEY/Mqx6g0EHgSGufoY+7Fk5w2WgtnuWoo0DzW9c+WFZEHE7iHtYS6o9mFz3nLk0e0UcBqID6YD4YLoWgCcgJoZWZh/MGciNtdmr3HLCjCybfdfVgsFkf34Pkh5kJR1WTCo7N7XBkX463pw3cfz7lRHV6Yw8z2OEXP3sQYlWgwZiA41dY1cXt+dRkLrKhQu71lhhxfXV4dsuDwGomUKcOwwz+P7d0agjxWaKxB6fbm/nBfT6yW6OvwbnqNfq5y3NaOR0I1jMJDmUitcjQBe1X4/OLqjZiLF4NUJr0q9BnBG765/PH12+vXzIYLaxux0SAdpHH4sYFqMD1TF0jdO2Vbkg+Cvd43qP/7FbStioRLGjoNKvaf6Px62ztu+2+jSSIrG4hX1+sMAv7m9WbDy+1ozx2lUAEy3RvuH/XtwVfSg4xmuHroBTYH3bRvnuQBuy2oewJ9juz2rbIXnfCHVywbG2zSNQd2tMWc5zm6voGjieKgLV+8vpGJhIZD229Ks9iUtv+w9m7LrHq6D7tVS4D/sk8PAtbrtuFtNjv5dutRxNbBTprjP9lsNv8AI19tOg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,y={},F=[];function g(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,r.jsx)(n(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,r.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,r.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/4d665321.3e8376ec.js b/assets/js/4d665321.3e8376ec.js new file mode 100644 index 000000000..ebb74bb89 --- /dev/null +++ b/assets/js/4d665321.3e8376ec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6792],{87610:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>f,contentTitle:()=>j,default:()=>y,frontMatter:()=>k,metadata:()=>n,toc:()=>F});const n=JSON.parse('{"id":"API-docs/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/revokedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/revokedocument","permalink":"/docs/API-docs/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V11u3DYQvgozL00MeXf9kxTVU53ESIwatWE7CFBnYXClWYkxRTIktT9YCOhDb9Ab9Gg5STGktKu1HSNB07zYK3JmOPPN/wo8Lxyk1/BaZ3WFyjsYJ5Cjy6wwXmgFKVyVyC5wpm+R5S0VOzo/YVxKPXdsqWvmNbORwhnMxFRkG9Kp1RUR2fWRG0AC2qDl9MJJDilE7o4AEjDc8go9WtJuBYpXCCl0BDcihwQEaWe4L+GuyudWz0SOTE8+YuZPcqanG4XWykICFj/VwmIOqbc1JuD8UtJDTlRGEgEujNQ5Qjrl0hFBVmLFIV2BX5pA6a1QBSQw1bbivn+CCx6kpGDK/Um5z10OTTOOr6LzL3W+JEmZVp6sTlfAjZEiC7gMPzqyZXX/yWgVgWQJRS/Q0a1F3nLcVW2jCDRNAl748HEH9KahS4vOaOWiyP3RiP5tg9uFSotizlydZejctJZy+QSS72VP57zHLXq5IGDNW3MAQfug0pF/nGl/tH+wuzfaHf18tfciPfwlff5iMBqN/oAEFpUk3i7guEfoQRa/m7tkbTzdw7bF9PAhGC91hb4UqmBzAnNutSoSZiRyh8zbJeMFF4pJ7tF+R1TRWm0fR+fbNOtHlFBSKLzpYujmcDS62VuDcPhILCnt2VTXKv+xpj70/uMGHd4crA16ft+gEzXjUuShQF7pW1Q/1p7+8z4+fz9aRSQK97BlbP88Gukwq63wy1CFF7vciN14n16PqZRRpGiq4Ea7WLd9CSkMu6oyXPVqdgMk0M66ql5bCSmU3huXDoeOq3yiFwNtUDlRKMknbpDpasiNGM72oEnucnBjvoEa691vY3CeF0IVj3ONNxhdkh+jq7aQWjuMG/EbLiHpHNGnattZiTxHG5xG4XGx6RTHnZM3lR7Ie0JNdXij9eKZQXUpChViYLZ3rze+R5npCqkN+hJZR/75r38CR+euEKJPPqgP6qy2zOg52mktGVc5m0pciInEQI9VuFvPAQ55JdE5uWRCeSws98hyUQjPJSMEqa5k3PCJkIIim8h0HBB6yeEG7H2JvkRLVz9ZZJzlOENJCcF47XXFPYlat/W5trdTmkgSxtmkdkKhcwxVyVVGhJ2XEqYt44qh8miNFQ6Z85a0FlE3rbzlmWcVV7xAkp1soZSjFBTCzOpJ7TxzWtZBZea5kNpizjqDFGLuBgTiMc0RFhmdZroyFksKqBmyohY5uoRlOkfmgo/JBJWzCTrPDOkiMnQktFZSZ7fBb9RtmdFUVwSXNOD0dSR2b7lyNJW001frgzVgxmpq2xgV3Nl555A8fCrUrUt3dj6oXXa9Dqb3OHHC4/hplxzz+fxeUjzb5nkj/Nt6wi7QaCe8tssNdyF8WU9CIvWFrD+ipDeoMMRPL1E2MnKduft5SafDEqUZXqKnCHHDo/OTUIqfsc9//s1OkVvFSj2P0ZrVFuWSFd1ThFz0fIRtXUnZVIfAKwnxLAZfO8gRgjQ6bCf9dtpZnGIYgYMjN88Z0Yq/7tRkpP1/MZOqAkUxz0LLwYoLGavPr3flhPKPtnJn00u0M5FhW/++4OFhIB5CAlJkqBz22srRm/NTNmMHgxEkvUr6Fd4enp68Ov798pi0ocyKiO0NRoMRHVFrqbjqPdWuI683+8IW2L2R+n/aXtqC7nHhh0ZyEfposHnVtsBr6G0zaX9xGSdQUrNMr2G1mnCH76xsGjr+VKOlTjtOYMat4BMq6NcryIWj3/l6C/mitU8v2oXmGfvqHehBW7qOpahdzbisw/aQwC0u7+xhzbhJurZFykaKV1Gl3SuSs5Fwb/yhrhs5jrIMjX+Utj9vnJ9dXkECk3aHqsKSBpbPaavj86itDhDF7YjOViC5KmpeEG2USZ2Wsnq7Td+GNt3+IKsexGO7f0cz6C8Z9SDDahVHgKZZ08erL3K0wHbU5Jxx0zT/Ai65hag=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"}}');var i=o(74848),a=o(28453),s=o(33617),r=o.n(s),p=o(17543),c=o.n(p),d=o(86013),l=o.n(d),u=o(63723),m=o.n(u),h=(o(18766),o(79329),o(9303));const k={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V11u3DYQvgozL00MeXf9kxTVU53ESIwatWE7CFBnYXClWYkxRTIktT9YCOhDb9Ab9Gg5STGktKu1HSNB07zYK3JmOPPN/wo8Lxyk1/BaZ3WFyjsYJ5Cjy6wwXmgFKVyVyC5wpm+R5S0VOzo/YVxKPXdsqWvmNbORwhnMxFRkG9Kp1RUR2fWRG0AC2qDl9MJJDilE7o4AEjDc8go9WtJuBYpXCCl0BDcihwQEaWe4L+GuyudWz0SOTE8+YuZPcqanG4XWykICFj/VwmIOqbc1JuD8UtJDTlRGEgEujNQ5Qjrl0hFBVmLFIV2BX5pA6a1QBSQw1bbivn+CCx6kpGDK/Um5z10OTTOOr6LzL3W+JEmZVp6sTlfAjZEiC7gMPzqyZXX/yWgVgWQJRS/Q0a1F3nLcVW2jCDRNAl748HEH9KahS4vOaOWiyP3RiP5tg9uFSotizlydZejctJZy+QSS72VP57zHLXq5IGDNW3MAQfug0pF/nGl/tH+wuzfaHf18tfciPfwlff5iMBqN/oAEFpUk3i7guEfoQRa/m7tkbTzdw7bF9PAhGC91hb4UqmBzAnNutSoSZiRyh8zbJeMFF4pJ7tF+R1TRWm0fR+fbNOtHlFBSKLzpYujmcDS62VuDcPhILCnt2VTXKv+xpj70/uMGHd4crA16ft+gEzXjUuShQF7pW1Q/1p7+8z4+fz9aRSQK97BlbP88Gukwq63wy1CFF7vciN14n16PqZRRpGiq4Ea7WLd9CSkMu6oyXPVqdgMk0M66ql5bCSmU3huXDoeOq3yiFwNtUDlRKMknbpDpasiNGM72oEnucnBjvoEa691vY3CeF0IVj3ONNxhdkh+jq7aQWjuMG/EbLiHpHNGnattZiTxHG5xG4XGx6RTHnZM3lR7Ie0JNdXij9eKZQXUpChViYLZ3rze+R5npCqkN+hJZR/75r38CR+euEKJPPqgP6qy2zOg52mktGVc5m0pciInEQI9VuFvPAQ55JdE5uWRCeSws98hyUQjPJSMEqa5k3PCJkIIim8h0HBB6yeEG7H2JvkRLVz9ZZJzlOENJCcF47XXFPYlat/W5trdTmkgSxtmkdkKhcwxVyVVGhJ2XEqYt44qh8miNFQ6Z85a0FlE3rbzlmWcVV7xAkp1soZSjFBTCzOpJ7TxzWtZBZea5kNpizjqDFGLuBgTiMc0RFhmdZroyFksKqBmyohY5uoRlOkfmgo/JBJWzCTrPDOkiMnQktFZSZ7fBb9RtmdFUVwSXNOD0dSR2b7lyNJW001frgzVgxmpq2xgV3Nl555A8fCrUrUt3dj6oXXa9Dqb3OHHC4/hplxzz+fxeUjzb5nkj/Nt6wi7QaCe8tssNdyF8WU9CIvWFrD+ipDeoMMRPL1E2MnKduft5SafDEqUZXqKnCHHDo/OTUIqfsc9//s1OkVvFSj2P0ZrVFuWSFd1ThFz0fIRtXUnZVIfAKwnxLAZfO8gRgjQ6bCf9dtpZnGIYgYMjN88Z0Yq/7tRkpP1/MZOqAkUxz0LLwYoLGavPr3flhPKPtnJn00u0M5FhW/++4OFhIB5CAlJkqBz22srRm/NTNmMHgxEkvUr6Fd4enp68Ov798pi0ocyKiO0NRoMRHVFrqbjqPdWuI683+8IW2L2R+n/aXtqC7nHhh0ZyEfposHnVtsBr6G0zaX9xGSdQUrNMr2G1mnCH76xsGjr+VKOlTjtOYMat4BMq6NcryIWj3/l6C/mitU8v2oXmGfvqHehBW7qOpahdzbisw/aQwC0u7+xhzbhJurZFykaKV1Gl3SuSs5Fwb/yhrhs5jrIMjX+Utj9vnJ9dXkECk3aHqsKSBpbPaavj86itDhDF7YjOViC5KmpeEG2USZ2Wsnq7Td+GNt3+IKsexGO7f0cz6C8Z9SDDahVHgKZZ08erL3K0wHbU5Jxx0zT/Ai65hag=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,f={},F=[];function R(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,i.jsx)(r(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(c(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,i.jsx)(l(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document revoked successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},revokedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"revoke"},title:"revoke"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(R,{...e})}):R(e)}}}]); \ No newline at end of file diff --git a/assets/js/4d665321.9d8377ce.js b/assets/js/4d665321.9d8377ce.js deleted file mode 100644 index 933dc0685..000000000 --- a/assets/js/4d665321.9d8377ce.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6792],{87610:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>J,default:()=>Z,frontMatter:()=>y,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/revokedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/revokedocument","permalink":"/docs/API-docs/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V1tv2zYU/ivseVkDKLaTph2mp6UXdMGKJWgyFFhqBMfSkcyGIlmS8gWG3vZL9tP2S4ZDSbacpEELdH1JLPJcv3PlBgKWHtJreG2yuiIdPEwTyMlnTtogjYYUruYk3tPC3JLIOypxenEmUCmz9GJtahGMcC2Ft5TJQmY70sKZionc9siPIAFjySFrOMshhZa7J4AELDqsKJBj6zagsSJIoSe4kTkkINk6i2EOd02+cGYhcxJm9omycJYLU+wM2hoLCTj6XEtHOaTB1ZSAD2vFirysrGICWlllcoK0QOWZIJtThZBuIKxtpAxO6hISKIyrMAxPaIVRSgp2fjybH6PPoWmmrVby4aXJ1ywpMzqw1+kG0Fols4jL+JNnXzb3VbZeMUiOUQySPN86wo7jrmk7Q6BpEggyxI87oDcNXzry1mjfijyeTPjfPrh9qnQo5sLXWUbeF7VS6yeQfC9/+uA97tHLFQNrf7PPIFofTToNjzMdT46fHR5NDic/Xx29SE9+SZ+/GE0mk78ggVWlmLdPOAwEA8ja7+YuWZdP97DtMD15CMZLU1GYS12KJYO5dEaXibCK0JMIbi2wRKmFwkDuO6JKzhn3ODrfZtkwo6RWUtNNn0M3J5PJzdEWhJNHckmbIApT6/zHuvqQ/scdOrl5tnXo+X2HzvQClcxjg7wyt6R/rD9D9aFVfz9bZUsU72HP2eF566SnrHYyrGMXXh2ilYftfXo95VbGmWK4g1vj274d5pDCuO8q482gZzfAAt2i7+q1U5DCPATr0/HYo85nZjUylrSXpVY486PMVGO0crw4gia5y4HWfgM11YffxuADllKXj3NNdxhdchzbUO0htQ0YWvk7rSHpAzGk6sbZnDAnF4PG6fF+Nyne9EHedXrg6EldmKiji+K5JX0pSx1zYHF0bzZ+IJWZingMhjmJnvzfv/+JHH24Yoo+Eee1E9YsyRW1EqhzUShayZmiB1YAT1gp8l6thdSBSoeBRC5LGVAJBo9bSoYWZ1JJTmomM+1uMKgLPxIf5hTm5PjqJ0cCRU4LUlwLQhlzy3KCEVgHU0UdfRUvjbst2KREoJjVXmryXniinoX0HHVGog9ZIowTqAXpQM466UmgrJi4ME5QUchMsmCuYIdZEBVqLImVJYLtZhRsu2144cys9kF4o+roCGusiELroibK/Ui8lgtqHY87EQWUinJR1iwiEZnJSXQFzW7oXMzIB2FZvcwoCvUBXRCKFuRiisZI8vwV1nCnkah45RnGlgUFh9rzntLtY11otvBZZ3iQRx05rkfio/6oeRqI2hMngJL61qcf9aG43qbZB5p5GWj6tC+b5XJ5r1wO9nneyjCvZ8KRNTu+Mh7G4hqybz8OeDrv19V+ZjsqKG6ZEaOSNMUMRCvbXiiuTy/OYlMWc1J2p5lZ7lc4n46ZcHxJIUhd+nHPf8CFxzmBWezqVKFUbYH/eldO7LDkKn9eXJJbyIy6FvMFqMaReAwJKJmR9jTo3KdvL96JhXg2mkAyaFZfAd743dmrN39cvmFruP+2iB2NJqMJH3H3rlAPVHUb/+vdSr4H9mBr/Z8eCF3PDLQKY6tQxlEVfd50U+YaBg+GdPg2mCYw53mUXsNmM0NPfzrVNHz8uSbHw2yawAKdxBn3zOsN5NLz73y76H/R26fvuzfDgfjqZ8aDvvRDQfNEWKCq44KewC2t7zx1mmmT9JOBjW0pXrUmHV6xnJ2EexsGD7aW4zTLyIZHaYcj/eL88goSmHXPlCq+g8Dhkh9OuGytNRGi9gHCZxtQqMsaS6ZtZfIww5ojNpyEt3ESdj/Yqwfx2B+RrRv8l516kGGzaads02zp26svcnTA9tQcnGnTNP8BWplI3w==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"}}');var i=o(74848),s=o(28453),r=o(33617),c=o.n(r),d=o(17543),a=o.n(d),m=o(86013),l=o.n(m),p=o(63723),u=o.n(p),h=(o(18766),o(79329),o(9303));const y={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V1tv2zYU/ivseVkDKLaTph2mp6UXdMGKJWgyFFhqBMfSkcyGIlmS8gWG3vZL9tP2S4ZDSbacpEELdH1JLPJcv3PlBgKWHtJreG2yuiIdPEwTyMlnTtogjYYUruYk3tPC3JLIOypxenEmUCmz9GJtahGMcC2Ft5TJQmY70sKZionc9siPIAFjySFrOMshhZa7J4AELDqsKJBj6zagsSJIoSe4kTkkINk6i2EOd02+cGYhcxJm9omycJYLU+wM2hoLCTj6XEtHOaTB1ZSAD2vFirysrGICWlllcoK0QOWZIJtThZBuIKxtpAxO6hISKIyrMAxPaIVRSgp2fjybH6PPoWmmrVby4aXJ1ywpMzqw1+kG0Fols4jL+JNnXzb3VbZeMUiOUQySPN86wo7jrmk7Q6BpEggyxI87oDcNXzry1mjfijyeTPjfPrh9qnQo5sLXWUbeF7VS6yeQfC9/+uA97tHLFQNrf7PPIFofTToNjzMdT46fHR5NDic/Xx29SE9+SZ+/GE0mk78ggVWlmLdPOAwEA8ja7+YuWZdP97DtMD15CMZLU1GYS12KJYO5dEaXibCK0JMIbi2wRKmFwkDuO6JKzhn3ODrfZtkwo6RWUtNNn0M3J5PJzdEWhJNHckmbIApT6/zHuvqQ/scdOrl5tnXo+X2HzvQClcxjg7wyt6R/rD9D9aFVfz9bZUsU72HP2eF566SnrHYyrGMXXh2ilYftfXo95VbGmWK4g1vj274d5pDCuO8q482gZzfAAt2i7+q1U5DCPATr0/HYo85nZjUylrSXpVY486PMVGO0crw4gia5y4HWfgM11YffxuADllKXj3NNdxhdchzbUO0htQ0YWvk7rSHpAzGk6sbZnDAnF4PG6fF+Nyne9EHedXrg6EldmKiji+K5JX0pSx1zYHF0bzZ+IJWZingMhjmJnvzfv/+JHH24Yoo+Eee1E9YsyRW1EqhzUShayZmiB1YAT1gp8l6thdSBSoeBRC5LGVAJBo9bSoYWZ1JJTmomM+1uMKgLPxIf5hTm5PjqJ0cCRU4LUlwLQhlzy3KCEVgHU0UdfRUvjbst2KREoJjVXmryXniinoX0HHVGog9ZIowTqAXpQM466UmgrJi4ME5QUchMsmCuYIdZEBVqLImVJYLtZhRsu2144cys9kF4o+roCGusiELroibK/Ui8lgtqHY87EQWUinJR1iwiEZnJSXQFzW7oXMzIB2FZvcwoCvUBXRCKFuRiisZI8vwV1nCnkah45RnGlgUFh9rzntLtY11otvBZZ3iQRx05rkfio/6oeRqI2hMngJL61qcf9aG43qbZB5p5GWj6tC+b5XJ5r1wO9nneyjCvZ8KRNTu+Mh7G4hqybz8OeDrv19V+ZjsqKG6ZEaOSNMUMRCvbXiiuTy/OYlMWc1J2p5lZ7lc4n46ZcHxJIUhd+nHPf8CFxzmBWezqVKFUbYH/eldO7LDkKn9eXJJbyIy6FvMFqMaReAwJKJmR9jTo3KdvL96JhXg2mkAyaFZfAd743dmrN39cvmFruP+2iB2NJqMJH3H3rlAPVHUb/+vdSr4H9mBr/Z8eCF3PDLQKY6tQxlEVfd50U+YaBg+GdPg2mCYw53mUXsNmM0NPfzrVNHz8uSbHw2yawAKdxBn3zOsN5NLz73y76H/R26fvuzfDgfjqZ8aDvvRDQfNEWKCq44KewC2t7zx1mmmT9JOBjW0pXrUmHV6xnJ2EexsGD7aW4zTLyIZHaYcj/eL88goSmHXPlCq+g8Dhkh9OuGytNRGi9gHCZxtQqMsaS6ZtZfIww5ojNpyEt3ESdj/Yqwfx2B+RrRv8l516kGGzaads02zp26svcnTA9tQcnGnTNP8BWplI3w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},J=void 0,v={},f=[];function g(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,i.jsx)(c(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,i.jsx)(l(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document revoked successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},revokedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"revoke"},title:"revoke"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function Z(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.4cc28061.js b/assets/js/52d5c0f9.4cc28061.js new file mode 100644 index 000000000..86c8a8254 --- /dev/null +++ b/assets/js/52d5c0f9.4cc28061.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4469],{27668:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>Y,default:()=>k,frontMatter:()=>f,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/deletedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletedocument","permalink":"/docs/API-docs/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oY8mp9SYrqqW5tJEaNxIgdBKizMLjSSGJMkQxJ7QULAX3oH/QP+mn5kmIoaVfrdYwEbfNir6i5nhnOGa2Y54VjyQ071WldofKOTSKWoUutMF5oxRJ2XSKcokSPkHVScHJ5DlxKPXew1DV4DRYrPUNwBlORi3QjmltdkZBdH7kRi5g2aDl5OM9YwrJgvxdgETPc8go9WopuxRSvkMQ6gVuRsYgJis5wX7L7IV9aPRMZgp5+xNSfZ6DzTUBeQ+uORczip1pYzFjibY0Rc34pyZETlZEkgAsjdYYsybl0JJCWWHGWrJhfmiDprVAFi1iubcX98AQXPFhJmCkPp+Uhdxlrmgl5dUYrh47sHI7H9G87gb4cXaQZuDpN0bm8lnL5hEUs1coTUsmKcWOkSAOW8UdH6qvdMFskCFhLyHvROu8BeiihTfi/LCh488ocsSbqa3XiH1c6HB8e7R+M98c/Xh+8SI5/Sp6/GI3H499ZxBaVJN2+qNwj2fXCy81zsyPW1mwo2J00JHz8EIxXukJfClXAnMCcW62KCIxE7hC8XQIvuFAguUf7H6KK1mr7ODrfFlkzyFooKRTe9j10ezwe3x6sQTh+pJeU9pDrWmXfN9WH/D+e0PHt0Tqh57sJnasZlyILQ+ha36H6vvkM3fvW/W63ilYovGdbyQ7P2yQdprUVfhkm3WKfG7Hfvk9uJjQuqFP0ZkqG6ehLlrC4n2nxajAZG0Ym7ayfnbWVLGGl98Ylcey4yqZ6MdIGlROFknzqRqmuYm5EPDtgTXRfgxvzDdJY73+bgvO8EKp4XGuyQemKKtkWawurdcm4Eb/hkkV9KYZSHWmUyDO0oWxC5ToodwV6Y1BdiUKF8s4OdqjlPcpUV0gs4kuEXvzzn38Hjb4OofuefFAf1JvagtFztHktgasMcokLMZUY5LEK79Y06pBXEp2TSxDKY2E50a4ohOcSCBoaGSk3fCqkoKYlMd3y66Dv3Qjel+hLtPTqB4vAIcMZSup14LXXFfdkas2Kc23vciL0CDhMaycUOgeoSq5SEuzhj0Bb4ApQebTGCofgvKWoRRubVt7y1EPFFS+QbEdbKGUoBfUmWD2tnQenZR1CBs+F1BYz6BNSiJkbEYhnRMMWgU5TXRmLJXXKDKGoRYYuglRnCC7cUUpBZTBF58FQLCJFR0ZrJXV6F+pGRApG08gQXNJ+MIyR1L3lyhGpd8tLV4M1YMZqYmRsA9zbe+eQKnwh1J1L9vY+qH24WTfTe5w64XHytO/6+Xy+0+3PtnVeCv+qnsJbNNoJr+1yo10IX9bTcEOGRtYPraWXqDD0z+AGbGxkOnW7F45O4xKlia/QU4e4+OTyPEzZZ/D5j7/gArlVUOp5261pbVEuoehdEXJt5VvY1kMSch0aryTE07b5aPtC5wlB2gq2b/P2tbOYY9ggQyE37ozozN/0YQJF/2/SpHFNXczTwCZYcSHbsfLzfTthsqOt3Jv8Cu1MpNgNti9UOA7CMYuYFCkqhwPGOHl5eQEzOBqNWTQYkV9R7fji/Nez11dnFA3drBaxg9F4NKYjo52vuBq46rb50826vQX2akOm/9Py301qjwsfG8lFoMiQ86rjths2+BhIhnv/JGKldp5EVqspd/jOyqah4081WiLRScRm3Ao+pYF+s2KZcPQ7Wy/xX8z26dvue+AZfPUnxIO59FSkiIdmXNb0xCJ2h8t7nzHNpIl6PqJgW4mTNEXjB7o7O83WYnB6dnF2fcYiRhdsmwrvAhV2P8jBg6Ftc2QbA/0lun5QYbVqabZp1vLtqy9qdDn20oTTpGmafwDN2xi/","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"}}');var s=o(74848),i=o(28453),d=o(33617),c=o.n(d),l=o(17543),a=o.n(l),p=o(86013),r=o.n(p),m=o(63723),u=o.n(m),h=(o(18766),o(79329),o(9303));const f={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oY8mp9SYrqqW5tJEaNxIgdBKizMLjSSGJMkQxJ7QULAX3oH/QP+mn5kmIoaVfrdYwEbfNir6i5nhnOGa2Y54VjyQ071WldofKOTSKWoUutMF5oxRJ2XSKcokSPkHVScHJ5DlxKPXew1DV4DRYrPUNwBlORi3QjmltdkZBdH7kRi5g2aDl5OM9YwrJgvxdgETPc8go9WopuxRSvkMQ6gVuRsYgJis5wX7L7IV9aPRMZgp5+xNSfZ6DzTUBeQ+uORczip1pYzFjibY0Rc34pyZETlZEkgAsjdYYsybl0JJCWWHGWrJhfmiDprVAFi1iubcX98AQXPFhJmCkPp+Uhdxlrmgl5dUYrh47sHI7H9G87gb4cXaQZuDpN0bm8lnL5hEUs1coTUsmKcWOkSAOW8UdH6qvdMFskCFhLyHvROu8BeiihTfi/LCh488ocsSbqa3XiH1c6HB8e7R+M98c/Xh+8SI5/Sp6/GI3H499ZxBaVJN2+qNwj2fXCy81zsyPW1mwo2J00JHz8EIxXukJfClXAnMCcW62KCIxE7hC8XQIvuFAguUf7H6KK1mr7ODrfFlkzyFooKRTe9j10ezwe3x6sQTh+pJeU9pDrWmXfN9WH/D+e0PHt0Tqh57sJnasZlyILQ+ha36H6vvkM3fvW/W63ilYovGdbyQ7P2yQdprUVfhkm3WKfG7Hfvk9uJjQuqFP0ZkqG6ehLlrC4n2nxajAZG0Ym7ayfnbWVLGGl98Ylcey4yqZ6MdIGlROFknzqRqmuYm5EPDtgTXRfgxvzDdJY73+bgvO8EKp4XGuyQemKKtkWawurdcm4Eb/hkkV9KYZSHWmUyDO0oWxC5ToodwV6Y1BdiUKF8s4OdqjlPcpUV0gs4kuEXvzzn38Hjb4OofuefFAf1JvagtFztHktgasMcokLMZUY5LEK79Y06pBXEp2TSxDKY2E50a4ohOcSCBoaGSk3fCqkoKYlMd3y66Dv3Qjel+hLtPTqB4vAIcMZSup14LXXFfdkas2Kc23vciL0CDhMaycUOgeoSq5SEuzhj0Bb4ApQebTGCofgvKWoRRubVt7y1EPFFS+QbEdbKGUoBfUmWD2tnQenZR1CBs+F1BYz6BNSiJkbEYhnRMMWgU5TXRmLJXXKDKGoRYYuglRnCC7cUUpBZTBF58FQLCJFR0ZrJXV6F+pGRApG08gQXNJ+MIyR1L3lyhGpd8tLV4M1YMZqYmRsA9zbe+eQKnwh1J1L9vY+qH24WTfTe5w64XHytO/6+Xy+0+3PtnVeCv+qnsJbNNoJr+1yo10IX9bTcEOGRtYPraWXqDD0z+AGbGxkOnW7F45O4xKlia/QU4e4+OTyPEzZZ/D5j7/gArlVUOp5261pbVEuoehdEXJt5VvY1kMSch0aryTE07b5aPtC5wlB2gq2b/P2tbOYY9ggQyE37ozozN/0YQJF/2/SpHFNXczTwCZYcSHbsfLzfTthsqOt3Jv8Cu1MpNgNti9UOA7CMYuYFCkqhwPGOHl5eQEzOBqNWTQYkV9R7fji/Nez11dnFA3drBaxg9F4NKYjo52vuBq46rb50826vQX2akOm/9Py301qjwsfG8lFoMiQ86rjths2+BhIhnv/JGKldp5EVqspd/jOyqah4081WiLRScRm3Ao+pYF+s2KZcPQ7Wy/xX8z26dvue+AZfPUnxIO59FSkiIdmXNb0xCJ2h8t7nzHNpIl6PqJgW4mTNEXjB7o7O83WYnB6dnF2fcYiRhdsmwrvAhV2P8jBg6Ftc2QbA/0lun5QYbVqabZp1vLtqy9qdDn20oTTpGmafwDN2xi/",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},Y=void 0,b={},y=[];function g(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(r(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.ab1067bd.js b/assets/js/52d5c0f9.ab1067bd.js deleted file mode 100644 index f1992e089..000000000 --- a/assets/js/52d5c0f9.ab1067bd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4469],{27668:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>f,default:()=>S,frontMatter:()=>I,metadata:()=>d,toc:()=>y});const d=JSON.parse('{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/deletedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletedocument","permalink":"/docs/API-docs/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V91u2zYUfpVT3qwBFMv5aYfpatkSdMGKNVgyFFhqBLR0JLGhSJak/ANBd3uSPdqeZDiUZMuxG7TA1hvbor7zf/id44Z5XjiW3LNLndYVKu/YLGIZutQK44VWLGF3JcIlSvQIWY+Ci5tr4FLqpYO1rsFrsFjpBYIzmIpcpFtobnVFILs5chMWMW3QcrJwnbGEZUH/AGARM9zyCj1a8q5hildIsB7wIDIWMUHeGe5L9tTlG6sXIkPQ84+Y+usMdL51yGvozLGIWfxUC4sZS7ytMWLOryUZcqIykgC4MlJnyJKcS0eAtMSKs6Rhfm0C0luhChaxXNuK+/EJrnjQkjBTns7LU+4y1rYzsuqMVg4d6TmdTulrN4ChHL2nGbg6TdG5vJZy/YJFLNXKU6aShnFjpEhDLuOPjsSbfTe7TFBiLWXei874kKBDAW3d/2lFzptfzBlro6FWF/55odPp6dnxyfR4+v3dyevk/Ifk1evJdDr9k0VsVUmSHYrKPZJeL7zcPrd7sK5mY2B/0hL4/FAab3WFvhSqgCUlc2m1KiIwErlD8HYNvOBCgeQe7X+YVbRW2+ez83WetaOohZJC4cPQQw/n0+nDySYJ58/0ktIecl2r7NuGesj+8wGdP5xtAnq1H9C1WnApskBCd/oR1beNZ2zed+b3u1V0oPCe7QQ7Pu+CdJjWVvh1YLrVMTfiuHuf3M+ILqhT9JYlAzv6kiUsHjgtbkbM2DJSaRcDd9ZWsoSV3huXxLHjKpvr1UQbVE4USvK5m6S6irkR8eKEtdFTCW7MV6CxPv46Aed5IVTxvNRsm6VbqmRXrJ1cbUrGjfgV1ywaSjFG9UOjRJ6hDWUTKtdBuC/QO4PqVhQqlHdxsjda3qNMdYU0RXyJMMD/+evvIDHUIXTfC3hXWzB6iTavJXCVQS5xJeYSD0xQh7yS6Jxcg1AeC8tp4opCeC6BskJskXLD50IK6leC6W60jlreTeB9ib5ES6++swgcMlygpDYHqfUj6fEaeO11xcdTfantY04uRcBhXjuh0DlwiIMIqpKrFGGoRQTaAleAyqM1VjgELioC59oC5rlIBSmmy2l56qHiihdIxiIgvykLphvWDqye186D07IOgZDFCtF3ISrEzE3gUiywCzysFOi5kJhBUZOKCFKdIfR3lcJQGczReTBkXqQYlDrPrQeJC7Sh90IlabSC0UQigkvaGMa1JUXecuVozPfrTF+aTfqM1TSjg42MryfwQX1QRPRQO6QGkEI9uuSDOob7TZu9x7kTHmcvh/uwXC737sHRrswb4ct6DhaN3soV4TDcmrH45uGIBu/uhdntbIs5hiUt5KhAhaEDuREdzcH9xc114FsoUZqtZRLZv7p0GhMwvkXvhSpcPMgfESNST/A0EDZWXMju5v74VE8gT7SVe5ffol2IFHvu+Eyq4gCOWcSkSFE5HJHyxZubt7CAs8mURSMW+oLkxW+vf7767faKvCFi7TJ2MplOpnRktPMVVyNT/cJ8ud1od5LdbOfV/7Rf92ToceVjI7kIUyjE3PTj456N9u1kvFrPIlZq5wnSNHPu8A8r25aOP9VoaU7NIrbgVvA5ceZ9wzLh6He22ZM/G+3L3/uV+wi+eEs/GMvA9oqofsFlTU8sYo+4fvJPoZ210UD55GyHuEhTNH4ku7c27Mzey6u3V3dXLGK8puSNp81jmDb9DzJw0LXdMdT5QJ80EQ8KNE03ydp2g+9efVaij3FAU55mbdv+C0ES2+c=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"}}');var s=o(74848),n=o(28453),i=o(33617),c=o.n(i),r=o(17543),l=o.n(r),a=o(86013),u=o.n(a),p=o(63723),m=o.n(p),h=(o(18766),o(79329),o(9303));const I={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V91u2zYUfpVT3qwBFMv5aYfpatkSdMGKNVgyFFhqBLR0JLGhSJak/ANBd3uSPdqeZDiUZMuxG7TA1hvbor7zf/id44Z5XjiW3LNLndYVKu/YLGIZutQK44VWLGF3JcIlSvQIWY+Ci5tr4FLqpYO1rsFrsFjpBYIzmIpcpFtobnVFILs5chMWMW3QcrJwnbGEZUH/AGARM9zyCj1a8q5hildIsB7wIDIWMUHeGe5L9tTlG6sXIkPQ84+Y+usMdL51yGvozLGIWfxUC4sZS7ytMWLOryUZcqIykgC4MlJnyJKcS0eAtMSKs6Rhfm0C0luhChaxXNuK+/EJrnjQkjBTns7LU+4y1rYzsuqMVg4d6TmdTulrN4ChHL2nGbg6TdG5vJZy/YJFLNXKU6aShnFjpEhDLuOPjsSbfTe7TFBiLWXei874kKBDAW3d/2lFzptfzBlro6FWF/55odPp6dnxyfR4+v3dyevk/Ifk1evJdDr9k0VsVUmSHYrKPZJeL7zcPrd7sK5mY2B/0hL4/FAab3WFvhSqgCUlc2m1KiIwErlD8HYNvOBCgeQe7X+YVbRW2+ez83WetaOohZJC4cPQQw/n0+nDySYJ58/0ktIecl2r7NuGesj+8wGdP5xtAnq1H9C1WnApskBCd/oR1beNZ2zed+b3u1V0oPCe7QQ7Pu+CdJjWVvh1YLrVMTfiuHuf3M+ILqhT9JYlAzv6kiUsHjgtbkbM2DJSaRcDd9ZWsoSV3huXxLHjKpvr1UQbVE4USvK5m6S6irkR8eKEtdFTCW7MV6CxPv46Aed5IVTxvNRsm6VbqmRXrJ1cbUrGjfgV1ywaSjFG9UOjRJ6hDWUTKtdBuC/QO4PqVhQqlHdxsjda3qNMdYU0RXyJMMD/+evvIDHUIXTfC3hXWzB6iTavJXCVQS5xJeYSD0xQh7yS6Jxcg1AeC8tp4opCeC6BskJskXLD50IK6leC6W60jlreTeB9ib5ES6++swgcMlygpDYHqfUj6fEaeO11xcdTfantY04uRcBhXjuh0DlwiIMIqpKrFGGoRQTaAleAyqM1VjgELioC59oC5rlIBSmmy2l56qHiihdIxiIgvykLphvWDqye186D07IOgZDFCtF3ISrEzE3gUiywCzysFOi5kJhBUZOKCFKdIfR3lcJQGczReTBkXqQYlDrPrQeJC7Sh90IlabSC0UQigkvaGMa1JUXecuVozPfrTF+aTfqM1TSjg42MryfwQX1QRPRQO6QGkEI9uuSDOob7TZu9x7kTHmcvh/uwXC737sHRrswb4ct6DhaN3soV4TDcmrH45uGIBu/uhdntbIs5hiUt5KhAhaEDuREdzcH9xc114FsoUZqtZRLZv7p0GhMwvkXvhSpcPMgfESNST/A0EDZWXMju5v74VE8gT7SVe5ffol2IFHvu+Eyq4gCOWcSkSFE5HJHyxZubt7CAs8mURSMW+oLkxW+vf7767faKvCFi7TJ2MplOpnRktPMVVyNT/cJ8ud1od5LdbOfV/7Rf92ToceVjI7kIUyjE3PTj456N9u1kvFrPIlZq5wnSNHPu8A8r25aOP9VoaU7NIrbgVvA5ceZ9wzLh6He22ZM/G+3L3/uV+wi+eEs/GMvA9oqofsFlTU8sYo+4fvJPoZ210UD55GyHuEhTNH4ku7c27Mzey6u3V3dXLGK8puSNp81jmDb9DzJw0LXdMdT5QJ80EQ8KNE03ydp2g+9efVaij3FAU55mbdv+C0ES2+c=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,v={},y=[];function D(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function S(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(D,{...e})}):D(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.85cab8cc.js b/assets/js/5a2de241.85cab8cc.js new file mode 100644 index 000000000..dbef78986 --- /dev/null +++ b/assets/js/5a2de241.85cab8cc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2223],{85651:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>w,frontMatter:()=>b,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"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":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar_label":"Update Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzFWNtuGzkS/ZUavmwStCXZcTJYPa13JpsYY4wFXxDsOobA7i6pOWaTHJItWRAa2If9g/mD+bT5kkWR3a3WJU68M7v7YsjsYvHUqWJduGaezx0b37EbLI3kHh27T1iOLrPCeKEVG7ObAuHW5NwjtFJwNjkHVDyV6GClK/AaSp2L2Qq4yqGK0r5AyNFzIR3oGXBwBjMxExn4Rs+AJUwbtJyOOs/ZmMWt7TksYYZbXqJHSzDXTPES2Zi1CqYiZwkTBNNwX7Bd7Off08kEpN0BvuAeFGLuCHWKDVrSY/HnSljM2djbChPm/ErSaU6URhIYfDRS58jGMy4dCWQFlpyN18yvTJD0Vqg5S9hM25L7zUpd30f96Pxfdb6iPdtQJ1YvRI6QotRL6MwmkC2frY/gBfcgkTsPWmFPtjXgJUtYppVH5ekgbowUWSB5+JOj09b70HX6E2aeGLfkEi/Q0ddI+JcNJHJ4oGnMXPjR4WV1wpT2z1YzIRMRLC4ELkNgOTFX4AvhINdZVZJ59Y7Ln3dEFxV9HTXtkTlaish9fZvdJBlvweXNpCeaai2Rq71opKiCo2iADouwFFI2NwkubyawQEs3JPhqALcOrYsyFjMUCwS+JQKZzhEWggOWXMgEloXICgr4FZSV84CqiaGGOuyYG0AIYjiCfUC5cAcRJcCl1Euh5lAFaIcUQy4sZl6uYCl8oSsPPM8FbecSnEfjBn0WA4qOyBtd2d/PJId5JXLMwevKwkzbgBKtS8CEa0YWCOW8rTLa7CCvyLvBDhKl38bqDJ3b8NSyQkI9/QmgcnE7hxl3Hm0ClRLEvK2Mx7xTiY8GrUCV4UEKArnTkEgbwt3XczFBWwrvWkvJNTzPASWSUxy4KiuAx+/cVxZdAkIJL7h0CTjPS+MS0BY8PlJeAa8NJU98FM4T+KXI5+gdiM/F0RXSHcl6GGZWl8H7xI1a9QOhw+X1jrobcqpwTfmY8Up6WHBZHeZsJuTBxLLN0d91BSVfNd6PLky5w7engIruUA6T7/8GpIwAWTSSZ1Gss18r7GeTuH0vH1iM4T+trPwyrutYETFae3t1AcsCLXZxiDbGdUppMCpGqq/h5tOpvo3a7vbthu8eQl55PbVYCpXj19y1a/TBSRRmXndXrPK65F5k0KpyA2hEY0B43b8xJbxonZliwRdC25cHHRrVTbXKcCrUFBdoVz2UqipTtHsgfwzLFK85XzlI0S8RVR9bG1ZayRU0FZGwLQtUsMUJSbmN0Vso39R1wrzwW9Vj2mtHpilV97qugynOaOViIT0ZjfaLftdQNU0I3VLy2qyScvXNH1fF4/KX6hl3+ckHNzn9YChOGkhn/ulNJ6OT10fHo6PRtzfHb8enfx6/eTsYjUb/YAl7LOWmhWB50wq07MX/ewtCSaFw2rI2PRmNpq8bKk8Psdc0CO2lXnApcpgJlDnQme4PJBCt1fY/bGCewPeU+WRya/zpE6GjtIeZrlT+/zb3EKKnDTydftuZ+GbfxHMVKaNp40Y/oPpfWLixp3+8j8cT1O2oFlEofGdbxvbXo5EOs8oKvwqTzOMRN+Iofh/f3dN8UKIvNE1BpgqAaaIZs2GbXYbrXp6pGemzi3YwCuWGFd4bNx4OHVd5qh8H2qCigiB56gaZLofciOHimNXJ7g5uzDOksTp63gbn+Vyo+dO77jcUXZMbo6e2iOr8xY34AVcsaf3Ql2omwgI5VThinqLjajN9vWt93Llxd2RpJ5avG0L2WrJDY0V/qmBsa3Joxsl+C9wsHWwJm2+x9WFst+mglZ0i3+w4XFvf1ETYTAd2m/C9NKiuyVAK/sXxnoUfUWa6xLZ7a8V/+9evYUfLTED8zSf1SV1WFoxeop1VMtA4k/goqACHt4QyfOseExzyUqJzcgXUR89tIFPMhacZoulwMm54KqSgK01imnZb6GUFN4CPBfoCLX36k6XJIMcFSsoEXQuj5pvuaantw0zqpUuAQ1o5odA5QFVwlZFgG5+hU+YqzlfGCofgvCXUImLTylueeSi54vPQ6iZbLOUoBV1esDqlQc1pWcVRhB5MtA3DRTQoPFYMiMR39P5gEWiV+j+LBV2lRTOPuCTOgzGYyQSVQ4rOgyEsIsPQbldK6uwh+I36DDCaEqrgktqnPkba7i1XjrJ+xNL6oCOsaTMxAnz16tYhefhCqAc3fvXqkzqCuy6YPmLqhMf7F21aWC6Xe+ng5fae98J/qFK4QqOd8NquNrvnwhdVGlJIX0n3T9T0HhWG+OmliI2OXGduPyPR6rBAaYbX6ClC3PBsch5q0Ev47Z+/wAVyq6DQyxitWWVRrmDeHkXMRc9H2roSEoZRXvmCGM9i8DXPQsQgNU3b6W772lmcoSXygyM3xxnRqL9rYQKh/z1mUjGjKOZZqLXhfSHm3b/s6gl1D23pLmfXaBciwybzf8bDwyA8ZAmTIkPl+on47P3kAhbwejBiSa+GfIW3hxfn37378fodoaGbFRk7HowGI1oy2vmSq95RO4+auzluvWk1/ttvoE1No8l7aCQXoZNoBsjYBdyxXmka958/7xNWaOdJZL2mofTWyrqm5Z+rkN7v7hO24FYQ0tAqNFNZ3pWFz5r94qp9UITnvaQeNKit3IrKdpjoY616wNXOk259Xydt+SbEUeK7iOvohvRsNOx1gdR9xB1nWYbGPynbb7smtzcsYWnzPFuGl15m+ZIqLF9GsPG1KTQmYW3NJFfzis9JNqqs45BdbHcrD6FbaX6QUQfp2G5johX0l2w6uGG9jp1QXXfy8dNndzS8ttLkm/u6rv8NBIl6Uw==","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"}}');var o=a(74848),s=a(28453),n=a(33617),p=a.n(n),l=a(17543),d=a.n(l),r=a(86013),m=a.n(r),c=a(63723),u=a.n(c),f=(a(18766),a(79329),a(9303));const b={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWNtuGzkS/ZUavmwStCXZcTJYPa13JpsYY4wFXxDsOobA7i6pOWaTHJItWRAa2If9g/mD+bT5kkWR3a3WJU68M7v7YsjsYvHUqWJduGaezx0b37EbLI3kHh27T1iOLrPCeKEVG7ObAuHW5NwjtFJwNjkHVDyV6GClK/AaSp2L2Qq4yqGK0r5AyNFzIR3oGXBwBjMxExn4Rs+AJUwbtJyOOs/ZmMWt7TksYYZbXqJHSzDXTPES2Zi1CqYiZwkTBNNwX7Bd7Off08kEpN0BvuAeFGLuCHWKDVrSY/HnSljM2djbChPm/ErSaU6URhIYfDRS58jGMy4dCWQFlpyN18yvTJD0Vqg5S9hM25L7zUpd30f96Pxfdb6iPdtQJ1YvRI6QotRL6MwmkC2frY/gBfcgkTsPWmFPtjXgJUtYppVH5ekgbowUWSB5+JOj09b70HX6E2aeGLfkEi/Q0ddI+JcNJHJ4oGnMXPjR4WV1wpT2z1YzIRMRLC4ELkNgOTFX4AvhINdZVZJ59Y7Ln3dEFxV9HTXtkTlaish9fZvdJBlvweXNpCeaai2Rq71opKiCo2iADouwFFI2NwkubyawQEs3JPhqALcOrYsyFjMUCwS+JQKZzhEWggOWXMgEloXICgr4FZSV84CqiaGGOuyYG0AIYjiCfUC5cAcRJcCl1Euh5lAFaIcUQy4sZl6uYCl8oSsPPM8FbecSnEfjBn0WA4qOyBtd2d/PJId5JXLMwevKwkzbgBKtS8CEa0YWCOW8rTLa7CCvyLvBDhKl38bqDJ3b8NSyQkI9/QmgcnE7hxl3Hm0ClRLEvK2Mx7xTiY8GrUCV4UEKArnTkEgbwt3XczFBWwrvWkvJNTzPASWSUxy4KiuAx+/cVxZdAkIJL7h0CTjPS+MS0BY8PlJeAa8NJU98FM4T+KXI5+gdiM/F0RXSHcl6GGZWl8H7xI1a9QOhw+X1jrobcqpwTfmY8Up6WHBZHeZsJuTBxLLN0d91BSVfNd6PLky5w7engIruUA6T7/8GpIwAWTSSZ1Gss18r7GeTuH0vH1iM4T+trPwyrutYETFae3t1AcsCLXZxiDbGdUppMCpGqq/h5tOpvo3a7vbthu8eQl55PbVYCpXj19y1a/TBSRRmXndXrPK65F5k0KpyA2hEY0B43b8xJbxonZliwRdC25cHHRrVTbXKcCrUFBdoVz2UqipTtHsgfwzLFK85XzlI0S8RVR9bG1ZayRU0FZGwLQtUsMUJSbmN0Vso39R1wrzwW9Vj2mtHpilV97qugynOaOViIT0ZjfaLftdQNU0I3VLy2qyScvXNH1fF4/KX6hl3+ckHNzn9YChOGkhn/ulNJ6OT10fHo6PRtzfHb8enfx6/eTsYjUb/YAl7LOWmhWB50wq07MX/ewtCSaFw2rI2PRmNpq8bKk8Psdc0CO2lXnApcpgJlDnQme4PJBCt1fY/bGCewPeU+WRya/zpE6GjtIeZrlT+/zb3EKKnDTydftuZ+GbfxHMVKaNp40Y/oPpfWLixp3+8j8cT1O2oFlEofGdbxvbXo5EOs8oKvwqTzOMRN+Iofh/f3dN8UKIvNE1BpgqAaaIZs2GbXYbrXp6pGemzi3YwCuWGFd4bNx4OHVd5qh8H2qCigiB56gaZLofciOHimNXJ7g5uzDOksTp63gbn+Vyo+dO77jcUXZMbo6e2iOr8xY34AVcsaf3Ql2omwgI5VThinqLjajN9vWt93Llxd2RpJ5avG0L2WrJDY0V/qmBsa3Joxsl+C9wsHWwJm2+x9WFst+mglZ0i3+w4XFvf1ETYTAd2m/C9NKiuyVAK/sXxnoUfUWa6xLZ7a8V/+9evYUfLTED8zSf1SV1WFoxeop1VMtA4k/goqACHt4QyfOseExzyUqJzcgXUR89tIFPMhacZoulwMm54KqSgK01imnZb6GUFN4CPBfoCLX36k6XJIMcFSsoEXQuj5pvuaantw0zqpUuAQ1o5odA5QFVwlZFgG5+hU+YqzlfGCofgvCXUImLTylueeSi54vPQ6iZbLOUoBV1esDqlQc1pWcVRhB5MtA3DRTQoPFYMiMR39P5gEWiV+j+LBV2lRTOPuCTOgzGYyQSVQ4rOgyEsIsPQbldK6uwh+I36DDCaEqrgktqnPkba7i1XjrJ+xNL6oCOsaTMxAnz16tYhefhCqAc3fvXqkzqCuy6YPmLqhMf7F21aWC6Xe+ng5fae98J/qFK4QqOd8NquNrvnwhdVGlJIX0n3T9T0HhWG+OmliI2OXGduPyPR6rBAaYbX6ClC3PBsch5q0Ev47Z+/wAVyq6DQyxitWWVRrmDeHkXMRc9H2roSEoZRXvmCGM9i8DXPQsQgNU3b6W772lmcoSXygyM3xxnRqL9rYQKh/z1mUjGjKOZZqLXhfSHm3b/s6gl1D23pLmfXaBciwybzf8bDwyA8ZAmTIkPl+on47P3kAhbwejBiSa+GfIW3hxfn37378fodoaGbFRk7HowGI1oy2vmSq95RO4+auzluvWk1/ttvoE1No8l7aCQXoZNoBsjYBdyxXmka958/7xNWaOdJZL2mofTWyrqm5Z+rkN7v7hO24FYQ0tAqNFNZ3pWFz5r94qp9UITnvaQeNKit3IrKdpjoY616wNXOk259Xydt+SbEUeK7iOvohvRsNOx1gdR9xB1nWYbGPynbb7smtzcsYWnzPFuGl15m+ZIqLF9GsPG1KTQmYW3NJFfzis9JNqqs45BdbHcrD6FbaX6QUQfp2G5johX0l2w6uGG9jp1QXXfy8dNndzS8ttLkm/u6rv8NBIl6Uw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,y={},g=[];function T(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,o.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,o.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,o.jsx)(m(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"template_template_id_body"}}}}}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Template not found!"}},title:"inline_response_404_7"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function w(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.fbd45b06.js b/assets/js/5a2de241.fbd45b06.js deleted file mode 100644 index 107d60567..000000000 --- a/assets/js/5a2de241.fbd45b06.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2223],{85651:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>f,default:()=>v,frontMatter:()=>y,metadata:()=>a,toc:()=>g});const a=JSON.parse('{"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":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar_label":"Update Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzFWNtuI7kR/ZVavmQGaF3s8c4ieoqzM9k1soiFsQaDxCMYVLNazTWb5JJsyYLQb/mSfFq+JCiyW2pdxjtONsmLIbOrilWnilWH3LLAl55N7tkMK6t4QM/mGRPocydtkEazCZuVCB+t4AGhk4Lr6Q2g5guFHjamhmCgMkIWG+BaQJ2kQ4kgMHCpPJgCOHiLuSxkDqG1M2QZMxYdp61uBJuwpNrtwzJmueMVBnTk5pZpXiGbsM7AgxQsY5LctDyU7Nj3m3e0MznSaUAoeQCNKDx5vcDWW7Lj8JdaOhRsElyNGfNho2g3LyuryBl8ssoIZJOCK08CeYkVZ5MtCxsbJYOTeskyVhhX8bBfaZp5so8+/NGIDekcujp1ZiUFwgKVWcMubHKyw7PLEbziARRyH8Bo7Ml2AbxmGcuNDqgDbcStVTKPII9+9rTb9tR1s/gZ80CIO0pJkOjpawL81wMkcHiEacJ8/LHzlzUZ0ya82MyUQkRwuJK4joXl5VJDKKUHYfK6ovCao5S/bItdVfRtNKSjBDqqyFN7e22STKfgdjbtiS6MUcj1STVSVcEgBWDiIqylUu1JgtvZFFbo6ITEXA3ho0fnk4zDHOUKgR+IQG4EwkpywIpLlcG6lHlJBb+BqvYBULc11EKHO+SGEIsYBnDqkJD+rEcZcKXMWuol1NG1c4ZBSId5UBtYy1CaOgAXQpI6V+ADWj/soxi92AE5M7X7z5HksKylQAHB1A4K46KX6HwGNh4zikBqH1ydk7IHUVN2YxwkSr+tMzl6v8epQ4WEevYzQO2TOoeC+4Aug1pLQt7VNqDYmcQni06izvEsBBHch9hIW8D912MxRVfJ4LtIKTVcCECFlBQPvs5L4Ok7D7VDn4HUMkiufAY+8Mr6DIyDgE/UVyAYS80Tn6QP5PxaiiUGD/JLdfQB6YzkPR8KZ6qYfcJGb/qFsPMrmCNzM0qq9O34KHitAqy4qs9jVkh1trEcYvRXU0PFN232UwoX3OPbK0BNZ0jA9N2fgIyRQw6t4nkS28VvNPa7SVI/6gdNxoIMB63loTerHhbU+puG5Bx6a7RPXfZyPD6dCLtp204oSiFVZFErtfnmt2vxafnXmh334vJHP7360VLba126Ds8rXY4v3wwuxoPxd7OLt5Or30++fTscj8d/Yxl7qtR+vjDRzokOvfR/b0FqJTU+dKg9XI7HD29aKK/OoddOjy7jK66kgEKiEkB7+t8QQHTOuH9zuj3j33PhU8hd8FfPlI42AQpTa/H/DvecR88HePXw3S7Eb09DvNEJMqKiM/OI+n8R4T6e/vYhbU+uHla1TELxOzsItr+egvSY106GTaS5TwNu5SB9n9zPiTxWGEpDFNnW0WGiuxM26rrLaNvrMw0je27VsebaKTZhZQjWT0Yjz7VYmKehsaipUyu+8MPcVCNu5Wh1wZrsWINb+wJprAcvU/CBL6VePq8130N0R2lMmToAapcvbuWfccOyLg99qfa6UCIX6GLOqDo+7Kn5+y7HuzQe89mOzn4dQz2Z1+c4Z59yMnZAK9u7Rp8ftUtn+UL7Lc3FSFGlLkwEp62+W4v6jvyk2l1dnDj4CVVuKuwmcyf+z7//I2p0gcUNv4Hb2oE1a3RFrSIEhcInSTyJhKOLuzuiR14p9F5tgOjR0kUY5FIGooYtScq55QupJB1GEjOk7aB3nv0QPpUYSnT06XeOCJ/AFSo6w6CMeYxczgCvg6niHh03XRv3WJBLGXBY1F5q9B48YqeCuuQ6R+hqLVIirhORtk56BC4rEiZaiUUhc0mGqfM4ngeouObLyG0yIL8JhbbJe3BmQazcG1Un3kkXZ8SQQoy30iG8I54fA6fFdINGkSinzxLlbxsRhaEFLNAHsLS9zDGx8sAd3RFX6OLZipkk4gDWUIeUXBG56+eWDAXHtac2nhzqUrODr+XEcQ/BN0P4rD/rOyqW2iMVgJL60U8+6wHc78rsEy68DDh/1Z339Xp9cs5fH+r8IENZL4iImb3eMi7GrtBX3/1D196jhnBY2Q4LdBRNxGiJGmMFcitTD4f76+lNHCZQorL7nUnltDXR6ogER3cYiCP6Uaf/mg4e1QTP4zSK17PUmf5wbCdOBnSVvy3u0K1kjm1v/AJUoyg8YhlTMkft+63q+ofpT7CCN8Mxy3pd9ivAG/108/37v9y9J29ocCTELobj4ZiWrPGh4rq31dGb0HEb2e6H8X/7Cant+nRxGVnFZZy1MfhtOyfvWa95T/qvR/OMlcYHEtluidN/dKppaPmXGh1N43nGVtxJ8jQO0/YaKHat9othv/rQvcfAyx6izgbUzTZNgy1eiNKoeMTN0YtYM2+ybsCRx0ni++TXYEZ29hZOeBLN56Rxnedow7OyfWIy/ThjGVu0r1tVfChjjq/pZY2vk7Ppsh5Hd1zbMsX1suZLkk0maSTzmrLWn+ePcZ63Pyios3AcDvoUBf2lmM4qbLeJKzTNTj59+qJGi2snTbmZN03zL1yFea4=","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"}}');var n=i(74848),s=i(28453),o=i(33617),p=i.n(o),l=i(17543),d=i.n(l),r=i(86013),c=i.n(r),m=i(63723),u=i.n(m),h=(i(18766),i(79329),i(9303));const y={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:"eJzFWNtuI7kR/ZVavmQGaF3s8c4ieoqzM9k1soiFsQaDxCMYVLNazTWb5JJsyYLQb/mSfFq+JCiyW2pdxjtONsmLIbOrilWnilWH3LLAl55N7tkMK6t4QM/mGRPocydtkEazCZuVCB+t4AGhk4Lr6Q2g5guFHjamhmCgMkIWG+BaQJ2kQ4kgMHCpPJgCOHiLuSxkDqG1M2QZMxYdp61uBJuwpNrtwzJmueMVBnTk5pZpXiGbsM7AgxQsY5LctDyU7Nj3m3e0MznSaUAoeQCNKDx5vcDWW7Lj8JdaOhRsElyNGfNho2g3LyuryBl8ssoIZJOCK08CeYkVZ5MtCxsbJYOTeskyVhhX8bBfaZp5so8+/NGIDekcujp1ZiUFwgKVWcMubHKyw7PLEbziARRyH8Bo7Ml2AbxmGcuNDqgDbcStVTKPII9+9rTb9tR1s/gZ80CIO0pJkOjpawL81wMkcHiEacJ8/LHzlzUZ0ya82MyUQkRwuJK4joXl5VJDKKUHYfK6ovCao5S/bItdVfRtNKSjBDqqyFN7e22STKfgdjbtiS6MUcj1STVSVcEgBWDiIqylUu1JgtvZFFbo6ITEXA3ho0fnk4zDHOUKgR+IQG4EwkpywIpLlcG6lHlJBb+BqvYBULc11EKHO+SGEIsYBnDqkJD+rEcZcKXMWuol1NG1c4ZBSId5UBtYy1CaOgAXQpI6V+ADWj/soxi92AE5M7X7z5HksKylQAHB1A4K46KX6HwGNh4zikBqH1ydk7IHUVN2YxwkSr+tMzl6v8epQ4WEevYzQO2TOoeC+4Aug1pLQt7VNqDYmcQni06izvEsBBHch9hIW8D912MxRVfJ4LtIKTVcCECFlBQPvs5L4Ok7D7VDn4HUMkiufAY+8Mr6DIyDgE/UVyAYS80Tn6QP5PxaiiUGD/JLdfQB6YzkPR8KZ6qYfcJGb/qFsPMrmCNzM0qq9O34KHitAqy4qs9jVkh1trEcYvRXU0PFN232UwoX3OPbK0BNZ0jA9N2fgIyRQw6t4nkS28VvNPa7SVI/6gdNxoIMB63loTerHhbU+puG5Bx6a7RPXfZyPD6dCLtp204oSiFVZFErtfnmt2vxafnXmh334vJHP7360VLba126Ds8rXY4v3wwuxoPxd7OLt5Or30++fTscj8d/Yxl7qtR+vjDRzokOvfR/b0FqJTU+dKg9XI7HD29aKK/OoddOjy7jK66kgEKiEkB7+t8QQHTOuH9zuj3j33PhU8hd8FfPlI42AQpTa/H/DvecR88HePXw3S7Eb09DvNEJMqKiM/OI+n8R4T6e/vYhbU+uHla1TELxOzsItr+egvSY106GTaS5TwNu5SB9n9zPiTxWGEpDFNnW0WGiuxM26rrLaNvrMw0je27VsebaKTZhZQjWT0Yjz7VYmKehsaipUyu+8MPcVCNu5Wh1wZrsWINb+wJprAcvU/CBL6VePq8130N0R2lMmToAapcvbuWfccOyLg99qfa6UCIX6GLOqDo+7Kn5+y7HuzQe89mOzn4dQz2Z1+c4Z59yMnZAK9u7Rp8ftUtn+UL7Lc3FSFGlLkwEp62+W4v6jvyk2l1dnDj4CVVuKuwmcyf+z7//I2p0gcUNv4Hb2oE1a3RFrSIEhcInSTyJhKOLuzuiR14p9F5tgOjR0kUY5FIGooYtScq55QupJB1GEjOk7aB3nv0QPpUYSnT06XeOCJ/AFSo6w6CMeYxczgCvg6niHh03XRv3WJBLGXBY1F5q9B48YqeCuuQ6R+hqLVIirhORtk56BC4rEiZaiUUhc0mGqfM4ngeouObLyG0yIL8JhbbJe3BmQazcG1Un3kkXZ8SQQoy30iG8I54fA6fFdINGkSinzxLlbxsRhaEFLNAHsLS9zDGx8sAd3RFX6OLZipkk4gDWUIeUXBG56+eWDAXHtac2nhzqUrODr+XEcQ/BN0P4rD/rOyqW2iMVgJL60U8+6wHc78rsEy68DDh/1Z339Xp9cs5fH+r8IENZL4iImb3eMi7GrtBX3/1D196jhnBY2Q4LdBRNxGiJGmMFcitTD4f76+lNHCZQorL7nUnltDXR6ogER3cYiCP6Uaf/mg4e1QTP4zSK17PUmf5wbCdOBnSVvy3u0K1kjm1v/AJUoyg8YhlTMkft+63q+ofpT7CCN8Mxy3pd9ivAG/108/37v9y9J29ocCTELobj4ZiWrPGh4rq31dGb0HEb2e6H8X/7Cant+nRxGVnFZZy1MfhtOyfvWa95T/qvR/OMlcYHEtluidN/dKppaPmXGh1N43nGVtxJ8jQO0/YaKHat9othv/rQvcfAyx6izgbUzTZNgy1eiNKoeMTN0YtYM2+ybsCRx0ni++TXYEZ29hZOeBLN56Rxnedow7OyfWIy/ThjGVu0r1tVfChjjq/pZY2vk7Ppsh5Hd1zbMsX1suZLkk0maSTzmrLWn+ePcZ63Pyios3AcDvoUBf2lmM4qbLeJKzTNTj59+qJGi2snTbmZN03zL1yFea4=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,b={},g=[];function T(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""}},title:"template_template_id_body"}}}}}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Template not found!"}},title:"inline_response_404_7"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.24d5c460.js b/assets/js/5c04ee3b.24d5c460.js new file mode 100644 index 000000000..0ac0e0df7 --- /dev/null +++ b/assets/js/5c04ee3b.24d5c460.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6382],{45016:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>m,contentTitle:()=>w,default:()=>W,frontMatter:()=>u,metadata:()=>i,toc:()=>x});const i=JSON.parse('{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/get-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-webhook","permalink":"/docs/API-docs/get-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar_label":"Get Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9VttuGzcQ/ZUJX9oYa62SpiigpwSF4Ro1miBO4AdZMLjc0S4jLslwuLpAWKAP/YP+QT8tX1IMVytLchM0bdEXW+LMGc7lcI62IsqKxGQqbrGonVuIWSZKJBW0j9pZMRHvaoRLjLBzgFdvrkAa41awcS1EBxVGWO2MbTAiE85jkAy/KsVEVBiH4JkISN5ZQhKTrXg+HvO/4/tuWqWQaN4a2McRmVDORrSR/aX3RqtkyD8Qg7aCVI2N5E9x41FMhCs+oIoiEz5wmKj7K3eJHjhSDNpWIhO4lo03fFTH6GmS5xvXhvMd4rwN5uXOZaRcI7ouE1HHBNDWaIv3Q3H3z8fj+x9E17HPi/GLx0W+JwxgXYS5a2355L+rD0Nw4cvVnd79pUI4+aGM7x+XcWWX0ugyceKdW6D9fys5vD7213Oq68YwzsqmLyk5Jbs4KvXwvC+SULVBx42YTLdifS69Pu/tk+msm2WiwVi7Hac5YRlrMRH5ak9vwrDEQAnPb+GBSyRtWbj1yHm0pCtrZEHMo1x6nS+fiS47RUjvv8Ib2/OvA1CUlbbVl1Gzh57c8Nz60Rx1Zj8g6fXPuBHZ0PhDr0xo5kuNssSQhqTt3CXwbhyvPdobXdk0zOUzcbqGbtEo1yAvnFgjDO6ffvsjIUqn2gZtTFx7cmfv7Os2gHcrDLxJpC1hbnCtC4PJH5tko2GJEcrGIJHZgLYRqyAjQqkrHaUBbo22FSjpZaGNZoqym2N0gAOW0whua4w1BjZ9ExAklLhEw8wG2UbXyMihhnxh5cJibtyKMpBQtKQtEgHaWlrFjkP7M3ABpAW0EYMPmhAoBs5a97k5G4NUERppZYUcOzvqUolGMzchuKKlCORMm1KGKLVxAUsYCrKIJY24iRdrzybgU+UaH7BmpiwRqlaXSBkoVyJQepFcgi2hQIrgORetkDhoa41TizS3eWsMeMcLQksDbn6UI8NjkJbmLjR9LsMM9g3zwbE+YJ/g2dl7Qp7wtbYLmpyd3dlzmO7JdIsF6YizbwfWr1arR2x/eoy51PGntoC36B3p6MLmAV3pWLdFeiGHQfZf+kiXaDHx5+AFPMQonaLHD45P8xqNz28wMkMof/XmKu3Up/Dp19/hGmWwULtVz1bVBjQbqIaruHP95Pu27VcizF0iXs0dVz35An5skSJ3UGSnr/n42QWcY+DmUy/1w3Ve78JPhzSBs/83ZfJyZhZLlbQDG6lNv1ZensZJexxDQ6/nNxiWWg2q/ZkJ58k5F5kwWqElPNCHV5dvrmEJ343GIjtYkX9j2vn11Y8Xv9xccDb8svqOPRuNR2M+8o5iI+3BVQc/o0732/ZBNv/JL67dCo64jrk3UielS8Vsdyo13f/0mWWidhT5aLstJOH7YLqOjz+2GFj7ZplYyqBlwZt5OuuyYXGzrC1ww11TCj1r4FKatt/+J1J/pJeXF+9EJpiGx4KxSIKx+8DRB5PdHMQ+VpI+Af7LovaXgO22F6Ou2/v3ps8idgUO3tzAWdd1fwLRqO21","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/save-update-webhook"}}');var s=t(74848),a=t(28453),n=t(33617),r=t.n(n),p=t(17543),c=t.n(p),d=t(86013),l=t.n(d),h=t(63723),b=t.n(h),k=(t(18766),t(79329),t(9303));const u={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VttuGzcQ/ZUJX9oYa62SpiigpwSF4Ro1miBO4AdZMLjc0S4jLslwuLpAWKAP/YP+QT8tX1IMVytLchM0bdEXW+LMGc7lcI62IsqKxGQqbrGonVuIWSZKJBW0j9pZMRHvaoRLjLBzgFdvrkAa41awcS1EBxVGWO2MbTAiE85jkAy/KsVEVBiH4JkISN5ZQhKTrXg+HvO/4/tuWqWQaN4a2McRmVDORrSR/aX3RqtkyD8Qg7aCVI2N5E9x41FMhCs+oIoiEz5wmKj7K3eJHjhSDNpWIhO4lo03fFTH6GmS5xvXhvMd4rwN5uXOZaRcI7ouE1HHBNDWaIv3Q3H3z8fj+x9E17HPi/GLx0W+JwxgXYS5a2355L+rD0Nw4cvVnd79pUI4+aGM7x+XcWWX0ugyceKdW6D9fys5vD7213Oq68YwzsqmLyk5Jbs4KvXwvC+SULVBx42YTLdifS69Pu/tk+msm2WiwVi7Hac5YRlrMRH5ak9vwrDEQAnPb+GBSyRtWbj1yHm0pCtrZEHMo1x6nS+fiS47RUjvv8Ib2/OvA1CUlbbVl1Gzh57c8Nz60Rx1Zj8g6fXPuBHZ0PhDr0xo5kuNssSQhqTt3CXwbhyvPdobXdk0zOUzcbqGbtEo1yAvnFgjDO6ffvsjIUqn2gZtTFx7cmfv7Os2gHcrDLxJpC1hbnCtC4PJH5tko2GJEcrGIJHZgLYRqyAjQqkrHaUBbo22FSjpZaGNZoqym2N0gAOW0whua4w1BjZ9ExAklLhEw8wG2UbXyMihhnxh5cJibtyKMpBQtKQtEgHaWlrFjkP7M3ABpAW0EYMPmhAoBs5a97k5G4NUERppZYUcOzvqUolGMzchuKKlCORMm1KGKLVxAUsYCrKIJY24iRdrzybgU+UaH7BmpiwRqlaXSBkoVyJQepFcgi2hQIrgORetkDhoa41TizS3eWsMeMcLQksDbn6UI8NjkJbmLjR9LsMM9g3zwbE+YJ/g2dl7Qp7wtbYLmpyd3dlzmO7JdIsF6YizbwfWr1arR2x/eoy51PGntoC36B3p6MLmAV3pWLdFeiGHQfZf+kiXaDHx5+AFPMQonaLHD45P8xqNz28wMkMof/XmKu3Up/Dp19/hGmWwULtVz1bVBjQbqIaruHP95Pu27VcizF0iXs0dVz35An5skSJ3UGSnr/n42QWcY+DmUy/1w3Ve78JPhzSBs/83ZfJyZhZLlbQDG6lNv1ZensZJexxDQ6/nNxiWWg2q/ZkJ58k5F5kwWqElPNCHV5dvrmEJ343GIjtYkX9j2vn11Y8Xv9xccDb8svqOPRuNR2M+8o5iI+3BVQc/o0732/ZBNv/JL67dCo64jrk3UielS8Vsdyo13f/0mWWidhT5aLstJOH7YLqOjz+2GFj7ZplYyqBlwZt5OuuyYXGzrC1ww11TCj1r4FKatt/+J1J/pJeXF+9EJpiGx4KxSIKx+8DRB5PdHMQ+VpI+Af7LovaXgO22F6Ou2/v3ps8idgUO3tzAWdd1fwLRqO21",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},w=void 0,m={},x=[];function v(e){const o={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,s.jsx)(r(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,s.jsx)(c(),{parameters:void 0}),"\n",(0,s.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{webhook:{type:"string",example:"https://your-webhook-url@example.com"}},title:"inline_response_200_7"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function W(e={}){const{wrapper:o}={...(0,a.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.f55f760f.js b/assets/js/5c04ee3b.f55f760f.js deleted file mode 100644 index f50567f6f..000000000 --- a/assets/js/5c04ee3b.f55f760f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6382],{45016:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>g,contentTitle:()=>k,default:()=>f,frontMatter:()=>b,metadata:()=>s,toc:()=>S});const s=JSON.parse('{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/get-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-webhook","permalink":"/docs/API-docs/get-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar_label":"Get Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9VsFu4zYQ/ZVZXrYBZMvZbrGATxu0QRB00QRwFjk4RkBJI4lrimRJSrZh6LZf0k/rlxRDSbbsdINuUfSS2OS8mXkzwzfeM88Lx+ZL9ohJqfWarSKWoUutMF5oxebsoUS4QQ+9AVzd3wKXUm9gp2vwGgr0sOkvaytZxLRBywl+m7E5K9APziNm0RmtHDo237N3sxn9O423qNMUnctrCQc/LGKpVh6VJ3tujBRpuIi/OALtmUtLrDh98juDbM508gVTzyJmLLnxogvZJzoydN4KVbCI4ZZXRtJR6b1x8zje6dpOesSktvJjbzJNdcXaNmJe+AAQSgqFzwO553ez2fMH1rZk8372/iXJzw4tKO0h17XK3vx3/NBabV9ndx77NSKU/EDjp5c0blXDpcjCTDzoNar/l8k4vO/CU6rbShJO8aqjFIzCPTuhOj7vSDpMayv8js2Xe7adcCMm3f18uWpXEavQl7qfaUqY+5LNWbw5jLdD26B1AU9v4ThLjqss0dupNqicKJTkiaM5irkRcXPJ2ugcwY35DmusJ98HcJ4XQhWvo1bHmiyob11rTipzaBA34lfcsWgo/NgqYoLmpUSeoQ1NEirXAdy3486gWohChWY2l+xchh5RprpCEhxfIgzmf379IyAyndYVKh9m7Q3c1RaM3qAlGeEqg1ziViQSj/LlBv1yyCuJzskdCOWxsNwjZKIQnkugqghVQMoNT4QUNJ1kpgltYTTgbgqPJfoSLV29tQgcMmxQ0lCD1HpNfrwGXntdhRh9zrDRdp1TShFwSGonFDoHDnGAoCq5ShGGXkSgLXAFqDxaY4VD4KIi41xbwDwXqSDH9BQtTz1UXPECKVgElDdVwVjdiAwdWJ3UzoPTsg5EKGKF6DuKCjFzU/hFNNgRp8MMPRcSMyhqchFBqjOE/mUSDZVBgs6DofAixeDUeW49SGzQhtkLncxrKcFokgzBJej8pLfkyFuuXK5t1SU0tOZQPmM1bYwQI+O7KTypJ7WgYakd0gBIodZu/qQmsDyM2SMmTnhc/TC8h81m8+IdXJxiboQv6wQsGn3EFeEwvJox/PDlgkXnD+Z0si3maImN67apwjCB3IhO1GB5dX8b1BVKlOYYmSAvny6dxmQYL9B7oQoXD/gL0j+aCZ4GecaKC9m93I/nfoJUoq3cXb5A24h0WIzfKFUcjGMWMSlSVA5HEnx1c/8JGvhxOmPRSIX+QfHiT7c/X/+2uKZsSFi7il1OZ9MZHRntfMXVKNTol8q5hOyPm+nf/KjpVc7j1sdGchGWSSCz7xfB8vDrYhWxUjtPR/t9wh1+trJt6fj3Gi2tl1XEGm4FT0j8lqs2GrSRNscad1S1NEVDa6bhsu4E9mybnqykm+sHFjFeUyZjTV4HTe4/kPfhSu1Gvk/FukuA/tLe+FvAft/pfdse7LurbyJ6goM1FXDVtu1fMk6w7A==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/save-update-webhook"}}');var i=t(74848),n=t(28453),a=t(33617),r=t.n(a),h=t(17543),c=t.n(h),d=t(86013),l=t.n(d),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const b={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VsFu4zYQ/ZVZXrYBZMvZbrGATxu0QRB00QRwFjk4RkBJI4lrimRJSrZh6LZf0k/rlxRDSbbsdINuUfSS2OS8mXkzwzfeM88Lx+ZL9ohJqfWarSKWoUutMF5oxebsoUS4QQ+9AVzd3wKXUm9gp2vwGgr0sOkvaytZxLRBywl+m7E5K9APziNm0RmtHDo237N3sxn9O423qNMUnctrCQc/LGKpVh6VJ3tujBRpuIi/OALtmUtLrDh98juDbM508gVTzyJmLLnxogvZJzoydN4KVbCI4ZZXRtJR6b1x8zje6dpOesSktvJjbzJNdcXaNmJe+AAQSgqFzwO553ez2fMH1rZk8372/iXJzw4tKO0h17XK3vx3/NBabV9ndx77NSKU/EDjp5c0blXDpcjCTDzoNar/l8k4vO/CU6rbShJO8aqjFIzCPTuhOj7vSDpMayv8js2Xe7adcCMm3f18uWpXEavQl7qfaUqY+5LNWbw5jLdD26B1AU9v4ThLjqss0dupNqicKJTkiaM5irkRcXPJ2ugcwY35DmusJ98HcJ4XQhWvo1bHmiyob11rTipzaBA34lfcsWgo/NgqYoLmpUSeoQ1NEirXAdy3486gWohChWY2l+xchh5RprpCEhxfIgzmf379IyAyndYVKh9m7Q3c1RaM3qAlGeEqg1ziViQSj/LlBv1yyCuJzskdCOWxsNwjZKIQnkugqghVQMoNT4QUNJ1kpgltYTTgbgqPJfoSLV29tQgcMmxQ0lCD1HpNfrwGXntdhRh9zrDRdp1TShFwSGonFDoHDnGAoCq5ShGGXkSgLXAFqDxaY4VD4KIi41xbwDwXqSDH9BQtTz1UXPECKVgElDdVwVjdiAwdWJ3UzoPTsg5EKGKF6DuKCjFzU/hFNNgRp8MMPRcSMyhqchFBqjOE/mUSDZVBgs6DofAixeDUeW49SGzQhtkLncxrKcFokgzBJej8pLfkyFuuXK5t1SU0tOZQPmM1bYwQI+O7KTypJ7WgYakd0gBIodZu/qQmsDyM2SMmTnhc/TC8h81m8+IdXJxiboQv6wQsGn3EFeEwvJox/PDlgkXnD+Z0si3maImN67apwjCB3IhO1GB5dX8b1BVKlOYYmSAvny6dxmQYL9B7oQoXD/gL0j+aCZ4GecaKC9m93I/nfoJUoq3cXb5A24h0WIzfKFUcjGMWMSlSVA5HEnx1c/8JGvhxOmPRSIX+QfHiT7c/X/+2uKZsSFi7il1OZ9MZHRntfMXVKNTol8q5hOyPm+nf/KjpVc7j1sdGchGWSSCz7xfB8vDrYhWxUjtPR/t9wh1+trJt6fj3Gi2tl1XEGm4FT0j8lqs2GrSRNscad1S1NEVDa6bhsu4E9mybnqykm+sHFjFeUyZjTV4HTe4/kPfhSu1Gvk/FukuA/tLe+FvAft/pfdse7LurbyJ6goM1FXDVtu1fMk6w7A==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},k=void 0,g={},S=[];function j(e){const o={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,i.jsx)(c(),{parameters:void 0}),"\n",(0,i.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{webhook:{type:"string",example:"https://your-webhook-url@example.com"}},title:"inline_response_200_7"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9853b.336a8868.js b/assets/js/5ce9853b.336a8868.js deleted file mode 100644 index 05c76b544..000000000 --- a/assets/js/5ce9853b.336a8868.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1019],{77408:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>b,default:()=>x,frontMatter:()=>q,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/resendrequestmail.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/resendrequestmail","permalink":"/docs/API-docs/resendrequestmail","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar_label":"Resend request mail","hide_title":true,"hide_table_of_contents":true,"api":"eJztV81uGzcQfpUJL22AtSSn7kWnuE4QGA1qI3KRgyMI1O5oxZhLMvyRLCz21ifpo/VJiiF3VyvLcZIWbS+9CCtyfj8OvxnWzPPSsekte6XzUKHyjs0zVqDLrTBeaMWm7B06VAVY/BTQeai4kOA1BIcWVtqCE6USqoSiNTH6oFjGtEHLycJl0dtoTZAFlrH230+62LFpzXKtPCpPn9wYKfKoPf7oKIiauXyNFacv0hMWCwq787kQBcsYRsvzjPmdQTZlevkRc88yZiyF4wU6MjBUmtadsPNWqJKs3PPKSFoyVm9EgX1mIArWdG4e0TzErdOOQEXUVlZXES60jiC0eHIEbUJvHwNpv2z/jnJd9QEsXEjpfTGQi+B865j7YLH3F+1AaweEAo/3frz2laSDrbgfwQVXIFQuQ4Gw0lLqLR31hlvBlxIdQF33cHrhJTYN1DVlhXaheIVNk+0XyN/Bgllr1YpYzFFsDrT6Jdwr9msDVbw3wu4WBfftQq4rw9VuGEAq0kWwrR2lSXh0gPUe22VblH8LWDLyP6qMNU3GYhZsymwkgj3GDW3ub7S3AeOCM1q5dF1fTCbx1h5Az7KvJ4yn2cCiC/LRW5RO63FqSDeHOMGFPEfnVkHK3eggV6GkULjoklm8mEwWpxNKucnY2T+bFVqr7bcmNdMV+jWV4pYy21qtyqdTOptMFi/6jM6OMzrZk6fSHlY6qALEakipIFzcy7W1mFP7OEmceaDQsmmRttIFaxVNLKpIYIlcQQrnQe+9RE79L5F9BARtH2T5JaTPFqc90j8eI32pNlyKAs6vL+FG36F69i/kvM9w6N4n9xTqfRU7JVFGTCoKxX12kOxwPSXpMA9W+B2b3tbs/oQbcZL2p7fzZp4xKlVNs4XRLkbM/ZpN2XjPMIyM2A1aF20EK9mUrb03bjoeO66Kpb4faYOKqkbypaP+OuZGjDenrMkeanBjvkEaw8m3KTjPS6HKp7Xme1xmdHbpeA7Q6Q+JG/Ez7ljWgT+UypigmlkjL9DGg6KSeLefyF53B/tgXHp0JupHouNp5WhYYeywx8amK9RKx8jbergyqGaiVLGaNqdHjfc9ylxXSDOUXyN04n/89nvU6GKLxf4MroIFo7doV0ECVwWsJN6LpcQozKn9OtjpQOYc8kqic5I6t8fSco9QiFJ4LvtJN+eGL4UUdD1ITJO2hcENcyN4v0a/Rktb31kEDgVuUNKtAqn1HdnxGnjwuoo+Ojy32t6tKKQMOCyDEwqdA4fYqaBac5UjdIWQEZVwBag8WmOFQ+CiImGaznG1Erkgw8QFluc0ZipeIjnLgOImFNpjdWD1MjgPTssQEyGPFaJPKSrEwo3gldhgSpwWC/RcSCygDGQig1wXCG0VUBqqgCWNRYbcixyjUee59SBxgzYWfjxJ6qJgNHGW4JIofHi2ZMhbrhxRbQqoO5oePmM1tePoo+C7EXxQHxQ1NmJbKgAp1J2bUpO57cvsPS6d8Dj/vruM2+326BI+P9R5I/w6LMGi0Xu9Mi7GKztU7/88Z9nD23pY2RZXaCmbiFGJCmMFciMSq8Lt+fVlpHdYozR7z6RyzBu0OibB8Qy9F6p0407/OV08qgme3hDdFeZGvHxoJ3I12spdrWZoNyLHlrg+A9U4Co9ZxqTIUTkc9IDzN9dvYQM/jCYsG1DgV4A3fnt58fqX2WuKhlg9IXY6mowmtER9oOJq4OqRl+tDKhm8O//iQ7dl2zjkG8lFbGwxr7rtSbeDqZdep2tqWNNbVtdL7vBXmp1p+VNAS91unrHuJRB7XdbRNDWxOyTOvEgxn9yQbxKXITH+gxZPXSZpnOc5Gv+k7LCnXl/NbljGumdQpYs4vPMtvdv5NtG4jhimIZrWaia5KgMvSTbZpM7CA4EwbEt3sS21H5RVt6V2gwgP+1VKg34pqUcV6jq1vKbp5dPWZzVaYDtpOrt50zR/AtM/GJs=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"}}');var s=n(74848),o=n(28453),r=n(33617),a=n.n(r),p=n(17543),d=n.n(p),l=n(86013),c=n.n(l),m=n(63723),u=n.n(m),g=(n(18766),n(79329),n(9303));const q={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJztV81uGzcQfpUJL22AtSSn7kWnuE4QGA1qI3KRgyMI1O5oxZhLMvyRLCz21ifpo/VJiiF3VyvLcZIWbS+9CCtyfj8OvxnWzPPSsekte6XzUKHyjs0zVqDLrTBeaMWm7B06VAVY/BTQeai4kOA1BIcWVtqCE6USqoSiNTH6oFjGtEHLycJl0dtoTZAFlrH230+62LFpzXKtPCpPn9wYKfKoPf7oKIiauXyNFacv0hMWCwq787kQBcsYRsvzjPmdQTZlevkRc88yZiyF4wU6MjBUmtadsPNWqJKs3PPKSFoyVm9EgX1mIArWdG4e0TzErdOOQEXUVlZXES60jiC0eHIEbUJvHwNpv2z/jnJd9QEsXEjpfTGQi+B865j7YLH3F+1AaweEAo/3frz2laSDrbgfwQVXIFQuQ4Gw0lLqLR31hlvBlxIdQF33cHrhJTYN1DVlhXaheIVNk+0XyN/Bgllr1YpYzFFsDrT6Jdwr9msDVbw3wu4WBfftQq4rw9VuGEAq0kWwrR2lSXh0gPUe22VblH8LWDLyP6qMNU3GYhZsymwkgj3GDW3ub7S3AeOCM1q5dF1fTCbx1h5Az7KvJ4yn2cCiC/LRW5RO63FqSDeHOMGFPEfnVkHK3eggV6GkULjoklm8mEwWpxNKucnY2T+bFVqr7bcmNdMV+jWV4pYy21qtyqdTOptMFi/6jM6OMzrZk6fSHlY6qALEakipIFzcy7W1mFP7OEmceaDQsmmRttIFaxVNLKpIYIlcQQrnQe+9RE79L5F9BARtH2T5JaTPFqc90j8eI32pNlyKAs6vL+FG36F69i/kvM9w6N4n9xTqfRU7JVFGTCoKxX12kOxwPSXpMA9W+B2b3tbs/oQbcZL2p7fzZp4xKlVNs4XRLkbM/ZpN2XjPMIyM2A1aF20EK9mUrb03bjoeO66Kpb4faYOKqkbypaP+OuZGjDenrMkeanBjvkEaw8m3KTjPS6HKp7Xme1xmdHbpeA7Q6Q+JG/Ez7ljWgT+UypigmlkjL9DGg6KSeLefyF53B/tgXHp0JupHouNp5WhYYeywx8amK9RKx8jbergyqGaiVLGaNqdHjfc9ylxXSDOUXyN04n/89nvU6GKLxf4MroIFo7doV0ECVwWsJN6LpcQozKn9OtjpQOYc8kqic5I6t8fSco9QiFJ4LvtJN+eGL4UUdD1ITJO2hcENcyN4v0a/Rktb31kEDgVuUNKtAqn1HdnxGnjwuoo+Ojy32t6tKKQMOCyDEwqdA4fYqaBac5UjdIWQEZVwBag8WmOFQ+CiImGaznG1Erkgw8QFluc0ZipeIjnLgOImFNpjdWD1MjgPTssQEyGPFaJPKSrEwo3gldhgSpwWC/RcSCygDGQig1wXCG0VUBqqgCWNRYbcixyjUee59SBxgzYWfjxJ6qJgNHGW4JIofHi2ZMhbrhxRbQqoO5oePmM1tePoo+C7EXxQHxQ1NmJbKgAp1J2bUpO57cvsPS6d8Dj/vruM2+326BI+P9R5I/w6LMGi0Xu9Mi7GKztU7/88Z9nD23pY2RZXaCmbiFGJCmMFciMSq8Lt+fVlpHdYozR7z6RyzBu0OibB8Qy9F6p0407/OV08qgme3hDdFeZGvHxoJ3I12spdrWZoNyLHlrg+A9U4Co9ZxqTIUTkc9IDzN9dvYQM/jCYsG1DgV4A3fnt58fqX2WuKhlg9IXY6mowmtER9oOJq4OqRl+tDKhm8O//iQ7dl2zjkG8lFbGwxr7rtSbeDqZdep2tqWNNbVtdL7vBXmp1p+VNAS91unrHuJRB7XdbRNDWxOyTOvEgxn9yQbxKXITH+gxZPXSZpnOc5Gv+k7LCnXl/NbljGumdQpYs4vPMtvdv5NtG4jhimIZrWaia5KgMvSTbZpM7CA4EwbEt3sS21H5RVt6V2gwgP+1VKg34pqUcV6jq1vKbp5dPWZzVaYDtpOrt50zR/AtM/GJs=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,j={},y=[];function f(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,s.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["document_id","email"],type:"object",properties:{document_id:{type:"string",example:"provide document id"},email:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"},email_subject:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""}},title:"resendmail_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",format:"string",example:"mail sent successfully."}},title:"inline_response_200_10"}}}},400:{description:"",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Something went wrong."}},title:"inline_response_400_2"}}}},404:{description:"- document not found if document id is not correct.\n- user not found if provided user email is not present in signer list of document\n",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"document not found or user not found."}},title:"inline_response_404_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9853b.e5a454ea.js b/assets/js/5ce9853b.e5a454ea.js new file mode 100644 index 000000000..d283de703 --- /dev/null +++ b/assets/js/5ce9853b.e5a454ea.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1019],{77408:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>f,contentTitle:()=>y,default:()=>q,frontMatter:()=>j,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/resendrequestmail.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/resendrequestmail","permalink":"/docs/API-docs/resendrequestmail","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar_label":"Resend request mail","hide_title":true,"hide_table_of_contents":true,"api":"eJztWEtuHDcQvQrNTWKhNTNylM2srCiCI0SIBcuGF/JgwOmu6abFJhl+5oNGA1nkBrlBjuaTBEX2VyPLdowkm2yEHpJVrHr1eUVV1LHc0vkt/VGlvgTpLF0kNAObGq4dV5LO6SuwIDNi4FcP1pGScUGcIt6CIWtliOW55DInWaNi8k7ShCoNhqGGy6zT0ahADTShza8fVLan84qmSjqQDj+Z1oKnQXr63qIRFbVpASXDL5TjBjI0u71zyTOaUAiaFwl1ew10TtXqPaSOJlQbNMdxsKhgKDSv2sPWGS5z1LJjpRa4pI3a8Aw6zwjPaN1e84DkGLdWOgAVUFsbVQa4wFiE0MDxAbQRvd4GlH7e/JykquwMWFof3fukIefeuuZi5ryB7r6ghzR6CJfEwc5NC1cKDGzJ3IScM0m4TIXPgKyVEGqLod4ww9lKgCWkqjo4HXcC6ppUFXoFZilZCXWd9At432hBF0o2RwykwDcjqW4JesFubSAKO83Nfpkx1yykqtRM7ocGxCRdetPokQoPT0ZY99iumqT8KmBRyf+oUlrXCQ1e0Dk1oRH0GNe42Ve0Mx7CgtVK2liuz2azULUj6Gny+Q3j8W5gwHrxYBXFaD3cGmLlYE+wPk3B2rUXYj8Z+cql4BKWrTPLZ7PZ8mSGLtcJPf1nvQJjlPlSp25UCa7AVNyiZ1ujZP64S6ez2fJZ59HpoUfHffOUypG18jIjfD1sqYTbsJcqYyBF+jiOPXMk0HTTLG7FAmsEdUiq0MBicyWCW0dUf0voqf8lsg+AoMw9Lz+F9OnypEP6+0OkL+WGCZ6Rs+tL8lrdgXzyL/jcezi83sXr0dRdGZgSW0ZwKhwK+3Tk7HA9Omkh9Ya7PZ3fVnR3zDQ/jvvz20W9SCimqsLZQisbLGauoHM67TsMRSVmA8YGHd4IOqeFc9rOp1PLZLZSu4nSIDFrBFtZ5Ncp03y6OaF1cl+Caf0Fp8Eff5mAdSznMn9catHjcoOxi+EZodMFiWn+M+xp0oI/PJVQjjlTAMvAhEBhSrzqJ7KLNrD3xqUHZ6JuJDqcVg6GFUrHHBtIl8u1CpY3+fBSg7zhuQzZtDk5IN63IFJVAs5QrgDSHv/w+59BorUtJPuTd/KdfOkN0WoLZu0FYTIjawE7vhIQzkMZ9izZK486LbBSgLUC6dtBbpgDkvGcOya6cTdlmq244FgjeEyhtCGDMrMT8rYAV4DBrW8MEEYy2IDA0iLMO1UyN5ycyVaZu7VQW5sQRlbecgnWEpAFkykebGOfYPdgkoB0YLThFoh1Bq3m0TYlnWEpTpSS5YC6kxFKGQike0uMWnnriFXCB5OJY1woAxlpHZIAmZ0giBc7jVsEV3EWMFBgmm6A5J5nYBOSqgyIDdFHF2RGVjgOabSFpxCGXi+FSu9C3JAziVbYoTgT2LCHNqK4M0xabKzRljYGHWDaKCRfiAYeHb2xgBG+4vLOzo+OkEpuu2R6CyvLHSy+bUtuu90elNrTscwL7n7yK/IKtLLcKbPvpXPuCr8K5TlU0v2Iml6AhJA/g/LrdWQqtYfVjqvTAoSe3oDDDLHTs+vL0NSfkg+//UGugBlJCrWN2Zp6A2JP8vYqRC5GPsLW9eTwXmPeFYh4GpOvmVltfHjcayXjsjOwBoPgh0D212neqL9tzSRo/de4iV0Bs5jFB07bX5jmz+/rCUQCprQv1zdgNjyFpqt+JMLTcHhKEyp4CtLCgKDOXlxfkQ35bjKjyaA/f0a0p1eX5xe/3FygNVhZEbGTyWwywyUkqZLJwVUPPKvv97nBo/hvvsIbKggvEC0YD6wb/KoawrwdjOT4dC6QTee3tKpWzMIbHOxx+VcPBql4kdD2mRKIOGk5BBn2DrChn0ebj1/j3Xhc+EhH9+YPpMAocZamoN2jZ4eEf/3y5jVNaPtGK1UWXhZsi/9UYNvIMSpgGCd8XKuoYDL3LMezUSfSHhbDmDPvAmc2H+hVuyX3AwvHZBrdwL/o1IMCVRX5uK6783HroxINsO1pjN2iruu/AB4hVWQ=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"}}');var s=i(74848),o=i(28453),r=i(33617),a=i.n(r),l=i(17543),d=i.n(l),c=i(86013),p=i.n(c),u=i(63723),m=i.n(u),g=(i(18766),i(79329),i(9303));const j={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJztWEtuHDcQvQrNTWKhNTNylM2srCiCI0SIBcuGF/JgwOmu6abFJhl+5oNGA1nkBrlBjuaTBEX2VyPLdowkm2yEHpJVrHr1eUVV1LHc0vkt/VGlvgTpLF0kNAObGq4dV5LO6SuwIDNi4FcP1pGScUGcIt6CIWtliOW55DInWaNi8k7ShCoNhqGGy6zT0ahADTShza8fVLan84qmSjqQDj+Z1oKnQXr63qIRFbVpASXDL5TjBjI0u71zyTOaUAiaFwl1ew10TtXqPaSOJlQbNMdxsKhgKDSv2sPWGS5z1LJjpRa4pI3a8Aw6zwjPaN1e84DkGLdWOgAVUFsbVQa4wFiE0MDxAbQRvd4GlH7e/JykquwMWFof3fukIefeuuZi5ryB7r6ghzR6CJfEwc5NC1cKDGzJ3IScM0m4TIXPgKyVEGqLod4ww9lKgCWkqjo4HXcC6ppUFXoFZilZCXWd9At432hBF0o2RwykwDcjqW4JesFubSAKO83Nfpkx1yykqtRM7ocGxCRdetPokQoPT0ZY99iumqT8KmBRyf+oUlrXCQ1e0Dk1oRH0GNe42Ve0Mx7CgtVK2liuz2azULUj6Gny+Q3j8W5gwHrxYBXFaD3cGmLlYE+wPk3B2rUXYj8Z+cql4BKWrTPLZ7PZ8mSGLtcJPf1nvQJjlPlSp25UCa7AVNyiZ1ujZP64S6ez2fJZ59HpoUfHffOUypG18jIjfD1sqYTbsJcqYyBF+jiOPXMk0HTTLG7FAmsEdUiq0MBicyWCW0dUf0voqf8lsg+AoMw9Lz+F9OnypEP6+0OkL+WGCZ6Rs+tL8lrdgXzyL/jcezi83sXr0dRdGZgSW0ZwKhwK+3Tk7HA9Omkh9Ya7PZ3fVnR3zDQ/jvvz20W9SCimqsLZQisbLGauoHM67TsMRSVmA8YGHd4IOqeFc9rOp1PLZLZSu4nSIDFrBFtZ5Ncp03y6OaF1cl+Caf0Fp8Eff5mAdSznMn9catHjcoOxi+EZodMFiWn+M+xp0oI/PJVQjjlTAMvAhEBhSrzqJ7KLNrD3xqUHZ6JuJDqcVg6GFUrHHBtIl8u1CpY3+fBSg7zhuQzZtDk5IN63IFJVAs5QrgDSHv/w+59BorUtJPuTd/KdfOkN0WoLZu0FYTIjawE7vhIQzkMZ9izZK486LbBSgLUC6dtBbpgDkvGcOya6cTdlmq244FgjeEyhtCGDMrMT8rYAV4DBrW8MEEYy2IDA0iLMO1UyN5ycyVaZu7VQW5sQRlbecgnWEpAFkykebGOfYPdgkoB0YLThFoh1Bq3m0TYlnWEpTpSS5YC6kxFKGQike0uMWnnriFXCB5OJY1woAxlpHZIAmZ0giBc7jVsEV3EWMFBgmm6A5J5nYBOSqgyIDdFHF2RGVjgOabSFpxCGXi+FSu9C3JAziVbYoTgT2LCHNqK4M0xabKzRljYGHWDaKCRfiAYeHb2xgBG+4vLOzo+OkEpuu2R6CyvLHSy+bUtuu90elNrTscwL7n7yK/IKtLLcKbPvpXPuCr8K5TlU0v2Iml6AhJA/g/LrdWQqtYfVjqvTAoSe3oDDDLHTs+vL0NSfkg+//UGugBlJCrWN2Zp6A2JP8vYqRC5GPsLW9eTwXmPeFYh4GpOvmVltfHjcayXjsjOwBoPgh0D212neqL9tzSRo/de4iV0Bs5jFB07bX5jmz+/rCUQCprQv1zdgNjyFpqt+JMLTcHhKEyp4CtLCgKDOXlxfkQ35bjKjyaA/f0a0p1eX5xe/3FygNVhZEbGTyWwywyUkqZLJwVUPPKvv97nBo/hvvsIbKggvEC0YD6wb/KoawrwdjOT4dC6QTee3tKpWzMIbHOxx+VcPBql4kdD2mRKIOGk5BBn2DrChn0ebj1/j3Xhc+EhH9+YPpMAocZamoN2jZ4eEf/3y5jVNaPtGK1UWXhZsi/9UYNvIMSpgGCd8XKuoYDL3LMezUSfSHhbDmDPvAmc2H+hVuyX3AwvHZBrdwL/o1IMCVRX5uK6783HroxINsO1pjN2iruu/AB4hVWQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,f={},h=[];function L(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,s.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["document_id","email"],type:"object",properties:{document_id:{type:"string",example:"provide document id"},email:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"},email_subject:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""}},title:"resendmail_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",format:"string",example:"mail sent successfully."}},title:"inline_response_200_10"}}}},400:{description:"",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Something went wrong."}},title:"inline_response_400_2"}}}},404:{description:"- document not found if document id is not correct.\n- user not found if provided user email is not present in signer list of document\n",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"document not found or user not found."}},title:"inline_response_404_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function q(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(L,{...e})}):L(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.1727838e.js b/assets/js/70853c19.1727838e.js deleted file mode 100644 index debf327e7..000000000 --- a/assets/js/70853c19.1727838e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3451],{47561:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>M,default:()=>m,frontMatter:()=>I,metadata:()=>i,toc:()=>N});const i=JSON.parse('{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/save-update-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/save-update-webhook","permalink":"/docs/API-docs/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWW1vGzcS/isTBrhrgrVkpy5w0Keqji4V6hfBkhEcLMOhdke7rLnkluRKFgR96y+5n3a/5DDk7lqSHaVJCiMI9EUv5MxwXh4OyZklczy1rHPN3uMk0/qO3UQsQRsbUTihFeuwUYZg+QxBGyiLhDuEiha6gz5wKfXcwkKX4HQg5DCvCK4uT2GeiTgDYaG0mBCNMyJN0QDOUDnbGquxevnyJfT83w79ff36qAUzgXNMOq9fj9UBvM9QAQcrUoXGT1ngkOi4zFG5CFwmbBAIcyFlvUZrrD58+DBWy7ECGDNPMGYdGLMgfcyiMOMWBYaJtxcnV2e989Ht6D+DXjOvJ79j7PrJFk3/bUMxFXJbwtXlaTOteL49fd49e1hAaVfNDyRyi2CQVASuEm91sLA2uGFbC1XgbmaCqyyNXtMIwDJ8bWoz7L87712u6xIoMOdCbpD0zrr90w2aItNqU8zg14vz3pgFkhV93VTqBH//svioyJqkWwVo1D/rDUfds0EzHxvk7kmCsVpVgSbsvGlBRboJntp5hMWK4AuAU3HukfNcyPkrYd8VY3CZ0WWagcsQEsOnDhzmhaRE1h309xD4xiCwRlOaNSn983fBKV+IEUoNP7bCEbIjM4R5mCya4+YLEBKEfPcAocEKGJ+CxadB8YmssFpf+W84JY5bEOu8kLjznFhDg5QVHuyXpIx6qe8eE9/OuYHGiamIeW3mSe9y1P93/6Q76m04qonN14PqpxYkGEuxM8PUFF+ZY2oxe0Q9F6Jqj++8xdZEXwcmFjFdoOHklH7COoweVv8Iz6/6pRYxg3+UaN0vOlmwznLr3TYweiYShNJIenWFVeGBOdbKoXLEyItC0kYRWrV/t8S9ZDbOMOf0i1YRBhN6JV4ZSS9EghrrVIhiESsMaesEWmIojaSvisg6I1TKIjbVJudufQTvOW091mGZc4XttNsLXZqD6vV4UBr5c0XSinXOVquIOeE8Q0VzOyHbVyuaMmgLrWzQ4c3h4WOXDMs4RmunpYTGu5/jid1mG7SldE9Z/mBn/XIOkUzANhrJxYsNA4UiGN3WRt2+OTy8/Vdl6fGTxukcXSZUCnOfRIxWaQRF2InOLICnXCige6958fdZjcZos9voz9NslxOODw9vjxonHD12QuNfI4FLgzxZAN4L6+zzmrxLj90GHt3OGwOPHxt4ZdGA0g6mulTJ8xq1vfZuQ44bM356bEZfzbgUia8gjfQdque1ZH15F5YnVe9zn7joZPEmeSI/zzZMXR8PRlqMSyPcgnWul+z+gBfiIMx3rm9WNxGjDaApjxfaeo25y1iHtedNOrZoZmisF+ATaJMTLVfJRN+3dIGKTkTJJ5byYZsXoj07Yqtom4MXxWdQY3nweQzW8VSodDfXzYNThhS4EJsN1zQR4oX4DRcsqj2/ThUxQYDJkCdofJQID5cPJ1+vjuq2mrvPEpI71V6JKq4XBaohXVMIFbMjtl0IfY8y1jn6EmaGUJP/78//eo76XuNB+wIuSgOFnqOh04ZuQFOJ92Ii8amqKfJcorVyAUI5TA2d1IlIhePh0UG5M+YFnwgpCOZEponbwNpOsS26broMDU3901AlNsEZStodILW+IzlOAy+dzv0a9bV0rs3dlFSKgMOktEKhtWARaxZUGVcxQh3TiMrBXAEqh6YwwiJwkRPxVBvA6VTEggTTnjY8dpBzxVMM1VrSm7xQhCuKBaMnpXVgtSy9IbRijuiCiQoxsS14K2YYDKfBBB0XEhNISxIRQawThCrEZIZKYILWQUHLixi9UOu4cSBxhsZj2EeSTl8oNOUewSXo6UZsSZAzXFm6vwSF6tA07iuMpmPcr5HwRQvoOUDHHhW9CQBSqDuqbR/AdQOz9zixwuHNDzVg5/P5o/30apPnnXBZOQGDhX7gS/2g333r7M2fVyza3nibyDY4RUPWeB+lqNAjkBciZEe47g76Pk1DhrJ4WJlYHqcAGm0TYXuIzgmV2nbN/4o2HmGCxz7P+yt6yAA/b8vxORdNbi+mQzQzEdcXxY+4qu2J2yxiUsSoLK7l8u67wSnM4MfWIYvW0sRfcF77tH/SOx/2SBtK0MFjR63D1iENUT7PuVpbalj1Sq42eiXb2WT5cNrtOyz71+m+w7Ivr+87LHsI7Dss+w7LvsOy77B8e0lj32HZI+o767BU1SeH965dSC58la9qXoQC3XXdZ6CmR0alu841Wy4n3OKVkasVDf9RoqG6303EZtwIPqFi0vXNKqprVlTRu8MF67CT8OQ7GNHCRC7LUP7aKnZSyS1wdOMYC7eTdr26OLgYjljEJlVDKNcJ8Rg+p2YRn7MO840lX2PxLQsaWzLJVVrylGiDTCqz8ZI8sF6ju/M1uuoHWVVPqcWahpvFu2AGfZJRTzIsl6H+t1o19GHqoxyVY2tqCtzNarX6P40sJ2E=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/delete-webhook"}}');var s=t(74848),o=t(28453),r=t(33617),a=t.n(r),d=t(17543),l=t.n(d),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),E=(t(18766),t(79329),t(9303));const I={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWW1vGzcS/isTBrhrgrVkpy5w0Keqji4V6hfBkhEcLMOhdke7rLnkluRKFgR96y+5n3a/5DDk7lqSHaVJCiMI9EUv5MxwXh4OyZklczy1rHPN3uMk0/qO3UQsQRsbUTihFeuwUYZg+QxBGyiLhDuEiha6gz5wKfXcwkKX4HQg5DCvCK4uT2GeiTgDYaG0mBCNMyJN0QDOUDnbGquxevnyJfT83w79ff36qAUzgXNMOq9fj9UBvM9QAQcrUoXGT1ngkOi4zFG5CFwmbBAIcyFlvUZrrD58+DBWy7ECGDNPMGYdGLMgfcyiMOMWBYaJtxcnV2e989Ht6D+DXjOvJ79j7PrJFk3/bUMxFXJbwtXlaTOteL49fd49e1hAaVfNDyRyi2CQVASuEm91sLA2uGFbC1XgbmaCqyyNXtMIwDJ8bWoz7L87712u6xIoMOdCbpD0zrr90w2aItNqU8zg14vz3pgFkhV93VTqBH//svioyJqkWwVo1D/rDUfds0EzHxvk7kmCsVpVgSbsvGlBRboJntp5hMWK4AuAU3HukfNcyPkrYd8VY3CZ0WWagcsQEsOnDhzmhaRE1h309xD4xiCwRlOaNSn983fBKV+IEUoNP7bCEbIjM4R5mCya4+YLEBKEfPcAocEKGJ+CxadB8YmssFpf+W84JY5bEOu8kLjznFhDg5QVHuyXpIx6qe8eE9/OuYHGiamIeW3mSe9y1P93/6Q76m04qonN14PqpxYkGEuxM8PUFF+ZY2oxe0Q9F6Jqj++8xdZEXwcmFjFdoOHklH7COoweVv8Iz6/6pRYxg3+UaN0vOlmwznLr3TYweiYShNJIenWFVeGBOdbKoXLEyItC0kYRWrV/t8S9ZDbOMOf0i1YRBhN6JV4ZSS9EghrrVIhiESsMaesEWmIojaSvisg6I1TKIjbVJudufQTvOW091mGZc4XttNsLXZqD6vV4UBr5c0XSinXOVquIOeE8Q0VzOyHbVyuaMmgLrWzQ4c3h4WOXDMs4RmunpYTGu5/jid1mG7SldE9Z/mBn/XIOkUzANhrJxYsNA4UiGN3WRt2+OTy8/Vdl6fGTxukcXSZUCnOfRIxWaQRF2InOLICnXCige6958fdZjcZos9voz9NslxOODw9vjxonHD12QuNfI4FLgzxZAN4L6+zzmrxLj90GHt3OGwOPHxt4ZdGA0g6mulTJ8xq1vfZuQ44bM356bEZfzbgUia8gjfQdque1ZH15F5YnVe9zn7joZPEmeSI/zzZMXR8PRlqMSyPcgnWul+z+gBfiIMx3rm9WNxGjDaApjxfaeo25y1iHtedNOrZoZmisF+ATaJMTLVfJRN+3dIGKTkTJJ5byYZsXoj07Yqtom4MXxWdQY3nweQzW8VSodDfXzYNThhS4EJsN1zQR4oX4DRcsqj2/ThUxQYDJkCdofJQID5cPJ1+vjuq2mrvPEpI71V6JKq4XBaohXVMIFbMjtl0IfY8y1jn6EmaGUJP/78//eo76XuNB+wIuSgOFnqOh04ZuQFOJ92Ii8amqKfJcorVyAUI5TA2d1IlIhePh0UG5M+YFnwgpCOZEponbwNpOsS26broMDU3901AlNsEZStodILW+IzlOAy+dzv0a9bV0rs3dlFSKgMOktEKhtWARaxZUGVcxQh3TiMrBXAEqh6YwwiJwkRPxVBvA6VTEggTTnjY8dpBzxVMM1VrSm7xQhCuKBaMnpXVgtSy9IbRijuiCiQoxsS14K2YYDKfBBB0XEhNISxIRQawThCrEZIZKYILWQUHLixi9UOu4cSBxhsZj2EeSTl8oNOUewSXo6UZsSZAzXFm6vwSF6tA07iuMpmPcr5HwRQvoOUDHHhW9CQBSqDuqbR/AdQOz9zixwuHNDzVg5/P5o/30apPnnXBZOQGDhX7gS/2g333r7M2fVyza3nibyDY4RUPWeB+lqNAjkBciZEe47g76Pk1DhrJ4WJlYHqcAGm0TYXuIzgmV2nbN/4o2HmGCxz7P+yt6yAA/b8vxORdNbi+mQzQzEdcXxY+4qu2J2yxiUsSoLK7l8u67wSnM4MfWIYvW0sRfcF77tH/SOx/2SBtK0MFjR63D1iENUT7PuVpbalj1Sq42eiXb2WT5cNrtOyz71+m+w7Ivr+87LHsI7Dss+w7LvsOy77B8e0lj32HZI+o767BU1SeH965dSC58la9qXoQC3XXdZ6CmR0alu841Wy4n3OKVkasVDf9RoqG6303EZtwIPqFi0vXNKqprVlTRu8MF67CT8OQ7GNHCRC7LUP7aKnZSyS1wdOMYC7eTdr26OLgYjljEJlVDKNcJ8Rg+p2YRn7MO840lX2PxLQsaWzLJVVrylGiDTCqz8ZI8sF6ju/M1uuoHWVVPqcWahpvFu2AGfZJRTzIsl6H+t1o19GHqoxyVY2tqCtzNarX6P40sJ2E=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},M=void 0,x={},N=[{value:"Events:",id:"events",level:3}];function g(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(E.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,s.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(E.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function m(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.b02fe1ab.js b/assets/js/70853c19.b02fe1ab.js new file mode 100644 index 000000000..85d02c463 --- /dev/null +++ b/assets/js/70853c19.b02fe1ab.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3451],{47561:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>M,default:()=>I,frontMatter:()=>u,metadata:()=>s,toc:()=>x});const s=JSON.parse('{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/save-update-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/save-update-webhook","permalink":"/docs/API-docs/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWf1uIjkSf5Uaj3R3G3Ugmc1KJ/5aNstl0eUDBaLRCaKM6S5ob4zda7shCCHdH/cG9wb3aPskp7K7m4bMMDszq2g04h8+XFV2ffxcZZdXzPGpZa0he4vjVOtHdh+xBG1sROaEVqzFBimC5XMEbSDPEu4QCl5o97rApdQLC0udg9OBkcOiYLi7vYRFKuIUhIXcYkI8zojpFA3gHJWzjZEaqdevX0PH/23R36Oj0wbMBS4waR0djdQxvE1RAQcrpgqNJ1ngkOg4n6FyEbhU2DAhLISU5RqNkXr37t1IrUYKYMQ8w4i1YMTC7CMWBYpbZhgIP9+c3111rgcPg3/1OhVdj3/F2HWTHZ7uzxXHRMjdGe5uLyuy4rNd8nX7arOA0q6g9yRyi2CQVASuEm91sLA0uBKrhSpIV5TgKkujQxoBWIWvbW363Yvrzm1dl8CBMy7kFkvnqt293OLJUq22p+n9cnPdGbHAsqav+0Kd4O+flh+csmRpFwEadK86/UH7qlfRY4PcvZdhpNZFoAk7bxpQsG6Dp3QeYbFg+AzgFJIH5LwUcv5I2PfFGFxqdD5NwaUIieETBw5nmaRE1u51DxD4yiBQ48lNbZbu9UVwymdihFLD941QQvZkhkCH8bIqN5+BkDDJNw8QGiyA8TFYfBwUH8kK6/rKf0KVOGtArGeZxL11ooYGKQs82M9JGeVS3zwmvp66gcaJiYh5aeZ553bQ/Uf3vD3obDmqis2Xg+qHBiQYS7E3w5QcX5hjymkOiHopRJUe33uKLZm+DEwsYjpDw8kp3YS1GF2s/hKuX+VNLWIGf8vRup90smSt1c69rWf0XCQIuZF06wqrwkY41sqhciTIs0zSRhFaNX+1JL1iNk5xxukXrSIMJnRLvDOSbogENdYqEMUilhnS1gm0JJAbSV8Fk3VGqCmL2ESbGXf1EXzitPVYi6XOZbbVbC51bo6L2+NxbuSPBUsj1jO2XkfMCecFCp6HMdm+XhPJoM20skGHNycnz13Sz+MYrZ3kEirvfoon9ptt0ObSvc/yjZ3lzTlEMgFbaSSXr7YMFIpg9FAa9fDm5OTh74WlZ+81Ts/QpUJNYeGTiNFqGkEWdqIzS+BTLhTQude8+vOsRmO02W/0p2m2zwlnJycPp5UTTp87ofKvkcClQZ4sAZ+EdfZlTd6nx34DTx8WlYFnzw28s2hAaQcTnavkZY3aXXu/IWeVGT88N6Or5lyKxHeQBvoR1ctaUl/eheVJ1aeZT1xUWbxJnsnT2Zap9fFgpMU4N8ItWWu4Yk/HPBPHgd4a3q/vI0YbQFMez7T1GnOXshZrLqp0bNHM0Vg/gU+gVU60XCVj/dTQGSqqiJKPLeXDJs9Ec37K1tGuBM+yT+DG/PjTBKzjU6Gm+6XuN07pU+BCbLZcU0WIZ+KfuGRR6fk6V8QEASZFnqDxUSI83G4qX6eM6q6a+2sJzTvRXokirjcZqj4dUwgV81O22wh9izLWM/QtzBShZP/9P//zEuW5xoP2FZ0Hb3IDmV6goYJDh6CJxCcxlr7vADjztE3rFPlMorVyCUI5nBoq14mYCsfDzYMSaMwzPhZSENaJTZO0gdp2sQ06c7oUDZH+aqgdm+AcJW0R4LnTM+5oqupIutDmcUJN3Ag4jHMrFFoLqFKuYmIswxhRB5grQOXQZEZYBOsMaS2Cblo5w2MHM674FENjtu6lBKUgjIPR49w6sFrmXmVwXEhtQnvYG6QQk9Aa7jxlRAIapZO6wZQQN0eY5iJBG0GsE+pQU2jJBJXAGK2DjHQRMVqaNFdSx48+blRrIdOUaQSXoCdbOpK4M1xZOq0EXcoYVA7LjKaijUHBo6M7ixThS6EebXHsH1ZgeotjKxze/62E5WKxeLZrvtuWuRDul3wMt5hpK5w2y430VLg0H/udVp+k+hNmukCFHj+1nbSZI9Gxfb5xabSZosyafXSEENts97o+OX8Hv//7v3CJ3ChI9SKgNc4NyiVMy6XIcyHywW1VboWJ9sBLyeNxAF9xciUPsmg3K2xvO4MTNOR8H8jNcpkoph+WagJp/yVmUlYgFPPYFyF/fwjp6cfdeXxBQDOzN5M+mrmIy1PsByLc9MxNFjEpYlQWa4WmfdG7hDl83zhhUS2H/YFoNy+7553rfoe0oZ0VPHbaOGmc0BAVmxlXtaX6xUPO3dZDzm6qW21K8eH553B1Pjz/HHr/h+efAwQOzz+H55/D88/h+efrSxqH558Dor6x55+iNebwyTUzyYVvQRYvK6F7OCwfQehFJqW+YmvIVqsxt3hn5HpNw7/laKgpeR+xOTeCj6nTNbxfR2VDjdqNj7hkLXYernzHA1qY2GUeenM7nVjqBwaJdhxj5vby1lufvZv+gEVsXLxWzXRCMoYv6CWLL1iL+Vcv3xHy7yk0tmKSq2nOp8Qb5qQeILUTthuIj76BWPwgq0qSWtY03O4sBjPok4x6r8BqFZqT63XFH0gflCgcW3JT4O7X6/X/AWL2ZCo=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/delete-webhook"}}');var o=t(74848),i=t(28453),r=t(33617),a=t.n(r),d=t(17543),c=t.n(d),l=t(86013),p=t.n(l),h=t(63723),E=t.n(h),g=(t(18766),t(79329),t(9303));const u={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWf1uIjkSf5Uaj3R3G3Ugmc1KJ/5aNstl0eUDBaLRCaKM6S5ob4zda7shCCHdH/cG9wb3aPskp7K7m4bMMDszq2g04h8+XFV2ffxcZZdXzPGpZa0he4vjVOtHdh+xBG1sROaEVqzFBimC5XMEbSDPEu4QCl5o97rApdQLC0udg9OBkcOiYLi7vYRFKuIUhIXcYkI8zojpFA3gHJWzjZEaqdevX0PH/23R36Oj0wbMBS4waR0djdQxvE1RAQcrpgqNJ1ngkOg4n6FyEbhU2DAhLISU5RqNkXr37t1IrUYKYMQ8w4i1YMTC7CMWBYpbZhgIP9+c3111rgcPg3/1OhVdj3/F2HWTHZ7uzxXHRMjdGe5uLyuy4rNd8nX7arOA0q6g9yRyi2CQVASuEm91sLA0uBKrhSpIV5TgKkujQxoBWIWvbW363Yvrzm1dl8CBMy7kFkvnqt293OLJUq22p+n9cnPdGbHAsqav+0Kd4O+flh+csmRpFwEadK86/UH7qlfRY4PcvZdhpNZFoAk7bxpQsG6Dp3QeYbFg+AzgFJIH5LwUcv5I2PfFGFxqdD5NwaUIieETBw5nmaRE1u51DxD4yiBQ48lNbZbu9UVwymdihFLD941QQvZkhkCH8bIqN5+BkDDJNw8QGiyA8TFYfBwUH8kK6/rKf0KVOGtArGeZxL11ooYGKQs82M9JGeVS3zwmvp66gcaJiYh5aeZ553bQ/Uf3vD3obDmqis2Xg+qHBiQYS7E3w5QcX5hjymkOiHopRJUe33uKLZm+DEwsYjpDw8kp3YS1GF2s/hKuX+VNLWIGf8vRup90smSt1c69rWf0XCQIuZF06wqrwkY41sqhciTIs0zSRhFaNX+1JL1iNk5xxukXrSIMJnRLvDOSbogENdYqEMUilhnS1gm0JJAbSV8Fk3VGqCmL2ESbGXf1EXzitPVYi6XOZbbVbC51bo6L2+NxbuSPBUsj1jO2XkfMCecFCp6HMdm+XhPJoM20skGHNycnz13Sz+MYrZ3kEirvfoon9ptt0ObSvc/yjZ3lzTlEMgFbaSSXr7YMFIpg9FAa9fDm5OTh74WlZ+81Ts/QpUJNYeGTiNFqGkEWdqIzS+BTLhTQude8+vOsRmO02W/0p2m2zwlnJycPp5UTTp87ofKvkcClQZ4sAZ+EdfZlTd6nx34DTx8WlYFnzw28s2hAaQcTnavkZY3aXXu/IWeVGT88N6Or5lyKxHeQBvoR1ctaUl/eheVJ1aeZT1xUWbxJnsnT2Zap9fFgpMU4N8ItWWu4Yk/HPBPHgd4a3q/vI0YbQFMez7T1GnOXshZrLqp0bNHM0Vg/gU+gVU60XCVj/dTQGSqqiJKPLeXDJs9Ec37K1tGuBM+yT+DG/PjTBKzjU6Gm+6XuN07pU+BCbLZcU0WIZ+KfuGRR6fk6V8QEASZFnqDxUSI83G4qX6eM6q6a+2sJzTvRXokirjcZqj4dUwgV81O22wh9izLWM/QtzBShZP/9P//zEuW5xoP2FZ0Hb3IDmV6goYJDh6CJxCcxlr7vADjztE3rFPlMorVyCUI5nBoq14mYCsfDzYMSaMwzPhZSENaJTZO0gdp2sQ06c7oUDZH+aqgdm+AcJW0R4LnTM+5oqupIutDmcUJN3Ag4jHMrFFoLqFKuYmIswxhRB5grQOXQZEZYBOsMaS2Cblo5w2MHM674FENjtu6lBKUgjIPR49w6sFrmXmVwXEhtQnvYG6QQk9Aa7jxlRAIapZO6wZQQN0eY5iJBG0GsE+pQU2jJBJXAGK2DjHQRMVqaNFdSx48+blRrIdOUaQSXoCdbOpK4M1xZOq0EXcoYVA7LjKaijUHBo6M7ixThS6EebXHsH1ZgeotjKxze/62E5WKxeLZrvtuWuRDul3wMt5hpK5w2y430VLg0H/udVp+k+hNmukCFHj+1nbSZI9Gxfb5xabSZosyafXSEENts97o+OX8Hv//7v3CJ3ChI9SKgNc4NyiVMy6XIcyHywW1VboWJ9sBLyeNxAF9xciUPsmg3K2xvO4MTNOR8H8jNcpkoph+WagJp/yVmUlYgFPPYFyF/fwjp6cfdeXxBQDOzN5M+mrmIy1PsByLc9MxNFjEpYlQWa4WmfdG7hDl83zhhUS2H/YFoNy+7553rfoe0oZ0VPHbaOGmc0BAVmxlXtaX6xUPO3dZDzm6qW21K8eH553B1Pjz/HHr/h+efAwQOzz+H55/D88/h+efrSxqH558Dor6x55+iNebwyTUzyYVvQRYvK6F7OCwfQehFJqW+YmvIVqsxt3hn5HpNw7/laKgpeR+xOTeCj6nTNbxfR2VDjdqNj7hkLXYernzHA1qY2GUeenM7nVjqBwaJdhxj5vby1lufvZv+gEVsXLxWzXRCMoYv6CWLL1iL+Vcv3xHy7yk0tmKSq2nOp8Qb5qQeILUTthuIj76BWPwgq0qSWtY03O4sBjPok4x6r8BqFZqT63XFH0gflCgcW3JT4O7X6/X/AWL2ZCo=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},M=void 0,b={},x=[{value:"Events:",id:"events",level:3}];function m(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,o.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,o.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,o.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(c(),{parameters:void 0}),"\n",(0,o.jsx)(p(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,o.jsx)(E(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(m,{...e})}):m(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.64935506.js b/assets/js/770b40a9.64935506.js new file mode 100644 index 000000000..726e01965 --- /dev/null +++ b/assets/js/770b40a9.64935506.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7605],{71625:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>v,contentTitle:()=>h,default:()=>T,frontMatter:()=>g,metadata:()=>p,toc:()=>x});const p=JSON.parse('{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/gettemplatelist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/gettemplatelist","permalink":"/docs/API-docs/gettemplatelist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar_label":"Get Template list","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWN1u2zYUfpVT3mwrFFtO07TzVYOhyIIFa7FkKLA0MCjp2GJDkRxJ+QeGgF3sDfYGe7Q9yXCoH0txGzfrsIvdJBZ5Pp5fnh9umecLx6Y37BoLI7lHx24jlqFLrTBeaMWm7DpHOEcPLQlcCufh7O0FcCn1ysFGl+A1WPRW4BKBgyQKPQe+5ELyRCL49vwRXOfCwbxUKZ3PpfAbMFYvRYYOuAK9RLsUuAp4KXfICFDxRAq1gNKhdcQzzbV2CHOrC8C1cJ52OwSsclSQWuRhPdNpWaDybsQipg1aThJcZGzKFuhbFMnOIma45QV6tGSeLVO8QDZlUhSCdgUZ5tcS7YZFzOKvpbCYsemcS4cRc34jiXqubcEihmsjdYZs6m1Ju2mOBWfTLSv4WhRlwabP4zhifmMIpMoiQcsqwvHC0EGTuIo6EdydMP+aBJ/mGVe3dK4zWjl0RHscx/RvGByuTFN0bl5K6CzKIpZq5VF5oufGSJGGjfEHR6DtvgA6+YBpMLulY7yoWVp0pfQ9Om4tJ4WFx8IdxtfL5OGO0nkr1IJFwTTc91c63dl68n2iCnf8dkE28cLT6v4RO4ALP7rII5TS/gCopYZAWpFIMkP7X6lVx9NDAtbyQCCsdoboBJ81ApPo4pCJcu+Nm47HLZju8CjVBaH1Sg30fshY4TrrVqqIObFQ4Zb+0yCx+pDoKerPM9gHjZBgEAsLLuRB6gTxVbPQ2sLkWh1gc/L89Hjy7OWLCdGvRLZA/wX617v7/IYX/YxyPWaw5LJEB0dAdue+tBiB87wwowPB19GT0Ov95NNDdysd+vjkpIrY5pGoFxOyzyNBz15WEcsfCTo5Jc/xBT4SN/notbqqQ3rWurZ6iCrcTIcqu1Bv7DB9JFpL5KrPkApAFbFwiTA78w8H2nF8/OxoEh/FL64np9OTb6fPT0dxHP/CIrYuQnQ3RSlrkl4rZPtdmuw/4RM6A7zW5eepbzETFlM/K+1H7+hDcUzsQuMzK3Qm5k1pcw/zDWWZgKXXM4uFUAc91UJq6plWKc6EmuGSSv5HoqxXuav7ZuvXpftxNIwuoaRQOGsL/+w4jmenRFJF7CR+vt8AXKgllyIL/eC1vkP15N8r/2itPlAW+ux9zX5ffVEThX02ULa/XivpMC2t8JvQ9a2PuBFH9f705pZaogJ9rpuWMbSJPmdTNr7XPTq0y7Z1DDHWlT/HVZbo9UgbVJQSJU8cpf4xN2K8pIx+H8GNeQQ1lkePAzjPF0ItHkbd7gxzRc6r/TMwz678GPEDUv1prN+navrWHHnoGyr6nusAbnzyxqCizBY8upzs1aF3KFNdIDX/Pkdoyf/6/c+AaHv8EHBP3qv36k1pwegVWupRucpgLnEtaCYheizCXjfEOOSFROfkBoTyuLDUcmRiITyXoeTRIJFywxMhBcUpkWlCW+iFuhvBuxx9jpa2vrI0FGW4REnhDZQFiuFMAitt7+Y0TkXAISmdUOgcoMq5SomwNX8E2tKYhMqjNVY4BOctSS1q2bTylqceCq74AunsaGClDKWg2ASrk9J5cFqWQWTwXEhtMYNWIYWYuREZ8TUNEBaBVlNdGIs5RcoSYVHS4BZBqjOEug0mFVQGCToPhmQRKYZprVRSp3fBb/NSSjCasoTgkma9vowE95YrR4m4lqX1QWcwYzVNHlgL+PTpzw7Jw5dC3bnp06fv1RHcdMH0DhMnPN5+3Ub9arXai/Zvhphz4b8vE/gJjXbCa7vZoRfC52USbkj/kO6jPukcFYb46d2A3RmZTt3+haPVcY7SjK/QU4S48dnbi5BYv4G/fvsDLpFbBble1dGalhblBhYtK7Jc7fnabF1ehLkOgZeTxdM6+GhsROfJglRph7d5eO0sztGS8YMjd+yMaI6/acUEkv5L1KQMTVHM01BAmkaa0sqr++eEZI62cG/mV/RqkLaDxic8PA7EYxYxKVJUDntF4uz87SUs4dkoZlEvRX6Gt8eXF9+9/vHqNUlDN6u22GQUj+LQ0GvnC656rAavKU3FGJh7u6ug/9Pnl6ZWeFz7sZFchLrcdGN1Tb1hg5p6G7FcO0/r223CHf5sZVXRcv0IQpU2E4603T2D3OGm92gTRpe6g/skbfO6siO9pQ8riDa0AFFbvIhhjTlLUzR9Bns9z6BxOH99zUInmA+L5l0oms0POr3dUpve2cNqWgtAf0mnjwK227ogV1VHX299EtEo2FKTb26rqvobtFsDGA==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"}}');var s=a(74848),l=a(28453),o=a(33617),i=a.n(o),n=a(17543),r=a.n(n),m=a(86013),c=a.n(m),d=a(63723),u=a.n(d),b=(a(18766),a(79329),a(9303));const g={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWN1u2zYUfpVT3mwrFFtO07TzVYOhyIIFa7FkKLA0MCjp2GJDkRxJ+QeGgF3sDfYGe7Q9yXCoH0txGzfrsIvdJBZ5Pp5fnh9umecLx6Y37BoLI7lHx24jlqFLrTBeaMWm7DpHOEcPLQlcCufh7O0FcCn1ysFGl+A1WPRW4BKBgyQKPQe+5ELyRCL49vwRXOfCwbxUKZ3PpfAbMFYvRYYOuAK9RLsUuAp4KXfICFDxRAq1gNKhdcQzzbV2CHOrC8C1cJ52OwSsclSQWuRhPdNpWaDybsQipg1aThJcZGzKFuhbFMnOIma45QV6tGSeLVO8QDZlUhSCdgUZ5tcS7YZFzOKvpbCYsemcS4cRc34jiXqubcEihmsjdYZs6m1Ju2mOBWfTLSv4WhRlwabP4zhifmMIpMoiQcsqwvHC0EGTuIo6EdydMP+aBJ/mGVe3dK4zWjl0RHscx/RvGByuTFN0bl5K6CzKIpZq5VF5oufGSJGGjfEHR6DtvgA6+YBpMLulY7yoWVp0pfQ9Om4tJ4WFx8IdxtfL5OGO0nkr1IJFwTTc91c63dl68n2iCnf8dkE28cLT6v4RO4ALP7rII5TS/gCopYZAWpFIMkP7X6lVx9NDAtbyQCCsdoboBJ81ApPo4pCJcu+Nm47HLZju8CjVBaH1Sg30fshY4TrrVqqIObFQ4Zb+0yCx+pDoKerPM9gHjZBgEAsLLuRB6gTxVbPQ2sLkWh1gc/L89Hjy7OWLCdGvRLZA/wX617v7/IYX/YxyPWaw5LJEB0dAdue+tBiB87wwowPB19GT0Ov95NNDdysd+vjkpIrY5pGoFxOyzyNBz15WEcsfCTo5Jc/xBT4SN/notbqqQ3rWurZ6iCrcTIcqu1Bv7DB9JFpL5KrPkApAFbFwiTA78w8H2nF8/OxoEh/FL64np9OTb6fPT0dxHP/CIrYuQnQ3RSlrkl4rZPtdmuw/4RM6A7zW5eepbzETFlM/K+1H7+hDcUzsQuMzK3Qm5k1pcw/zDWWZgKXXM4uFUAc91UJq6plWKc6EmuGSSv5HoqxXuav7ZuvXpftxNIwuoaRQOGsL/+w4jmenRFJF7CR+vt8AXKgllyIL/eC1vkP15N8r/2itPlAW+ux9zX5ffVEThX02ULa/XivpMC2t8JvQ9a2PuBFH9f705pZaogJ9rpuWMbSJPmdTNr7XPTq0y7Z1DDHWlT/HVZbo9UgbVJQSJU8cpf4xN2K8pIx+H8GNeQQ1lkePAzjPF0ItHkbd7gxzRc6r/TMwz678GPEDUv1prN+navrWHHnoGyr6nusAbnzyxqCizBY8upzs1aF3KFNdIDX/Pkdoyf/6/c+AaHv8EHBP3qv36k1pwegVWupRucpgLnEtaCYheizCXjfEOOSFROfkBoTyuLDUcmRiITyXoeTRIJFywxMhBcUpkWlCW+iFuhvBuxx9jpa2vrI0FGW4REnhDZQFiuFMAitt7+Y0TkXAISmdUOgcoMq5SomwNX8E2tKYhMqjNVY4BOctSS1q2bTylqceCq74AunsaGClDKWg2ASrk9J5cFqWQWTwXEhtMYNWIYWYuREZ8TUNEBaBVlNdGIs5RcoSYVHS4BZBqjOEug0mFVQGCToPhmQRKYZprVRSp3fBb/NSSjCasoTgkma9vowE95YrR4m4lqX1QWcwYzVNHlgL+PTpzw7Jw5dC3bnp06fv1RHcdMH0DhMnPN5+3Ub9arXai/Zvhphz4b8vE/gJjXbCa7vZoRfC52USbkj/kO6jPukcFYb46d2A3RmZTt3+haPVcY7SjK/QU4S48dnbi5BYv4G/fvsDLpFbBble1dGalhblBhYtK7Jc7fnabF1ehLkOgZeTxdM6+GhsROfJglRph7d5eO0sztGS8YMjd+yMaI6/acUEkv5L1KQMTVHM01BAmkaa0sqr++eEZI62cG/mV/RqkLaDxic8PA7EYxYxKVJUDntF4uz87SUs4dkoZlEvRX6Gt8eXF9+9/vHqNUlDN6u22GQUj+LQ0GvnC656rAavKU3FGJh7u6ug/9Pnl6ZWeFz7sZFchLrcdGN1Tb1hg5p6G7FcO0/r223CHf5sZVXRcv0IQpU2E4603T2D3OGm92gTRpe6g/skbfO6siO9pQ8riDa0AFFbvIhhjTlLUzR9Bns9z6BxOH99zUInmA+L5l0oms0POr3dUpve2cNqWgtAf0mnjwK227ogV1VHX299EtEo2FKTb26rqvobtFsDGA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,v={},x=[];function f(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,s.jsx)(i(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,s.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(r(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}},title:"inline_response_200_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function T(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.e63b830b.js b/assets/js/770b40a9.e63b830b.js deleted file mode 100644 index b3efb701f..000000000 --- a/assets/js/770b40a9.e63b830b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7605],{71625:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>b,contentTitle:()=>f,default:()=>v,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/gettemplatelist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/gettemplatelist","permalink":"/docs/API-docs/gettemplatelist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar_label":"Get Template list","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWFtv2zYU/iunfNkKKLacJmnnpwZbkQUrlgDJUGBpEFDSscWGIjmS8gWG3vZL9tP2S4ZDXSzFTdxsRR/2kljk+XjuF3LDPJ87Nr1h11gYyT06dhuxDF1qhfFCKzZl1znCGXpoSeC9cB5OL8+BS6mXDta6BK/BorcCFwgcJFHoGfAFF5InEsG354/gOhcOZqVK6XwuhV+DsXohMnTAFegF2oXAZcBLuUVGgIonUqg5lA6tI55prrVDmFldAK6E87TbIWCZo4LUIg/rmU7LApV3IxYxbdBykuA8Y1M2R9+iSHYWMcMtL9CjJfNsmOIFsimTohC0K8gwf5Ro1yxiFv8ohcWMTWdcOoyY82tJ1DNtCxYxXBmpM2RTb0vaTXMsOJtuWMFXoigLNj2O44j5tSGQKosELasIxwtDB03iKupEcPfCfDUJHucZV7d0rjNaOXREexjH9G8YHK5MU3RuVkroLMoilmrlUXmi58ZIkYaN8SdHoM2uADr5hGkwu6VjvKhZWnSl9D06bi0nhYXHwu3H18vk4Y7SeSvUnEXBNNz3Vzrd2Wryc6IKd3g5J5t44Wl194gtwIUfXeQRSmm/B9RSQyCtSCSZof1WatXx9JSAtTwQCKutITrB7xqBSXSxz0S598ZNx+MWTDk8SnVBaL1UA72fMlZIZ91KFTEn5ipk6b8NEqv3iZ6i/jKDfdIICQaxsOBC7qVOEN82C60tTK7VHjZHxyeHk1dvXk+IfimyOfr/oH+9u8tvmOinVOsxgwWXJTo4ALI796XFCJznhRntCb6OnoRe7RafHrpb6dCHR0dVxNbPRL2ekH2eCXr1popY/kzQ0Ql5js/xmbjJZ9Pqqg7pu9a11VNUITMdquxcXdhh+Ui0lshVnyE1gCpiIYkwO/VPB9phfPjqYBIfxK+vJyfTox+mxyejOI5/ZxFbFSG6m6aUNUWvFbL9Lk32TfiEyQCvdfll6lvMhMXU35X2szn6VBwTuzD43BU6E7Omtbmn+Ya2TI4aqtPvFw/9O/S6UFIovGsb8t1hHN+dEEkVsaP4eLcxn6sFlyILc9q1vkf14uu1ZbRW7ynXffa+Zr+rvqiJwj4bKNtfr5V0mJZW+HWYxlYH3IiDen96c0ujSoE+180oF8Y3n7MpGz+Y6hzaRTvSBd93bclxlSV6NdIGFZUqyRNHJXnMjRgvqNI+RHBjnkGN5cHzAM7zuVDzp1G3W8NckfNq/wzMs20LRvyC1Bca6/epmnkyRx76eUXfMx3AjU8uDCqqOMGji8lOf/iAMtUF0lDuc4SW/O8//wqIdvYOAfcCLkoLRi/R0uDIVQYziStBF4Xde4VDXkh0Tq5BKI9zS1NAJubCcxm6EM32KTc8EVJQiBKZJrSFXpS7EXzI0edoaes7S/eUDBcoKbJBan0f7g4aeOl1EXg0MsNS2/sZiRQBh6R0QqFz4BBbCKqcqxSh9UUE2tJdBpVHa6xwCFwURDzTFnA2E6mggykfLU89FFzxORKzCEhuskJ3KbI6KZ0Hp2UZFCGOBaKvVVSImRvBT2KBteK0mKHnQmIG85KOiCDVGUKTnqSGyiBB58EQe5FiONR5bj1IXKANsRc8OSulBKOpbggu6VbW9y0d5C1XjkpmLVDrms58xmq6IwQeGV+P4KP6qK4oWEqHFABSqHs3/agO4KYLsw+YOOHx9vs2H5bL5U4evBxizoTPywQsGr3FzcNiyJo+vPt4SU1mmDDDyLY4Q0vaBBvNUWGIQG5EXdng5vTyPJRYyFGaLWeC7KYurY6JcHyFnu6lbtziX1IRpJjgaajRzQxJmfv24TmhXqIt3MXsii7MaTtjP2KqcSAes4hJkaJy2KvDp2eX72EBr0Yxi3pV6AuMN35//uO7X6/ekTRUWGuLTUbxKA6zrHa+4KrHavCQ0BTlgbk32yb1P315aMqxx5UfG8lFaH3NIFK3rRs2aFu3Ecu187S+2STc4W9WVhUt1/d/amaZcKTt9gXgHte994owtdfDy6O0zcPClvSWPqwg2tBlo7Y/EMMac5qmaPoMdsaKQW8+e3fNIsZLnw/70n3oS80POr3dUuve2cOGVQtAf0mnzwI2m7rnVVVHX289imgUbKnJN7dVVf0DL+uhcw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"}}');var s=a(74848),n=a(28453),l=a(33617),o=a.n(l),r=a(17543),p=a.n(r),m=a(86013),c=a.n(m),d=a(63723),u=a.n(d),x=(a(18766),a(79329),a(9303));const g={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWFtv2zYU/iunfNkKKLacJmnnpwZbkQUrlgDJUGBpEFDSscWGIjmS8gWG3vZL9tP2S4ZDXSzFTdxsRR/2kljk+XjuF3LDPJ87Nr1h11gYyT06dhuxDF1qhfFCKzZl1znCGXpoSeC9cB5OL8+BS6mXDta6BK/BorcCFwgcJFHoGfAFF5InEsG354/gOhcOZqVK6XwuhV+DsXohMnTAFegF2oXAZcBLuUVGgIonUqg5lA6tI55prrVDmFldAK6E87TbIWCZo4LUIg/rmU7LApV3IxYxbdBykuA8Y1M2R9+iSHYWMcMtL9CjJfNsmOIFsimTohC0K8gwf5Ro1yxiFv8ohcWMTWdcOoyY82tJ1DNtCxYxXBmpM2RTb0vaTXMsOJtuWMFXoigLNj2O44j5tSGQKosELasIxwtDB03iKupEcPfCfDUJHucZV7d0rjNaOXREexjH9G8YHK5MU3RuVkroLMoilmrlUXmi58ZIkYaN8SdHoM2uADr5hGkwu6VjvKhZWnSl9D06bi0nhYXHwu3H18vk4Y7SeSvUnEXBNNz3Vzrd2Wryc6IKd3g5J5t44Wl194gtwIUfXeQRSmm/B9RSQyCtSCSZof1WatXx9JSAtTwQCKutITrB7xqBSXSxz0S598ZNx+MWTDk8SnVBaL1UA72fMlZIZ91KFTEn5ipk6b8NEqv3iZ6i/jKDfdIICQaxsOBC7qVOEN82C60tTK7VHjZHxyeHk1dvXk+IfimyOfr/oH+9u8tvmOinVOsxgwWXJTo4ALI796XFCJznhRntCb6OnoRe7RafHrpb6dCHR0dVxNbPRL2ekH2eCXr1popY/kzQ0Ql5js/xmbjJZ9Pqqg7pu9a11VNUITMdquxcXdhh+Ui0lshVnyE1gCpiIYkwO/VPB9phfPjqYBIfxK+vJyfTox+mxyejOI5/ZxFbFSG6m6aUNUWvFbL9Lk32TfiEyQCvdfll6lvMhMXU35X2szn6VBwTuzD43BU6E7Omtbmn+Ya2TI4aqtPvFw/9O/S6UFIovGsb8t1hHN+dEEkVsaP4eLcxn6sFlyILc9q1vkf14uu1ZbRW7ynXffa+Zr+rvqiJwj4bKNtfr5V0mJZW+HWYxlYH3IiDen96c0ujSoE+180oF8Y3n7MpGz+Y6hzaRTvSBd93bclxlSV6NdIGFZUqyRNHJXnMjRgvqNI+RHBjnkGN5cHzAM7zuVDzp1G3W8NckfNq/wzMs20LRvyC1Bca6/epmnkyRx76eUXfMx3AjU8uDCqqOMGji8lOf/iAMtUF0lDuc4SW/O8//wqIdvYOAfcCLkoLRi/R0uDIVQYziStBF4Xde4VDXkh0Tq5BKI9zS1NAJubCcxm6EM32KTc8EVJQiBKZJrSFXpS7EXzI0edoaes7S/eUDBcoKbJBan0f7g4aeOl1EXg0MsNS2/sZiRQBh6R0QqFz4BBbCKqcqxSh9UUE2tJdBpVHa6xwCFwURDzTFnA2E6mggykfLU89FFzxORKzCEhuskJ3KbI6KZ0Hp2UZFCGOBaKvVVSImRvBT2KBteK0mKHnQmIG85KOiCDVGUKTnqSGyiBB58EQe5FiONR5bj1IXKANsRc8OSulBKOpbggu6VbW9y0d5C1XjkpmLVDrms58xmq6IwQeGV+P4KP6qK4oWEqHFABSqHs3/agO4KYLsw+YOOHx9vs2H5bL5U4evBxizoTPywQsGr3FzcNiyJo+vPt4SU1mmDDDyLY4Q0vaBBvNUWGIQG5EXdng5vTyPJRYyFGaLWeC7KYurY6JcHyFnu6lbtziX1IRpJjgaajRzQxJmfv24TmhXqIt3MXsii7MaTtjP2KqcSAes4hJkaJy2KvDp2eX72EBr0Yxi3pV6AuMN35//uO7X6/ekTRUWGuLTUbxKA6zrHa+4KrHavCQ0BTlgbk32yb1P315aMqxx5UfG8lFaH3NIFK3rRs2aFu3Ecu187S+2STc4W9WVhUt1/d/amaZcKTt9gXgHte994owtdfDy6O0zcPClvSWPqwg2tBlo7Y/EMMac5qmaPoMdsaKQW8+e3fNIsZLnw/70n3oS80POr3dUuve2cOGVQtAf0mnzwI2m7rnVVVHX289imgUbKnJN7dVVf0DL+uhcw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,b={},y=[];function I(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,s.jsx)(o(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,s.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},xml:{name:"template"},title:"template"}}},title:"inline_response_200_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/78b2b753.05461463.js b/assets/js/78b2b753.05461463.js deleted file mode 100644 index 8a21e115d..000000000 --- a/assets/js/78b2b753.05461463.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1519],{30818:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>F,contentTitle:()=>g,default:()=>x,frontMatter:()=>j,metadata:()=>r,toc:()=>h});const r=JSON.parse('{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/deletefolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletefolder","permalink":"/docs/API-docs/deletefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar_label":"Delete Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V91u2zYUfpVT3qwBZFt2027T1YI167wWTbFkKLDECGjpSGJNkSxJ+QeG7vYke7Q9yXAoyz+1EyzdsJvE5vn/zuF36DXzvHAsuWU/aZmhZZOIZehSK4wXWrGE3ZQIGUr0CK0KXHwYA5dSLxysdA1ed/I8yPssYtqg5eRgnLGEteJWyiJmuOUVerQUd80Ur5AlrBXfi4xFTFBgw33JvsxGTz9h6scZ6By2Di1+roXFjCXe1hgx51eSXDpRGYksYrg0UmfIkpxLRwppiRVnyZr5lQma3gpVsIjl2lbc75/gkgcvCZu+HaZ5NirNlDXNhMI6o5VDR45GcUz/DrN1dZqic3ktYYsIi1iqlUflSZ8bI0UaBINPjozWx9m1RRNyltx40YbssHhqHT/P3OgXg4uxYU20aU524U+52RmN4tGL3jDuxd/eDF8l598nL1/14zj+nUVsWUmy3fQx4x7Jrxde7r7vHQglhcL7Dr37URzfD0esaUjp/BSMvU2rQThQ2gNWxq8iIBi5UA4yndYVKg/adjN4p3pwrSv0pVAFLEi4sFoVERiJ3CF4uwJecKFAco/22d2/aoxWeJWHaT5sEVqr7ePAPrk0Qir6ikBPgoOCTB7u2Xkc37/Ytuz8uGWbqqikXNcq6/93Y/9gqY/N/HE+j43keXx+/922vJfH5Y3VnEuRBSr0eobq2f9Q366aE+Ep1cOLKFqlIGcHxe6ft0U6TGsr/CqM8LLHjei18uR2QnNAk6N3VB5I3JcsYYMW2MF6S98NI3d23tF7bSVLWOm9cclg4LjKpnrZ1waVE4WSfOr6qa4G3IjBfMhosg8tuDFP0Ma69zQD53khVPG41WSH0DV1sW3UAU7bdnEj3uKKRV0b9rU2m61ETouLgBcq18F405wrg+paFCq0dj482n8fUaa6Qlq6vkTo1P/6489g0dFFmLxncFVbMHqBljYQVxnkEpdiKvHEDnfIK4nOyRUI5bGw3CNkohCeSyBUiDlSbvhUSEGzSmqarC3sjbvrw8cSfYmWRN9YBA4ZzlHSiIPUekZ+vAZee12FGB3FLbSd5ZRSBBymtRMKnQOH2JmgKrlKEbpeRMSKXAEqj9ZY4RC4qEg51xYwz0UqyDFdTMtTDxVXvEAKFgHlTSgYq+ciQwdWT2vnwWlZh0IoYoXo2xIVYub68FrMsS2cDjP0XEjMoKjJBfF2hrC5p1SGymCKzoOh8CLF4NR5bj1InKMNsxc6mddSgtFEIIJLet7s95YcecuVI45rE+pas4XPWE2PjRAj46s+3Kk7RaQPtUMaACnUzCW0GW+3Y/YRp054nDzv7sNisTi6B2eHNm+EL+spWDR6Z1eEw3Br9s23X87ooXB4YQ4n22KOlqoJGBWoMEwgN6KlOLi9+DC+CZ9KlGYXmUyOry6dDkhxcI3eC1W4QWd/RmwYNmwayBorLmR7c3/40k8gTrSVu8qv0c5FihvueACqQVAesIhJkaJyuEfIF28+vIM5vOjHLNpjoX8A3uDd+MfL99eXlA0Ra4vYsB/3Yzoy2vmKq71Qr/cf7F+SyHq3qb7udb9hOo9LPzCSi7BeQkHrzV64ZdvHebJ72E8iVmrnSbxeT7nD36xsGjr+XKOl5TOJ2JxbwadEhrdrlglHn7Pty/3BQp7/uvkRcAYnfyOczLmjbEV8Peeypm8sYjNcHfwiaSZN1LE2pdXKL9IUjd+zPNr6B6vz9eW7y5tLFjFeE0T7C2MWFsbmAwU4mdjhJmlzoL+01E4arNftMmqarX4retBiU2OnTShNmqb5G9Mn7lM=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/folderlist"}}');var s=o(74848),l=o(28453),n=o(33617),d=o.n(n),i=o(17543),a=o.n(i),p=o(86013),c=o.n(p),m=o(63723),f=o.n(m),u=(o(18766),o(79329),o(9303));const j={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V91u2zYUfpVT3qwBZFt2027T1YI167wWTbFkKLDECGjpSGJNkSxJ+QeG7vYke7Q9yXAoyz+1EyzdsJvE5vn/zuF36DXzvHAsuWU/aZmhZZOIZehSK4wXWrGE3ZQIGUr0CK0KXHwYA5dSLxysdA1ed/I8yPssYtqg5eRgnLGEteJWyiJmuOUVerQUd80Ur5AlrBXfi4xFTFBgw33JvsxGTz9h6scZ6By2Di1+roXFjCXe1hgx51eSXDpRGYksYrg0UmfIkpxLRwppiRVnyZr5lQma3gpVsIjl2lbc75/gkgcvCZu+HaZ5NirNlDXNhMI6o5VDR45GcUz/DrN1dZqic3ktYYsIi1iqlUflSZ8bI0UaBINPjozWx9m1RRNyltx40YbssHhqHT/P3OgXg4uxYU20aU524U+52RmN4tGL3jDuxd/eDF8l598nL1/14zj+nUVsWUmy3fQx4x7Jrxde7r7vHQglhcL7Dr37URzfD0esaUjp/BSMvU2rQThQ2gNWxq8iIBi5UA4yndYVKg/adjN4p3pwrSv0pVAFLEi4sFoVERiJ3CF4uwJecKFAco/22d2/aoxWeJWHaT5sEVqr7ePAPrk0Qir6ikBPgoOCTB7u2Xkc37/Ytuz8uGWbqqikXNcq6/93Y/9gqY/N/HE+j43keXx+/922vJfH5Y3VnEuRBSr0eobq2f9Q366aE+Ep1cOLKFqlIGcHxe6ft0U6TGsr/CqM8LLHjei18uR2QnNAk6N3VB5I3JcsYYMW2MF6S98NI3d23tF7bSVLWOm9cclg4LjKpnrZ1waVE4WSfOr6qa4G3IjBfMhosg8tuDFP0Ma69zQD53khVPG41WSH0DV1sW3UAU7bdnEj3uKKRV0b9rU2m61ETouLgBcq18F405wrg+paFCq0dj482n8fUaa6Qlq6vkTo1P/6489g0dFFmLxncFVbMHqBljYQVxnkEpdiKvHEDnfIK4nOyRUI5bGw3CNkohCeSyBUiDlSbvhUSEGzSmqarC3sjbvrw8cSfYmWRN9YBA4ZzlHSiIPUekZ+vAZee12FGB3FLbSd5ZRSBBymtRMKnQOH2JmgKrlKEbpeRMSKXAEqj9ZY4RC4qEg51xYwz0UqyDFdTMtTDxVXvEAKFgHlTSgYq+ciQwdWT2vnwWlZh0IoYoXo2xIVYub68FrMsS2cDjP0XEjMoKjJBfF2hrC5p1SGymCKzoOh8CLF4NR5bj1InKMNsxc6mddSgtFEIIJLet7s95YcecuVI45rE+pas4XPWE2PjRAj46s+3Kk7RaQPtUMaACnUzCW0GW+3Y/YRp054nDzv7sNisTi6B2eHNm+EL+spWDR6Z1eEw3Br9s23X87ooXB4YQ4n22KOlqoJGBWoMEwgN6KlOLi9+DC+CZ9KlGYXmUyOry6dDkhxcI3eC1W4QWd/RmwYNmwayBorLmR7c3/40k8gTrSVu8qv0c5FihvueACqQVAesIhJkaJyuEfIF28+vIM5vOjHLNpjoX8A3uDd+MfL99eXlA0Ra4vYsB/3Yzoy2vmKq71Qr/cf7F+SyHq3qb7udb9hOo9LPzCSi7BeQkHrzV64ZdvHebJ72E8iVmrnSbxeT7nD36xsGjr+XKOl5TOJ2JxbwadEhrdrlglHn7Pty/3BQp7/uvkRcAYnfyOczLmjbEV8Peeypm8sYjNcHfwiaSZN1LE2pdXKL9IUjd+zPNr6B6vz9eW7y5tLFjFeE0T7C2MWFsbmAwU4mdjhJmlzoL+01E4arNftMmqarX4retBiU2OnTShNmqb5G9Mn7lM=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,F={},h=[];function I(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,s.jsx)(d(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_12"}}}},400:{description:"- folder is not empty, contains document or folder.\n- Something went wrong, please try again later!\n",content:{"application/json":{schema:{type:"object",oneOf:[{properties:{error:{type:"string",example:"folder is not empty, contains document or folder."}}},{properties:{error:{type:"string",example:"Something went wrong, please try again later!"}}}],title:"inline_response_400_3"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/78b2b753.5a4dcd6c.js b/assets/js/78b2b753.5a4dcd6c.js new file mode 100644 index 000000000..6c7173ace --- /dev/null +++ b/assets/js/78b2b753.5a4dcd6c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1519],{30818:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>y,default:()=>H,frontMatter:()=>b,metadata:()=>l,toc:()=>J});const l=JSON.parse('{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/deletefolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletefolder","permalink":"/docs/API-docs/deletefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar_label":"Delete Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V+9u2zYQf5Urv6wNFFtJ027TpwVr1mYNlqBJUWCJEVDSSWJDkSxJ2TEMAfuwN9gb7NH6JMNRlmzXSbC0w74kFu8P7353vB+5YJ6XjiWX7Bctc7RsErEcXWaF8UIrlrCLCiFHiR6hU4HDs2PgUuqZg7luwOteXgT5iEVMG7ScHBznLGGduJOyiBlueY0eLe27YIrXyBLWia9FziImaGPDfcW+jEanHzHzxznoAgaHFj81wmLOEm8bjJjzc0kunaiNRBYxvDVS58iSgktHClmFNWfJgvm5CZreClWyiBXa1tyvr+AtD14Slr7dy4p8vzIpa9sJbeuMVg4dOdqPY/q3Ga1rsgydKxoJAyIsYplWHpUnfW6MFFkQjD86MlpsR9clTchZcuNFt2WPxWPzeHPj9n81ODs2rI2WxckP/V1uVkb78f7z3b14N/7+Yu9lcvBj8uLlKI7j31nEbmtJtss65twj+fXCy9X32oJQUii87tG73o/j67191rakdHAXjLvLUoNwoLQHrI2fR0AwcqEc5DpralQetO178Ertwrmu0VdClTAj4cxqVUZgJHKH4O0ceMmFAsk92idX31QYrfC0CN28WSK0VtuHgX10aoRU9BUbPQoO2mRyf80O4vj6+VCyg+2SLbOilArdqHz037X9vak+1PPb8TzUkgfxwfUPQ3ovttM7VlMuRR5Godc3qJ78D/mtsrljewp18yCKTinI2Uay6+tdkg6zxgo/Dy18u8uN2O3kyeWE+oA6R69GeRjivmIJG3fAjhfD+G4ZubPTfrw3VrKEVd4bl4zHjqs81bcjbVA5USrJUzfKdD3mRoyne4w6e9OCG/MIbWx2H2fgPC+FKh+2mqwQOqcqdoXawGkoFzfiLc5Z1JdhXWvJbBVyIi4CXqhCB+NlcU4NqnNRqlDa6d4W/31AmekaiXR9hdCrf/7z72DRj4vQeU+u1JU6bSwYPUNLJMRVDoXEW5FKDPpYB9lA5A55LdE5OQehPJaWe4RclMJzCQQNjY+MG54KKahhSU2TtYW1nncj+FChr9CS6DuLwCHHKUrqc+CN1zX35GoYbzNtbwq6UkTAIW2cUOgcoKq4ykixhz+iQcgVoPJojRUOwXlLUYsuNq285ZmHmiteIvmONlDKUQrqTbA6bZwHp2UTQgbPhdQWc+gTUoi5GxGIR3R/sAi0munaWKyoU6YIZSNydDSwcwQXzieloHJI0XkwFIvI0JHTRkmd3YS6FY2UYDSNC8ElXWbWYyRzb7lyNNG6WPoaDIAZq+lqgV2AOzvvHVKFT4S6ccnODvHf5dBMHzB1wuPkad/1s9lsq9ufbdq8Fv5Nk8I7NNoJr+18ZV0KXzVpOCHrToaPztNrVBj6Z+0ErHzkOnPbB45WxxVKMz5HTx3ixodnxxdk+gw+//EXnCC3Cio967o1ayzKOZT9VoRcV/kOtmFAQqFD41WEeNY1H10b0XlCkG4xm6d589hZLNAS+KGQq+2MWLq/7MMEiv5b0qRRHeg/C0yCNReyGys/feknTHW0tTstztFORYbLwXZPhcdBecwiJkWGyuEaWxy+PjuBKTwfxSxaG5H/otrjk+Ofj347P6Jo6GR1iO2N4lFMS0Y7X3O1ttWr9dfElxNusaLRr3t6LMewx1s/NpKLwH0hocWStC7Z8HJIVq+OScQq7TyJF4uUO3xvZdvS8qcGLTHjJGJTbgVPaVJfLlguHP3Oh2fFvYk8fbd8oTyDOx8wd8bc84kiMply2dAXi9gNzjeeS+2kjXpKobA6+WGWofFrlltXkg1ef3V0cnRxxCJGZ2STzW4Cmy1/0AZ3BrZJc10M9JcY906DxaJjyrYd9DvRvRbLHHttQmnStu0/5U0rKw==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/folderlist"}}');var r=o(74848),d=o(28453),i=o(33617),n=o.n(i),s=o(17543),a=o.n(s),c=o(86013),p=o.n(c),f=o(63723),u=o.n(f),m=(o(18766),o(79329),o(9303));const b={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9u2zYQf5Urv6wNFFtJ027TpwVr1mYNlqBJUWCJEVDSSWJDkSxJ2TEMAfuwN9gb7NH6JMNRlmzXSbC0w74kFu8P7353vB+5YJ6XjiWX7Bctc7RsErEcXWaF8UIrlrCLCiFHiR6hU4HDs2PgUuqZg7luwOteXgT5iEVMG7ScHBznLGGduJOyiBlueY0eLe27YIrXyBLWia9FziImaGPDfcW+jEanHzHzxznoAgaHFj81wmLOEm8bjJjzc0kunaiNRBYxvDVS58iSgktHClmFNWfJgvm5CZreClWyiBXa1tyvr+AtD14Slr7dy4p8vzIpa9sJbeuMVg4dOdqPY/q3Ga1rsgydKxoJAyIsYplWHpUnfW6MFFkQjD86MlpsR9clTchZcuNFt2WPxWPzeHPj9n81ODs2rI2WxckP/V1uVkb78f7z3b14N/7+Yu9lcvBj8uLlKI7j31nEbmtJtss65twj+fXCy9X32oJQUii87tG73o/j67191rakdHAXjLvLUoNwoLQHrI2fR0AwcqEc5DpralQetO178Ertwrmu0VdClTAj4cxqVUZgJHKH4O0ceMmFAsk92idX31QYrfC0CN28WSK0VtuHgX10aoRU9BUbPQoO2mRyf80O4vj6+VCyg+2SLbOilArdqHz037X9vak+1PPb8TzUkgfxwfUPQ3ovttM7VlMuRR5Godc3qJ78D/mtsrljewp18yCKTinI2Uay6+tdkg6zxgo/Dy18u8uN2O3kyeWE+oA6R69GeRjivmIJG3fAjhfD+G4ZubPTfrw3VrKEVd4bl4zHjqs81bcjbVA5USrJUzfKdD3mRoyne4w6e9OCG/MIbWx2H2fgPC+FKh+2mqwQOqcqdoXawGkoFzfiLc5Z1JdhXWvJbBVyIi4CXqhCB+NlcU4NqnNRqlDa6d4W/31AmekaiXR9hdCrf/7z72DRj4vQeU+u1JU6bSwYPUNLJMRVDoXEW5FKDPpYB9lA5A55LdE5OQehPJaWe4RclMJzCQQNjY+MG54KKahhSU2TtYW1nncj+FChr9CS6DuLwCHHKUrqc+CN1zX35GoYbzNtbwq6UkTAIW2cUOgcoKq4ykixhz+iQcgVoPJojRUOwXlLUYsuNq285ZmHmiteIvmONlDKUQrqTbA6bZwHp2UTQgbPhdQWc+gTUoi5GxGIR3R/sAi0munaWKyoU6YIZSNydDSwcwQXzieloHJI0XkwFIvI0JHTRkmd3YS6FY2UYDSNC8ElXWbWYyRzb7lyNNG6WPoaDIAZq+lqgV2AOzvvHVKFT4S6ccnODvHf5dBMHzB1wuPkad/1s9lsq9ufbdq8Fv5Nk8I7NNoJr+18ZV0KXzVpOCHrToaPztNrVBj6Z+0ErHzkOnPbB45WxxVKMz5HTx3ixodnxxdk+gw+//EXnCC3Cio967o1ayzKOZT9VoRcV/kOtmFAQqFD41WEeNY1H10b0XlCkG4xm6d589hZLNAS+KGQq+2MWLq/7MMEiv5b0qRRHeg/C0yCNReyGys/feknTHW0tTstztFORYbLwXZPhcdBecwiJkWGyuEaWxy+PjuBKTwfxSxaG5H/otrjk+Ofj347P6Jo6GR1iO2N4lFMS0Y7X3O1ttWr9dfElxNusaLRr3t6LMewx1s/NpKLwH0hocWStC7Z8HJIVq+OScQq7TyJF4uUO3xvZdvS8qcGLTHjJGJTbgVPaVJfLlguHP3Oh2fFvYk8fbd8oTyDOx8wd8bc84kiMply2dAXi9gNzjeeS+2kjXpKobA6+WGWofFrlltXkg1ef3V0cnRxxCJGZ2STzW4Cmy1/0AZ3BrZJc10M9JcY906DxaJjyrYd9DvRvRbLHHttQmnStu0/5U0rKw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,j={},J=[];function x(e){const t={p:"p",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,r.jsx)(n(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,r.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(a(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,r.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_12"}}}},400:{description:"- folder is not empty, contains document or folder.\n- Something went wrong, please try again later!\n",content:{"application/json":{schema:{type:"object",oneOf:[{properties:{error:{type:"string",example:"folder is not empty, contains document or folder."}}},{properties:{error:{type:"string",example:"Something went wrong, please try again later!"}}}],title:"inline_response_400_3"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function H(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.74d6bcf5.js b/assets/js/7b076186.74d6bcf5.js new file mode 100644 index 000000000..e89cce34a --- /dev/null +++ b/assets/js/7b076186.74d6bcf5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9938],{90736:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>I,contentTitle:()=>f,default:()=>g,frontMatter:()=>M,metadata:()=>a,toc:()=>A});const a=JSON.parse('{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/deletecontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletecontact","permalink":"/docs/API-docs/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV9tu3DYQ/ZUJX3KBvLt2nBTVU93ESIwajRE7CFBnYVDirMQsRbIktRcsBPShf9A/6KflS4qhpL14bSNBiwB9sVfkXM8M55ArFnjhWXrNXhkdeB48GydMoM+dtEEazVJ2VSK8RoUBoROCk4sz4EqZuYelqSEYcFiZGQKHvBOZOFPRputXMmOmAzibRA1tQBldoAONKICD5S7IvFZ8Lf/Yg9QT4ypOcSQQSumj44pP0YMMgNwvybdogwslSgcOc+PEgCXMWHRR90ywlLVCnW2WMMsdrzCgo+xXTPMKWcq6/RspWMIkZW95KNltSC6cmUmBYLLPmIczAWayTnwdEEuYw99r6VCwNLgaE+bDUpEbLyurSAAXVhmBLJ1w5UkgL7HiLF2xsLRRMjipC5awFontFVzwaCVltjzKyiPuBWuaMXn11miPnuwcjUb0bzf+vo5toAJ8nefo/aRWavmIJREG1IEUubVK5hHH4WdP2qv9KFscCFVHqAfZ+u7huSufTfQ/Lyh2+9Y+Z03S1UmchIeVjkZHzw8ORwejH64OX6bHP6YvXg5Go9FvLGGLSpFuV1HBA5LdIIPafDd7Ym3JtgW7lYaEj+9C8dJUGEqpC5ijDjB3RhcJWIXcIwS3BF5wqUHxgO4/RBWdM+5hdL4tsmYra6mV1HjTt9DN8Wh0c7gG4fj+VtImwMTUWnzfTO9w/3A6xzdH63Re7KdzpmdcSREHzZWZov6+6Wy7D637/V6VrVDcZzvJbq+3SXrMayfDMg65xQG38qDdT6/HNCuoT8xmPsbBGEqWsmE3z4arzUxsGBl0s35o1k6xlJUhWJ8Oh55rkZnFwFjUXhZa8cwPclMNuZXD2SFrktsa3NpvkMb64NsUfOCF1MXDWuMNRpdUx7ZUO0itC8at/AWXLOkLsS3V0UWJXKCLRSP2ispded5Z1Jey0LG4s8M9UvmIKjcVEoGEEqEX//Ln31FDmLyuUIfYe48+6U/6Xe3Amjm6Sa2AawEThQuZKYzyWMW9NUN75JVC79USpA5YOB4QhCxk4AoIGhoXObc8k0pSy5KYaSl8q+v9AD6WGEp0tPXYEecLnKGiTgdeB0OErYt1vDA3bjqhu0ICHLLaS43eA+qS65wEe/gTMA64BtQBnXXSI/jgKGrZxmZ0cHTWK655gWQ72UFJoJLUm+BMVvsA3qg6hgyBS2UcCugToluHHxCIp8TADqG9qVTWYUmdMkMoainQJ5AbgeDjCaUUtIAMfQBLscgcPRmttTL5NNaNSBSsoYEhuaKbwXaMpB4c1574vI2lr8EaMOsMsTG2AT579sEjVfhc6qlPnz37pA/get1MHzHzMuD4Sd/18/l8r9uf7uq8keFtncF7tMbLYNxyo13IUNZZPCHbRtYfraU3qDH2z9YJ2NgQJvf7B45WhyUqO7zEQB3ihycXZ3HGPoUvf/wF58idhtLM227Na4dqCUXvipBrK9/Cth6RMDGx8UpCPG+bjy5e6AMhSDeC3dO8e+wcTtAR+LGQG3dWduav+zCBov83adKw7m+gxAcVl6odKz/dthPnOrrKv5tcopvJHLvBdk+Fh1F4yBKmZI7a4xZfnLy5OIcZPB+MWLI1Ir+i2sPzs1env16eUjR0slrEDgejwYiWrPGh4nrL1e474faIW22Y9H/7quioIOAiDK3iMjJwBHXVUec127wy0q0HxThhpfGBBFarjHv84FTT0PLvNTpi6HHCZtxJnhFfXK+YkJ5+i/Xz4F40n7zvXhpP4WvfJncm0hOdJpabcVXTF0vYFJe7r6Nm3CQ92VGorcBJnqMNW6p716WdO8fr0/PTq1OWMDq9uzw7jTzb/SAHd0a2S8BtDPSX7gJ3KqxWLYc3zVq+3bpXo8uxlyaYxk3T/AOnI1dC","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"}}');var n=o(74848),c=o(28453),s=o(33617),i=o.n(s),r=o(17543),d=o.n(r),l=o(86013),p=o.n(l),h=o(63723),m=o.n(h),u=(o(18766),o(79329),o(9303));const M={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV9tu3DYQ/ZUJX3KBvLt2nBTVU93ESIwajRE7CFBnYVDirMQsRbIktRcsBPShf9A/6KflS4qhpL14bSNBiwB9sVfkXM8M55ArFnjhWXrNXhkdeB48GydMoM+dtEEazVJ2VSK8RoUBoROCk4sz4EqZuYelqSEYcFiZGQKHvBOZOFPRputXMmOmAzibRA1tQBldoAONKICD5S7IvFZ8Lf/Yg9QT4ypOcSQQSumj44pP0YMMgNwvybdogwslSgcOc+PEgCXMWHRR90ywlLVCnW2WMMsdrzCgo+xXTPMKWcq6/RspWMIkZW95KNltSC6cmUmBYLLPmIczAWayTnwdEEuYw99r6VCwNLgaE+bDUpEbLyurSAAXVhmBLJ1w5UkgL7HiLF2xsLRRMjipC5awFontFVzwaCVltjzKyiPuBWuaMXn11miPnuwcjUb0bzf+vo5toAJ8nefo/aRWavmIJREG1IEUubVK5hHH4WdP2qv9KFscCFVHqAfZ+u7huSufTfQ/Lyh2+9Y+Z03S1UmchIeVjkZHzw8ORwejH64OX6bHP6YvXg5Go9FvLGGLSpFuV1HBA5LdIIPafDd7Ym3JtgW7lYaEj+9C8dJUGEqpC5ijDjB3RhcJWIXcIwS3BF5wqUHxgO4/RBWdM+5hdL4tsmYra6mV1HjTt9DN8Wh0c7gG4fj+VtImwMTUWnzfTO9w/3A6xzdH63Re7KdzpmdcSREHzZWZov6+6Wy7D637/V6VrVDcZzvJbq+3SXrMayfDMg65xQG38qDdT6/HNCuoT8xmPsbBGEqWsmE3z4arzUxsGBl0s35o1k6xlJUhWJ8Oh55rkZnFwFjUXhZa8cwPclMNuZXD2SFrktsa3NpvkMb64NsUfOCF1MXDWuMNRpdUx7ZUO0itC8at/AWXLOkLsS3V0UWJXKCLRSP2ispded5Z1Jey0LG4s8M9UvmIKjcVEoGEEqEX//Ln31FDmLyuUIfYe48+6U/6Xe3Amjm6Sa2AawEThQuZKYzyWMW9NUN75JVC79USpA5YOB4QhCxk4AoIGhoXObc8k0pSy5KYaSl8q+v9AD6WGEp0tPXYEecLnKGiTgdeB0OErYt1vDA3bjqhu0ICHLLaS43eA+qS65wEe/gTMA64BtQBnXXSI/jgKGrZxmZ0cHTWK655gWQ72UFJoJLUm+BMVvsA3qg6hgyBS2UcCugToluHHxCIp8TADqG9qVTWYUmdMkMoainQJ5AbgeDjCaUUtIAMfQBLscgcPRmttTL5NNaNSBSsoYEhuaKbwXaMpB4c1574vI2lr8EaMOsMsTG2AT579sEjVfhc6qlPnz37pA/get1MHzHzMuD4Sd/18/l8r9uf7uq8keFtncF7tMbLYNxyo13IUNZZPCHbRtYfraU3qDH2z9YJ2NgQJvf7B45WhyUqO7zEQB3ihycXZ3HGPoUvf/wF58idhtLM227Na4dqCUXvipBrK9/Cth6RMDGx8UpCPG+bjy5e6AMhSDeC3dO8e+wcTtAR+LGQG3dWduav+zCBov83adKw7m+gxAcVl6odKz/dthPnOrrKv5tcopvJHLvBdk+Fh1F4yBKmZI7a4xZfnLy5OIcZPB+MWLI1Ir+i2sPzs1env16eUjR0slrEDgejwYiWrPGh4nrL1e474faIW22Y9H/7quioIOAiDK3iMjJwBHXVUec127wy0q0HxThhpfGBBFarjHv84FTT0PLvNTpi6HHCZtxJnhFfXK+YkJ5+i/Xz4F40n7zvXhpP4WvfJncm0hOdJpabcVXTF0vYFJe7r6Nm3CQ92VGorcBJnqMNW6p716WdO8fr0/PTq1OWMDq9uzw7jTzb/SAHd0a2S8BtDPSX7gJ3KqxWLYc3zVq+3bpXo8uxlyaYxk3T/AOnI1dC",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,I={},A=[];function B(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,n.jsx)(i(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,n.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(B,{...e})}):B(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.d801eba3.js b/assets/js/7b076186.d801eba3.js deleted file mode 100644 index c9e90e769..000000000 --- a/assets/js/7b076186.d801eba3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9938],{90736:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>y,default:()=>k,frontMatter:()=>g,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/deletecontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletecontact","permalink":"/docs/API-docs/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV9tuGzcQ/ZUJXxIDa0l2nBTdp7qJkRoNGqN2EaCOYIx2R7uMuCRDcnWBsG/9kn5av6QY7q4ulm0kQBGgL7ZEznBmzgzPodYiYOFFeiveGB0wC16ME5GTz5y0QRotUnFTErwlRYGgM4Lzq0tApczCw8rUEAw4qsycACHrTKbOVLzp+pWJMbMBXE6jhzagjC7IgSbKAcGiCzKrFW7sn3uQempchZxHAqGUPgaucEYeZABCv+LYeZtcKEk6cJQZlw9EIowlF30vc5GK1qg7WyTCosOKAjmufi00ViRS0e3fyVwkQnL1FkMp7kNy5cxc5gRm8pmycJmDmW4K3yQkEuHoSy0d5SINrqZE+LBSHMbLyio2oKVVJieRTlF5NshKqlCkaxFWNloGJ3UhEtEisbtCS4ynpMKWp5PyFH0ummbMUb012pPnc05HI/63n3/fxzbRHHydZeT9tFZq9UwkEQbSgR3RWiWziOPws2fv9WGWLQ6MqmPUg2xj9/A8VM82+5+XnLv9xb4UTdL1KT8PTzudjk5fHp+Mjkc/3Jy8Ts9+TF+9HoxGoz9FIpaVYt+uozkG4nODDGr7vTkwa1u2a9itNGx89hCK16aiUEpdwIJ0gIUzukjAKkJPENwKsECpQWEg9x+iSs4Z9zQ635ZZs1O11EpquutH6O5sNLo72YBw9vgoaRNgamqdf99KHwj/dDlnd6ebcl4dlnOp56hkHonmxsxIf99ydsOHNvzhrMrWKO6LvWJ319siPWW1k2EVSW55jFYet/vp7Zi5gufEbPkxEmMoRSqGHZ8N11tObAQf6OY9adZOiVSUIVifDocedT4xy4GxpL0stMKJH2SmGqKVw/mJaJL7HmjtN1hTffxtDj5gIXXxtNd4i9E197Ft1R5Sm4ahlb/SSiR9I3atOrkoCXNysWmsXtG5a88HS/paFjo2d35yICofSWWmIhaQUBL05v/89Xf0yE1WV6RDnL1n8KF2YM2C3LRWgDqHqaKlnCh6QJw9YaXIe7UCqQMVDgNBLgsZUAGjwkyRocWJVJKnlc1Mq947A+8H8LGkUJLjreeO5T6nOSkeclDGzPicYADrYKoYo8sZFsbNppxSAgiT2ktN3oMn6l1Il6gzgr4XCRgHqIF0IGed9AQoKzaeGgc0ncpM8sE8nI4JoEKNBXGwBDhvRsG2Mu3BmUntA3ij6lgIR6yIQlsiP0H8AN7KObWF82JOAaWiHIqaj0ggMzlBd1O5DJ3DhHwAy+FlRvFQH9AFUDQnF2cvdpJlFaxhCpGo+K2w21s+KDjUnhW+TahvzQY+6wzrc4yR42oAn/QnzSQPtSceACX1zKef9DHcbsbsI028DDR+0d+HxWJxcA+O9n3eyVDWE3BkzdaviIvx1uy6b74csejuX5j9yXY0JcfVRIwK0hQnEK1sSQ5uz68uI9tCScpuI7PL4dXl1SEbDq8pBKkLP+z9j5gP+0ceU26FUrU396f750TqJFf5D9NrcnOZUccdj0A1jMZDkQglM9Kedij5/N3Ve5jDy8FIJDss9BXgDd9fvrn47fqCs2FibRE7GYwGI16yxocK9U6o/af4fRZZb8Xqf/tw79g20DIMrUIZRS6Cuu7U6VZsH/Lpzpt9nIjS+MAG6/UEPf3hVNPw8peaHIvgOBFzdBInTMm3a5FLz5/zzQv8UTRf/N495o/ga5//DxbSa4lmIZmjqvmbSMSMVvs/QJpxk/R6wqm2BudZRjbsuB68SPZk/e3F+4ubC5EIrBm4XSmbRSnrPnCABzPb17g2B/7Lcvugw3rdymTTbOzbrUc9uhp7a4Zp3DTNv2UfGnk=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"}}');var a=o(74848),c=o(28453),s=o(33617),i=o.n(s),l=o(17543),r=o.n(l),d=o(86013),p=o.n(d),m=o(63723),u=o.n(m),I=(o(18766),o(79329),o(9303));const g={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV9tuGzcQ/ZUJXxIDa0l2nBTdp7qJkRoNGqN2EaCOYIx2R7uMuCRDcnWBsG/9kn5av6QY7q4ulm0kQBGgL7ZEznBmzgzPodYiYOFFeiveGB0wC16ME5GTz5y0QRotUnFTErwlRYGgM4Lzq0tApczCw8rUEAw4qsycACHrTKbOVLzp+pWJMbMBXE6jhzagjC7IgSbKAcGiCzKrFW7sn3uQempchZxHAqGUPgaucEYeZABCv+LYeZtcKEk6cJQZlw9EIowlF30vc5GK1qg7WyTCosOKAjmufi00ViRS0e3fyVwkQnL1FkMp7kNy5cxc5gRm8pmycJmDmW4K3yQkEuHoSy0d5SINrqZE+LBSHMbLyio2oKVVJieRTlF5NshKqlCkaxFWNloGJ3UhEtEisbtCS4ynpMKWp5PyFH0ummbMUb012pPnc05HI/63n3/fxzbRHHydZeT9tFZq9UwkEQbSgR3RWiWziOPws2fv9WGWLQ6MqmPUg2xj9/A8VM82+5+XnLv9xb4UTdL1KT8PTzudjk5fHp+Mjkc/3Jy8Ts9+TF+9HoxGoz9FIpaVYt+uozkG4nODDGr7vTkwa1u2a9itNGx89hCK16aiUEpdwIJ0gIUzukjAKkJPENwKsECpQWEg9x+iSs4Z9zQ635ZZs1O11EpquutH6O5sNLo72YBw9vgoaRNgamqdf99KHwj/dDlnd6ebcl4dlnOp56hkHonmxsxIf99ydsOHNvzhrMrWKO6LvWJ319siPWW1k2EVSW55jFYet/vp7Zi5gufEbPkxEmMoRSqGHZ8N11tObAQf6OY9adZOiVSUIVifDocedT4xy4GxpL0stMKJH2SmGqKVw/mJaJL7HmjtN1hTffxtDj5gIXXxtNd4i9E197Ft1R5Sm4ahlb/SSiR9I3atOrkoCXNysWmsXtG5a88HS/paFjo2d35yICofSWWmIhaQUBL05v/89Xf0yE1WV6RDnL1n8KF2YM2C3LRWgDqHqaKlnCh6QJw9YaXIe7UCqQMVDgNBLgsZUAGjwkyRocWJVJKnlc1Mq947A+8H8LGkUJLjreeO5T6nOSkeclDGzPicYADrYKoYo8sZFsbNppxSAgiT2ktN3oMn6l1Il6gzgr4XCRgHqIF0IGed9AQoKzaeGgc0ncpM8sE8nI4JoEKNBXGwBDhvRsG2Mu3BmUntA3ij6lgIR6yIQlsiP0H8AN7KObWF82JOAaWiHIqaj0ggMzlBd1O5DJ3DhHwAy+FlRvFQH9AFUDQnF2cvdpJlFaxhCpGo+K2w21s+KDjUnhW+TahvzQY+6wzrc4yR42oAn/QnzSQPtSceACX1zKef9DHcbsbsI028DDR+0d+HxWJxcA+O9n3eyVDWE3BkzdaviIvx1uy6b74csejuX5j9yXY0JcfVRIwK0hQnEK1sSQ5uz68uI9tCScpuI7PL4dXl1SEbDq8pBKkLP+z9j5gP+0ceU26FUrU396f750TqJFf5D9NrcnOZUccdj0A1jMZDkQglM9Kedij5/N3Ve5jDy8FIJDss9BXgDd9fvrn47fqCs2FibRE7GYwGI16yxocK9U6o/af4fRZZb8Xqf/tw79g20DIMrUIZRS6Cuu7U6VZsH/Lpzpt9nIjS+MAG6/UEPf3hVNPw8peaHIvgOBFzdBInTMm3a5FLz5/zzQv8UTRf/N495o/ga5//DxbSa4lmIZmjqvmbSMSMVvs/QJpxk/R6wqm2BudZRjbsuB68SPZk/e3F+4ubC5EIrBm4XSmbRSnrPnCABzPb17g2B/7Lcvugw3rdymTTbOzbrUc9uhp7a4Zp3DTNv2UfGnk=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,b={},f=[];function h(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(i(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,a.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(r(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.a786571b.js b/assets/js/8a725248.a786571b.js new file mode 100644 index 000000000..631473655 --- /dev/null +++ b/assets/js/8a725248.a786571b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8672],{96752:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>y,contentTitle:()=>g,default:()=>C,frontMatter:()=>x,metadata:()=>a,toc:()=>I});const a=JSON.parse('{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/createcontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createcontact","permalink":"/docs/API-docs/createcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar_label":"Create Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV2lu3DYUvsoL/7Qx5NnspKh+xQ2M1KgRG7GDAJ0MDEp6I9GmSIakZsFAQH/0Br1Bj5aTFI+SZvOCGi1SFDAMDfn27XtcMc9zx+Ixe6uV56l3bBKxDF1qhfFCKxaz6wLhrUXuEVoiOLk8Ay6lnjtY6gq8BpxOtfUSnZNLSBtqhXNIW7HgC+4h5QqInztwIldoHUy1JRkWRGm09Vx5yHRalai867GIaYOWkyVnGYtZI7kVyiJm8UuFzv+ksyWLV3uGX1o9ExlCglLPwXDLS/RoydzWwo0g+kLlSQg3Roo06OzfOpK0Yi4tsOT0RRqFxYxihiUXkkVM8RIpbn5pkMVMJ7cYhBpL1nuBjjgDVbzqqJy3QuUsYlNtS+63T3DBSyOJ6FaT+cjqqFX2fP4E8U170Et1SaJModWzTRmOjkbDo+HRaMjqOmJe+HC8k5GbhBJR0/0mTt5WGA6c0co1sRgNBvfz1VVXIzIDV6UpOjetpFy+eE6Ons5Dc0zl9LwAmGKYFIvRraEQ/s+TeTw8Go7CH4loA37iHxKzYRoNRkeHw8Hh4Ifr4ev4+Mf41eveYDD4lUVsUcpNibOM++BlVyPd78pk30BPvU/WFmeGngvpthm6/q9DyR4/VJRXukRfCJXDHJWHudUqj8BI5A7B2yXwnAsFknu0/2KRorXaPh2m51m23bNCSaHwpuvIm+PB4Ga4DsLw8c7k0iLPloAL4bz7tu4+ZsPTjg23HHt137EzNeNSZAHQrvUdqm/r07Z636i/X76iIQr3bMfZ7fPGSYdpZYVfsni8YotDbsRhcx+PJ/UkYlQxmoDUaBcs5r5gMevv46pDO0PrgpjKShazwnvj4n7fcZUletHTBhVhuOSJo1HU50b0ZzRO9jm4Mc+gxurweQzO81yo/GmuySY0V5S+JkM7AVrniRvxCy47WI93qCImqGwK5BnakCuqig+bLeS0y+06fd3UXw/9h+b4eozvwCxpm+pgWpvzC4PqSuQqVMxsyPZ3tU8oU10irTi+QOjIv/7+Z+DoNqtQ0C8+q8/qorJg9BzttJLAVQZTiQuRSAz0WIa79ZbnkJftjieUx9zSEpWJXHguw0ZH0yjlhidCCuoDItPNfrfVSq4Hnwr0BYbV7zuLwCHDGUpqH+CV1yX3JKqzF+ba3k1p34yAQ1I5odA5QFVwlRJhl9wItAWuAJVHa6xwCM5bslo0tmnlLU2RkiueI8mOdqKUoRRU+WB1UjkPTssqmAwEHtpiBp1DCjFzPQri6cLQFdBpqktjsaA6nCHklcjQRZDqDMGFfJMLKoMEnQdDtogUHQmtlNTpXcgbrTxgNE0hwSXo6Y6NxO4tV44QvrGly8E6YMZq2p2wMfDg4KNDyvC5UHcuPjj4rA5hvC6mT5g44XHyfddT8/n8Xi+93OV5J/zPVQIf0GgnvLbLDXcufFElof+2hax/NJLeocJQP1v9tZGR6dTdb2c67RcoTf8KPVWI659cnoXB/RK+/vYHnCO3Cgo9b6o1rSzKJeSdKopck/kmbOu5G54hvPIFRTxtiq99W1AEafPYnRW7bWdxipaCHxK5UWdEK37cmQlk/T9xM+xr7ZwmkGlnCjfizb6cABZoS3cxvUI7Eym2Y/ORDPcDcZ9FTIoUldueYifvLs9hBke9AYu2BvDfyHb//Ozt6furU7KGOquJ2LA36A3C+qqdL7naUrX71twfcasNPP/HL9MWLjwufN9ILgI4h9CsWlwd771XJxErCHfjMVutEu7wo5V1TcdfKrQE2pOIzbgVPKFpP57UUQc1BMR3uGz3IFT+8JrUE7msGtTa21QIKRuOkzRF45+k3V4NLi+urlnEkvZNXeqMeCyf03ubz1nMwrM8TMXwIqazFZNc5RXPA+QFmYSO1FK70HoXoLX9IK+6K7XcsnAXcxs36D859SDDatXAdl2v6ZurRznawHbUlL5JXdd/AbpS8Y4=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"}}');var n=o(74848),s=o(28453),c=o(33617),r=o.n(c),i=o(17543),l=o.n(i),p=o(86013),d=o.n(p),m=o(63723),u=o.n(m),f=(o(18766),o(79329),o(9303));const x={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV2lu3DYUvsoL/7Qx5NnspKh+xQ2M1KgRG7GDAJ0MDEp6I9GmSIakZsFAQH/0Br1Bj5aTFI+SZvOCGi1SFDAMDfn27XtcMc9zx+Ixe6uV56l3bBKxDF1qhfFCKxaz6wLhrUXuEVoiOLk8Ay6lnjtY6gq8BpxOtfUSnZNLSBtqhXNIW7HgC+4h5QqInztwIldoHUy1JRkWRGm09Vx5yHRalai867GIaYOWkyVnGYtZI7kVyiJm8UuFzv+ksyWLV3uGX1o9ExlCglLPwXDLS/RoydzWwo0g+kLlSQg3Roo06OzfOpK0Yi4tsOT0RRqFxYxihiUXkkVM8RIpbn5pkMVMJ7cYhBpL1nuBjjgDVbzqqJy3QuUsYlNtS+63T3DBSyOJ6FaT+cjqqFX2fP4E8U170Et1SaJModWzTRmOjkbDo+HRaMjqOmJe+HC8k5GbhBJR0/0mTt5WGA6c0co1sRgNBvfz1VVXIzIDV6UpOjetpFy+eE6Ons5Dc0zl9LwAmGKYFIvRraEQ/s+TeTw8Go7CH4loA37iHxKzYRoNRkeHw8Hh4Ifr4ev4+Mf41eveYDD4lUVsUcpNibOM++BlVyPd78pk30BPvU/WFmeGngvpthm6/q9DyR4/VJRXukRfCJXDHJWHudUqj8BI5A7B2yXwnAsFknu0/2KRorXaPh2m51m23bNCSaHwpuvIm+PB4Ga4DsLw8c7k0iLPloAL4bz7tu4+ZsPTjg23HHt137EzNeNSZAHQrvUdqm/r07Z636i/X76iIQr3bMfZ7fPGSYdpZYVfsni8YotDbsRhcx+PJ/UkYlQxmoDUaBcs5r5gMevv46pDO0PrgpjKShazwnvj4n7fcZUletHTBhVhuOSJo1HU50b0ZzRO9jm4Mc+gxurweQzO81yo/GmuySY0V5S+JkM7AVrniRvxCy47WI93qCImqGwK5BnakCuqig+bLeS0y+06fd3UXw/9h+b4eozvwCxpm+pgWpvzC4PqSuQqVMxsyPZ3tU8oU10irTi+QOjIv/7+Z+DoNqtQ0C8+q8/qorJg9BzttJLAVQZTiQuRSAz0WIa79ZbnkJftjieUx9zSEpWJXHguw0ZH0yjlhidCCuoDItPNfrfVSq4Hnwr0BYbV7zuLwCHDGUpqH+CV1yX3JKqzF+ba3k1p34yAQ1I5odA5QFVwlRJhl9wItAWuAJVHa6xwCM5bslo0tmnlLU2RkiueI8mOdqKUoRRU+WB1UjkPTssqmAwEHtpiBp1DCjFzPQri6cLQFdBpqktjsaA6nCHklcjQRZDqDMGFfJMLKoMEnQdDtogUHQmtlNTpXcgbrTxgNE0hwSXo6Y6NxO4tV44QvrGly8E6YMZq2p2wMfDg4KNDyvC5UHcuPjj4rA5hvC6mT5g44XHyfddT8/n8Xi+93OV5J/zPVQIf0GgnvLbLDXcufFElof+2hax/NJLeocJQP1v9tZGR6dTdb2c67RcoTf8KPVWI659cnoXB/RK+/vYHnCO3Cgo9b6o1rSzKJeSdKopck/kmbOu5G54hvPIFRTxtiq99W1AEafPYnRW7bWdxipaCHxK5UWdEK37cmQlk/T9xM+xr7ZwmkGlnCjfizb6cABZoS3cxvUI7Eym2Y/ORDPcDcZ9FTIoUldueYifvLs9hBke9AYu2BvDfyHb//Ozt6furU7KGOquJ2LA36A3C+qqdL7naUrX71twfcasNPP/HL9MWLjwufN9ILgI4h9CsWlwd771XJxErCHfjMVutEu7wo5V1TcdfKrQE2pOIzbgVPKFpP57UUQc1BMR3uGz3IFT+8JrUE7msGtTa21QIKRuOkzRF45+k3V4NLi+urlnEkvZNXeqMeCyf03ubz1nMwrM8TMXwIqazFZNc5RXPA+QFmYSO1FK70HoXoLX9IK+6K7XcsnAXcxs36D859SDDatXAdl2v6ZurRznawHbUlL5JXdd/AbpS8Y4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},I=[];function h(t){const e={p:"p",...(0,s.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,n.jsx)(r(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,n.jsx)(e.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,n.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(l(),{parameters:void 0}),"\n",(0,n.jsx)(d(),{title:"Body",body:{description:"Provide below parameter to create contact",content:{"application/json":{schema:{required:["email","name"],type:"object",properties:{name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"1232131321"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function C(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,n.jsx)(e,{...t,children:(0,n.jsx)(h,{...t})}):h(t)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.ec40bb7e.js b/assets/js/8a725248.ec40bb7e.js deleted file mode 100644 index ae6a65e37..000000000 --- a/assets/js/8a725248.ec40bb7e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8672],{96752:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>j,default:()=>x,frontMatter:()=>y,metadata:()=>n,toc:()=>g});const n=JSON.parse('{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/createcontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createcontact","permalink":"/docs/API-docs/createcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar_label":"Create Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV+tq5DYUfpWz+tMuOHNJslvqX5tulyW0NKFJWWh2CMf2GVuJLGkleS4M869P0kfrk5Qj23PLhQbKlkIIHuncb9/RSgQsvUhvxHujA+bBi0kiCvK5kzZIo0UqriuC944wEHREcHZ5DqiUmXtYmgaCAZpOjQuKvFdLyFtqTXPIO7EQKgyQowbmRw9elpqch6lxLMOBrK1xAXWAwuRNTTr4gUiEseSQLTkvRCpayZ1QkQhHXxry4QdTLEW6OjD80pmZLAgyUmYOFh3WFMixuZ2FW0H8RTqwELRWyTzqHN55lrQSPq+oRv5ijdJRwTGjGqUSidBYE8ctLC2JVJjsjqJQ69j6IMkzZ6RKVz2VD07qUiRialyNYfeEFlhbxUR3hs0nsU46ZS/nz4jedQeD3NQsylZGv9iU8fHJ8fhkfHI8Fut1IoIM8XgvI7cZJ2LN99s4BddQPPDWaN/G4ng0epivvrpakQX4Js/J+2mj1PLVS3L0fB7aYy6nlwXAVuOsWhzfWQ7h/zyZp+OT8XH8YxFdwM/CY2K2TMej45Oj8eho9N31+G16+n365u1gNBr9LhKxqNW2xEWBIXrZ10j/u7HFV9CzPiTrirOggFL5XYa+/9exZE8fK8orU1OopC5hTjrA3BldJmAVoScIbglYotSgMJD7F4uUnDPu+TC9zLLdnpVaSU23fUfeno5Gt+NNEMZPdyYqR1gsgRbSB/913X3KhucdG+849uahY+d6hkoWEdCuzT3pr+vTrvrQqn9YvrIlivdiz9nd89ZJT3njZFiK9GYlFkdo5VF7n95M1pNEcMUYBlJrfLQYQyVSMTzEVU9uRs5HMY1TIhVVCNanw6FHXWRmMTCWNGO4wszzKBqilcMZj5NDDrT2BdTUHL2MwQcspS6f55psQ3PF6WsztBegTZ7Qyp9o2cN6ukeVCMllUxEW5GKuuCp+3W4hH/rcbtLXT/3N0H9sjm/G+B7MsrapiaZ1Ob+wpK9kqWPFzMbicFf7RCo3NfGKEyqCnvyvP/6MHP1mFQv6FVw0DqyZk5s2ClAXMFW0kJmiRxY8T1h3653UgUrH+1MhSxlQxWWOB1GOFjOpJLcAk5l2tdvpIj+ATxWFiuLW940jQChoRoo7B5Qx9ywnGMAmmDrq6GyGuXH3UzYpAYSs8VKT9+CJehbSFeqcoM90AsYBaiAdyFknPQHKmol56aTpVOaSBXPZOx4tNWosiZUlwHZzFGy7RHpwJmt8AG9UEx1hjTVRaF3URIUfwI9yRq3jfNgiDhVQNiwigdwUBF3e2Q1dQEY+gGX1Mqco1Ad0ARTNyMXKjpnkJQis4bkkUYGZ7uWWBQWH2jPmtwb1qdmEzzrD21TUUeByAJ/1Z80YAo0nLgAl9b1PP+sjuNmU2SfKvAw0+bbvtvl8/qDLXu/zfJShajJwZM2Wr4yHsSd32Tc/XjO477fjfmU7mpJjb2KMStIUKxCtbCcn3JxdnscRDhUpu9XMLA8HA58OmXB4RSFIXfphz/86rkTdKOQ53rUtWvnuUE6cx+RqfzG9IjeTOXWT6YlQDSPxUCRCyZy03x0UZx8vf4YZnAxGItmZcf8geMOfz99/+OXqA1vDY7uN2HgwGozihmh8qFHvqNp/zh1OkdUWAf/jx183kQMtwtAqlBH/YmhWHXTdHDwJJ4moGNrSG7FaZejpN6fWaz7+0pBjXJwkYoZOYsYD9WayTvppzlh3T8tu1SAdjq5ZPZOrpgWGg2WAwajlOMtzsuFZ2l30vby4uhaJyLpna20K5nE45yctzkUq4ss3zpn46OSzlVCoywbLiCpRJgMQNhyHXfS6j+jVfbBX/ZVe7li4D2utG/yfnXqUYbVqkXG93tC3V09ydIHtqTl9k/V6/TemwbTF","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"}}');var o=a(74848),s=a(28453),r=a(33617),i=a.n(r),c=a(17543),p=a.n(c),l=a(86013),d=a.n(l),m=a(63723),u=a.n(m),h=(a(18766),a(79329),a(9303));const y={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+tq5DYUfpWz+tMuOHNJslvqX5tulyW0NKFJWWh2CMf2GVuJLGkleS4M869P0kfrk5Qj23PLhQbKlkIIHuncb9/RSgQsvUhvxHujA+bBi0kiCvK5kzZIo0UqriuC944wEHREcHZ5DqiUmXtYmgaCAZpOjQuKvFdLyFtqTXPIO7EQKgyQowbmRw9elpqch6lxLMOBrK1xAXWAwuRNTTr4gUiEseSQLTkvRCpayZ1QkQhHXxry4QdTLEW6OjD80pmZLAgyUmYOFh3WFMixuZ2FW0H8RTqwELRWyTzqHN55lrQSPq+oRv5ijdJRwTGjGqUSidBYE8ctLC2JVJjsjqJQ69j6IMkzZ6RKVz2VD07qUiRialyNYfeEFlhbxUR3hs0nsU46ZS/nz4jedQeD3NQsylZGv9iU8fHJ8fhkfHI8Fut1IoIM8XgvI7cZJ2LN99s4BddQPPDWaN/G4ng0epivvrpakQX4Js/J+2mj1PLVS3L0fB7aYy6nlwXAVuOsWhzfWQ7h/zyZp+OT8XH8YxFdwM/CY2K2TMej45Oj8eho9N31+G16+n365u1gNBr9LhKxqNW2xEWBIXrZ10j/u7HFV9CzPiTrirOggFL5XYa+/9exZE8fK8orU1OopC5hTjrA3BldJmAVoScIbglYotSgMJD7F4uUnDPu+TC9zLLdnpVaSU23fUfeno5Gt+NNEMZPdyYqR1gsgRbSB/913X3KhucdG+849uahY+d6hkoWEdCuzT3pr+vTrvrQqn9YvrIlivdiz9nd89ZJT3njZFiK9GYlFkdo5VF7n95M1pNEcMUYBlJrfLQYQyVSMTzEVU9uRs5HMY1TIhVVCNanw6FHXWRmMTCWNGO4wszzKBqilcMZj5NDDrT2BdTUHL2MwQcspS6f55psQ3PF6WsztBegTZ7Qyp9o2cN6ukeVCMllUxEW5GKuuCp+3W4hH/rcbtLXT/3N0H9sjm/G+B7MsrapiaZ1Ob+wpK9kqWPFzMbicFf7RCo3NfGKEyqCnvyvP/6MHP1mFQv6FVw0DqyZk5s2ClAXMFW0kJmiRxY8T1h3653UgUrH+1MhSxlQxWWOB1GOFjOpJLcAk5l2tdvpIj+ATxWFiuLW940jQChoRoo7B5Qx9ywnGMAmmDrq6GyGuXH3UzYpAYSs8VKT9+CJehbSFeqcoM90AsYBaiAdyFknPQHKmol56aTpVOaSBXPZOx4tNWosiZUlwHZzFGy7RHpwJmt8AG9UEx1hjTVRaF3URIUfwI9yRq3jfNgiDhVQNiwigdwUBF3e2Q1dQEY+gGX1Mqco1Ad0ARTNyMXKjpnkJQis4bkkUYGZ7uWWBQWH2jPmtwb1qdmEzzrD21TUUeByAJ/1Z80YAo0nLgAl9b1PP+sjuNmU2SfKvAw0+bbvtvl8/qDLXu/zfJShajJwZM2Wr4yHsSd32Tc/XjO477fjfmU7mpJjb2KMStIUKxCtbCcn3JxdnscRDhUpu9XMLA8HA58OmXB4RSFIXfphz/86rkTdKOQ53rUtWvnuUE6cx+RqfzG9IjeTOXWT6YlQDSPxUCRCyZy03x0UZx8vf4YZnAxGItmZcf8geMOfz99/+OXqA1vDY7uN2HgwGozihmh8qFHvqNp/zh1OkdUWAf/jx183kQMtwtAqlBH/YmhWHXTdHDwJJ4moGNrSG7FaZejpN6fWaz7+0pBjXJwkYoZOYsYD9WayTvppzlh3T8tu1SAdjq5ZPZOrpgWGg2WAwajlOMtzsuFZ2l30vby4uhaJyLpna20K5nE45yctzkUq4ss3zpn46OSzlVCoywbLiCpRJgMQNhyHXfS6j+jVfbBX/ZVe7li4D2utG/yfnXqUYbVqkXG93tC3V09ydIHtqTl9k/V6/TemwbTF",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,f={},g=[];function T(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(i(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(p(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{title:"Body",body:{description:"Provide below parameter to create contact",content:{"application/json":{schema:{required:["email","name"],type:"object",properties:{name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"1232131321"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a855f99.b5c8d3ca.js b/assets/js/8a855f99.b5c8d3ca.js new file mode 100644 index 000000000..865cdadd5 --- /dev/null +++ b/assets/js/8a855f99.b5c8d3ca.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9180],{31752:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>j,metadata:()=>n,toc:()=>I});const n=JSON.parse('{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/updatefolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/updatefolder","permalink":"/docs/API-docs/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oE8l4cJ231VDdwEzdGYsQ2AtRZGJQ0KzGmSIakdr1YCOhD/6B/0E/LlxRDrna1Xseo0aYvvpAzozNnhnPIJfO8dCy9ZL9oWaBlk4QV6HIrjBdasZSdVwgXpuAeIZrA4ekxcCn13MFCN+A1NDrsT+O+4jUCdzBHKem34RaVj87HxYAlTBu0nOIfFyxlTYgenVnCDLe8Ro+WYC0ZRWMpi9tXomAJE4TLcF+x22B19glzf1yAnsI6oMXPjbBYsNTbBhPm/EJSSCdqI5ElDG+M1AWydMqlI4O8wpqzdMn8wgRLb4UqWcKm2tbc91fwhocoKcvejPNpsV+ZjLXtJH4Wnf9ZFwsKtQ301OqZKBAylHoO65SJzNzihkyWsFwrj8pTDG6MFHlgbvjJUaBlD+wmz8sVXYG7SdKlEdkhii1VwAt05Bdt3waeH5aywnmHsw2F69X5obFY2ybMCy971c6Iu7alHYvOaOUi4v3RaJdS1+Q5OjdtJKz76yH03U9S11kPTev1tdv/1eD82BBFsdWLQ39XmI3T/mj/2d54tDf6/nz8Ij34MX3+YjAajX5jCbupJfmuTgVFYz3e4v+9BaGkUHjVsXe1PxpdjccrTg/uovFM1+groUqYo/Iwt1qVCRiJ3CF4uwBecqFAco/20X/HL1qr7f2sPAzZfSwcEAtrEg52SegmmfYw1Y0KQ+tbJ3pfF+3iuT+9g6sf1uk9303vWM24FEWY5F5fo/p/C3nH5wnqdmuLaBT22Vay/fWYpMO8scIvgmDc7HEj9uJ+ejmhUUx9o0lqTBMAk3SkbBhZHS7X2tIyimVnnfY0VrKUVd4blw6Hjqsi0zcDbVA5USrJMzfIdT3kRgxnY9Ymtz24MQ+wxmbvYQ7O81Ko8n6vyYaeMyphrNIWSetacSPe4IIlXQ36VivZrZCHcd8mjDrj/Ubkjrr6bitKXyR2NYJRaYWa6oBiVeJ3BtWZKFVokNl4R+U/oMx1jSSWvkLozL/88VfwKHTe1Kh86N9HH9VH9a6xYPQcLYkDVwVMJd6ITGKwxzrsrW8zDnkt0Tm5AKE8lpbkuBCl8FwCcUwjKOeGZ0IKansy0+RtoXdy3AA+VOgrtLT1nUXgUOAMJZ0W4I3XNfcUqsMLc22vp3SvSoBD1jih0DlAVXGVk2FXxwS0Ba4AlUdrrHAIzltCLSI2rbzluYeaK14ixU62WCpQCmpysDprnAenZRMgg+dCaosFdAkpxMINiMQjuiVZBFrNdW0sVtRyM4SyEQW6BHJdILjQBZSCKiBD58EQFpGjC1dFJXV+Heo2baQEo2noCC7pytbHSO7ecuVoLkYsXQ3WhBmrSfIxAnz69MIhVfhEqGuXPn36Ue3B5bqZPmDmhMfJ4+74zOfznWPzZNvnlfCvmwzeo9FOeG0XG+9S+KrJwlHrB1n/EyO9QoWhf3pHaROj0LnbPbm0OqxQmuEZeuoQNzw8PT4n1yfw5fc/4QS5VVDpeezWvLEoF1B2nyLmYuUjbesxC1MdGq8ixvPYfKtbKjFIt4vtsbB97CxO0RL5oZCbzxmxCn/ZwQRC/2/SpKlAXczzoEdYcyHjfPrpdpygDWhr9256hnYmclxNyK9UeBiMhyxhUuSoHPY05/DV6QnM4NlgxJLerP0H1R6eHL88ent2RGjoZEXGxoPRYBSuxtr5mqvep7aeVLcn3HIjxt/k/bUa9x5v/NBILoLAhnyXK3HsXhAsYenm6TVJWKWdp+3lMuMOL6xsW1r+3KAl+Z0kbMat4BkN8sslK4Sjv4v12+qreT5+v3q+PIE7X3F3Yu50S5FozbhswksiYde42HoztpM26aSLYMX9l/Hje+cUZeO/c/sh5Y0eh3mOxt9r279unF6cs4RlqxdgHd6YzPI5PUr5PELVgYsgymFtySRXZcNLso0hSWzp2G4r9XVQ6tUflNSdZGxLeMyCflJOdzosl/EW0LZr+7j1VY8Vr501VWbStu3foFS4vQ==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/deletefolder"}}');var r=o(74848),d=o(28453),s=o(33617),a=o.n(s),l=o(17543),p=o.n(l),i=o(86013),c=o.n(i),m=o(63723),f=o.n(m),u=(o(18766),o(79329),o(9303));const j={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oE8l4cJ231VDdwEzdGYsQ2AtRZGJQ0KzGmSIakdr1YCOhD/6B/0E/LlxRDrna1Xseo0aYvvpAzozNnhnPIJfO8dCy9ZL9oWaBlk4QV6HIrjBdasZSdVwgXpuAeIZrA4ekxcCn13MFCN+A1NDrsT+O+4jUCdzBHKem34RaVj87HxYAlTBu0nOIfFyxlTYgenVnCDLe8Ro+WYC0ZRWMpi9tXomAJE4TLcF+x22B19glzf1yAnsI6oMXPjbBYsNTbBhPm/EJSSCdqI5ElDG+M1AWydMqlI4O8wpqzdMn8wgRLb4UqWcKm2tbc91fwhocoKcvejPNpsV+ZjLXtJH4Wnf9ZFwsKtQ301OqZKBAylHoO65SJzNzihkyWsFwrj8pTDG6MFHlgbvjJUaBlD+wmz8sVXYG7SdKlEdkhii1VwAt05Bdt3waeH5aywnmHsw2F69X5obFY2ybMCy971c6Iu7alHYvOaOUi4v3RaJdS1+Q5OjdtJKz76yH03U9S11kPTev1tdv/1eD82BBFsdWLQ39XmI3T/mj/2d54tDf6/nz8Ij34MX3+YjAajX5jCbupJfmuTgVFYz3e4v+9BaGkUHjVsXe1PxpdjccrTg/uovFM1+groUqYo/Iwt1qVCRiJ3CF4uwBecqFAco/20X/HL1qr7f2sPAzZfSwcEAtrEg52SegmmfYw1Y0KQ+tbJ3pfF+3iuT+9g6sf1uk9303vWM24FEWY5F5fo/p/C3nH5wnqdmuLaBT22Vay/fWYpMO8scIvgmDc7HEj9uJ+ejmhUUx9o0lqTBMAk3SkbBhZHS7X2tIyimVnnfY0VrKUVd4blw6Hjqsi0zcDbVA5USrJMzfIdT3kRgxnY9Ymtz24MQ+wxmbvYQ7O81Ko8n6vyYaeMyphrNIWSetacSPe4IIlXQ36VivZrZCHcd8mjDrj/Ubkjrr6bitKXyR2NYJRaYWa6oBiVeJ3BtWZKFVokNl4R+U/oMx1jSSWvkLozL/88VfwKHTe1Kh86N9HH9VH9a6xYPQcLYkDVwVMJd6ITGKwxzrsrW8zDnkt0Tm5AKE8lpbkuBCl8FwCcUwjKOeGZ0IKansy0+RtoXdy3AA+VOgrtLT1nUXgUOAMJZ0W4I3XNfcUqsMLc22vp3SvSoBD1jih0DlAVXGVk2FXxwS0Ba4AlUdrrHAIzltCLSI2rbzluYeaK14ixU62WCpQCmpysDprnAenZRMgg+dCaosFdAkpxMINiMQjuiVZBFrNdW0sVtRyM4SyEQW6BHJdILjQBZSCKiBD58EQFpGjC1dFJXV+Heo2baQEo2noCC7pytbHSO7ecuVoLkYsXQ3WhBmrSfIxAnz69MIhVfhEqGuXPn36Ue3B5bqZPmDmhMfJ4+74zOfznWPzZNvnlfCvmwzeo9FOeG0XG+9S+KrJwlHrB1n/EyO9QoWhf3pHaROj0LnbPbm0OqxQmuEZeuoQNzw8PT4n1yfw5fc/4QS5VVDpeezWvLEoF1B2nyLmYuUjbesxC1MdGq8ixvPYfKtbKjFIt4vtsbB97CxO0RL5oZCbzxmxCn/ZwQRC/2/SpKlAXczzoEdYcyHjfPrpdpygDWhr9256hnYmclxNyK9UeBiMhyxhUuSoHPY05/DV6QnM4NlgxJLerP0H1R6eHL88ent2RGjoZEXGxoPRYBSuxtr5mqvep7aeVLcn3HIjxt/k/bUa9x5v/NBILoLAhnyXK3HsXhAsYenm6TVJWKWdp+3lMuMOL6xsW1r+3KAl+Z0kbMat4BkN8sslK4Sjv4v12+qreT5+v3q+PIE7X3F3Yu50S5FozbhswksiYde42HoztpM26aSLYMX9l/Hje+cUZeO/c/sh5Y0eh3mOxt9r279unF6cs4RlqxdgHd6YzPI5PUr5PELVgYsgymFtySRXZcNLso0hSWzp2G4r9XVQ6tUflNSdZGxLeMyCflJOdzosl/EW0LZr+7j1VY8Vr501VWbStu3foFS4vQ==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,y={},I=[];function h(e){const t={p:"p",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,r.jsx)(a(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,r.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(p(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,r.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,r.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a855f99.d1b9f1c1.js b/assets/js/8a855f99.d1b9f1c1.js deleted file mode 100644 index d55814e71..000000000 --- a/assets/js/8a855f99.d1b9f1c1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9180],{31752:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>C,default:()=>F,frontMatter:()=>b,metadata:()=>r,toc:()=>g});const r=JSON.parse('{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/updatefolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/updatefolder","permalink":"/docs/API-docs/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V21v2zYQ/itXflkDKH5J027Tp2Vd13ktmqBJUWCpEVDSSWZDkSxJ2TEMfdsv2U/bLxmOtGw5doMFWPclkcm7491zLw+5Yp5XjqXX7FctC7RsmrACXW6F8UIrlrKrGcIHU3CPEEXg7GICXEq9cLDUDXgNjQ77ZdxXvEbgDhYoJf033KLyUXlSDFjCtEHLyf6kYClrgvWozBJmuOU1erTk1oqRNZayuH0jCpYwQX4Z7mfsvrM6+4y5nxSgS9gYtPilERYLlnrbYMKcX0oy6URtJLKE4Z2RukCWllw6EshnWHOWrphfmiDprVAVS1ipbc19fwXveLCSsuzNOC+Lk5nJWNtO47Ho/M+6WJKpXUcvrJ6LAiFDqRewCZnAzC1uwWQJy7XyqDzZ4MZIkQfkhp8dGVr1nN3Geb2GK2A3TbowIjoEsaUMeIGO9KLsu4Dz40JWuOj8bEPienl+rC3WtgnzwstetjPCrm1px6IzWrno8clotA+pa/IcnSsbCZv6egx8D4PUVdZjw/rt1p38bnAxMQRRLPXizB8ys1U6GZ08Ox6PjkffX41fpKc/ps9fDEaj0R8sYXe1JN11V5A11sMt/u4tCCWFwpsOvZuT0ehmPF5jenoIxktdo58JVcEClYeF1apKwEjkDsHbJfCKCwWSe7RP/jt80VptH0blcZ49hMIpobAB4XQfhG6SaQ+lblQYWt860IeqaN+fh8M7vflhE97z/fAmas6lKMIk9/oW1f+byAPHk6u7pS2iUNhnO8H212OQDvPGCr8MhHF3zI04jvvp9ZRGMdWNJqoxTXCYqCNlw4jqcLXhlpaRLTvvuKexkqVs5r1x6XDouCoyfTfQBpUTlZI8c4Nc10NuxHA+Zm1yX4Mb8whpbI4fp+A8r4SqHtaabuG5pBTGLO2AtMkVN+INLlnS5aAvtabdGfIw7tuEUWW835Lcqy6/u4zSJ4l9jmCUWqFKHbxYp/jcoLoUlQoFMh/vsfxHlLmukcjSzxA68b///CtoFDpvalQ+1O8TOG8sGL1AS8zAVQGlxDuRSTxwkXHIa4nOySUI5bGyxMSFqITnEghemj45NzwTUlDFk5gmbQu9pnED+DhDP0NLW99ZBA4FzlFSo4DU+pbseA288boOZ6x9hoW2tyW5lACHrHFCoXPgEDsVVDOucoQuqQloC1wBKo/WWOEQuKhJuNQWsCxFLsgwtbfluYeaK14hHZYA+U0omHgdcWB11jgPTssmBEIn1og+hqgQCzeAX8QcY+C0WKDnQmIBVUMmEsh1gbDudgpDFZCh82DoeJFjMOo8tx4kztGGIg6ZLBspwWgaQ4JLusT1c0uGvOXK0aSMDnWp2cBnrKZLQDij4MsBfFKfFBEHNA6pAKRQty79pI7helNmHzFzwuP0addYi8Vir6GOdnVeCz9rMrBo9FavCouh/frqmx9HROC7nbdb2RZLtBRNwKhChaECuRFxUML12cXkKnzNUJrtyaSyPwNodUiCw0v0XqjKDTv9I2o8qgmeh5GPNRcyjoCf7tsJ4xdt7c7LS7RzkeN6CH0FqmEQHrKESZGjctgb62evL97CHJ4NRizpjbN/Ad7w7eTlq3eXr8gbmtARsfFgNBiF26d2vuaqd9TOq+X+EFlt+e6bPHHWE9XjnR8ayUXgsBDvas0/3SWdJSzdvm6mCZtp52l7tcq4ww9Wti0tf2nQEsNNEzbnVvCMZuX1ihXC0Xexeb58Nc6n79cvhCM4+FA66HNHDYp4Yc5lEy7rCbvF5c6zrJ22SccO5FbcfxkPP74iK1v9vQsGkVvUOMtzNP5B2T6jX3y4YgnL1o+sOjzjmOULevfxRXRVBywC74W1FZNcVQ2vSDaaJD7jDaWlT4a3gQzXHxTUQTB2WTJGQX8ppoMKq1Uk2rbdyMetr2qsce2kKTPTtm3/Aagde/Q=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/deletefolder"}}');var s=o(74848),a=o(28453),l=o(33617),n=o.n(l),p=o(17543),d=o.n(p),i=o(86013),c=o.n(i),u=o(63723),f=o.n(u),m=(o(18766),o(79329),o(9303));const b={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/itXflkDKH5J027Tp2Vd13ktmqBJUWCpEVDSSWZDkSxJ2TEMfdsv2U/bLxmOtGw5doMFWPclkcm7491zLw+5Yp5XjqXX7FctC7RsmrACXW6F8UIrlrKrGcIHU3CPEEXg7GICXEq9cLDUDXgNjQ77ZdxXvEbgDhYoJf033KLyUXlSDFjCtEHLyf6kYClrgvWozBJmuOU1erTk1oqRNZayuH0jCpYwQX4Z7mfsvrM6+4y5nxSgS9gYtPilERYLlnrbYMKcX0oy6URtJLKE4Z2RukCWllw6EshnWHOWrphfmiDprVAVS1ipbc19fwXveLCSsuzNOC+Lk5nJWNtO47Ho/M+6WJKpXUcvrJ6LAiFDqRewCZnAzC1uwWQJy7XyqDzZ4MZIkQfkhp8dGVr1nN3Geb2GK2A3TbowIjoEsaUMeIGO9KLsu4Dz40JWuOj8bEPienl+rC3WtgnzwstetjPCrm1px6IzWrno8clotA+pa/IcnSsbCZv6egx8D4PUVdZjw/rt1p38bnAxMQRRLPXizB8ys1U6GZ08Ox6PjkffX41fpKc/ps9fDEaj0R8sYXe1JN11V5A11sMt/u4tCCWFwpsOvZuT0ehmPF5jenoIxktdo58JVcEClYeF1apKwEjkDsHbJfCKCwWSe7RP/jt80VptH0blcZ49hMIpobAB4XQfhG6SaQ+lblQYWt860IeqaN+fh8M7vflhE97z/fAmas6lKMIk9/oW1f+byAPHk6u7pS2iUNhnO8H212OQDvPGCr8MhHF3zI04jvvp9ZRGMdWNJqoxTXCYqCNlw4jqcLXhlpaRLTvvuKexkqVs5r1x6XDouCoyfTfQBpUTlZI8c4Nc10NuxHA+Zm1yX4Mb8whpbI4fp+A8r4SqHtaabuG5pBTGLO2AtMkVN+INLlnS5aAvtabdGfIw7tuEUWW835Lcqy6/u4zSJ4l9jmCUWqFKHbxYp/jcoLoUlQoFMh/vsfxHlLmukcjSzxA68b///CtoFDpvalQ+1O8TOG8sGL1AS8zAVQGlxDuRSTxwkXHIa4nOySUI5bGyxMSFqITnEghemj45NzwTUlDFk5gmbQu9pnED+DhDP0NLW99ZBA4FzlFSo4DU+pbseA288boOZ6x9hoW2tyW5lACHrHFCoXPgEDsVVDOucoQuqQloC1wBKo/WWOEQuKhJuNQWsCxFLsgwtbfluYeaK14hHZYA+U0omHgdcWB11jgPTssmBEIn1og+hqgQCzeAX8QcY+C0WKDnQmIBVUMmEsh1gbDudgpDFZCh82DoeJFjMOo8tx4kztGGIg6ZLBspwWgaQ4JLusT1c0uGvOXK0aSMDnWp2cBnrKZLQDij4MsBfFKfFBEHNA6pAKRQty79pI7helNmHzFzwuP0addYi8Vir6GOdnVeCz9rMrBo9FavCouh/frqmx9HROC7nbdb2RZLtBRNwKhChaECuRFxUML12cXkKnzNUJrtyaSyPwNodUiCw0v0XqjKDTv9I2o8qgmeh5GPNRcyjoCf7tsJ4xdt7c7LS7RzkeN6CH0FqmEQHrKESZGjctgb62evL97CHJ4NRizpjbN/Ad7w7eTlq3eXr8gbmtARsfFgNBiF26d2vuaqd9TOq+X+EFlt+e6bPHHWE9XjnR8ayUXgsBDvas0/3SWdJSzdvm6mCZtp52l7tcq4ww9Wti0tf2nQEsNNEzbnVvCMZuX1ihXC0Xexeb58Nc6n79cvhCM4+FA66HNHDYp4Yc5lEy7rCbvF5c6zrJ22SccO5FbcfxkPP74iK1v9vQsGkVvUOMtzNP5B2T6jX3y4YgnL1o+sOjzjmOULevfxRXRVBywC74W1FZNcVQ2vSDaaJD7jDaWlT4a3gQzXHxTUQTB2WTJGQX8ppoMKq1Uk2rbdyMetr2qsce2kKTPTtm3/Aagde/Q=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},C=void 0,h={},g=[];function j(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,s.jsx)(n(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,s.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function F(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.504ac772.js b/assets/js/a2bc1463.504ac772.js deleted file mode 100644 index cfbbb53ec..000000000 --- a/assets/js/a2bc1463.504ac772.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1381],{47091:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>f,contentTitle:()=>g,default:()=>v,frontMatter:()=>x,metadata:()=>a,toc:()=>D});const a=JSON.parse('{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/contactlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/contactlist","permalink":"/docs/API-docs/contactlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar_label":"Get Contact list","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV+tu2zYUfpVT/tkKKLacph3mXw26IghWrAWSocBSoziSjiXGFMmSlC8w9K9PskfbkwyHkm05abplKIoBQRIdnuvHc+NWBCy9mN6IV0YHzIMXs0QU5HMnbZBGi6m4rgj6U3gjfYDzd5dAtTUrch42poFgwFFwkpYECIp5zBzyXmMC1pmlLKQuASE3tXVUkfZySbCUtGJeVApwiVJhpmgvCVKzfrcjZMYsRiIRxpJD9u6yEFPRH7JZkQiLDmsK5DiqrdBYk5gKJWvJp5ID+tSQ24hEOPrUSEeFmM5ReUqEDxvF3HPjapEIWltlChLT4Bo+zSuqUUy3osa1rJtaTJ+naSLCxrKQbuqMnGhZDmvLiiZpm+xd8Atpv5kHD9tM2xnr9dZoT555T9OU/xxfqm/ynLyfNwr2aIokYkk6MD9aq2QeD8a3noW29x0w2S3lEXbHaoLsTDryjQoDPnQOOWAZqPb/LN+R+Xb3nD44qUuRRGgwDCn72IWtJlm1Pr21DEmH++MU3BqCjCgiWqNU/0E+I3rZE0a5qVmVrYx+tCtnk2eT0/jDKnJHGKg4D19ScxA6TU+fnUzSk/Sn68mL6dnP0+cvRmma/iESsa5jNH02FhhilEEGNfxubPEd7LR32foaLiigVH4o0J+Ith0QpVZS08ddmn/kFG8jx9mXkv3K1BQq7j8r0gFWzugyAasIPUFwG8ASpQaFgdyTb1cF5JxxX8fxcZ59DYKzNP042YPw/D4Il3qJShaxe1+bBenvG+nQfOjM308D2THFc3EU7JDeBekpb5wMm9jm1ydo5Ul3Pr2ZcQ9kYA3Ph5K6uRAqMRXj42nhyS13o6JxSkxFFYL10/HYoy4ysx4Zy6Oq1Aozz/U8RivHS67JuxJo7SO4qTl5nIAPWEpdfl1qdsDliu+uu54jdA492cpfiZtyD/6Qq59TFWHB86Xl77mJwv2VvLWkr2Sp44UuJ+Lu1vCeVG5q4t0gVAQ79r8+/xklCpM3NekQ8+0JvG0cxIWCBxLqAuaK1pJ3AWZGpcxqv2p4wlqR92oDUgcqHQaCQpYyoAJGhcspR4uZVJIzlNlMt0gMktyP4H1FoSLHRz84Xl0KWpLixAZlzIL1BAPYBFNHG73PsDJuMWeXEkDIGi81eQ+eaCdCukKdE+zuIgHjADWQDuSsk54AZc3Mc+OA5nOZS1bMyel4z6pRY0lsLAH2m1Hotijy4EzW+ADeqCYGwhZrotCFqIkKP4JfeL2KgTOxa6xUQNmwigRyUxD01clh6AIy8gEsm5c5RaU+oAugaEku5l68yXmjFFjDbUOi4uVteLesKDjUnkdb59DuavbwWWd494g2CtyM4IP+oLkTQuOJE0BJvfDTD/oEbvZp9p4yLwPNftzVw2q1ulcHT49lLmSomgwcWXOQKyMxVs1QfP/xlGfYccEcZ7ajOTmOJmJUkqaYgWhl19jg5vzdZeywUJGyB8sscr90mTpmxvEVhSB16cc7+adx8vcDkNtst5Jw5b68qye2S3K1fzu/IreUOfW94wGoxpF5LBKhZE7a06ANn1+8ewNLeDZKRTLoQv8CvPGby1evf7t6zd5wY+0Qm4zSURoXIeNDjXpg6oLC/nHR9+QjtLeHEfU/fIj0nTTQOoytQhmHVgRs2w+cm6PnySwRlfGBydtthp5+d6ptmdy9CHgMFdKz7cObYEGbwQtmiaphm3FCPMDbPzUOrDP+cJJ543hMdp2dDXYy53lOdmjg3j5wNFQvXl+LRGDDMQ4nyiJOlP4f1r470puB7uNR0znAvzmmLwpst920ats9f3f0oEQf4I6br2bWtu3faIYtTg==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"}}');var n=o(74848),i=o(28453),s=o(33617),c=o.n(s),l=o(17543),p=o.n(l),r=o(86013),m=o.n(r),d=o(63723),u=o.n(d),y=(o(18766),o(79329),o(9303));const x={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV+tu2zYUfpVT/tkKKLacph3mXw26IghWrAWSocBSoziSjiXGFMmSlC8w9K9PskfbkwyHkm05abplKIoBQRIdnuvHc+NWBCy9mN6IV0YHzIMXs0QU5HMnbZBGi6m4rgj6U3gjfYDzd5dAtTUrch42poFgwFFwkpYECIp5zBzyXmMC1pmlLKQuASE3tXVUkfZySbCUtGJeVApwiVJhpmgvCVKzfrcjZMYsRiIRxpJD9u6yEFPRH7JZkQiLDmsK5DiqrdBYk5gKJWvJp5ID+tSQ24hEOPrUSEeFmM5ReUqEDxvF3HPjapEIWltlChLT4Bo+zSuqUUy3osa1rJtaTJ+naSLCxrKQbuqMnGhZDmvLiiZpm+xd8Atpv5kHD9tM2xnr9dZoT555T9OU/xxfqm/ynLyfNwr2aIokYkk6MD9aq2QeD8a3noW29x0w2S3lEXbHaoLsTDryjQoDPnQOOWAZqPb/LN+R+Xb3nD44qUuRRGgwDCn72IWtJlm1Pr21DEmH++MU3BqCjCgiWqNU/0E+I3rZE0a5qVmVrYx+tCtnk2eT0/jDKnJHGKg4D19ScxA6TU+fnUzSk/Sn68mL6dnP0+cvRmma/iESsa5jNH02FhhilEEGNfxubPEd7LR32foaLiigVH4o0J+Ith0QpVZS08ddmn/kFG8jx9mXkv3K1BQq7j8r0gFWzugyAasIPUFwG8ASpQaFgdyTb1cF5JxxX8fxcZ59DYKzNP042YPw/D4Il3qJShaxe1+bBenvG+nQfOjM308D2THFc3EU7JDeBekpb5wMm9jm1ydo5Ul3Pr2ZcQ9kYA3Ph5K6uRAqMRXj42nhyS13o6JxSkxFFYL10/HYoy4ysx4Zy6Oq1Aozz/U8RivHS67JuxJo7SO4qTl5nIAPWEpdfl1qdsDliu+uu54jdA492cpfiZtyD/6Qq59TFWHB86Xl77mJwv2VvLWkr2Sp44UuJ+Lu1vCeVG5q4t0gVAQ79r8+/xklCpM3NekQ8+0JvG0cxIWCBxLqAuaK1pJ3AWZGpcxqv2p4wlqR92oDUgcqHQaCQpYyoAJGhcspR4uZVJIzlNlMt0gMktyP4H1FoSLHRz84Xl0KWpLixAZlzIL1BAPYBFNHG73PsDJuMWeXEkDIGi81eQ+eaCdCukKdE+zuIgHjADWQDuSsk54AZc3Mc+OA5nOZS1bMyel4z6pRY0lsLAH2m1Hotijy4EzW+ADeqCYGwhZrotCFqIkKP4JfeL2KgTOxa6xUQNmwigRyUxD01clh6AIy8gEsm5c5RaU+oAugaEku5l68yXmjFFjDbUOi4uVteLesKDjUnkdb59DuavbwWWd494g2CtyM4IP+oLkTQuOJE0BJvfDTD/oEbvZp9p4yLwPNftzVw2q1ulcHT49lLmSomgwcWXOQKyMxVs1QfP/xlGfYccEcZ7ajOTmOJmJUkqaYgWhl19jg5vzdZeywUJGyB8sscr90mTpmxvEVhSB16cc7+adx8vcDkNtst5Jw5b68qye2S3K1fzu/IreUOfW94wGoxpF5LBKhZE7a06ANn1+8ewNLeDZKRTLoQv8CvPGby1evf7t6zd5wY+0Qm4zSURoXIeNDjXpg6oLC/nHR9+QjtLeHEfU/fIj0nTTQOoytQhmHVgRs2w+cm6PnySwRlfGBydtthp5+d6ptmdy9CHgMFdKz7cObYEGbwQtmiaphm3FCPMDbPzUOrDP+cJJ543hMdp2dDXYy53lOdmjg3j5wNFQvXl+LRGDDMQ4nyiJOlP4f1r470puB7uNR0znAvzmmLwpst920ats9f3f0oEQf4I6br2bWtu3faIYtTg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,f={},D=[];function h(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,n.jsx)(c(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,n.jsx)(e.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,n.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(p(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,n.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,n.jsx)(e,{...t,children:(0,n.jsx)(h,{...t})}):h(t)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.b30f8ee5.js b/assets/js/a2bc1463.b30f8ee5.js new file mode 100644 index 000000000..a1f7dfd72 --- /dev/null +++ b/assets/js/a2bc1463.b30f8ee5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1381],{47091:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>v,frontMatter:()=>b,metadata:()=>n,toc:()=>g});const n=JSON.parse('{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/contactlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/contactlist","permalink":"/docs/API-docs/contactlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar_label":"Get Contact list","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV+tu2zYUfpVT/tkaKLacph2mXw2KIAsWrEWTosBSo6CkY4kxRbIk5QsMAfuxN9gb7NH6JMOhJFvOpVu2ohgQJBF5rt+5csM8LxxLrtkrrTzPvGPTiOXoMiuMF1qxhF2VCN0tXAjn4eTNOWBl9BKtg7WuwWuw6K3ABQIHSTR6BlknMQJj9ULkQhXAIdOVsViicmKBsBC4JFouJfAFF5KnErecIBTJt/1BqvV8xCKmDVpO1p3nLGHdJallETPc8go9WvJqwxSvkCVMikrQrSCHPtVo1yxiFj/VwmLOkhmXDiPm/FoS9UzbikUMV0bqHFnibU23WYkVZ8mGVXwlqrpiyfM4jphfG2JSdZWiZQ3x8cqQoEncRFsT3FyYr2bBwzrjZkpyndHKoSPaozimP/tBdXWWoXOzWsIWTRYFLFF5oufGSJGFi/GNI6bNXQN0eoNZgN2SGC9alRZdLf2AjlvLyWHhsXJ/z98eU3S3lM5boQoWBWi4H55sfWemnKTl6ujGECQt7o8TcKMRUsSAaMWF/Bf8KeLL7mCU6YpEmVKrR5tyPHk2OQo/JCKzyD3mJ/4+MTumo/jo2eEkPox/uJq8SI5/TJ6/GMVx/CuL2KoK3nTZmHMfvPTCy+F3bfJvoKe5TdbVcI6eC+mGDN0Na5rBoVBSKPzYp/lHSvEmUBzfl+yXukJfUv9ZovKwtFoVERiJ3CF4uwZecKFAco/2yderArRW2y/j+DjLvgTBcRx/nGxBeH4XhHO14FLkoXtf6Tmqb+vpUL1v1d9NA9EShXu25+zwvHXSYVZb4dehza8OuRGH7X1yPaUeSMBqmg8FtnPBlyxh4/1p4dAu+lFRW8kSVnpvXDIeO67yVK9G2tCoKpTkqaN6HnMjxguqydsc3JhHUGN9+DgG53khVPFlrukOl0uKXRuePXR2PdmIn5Gacgf+kKqbUyXynOZLQ98zHZi7kLw2qC5FoUJAFxN2e2t4jzLTFdJu4EuEnvzz738GjlxndYXKh3x78kF9UK9rC2GnoJnEVQ4ziStB68B9+4ZDXkl0Tq5BKI+F5R4hF4XwXAJBQzWVccNTIQWlKZHpdpsYZLobwfsSfYmWrr6ztL/kuEBJ2Q289rrinkT19sJS2/lM6qWLgENaO6HQOUBVcpURYQ9/BNoCV4DKozVWOATnLVktWtu08pZWqoorXiDJjvZQylEKyk2wOq2dB6dlHUwG6pHaYg69QwoxdyMC8ZQWBovQLk3DTauoRY4ugkznCC5UJbmgckjReTBki8jQkdBaSZ3NQ9xmtZRgNDUJwSWtakMbid1brhwNstaWPgZbwIzVtGlga+DBwTuHFOELoeYuOTj4oA7heptM7zF1wuP0+z7rl8vlnWx/us9zJvxPdQpv0WgnvLbrHXchfFmnoUKGQrYfraQzVBjyZ1ABOxm5ztzdgqPTcYnSjC/RU4a48cmb89BXn8Ln3/6AC+RWQamXbbZmtUW5hqJXRci1kW9h27ZFmOmQeCUhnrXJR2siOk8I0oDdr+b9srM4Q0vgh0Du1BnRib/uzQSy/r+4GdaSbjrTDGj3JWorL2/LCb0cbeVezy7RLkSGXWN7IMLjQDxmEZMiQ+VwMCNOzt5cwAKejWIWDVrkP4j2+OL81ekvl6dkDVVWi9hkFI/isKVp5yuuBqrO0G9fPt3A2EN7s5uf/8NXUtfmPa782EguwkQNgG26aXi993aaRqzUztPxZpNyh++sbBo6bp8rNCNz4Uj37sEyx/XgebXgsiadYXw9QNu9g3akU/qwgmjD7I76sUMKW56TLEMzVHBnWdmb+GenVyxiVET7424exl33D0nvr9R6IHt/DrYG0G/y6V6GzaYdpU2zpW+vHuToHOypKTTTpmn+AjCWahc=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"}}');var i=o(74848),a=o(28453),s=o(33617),r=o.n(s),c=o(17543),l=o.n(c),p=o(86013),d=o.n(p),m=o(63723),u=o.n(m),k=(o(18766),o(79329),o(9303));const b={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV+tu2zYUfpVT/tkaKLacph2mXw2KIAsWrEWTosBSo6CkY4kxRbIk5QsMAfuxN9gb7NH6JMOhJFvOpVu2ohgQJBF5rt+5csM8LxxLrtkrrTzPvGPTiOXoMiuMF1qxhF2VCN0tXAjn4eTNOWBl9BKtg7WuwWuw6K3ABQIHSTR6BlknMQJj9ULkQhXAIdOVsViicmKBsBC4JFouJfAFF5KnErecIBTJt/1BqvV8xCKmDVpO1p3nLGHdJallETPc8go9WvJqwxSvkCVMikrQrSCHPtVo1yxiFj/VwmLOkhmXDiPm/FoS9UzbikUMV0bqHFnibU23WYkVZ8mGVXwlqrpiyfM4jphfG2JSdZWiZQ3x8cqQoEncRFsT3FyYr2bBwzrjZkpyndHKoSPaozimP/tBdXWWoXOzWsIWTRYFLFF5oufGSJGFi/GNI6bNXQN0eoNZgN2SGC9alRZdLf2AjlvLyWHhsXJ/z98eU3S3lM5boQoWBWi4H55sfWemnKTl6ujGECQt7o8TcKMRUsSAaMWF/Bf8KeLL7mCU6YpEmVKrR5tyPHk2OQo/JCKzyD3mJ/4+MTumo/jo2eEkPox/uJq8SI5/TJ6/GMVx/CuL2KoK3nTZmHMfvPTCy+F3bfJvoKe5TdbVcI6eC+mGDN0Na5rBoVBSKPzYp/lHSvEmUBzfl+yXukJfUv9ZovKwtFoVERiJ3CF4uwZecKFAco/2yderArRW2y/j+DjLvgTBcRx/nGxBeH4XhHO14FLkoXtf6Tmqb+vpUL1v1d9NA9EShXu25+zwvHXSYVZb4dehza8OuRGH7X1yPaUeSMBqmg8FtnPBlyxh4/1p4dAu+lFRW8kSVnpvXDIeO67yVK9G2tCoKpTkqaN6HnMjxguqydsc3JhHUGN9+DgG53khVPFlrukOl0uKXRuePXR2PdmIn5Gacgf+kKqbUyXynOZLQ98zHZi7kLw2qC5FoUJAFxN2e2t4jzLTFdJu4EuEnvzz738GjlxndYXKh3x78kF9UK9rC2GnoJnEVQ4ziStB68B9+4ZDXkl0Tq5BKI+F5R4hF4XwXAJBQzWVccNTIQWlKZHpdpsYZLobwfsSfYmWrr6ztL/kuEBJ2Q289rrinkT19sJS2/lM6qWLgENaO6HQOUBVcpURYQ9/BNoCV4DKozVWOATnLVktWtu08pZWqoorXiDJjvZQylEKyk2wOq2dB6dlHUwG6pHaYg69QwoxdyMC8ZQWBovQLk3DTauoRY4ugkznCC5UJbmgckjReTBki8jQkdBaSZ3NQ9xmtZRgNDUJwSWtakMbid1brhwNstaWPgZbwIzVtGlga+DBwTuHFOELoeYuOTj4oA7heptM7zF1wuP0+z7rl8vlnWx/us9zJvxPdQpv0WgnvLbrHXchfFmnoUKGQrYfraQzVBjyZ1ABOxm5ztzdgqPTcYnSjC/RU4a48cmb89BXn8Ln3/6AC+RWQamXbbZmtUW5hqJXRci1kW9h27ZFmOmQeCUhnrXJR2siOk8I0oDdr+b9srM4Q0vgh0Du1BnRib/uzQSy/r+4GdaSbjrTDGj3JWorL2/LCb0cbeVezy7RLkSGXWN7IMLjQDxmEZMiQ+VwMCNOzt5cwAKejWIWDVrkP4j2+OL81ekvl6dkDVVWi9hkFI/isKVp5yuuBqrO0G9fPt3A2EN7s5uf/8NXUtfmPa782EguwkQNgG26aXi993aaRqzUztPxZpNyh++sbBo6bp8rNCNz4Uj37sEyx/XgebXgsiadYXw9QNu9g3akU/qwgmjD7I76sUMKW56TLEMzVHBnWdmb+GenVyxiVET7424exl33D0nvr9R6IHt/DrYG0G/y6V6GzaYdpU2zpW+vHuToHOypKTTTpmn+AjCWahc=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,y={},g=[];function x(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,i.jsx)(k.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.168a453c.js b/assets/js/a88a3db3.168a453c.js deleted file mode 100644 index d98b0c57e..000000000 --- a/assets/js/a88a3db3.168a453c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3605],{29993:(e,t,l)=>{l.r(t),l.d(t,{assets:()=>y,contentTitle:()=>w,default:()=>x,frontMatter:()=>A,metadata:()=>a,toc:()=>j});const a=JSON.parse('{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/delete-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/delete-template","permalink":"/docs/API-docs/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tu20YQ/ZXJvjQGaEl2nBTlU93aSIUGTVC7CFBHMFbkkNx4ubvdHeoCgW/9kn5av6SYpairY9RAEfRFEpdzn9lzRitBsgwivRO3WDstCYOYJCLHkHnlSFkjUnFbIVyhRkLopeDywxictzOVY4ClbWCuqAKqEORUaUVLIAseaztDkBAcZqpQGVCvX3hbR/H+JAxgXIDcSqgAxoK2pkQPBjHHXCTCOvSS4xrnIhV5jKoPSiTCSS9rJPSc00oYWaNIRW/zXrEJxTk5SZU4THR8BbbYiwqokhS9B05oitC5ZDse/2iUx1yk5BtMRKClZm9B1U5zMLhw2uYo0kLqwAJZhbUU6UrQ0kVJ8sqUIhGF9bWk7UnbTth+cNYEDKxxPhrx10Fj+ijXQUFosgxDKBqtly9EIjJrCA2xpnROqyyWbvg5sPrqOCA7/YwZcR09F5pU57w75oofh44LGdNNxQ+L6lwG95N7Jdpk3Zr8kp5WOh+dvzo9G52Ovr09e5NefJe+fjMYjUa/i0Qsas266x7m3OA2EaRIb5/bI7Hodk9wfdKy8MVjZbyxNVKlTAlzNARzb02ZgNMoAwL5JchSKgNcaf8fVhW9t/7p6jwvsnYna2W0Mnjfz9D9xWh0f7YpwsUTs2QsQWEbk3/dVB/z/3RCF/dvNgm9Pk5obGZSqzwi1a19QPN189l1T53742lVnVB8L/aS3T3vkgyYNV7RMgLb4lQ6ddq9T+8mDBc8KXYLihEMqRKpGPZgNlztAGEr2KSf9VDZeC1SURG5kA6HQZp8ahcD69AEVRotp2GQ2XoonRrOzkSbHGpI554hjc3p8xQCyVKZ8mmtybZKN9zJrll7tdq0TDr1My5F0rdiV2rNERXKHH1smzKFjcrrBr13aG5UaWJ7Z2dHTPIRdWZrZM5gOunF//7zr6iR26yp0VCcvhfwvvHg7Bx90WiQJodC40JNdUezUms770iWLASUtcYQ9BKUISx9xH9VKpIauCqMFpl0HQ0rDCxmWdvDzsiHAXyskCr0/Oobzyyd4ww1jzloax/YDlmQDdk6+ljHDHPrHwoOKQEJ0yYogyFAQOxV0FTSZAh9LxKwHqQBNITeeRUQpKpZuLAesChUptgwX04vM4JaGlkiO0uA495bNrydNoEgWN3ERNhjjUhdipGqB3ClZtglzoc5klQacygbNpFAZnOE9V3lNEwOUwwEjt2rDKPRQNITaJyhj7MXO8nUCs4yiCipeV3Y7S0bIi9NYELvAupbsymf85Y5OvrI5XIAn8wnw0APTUAeAK3MQ0g/mVO424zZR5wGRTh52d+H+Xx+dA9O9nXeKqqaKXh0dqtXxsN4a3bVNw8nTLz7F2Z/sj0W6DmbWKMSDcYJlE51MAd3lx/GEW+hQu22nlnl+Ory6ZAFhzdIpEwZhr3+CSMiz4TMImBjLZXubu73h3YieKKvw/viBv1MZbjGji+UahiFhyIRWmVoAu6A8uXbD+9gBq8GI5HsoNC/KN7w3fjH619urjkaBtauYmeD0WDER84GqqXZcXWwVR/CyGrLV/+rJXwNoYQLGjotVeSuWKnVmnTuNju3SES6u39PElHZQCyyWk1lwN+8bls+/qNBz+w2ScRMeiWnjLR3K5GrwL/zzR79xRq9/HW9kp/A81b5RxPqicIwS8ykbvhJJOIBlwf/KdpJm/RswRF3EpdZho52dI82jj3avrp+d317LRIhG67gLlE9RKJa/2AHj4a2z2BdDPzJZPqowmrVkWDbbuS7V1/UWOfYS3OdJm3b/gNQMfyA","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/gettemplatelist"}}');var i=l(74848),o=l(28453),p=l(33617),n=l.n(p),s=l(17543),d=l.n(s),r=l(86013),m=l.n(r),c=l(63723),h=l.n(c),b=(l(18766),l(79329),l(9303));const A={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tu20YQ/ZXJvjQGaEl2nBTlU93aSIUGTVC7CFBHMFbkkNx4ubvdHeoCgW/9kn5av6SYpairY9RAEfRFEpdzn9lzRitBsgwivRO3WDstCYOYJCLHkHnlSFkjUnFbIVyhRkLopeDywxictzOVY4ClbWCuqAKqEORUaUVLIAseaztDkBAcZqpQGVCvX3hbR/H+JAxgXIDcSqgAxoK2pkQPBjHHXCTCOvSS4xrnIhV5jKoPSiTCSS9rJPSc00oYWaNIRW/zXrEJxTk5SZU4THR8BbbYiwqokhS9B05oitC5ZDse/2iUx1yk5BtMRKClZm9B1U5zMLhw2uYo0kLqwAJZhbUU6UrQ0kVJ8sqUIhGF9bWk7UnbTth+cNYEDKxxPhrx10Fj+ijXQUFosgxDKBqtly9EIjJrCA2xpnROqyyWbvg5sPrqOCA7/YwZcR09F5pU57w75oofh44LGdNNxQ+L6lwG95N7Jdpk3Zr8kp5WOh+dvzo9G52Ovr09e5NefJe+fjMYjUa/i0Qsas266x7m3OA2EaRIb5/bI7Hodk9wfdKy8MVjZbyxNVKlTAlzNARzb02ZgNMoAwL5JchSKgNcaf8fVhW9t/7p6jwvsnYna2W0Mnjfz9D9xWh0f7YpwsUTs2QsQWEbk3/dVB/z/3RCF/dvNgm9Pk5obGZSqzwi1a19QPN189l1T53742lVnVB8L/aS3T3vkgyYNV7RMgLb4lQ6ddq9T+8mDBc8KXYLihEMqRKpGPZgNlztAGEr2KSf9VDZeC1SURG5kA6HQZp8ahcD69AEVRotp2GQ2XoonRrOzkSbHGpI554hjc3p8xQCyVKZ8mmtybZKN9zJrll7tdq0TDr1My5F0rdiV2rNERXKHH1smzKFjcrrBr13aG5UaWJ7Z2dHTPIRdWZrZM5gOunF//7zr6iR26yp0VCcvhfwvvHg7Bx90WiQJodC40JNdUezUms770iWLASUtcYQ9BKUISx9xH9VKpIauCqMFpl0HQ0rDCxmWdvDzsiHAXyskCr0/Oobzyyd4ww1jzloax/YDlmQDdk6+ljHDHPrHwoOKQEJ0yYogyFAQOxV0FTSZAh9LxKwHqQBNITeeRUQpKpZuLAesChUptgwX04vM4JaGlkiO0uA495bNrydNoEgWN3ERNhjjUhdipGqB3ClZtglzoc5klQacygbNpFAZnOE9V3lNEwOUwwEjt2rDKPRQNITaJyhj7MXO8nUCs4yiCipeV3Y7S0bIi9NYELvAupbsymf85Y5OvrI5XIAn8wnw0APTUAeAK3MQ0g/mVO424zZR5wGRTh52d+H+Xx+dA9O9nXeKqqaKXh0dqtXxsN4a3bVNw8nTLz7F2Z/sj0W6DmbWKMSDcYJlE51MAd3lx/GEW+hQu22nlnl+Ory6ZAFhzdIpEwZhr3+CSMiz4TMImBjLZXubu73h3YieKKvw/viBv1MZbjGji+UahiFhyIRWmVoAu6A8uXbD+9gBq8GI5HsoNC/KN7w3fjH619urjkaBtauYmeD0WDER84GqqXZcXWwVR/CyGrLV/+rJXwNoYQLGjotVeSuWKnVmnTuNju3SES6u39PElHZQCyyWk1lwN+8bls+/qNBz+w2ScRMeiWnjLR3K5GrwL/zzR79xRq9/HW9kp/A81b5RxPqicIwS8ykbvhJJOIBlwf/KdpJm/RswRF3EpdZho52dI82jj3avrp+d317LRIhG67gLlE9RKJa/2AHj4a2z2BdDPzJZPqowmrVkWDbbuS7V1/UWOfYS3OdJm3b/gNQMfyA",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},w=void 0,y={},j=[];function R(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,i.jsx)(n(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,i.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(R,{...e})}):R(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.b00e16a9.js b/assets/js/a88a3db3.b00e16a9.js new file mode 100644 index 000000000..504bd7736 --- /dev/null +++ b/assets/js/a88a3db3.b00e16a9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3605],{29993:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>I,contentTitle:()=>b,default:()=>j,frontMatter:()=>f,metadata:()=>l,toc:()=>D});const l=JSON.parse('{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/delete-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/delete-template","permalink":"/docs/API-docs/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tu3DYQ/ZUJX5oE8u7acVJUT3UbIzFqNEHsIECdhcGVRhJjimTI0V6wENCH/kH/oJ+WLymGWu3F6xg1WgR9sVfUDOfMmeEcailIlkGkV+ISa6clYRDjROQYMq8cKWtEKi4rhJeokRB6Kzh5ewbO26nKMcDCNjBTVAFVCHKitKIFkAWPtZ0iSAgOM1WoDKj3L7yto3m/EgZwVoDcWKgAxoK2pkQPBjHHXCTCOvSScZ3lIhV5RNWDEolw0ssaCT3ntBRG1ihS0e95rXgLxTk5SZW4nejZS7DFDiqgSlKMHjihCUIXkvfx+LlRHnORkm8wEYEWmqMFVTvNYHDutM1RpIXUgQ2yCmsp0qWghYuW5JUpRSIK62tJm5W2HfP+wVkTMLDH0WjE/24Vpke5AgWhyTIMoWi0XjwSicisITTEntI5rbJI3fBTYPflPiA7+YQZMY+eiSbVBe+WmfF96DiXMd1U/DSvjmRwr90z0Sar0uQndL/T0ejo2cHh6GD0/eXhi/T4h/T5i8FoNPpNJGJea/Zd1TDnAreJIEV689zumcWwO4arlZaNj++i8cLWSJUyJczQEMy8NWUCTqMMCOQXIEupDDDT/j9kFb23/n52Hoas3cpaGa0MXvc9dH08Gl0frkk4vqeXjCUobGPyb5vqXfHvT+j4+sU6oef7CZ2ZqdQqj5Pq0t6g+bb5bIenLvx+t6rOKL4XO8lur3dJBswar2gRB9v8QDp10L1Pr8Y8LrhT7GYoxmFIlUjFsB9mw+XWIGwFb+mn/ahsvBapqIhcSIfDIE0+sfOBdWiCKo2WkzDIbD2UTg2nh6JNbntI5x5gjc3BwxwCyVKZ8n6v8YalC65kV6wdrtYlk079gguR9KXYtlppRIUyRx/Lpkxho/OqQG8cmgtVmlje6eGeknxAndkaWTNYTnrzL3/8FT1ymzU1Gord9+ij+WjeNB6cnaEvGg3S5FBonKuJ7pQW6/iuU1qyEFDWGkPQC1CGsPRRBFSpSGpganhkZNJ1WqwwsJllbw9bfR8G8KFCqtDzq+88S3WOU9Tc6yAbsrUk3qrHCzPrbwptZyEBCZMmKIMhAJpKmowNe/oTsB6kATSE3nkVEAJ5Rq06bNaQlxlBLY0skfdOdljKUSvuTfB20gSCYHUTIQNJpa3HHPqEojoPmMRTFlyPwKuZrZ3HijtlilA2fFFJILM5QohnlFMwOUwwEDjGojKMIt8YbbObWDcWUnCWR4aSmi8H2xjZnbw0geW7w9LXYE2Y85YVGTuAT5++D8gVPlfmJqRPn340B3C1bqYPOAmKcPy47/rZbLbX7U92fV4pet1M4B06GxRZv9h4l4qqZhJPyPYm64dup1doMPbP1gnY7JHbLOwfOF4dVqjd8AKJOyQMT96exSn7BL78/ieco/QGKjvrujVrPOoFlH0oZq6rfEfbekhCYWPjVcx41jUf37MwEDPIt4Ld07x77DwW6Jn8WMhNOKdW21/1MIHR/5s0eVxzF8ssqgnWUulurPx4e5842dHX4U1xgX6qMlwNtq9UeBiNhyIRWmVoAm4pxsmrt+cwhWeDkUi2RuQ/qPbw/Ozn018vThkNn6yOscPBaDDiJWcD1dJshbp15b8945YbMf1ffSGs5jvhnIZOSxWFNTK1XCni1fqDQCQi3f44GCeisoHYZLmcyIDvvW5bXv7coGfpHSdiKr2SE5aBq6XIVeDf+fqS/1WOHr9bfS88gYd9Z9yZUK9ihiVsKnXDTyIRN7i49cHTjtuklzJG3FmcZBk62vLduw7t3Clenp6fXp6KRPDZ3FXRm6iiqx8c4E5ou/LaYeC/rPR3OiyXnUK37dq+e/VVj1WOvTXzNG7b9m+mEzlY","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/gettemplatelist"}}');var n=i(74848),a=i(28453),o=i(33617),s=i.n(o),p=i(17543),r=i.n(p),d=i(86013),m=i.n(d),c=i(63723),h=i.n(c),T=(i(18766),i(79329),i(9303));const f={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tu3DYQ/ZUJX5oE8u7acVJUT3UbIzFqNEHsIECdhcGVRhJjimTI0V6wENCH/kH/oJ+WLymGWu3F6xg1WgR9sVfUDOfMmeEcailIlkGkV+ISa6clYRDjROQYMq8cKWtEKi4rhJeokRB6Kzh5ewbO26nKMcDCNjBTVAFVCHKitKIFkAWPtZ0iSAgOM1WoDKj3L7yto3m/EgZwVoDcWKgAxoK2pkQPBjHHXCTCOvSScZ3lIhV5RNWDEolw0ssaCT3ntBRG1ihS0e95rXgLxTk5SZW4nejZS7DFDiqgSlKMHjihCUIXkvfx+LlRHnORkm8wEYEWmqMFVTvNYHDutM1RpIXUgQ2yCmsp0qWghYuW5JUpRSIK62tJm5W2HfP+wVkTMLDH0WjE/24Vpke5AgWhyTIMoWi0XjwSicisITTEntI5rbJI3fBTYPflPiA7+YQZMY+eiSbVBe+WmfF96DiXMd1U/DSvjmRwr90z0Sar0uQndL/T0ejo2cHh6GD0/eXhi/T4h/T5i8FoNPpNJGJea/Zd1TDnAreJIEV689zumcWwO4arlZaNj++i8cLWSJUyJczQEMy8NWUCTqMMCOQXIEupDDDT/j9kFb23/n52Hoas3cpaGa0MXvc9dH08Gl0frkk4vqeXjCUobGPyb5vqXfHvT+j4+sU6oef7CZ2ZqdQqj5Pq0t6g+bb5bIenLvx+t6rOKL4XO8lur3dJBswar2gRB9v8QDp10L1Pr8Y8LrhT7GYoxmFIlUjFsB9mw+XWIGwFb+mn/ahsvBapqIhcSIfDIE0+sfOBdWiCKo2WkzDIbD2UTg2nh6JNbntI5x5gjc3BwxwCyVKZ8n6v8YalC65kV6wdrtYlk079gguR9KXYtlppRIUyRx/Lpkxho/OqQG8cmgtVmlje6eGeknxAndkaWTNYTnrzL3/8FT1ymzU1Gord9+ij+WjeNB6cnaEvGg3S5FBonKuJ7pQW6/iuU1qyEFDWGkPQC1CGsPRRBFSpSGpganhkZNJ1WqwwsJllbw9bfR8G8KFCqtDzq+88S3WOU9Tc6yAbsrUk3qrHCzPrbwptZyEBCZMmKIMhAJpKmowNe/oTsB6kATSE3nkVEAJ5Rq06bNaQlxlBLY0skfdOdljKUSvuTfB20gSCYHUTIQNJpa3HHPqEojoPmMRTFlyPwKuZrZ3HijtlilA2fFFJILM5QohnlFMwOUwwEDjGojKMIt8YbbObWDcWUnCWR4aSmi8H2xjZnbw0geW7w9LXYE2Y85YVGTuAT5++D8gVPlfmJqRPn340B3C1bqYPOAmKcPy47/rZbLbX7U92fV4pet1M4B06GxRZv9h4l4qqZhJPyPYm64dup1doMPbP1gnY7JHbLOwfOF4dVqjd8AKJOyQMT96exSn7BL78/ieco/QGKjvrujVrPOoFlH0oZq6rfEfbekhCYWPjVcx41jUf37MwEDPIt4Ld07x77DwW6Jn8WMhNOKdW21/1MIHR/5s0eVxzF8ssqgnWUulurPx4e5842dHX4U1xgX6qMlwNtq9UeBiNhyIRWmVoAm4pxsmrt+cwhWeDkUi2RuQ/qPbw/Ozn018vThkNn6yOscPBaDDiJWcD1dJshbp15b8945YbMf1ffSGs5jvhnIZOSxWFNTK1XCni1fqDQCQi3f44GCeisoHYZLmcyIDvvW5bXv7coGfpHSdiKr2SE5aBq6XIVeDf+fqS/1WOHr9bfS88gYd9Z9yZUK9ihiVsKnXDTyIRN7i49cHTjtuklzJG3FmcZBk62vLduw7t3Clenp6fXp6KRPDZ3FXRm6iiqx8c4E5ou/LaYeC/rPR3OiyXnUK37dq+e/VVj1WOvTXzNG7b9m+mEzlY",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,I={},D=[];function W(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(T.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,n.jsx)(s(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,n.jsx)(T.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(r(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(W,{...e})}):W(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.09056bb0.js b/assets/js/a9f09360.09056bb0.js new file mode 100644 index 000000000..9bdec20d4 --- /dev/null +++ b/assets/js/a9f09360.09056bb0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9lyGzmSv4KpF7cVRUqkZbdXT+O2vT3a9VqKlhwdG5JCDVYlWbCrgGoAxaMVjNiH+YP9g/m0/pKNTAB18BDlY3rUsfSDxcKZSGQm8ryLLJ+Y6OQqeqOSqgBpTXQTRymYRIvSCiWjk+gyA/ZG87FlYRB7dX7KeJ6rmWGVAW2YVWwCEjS3wCTMWBqWY6MFK7WailTICUu55WwmbMY4G3EDL44ZyESlkLKxyKF/La/lpShP2IcyVzxlC1Vpdv7m3+v1cCNsuzo4eAOjasI+nB4c3HyXWVuak8NDXpZ9VYI0YiJzPjL9RBWHKQ4s0/HTmM0y0ICrsoRLBtyIfMF4mrKZSCdgTcxsBpIlqlywRCmdCsktmJiVfAJMVsUItIkZlykrlAYmJONMA08XPat6lQH2Hxdn79lY6YLbPjvPKxPX26VCQ2LzhVveZlCf6okJ2DBWCzmJWcE/Ib6EZb9WIvmExzYgU/yLE1+dnxKuDg4uqrJU2kLKfnZHODk4wJ4fIFczxjXQ+EQVhZKs5JoXYOnCMm6pW8OvldCQ+mvJ84CLk2vZYwcHdlHCycEBO5WpSBAZtCC2MjX2Y/tuKCIJh16UkIix8ENbqGNKslkmkoxwMuPuPsucJw5MDaaExIopdBeex2yBC78BqQIEmdLiNyUtz+k6pqCtSHjevjYEEIcay7VFdJZKSBta/Q7sv/314O3RpXi6QtBSRFYhJPUYYFOeV2A8VLOYZQjVT1BqMETsfl1EpExZBmKSbd2Ppx8rYzsLs8ogmG0o/F7hlgi9QGgb89wAE+MOLgv+CVq7MUVMzPM++2HBUhjzKrcxE0hxVlfQZ++VZbwsc5HwUQ5IuQyZh9tKQ49u2ZODB0Tygu74nHgaDOMsFeMxaGRO7KQl/JwAHdJZIwSIc2zGJVNy5aITlSu9TkLU3MUjS5S0IG2fvZpykRPw7rCGCZnkVQpslPPkU8xGeQUx05A6xl0ACq7Y0TsNYdx4nBN+mIEcqVBJhF8qv70wzHio0j67zIRp+Ak7A6ppE2HaWPVcO1a4M6IgsBiDgos8JsTF7KMaMStsDjEybMnlIkaJCTGzMLcjNY9ZkkHyiX5pngrFRpW1SrqDpVqVqZpJj8uxktaI3zZwZOj5fIwOY3YcsxcxexmzwVHMBsOYDY5jNngRs8HLmA2PYjYcxmx4HLPhCwfW8GUcRH5AcBuAwdBh2f55sIty950wxNkoME0tg2cdGTzos4ODmpuw7ZdffrmWd9eSsesImes6OmHXUT3kOopdH8pM7Bv47zl+PBt+7z8X+Pli+NJ/zmjo4Nh/Zvg5HFzLpd/wWg4JEsuL8h4osPubQuC/PBFhG22KbUGeYSMKojh04F114MGOZfssz/AsQgoreG62HyeMeEQnakBaO9QxHorIdfuJqPsRHacND/aQmHRdJFZbXYHhCYrh2umf9/3Lsv3wbttHc/YWOF939Bd4dBRNlyiatp+/ll6PCAmrMH0dJr7vkwJAknk7HvyAR4SFLkRfh4OXiAN8lLYjAHsf0elb4GCHf+Fd39Fxb/C8NzwaHncwgLaRG1AUvTTtLRaLb4E91Hn89qjyBA3VaXZol461KjaYH2QdNKO8TkS/g8r+X6ioj4IOCynafWRYBI2ltvjaWrZVKV88MW6pMLVWznB8o5otWmBSF8JB1m+SKZF44HFMUMlGaOD1EQc9wuRhmh62MImNadorit5KI372CPGtxqLop2l/ZeTa7bjGgqVpzNabN7anKSuKYkuza7+OSKX6NyR9r4ltp34/4I9igIbOuxvfyxzoD1Ayp73JSNvMHStPSCak7/CkwlYGaJhUOdcwR2vTCCXd6G/POYFxGn2drFMy7Mj2d6hg3515nfypJ2o8QncBbNk9b+1k7UU0TGBOaySVsapAYETKcYWYmSrJ0HrjQfVHvDd+GvpKeCnQS5CDtdQKNulvAsLdWsvCxltdNbAN2M5huGFh5gYbm66fyHtwRM+bNzDued/8iEck4ldAwk7nrsDuq+uo4KQBIJVB81vZDPR1dFPPcVY1pDvm3jyAjzKRQs5HkK93PZgH2mfx9NRCDHYUQtaeAIL3KG518vlKp+tbbuAtd+I2UQchHlgjoJjlwgRfSBdf7dneWUQuPAlAXsERsDABXa6Bc7+WzGvAHkbnTgr4y9mxBY5jNLB21IXdduzQuZg2YnCNQkhRVEXtcRzXqwaUFf41b+MLZ6InO+zQvt21Hfh8xw7o3tu+wbUckGcgeBTu0fX8iEckDFZAup9Pv0RMdN7Ib/S47WbAcKw2A254EnGoewxr5jPbua/PzvABQi+nm4R+qySB0qKP62tZswb5wU8QeYGcZ+sH8mxtp7y2/+sRUd8GsP7JFOjH/TFU2D7en4gSO2A/mBqdH6/gk3uMXep+RPTn4Vm53CiOVImxT6HkaRqdRClGS0NwL4ppZTD2B5UuopO7yDva8ad3Y+PMw48Gw613kUkyKDj+ChBhgBbjo1Eckb8FY7SIpOgkUqOPkOAepUYYrACDM2n0yV0Y5cKKUeyt7+gkcvHGKI5gzosSB0crAdkyHUfLsOF9S9UtzVKGftTxTVwHI3dfuMx7nLpcCUt/0UpvWivQ2Qq4VK8V9ll4wxemta573qPVaDjOQeJP/CyW8oVBfqqM08QSnidVjpY8zEuhF7Vbgcz5FlXU8NY71fAOni9jCguAboPEteaLKI6EhaLdvoUItPr8m0tAIWbIt/u5cz8qGAH81Tdg7J0unhefDcVHBWwEdOllpuRnzx8Mnw2Gg2eDIa7ggzJfjkfXuw5BlzBeoQ0KadDOe00cNWYUy+jvotEwno7NJ7CbGC+3xddbYT2TqSpPMWAGXPcpzP3FGRRd+q7foP4Oal7G0Xz3YeYsUb0QvGff5TC2rCpL0CxRWoJ+2vbgPZrDDY+Pl3G02H28xZ/yeN/j5c12n+5nynpoMkL+FbA+e7mMo2w3rH+r8zL+hcAev1g2r2uUaOAWwuNwO1Lp4jbIreWugeGhwHFjlaegUQtZl1eNqEEJg/lEt6tyfqRUDlxuEDSdgLzP/UJlEPVA78KeZYC6dKMj0uqNWuq1RgctBvlhxcMoDGp/uoLrqM9Oxy0llxwEqzkBYSzF56ViT2i/W1ORGH9y6L8RR0/auU+YjtK47gMINJhZKMqckodmIs8RbnzX+6z+R+pejUkEIDyXYePdT8Vr58mkDf2kbuYN8xpjn73mss6+6GY5sLu7mgyIOpZLdneHtwr6Fh/d5TJuGnCvTgO9q65FQwJi2plVN0EzsW5rTXUqzi2qOK7BR8PaAIiJFHJyW2m/DmqCy2V/jSCb23owBtcQ5m8RF/l/hTsE7FSe6RT0A7j5dOxsN8WeIAE/8Z5ywpHQxnoedSzgQXcBry349pkNaPK9rXneVCODo2RYr+Epq8VkAph16EfQZJ8nBDzJnLQgqPgY2Z0yCTVMhapMAC/jplbDUxwhHAsJOemani3sUBpX++z9TewsMbHo7PL8Abgkw7jnpJOzKt0p3Rrs7PIccxPF2Ft5ffbB1JgIqOWdIQztLzYVPOQv1SrdwvkuQRJGnCjtJJL2fVZgj60DlAqzEaK4iZ7UubxrCzfJq3hFqrKYNSt8SpaxUJoOHgmKGpGXqnoIVe7AJGeTioKvFl/qIC4potPkFgpprK6c35allQ7plJ4scGQCxjR4CljBQa31YwbSuOmcjbmxoGNWSYGY1xW6TeolYV6CFiAT2IgCDQ51yMO75Vo3Ue/DT+98ynI4Q2DKEXKgWxhSVpVENcQJdQJpuLnVo2+UHV6A7QYQH21K8/Qu+xK0UZJheqaecCl+cyRMhogyaMVlPHdDvajA0DXCgxzeBSaoWL///R8tuLaaouuAuR14mmIccQeE5DZzBI/ueg0lSkDVhQjXA/3XVd0PoSOmuS1UWjOSeTiNn2NWsTW1XLSKstAhB5c0H+Katbw1cZCxxluTGN7UFIZEZFtV4nlhLoxtpUCGRIV1+fATIB6TFgxkfSBXI83LRZvBa7h8qmWzHOmFops+W2u/a7zAK6tuNRRCPuydavseraoFQWVVwa1IWFjK9LtJ0Zi53fB1wb4LoCE1ToXST7ewKi53q2QCt0LewhT0A+y693UYiDxBI7AzANmGLSDJPWdN4uoMaw06OGm9TpSe3YbyedsM6HgYnc5EZkLjMfRPGabUK2mcI2N4dIR/uvDXRR3etEDiQ0ExrvJ88Zcofri78n4vSg2t2Gic3OcZyT6K4W/zZDo8R87bIkjvXcAbcpXOsVADJUuvJmJi6BZuhcyFhFtC8W2qklsN5nZ4dHQ7QBwv4+h4ExovVAE2I95DZM60wjqOMgeOBKkXjE+4kAxtC/0NsQpaK32/sfd5kG3ARKCh2+MOEp6vI+FUUjSd6oMu1SeQf+xJ29tbtz2COi+IYNwDFwk3iPqjzmHb7e6QBpJKC7uITq7uonmPl6Ln+k+ubpY3cYSIVejxL5UhiLnNopPocDUAYEBPyZV7defIt6ZIw2WKEe819wIvxeF0EC3j1RkbnRFbR0PV+7wJxvKJkJP7Z900qLnA63M31EFQ42wtxX8Cels9/tuj4kgg2WTA8UFAjCNV/NSES96Guw0hjU1RiuYOV+MOIezQiSSsCvANsYHNoYHB85ZT/ir418llXnvMNznB66MHt3bt1W45qlt+6quGxmuXcPAID8iVOjw+Jp/j9wNyzj17SX6v4xdLosrGBxRFXT8PhbVWvRVR1LW9w6TanvSzGqPIxVg72r1v6mq7YaVau+yoeKsa3lZta4uy5bdcUSpqQDa95RhWEXKsiDw9zZyVIC/Q3kGpMR2sezYhT1RRl5mE4b///R80I9AaQfUXjGyeVZqVagZ6XLlylXEOc4EPPo6Hgvoa5xnwIgdj8gVD62JCJZSpmFDOWtDdE17ykcgFykIcplwwqSVOTZ/93LjfnmiXvjeFHEVorTJhCWZ47mdKfxqjGy/GYkysPEOlGWTGZeL0c8fgpGditSTaPqUWBgvqNEItHGxKWs0Tywou+YQUxbiDpRRydH0YptUIzVej8soZaJaLXGkXNqMDURibwsNv5yV2kVcWLRsNGVLF1FtpJnZWsuNdX5I5QodEibCIBEhZrWSusHoSHRtVnrNSWedsQHWtDSNOt5pLg1qEj9T5O6gR5g0oML4E6IMBvOF3Qn5yFT89dlUT088wMsJC40OezWZr8vRpd86Pwv6tGmE9oTLCKr1oZk+EzaoRyeD2IvWHW+nHUILbkrHNGqlKzAY3tkrMYQZ5eXgBFinEHL46P6XH+yn7/X/+l70DriXL1MxRa1JpyBdNtS/VwtLNO7TVby+Z6LzCglpLRConwWuEGIzi1feiy3YaxkDh0m5xMS+FX/4qgMkQ+q85JmoBSMXc+W6DOOKl2Gj5YUmoORtfgJ6KJGiXW274kAYfRnGUiwSkgZYi8urH83dsyp71j6K49Qg/4LYP352+fvv+4i1Cg5zlMDboH/WPKHaojC24bG3VLd9eFXGtjIR9sfe+2Htf7L0v9t4Xe/95ypH3xd77Yu99sfe+2Htf7L0v9v7nIWFf7L0v9t4Xe++LvffF3vti732x977Ye1/svS/23hd774u9v12p7b7Ye1/svS/2fuyUuC/2Dsk5qBUeljkXspWV6DLArlZKwG/iKMMMsZOr6O4Oo38fsKADm3+tKDHl6iaOplwL9HFTclkckqIwG+gTYFrOa+ey713i9rGjdgpTr+TUYU6Xm/GKbv3ese0ktvOzi8sojkIFTqFSnKP5DEvY+czl83hkUn0xp8LAnMtJRclJkVtz6VJ9s24S2CdKAvM/WjlOXC5aEHazw9wx8H881MYJd3cuwWy5rMe7rq0zPGLDaLy+m+Vy+X+dUQf/","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"}}');var i=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),u=t(63723),h=t.n(u),m=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9lyGzmSv4KpF7cVRUqkZbdXT+O2vT3a9VqKlhwdG5JCDVYlWbCrgGoAxaMVjNiH+YP9g/m0/pKNTAB18BDlY3rUsfSDxcKZSGQm8ryLLJ+Y6OQqeqOSqgBpTXQTRymYRIvSCiWjk+gyA/ZG87FlYRB7dX7KeJ6rmWGVAW2YVWwCEjS3wCTMWBqWY6MFK7WailTICUu55WwmbMY4G3EDL44ZyESlkLKxyKF/La/lpShP2IcyVzxlC1Vpdv7m3+v1cCNsuzo4eAOjasI+nB4c3HyXWVuak8NDXpZ9VYI0YiJzPjL9RBWHKQ4s0/HTmM0y0ICrsoRLBtyIfMF4mrKZSCdgTcxsBpIlqlywRCmdCsktmJiVfAJMVsUItIkZlykrlAYmJONMA08XPat6lQH2Hxdn79lY6YLbPjvPKxPX26VCQ2LzhVveZlCf6okJ2DBWCzmJWcE/Ib6EZb9WIvmExzYgU/yLE1+dnxKuDg4uqrJU2kLKfnZHODk4wJ4fIFczxjXQ+EQVhZKs5JoXYOnCMm6pW8OvldCQ+mvJ84CLk2vZYwcHdlHCycEBO5WpSBAZtCC2MjX2Y/tuKCIJh16UkIix8ENbqGNKslkmkoxwMuPuPsucJw5MDaaExIopdBeex2yBC78BqQIEmdLiNyUtz+k6pqCtSHjevjYEEIcay7VFdJZKSBta/Q7sv/314O3RpXi6QtBSRFYhJPUYYFOeV2A8VLOYZQjVT1BqMETsfl1EpExZBmKSbd2Ppx8rYzsLs8ogmG0o/F7hlgi9QGgb89wAE+MOLgv+CVq7MUVMzPM++2HBUhjzKrcxE0hxVlfQZ++VZbwsc5HwUQ5IuQyZh9tKQ49u2ZODB0Tygu74nHgaDOMsFeMxaGRO7KQl/JwAHdJZIwSIc2zGJVNy5aITlSu9TkLU3MUjS5S0IG2fvZpykRPw7rCGCZnkVQpslPPkU8xGeQUx05A6xl0ACq7Y0TsNYdx4nBN+mIEcqVBJhF8qv70wzHio0j67zIRp+Ak7A6ppE2HaWPVcO1a4M6IgsBiDgos8JsTF7KMaMStsDjEybMnlIkaJCTGzMLcjNY9ZkkHyiX5pngrFRpW1SrqDpVqVqZpJj8uxktaI3zZwZOj5fIwOY3YcsxcxexmzwVHMBsOYDY5jNngRs8HLmA2PYjYcxmx4HLPhCwfW8GUcRH5AcBuAwdBh2f55sIty950wxNkoME0tg2cdGTzos4ODmpuw7ZdffrmWd9eSsesImes6OmHXUT3kOopdH8pM7Bv47zl+PBt+7z8X+Pli+NJ/zmjo4Nh/Zvg5HFzLpd/wWg4JEsuL8h4osPubQuC/PBFhG22KbUGeYSMKojh04F114MGOZfssz/AsQgoreG62HyeMeEQnakBaO9QxHorIdfuJqPsRHacND/aQmHRdJFZbXYHhCYrh2umf9/3Lsv3wbttHc/YWOF939Bd4dBRNlyiatp+/ll6PCAmrMH0dJr7vkwJAknk7HvyAR4SFLkRfh4OXiAN8lLYjAHsf0elb4GCHf+Fd39Fxb/C8NzwaHncwgLaRG1AUvTTtLRaLb4E91Hn89qjyBA3VaXZol461KjaYH2QdNKO8TkS/g8r+X6ioj4IOCynafWRYBI2ltvjaWrZVKV88MW6pMLVWznB8o5otWmBSF8JB1m+SKZF44HFMUMlGaOD1EQc9wuRhmh62MImNadorit5KI372CPGtxqLop2l/ZeTa7bjGgqVpzNabN7anKSuKYkuza7+OSKX6NyR9r4ltp34/4I9igIbOuxvfyxzoD1Ayp73JSNvMHStPSCak7/CkwlYGaJhUOdcwR2vTCCXd6G/POYFxGn2drFMy7Mj2d6hg3515nfypJ2o8QncBbNk9b+1k7UU0TGBOaySVsapAYETKcYWYmSrJ0HrjQfVHvDd+GvpKeCnQS5CDtdQKNulvAsLdWsvCxltdNbAN2M5huGFh5gYbm66fyHtwRM+bNzDued/8iEck4ldAwk7nrsDuq+uo4KQBIJVB81vZDPR1dFPPcVY1pDvm3jyAjzKRQs5HkK93PZgH2mfx9NRCDHYUQtaeAIL3KG518vlKp+tbbuAtd+I2UQchHlgjoJjlwgRfSBdf7dneWUQuPAlAXsERsDABXa6Bc7+WzGvAHkbnTgr4y9mxBY5jNLB21IXdduzQuZg2YnCNQkhRVEXtcRzXqwaUFf41b+MLZ6InO+zQvt21Hfh8xw7o3tu+wbUckGcgeBTu0fX8iEckDFZAup9Pv0RMdN7Ib/S47WbAcKw2A254EnGoewxr5jPbua/PzvABQi+nm4R+qySB0qKP62tZswb5wU8QeYGcZ+sH8mxtp7y2/+sRUd8GsP7JFOjH/TFU2D7en4gSO2A/mBqdH6/gk3uMXep+RPTn4Vm53CiOVImxT6HkaRqdRClGS0NwL4ppZTD2B5UuopO7yDva8ad3Y+PMw48Gw613kUkyKDj+ChBhgBbjo1Eckb8FY7SIpOgkUqOPkOAepUYYrACDM2n0yV0Y5cKKUeyt7+gkcvHGKI5gzosSB0crAdkyHUfLsOF9S9UtzVKGftTxTVwHI3dfuMx7nLpcCUt/0UpvWivQ2Qq4VK8V9ll4wxemta573qPVaDjOQeJP/CyW8oVBfqqM08QSnidVjpY8zEuhF7Vbgcz5FlXU8NY71fAOni9jCguAboPEteaLKI6EhaLdvoUItPr8m0tAIWbIt/u5cz8qGAH81Tdg7J0unhefDcVHBWwEdOllpuRnzx8Mnw2Gg2eDIa7ggzJfjkfXuw5BlzBeoQ0KadDOe00cNWYUy+jvotEwno7NJ7CbGC+3xddbYT2TqSpPMWAGXPcpzP3FGRRd+q7foP4Oal7G0Xz3YeYsUb0QvGff5TC2rCpL0CxRWoJ+2vbgPZrDDY+Pl3G02H28xZ/yeN/j5c12n+5nynpoMkL+FbA+e7mMo2w3rH+r8zL+hcAev1g2r2uUaOAWwuNwO1Lp4jbIreWugeGhwHFjlaegUQtZl1eNqEEJg/lEt6tyfqRUDlxuEDSdgLzP/UJlEPVA78KeZYC6dKMj0uqNWuq1RgctBvlhxcMoDGp/uoLrqM9Oxy0llxwEqzkBYSzF56ViT2i/W1ORGH9y6L8RR0/auU+YjtK47gMINJhZKMqckodmIs8RbnzX+6z+R+pejUkEIDyXYePdT8Vr58mkDf2kbuYN8xpjn73mss6+6GY5sLu7mgyIOpZLdneHtwr6Fh/d5TJuGnCvTgO9q65FQwJi2plVN0EzsW5rTXUqzi2qOK7BR8PaAIiJFHJyW2m/DmqCy2V/jSCb23owBtcQ5m8RF/l/hTsE7FSe6RT0A7j5dOxsN8WeIAE/8Z5ywpHQxnoedSzgQXcBry349pkNaPK9rXneVCODo2RYr+Epq8VkAph16EfQZJ8nBDzJnLQgqPgY2Z0yCTVMhapMAC/jplbDUxwhHAsJOemani3sUBpX++z9TewsMbHo7PL8Abgkw7jnpJOzKt0p3Rrs7PIccxPF2Ft5ffbB1JgIqOWdIQztLzYVPOQv1SrdwvkuQRJGnCjtJJL2fVZgj60DlAqzEaK4iZ7UubxrCzfJq3hFqrKYNSt8SpaxUJoOHgmKGpGXqnoIVe7AJGeTioKvFl/qIC4potPkFgpprK6c35allQ7plJ4scGQCxjR4CljBQa31YwbSuOmcjbmxoGNWSYGY1xW6TeolYV6CFiAT2IgCDQ51yMO75Vo3Ue/DT+98ynI4Q2DKEXKgWxhSVpVENcQJdQJpuLnVo2+UHV6A7QYQH21K8/Qu+xK0UZJheqaecCl+cyRMhogyaMVlPHdDvajA0DXCgxzeBSaoWL///R8tuLaaouuAuR14mmIccQeE5DZzBI/ueg0lSkDVhQjXA/3XVd0PoSOmuS1UWjOSeTiNn2NWsTW1XLSKstAhB5c0H+Katbw1cZCxxluTGN7UFIZEZFtV4nlhLoxtpUCGRIV1+fATIB6TFgxkfSBXI83LRZvBa7h8qmWzHOmFops+W2u/a7zAK6tuNRRCPuydavseraoFQWVVwa1IWFjK9LtJ0Zi53fB1wb4LoCE1ToXST7ewKi53q2QCt0LewhT0A+y693UYiDxBI7AzANmGLSDJPWdN4uoMaw06OGm9TpSe3YbyedsM6HgYnc5EZkLjMfRPGabUK2mcI2N4dIR/uvDXRR3etEDiQ0ExrvJ88Zcofri78n4vSg2t2Gic3OcZyT6K4W/zZDo8R87bIkjvXcAbcpXOsVADJUuvJmJi6BZuhcyFhFtC8W2qklsN5nZ4dHQ7QBwv4+h4ExovVAE2I95DZM60wjqOMgeOBKkXjE+4kAxtC/0NsQpaK32/sfd5kG3ARKCh2+MOEp6vI+FUUjSd6oMu1SeQf+xJ29tbtz2COi+IYNwDFwk3iPqjzmHb7e6QBpJKC7uITq7uonmPl6Ln+k+ubpY3cYSIVejxL5UhiLnNopPocDUAYEBPyZV7defIt6ZIw2WKEe819wIvxeF0EC3j1RkbnRFbR0PV+7wJxvKJkJP7Z900qLnA63M31EFQ42wtxX8Cels9/tuj4kgg2WTA8UFAjCNV/NSES96Guw0hjU1RiuYOV+MOIezQiSSsCvANsYHNoYHB85ZT/ir418llXnvMNznB66MHt3bt1W45qlt+6quGxmuXcPAID8iVOjw+Jp/j9wNyzj17SX6v4xdLosrGBxRFXT8PhbVWvRVR1LW9w6TanvSzGqPIxVg72r1v6mq7YaVau+yoeKsa3lZta4uy5bdcUSpqQDa95RhWEXKsiDw9zZyVIC/Q3kGpMR2sezYhT1RRl5mE4b///R80I9AaQfUXjGyeVZqVagZ6XLlylXEOc4EPPo6Hgvoa5xnwIgdj8gVD62JCJZSpmFDOWtDdE17ykcgFykIcplwwqSVOTZ/93LjfnmiXvjeFHEVorTJhCWZ47mdKfxqjGy/GYkysPEOlGWTGZeL0c8fgpGditSTaPqUWBgvqNEItHGxKWs0Tywou+YQUxbiDpRRydH0YptUIzVej8soZaJaLXGkXNqMDURibwsNv5yV2kVcWLRsNGVLF1FtpJnZWsuNdX5I5QodEibCIBEhZrWSusHoSHRtVnrNSWedsQHWtDSNOt5pLg1qEj9T5O6gR5g0oML4E6IMBvOF3Qn5yFT89dlUT088wMsJC40OezWZr8vRpd86Pwv6tGmE9oTLCKr1oZk+EzaoRyeD2IvWHW+nHUILbkrHNGqlKzAY3tkrMYQZ5eXgBFinEHL46P6XH+yn7/X/+l70DriXL1MxRa1JpyBdNtS/VwtLNO7TVby+Z6LzCglpLRConwWuEGIzi1feiy3YaxkDh0m5xMS+FX/4qgMkQ+q85JmoBSMXc+W6DOOKl2Gj5YUmoORtfgJ6KJGiXW274kAYfRnGUiwSkgZYi8urH83dsyp71j6K49Qg/4LYP352+fvv+4i1Cg5zlMDboH/WPKHaojC24bG3VLd9eFXGtjIR9sfe+2Htf7L0v9t4Xe/95ypH3xd77Yu99sfe+2Htf7L0v9v7nIWFf7L0v9t4Xe++LvffF3vti732x977Ye1/svS/23hd774u9v12p7b7Ye1/svS/2fuyUuC/2Dsk5qBUeljkXspWV6DLArlZKwG/iKMMMsZOr6O4Oo38fsKADm3+tKDHl6iaOplwL9HFTclkckqIwG+gTYFrOa+ey713i9rGjdgpTr+TUYU6Xm/GKbv3ese0ktvOzi8sojkIFTqFSnKP5DEvY+czl83hkUn0xp8LAnMtJRclJkVtz6VJ9s24S2CdKAvM/WjlOXC5aEHazw9wx8H881MYJd3cuwWy5rMe7rq0zPGLDaLy+m+Vy+X+dUQf/",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,i.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.f206504f.js b/assets/js/a9f09360.f206504f.js deleted file mode 100644 index aabf564d1..000000000 --- a/assets/js/a9f09360.f206504f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyGzmuv4Ltl0xcLdlSnEzWT5tJ5uzxnjlj19ipqVO2y0N1QxKTbrKHZFvWuPS2X7Kftl+yBZBsdetiO5ed9dRRHmI1CZIgCIAACNwlTkxscnSRvNNZXaJyNrlKkxxtZmTlpFbJUXI+RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6ku1bmsjuB9VWiRw1zXBk7f/VczHy1EbRd7e+9wVE/g/fHe3tU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvzt7ORHGGtTCteH06K2abNcLg1mrpj76d0Um109s5Ea1hmpJimU4iPRSzr4tZbZR9q2RZXTXxr45vSYabW3d1ZXlTYOc/jZb+Fob496vsNCz0AYZPhMl6VWUAkjSnR8YFPhuNvgr7U0mIdjKYpIi6NL1YO9PTev8GhvD45VLjMiBk9IraDHAbbvQYlIBHpWYSbHMoC2SAdawWwqsynTZCb8eVaFyDyaBm2FmZM32J34NoU5TfwOlY4YTLWRv2nlRMHHcYPGyUwU7WMjBAnUOmEckbPSUrnYGlaA/wvHQ6fHhxL4ilDLiVilVNxjEW5EUaMNWM1SmBJWP2Fl0DKzh3mJkCqHKcrJdOt6Iv9QW9eZGGpLaLaxCGvFU2LyIpNtLAqLIMcdWpbiI7ZWA81CLIo+fDeHHMeiLlwKkjjOmRr78KN2IKqqkJkYFUicCyQ8wtUGe3zKgR0CIkqUfManLNNoQUAux2M0JJzUyVOEMRE74rOlEmDJcVOhQKuVg850oc06C3Fzl46QaeVQuT68uRGyYOT9Zi1IlRV1jjAqRPYxhVFRYwoGcy+4cyTFlXp+ZxAQNtCc6QMWC+JCrQh/pcPy0oINWOV9OJ9Ku5Qn6oyk5kWkbVM1SO1Y08pEgihigKWQRcqES+GDHoGTrsCUBLYSap6SxsQUHN66kb5NIZti9pF/GZFLDaPaOa38xnKjq1zPVKDlWCtn5W8bJDL2fDpFhykcpvAqhdcpDA5SGAxTGBymMHiVwuB1CsODFIbDFIaHKQxfebSGr9Oo8iOB2wgMhp7K7o9DXdK7P0jLkk0K0zY6eNbRwYM+7O010kRtv/zyy6W6u1QAlwkJ12VyBJdJA3KZpL6PdCb1DcL3LX28GH4bPuf0+Wr4OnzOGHRwGD6n9DkcXKpFWPBSDRkTJ8rqHiyo+6tiEL4CE1EbL0ptUZ9RIymiNHbQWXXwoY5Fey8vaC9SSSdFYbdvJ0I8oR0tUVrb1CFtitl1+464+wltp40P9bCa9F2sVltdUeAZi+Ha7l/2w82yffN+2Sez9xY6X7b1V7R1Uk3npJq277/RXk+ICKs4fRklvu2zAcCaeTsdAsATokIXoy+jwWuiAV1K2wlAvU9o9y10qCPc8L7v4LA3eNkbHgwPOxQg38gDlGUvz3vz+fxrUI9snrA8mTzRQvWWHfmlY6PLDe4HewdLqGAT8e9osv8vGeqjaMNiTn4fOxbRYmk8vraV7XQu5s+snyoObYwzgl+aZvMWmtxFeLD3m021zALyBBNNshE5eH2iQY8puZ/n+y1KUmOe98qyt9JInz0mfKuxLPt53l+BXDsd31hCnqew3ryxPc+hLMstzb79MmGT6s/E+sES2879AeD3EoAln3cXvlc4KB6gVcFrs5O2WTpWrpCpVKEjsAqsABic1IUweEveppVaeeivLzlRcJb2Onun7Nix7+9JAd+cBJv8eWBq2kJ3Amp5eNzaztqTGJzgLc+R1dbpkpCRuaAZUrB1NiXvTUTTn+i+jNPwVyYqSVGCAp3jVnRZfxMS/tRaHjad6qqDbdF1NiMsxJEbfGw+fmbvwQFfb8HBuOd+CxBPSMWvoESdPlxB3ReXSSnYAiAuw+Vv7aZoLpOrZoz3qjF/YOzVI+RoKnMsxAiL9a5Hy0B7L4GfWoShjlKqJhLA+B6krU5xu9Lp+xYbZMvvuM3UUYlH0YgkhkLaGAvp0qs9OgSLOISnEDkqOEKIAyjkGiX3S9m8QexxfO61QDicB5YgOGDAJlAXV3tghc7BtAlDc5RSybIum4jjuJk1kqwMt3mbXjSSItlxhfbprq0gbh9YgcJ72xe4VAOODMSIwj22XoB4QspgBaX75fRz1ETnjvxKl9vDAhi31RbADVcigfrLsBE+u136+nBCFxBFOf0giltlGVaOYlxfKpoNyo++gjgK5CNb33FkazvnteNfT4j7NqD1b+bAAPf7cGF7e38gTuyg/Whu9HG8UkzucXa5+wnxX8Bn5XCTNNEVvX1KrY7z5CjJ6bU0Pu4lKc+M1n2n83lydJeEQDv9DGFsGrn/wdJz611isymWgn5FjOiBlt5HkzTheAu90RKRkqNEjz5gRmtUhnBwEi2NZOijuwjlnxWTNHjfyVHi3xuTNMFbUVYEnKw8yFb5OFnEBe+bqmlZTmX5R/O+SfPQy91nTvMjDV2sPEt/1kzvWjPw3ko812819Tl8J+a2Na+/3pPV13AaQ8yfhVGQi7kleaqtt8QyUWR1QZ483lbSzJuwArvzLa5o8G1WavAdvFyk/CyApo2SMEbMkzSRDst2+xYmMPrTTy5DTZTh2O6njv2gcYT4l9BAb+988KL8ZCw+aIQR8qFXU60+efxg+GIwHLwYDGmG8Cjz+XT0vesYdBnjDfmgmEfrvLd8R02B3zL6D/FohOdtiwk+zIzn297XW896dqrrIqcHMxSmz8/cn51B0eXv5g7qP8DNizS5fXgzt5DpXny8h28KHDuoqwoNZNooNM/bEbwns7nh4eEiTeYPb2/+h9zet3R4s4d39zNnPSwzQv4TuL54vUiT6cO4/neTl/EfRPbw1WJ5uyaZQeEwXg7XI53Pr6PeWjwEGC8KghvrIkdDVsi6vlqqGtIwlE90varnR1oXKNQGRdN5kA+5X2QMkh0YQtizKZItvbQRefalWRqsRo8tPfLjSoRRWrL+TI2XSR+Oxy0jlwMEqzkBEZbf55WGZ7zeta1ZjT/bD99Eo2ft3CdKR1mG7iMKDAwOy6rg5KGZLArCm+71PjT/2NxrKEkIxOsyLvzwVfHWRzJ5wTCom3kDwWLsw1uhmuyLbpYD3N01bMDcsVjA3R2dKpprunQXi3TZQGt1Gvhe9S0GM5Q3nVFNEy4HNm2tod7EuSYTxzeE17A2AnKipJpc1ybMQ5bgYtFfY8jlaT2agmsEC6dIk/y/oh0hdqxOTI7mEdJ8PPa+m4ZnxMDPQqScaSSNdUFGvQgE1P2D1xZ6h8wGcvm+b2Te1iNLUCrOt5QpZ+RkgpR1GCB4cMgTQpFNvbZgrMSYxJ0zCQ3eSF3biN5U2MYMzwlCehGSatJ1PVvU4TSu9t77m8RZUWLRyfnpI2jJjnHPayfvVfpd+jng5PyUchPlOHh5fXhvG0pE0ooOCJD/BTdSxPylxqSb+9glKqaIV6WdRNJ+yArswTpCubQbMUqXrydNLu/axMvkVToiXTvKmpUhJcs6rGyHjoxFQ8hzXT+GKx+gpIBJzY+vjm7qqC75RWeZWyiVdab2cVvIaxPTKQNbEGSG1i7pFKlCQK35U0Bl/XABY2EdmhRqJYnypqawSTMl3lZoJKoMN5LAoCcdyfDDeq2bqPf+px9CynLcQxTKEUmgnxhzqCvmGpaEJoE0ntzq1jfqjqDAHkaQLm1O8wwh+wqN1QooPdNMhJK/eRZmR0Rb8uKmovCgQVXQ0zXhQxLeRSaaWP/8+z9aeG11RdcR8yuIPKd3xAcw5LCZZ3gK1xusSAPqLkY0H5q/rNp+hB0LzXWp80aQ7ON5/JSyip1t9KLTnIWOBfqk+fiu2ehbm0Yda4M3Sc+bhp8hidhOV7RfvJXWtVIgY6LCun74CYmOWQsH9j5Iqonn1bwt4A1eIdVyOR3bhbKbPttYvyuy0LJiOwEyf+WzlbsMeAVNTBnhWlnvhw8PDuhPl6JNTUKwjIl2xOfjuijmf0rSx0fb7g8CNNjKjbb1fY799IMc/nab3QxPiXG26IF7Jwh+SG0KqjMgweg1Z8D82KKtVIVUeM0kvs51dm3QXg8PDq4HRONFmhxuIuOZLtFNmXWImDOjqQyhKlBQWryZg5gIqYBMY/MVqYrGaHO/r/JpmG2gROSh68MOEV6uE+FY8WMwl7ec64+oft+dtpd3fnlC9bZkhvH6OZEeiPuTzmbb7X6TFrPaSDdPji7uktueqGTP9x9dXC2u0oQIqylgXWnLGAs3TY6S/dX4tUVzw5HIizvPvg1HWqFyerBd845FJfdvBskiXR2x0ZfeCo1179MGWCcmUk3uH3W1JM0ZHZ8/oQ6BlrHCSv4PUrAw0L8NlSaS2GaKguxuojhxxU/LaP/38WxjRH5TkH15hqth8xg17wTCV6+UDaHtzZHtwctWTPkihoc54tsEfDfFcJutx6hsE5RtxVlbYdaLJY83Ec0Y0BxwJHB4eMghs28HHFt68ZrDNoevFsyVyxBGknTDFPwqs+psJ0nXdYyDGncojFra9P6JsGOchqausRZnaoyjjoWyaqBsNRa22ArRQJRqrJnfAhOcVKjOyP4mNXAzWI+0YZHpsil7iOD//Ps/eERkHl7mT3BSG6j0DM249rUT4wJvJVm8rRq+GMdBURZobTEHMnQnXM2XywmnT0UzMhOVGMlCkl4jMO3fNVqq0fbh52Uk6JnxmWQ3WJA6hEJrLm0jk6d2uuQ14h0+0+bjmFBKqUCQqqHIkLOIcQiqqVAZBZO8+LIRRKV8ZJhXRloEIUsCJgcBx2OZSTYOtHJGZA5KocSErZmUI35EhSrWMhk9Iv/K6qL2HgRVVCE6v0V+Y+3DO/LYeOP8noOOjj33zoNNvfMWxCeUCo7IUa5oeZmhXeacFniDhtWVd73rooBKO+8OkznXPluayBmhLBkK4S0pHE1DvmDi8xq5mPeBHlrp/iRDlxigkOqjL+y7aNjsZxxZ6XAZ7ZzNZmuq83l3zF+lm9YjMpr1ctyEG1nRtoc3H8+TdFXHdjnb4Bj5haxbTyoq6a9DuHhzesz3MkyxqJYr05ANAVqd2X0C3D9DR1ax3Y/jn9PNSTwhfLguirCo5EZjn6oA7cn4DM2NzKJFtoVU+wy8n6RJITNUFluX95u/nv4AN/Cif5CkrYvrEcTb/+H47fc/nn1P2NBd7Ck26B/0D/i5SFtXCtVaqluxu6pFWo/Qu/reXX3vrr53V9+7q+/941Sg7up7d/W9u/reXX3vrr53V9/77yPCrr53V9+7q+/d1ffu6nt39b27+t5dfe+uvndX37ur793V93696spdfe+uvndX3/vUOXFX3xsTWsgq3K8KIVUrk89nTV2sVP1epcmUsqqOLpK7O3r9e085/NT8a42GUrKu0uRGGEkxbk7ISmMiEWXQfERKZXnrQ/a9c1o+9dzOz9QreWiUB+VHvOFTvxe2nfh1enJ2nqRJLLoodU5jjJhR1bKY+RyYQEwuKRVcC1YINak5oSfxc1Luk6jdtJs49ZETp8KPVl6QUPMWht2MKr8N+p82tXHA3Z1PylosGnjftXVEIGyEpuO7WiwW/wKETEc2","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzmuv4Ltl0xcLdlSnEzWT5tJ5uzxnjlj19ipqVO2y0N1QxKTbrKHZFvWuPS2X7Kftl+yBZBsdetiO5ed9dRRHmI1CZIgCIAACNwlTkxscnSRvNNZXaJyNrlKkxxtZmTlpFbJUXI+RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6ku1bmsjuB9VWiRw1zXBk7f/VczHy1EbRd7e+9wVE/g/fHe3tU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvzt7ORHGGtTCteH06K2abNcLg1mrpj76d0Um109s5Ea1hmpJimU4iPRSzr4tZbZR9q2RZXTXxr45vSYabW3d1ZXlTYOc/jZb+Fob496vsNCz0AYZPhMl6VWUAkjSnR8YFPhuNvgr7U0mIdjKYpIi6NL1YO9PTev8GhvD45VLjMiBk9IraDHAbbvQYlIBHpWYSbHMoC2SAdawWwqsynTZCb8eVaFyDyaBm2FmZM32J34NoU5TfwOlY4YTLWRv2nlRMHHcYPGyUwU7WMjBAnUOmEckbPSUrnYGlaA/wvHQ6fHhxL4ilDLiVilVNxjEW5EUaMNWM1SmBJWP2Fl0DKzh3mJkCqHKcrJdOt6Iv9QW9eZGGpLaLaxCGvFU2LyIpNtLAqLIMcdWpbiI7ZWA81CLIo+fDeHHMeiLlwKkjjOmRr78KN2IKqqkJkYFUicCyQ8wtUGe3zKgR0CIkqUfManLNNoQUAux2M0JJzUyVOEMRE74rOlEmDJcVOhQKuVg850oc06C3Fzl46QaeVQuT68uRGyYOT9Zi1IlRV1jjAqRPYxhVFRYwoGcy+4cyTFlXp+ZxAQNtCc6QMWC+JCrQh/pcPy0oINWOV9OJ9Ku5Qn6oyk5kWkbVM1SO1Y08pEgihigKWQRcqES+GDHoGTrsCUBLYSap6SxsQUHN66kb5NIZti9pF/GZFLDaPaOa38xnKjq1zPVKDlWCtn5W8bJDL2fDpFhykcpvAqhdcpDA5SGAxTGBymMHiVwuB1CsODFIbDFIaHKQxfebSGr9Oo8iOB2wgMhp7K7o9DXdK7P0jLkk0K0zY6eNbRwYM+7O010kRtv/zyy6W6u1QAlwkJ12VyBJdJA3KZpL6PdCb1DcL3LX28GH4bPuf0+Wr4OnzOGHRwGD6n9DkcXKpFWPBSDRkTJ8rqHiyo+6tiEL4CE1EbL0ptUZ9RIymiNHbQWXXwoY5Fey8vaC9SSSdFYbdvJ0I8oR0tUVrb1CFtitl1+464+wltp40P9bCa9F2sVltdUeAZi+Ha7l/2w82yffN+2Sez9xY6X7b1V7R1Uk3npJq277/RXk+ICKs4fRklvu2zAcCaeTsdAsATokIXoy+jwWuiAV1K2wlAvU9o9y10qCPc8L7v4LA3eNkbHgwPOxQg38gDlGUvz3vz+fxrUI9snrA8mTzRQvWWHfmlY6PLDe4HewdLqGAT8e9osv8vGeqjaMNiTn4fOxbRYmk8vraV7XQu5s+snyoObYwzgl+aZvMWmtxFeLD3m021zALyBBNNshE5eH2iQY8puZ/n+y1KUmOe98qyt9JInz0mfKuxLPt53l+BXDsd31hCnqew3ryxPc+hLMstzb79MmGT6s/E+sES2879AeD3EoAln3cXvlc4KB6gVcFrs5O2WTpWrpCpVKEjsAqsABic1IUweEveppVaeeivLzlRcJb2Onun7Nix7+9JAd+cBJv8eWBq2kJ3Amp5eNzaztqTGJzgLc+R1dbpkpCRuaAZUrB1NiXvTUTTn+i+jNPwVyYqSVGCAp3jVnRZfxMS/tRaHjad6qqDbdF1NiMsxJEbfGw+fmbvwQFfb8HBuOd+CxBPSMWvoESdPlxB3ReXSSnYAiAuw+Vv7aZoLpOrZoz3qjF/YOzVI+RoKnMsxAiL9a5Hy0B7L4GfWoShjlKqJhLA+B6krU5xu9Lp+xYbZMvvuM3UUYlH0YgkhkLaGAvp0qs9OgSLOISnEDkqOEKIAyjkGiX3S9m8QexxfO61QDicB5YgOGDAJlAXV3tghc7BtAlDc5RSybIum4jjuJk1kqwMt3mbXjSSItlxhfbprq0gbh9YgcJ72xe4VAOODMSIwj22XoB4QspgBaX75fRz1ETnjvxKl9vDAhi31RbADVcigfrLsBE+u136+nBCFxBFOf0giltlGVaOYlxfKpoNyo++gjgK5CNb33FkazvnteNfT4j7NqD1b+bAAPf7cGF7e38gTuyg/Whu9HG8UkzucXa5+wnxX8Bn5XCTNNEVvX1KrY7z5CjJ6bU0Pu4lKc+M1n2n83lydJeEQDv9DGFsGrn/wdJz611isymWgn5FjOiBlt5HkzTheAu90RKRkqNEjz5gRmtUhnBwEi2NZOijuwjlnxWTNHjfyVHi3xuTNMFbUVYEnKw8yFb5OFnEBe+bqmlZTmX5R/O+SfPQy91nTvMjDV2sPEt/1kzvWjPw3ko812819Tl8J+a2Na+/3pPV13AaQ8yfhVGQi7kleaqtt8QyUWR1QZ483lbSzJuwArvzLa5o8G1WavAdvFyk/CyApo2SMEbMkzSRDst2+xYmMPrTTy5DTZTh2O6njv2gcYT4l9BAb+988KL8ZCw+aIQR8qFXU60+efxg+GIwHLwYDGmG8Cjz+XT0vesYdBnjDfmgmEfrvLd8R02B3zL6D/FohOdtiwk+zIzn297XW896dqrrIqcHMxSmz8/cn51B0eXv5g7qP8DNizS5fXgzt5DpXny8h28KHDuoqwoNZNooNM/bEbwns7nh4eEiTeYPb2/+h9zet3R4s4d39zNnPSwzQv4TuL54vUiT6cO4/neTl/EfRPbw1WJ5uyaZQeEwXg7XI53Pr6PeWjwEGC8KghvrIkdDVsi6vlqqGtIwlE90varnR1oXKNQGRdN5kA+5X2QMkh0YQtizKZItvbQRefalWRqsRo8tPfLjSoRRWrL+TI2XSR+Oxy0jlwMEqzkBEZbf55WGZ7zeta1ZjT/bD99Eo2ft3CdKR1mG7iMKDAwOy6rg5KGZLArCm+71PjT/2NxrKEkIxOsyLvzwVfHWRzJ5wTCom3kDwWLsw1uhmuyLbpYD3N01bMDcsVjA3R2dKpprunQXi3TZQGt1Gvhe9S0GM5Q3nVFNEy4HNm2tod7EuSYTxzeE17A2AnKipJpc1ybMQ5bgYtFfY8jlaT2agmsEC6dIk/y/oh0hdqxOTI7mEdJ8PPa+m4ZnxMDPQqScaSSNdUFGvQgE1P2D1xZ6h8wGcvm+b2Te1iNLUCrOt5QpZ+RkgpR1GCB4cMgTQpFNvbZgrMSYxJ0zCQ3eSF3biN5U2MYMzwlCehGSatJ1PVvU4TSu9t77m8RZUWLRyfnpI2jJjnHPayfvVfpd+jng5PyUchPlOHh5fXhvG0pE0ooOCJD/BTdSxPylxqSb+9glKqaIV6WdRNJ+yArswTpCubQbMUqXrydNLu/axMvkVToiXTvKmpUhJcs6rGyHjoxFQ8hzXT+GKx+gpIBJzY+vjm7qqC75RWeZWyiVdab2cVvIaxPTKQNbEGSG1i7pFKlCQK35U0Bl/XABY2EdmhRqJYnypqawSTMl3lZoJKoMN5LAoCcdyfDDeq2bqPf+px9CynLcQxTKEUmgnxhzqCvmGpaEJoE0ntzq1jfqjqDAHkaQLm1O8wwh+wqN1QooPdNMhJK/eRZmR0Rb8uKmovCgQVXQ0zXhQxLeRSaaWP/8+z9aeG11RdcR8yuIPKd3xAcw5LCZZ3gK1xusSAPqLkY0H5q/rNp+hB0LzXWp80aQ7ON5/JSyip1t9KLTnIWOBfqk+fiu2ehbm0Yda4M3Sc+bhp8hidhOV7RfvJXWtVIgY6LCun74CYmOWQsH9j5Iqonn1bwt4A1eIdVyOR3bhbKbPttYvyuy0LJiOwEyf+WzlbsMeAVNTBnhWlnvhw8PDuhPl6JNTUKwjIl2xOfjuijmf0rSx0fb7g8CNNjKjbb1fY799IMc/nab3QxPiXG26IF7Jwh+SG0KqjMgweg1Z8D82KKtVIVUeM0kvs51dm3QXg8PDq4HRONFmhxuIuOZLtFNmXWImDOjqQyhKlBQWryZg5gIqYBMY/MVqYrGaHO/r/JpmG2gROSh68MOEV6uE+FY8WMwl7ec64+oft+dtpd3fnlC9bZkhvH6OZEeiPuTzmbb7X6TFrPaSDdPji7uktueqGTP9x9dXC2u0oQIqylgXWnLGAs3TY6S/dX4tUVzw5HIizvPvg1HWqFyerBd845FJfdvBskiXR2x0ZfeCo1179MGWCcmUk3uH3W1JM0ZHZ8/oQ6BlrHCSv4PUrAw0L8NlSaS2GaKguxuojhxxU/LaP/38WxjRH5TkH15hqth8xg17wTCV6+UDaHtzZHtwctWTPkihoc54tsEfDfFcJutx6hsE5RtxVlbYdaLJY83Ec0Y0BxwJHB4eMghs28HHFt68ZrDNoevFsyVyxBGknTDFPwqs+psJ0nXdYyDGncojFra9P6JsGOchqausRZnaoyjjoWyaqBsNRa22ArRQJRqrJnfAhOcVKjOyP4mNXAzWI+0YZHpsil7iOD//Ps/eERkHl7mT3BSG6j0DM249rUT4wJvJVm8rRq+GMdBURZobTEHMnQnXM2XywmnT0UzMhOVGMlCkl4jMO3fNVqq0fbh52Uk6JnxmWQ3WJA6hEJrLm0jk6d2uuQ14h0+0+bjmFBKqUCQqqHIkLOIcQiqqVAZBZO8+LIRRKV8ZJhXRloEIUsCJgcBx2OZSTYOtHJGZA5KocSErZmUI35EhSrWMhk9Iv/K6qL2HgRVVCE6v0V+Y+3DO/LYeOP8noOOjj33zoNNvfMWxCeUCo7IUa5oeZmhXeacFniDhtWVd73rooBKO+8OkznXPluayBmhLBkK4S0pHE1DvmDi8xq5mPeBHlrp/iRDlxigkOqjL+y7aNjsZxxZ6XAZ7ZzNZmuq83l3zF+lm9YjMpr1ctyEG1nRtoc3H8+TdFXHdjnb4Bj5haxbTyoq6a9DuHhzesz3MkyxqJYr05ANAVqd2X0C3D9DR1ax3Y/jn9PNSTwhfLguirCo5EZjn6oA7cn4DM2NzKJFtoVU+wy8n6RJITNUFluX95u/nv4AN/Cif5CkrYvrEcTb/+H47fc/nn1P2NBd7Ck26B/0D/i5SFtXCtVaqluxu6pFWo/Qu/reXX3vrr53V9+7q+/941Sg7up7d/W9u/reXX3vrr53V9/77yPCrr53V9+7q+/d1ffu6nt39b27+t5dfe+uvndX37ur793V93696spdfe+uvndX3/vUOXFX3xsTWsgq3K8KIVUrk89nTV2sVP1epcmUsqqOLpK7O3r9e085/NT8a42GUrKu0uRGGEkxbk7ISmMiEWXQfERKZXnrQ/a9c1o+9dzOz9QreWiUB+VHvOFTvxe2nfh1enJ2nqRJLLoodU5jjJhR1bKY+RyYQEwuKRVcC1YINak5oSfxc1Luk6jdtJs49ZETp8KPVl6QUPMWht2MKr8N+p82tXHA3Z1PylosGnjftXVEIGyEpuO7WiwW/wKETEc2",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,g={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/ada7accb.0a9d5bbe.js b/assets/js/ada7accb.0a9d5bbe.js new file mode 100644 index 000000000..82f6d49d4 --- /dev/null +++ b/assets/js/ada7accb.0a9d5bbe.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9983],{96522:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>I,default:()=>j,frontMatter:()=>f,metadata:()=>d,toc:()=>N});const d=JSON.parse('{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/getfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getfolder","permalink":"/docs/API-docs/getfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar_label":"Get Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oY8l4cJ231VKNwHbdGYsQOAtRZGJQ0KzGmSIYc7QULAX3oH/QP+mn5kmKovdqOUbdBXuwVOTM8c+Gc4UKQLINIr8QvVhfoxSgRBYbcK0fKGpGKywrhBAm6fTg6PwWptZ0GmNsGyIJH8gonCAWSVDqAzGxDICE4zNVY5TCOqj2RCOvQSzZ8WohUlEjdlkiEk17WSOgZzEIYWaNIRbd9rQqRCMVonKRK3IZos4+Y02kBdgxrgx4/NcpjIVLyDSYi0FyzyaBqp1EkAmdO2wJFOpY6sEBeYS1FuhA0d1GSvDKlSMTY+lrS9grOZLSSCvdqmFX5QeUy0bYjPjY4awIGNnQwGPC/XbShyXMMYdxoWIdDJCK3htAQy0vntMrjRv9jYKXFXXSd0xw5z2ZIdUeuYvFoP6phVs0OPjrRJsuwv445eJwZg9NVCtqYVDTUVc7jIf16YGR4caPO8bat/4osNNkWutyjJCyO6D5TG8WDwcHz/eFgf/D95fBlevhj+uJlbzAY/C4SMas16y6LtZAUkZIivf3duOIbnLO1sLw1HoNoW944vK8OL2yNVClTwhQNwdRbUybgNMqAQH4OspTKgJaE/snXK1D03vqHI/E4ZNueK6OVwevVJbw+HAyuh+sgHN4NQhcqMJZgbBtT9L6Bow9V6V08D7t3eP3D2r0Xd907NROpVRG79qW9QfNtE7l9PHXHM9TdcladUNwXO85ur3dOBswbr2geOWK2L53a7/bTqxF3X64bu6SWSCpUiVT0u6j2F2s6aQXb8pMV3TRei1RURC6k/X6QpsjsrGcdmqBKo2UWermt+9Kp/mQo2uS2hnTuEdLY7D9OIZAslSkf1hptwnPBKeyytBOkda6kU7/hXCSrHGxLLZm2Qhn7ZMvfYxuVl5l549BcqNLEvE6Gd/j4Perc1sjDAVUIK/HPf/4dNQqbNzUaimX35IP5YN40HpydomdSlKaAscaZyjRGeazj3nrgCChrjSHoOShDWHpJCIUqFUkNHBruHLl0MlNacbWymGVtD1sFH3rwvkKq0PPWdx5BQoET1FzkIBuytSQ2tcILU+tvxjz6JCAha4IyGAKgqaTJWXAV/gSsB2kADaF3XgWEQJ5Rqw6bNeRlTlBLI0tk28lOlArUimsTvM2aQBCsbiJk4AnLeixg5ZBBLEKPg3jM84xH4NXc1s5jxZUyQSgbVWBIILcFQoiXk10wBWQYCBxjUTkGNtoYbfObmLdxozU4y71CSc3D1TZGVicvTeB21mFZ5WAdMOctjzrYAdzbexeQM3ymzE1I9/Y+mH24WhfTe8yCIhw9XVX9dDq9U+3PdnVOFL1qMniLzgZF1s832qWiqsniDdk2sv7oLJ2gwVg/WzdgY6Owebh74Xi1X6F2/QskrpDQPzo/je31GXz+4y84Q+kNVHbaVWveeNRzKFdHceS6zHdhW3dHGNtYeBVHPO+Kj8dYDMQR5EFg9zbvXjuPY/Qc/JjIzXFOLc1frWACo/8/bsbxyRqSeaQRrKXSXVv56bad2NLR1+HN+AL9ROW4bGxfyHA/CvdFIrTK0QTcooqjk/MzmMDz3kAkWy3yX2S7f3b68/Hri2NGwzeri9iwN+gN4nBpA9XSbB21efLcbm+LDYF+3cfRsjcTzqjvtFSRDaOXiyWTXYn18ybdPI1GiahsIN5eLDIZ8J3XbcvLnxr0zJWjREykVzLj9n21EIUK/LtYv32+6ODTt8tn1DO495V1L+YVyRhmmInUDX+JRNzgfOdN147aZMUzDKvbP8pzdLSleWdI2WH6k+NLkQi+Nbv8dhP5bfmDrd+Lapf4OgD8lzn4XoXFouPOtl3Ld1tf1Fg6uJLmEI3atv0HtWBjWg==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"}}');var r=o(74848),s=o(28453),a=o(33617),i=o.n(a),n=o(17543),l=o.n(n),c=o(86013),p=o.n(c),b=o(63723),g=o.n(b),m=(o(18766),o(79329),o(9303));const f={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oY8l4cJ231VKNwHbdGYsQOAtRZGJQ0KzGmSIYc7QULAX3oH/QP+mn5kmKovdqOUbdBXuwVOTM8c+Gc4UKQLINIr8QvVhfoxSgRBYbcK0fKGpGKywrhBAm6fTg6PwWptZ0GmNsGyIJH8gonCAWSVDqAzGxDICE4zNVY5TCOqj2RCOvQSzZ8WohUlEjdlkiEk17WSOgZzEIYWaNIRbd9rQqRCMVonKRK3IZos4+Y02kBdgxrgx4/NcpjIVLyDSYi0FyzyaBqp1EkAmdO2wJFOpY6sEBeYS1FuhA0d1GSvDKlSMTY+lrS9grOZLSSCvdqmFX5QeUy0bYjPjY4awIGNnQwGPC/XbShyXMMYdxoWIdDJCK3htAQy0vntMrjRv9jYKXFXXSd0xw5z2ZIdUeuYvFoP6phVs0OPjrRJsuwv445eJwZg9NVCtqYVDTUVc7jIf16YGR4caPO8bat/4osNNkWutyjJCyO6D5TG8WDwcHz/eFgf/D95fBlevhj+uJlbzAY/C4SMas16y6LtZAUkZIivf3duOIbnLO1sLw1HoNoW944vK8OL2yNVClTwhQNwdRbUybgNMqAQH4OspTKgJaE/snXK1D03vqHI/E4ZNueK6OVwevVJbw+HAyuh+sgHN4NQhcqMJZgbBtT9L6Bow9V6V08D7t3eP3D2r0Xd907NROpVRG79qW9QfNtE7l9PHXHM9TdcladUNwXO85ur3dOBswbr2geOWK2L53a7/bTqxF3X64bu6SWSCpUiVT0u6j2F2s6aQXb8pMV3TRei1RURC6k/X6QpsjsrGcdmqBKo2UWermt+9Kp/mQo2uS2hnTuEdLY7D9OIZAslSkf1hptwnPBKeyytBOkda6kU7/hXCSrHGxLLZm2Qhn7ZMvfYxuVl5l549BcqNLEvE6Gd/j4Perc1sjDAVUIK/HPf/4dNQqbNzUaimX35IP5YN40HpydomdSlKaAscaZyjRGeazj3nrgCChrjSHoOShDWHpJCIUqFUkNHBruHLl0MlNacbWymGVtD1sFH3rwvkKq0PPWdx5BQoET1FzkIBuytSQ2tcILU+tvxjz6JCAha4IyGAKgqaTJWXAV/gSsB2kADaF3XgWEQJ5Rqw6bNeRlTlBLI0tk28lOlArUimsTvM2aQBCsbiJk4AnLeixg5ZBBLEKPg3jM84xH4NXc1s5jxZUyQSgbVWBIILcFQoiXk10wBWQYCBxjUTkGNtoYbfObmLdxozU4y71CSc3D1TZGVicvTeB21mFZ5WAdMOctjzrYAdzbexeQM3ymzE1I9/Y+mH24WhfTe8yCIhw9XVX9dDq9U+3PdnVOFL1qMniLzgZF1s832qWiqsniDdk2sv7oLJ2gwVg/WzdgY6Owebh74Xi1X6F2/QskrpDQPzo/je31GXz+4y84Q+kNVHbaVWveeNRzKFdHceS6zHdhW3dHGNtYeBVHPO+Kj8dYDMQR5EFg9zbvXjuPY/Qc/JjIzXFOLc1frWACo/8/bsbxyRqSeaQRrKXSXVv56bad2NLR1+HN+AL9ROW4bGxfyHA/CvdFIrTK0QTcooqjk/MzmMDz3kAkWy3yX2S7f3b68/Hri2NGwzeri9iwN+gN4nBpA9XSbB21efLcbm+LDYF+3cfRsjcTzqjvtFSRDaOXiyWTXYn18ybdPI1GiahsIN5eLDIZ8J3XbcvLnxr0zJWjREykVzLj9n21EIUK/LtYv32+6ODTt8tn1DO495V1L+YVyRhmmInUDX+JRNzgfOdN147aZMUzDKvbP8pzdLSleWdI2WH6k+NLkQi+Nbv8dhP5bfmDrd+Lapf4OgD8lzn4XoXFouPOtl3Ld1tf1Fg6uJLmEI3atv0HtWBjWg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},I=void 0,y={},N=[];function h(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,r.jsx)(i(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,r.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/ada7accb.5ec1ab32.js b/assets/js/ada7accb.5ec1ab32.js deleted file mode 100644 index 53cfb2f64..000000000 --- a/assets/js/ada7accb.5ec1ab32.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9983],{96522:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>f,default:()=>k,frontMatter:()=>b,metadata:()=>i,toc:()=>v});const i=JSON.parse('{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/getfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getfolder","permalink":"/docs/API-docs/getfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar_label":"Get Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V91u2zYUfpVT3qwBFNtJ027T1YKty7IVbbBkKLDUCCjpSGJDkSx55B8YutuT7NH2JMOhbEeO02AZit4kFs//33fIlSBZBZFei5+tLtCLaSIKDLlXjpQ1IhVXNcIZEvR0OL04B6m1nQdY2hbIgkfyCmcIBZJUOoDMbEsgITjMValyKKPoSCTCOvSSFZ8XIhUVUk8SiXDSywYJPTuzEkY2KFLRk29UIRKh2BsnqRb3XbTZR8zpvABbwlahx0+t8liIlHyLiQi01KwyqMZpFInAhdO2QJGWUgdmyGtspEhXgpYucpJXphKJKK1vJA1PcCGjllS4X46yOj+uXSa6bspmg7MmYGBFx5MJ/9v1NrR5jiGUrYZtOkQicmsIDTG/dE6rPBLGHwMLrfa964PmzHlWQ6o3ucnFk+Ooj7J6cfzRiS5Zp/1trMHT1Bicb0rQxaKiob5znu7Sr8dGhpe36gLv6/q/noU2G3iXe5SExSk9pOpO8Hhy/OLwaHI4+fbq6FV68n368tVoMpn8KRKxaDTLrpu1kBQ9JUV6+N264ivYGRysp8ZjEF3HhJOH+vDSNki1MhXM0RDMvTVVAk6jDAjklyArqQxoSeiffbkGRe+tfzwTT/NsGLkyWhm82QzhzclkcnO0TcLJfhL6VIGxBKVtTTH6CoE+1qX7/jwe3snNd9vwXu6Hd25mUqsiovaVvUXzdQs5NE+9eXZ1t51VzxTpYifY4XkfZMC89YqWcUcsDqVThz09vZ4y+nLf2PVqiUuFapGKcZ/V8Wq7TjrBuvxss25ar0UqaiIX0vE4SFNkdjGyDk1QldEyC6PcNmPp1Hh2JLrkvoR07gnc2B4+TSCQrJSpHpea3qXnkkvYV2knSdtaSad+w6VINjUYcq03bY0y4mTH36WNwuvKvHNoLlVlYl1nR3v7+D3q3DbIlwOqETbs//z1d5QobN42aCi23TN413pwdo6eN6I0BZQaFyrT+MBdI6BsNIagl6AMYeUlIRSqUiQ1cFYYNHLpZKa04kZlNsvSHga9Hkbwvkaq0TPpG48gocAZau5v0Nbesh6yIFuyTbSx9hnm1t+W7FICErI2KIMhQEDciKCppckRNrVIwHqQBtAQeudVQJCqYebSesCyVLlixTyVXuYEjTSyQjaWAPvNWXDezlSBAbzN2kAQrG5jIGyxQaQ+RINYhBH8pGbYB86H/bUMC6haVpFAbguE9ZByGKaADAOBY/Mqx6g0kPQEGmfoY+/FSpat1uAso4eSmq9bw9qyIvLSBAa43qFNabbpc97y5SfaKORyBB/MB8N4D21AbgCtzG1IP5hDuN622XvMgiKcPt/Mw3w+35uDg12ZM0V1m4FHZ+/kqngYp2Yovv044F27OzC7ne2xRM/RxBxVaDB2oHSqxze4Pr04j0ALNWp3Z5lF9keXT8fMOL5EImWqMN7IH8QbijUk84jU2Eil+8n94b6eiJrom/CuvEQ/UzmuseMzqRpH5rFIhFY5moADND49u3gDM3gxmohkgEL/IXnjN+c/vn57+Zq9YWDtM3Y0mowm8f5mAzXSDEzdvSruI8jqbkd92ffHGv4IFzR2Wqq4cGKUq/WyuBbbF0R69/qYJqK2gZi8WmUy4B9edx0ff2rR8zqaJmImvZIZI+T1ShQq8O9i+7z4bIDPf1+/VA7gwYfMgz5vcNwwiM+kbvlLJOIWlzvPpm7aJRsoZ7d6+mmeo6OB5N49YGeZnr2+EomQLednuEJu4wpZ/2DtD3q1u1t6B/gvr7kHBVarfj113Za/J31WYh3ghptTNO267l8LQSaR","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"}}');var a=o(74848),r=o(28453),n=o(33617),s=o.n(n),l=o(17543),p=o.n(l),d=o(86013),c=o.n(d),m=o(63723),I=o.n(m),u=(o(18766),o(79329),o(9303));const b={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V91u2zYUfpVT3qwBFNtJ027T1YKty7IVbbBkKLDUCCjpSGJDkSx55B8YutuT7NH2JMOhbEeO02AZit4kFs//33fIlSBZBZFei5+tLtCLaSIKDLlXjpQ1IhVXNcIZEvR0OL04B6m1nQdY2hbIgkfyCmcIBZJUOoDMbEsgITjMValyKKPoSCTCOvSSFZ8XIhUVUk8SiXDSywYJPTuzEkY2KFLRk29UIRKh2BsnqRb3XbTZR8zpvABbwlahx0+t8liIlHyLiQi01KwyqMZpFInAhdO2QJGWUgdmyGtspEhXgpYucpJXphKJKK1vJA1PcCGjllS4X46yOj+uXSa6bspmg7MmYGBFx5MJ/9v1NrR5jiGUrYZtOkQicmsIDTG/dE6rPBLGHwMLrfa964PmzHlWQ6o3ucnFk+Ooj7J6cfzRiS5Zp/1trMHT1Bicb0rQxaKiob5znu7Sr8dGhpe36gLv6/q/noU2G3iXe5SExSk9pOpO8Hhy/OLwaHI4+fbq6FV68n368tVoMpn8KRKxaDTLrpu1kBQ9JUV6+N264ivYGRysp8ZjEF3HhJOH+vDSNki1MhXM0RDMvTVVAk6jDAjklyArqQxoSeiffbkGRe+tfzwTT/NsGLkyWhm82QzhzclkcnO0TcLJfhL6VIGxBKVtTTH6CoE+1qX7/jwe3snNd9vwXu6Hd25mUqsiovaVvUXzdQs5NE+9eXZ1t51VzxTpYifY4XkfZMC89YqWcUcsDqVThz09vZ4y+nLf2PVqiUuFapGKcZ/V8Wq7TjrBuvxss25ar0UqaiIX0vE4SFNkdjGyDk1QldEyC6PcNmPp1Hh2JLrkvoR07gnc2B4+TSCQrJSpHpea3qXnkkvYV2knSdtaSad+w6VINjUYcq03bY0y4mTH36WNwuvKvHNoLlVlYl1nR3v7+D3q3DbIlwOqETbs//z1d5QobN42aCi23TN413pwdo6eN6I0BZQaFyrT+MBdI6BsNIagl6AMYeUlIRSqUiQ1cFYYNHLpZKa04kZlNsvSHga9Hkbwvkaq0TPpG48gocAZau5v0Nbesh6yIFuyTbSx9hnm1t+W7FICErI2KIMhQEDciKCppckRNrVIwHqQBtAQeudVQJCqYebSesCyVLlixTyVXuYEjTSyQjaWAPvNWXDezlSBAbzN2kAQrG5jIGyxQaQ+RINYhBH8pGbYB86H/bUMC6haVpFAbguE9ZByGKaADAOBY/Mqx6g0kPQEGmfoY+/FSpat1uAso4eSmq9bw9qyIvLSBAa43qFNabbpc97y5SfaKORyBB/MB8N4D21AbgCtzG1IP5hDuN622XvMgiKcPt/Mw3w+35uDg12ZM0V1m4FHZ+/kqngYp2Yovv044F27OzC7ne2xRM/RxBxVaDB2oHSqxze4Pr04j0ALNWp3Z5lF9keXT8fMOL5EImWqMN7IH8QbijUk84jU2Eil+8n94b6eiJrom/CuvEQ/UzmuseMzqRpH5rFIhFY5moADND49u3gDM3gxmohkgEL/IXnjN+c/vn57+Zq9YWDtM3Y0mowm8f5mAzXSDEzdvSruI8jqbkd92ffHGv4IFzR2Wqq4cGKUq/WyuBbbF0R69/qYJqK2gZi8WmUy4B9edx0ff2rR8zqaJmImvZIZI+T1ShQq8O9i+7z4bIDPf1+/VA7gwYfMgz5vcNwwiM+kbvlLJOIWlzvPpm7aJRsoZ7d6+mmeo6OB5N49YGeZnr2+EomQLednuEJu4wpZ/2DtD3q1u1t6B/gvr7kHBVarfj113Za/J31WYh3ghptTNO267l8LQSaR",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,h={},v=[];function g(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,a.jsx)(s(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,a.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(p(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(I(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.101476aa.js b/assets/js/ae010e44.101476aa.js new file mode 100644 index 000000000..2e0bb082d --- /dev/null +++ b/assets/js/ae010e44.101476aa.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6685],{73320:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/selfsign.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/selfsign","permalink":"/docs/API-docs/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11zGzeSf6V3XhyrhpRIy45PT+vYuazufLEqkiu1JakUcKbJgYUBJgBGJKNiVR72H9zr7sv+NP+Sq8bHcIYfoh2nNro7+kHm4KPR3Wg0+gv3iWUTk5xcJm9UVpcorUmu0yRHk2leWa5kcpJcFAgGxdjwiYRXZ6cwQYmaWTTA4P0Pb8EWzAJKNhJoYKwRjZ0LBBrP5QTUGBjkAX4f/qpqyJgEJowCLjNR5wjKLcYEVBp7OY65xBymPJ+gNSlMC54VYAsPE7Wbjzm3oDTgrGIyh7pSEpgBiZhj3oeLghuotLrjuUM0YoOzCjVHmRGwkgumwSoH++Ovfz8nEv+qak30fvz1HzAWagpcuv53FUo3gFVV/0peyQtencD7SiiWw1zVGs7e/HtDKEGltsuDgzc4qifw/vTg4PqrwtrKnBweEgxVoSS0BBuZfqbKw5wGVvn4KZGMGgmqp5UZLubA8hZTbIESMlXNIVNK51zSjqRQsQmCrMsRapMCcaZUGokGBhpZPu9Z1asNwn+cv/sexkqXzPbhTNQmbZbLucbMirkHT7RHqp4YGDGDL47BWM3lJIWS3RJbuYWfa57dEtkGZR6Z+urs1PHq4OC8riqlLebwoyfh5OCAer5B4jHT6MZnqiyVhIppVqJFbbx0UbfGn2uunVzYApgQkRcnV7IHBwd2XuHJwQGcypxnTjwJILWSCPqxfT+UmERDzyvM+JiHoS3WgZJB6ognU+b3sxIs82hqNBVmlt9hF/AshTkBfoNSRQwKpfkvSlom3HbcobY8Y6K9bYSgE2/LtCV2VopLG1vDCs3Jod1zmxLkilDLiVkll67HINwxUaMJWE1TKAirH7DSaOiUR7jESJlDgXxSbF2P5R9qYzuAoTaEZhuLsFbcJcdedGwbM2EQ+LjDy5LdYmu1RgP04Zs55DhmtbApcJI4q2vsw/fK0skTPCNFQ5LrzjSztcae2+UgDgERyUq3x2dLHZDz8Rg1HU7qdCDCnIgdyZlXGkSeOzm2YBKUXNnoTAml10XINXf5CJmS1mm+V3eMC4e8J9Y06m8kWHabwkjUmILG3B/cOQqhpqmXdzeEFJznueMPqWWSQiUJf6nC8tyACVg1ijCeJ+pslC0twk2bq+HUjhWtTCyIRwywZFykjnEpfFAjsNwKTOnAVkzOU8iZxRQszuxIzVLICsxuR2oW+DVW0hr+y4ZTF3s+n2vDFI5TeJHCyxQGRykMhikMjlMYvEhh8DKF4VEKw2EKw+MUhi88T4cvAz9Zw8Q2AoOh56R9XBwk/fmWG3dCSfGZRpdOO7p00IeDg+ZUUNtPP/10Je+vJMBVQofkKjmBq6QZcpWkvo90H/UNwveMPp4Nvw6fc/p8MXwZPqdu6OA4fBb0ORxcyUVY8EoOHSaWldUDWFD374pB+AqCQm1uUWqLeokaSaGksYP2o4MPdSzatDwjWrjkljNhtpMTRzwiipYorRF1TEQ5kdxOket+ROS08aEep+58l1OPra54qB0WwzXqn/fDDbGdeL/so6G9hc6Xkf6CSCf1c0HqZzv9jYZ6RExYxenLOPF1313kTvtu50MY8Ii40MXoy3jwknhAF892BlDvI6K+hQ51hFvc9x0d9wbPe8Oj4XGHA+Tj+AFl2cvz3nw+/z24R3ZNWJ7MmmhpeguNWYSxVuUGN8JZ+ctRwe5xv6Pp/V9kcI+iLYp59EEbq6Tx3NrWslU5mz8xHlSc2hhgNH5pfs1baLouwsN5sVmheBaQpzHR7BqRo9YnHvQcJw/z/LDFSWrM815Z9lYa6bPnGN9qLMt+nvdXRq7tjm8sIc9TWG/e2J7nUJbllmbffpU4k+rfSPSDtbVd+sOAf9UBWMp5d+EHDwf59UoKt7ZztjafjpUrpOAydARRgZUBGie1YBpn5DUarqQf/fufnHhwlja58zKdg+Z8eM8K+OpdsLufBqEmEroAqGX3vDXK2kA0TnDmYGS1saokZHjOCEIKps4K8sJYNO+J78t4i/vKWMXJ2xdorWtFm/U3IeF3reUp066uOsoGbYcYZiDO3OAru+134j04ctdbcCIeuN/CiEek4ldQok4fdqDuy6ukZM4CICnD5W9lC9RXyXUzx3vHmO+Ye/0J56jgOQo2QrHe9clnoE1LkKcWY6ij5LLx6B2+R2mrk81WOn3fYsPZ8hS3hToq8Xg0IotBcBNjGl1+tWeHoI8LxVGAleRyhBAnwKgRwy8W8waxT5NzrwXC5uxYgsaBG9gE3Bof++EVOhvTZgzBKLnkZV02kcNxAzWyrAy3eZtfNLM2qOMK7d1dW4HNdqxAYbrtC1zJgYsM8JJNHjD0XPcjUgMBnxX5TtJEVZR/4Eqe5slJEnMTSeqAorHfqHyenNwnIYZEP0OEhiYdfjCU17hPTFZgyehXRIYyIWMuMEkTn2kwSZo4h4PSIsSp5CRRow+Y2SSla7OiYC4aguHmndzHUT4+nqTB/ExOEh84T9IEZ6ysaHBoApSZIiOvysfJIi74EKimZQnKuB9NoJ7gUAj6N4L5nqYuVjJBvwnSmxYER1uJF+q1oj6Lb9jctOB6+U5WE1A0h85vFmZBzuaGwm618aooYyKrBZmyOKu4njd2tbNnG5a08G1WavAdPF/ETW9htGWvtfr8DcpQEQNcDONz535QOEL8c2igXJHbX1Z+NhYfFMII3d5WhZKfPX8wfDYYDp4NhgQhBB9bMJjWbJ6kCbdYmt189L3rGHT3/xXZWpjHW6i3jPun4GJ2/V2iGMc7stkEd8vcxbZ8UCtEbQpVi5yCv8h036VlfnPGryvGtIijtr9DaBdpMttNzAwy1YvJJvhK4NhCXVWUSFVaon7a9lQfDXHD4+NFmsx3kzf/X0ne17R5093U/eiydMsM5h+B67OXizQpduP6lyaP+Acie/xisbxEk0wjsxjvgJuRyuc3UW8t2gOjGdEdGm6EBa0octRkcazrq6WqoZGU/75Z1fMjpQQyuUHRdJJLzq80zmwloziEaqYFknOztGYddNOY4cGE9iYLJaxwxZPmhiw9XeNV0ofT8ZKX3hBezW/FsS6/JRU8cevdmNqp8SeH4Zs49KSdq6f06TJEFVFwg8FiWQmX7J5yIQhvur770Pxzpl3DSUIgXpdx4d1XxWvvsbsFw6RuphiCidiH10w2mcRuxg7u7xshcNKxWMD9Pe0q6hu6dBeLdNlAa3Ua3L3qWzRmyO86s5omXE5s2lpTvSVzQ5aMbwhR3zYCvqTlptYBDhl8i0V/TSCXu/XJHFxjWNhFAvL/i3eurulC1foTDrPzOnv+QHmnxwu7BwIMJrWL5lpSiVEuXYhoWXTApbG69o4g5LWOdRaxgKnSKkNj+qGsogc5Nz7zXGAbfgoojZ/OYMyMRZ1CLbm0qHVdkZe4XhPVod8tsCCvyhcEEbN2C1A3u0/1Yb6WqVW+FRVABIyhfCsY+E1lSSylWiV9o8YNkrIbQdKOrv4jxAAq1EZJKiVTesIk/8V5id7iU4bM5YIJP9SfAU6xcMKHFG8XmXiXffzbP1t4bbX51xHzK7A8p8DkDgyd508uvnH+v8ZKzMGqLkYED/WfVy/ZZOfV52/HpWccFDJVPilpvP0+PDqi/7pkxFJCCFcvxUxp28a1EPM/Jemnu+UPOw++efOF/JA3UHzgw19m2d3wjLZoi0w/CCAYL7UWVExHnOs19Y2rvOVScIk3kW03w6OjmwHxdpEmx5vYd65KtIWrHCEmTrWiMrtKIKOyLz0HNmFcAl2l+nfkJmqt9MO2zedh9hATjjtMeL7OhFPpgqSu3PRC3aL811LaXt765QnVWelkxauZhPtBrj/pENtu90QazGrN7Tw5ubxPZj1W8Z7vP7m8XlynCTFWUTCrUsZhzGyRnCSHrdiWQX1HASmC4IS2kUPDZE4xzDVDmlX88G6QLNLVGRvN7q2jse593gRj2YTLycOzrpdcOaed85vT4c0yrFDx/0SKKwTWt0elCSeJKZDlZKgv0oQE4odlJPDbuK0xRrcp7NZShiuBtBhH64TGVlX3hmDX5ljX4Hk7yuTjSC401ESGNgV7GsJj+KaJ3rQCMq14zOVSuJvQR4x8DFzIYHh87HzrrwfOCX320vl3xy8W1x1XJ0m67oyL1K4a5UnSNTHdd8ts8vmSFTMiQm6u7c7duXp1br/GaPvHyslK2MCmTptO791g3aFGkamyqdSLwz/+7Z9uRtx4p1z+RMHzd7WGSk1Rj2tf8TcWOONkctF4LF3f0mdDVgo0RsyBbK0JVcpDzicuJRgtmYxVbMQFJ51Ew5QPVbbUmunDj0uv74n22dE7FKTKgNVWlcxZSo2VNFX6lurVqewbRlSgSyYEyoLJzFsr/rSlZEhQUTlZgpXmhuqONWHNPW5KWs0yCyWTbIIEO+1wKUdBFrcBrUaU2TBK1N5ctYwLpX1Q1hFEySLjMhDfzirqcsEAsvM0FrSVd8FmNVQHmSP4gxQq10fkd1SEC8/Qebu1FIqKzMnnqIWAStGNwJkgU6mNI023mklDF3mIA4c9aBgWzEk0ocLyvUHa4bdc3vqCyh5cNsL0I44Mt7gMXUyn0zXl9rQ75ztu/1KPqOxaGW6Vni9nT7gt6pFTiG0gzYeH9F14aQEthbeEkavMbIieqMwcFiiqw3O0JCHm8NXZqbtEn8LHX/8b3iLTEgo19dKa1RrFvHnU4Z8MuJ33bGvuQOewsJreHVgnpHISnUPiYJKuKu/usdM4RheMdxu5XK7iAfxlRBMI+y8hk7QCSTHzIYOoQ1jFNyoQqpw378bnqO94Fg28LTt86AYfJmkieIbSYMsgePXd2Vu4g2f9oyRt3YifsNuHb09ff/v9+beEDZ0sz7FB/6h/5ELWytiSydZS5yjGcO4Ng5UcTWMl7R/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u/GF1zfuHO/uHO/uHO/uHO7sfHOwf7uwf7uwf7uwf7uwf7uwf7vzfebgTktKkEQ8rwbhsVeD4kofL5XOe6zQpqBri5DK5v6fg9Xuq1aPmn2vUVEpxnSZ3THMK37hCijRWAVAC/BYpFf3aR6N6F7Ry6rWRSwWt1I9QEYOf8SrLsLIPjm0XbJy9O79I0iQWV5YqpzmaTek5Epv6RHfgo0v5M1fzLZic1C4fn3iYVLhAybVu1cOtq3oIP1ppfSbnLQy75RCeDPpLRG2ccH/vKyoWi2a879o6IzA2jqadu14sFv8DI38f3Q==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzeSf6V3XhyrhpRIy45PT+vYuazufLEqkiu1JakUcKbJgYUBJgBGJKNiVR72H9zr7sv+NP+Sq8bHcIYfoh2nNro7+kHm4KPR3Wg0+gv3iWUTk5xcJm9UVpcorUmu0yRHk2leWa5kcpJcFAgGxdjwiYRXZ6cwQYmaWTTA4P0Pb8EWzAJKNhJoYKwRjZ0LBBrP5QTUGBjkAX4f/qpqyJgEJowCLjNR5wjKLcYEVBp7OY65xBymPJ+gNSlMC54VYAsPE7Wbjzm3oDTgrGIyh7pSEpgBiZhj3oeLghuotLrjuUM0YoOzCjVHmRGwkgumwSoH++Ovfz8nEv+qak30fvz1HzAWagpcuv53FUo3gFVV/0peyQtencD7SiiWw1zVGs7e/HtDKEGltsuDgzc4qifw/vTg4PqrwtrKnBweEgxVoSS0BBuZfqbKw5wGVvn4KZGMGgmqp5UZLubA8hZTbIESMlXNIVNK51zSjqRQsQmCrMsRapMCcaZUGokGBhpZPu9Z1asNwn+cv/sexkqXzPbhTNQmbZbLucbMirkHT7RHqp4YGDGDL47BWM3lJIWS3RJbuYWfa57dEtkGZR6Z+urs1PHq4OC8riqlLebwoyfh5OCAer5B4jHT6MZnqiyVhIppVqJFbbx0UbfGn2uunVzYApgQkRcnV7IHBwd2XuHJwQGcypxnTjwJILWSCPqxfT+UmERDzyvM+JiHoS3WgZJB6ognU+b3sxIs82hqNBVmlt9hF/AshTkBfoNSRQwKpfkvSlom3HbcobY8Y6K9bYSgE2/LtCV2VopLG1vDCs3Jod1zmxLkilDLiVkll67HINwxUaMJWE1TKAirH7DSaOiUR7jESJlDgXxSbF2P5R9qYzuAoTaEZhuLsFbcJcdedGwbM2EQ+LjDy5LdYmu1RgP04Zs55DhmtbApcJI4q2vsw/fK0skTPCNFQ5LrzjSztcae2+UgDgERyUq3x2dLHZDz8Rg1HU7qdCDCnIgdyZlXGkSeOzm2YBKUXNnoTAml10XINXf5CJmS1mm+V3eMC4e8J9Y06m8kWHabwkjUmILG3B/cOQqhpqmXdzeEFJznueMPqWWSQiUJf6nC8tyACVg1ijCeJ+pslC0twk2bq+HUjhWtTCyIRwywZFykjnEpfFAjsNwKTOnAVkzOU8iZxRQszuxIzVLICsxuR2oW+DVW0hr+y4ZTF3s+n2vDFI5TeJHCyxQGRykMhikMjlMYvEhh8DKF4VEKw2EKw+MUhi88T4cvAz9Zw8Q2AoOh56R9XBwk/fmWG3dCSfGZRpdOO7p00IeDg+ZUUNtPP/10Je+vJMBVQofkKjmBq6QZcpWkvo90H/UNwveMPp4Nvw6fc/p8MXwZPqdu6OA4fBb0ORxcyUVY8EoOHSaWldUDWFD374pB+AqCQm1uUWqLeokaSaGksYP2o4MPdSzatDwjWrjkljNhtpMTRzwiipYorRF1TEQ5kdxOket+ROS08aEep+58l1OPra54qB0WwzXqn/fDDbGdeL/so6G9hc6Xkf6CSCf1c0HqZzv9jYZ6RExYxenLOPF1313kTvtu50MY8Ii40MXoy3jwknhAF892BlDvI6K+hQ51hFvc9x0d9wbPe8Oj4XGHA+Tj+AFl2cvz3nw+/z24R3ZNWJ7MmmhpeguNWYSxVuUGN8JZ+ctRwe5xv6Pp/V9kcI+iLYp59EEbq6Tx3NrWslU5mz8xHlSc2hhgNH5pfs1baLouwsN5sVmheBaQpzHR7BqRo9YnHvQcJw/z/LDFSWrM815Z9lYa6bPnGN9qLMt+nvdXRq7tjm8sIc9TWG/e2J7nUJbllmbffpU4k+rfSPSDtbVd+sOAf9UBWMp5d+EHDwf59UoKt7ZztjafjpUrpOAydARRgZUBGie1YBpn5DUarqQf/fufnHhwlja58zKdg+Z8eM8K+OpdsLufBqEmEroAqGX3vDXK2kA0TnDmYGS1saokZHjOCEIKps4K8sJYNO+J78t4i/vKWMXJ2xdorWtFm/U3IeF3reUp066uOsoGbYcYZiDO3OAru+134j04ctdbcCIeuN/CiEek4ldQok4fdqDuy6ukZM4CICnD5W9lC9RXyXUzx3vHmO+Ye/0J56jgOQo2QrHe9clnoE1LkKcWY6ij5LLx6B2+R2mrk81WOn3fYsPZ8hS3hToq8Xg0IotBcBNjGl1+tWeHoI8LxVGAleRyhBAnwKgRwy8W8waxT5NzrwXC5uxYgsaBG9gE3Bof++EVOhvTZgzBKLnkZV02kcNxAzWyrAy3eZtfNLM2qOMK7d1dW4HNdqxAYbrtC1zJgYsM8JJNHjD0XPcjUgMBnxX5TtJEVZR/4Eqe5slJEnMTSeqAorHfqHyenNwnIYZEP0OEhiYdfjCU17hPTFZgyehXRIYyIWMuMEkTn2kwSZo4h4PSIsSp5CRRow+Y2SSla7OiYC4aguHmndzHUT4+nqTB/ExOEh84T9IEZ6ysaHBoApSZIiOvysfJIi74EKimZQnKuB9NoJ7gUAj6N4L5nqYuVjJBvwnSmxYER1uJF+q1oj6Lb9jctOB6+U5WE1A0h85vFmZBzuaGwm618aooYyKrBZmyOKu4njd2tbNnG5a08G1WavAdPF/ETW9htGWvtfr8DcpQEQNcDONz535QOEL8c2igXJHbX1Z+NhYfFMII3d5WhZKfPX8wfDYYDp4NhgQhBB9bMJjWbJ6kCbdYmt189L3rGHT3/xXZWpjHW6i3jPun4GJ2/V2iGMc7stkEd8vcxbZ8UCtEbQpVi5yCv8h036VlfnPGryvGtIijtr9DaBdpMttNzAwy1YvJJvhK4NhCXVWUSFVaon7a9lQfDXHD4+NFmsx3kzf/X0ne17R5093U/eiydMsM5h+B67OXizQpduP6lyaP+Acie/xisbxEk0wjsxjvgJuRyuc3UW8t2gOjGdEdGm6EBa0octRkcazrq6WqoZGU/75Z1fMjpQQyuUHRdJJLzq80zmwloziEaqYFknOztGYddNOY4cGE9iYLJaxwxZPmhiw9XeNV0ofT8ZKX3hBezW/FsS6/JRU8cevdmNqp8SeH4Zs49KSdq6f06TJEFVFwg8FiWQmX7J5yIQhvur770Pxzpl3DSUIgXpdx4d1XxWvvsbsFw6RuphiCidiH10w2mcRuxg7u7xshcNKxWMD9Pe0q6hu6dBeLdNlAa3Ua3L3qWzRmyO86s5omXE5s2lpTvSVzQ5aMbwhR3zYCvqTlptYBDhl8i0V/TSCXu/XJHFxjWNhFAvL/i3eurulC1foTDrPzOnv+QHmnxwu7BwIMJrWL5lpSiVEuXYhoWXTApbG69o4g5LWOdRaxgKnSKkNj+qGsogc5Nz7zXGAbfgoojZ/OYMyMRZ1CLbm0qHVdkZe4XhPVod8tsCCvyhcEEbN2C1A3u0/1Yb6WqVW+FRVABIyhfCsY+E1lSSylWiV9o8YNkrIbQdKOrv4jxAAq1EZJKiVTesIk/8V5id7iU4bM5YIJP9SfAU6xcMKHFG8XmXiXffzbP1t4bbX51xHzK7A8p8DkDgyd508uvnH+v8ZKzMGqLkYED/WfVy/ZZOfV52/HpWccFDJVPilpvP0+PDqi/7pkxFJCCFcvxUxp28a1EPM/Jemnu+UPOw++efOF/JA3UHzgw19m2d3wjLZoi0w/CCAYL7UWVExHnOs19Y2rvOVScIk3kW03w6OjmwHxdpEmx5vYd65KtIWrHCEmTrWiMrtKIKOyLz0HNmFcAl2l+nfkJmqt9MO2zedh9hATjjtMeL7OhFPpgqSu3PRC3aL811LaXt765QnVWelkxauZhPtBrj/pENtu90QazGrN7Tw5ubxPZj1W8Z7vP7m8XlynCTFWUTCrUsZhzGyRnCSHrdiWQX1HASmC4IS2kUPDZE4xzDVDmlX88G6QLNLVGRvN7q2jse593gRj2YTLycOzrpdcOaed85vT4c0yrFDx/0SKKwTWt0elCSeJKZDlZKgv0oQE4odlJPDbuK0xRrcp7NZShiuBtBhH64TGVlX3hmDX5ljX4Hk7yuTjSC401ESGNgV7GsJj+KaJ3rQCMq14zOVSuJvQR4x8DFzIYHh87HzrrwfOCX320vl3xy8W1x1XJ0m67oyL1K4a5UnSNTHdd8ts8vmSFTMiQm6u7c7duXp1br/GaPvHyslK2MCmTptO791g3aFGkamyqdSLwz/+7Z9uRtx4p1z+RMHzd7WGSk1Rj2tf8TcWOONkctF4LF3f0mdDVgo0RsyBbK0JVcpDzicuJRgtmYxVbMQFJ51Ew5QPVbbUmunDj0uv74n22dE7FKTKgNVWlcxZSo2VNFX6lurVqewbRlSgSyYEyoLJzFsr/rSlZEhQUTlZgpXmhuqONWHNPW5KWs0yCyWTbIIEO+1wKUdBFrcBrUaU2TBK1N5ctYwLpX1Q1hFEySLjMhDfzirqcsEAsvM0FrSVd8FmNVQHmSP4gxQq10fkd1SEC8/Qebu1FIqKzMnnqIWAStGNwJkgU6mNI023mklDF3mIA4c9aBgWzEk0ocLyvUHa4bdc3vqCyh5cNsL0I44Mt7gMXUyn0zXl9rQ75ztu/1KPqOxaGW6Vni9nT7gt6pFTiG0gzYeH9F14aQEthbeEkavMbIieqMwcFiiqw3O0JCHm8NXZqbtEn8LHX/8b3iLTEgo19dKa1RrFvHnU4Z8MuJ33bGvuQOewsJreHVgnpHISnUPiYJKuKu/usdM4RheMdxu5XK7iAfxlRBMI+y8hk7QCSTHzIYOoQ1jFNyoQqpw378bnqO94Fg28LTt86AYfJmkieIbSYMsgePXd2Vu4g2f9oyRt3YifsNuHb09ff/v9+beEDZ0sz7FB/6h/5ELWytiSydZS5yjGcO4Ng5UcTWMl7R/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u7B/u/GF1zfuHO/uHO/uHO/uHO7sfHOwf7uwf7uwf7uwf7uwf7uwf7vzfebgTktKkEQ8rwbhsVeD4kofL5XOe6zQpqBri5DK5v6fg9Xuq1aPmn2vUVEpxnSZ3THMK37hCijRWAVAC/BYpFf3aR6N6F7Ry6rWRSwWt1I9QEYOf8SrLsLIPjm0XbJy9O79I0iQWV5YqpzmaTek5Epv6RHfgo0v5M1fzLZic1C4fn3iYVLhAybVu1cOtq3oIP1ppfSbnLQy75RCeDPpLRG2ccH/vKyoWi2a879o6IzA2jqadu14sFv8DI38f3Q==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.7182f56e.js b/assets/js/ae010e44.7182f56e.js deleted file mode 100644 index c5e8b9eb3..000000000 --- a/assets/js/ae010e44.7182f56e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6685],{73320:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>f,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>t,toc:()=>y});const t=JSON.parse('{"id":"API-docs/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/selfsign.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/selfsign","permalink":"/docs/API-docs/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11zGzeSf6UzL45VQ0qkZcfHp3Xs3J52c7EqUiq1JakUcKbJgYUBJgBGJKNi1T7sz7h7yU/LL7lqfAxn+CHaSWqj26UfZA7QALobjUZ/4SGxbGqS0VXyTmV1idKa5CZNcjSZ5pXlSiaj5LJAMCgmhk8lvDk/gylK1MyiAQbfffs12IJZQMnGAg1MNKKxC4FA8FxOQU2AQR7m78PfVA0Zk8CEUcBlJuocQbnFmIBKYy/HCZeYw4znU7QmhVnBswJs4edE7cZjzi0oDTivmMyhrpQEZkAi5pj34bLgBiqt7nnuEI3Y4LxCzVFmNFnJBdNglZv7l7//zwWR+DdVa6L3l7//L0yEmgGXrv99hdIBsKrqX8trecmrEXxXCcVyWKhaw/m7/2wIpVmp7ero6B2O6yl8d3Z0dPN5YW1lRsfHNIeqUBJago1NP1PlcU6AVT55TiSjRprV08oMFwtgeYsptkAJmaoWkCmlcy5pR1Ko2BRB1uUYtUmBOFMqjUQDA40sX/Ss6tUG4S8X77+BidIls304F7VJm+VyrjGzYuGnJ9ojVc8MjJnBV6dgrOZymkLJ7oit3MKPNc/uiGyDMo9MfXN+5nh1dHRRV5XSFnP43pMwOjqini+ReMw0OvhMlaWSUDHNSrSojZcu6tb4Y821kwtbABMi8mJ0LXtwdGQXFY6OjuBM5jxz4kkTUiuJoIfte1BiEoFeVJjxCQ+gLdaBkkHqiCcz5vezEizzaGo0FWaW32N34nkKC5r4HUoVMSiU5j8paZlw23GP2vKMifa2EYJOvC3TlthZKS5tbA0rNCeHds9tSpArQi0nZpVcuh6DcM9EjSZgNUuhIKy+xUqjoVMe5yVGyhwK5NNi53os/1Ab25kYakNotrEIa8VdcuxFx7YJEwaBTzq8LNkdtlZrNEAfvlxAjhNWC5sCJ4mzusY+fKMsnTzBM1I0JLnuTDNba+y5XQ7iEBCRrHR7fL7SATmfTFDT4aRON0UYE7EjOfNKg8hzJ8cWTIKSaxudKaH0pgi55i4fIVPSOs335p5x4ZD3xJpG/Y0Fy+5SGIsaU9CY+4O7QCHULPXy7kBIwXmeO/6QWiYpVJLwlyoszw2YgFWjCON5os5G2dIi3LS5Gk7tRNHKxIJ4xABLxkXqGJfCBzUGy63AlA5sxeQihZxZTMHi3I7VPIWswOxurOaBXxMlreE/bTl1sefTuTZM4TSFVym8TmFwksJgmMLgNIXBqxQGr1MYnqQwHKYwPE1h+MrzdPg68JM1TGwjMBh6TtqnxUHSn19z404oKT7T6NJZR5cO+nB01JwKavvhhx+u5cO1BLhO6JBcJyO4ThqQ6yT1faT7qG8Qvuf08WL4Rfhc0Oer4evwOXOgg9PwWdDncHAtl2HBazl0mFhWVo9gQd2/KwbhKwgKtblFqS3qJWokhZLGDtqPDj7UsWzT8oJo4ZJbzoTZTU6EeEIUrVDaIOqUiHIiuZsi1/2EyGnjQz1O3fkupx5bXfFQOyyGG9S/7IcbYjfxftknQ3sLnd9G+isindTPJamf3fQ3GuoJMWEdp9/GiS/67iJ32nc3HwLAE+JCF6PfxoPXxAO6eHYzgHqfEPUtdKgj3OK+7+S0N3jZG54MTzscIB/HA5RlL897i8Xi9+Ae2TVheTJroqXpLTRmESZalVvcCGflr6CC3eN+R9P7v8ngHkdbFPPogzZWSeO5ta1lq3K2eGb8VHFoY4AR/Mr8WrTQdF2Eh/Nis0LxLCBPMNHsGpOj1ice9Bwnj/P8uMVJaszzXln21hrps+cY32osy36e99cgN3bHN5aQ5ylsNm9tz3Moy3JHs2+/TpxJ9R8k+sHa2i39AeCfdQBWct5d+NHDQX69ksKt7Zyt7adj7QopuAwdQVRgDUDjtBZM45y8RsOV9NC//8mJB2dlkzsv0zlozof3rIDP3we7+3kQaiKhOwG17B+3QVl7Eo1TnLs5stpYVRIyPGc0Qwqmzgrywlg074nvq3iL+8pYxcnbF2ita0Wb9bch4Xet5SnTrq47ygZthxhmII7c4iu77XfiPThx11twIh653wLEE1LxayhRpw87UPfVdVIyZwGQlOHqt7IF6uvkphnjvWPM94y9+YhzVPAcBRuj2Oz66DPQpiXIU4sx1FFy2Xj0Dt+TtNXJ5mudvm+55Wx5ittCHZV4PBqRxSC4iTGNLr/ao0PQx4XiKMBKcjlGiANg3IjhbxbzBrGPk3OvBcLm7FmC4MABNgG3xsd+fIXOxrQZQ3OUXPKyLpvI4aSZNbKsDLd5m180sjao4wrt3d1Ygc33rEBhut0LXMuBiwzwkk0fMfRc9xNSAwGfNflO0kRVlH/gSp7lySiJuYkkdZOisV+qfJGMHpIQQ6KfIUJDg44/GMprPCQmK7Bk9CsiQ5mQCReYpInPNJgkTZzDQWkR4lQyStT4A2Y2SenarCiYi4bmcONGDxHKx8eTNJifySjxgfMkTXDOyoqAQxOgzBQZeVU+SZZxwcemalpWUxn3ownU0zwUgv6V03xDQ5drmaBfNdO71gyOthIv1VtFfRbfsYVpzevlO1lPQNEYOr9ZGAU5WxgKu9XGq6KMiawWZMrivOJ60djVzp5tWNLCt1mpwXfwchk3vYXRjr3W6tM3KENFDHAxjE8d+0HhGPFPoYFyRW5/WfnJWHxQCGN0e1sVSn7y+MHwxWA4eDEY0gwh+Niag2nNFkmacIul2c9H37uJQXf/35CthXm8hXqruH8KLmbX3yeKEd6Rzaa4X+Yud+WDWiFqU6ha5BT8Rab7Li3zqzN+XTGmRRy1/T1Cu0yT+X5i5pCpXkw2wecCJxbqqqJEqtIS9fO2p/pkiBueni7TZLGfvMX/S/K+oM2b7afue5elW2Uw/whcX7xepkmxH9f/avKIfyCyp6+Wq0s0yTQyi/EOuB2rfHEb9dayDRjNiC5ouBGWtKLIUZPFsamvVqqGICn/fbuu58dKCWRyi6LpJJecX2mc2UpGcQjVzAok52ZlzbrZTWOGBxPamyyUsMI1T5obsvR0jddJH84mK156Q3g9vxVhXX5LKnjm1rs1tVPjz47DN3HoWTtXT+nTVYgqouCAwWJZCZfsnnEhCG+6vvvQ/HOmXcNJQiBel3Hh/VfFW++xuwXDoG6mGIKJ2Ie3TDaZxG7GDh4eGiFw0rFcwsMD7SrqW7p0l8t01UBrdRrcvepbNGbI7zujmiZcDWzaWkO9JXNLloxvCFHfNgK+pOW21mEeMviWy/6GQK5266M5uMGwsIs0yb8X71xd06Wq9UccZud19vyB8k6PF3Y/CTCY1i6aa0klRrl0IaJV0QGXxuraO4KQ1zrWWcQCpkqrDI3ph7KKHuTc+Mxzge35U0Bp/HAGE2Ys6hRqyaVFreuKvMTNmqgO/W6BJXlVviCImLVfgLrZfaoP87VMrfKtqADixBjKt4KB31SWxFKqddK3atwgKfsRJO3o6j9CDKBCbZSkUjKlp0zyn5yX6C0+ZchcLpjwoP4McIqFEz6keLvIxLvsl3/83MJrp82/iZhfgeU5BSb3YOg8f3LxjfP/NVZiAVZ1MaL5UP9p/ZJN9l59/nZcecZBIVPlk5LG2+/DkxP6r0tGLCWEcPVSzJS2bVILsfgsST/eLX/cefDN2y/kx7yB4gMf/jTP7ofntEU7ZPrRCYLxUmtBxXTEuV5T37jOWy4Fl3gb2XY7PDm5HRBvl2lyuo19F6pEW7jKEWLiTCsqs6sEMir70gtgU8Yl0FWqf0duotZKP27bfBpmjzHhtMOEl5tMOJMuSOrKTS/VHcp/LqXt5a1fnlCdl05WvJpJuAdy/UmH2Ha7J9JgVmtuF8no6iGZ91jFe75/dHWzvEkTYqyiYFaljMOY2SIZJcet2JZBfU8BKZrBCW0jh4bJnGKYG4Y0q/jx/SBZpusjtprdO6Gx7n3aAGPZlMvp46NuVly5oJ3zm9PhzSqsUPG/IsUVAuvbUGnCSWIKZDkZ6ss0IYH4dhUJ/Cpua4zRbQu7tZThWiAtxtE6obF11b0l2LU91jV42Y4y+TiSCw01kaFtwZ6G8Bi+aaI3rYBMKx5ztRLuJvQRIx8DFzIYnp463/qLgXNCX7x2/t3pq+VNx9VJkq474yK160Z5knRNTPfdMpt8vmTNjIgzN9d25+5cvzp3X2O0/RPlZCVsYFOnTaf3frDpUKPIVNlU6kXwX/7xsxsRN94pl8/gfa2hUjPUk9qX+00EzjnZWwS85q4hKwUaIxZAZtaUiuQh51OXDYxGTMYqNuaCkzoiMOWjlC2NZvrw/crhe6Z9YvQeBWkxEEq5imurgNVWlW6NeOXOlL6jmnUq/YYxFemSGWEQ4xCUBXO17+HopWRVUIU5mYWV5gaB8ZKAyTzFyYRn3N3lSlrNMgslk2yKtFjqHHviQlNmr9WYUh1Gidrbr1Toi2g9iZQ5Mn14R1XTjnAXnUVLW5t709VQOWROcVwn/KGCfUz+R0XL8wzNqoRC4D1qp2q8F1ILAZWiO4IzQcZTe29pIquZNHS1h8hw2JqGfcHAdGvkbNEHyp3QtUdmFgmA4PLO15tfNWL2PY4Nt7gKasxmsw2197w75s/cFvWYTDa1Gjd1jU5Jtoc3H8+TdF0/diVb4wRdvNvxKD7TAFZxf4vB1ZvzM3edQoGiWq1MQ7bEYVRmjgnw+AItWeXmOI5/TgePZIJ5rzweU1bxrWeUitPN+8kF6nueRRtqB6uOHfBxkiaCZygNtu7cN38+/xru4UX/JElbl85HMO/467O3X31z8RVhQ/eo59igf9I/cVFhZWzJZGupCxQTuPB371oapDFEDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9j/rDS4cPbmMPbmMPbmMPbmP01/Ye3MYe3MYe3MYe3MYe3MYe3Mf86b2NC3pc04nElGJetIhdfVXC1ejFzkyYFFRyMrpKHBwpef0flcNT8Y42aqhVu0uSeaU7hG1erkMZEO+WY75CyvW99NKp3SSunXhu5VNBaiQbVCfgRb7IMK/sobLsm4vz9xWWSJrF+sVQ5jdFsRi9+2MznkgMfXVadubJqweS0dinvxM9JtQGstkW3sODOFRaEH63MOZOLFobdigNPBv0lorYOeHjwRQvLZQPvu3aOCIyN0LRzN8vl8v8AT2zjBQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"}}');var s=i(74848),r=i(28453),o=i(33617),l=i.n(o),a=i(17543),d=i.n(a),c=i(86013),p=i.n(c),h=i(63723),m=i.n(h),u=(i(18766),i(79329),i(9303));const x={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzeSf6UzL45VQ0qkZcfHp3Xs3J52c7EqUiq1JakUcKbJgYUBJgBGJKNi1T7sz7h7yU/LL7lqfAxn+CHaSWqj26UfZA7QALobjUZ/4SGxbGqS0VXyTmV1idKa5CZNcjSZ5pXlSiaj5LJAMCgmhk8lvDk/gylK1MyiAQbfffs12IJZQMnGAg1MNKKxC4FA8FxOQU2AQR7m78PfVA0Zk8CEUcBlJuocQbnFmIBKYy/HCZeYw4znU7QmhVnBswJs4edE7cZjzi0oDTivmMyhrpQEZkAi5pj34bLgBiqt7nnuEI3Y4LxCzVFmNFnJBdNglZv7l7//zwWR+DdVa6L3l7//L0yEmgGXrv99hdIBsKrqX8trecmrEXxXCcVyWKhaw/m7/2wIpVmp7ero6B2O6yl8d3Z0dPN5YW1lRsfHNIeqUBJago1NP1PlcU6AVT55TiSjRprV08oMFwtgeYsptkAJmaoWkCmlcy5pR1Ko2BRB1uUYtUmBOFMqjUQDA40sX/Ss6tUG4S8X77+BidIls304F7VJm+VyrjGzYuGnJ9ojVc8MjJnBV6dgrOZymkLJ7oit3MKPNc/uiGyDMo9MfXN+5nh1dHRRV5XSFnP43pMwOjqini+ReMw0OvhMlaWSUDHNSrSojZcu6tb4Y821kwtbABMi8mJ0LXtwdGQXFY6OjuBM5jxz4kkTUiuJoIfte1BiEoFeVJjxCQ+gLdaBkkHqiCcz5vezEizzaGo0FWaW32N34nkKC5r4HUoVMSiU5j8paZlw23GP2vKMifa2EYJOvC3TlthZKS5tbA0rNCeHds9tSpArQi0nZpVcuh6DcM9EjSZgNUuhIKy+xUqjoVMe5yVGyhwK5NNi53os/1Ab25kYakNotrEIa8VdcuxFx7YJEwaBTzq8LNkdtlZrNEAfvlxAjhNWC5sCJ4mzusY+fKMsnTzBM1I0JLnuTDNba+y5XQ7iEBCRrHR7fL7SATmfTFDT4aRON0UYE7EjOfNKg8hzJ8cWTIKSaxudKaH0pgi55i4fIVPSOs335p5x4ZD3xJpG/Y0Fy+5SGIsaU9CY+4O7QCHULPXy7kBIwXmeO/6QWiYpVJLwlyoszw2YgFWjCON5os5G2dIi3LS5Gk7tRNHKxIJ4xABLxkXqGJfCBzUGy63AlA5sxeQihZxZTMHi3I7VPIWswOxurOaBXxMlreE/bTl1sefTuTZM4TSFVym8TmFwksJgmMLgNIXBqxQGr1MYnqQwHKYwPE1h+MrzdPg68JM1TGwjMBh6TtqnxUHSn19z404oKT7T6NJZR5cO+nB01JwKavvhhx+u5cO1BLhO6JBcJyO4ThqQ6yT1faT7qG8Qvuf08WL4Rfhc0Oer4evwOXOgg9PwWdDncHAtl2HBazl0mFhWVo9gQd2/KwbhKwgKtblFqS3qJWokhZLGDtqPDj7UsWzT8oJo4ZJbzoTZTU6EeEIUrVDaIOqUiHIiuZsi1/2EyGnjQz1O3fkupx5bXfFQOyyGG9S/7IcbYjfxftknQ3sLnd9G+isindTPJamf3fQ3GuoJMWEdp9/GiS/67iJ32nc3HwLAE+JCF6PfxoPXxAO6eHYzgHqfEPUtdKgj3OK+7+S0N3jZG54MTzscIB/HA5RlL897i8Xi9+Ae2TVheTJroqXpLTRmESZalVvcCGflr6CC3eN+R9P7v8ngHkdbFPPogzZWSeO5ta1lq3K2eGb8VHFoY4AR/Mr8WrTQdF2Eh/Nis0LxLCBPMNHsGpOj1ice9Bwnj/P8uMVJaszzXln21hrps+cY32osy36e99cgN3bHN5aQ5ylsNm9tz3Moy3JHs2+/TpxJ9R8k+sHa2i39AeCfdQBWct5d+NHDQX69ksKt7Zyt7adj7QopuAwdQVRgDUDjtBZM45y8RsOV9NC//8mJB2dlkzsv0zlozof3rIDP3we7+3kQaiKhOwG17B+3QVl7Eo1TnLs5stpYVRIyPGc0Qwqmzgrywlg074nvq3iL+8pYxcnbF2ita0Wb9bch4Xet5SnTrq47ygZthxhmII7c4iu77XfiPThx11twIh653wLEE1LxayhRpw87UPfVdVIyZwGQlOHqt7IF6uvkphnjvWPM94y9+YhzVPAcBRuj2Oz66DPQpiXIU4sx1FFy2Xj0Dt+TtNXJ5mudvm+55Wx5ittCHZV4PBqRxSC4iTGNLr/ao0PQx4XiKMBKcjlGiANg3IjhbxbzBrGPk3OvBcLm7FmC4MABNgG3xsd+fIXOxrQZQ3OUXPKyLpvI4aSZNbKsDLd5m180sjao4wrt3d1Ygc33rEBhut0LXMuBiwzwkk0fMfRc9xNSAwGfNflO0kRVlH/gSp7lySiJuYkkdZOisV+qfJGMHpIQQ6KfIUJDg44/GMprPCQmK7Bk9CsiQ5mQCReYpInPNJgkTZzDQWkR4lQyStT4A2Y2SenarCiYi4bmcONGDxHKx8eTNJifySjxgfMkTXDOyoqAQxOgzBQZeVU+SZZxwcemalpWUxn3ownU0zwUgv6V03xDQ5drmaBfNdO71gyOthIv1VtFfRbfsYVpzevlO1lPQNEYOr9ZGAU5WxgKu9XGq6KMiawWZMrivOJ60djVzp5tWNLCt1mpwXfwchk3vYXRjr3W6tM3KENFDHAxjE8d+0HhGPFPoYFyRW5/WfnJWHxQCGN0e1sVSn7y+MHwxWA4eDEY0gwh+Niag2nNFkmacIul2c9H37uJQXf/35CthXm8hXqruH8KLmbX3yeKEd6Rzaa4X+Yud+WDWiFqU6ha5BT8Rab7Li3zqzN+XTGmRRy1/T1Cu0yT+X5i5pCpXkw2wecCJxbqqqJEqtIS9fO2p/pkiBueni7TZLGfvMX/S/K+oM2b7afue5elW2Uw/whcX7xepkmxH9f/avKIfyCyp6+Wq0s0yTQyi/EOuB2rfHEb9dayDRjNiC5ouBGWtKLIUZPFsamvVqqGICn/fbuu58dKCWRyi6LpJJecX2mc2UpGcQjVzAok52ZlzbrZTWOGBxPamyyUsMI1T5obsvR0jddJH84mK156Q3g9vxVhXX5LKnjm1rs1tVPjz47DN3HoWTtXT+nTVYgqouCAwWJZCZfsnnEhCG+6vvvQ/HOmXcNJQiBel3Hh/VfFW++xuwXDoG6mGIKJ2Ie3TDaZxG7GDh4eGiFw0rFcwsMD7SrqW7p0l8t01UBrdRrcvepbNGbI7zujmiZcDWzaWkO9JXNLloxvCFHfNgK+pOW21mEeMviWy/6GQK5266M5uMGwsIs0yb8X71xd06Wq9UccZud19vyB8k6PF3Y/CTCY1i6aa0klRrl0IaJV0QGXxuraO4KQ1zrWWcQCpkqrDI3ph7KKHuTc+Mxzge35U0Bp/HAGE2Ys6hRqyaVFreuKvMTNmqgO/W6BJXlVviCImLVfgLrZfaoP87VMrfKtqADixBjKt4KB31SWxFKqddK3atwgKfsRJO3o6j9CDKBCbZSkUjKlp0zyn5yX6C0+ZchcLpjwoP4McIqFEz6keLvIxLvsl3/83MJrp82/iZhfgeU5BSb3YOg8f3LxjfP/NVZiAVZ1MaL5UP9p/ZJN9l59/nZcecZBIVPlk5LG2+/DkxP6r0tGLCWEcPVSzJS2bVILsfgsST/eLX/cefDN2y/kx7yB4gMf/jTP7ofntEU7ZPrRCYLxUmtBxXTEuV5T37jOWy4Fl3gb2XY7PDm5HRBvl2lyuo19F6pEW7jKEWLiTCsqs6sEMir70gtgU8Yl0FWqf0duotZKP27bfBpmjzHhtMOEl5tMOJMuSOrKTS/VHcp/LqXt5a1fnlCdl05WvJpJuAdy/UmH2Ha7J9JgVmtuF8no6iGZ91jFe75/dHWzvEkTYqyiYFaljMOY2SIZJcet2JZBfU8BKZrBCW0jh4bJnGKYG4Y0q/jx/SBZpusjtprdO6Gx7n3aAGPZlMvp46NuVly5oJ3zm9PhzSqsUPG/IsUVAuvbUGnCSWIKZDkZ6ss0IYH4dhUJ/Cpua4zRbQu7tZThWiAtxtE6obF11b0l2LU91jV42Y4y+TiSCw01kaFtwZ6G8Bi+aaI3rYBMKx5ztRLuJvQRIx8DFzIYnp463/qLgXNCX7x2/t3pq+VNx9VJkq474yK160Z5knRNTPfdMpt8vmTNjIgzN9d25+5cvzp3X2O0/RPlZCVsYFOnTaf3frDpUKPIVNlU6kXwX/7xsxsRN94pl8/gfa2hUjPUk9qX+00EzjnZWwS85q4hKwUaIxZAZtaUiuQh51OXDYxGTMYqNuaCkzoiMOWjlC2NZvrw/crhe6Z9YvQeBWkxEEq5imurgNVWlW6NeOXOlL6jmnUq/YYxFemSGWEQ4xCUBXO17+HopWRVUIU5mYWV5gaB8ZKAyTzFyYRn3N3lSlrNMgslk2yKtFjqHHviQlNmr9WYUh1Gidrbr1Toi2g9iZQ5Mn14R1XTjnAXnUVLW5t709VQOWROcVwn/KGCfUz+R0XL8wzNqoRC4D1qp2q8F1ILAZWiO4IzQcZTe29pIquZNHS1h8hw2JqGfcHAdGvkbNEHyp3QtUdmFgmA4PLO15tfNWL2PY4Nt7gKasxmsw2197w75s/cFvWYTDa1Gjd1jU5Jtoc3H8+TdF0/diVb4wRdvNvxKD7TAFZxf4vB1ZvzM3edQoGiWq1MQ7bEYVRmjgnw+AItWeXmOI5/TgePZIJ5rzweU1bxrWeUitPN+8kF6nueRRtqB6uOHfBxkiaCZygNtu7cN38+/xru4UX/JElbl85HMO/467O3X31z8RVhQ/eo59igf9I/cVFhZWzJZGupCxQTuPB371oapDFEDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9jDm9j/rDS4cPbmMPbmMPbmMPbmP01/Ye3MYe3MYe3MYe3MYe3MYe3Mf86b2NC3pc04nElGJetIhdfVXC1ejFzkyYFFRyMrpKHBwpef0flcNT8Y42aqhVu0uSeaU7hG1erkMZEO+WY75CyvW99NKp3SSunXhu5VNBaiQbVCfgRb7IMK/sobLsm4vz9xWWSJrF+sVQ5jdFsRi9+2MznkgMfXVadubJqweS0dinvxM9JtQGstkW3sODOFRaEH63MOZOLFobdigNPBv0lorYOeHjwRQvLZQPvu3aOCIyN0LRzN8vl8v8AT2zjBQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,f={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:""},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.a23572a7.js b/assets/js/bbdfc22d.a23572a7.js new file mode 100644 index 000000000..98c29723c --- /dev/null +++ b/assets/js/bbdfc22d.a23572a7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3844],{60092:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>g,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/createtemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createtemplate","permalink":"/docs/API-docs/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyHLeOv4LTL45VPSNpLDtePa2TeBOf9UaqWK7UlqRSON2YacbdZIdkazRRTdU+nD/YPzifli/ZAkj2dM9Fki+bo1TNi61pgiQAAiAAAreJE1ObHJ8nZ1jVpXBok8s0ydFmRtZOapUcJ2cFQhyGbw0K+g6vTt+AKEs9s9BYNBachowGEbLGOl3J38W4RHBx4RRmhcwKsGiuEYSFcdlgbaRyFibawBQVGuGkmkKus6ZCGphJV0BtMMeJVJiDdabJXGPQDuF9rRXYJsvQ2klTtjt5NKRWKbgCGVGDrjHKgoBGyd8ahL29CH0l8709cIVwkAkFYyRycqImIIQddMaCxrTihW2NmZxIAg5rDS/UhTqT9TG8r0stcpjrxsDpd//RLkHr0rfzvb3vcNxM4f2bvb3Lrwrnanu8vy/qeqhrVFZOVSnGdpjpaj8nwDqfPCUOokFalXFFYWU5B5HnMJP5FJ1lihVkup5DprXJpfKsr8UUQTXVGI1NQagcKm0QpAIBBkU+Hzg9aCzC39+d/EjHUQk3hNOysWm7XS4NZq6c++WJA5GqJ54zL47ofKSaplCJD3SQ0sFvjcw+ENkWFbM1nAnzam/vXVPX2jjM4WdPwvHeHo18g6WegTDI8JmuKq2gFkZU6Fja6MBo2OBvjTSYe1ERZRl5cXyhBnTO8xqP9/bgjcplRszgBekr6EmAHXpQYhKBvgsH60E7rKOT90JMPJkJf551KTKPpkGSCSevsb/wTQpzWvg7VDpiUGgjf9fKiZKP4xqNk5kou8dGCLKgOWFYL2otlYtfww7w3+F46PT4UIJcEWo5MauSikcswrUoG7QBq1kKBWH1E9YGLct3WJcYqXIoUE6LrfuJ/NfGut7C0FhCs4tF2CueErMXmW0TUVoEOenxshIfsLMbaDZCohzCN3PIcSKa0qUgSeKcaXAIP2oHoq5LmbG1IUNCyiPIRgz4lIM4BESUqPiMT42+ljmSScjlZIKGlJMGeYkwJ2JHclbzBCKPNccVQoFWKwed6VKbdRHiz30+QqaVQ+WG8OpayJKR98RakCormxxhXIrsQ8p2MgWDuVfcOZLVTb28MwgZU89z5g9YLEkKtSL8lQ7bS7u0WEM4K6Rd6hMNRlbzJtJ2uRq0dqJpZ2JBVDHASsgyZcal8Kseg5OuxJQUthZqnkIuHKbg8MaN9U0KWYHZB/7LiFxqGDfOkaGmPXOj61zPVODlRCtn5e8bNDKOfDxHRykcpfAihZcpHB6kcDhK4fAohcMXKRy+TGF0kMJolMLoKIXRC4/W6GXgtWgZ3EXgcOS57P463CW7+1Za1mwymLa1wbOeDT4cwt5eq0307ZdffrlQtxcK4CIh5bpIjuEiaUEuktSPkc2kscPw+4Z+PBt9HX7O6eeL0cvwc8agh0fhZ0E/R4cXahE2vFAjxsSJqr4DCxr+ohiEX0GI6BtvSt+iPaOPZIjSOEBn1cOHBhZdWp4RLVJJJ0Vpt5MTIR4RRUuU1og6IqJYXLdTxMOPiJwuPjTCZtIPsVntDEWFZyxGa9Q/H4abZTvxfttHQ3sHnc8j/QWRTqbpjEzTdvpb6/WImLCK0+dx4ushOwBsmbfzIQA8Ii70Mfo8HrwkHtCltJ0BNPqIqO+gQwPhhvdjB0eDw+eD0cHoqMcBio08QFUN8nwwn8+/BPfI5wnbk8sTPVTv2VEYOjG62hB+cHSwhAo+Ef8dXfb/Ikd9HH1YzCnu60ewMeLretlO52L+xPql4tTWOSP4pWs276DJQ4QHR79ZoWUWkCeY6JKNKcAbEg8GzMn9PN/vcJI+5vmgqgYrH+nngBnf+VhVwzwfrkCunY7/WEGep7D+eeP3PIeqqrZ89t8vEnap/m3ISQX2xLZLfwD4sxRgKef9je9UDsoHaFXy3hykbdaOlSukkCoMBFGBFQCD06YUBm8o2rRSKw/95TUnKs7SX+folAM7jv09K+Crk+CTPw1CTST0F6Av989bo6y7iMEp3vAaPi1GyMg85KdskxUUvYno+hPfl3ka/pWJWlKWoETn+Cu6bLgJCX9qnQibTnU1wLboesQIC3Hmhhibj5/F+/CAr7cQYNxxvwWIR2TiV1CiQZ+uoOHzi6QS7AGQlOHyb+0KNBfJZTvHR9WY3zP38gF6VMgcSzHGcn3owTrQpSXIU4cxNFBJ1WYCGN+DtDMoblYG/dhig255irtCHY14VI3IYiiljbmQPr+6s0OyiFN4Cn2ydYwQJ8C4FcPPFvMWsYfJubcC4XDu2YLggAHbRF3c7Z4degfTZQytUUklq6ZqM46TdtXIsirc5l1+0UxKw8cduqe7toO4uWeHkAjfssGFOuTMQMwo3OHrBYhHZAxWULpbTz/FTPTuyC90ud2vgJGsrgJuuBIJ1F+GrfLZ7do3hBO6gCjL6SdR3irLsHaU4/pc1WxRfvAVxFmgbmZru+R1oR6R9G1A6/9ZAgPcnyOFXfL+QpLYQ/vB0ujzeJWY3hHs8vAjkr+Az8rhJmmia3571epNnhwn/h03vmomKS+N1n2j83lyfJuETDv9GfLYNHX/V0vvxbeJzQqsBP0VUaIX5oksaSlKFqOxSZpw6oWem4lfyXGix79i5pKUAoiansPQ0ho87/g2QvkXxiQNgXhynPinxyRN8EZUNQGHT4Aq0xTu1vkkWcQN71qq/bJcyvIf7RMvrUOPeJ+4DE9drLywf9JK3RUWS7YuFxPGiHmy+pgfX+9ikObntc8T5TwqiXSkCu2TEoMlaSIdVt1dthya0R/P6Qw1UcJp2Y+dy8ciqo/ek+bVhVafNDG8lmzg+QO55EfXN+4f2SsKDjGPbvNg+cCZAj8yDO+TmAjP1Ippd0/vBK7tebbt4bvz3mYL3ZQ5vWShMEN+f/7k0gauHhFl1nABR3s59ChrUW0pO1ykyc39xNxApgfxVR2+KnHioKlrNJBpo9A87abWHg1xo6OjRZrM7ydv/pck72s6vNn91P3M5QjLUo1/Ba7PXi7SpLgf1x/agol/IbJHLxbLu27lKr8a63x+Fe3W4j7AeKkQHJXvvFEnJkfTYcRY6xKFWuPEm4n3rjQ8IVfkSchl8Tu3NDZeKDCTZQkGM6SaGU5JR1sFwefwj+AQ3h7JKXtNH9hZtM3YEpSK61m/4BjBGTmdItUFBQieHF7yUXAdGtXSEFZiQo/0XOtj8Frqxkb0CmH5sb1E8kddgdKXl0g17TuHHe5woUWX9mH3dOgLXXKKnv5Pzk4fwEt2XQfgiraMwFPp14CTs1OqHpKT4IYN4b1tORFZK3ogQG4RXEsRKwxa2z732QVUzBHNxPZKvYahbmcA6wjl0m7EKF3mN9tSwbWFl+VldES6cVTXJkPRhHVY2x4fGYuWkWe6eYhU3sNJAdOGn0ccqWwsJeKc67L6Rypfg8iBT96YWPAUxIIgqSBxyafIFQLqrJ8CKuunC5gI69CkVJ1InDcNBTbtknhTo5GoMtzIAoOedVeN2eg39XnQL6V5/9PbUFQYaYhKOSYN9AtjDk3NUsOa0JZ4xZNbJX3NUSLtQHO1zUFbdz24ECsk1Wo0ViugAiozFUr+7kWYPRJtEcZYiNKDBlNBj0uED2l4H5loa//4xz87eG31ONcR8zuIPKdM/z0YcmDrBZ48boM1WUDdx4jWQ/Pvq5cAYcdKc1XpvFUk+3AZP6W6P2dbu+g014liib6SNb48tPbWptHG2uBW0gOE4YcCrnjVNdGLN9K6TpFSfEpctw8/IfEx6+DAbghpNcm8mncVvMUrFEMtl+NSKtkvcGuvwTVdEI3TVwYrqR52T3WzA063hqBxuhJOZhCXssN+2SLVVi71uoKvImokjddSm6dbVJWWu9IqwyuprvAazQMcvB/bRG0u5iTcboaourhFJvnrbFlaNqNq4B5POrcTF1B2sXx+jz/gHYZlTB/uMqp61cr6kGZ0cED/rWhOrzKbLFtbtV3O/5akD08o3B1P+c+UwljX5aXKfVOMfrC1qrKCtKxCa/sh0YYp9xDQ5ZtUpVR4FZlyNTo4uHpOnFukydEm5rzTFbqCVYqM6cxoKqCuSxQkZ2YOYiqkAtrefEFeoTHa3E31x2F2FxOODg6uDlsmPF9nwhvFz1hcrH+mP6D6cyntbu/89oTqTcXXgr+3EumBeDzpEdv97om0mDVGunlyfH6b3AxELQd+/Pj8cnFJUucKTam2WlvGWLgiOU721zJv3C1BeZ3z24Tv9yTGDlaonN6a1uIHUcv968Nkka7O2BhtbIXGZvBxE6wTU6mmd8+6XPLmHZ2fP6Ieh5bZlFr+J1I6JRxAFypNJMlNgYIMPbGcxOKnZZ7ydTzcmEHclBRcHuJqmi9m+XqJu1XDvCEV18nEncc0GGe22sRWsiQoaZNP9GebTjpfimqbuYmJm0POeIyOjjg18PUhx9DPXnJ4evRicekZ3AnVOBPcjTf8A0PPcQ6f+o5kkqw4bj3vadV52urIbPFjwpYr93WLyKZr8vmCDn2iWULCsZ3UqN5RKEGae324nj3AMtNVW2Mdwf/4xz95RnQzGKu/UVr/pDFQ6xka6iiiuulJiTeS7lKCx4rHLGdI+QVBVCVaS2lT5XDq24XklAs2oluciVqMZSnJHhGY9oVRHZNmh/BzgfSOQ0NPjK9ducaSzFjrjXQao2CmzYcJNV+lIGBMbRfkj6IqhMq86+t1jF04ahWisKI20lI3iSGspcdNK2dE5qASSkzZB0t7XMqxlGSAwOgxRYZWl42PfZyQpTb+9Z4J4jccfht5fVPTEGc+KGgwWJBUXIcAyKY+APXqE/qRxhTr14SLzJD9wEaVmlqHKGfQlCXU2vk4njyhLo403RmhLGVFPC7xDFqGhdgEbah/f2+RTvitVB98ufsAzlth+hnHVjpc5mlms9maSXvan/O9dD80Y2qm0VY6bebL2VPpimbMZrC7SPvDr/R9bDfrmLnlGrnO7IZUkc7sfoFlvf8OHUmI3X91+oYv0Kfwx//8L7xFYRQUeualNWsMlvNlZxs3gvHJe7a19x9Hv6KhbjLHQqqmMSFDHEzSVZPdVzuDEzTEfNtrpBO1DMufRzSBsP8cMukmJikWGTsK0RyJWm4Mqqgfyp5M3qG5lhmG22vLCe8z8H6SJqXMUFnsOAOvvj99C9fwbHiQpJ178AGnvf/2zbevf3z3mrAhzfIcOxweDA84P6+tq4TqbPWt76o8W15NK69HrZ+0a9XctWruWjV3rZq7Vs1dq+auVXPXqrlr1dy1aq4RtWvV3LVq7lo1d62au1bNXavmrlVz16q5a9XctWo+FhO/a9XctWruWjV3rZq7Vs1H1SC3a9X8MyRw16q5a9V8QKtmKA0ir3C/LoXkWrRQ+u3LyM5XGzgv06SgOrPj8+T2lp7/3ptysaDPvzVcWnN+mSbXwkhKcnOJWhorq6gY6QPO6Rna5+wHZ7R/6sWdH9pXKvOoMMzPeMXHfidstxTu9OTdWZIm49BkWumc5hgxowZUMfMVSYGb3GMouH2oFGracG1U4tdc+Drgol9J9oErycIfnRIroeYdDPslZp4M+peI2jjh9tZXqS0WLbwf2jojMDZC0/ldLhaL/wMWl8hR","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/get-template"}}');var s=t(74848),r=t(28453),o=t(33617),a=t.n(o),l=t(17543),c=t.n(l),d=t(86013),p=t.n(d),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyHLeOv4LTL45VPSNpLDtePa2TeBOf9UaqWK7UlqRSON2YacbdZIdkazRRTdU+nD/YPzifli/ZAkj2dM9Fki+bo1TNi61pgiQAAiAAAreJE1ObHJ8nZ1jVpXBok8s0ydFmRtZOapUcJ2cFQhyGbw0K+g6vTt+AKEs9s9BYNBachowGEbLGOl3J38W4RHBx4RRmhcwKsGiuEYSFcdlgbaRyFibawBQVGuGkmkKus6ZCGphJV0BtMMeJVJiDdabJXGPQDuF9rRXYJsvQ2klTtjt5NKRWKbgCGVGDrjHKgoBGyd8ahL29CH0l8709cIVwkAkFYyRycqImIIQddMaCxrTihW2NmZxIAg5rDS/UhTqT9TG8r0stcpjrxsDpd//RLkHr0rfzvb3vcNxM4f2bvb3Lrwrnanu8vy/qeqhrVFZOVSnGdpjpaj8nwDqfPCUOokFalXFFYWU5B5HnMJP5FJ1lihVkup5DprXJpfKsr8UUQTXVGI1NQagcKm0QpAIBBkU+Hzg9aCzC39+d/EjHUQk3hNOysWm7XS4NZq6c++WJA5GqJ54zL47ofKSaplCJD3SQ0sFvjcw+ENkWFbM1nAnzam/vXVPX2jjM4WdPwvHeHo18g6WegTDI8JmuKq2gFkZU6Fja6MBo2OBvjTSYe1ERZRl5cXyhBnTO8xqP9/bgjcplRszgBekr6EmAHXpQYhKBvgsH60E7rKOT90JMPJkJf551KTKPpkGSCSevsb/wTQpzWvg7VDpiUGgjf9fKiZKP4xqNk5kou8dGCLKgOWFYL2otlYtfww7w3+F46PT4UIJcEWo5MauSikcswrUoG7QBq1kKBWH1E9YGLct3WJcYqXIoUE6LrfuJ/NfGut7C0FhCs4tF2CueErMXmW0TUVoEOenxshIfsLMbaDZCohzCN3PIcSKa0qUgSeKcaXAIP2oHoq5LmbG1IUNCyiPIRgz4lIM4BESUqPiMT42+ljmSScjlZIKGlJMGeYkwJ2JHclbzBCKPNccVQoFWKwed6VKbdRHiz30+QqaVQ+WG8OpayJKR98RakCormxxhXIrsQ8p2MgWDuVfcOZLVTb28MwgZU89z5g9YLEkKtSL8lQ7bS7u0WEM4K6Rd6hMNRlbzJtJ2uRq0dqJpZ2JBVDHASsgyZcal8Kseg5OuxJQUthZqnkIuHKbg8MaN9U0KWYHZB/7LiFxqGDfOkaGmPXOj61zPVODlRCtn5e8bNDKOfDxHRykcpfAihZcpHB6kcDhK4fAohcMXKRy+TGF0kMJolMLoKIXRC4/W6GXgtWgZ3EXgcOS57P463CW7+1Za1mwymLa1wbOeDT4cwt5eq0307ZdffrlQtxcK4CIh5bpIjuEiaUEuktSPkc2kscPw+4Z+PBt9HX7O6eeL0cvwc8agh0fhZ0E/R4cXahE2vFAjxsSJqr4DCxr+ohiEX0GI6BtvSt+iPaOPZIjSOEBn1cOHBhZdWp4RLVJJJ0Vpt5MTIR4RRUuU1og6IqJYXLdTxMOPiJwuPjTCZtIPsVntDEWFZyxGa9Q/H4abZTvxfttHQ3sHnc8j/QWRTqbpjEzTdvpb6/WImLCK0+dx4ushOwBsmbfzIQA8Ii70Mfo8HrwkHtCltJ0BNPqIqO+gQwPhhvdjB0eDw+eD0cHoqMcBio08QFUN8nwwn8+/BPfI5wnbk8sTPVTv2VEYOjG62hB+cHSwhAo+Ef8dXfb/Ikd9HH1YzCnu60ewMeLretlO52L+xPql4tTWOSP4pWs276DJQ4QHR79ZoWUWkCeY6JKNKcAbEg8GzMn9PN/vcJI+5vmgqgYrH+nngBnf+VhVwzwfrkCunY7/WEGep7D+eeP3PIeqqrZ89t8vEnap/m3ISQX2xLZLfwD4sxRgKef9je9UDsoHaFXy3hykbdaOlSukkCoMBFGBFQCD06YUBm8o2rRSKw/95TUnKs7SX+folAM7jv09K+Crk+CTPw1CTST0F6Av989bo6y7iMEp3vAaPi1GyMg85KdskxUUvYno+hPfl3ka/pWJWlKWoETn+Cu6bLgJCX9qnQibTnU1wLboesQIC3Hmhhibj5/F+/CAr7cQYNxxvwWIR2TiV1CiQZ+uoOHzi6QS7AGQlOHyb+0KNBfJZTvHR9WY3zP38gF6VMgcSzHGcn3owTrQpSXIU4cxNFBJ1WYCGN+DtDMoblYG/dhig255irtCHY14VI3IYiiljbmQPr+6s0OyiFN4Cn2ydYwQJ8C4FcPPFvMWsYfJubcC4XDu2YLggAHbRF3c7Z4degfTZQytUUklq6ZqM46TdtXIsirc5l1+0UxKw8cduqe7toO4uWeHkAjfssGFOuTMQMwo3OHrBYhHZAxWULpbTz/FTPTuyC90ud2vgJGsrgJuuBIJ1F+GrfLZ7do3hBO6gCjL6SdR3irLsHaU4/pc1WxRfvAVxFmgbmZru+R1oR6R9G1A6/9ZAgPcnyOFXfL+QpLYQ/vB0ujzeJWY3hHs8vAjkr+Az8rhJmmia3571epNnhwn/h03vmomKS+N1n2j83lyfJuETDv9GfLYNHX/V0vvxbeJzQqsBP0VUaIX5oksaSlKFqOxSZpw6oWem4lfyXGix79i5pKUAoiansPQ0ho87/g2QvkXxiQNgXhynPinxyRN8EZUNQGHT4Aq0xTu1vkkWcQN71qq/bJcyvIf7RMvrUOPeJ+4DE9drLywf9JK3RUWS7YuFxPGiHmy+pgfX+9ikObntc8T5TwqiXSkCu2TEoMlaSIdVt1dthya0R/P6Qw1UcJp2Y+dy8ciqo/ek+bVhVafNDG8lmzg+QO55EfXN+4f2SsKDjGPbvNg+cCZAj8yDO+TmAjP1Ippd0/vBK7tebbt4bvz3mYL3ZQ5vWShMEN+f/7k0gauHhFl1nABR3s59ChrUW0pO1ykyc39xNxApgfxVR2+KnHioKlrNJBpo9A87abWHg1xo6OjRZrM7ydv/pck72s6vNn91P3M5QjLUo1/Ba7PXi7SpLgf1x/agol/IbJHLxbLu27lKr8a63x+Fe3W4j7AeKkQHJXvvFEnJkfTYcRY6xKFWuPEm4n3rjQ8IVfkSchl8Tu3NDZeKDCTZQkGM6SaGU5JR1sFwefwj+AQ3h7JKXtNH9hZtM3YEpSK61m/4BjBGTmdItUFBQieHF7yUXAdGtXSEFZiQo/0XOtj8Frqxkb0CmH5sb1E8kddgdKXl0g17TuHHe5woUWX9mH3dOgLXXKKnv5Pzk4fwEt2XQfgiraMwFPp14CTs1OqHpKT4IYN4b1tORFZK3ogQG4RXEsRKwxa2z732QVUzBHNxPZKvYahbmcA6wjl0m7EKF3mN9tSwbWFl+VldES6cVTXJkPRhHVY2x4fGYuWkWe6eYhU3sNJAdOGn0ccqWwsJeKc67L6Rypfg8iBT96YWPAUxIIgqSBxyafIFQLqrJ8CKuunC5gI69CkVJ1InDcNBTbtknhTo5GoMtzIAoOedVeN2eg39XnQL6V5/9PbUFQYaYhKOSYN9AtjDk3NUsOa0JZ4xZNbJX3NUSLtQHO1zUFbdz24ECsk1Wo0ViugAiozFUr+7kWYPRJtEcZYiNKDBlNBj0uED2l4H5loa//4xz87eG31ONcR8zuIPKdM/z0YcmDrBZ48boM1WUDdx4jWQ/Pvq5cAYcdKc1XpvFUk+3AZP6W6P2dbu+g014liib6SNb48tPbWptHG2uBW0gOE4YcCrnjVNdGLN9K6TpFSfEpctw8/IfEx6+DAbghpNcm8mncVvMUrFEMtl+NSKtkvcGuvwTVdEI3TVwYrqR52T3WzA063hqBxuhJOZhCXssN+2SLVVi71uoKvImokjddSm6dbVJWWu9IqwyuprvAazQMcvB/bRG0u5iTcboaourhFJvnrbFlaNqNq4B5POrcTF1B2sXx+jz/gHYZlTB/uMqp61cr6kGZ0cED/rWhOrzKbLFtbtV3O/5akD08o3B1P+c+UwljX5aXKfVOMfrC1qrKCtKxCa/sh0YYp9xDQ5ZtUpVR4FZlyNTo4uHpOnFukydEm5rzTFbqCVYqM6cxoKqCuSxQkZ2YOYiqkAtrefEFeoTHa3E31x2F2FxOODg6uDlsmPF9nwhvFz1hcrH+mP6D6cyntbu/89oTqTcXXgr+3EumBeDzpEdv97om0mDVGunlyfH6b3AxELQd+/Pj8cnFJUucKTam2WlvGWLgiOU721zJv3C1BeZ3z24Tv9yTGDlaonN6a1uIHUcv968Nkka7O2BhtbIXGZvBxE6wTU6mmd8+6XPLmHZ2fP6Ieh5bZlFr+J1I6JRxAFypNJMlNgYIMPbGcxOKnZZ7ydTzcmEHclBRcHuJqmi9m+XqJu1XDvCEV18nEncc0GGe22sRWsiQoaZNP9GebTjpfimqbuYmJm0POeIyOjjg18PUhx9DPXnJ4evRicekZ3AnVOBPcjTf8A0PPcQ6f+o5kkqw4bj3vadV52urIbPFjwpYr93WLyKZr8vmCDn2iWULCsZ3UqN5RKEGae324nj3AMtNVW2Mdwf/4xz95RnQzGKu/UVr/pDFQ6xka6iiiuulJiTeS7lKCx4rHLGdI+QVBVCVaS2lT5XDq24XklAs2oluciVqMZSnJHhGY9oVRHZNmh/BzgfSOQ0NPjK9ducaSzFjrjXQao2CmzYcJNV+lIGBMbRfkj6IqhMq86+t1jF04ahWisKI20lI3iSGspcdNK2dE5qASSkzZB0t7XMqxlGSAwOgxRYZWl42PfZyQpTb+9Z4J4jccfht5fVPTEGc+KGgwWJBUXIcAyKY+APXqE/qRxhTr14SLzJD9wEaVmlqHKGfQlCXU2vk4njyhLo403RmhLGVFPC7xDFqGhdgEbah/f2+RTvitVB98ufsAzlth+hnHVjpc5mlms9maSXvan/O9dD80Y2qm0VY6bebL2VPpimbMZrC7SPvDr/R9bDfrmLnlGrnO7IZUkc7sfoFlvf8OHUmI3X91+oYv0Kfwx//8L7xFYRQUeualNWsMlvNlZxs3gvHJe7a19x9Hv6KhbjLHQqqmMSFDHEzSVZPdVzuDEzTEfNtrpBO1DMufRzSBsP8cMukmJikWGTsK0RyJWm4Mqqgfyp5M3qG5lhmG22vLCe8z8H6SJqXMUFnsOAOvvj99C9fwbHiQpJ178AGnvf/2zbevf3z3mrAhzfIcOxweDA84P6+tq4TqbPWt76o8W15NK69HrZ+0a9XctWruWjV3rZq7Vs1dq+auVXPXqrlr1dy1aq4RtWvV3LVq7lo1d62au1bNXavmrlVz16q5a9XctWo+FhO/a9XctWruWjV3rZq7Vs1H1SC3a9X8MyRw16q5a9V8QKtmKA0ir3C/LoXkWrRQ+u3LyM5XGzgv06SgOrPj8+T2lp7/3ptysaDPvzVcWnN+mSbXwkhKcnOJWhorq6gY6QPO6Rna5+wHZ7R/6sWdH9pXKvOoMMzPeMXHfidstxTu9OTdWZIm49BkWumc5hgxowZUMfMVSYGb3GMouH2oFGracG1U4tdc+Drgol9J9oErycIfnRIroeYdDPslZp4M+peI2jjh9tZXqS0WLbwf2jojMDZC0/ldLhaL/wMWl8hR",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},b=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(c(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.cb265dda.js b/assets/js/bbdfc22d.cb265dda.js deleted file mode 100644 index 717951870..000000000 --- a/assets/js/bbdfc22d.cb265dda.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3844],{60092:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>f,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/createtemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createtemplate","permalink":"/docs/API-docs/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11zIzeOfwXbL5NxtWRLcSZzfrrJx+3OXi52xZ5KXdkuh+qG1Mx0kx2SbVlx6W1/yf60/SVXAMlWtz5sz8dlnSq92GoSJAEQBAEQuE+cmNnk5DK5wKouhUObXKdJjjYzsnZSq+QkuSgQYjd8a1BQO7w5ewuiLPXcQmPRWHAaMupEyBrrdCV/F5MSwcWJU5gXMivAorlFEBYmZYO1kcpZmGoDM1RohJNqBrnOmgqpYy5dAbXBHKdSYQ7WmSZzjUE7hHe1VmCbLENrp03ZruTRkFql4ApkRA26xigLAholf2sQDg4i9I3MDw7AFcJBJhRMkMjJiZqAEHbQmQjq04ontjVmcioJOMw1vFJX6kLWJ/CuLrXIYaEbA2ff/Vc7Bc1LbZcHB9/hpJnBu7cHB9dfFM7V9uTwUNT1UNeorJypUkzsMNPVYU6AdT59SRxEgzQr44rCynIBIs9hLvMZOssUK8h0vYBMa5NL5VlfixmCaqoJGpuCUDlU2iBIBQIMinwxcHrQWIS/n5/+SNtRCTeEs7KxabtcLg1mrlz46YkDkaoXnjOvjml/pJqlUIn3tJHSwW+NzN4T2RYVszXsCfPq4OC8qWttHObwsyfh5OCAer7BUs9BGGT4TFeVVlALIyp0LG20YdRt8LdGGsy9qIiyjLw4uVID2udFjScHB/BW5TIjZvCE1Ap6GmCHHpSYRKDnYWM9aId1tPNeiIknc+H3sy5F5tE0SDLh5C32J75LYUETf4dKRwwKbeTvWjlR8nbconEyE2V32whBFjQnDJ+LWkvlYmtYAf43bA/tHm9KkCtCLSdmVVJxj0W4FWWDNmA1T6EgrH7C2qBl+Q7zEiNVDgXKWbFzPZH/2ljXmxgaS2h2sQhrxV1i9iKzbSpKiyCnPV5W4j12VgPNSkiUQ/hmATlORVO6FCRJnDMNDuFH7UDUdSkz1jakSOjwCNIRA97lIA4BESUq3uMzo29ljqQScjmdoqHDSZ08RRgTsSM5q3kAkccnxxVCgVZrG53pUptNEeLmPh8h08qhckN4cytkych7Yi1IlZVNjjApRfY+ZT2ZgsHcH9wFktZNvbwzCClTz3PmD1gsSQq1IvyVDstLu9JYQ7gopF2dJ+qMrOZFpO1yNZzaqaaViQXxiAFWQpYpMy6FX/UEnHQlpnRga6EWKeTCYQoO79xE36WQFZi9519G5FLDpHGOFDWtmRtd53quAi+nWjkrf99yImPPh3N0nMJxCq9SeJ3C6CiF0TiF0XEKo1cpjF6nMD5KYTxOYXycwviVR2v8OvBatAzuIjAaey67Pw93Se/+IC2fbFKYttXB854OHg3h4KA9TdT2yy+/XKn7KwVwldDhukpO4CppQa6S1PeRzqS+Ufi+o48vx1+HzwV9vhq/Dp9zBh0dh8+CPsejK7UMC16pMWPiRFU/gAV1f1YMwlcQImrjRakt6jNqJEWUxg7aqx4+1LHs0vIl0SKVdFKUdjc5EeIZUbRCaYOoYyKKxXU3Rdz9jMjp4kM9rCZ9F6vVTlc88IzFeIP6r4bhZtlNvF/22dDeQefTSH9FpJNquiDVtJv+Vns9Iyas4/RpnPh6yAYAa+bdfAgAz4gLfYw+jQeviQd0Ke1mAPU+I+o76FBHuOF939HxYPTVYHw0Pu5xgHwjD1BVgzwfLBaLz8E9snnC8mTyRAvVW3bkhk6Nrra4H+wdrKCCTcS/o8n+P2SoT6INizn5fX0PNnp8XSvb6VwsXlg/VRzaGmcEvzLNFh00uYvwYO83K7TMAvIEE02yCTl4Q+LBgDl5mOeHHU5SY54Pqmqw1kifA2Z8p7Gqhnk+XIPc2B3fWEGep7DZvLU9z6Gqqh3Nvv0qYZPqP4YcVGBLbLf0B4A/6gCs5Ly/8IOHg+IBWpW8Njtp20/H2hVSSBU6gqjAGoDBWVMKg3fkbVqplYf+/CcnHpyVvc7eKTt27Pt7VsAXp8EmfxmEmkjoT0Atj4/boKw7icEZ3vEcPixGyMg8xKdskxXkvYlo+hPfV3Ea/spELSlKUKJz3IouG25Dwu9ax8OmXV13sC26HjHCQhy5xcfm7WfxHh3x9RYcjAfutwDxjFT8GkrU6cMV1H15lVSCLQCSMlz91q5Ac5Vct2O8V435I2Ovn3COCpljKSZYbnY9+Qx0aQny1GEMdVRStZEAxvco7XSKu7VO37fccrY8xV2hjko8Ho3IYiiljbGQPr+6o0OwiEN4Cn2wdYIQB8CkFcNPFvMWsafJudcCYXMeWYLggAHbQF1c7ZEVehvTZQzNUUklq6ZqI47TdtbIsirc5l1+0UgKw8cVuru7sYK4e2SFEAjfscCVGnFkIEYUHrD1AsQzUgZrKD18Tj9GTfTuyM90uT1+ACNZ3QO45UokUH8ZtofP7j59QzilC4iinH4Qxa2yDGtHMa5PPZotyk++gjgK1I1s7Za8LtQzkr4taP0/S2CA+2OksEven0gSe2g/WRp9HK8SswecXe5+RvIX8Fnb3CRNdM1vr1q9zZOTxL/jxlfNJOWp0bpvdL5ITu6TEGmnnyGOTUMPf7X0Xnyf2KzAStCviBK9ME9lSVNRsBiNTdKEQy/03Ez8Sk4SPfkVM5ek5EDU9ByGlubgcSf3Ecq/MCZpcMSTk8Q/PSZpgneiqgk4NAGqTJO7W+fTZBkXfGiqtmU1leUf7RMvzUOPeB85DQ9drr2wf9RM3RmWK7auJhPGiEWy/pgfX++ik+bHtc8T5SIeEunoKLRPSgyWpIl0WHVX2bFpRn84pzPURAmHZT90LG+LqD54TRpXF1p91MDwWrKF50/kku/dXLi/ZW/IOcQ8ms2D1QNnCvzIMHxMYiI8Uytm3TW9Ebix5sWuh+/Oe5stdFPm9JKFwgz5/fmjUxs4e0SUWcMJHO3l0KOsRbWlbLRMk7vHibmDTA/iqzp8UeLUQVPXaCDTRqF52Q2tPRvixsfHyzRZPE7e4k9J3te0efPHqfuZ0xFWqRr/Dly/fL1Mk+JxXP/WJkz8G5E9frVc3XVrV/nNROeLm6i3lo8BxkuF4Ch95606NTmaDiMmWpco1AYn3k69daXhBZkiL0Isi9+5pbHxQoG5LEswmCHlzHBIOuoqCDaHfwSH8PZIRtn31MDGom0mlqBUnM/6CScIzsjZDCkvKEDw4PCSj4Lz0CiXhrASU3qk51wfg7dSNzaiVwjLj+0lkj3qCpQ+vUSqWd847HCHEy26tA+7u0MtdMkpevo/vTh7Ai/ZdB2AK9o0Ak+lnwNOL84oe0hOgxk2hHe25URkreiBAJlFcCtFzDBodfvCRxdQMUc0E9tL9RqGvJ0BbCKUS7sVo3QV32xTBTcmXqWX0RbpxlFemwxJE9ZhbXt8ZCxaRl7o5ilS+QgnBcwafh5xdGRjKhHHXFfZP1L5HER2fPLGxISnIBYESQmJKz5FrhBQZ/4UUFk/XMBUWIcmpexE4rxpyLFpp8S7Go1EleFWFhj0rLtpzFa7qc+DfirNu59+CEmFkYZ4KCd0Av3EmENTs9TwSWhTvOLOrZO+YSjR6UBzs8tA2zQ9OBErBNVqNFYroAQqMxNK/u5FmC0SbREmWIjSgwZVQY9LhA+d8D4yUdf+6x//7OC10+LcRMyvIPKcIv2PYMiOrRd4srgN1qQBdR8jmg/Nf65fAoQdH5qbSuftQbJPl/EzyvtzttWLTnOeKJboM1njy0Orb20adawNZiU9QBh+KOCMV10TvXgnreskKcWnxE398BMSH7MODmyG0KkmmVeL7gFv8QrJUKvpOJVK9hPc2mtw7Sw8fJ35+27lkgZVTEmbWllvkY+Pjujf2sb3EovpYLZJx+XiL0n6dH/4YXfAN5MHvimKK4n5phj/zdaqygoSkgqt7Vv0W4Y8QkCXb1KVUuFNZMrN+Ojo5ivi3DJNjrcx51xX6AqWCNIFc6Mp/7cuUVA+qlmAmAmpgJY3n5FXaIw2D1P9YZg9xITjo6ObUcuErzaZ8FbxKwznml/o96j+WEq7yzu/PKF6V7FW82o3kR6I+5Mesd12T6TFrDHSLZKTy/vkbiBqOfD9J5fXy2uSOldoihTV2jLGwhXJSXK4ETjiZH8KS1zeJ3w9JdH0tULl9FSyYf6KWh7ejpJluj5iq7G8ExqbwYcNsE7MpJo9POp6xZtz2j+/RT0OrYIBtfxvpGhA2IAuVJpIkpsCBdnTxHISi59WYbbv4+bGANi2mNZqE9ejVDFI1Ys7rV8VWyJJnUDSZYzicGCmjcskK4KSNnZCP9toyOVKVNvAQ4w7jNhhHx8fs2f79YhdwC9fs3d1/Gp57Rnc8TQ4kNk1l318vGf3haa+HZQka3ZH7/Jfv/t33sM7ruFoe0k11bzlYR9Oa1TnZNrSUbwdbXqzWGa6anN+I/i//vFPHhGvPV7mL3DaGKj1HA2Vt1AS77TEO0nGZKf6hoJ1HMwWVYnWUgRPOZz5yhU549yBaKFlohYTWUrSLQSmfY5ORz3ZIfxcID0pUNcL49MobrEklQSl1lzXQdZE43TVrY6BuTbvp4RSCgImVApANpJFjENQFUJlFOD3J4jtC6pjIZu3NtIiCFkRMNneOJ3KTNLEpEiNyBxUQokZGwope9XEhTom8hs9IdfF6rLxxjmVEyA6TyI/MAzhO3KGmHBqzNHRtufeLrep94uCXg11MhPyQWtaXmZoVwlXJd6iYY3hvdqmLKHWznuaZCl195YmckYoS367RyhuTcu+YD3zGrlYDIFeGegOIxuSBKCU6r2varlsxexnnFjpcBVRmM/nG9rrZX/MX6UrmgnZo3o1bsaNrOu6w9uPl0m6rub6km1wioaosb3aKVFLfyXB5Zuzt3w3QoFlvVqZhmwJgujMHhLg4Tk6MjjtYRz/km4vkgmR8eUaj7Co5VY7mkpg7On0HM2tzDBo/B2sOmTgwyRNSpmhsti5QN/89ewHuIUvh0dJ2rk7nsC8wx/efvv9j+ffEzZ0HXqOjYZHwyMOyWrrKqE6S33rC+kuVup87cGgtS321Xn76rx9dd6+Om9fnbevzttX5+2r8/bVefvqvA2i9tV5++q8fXXevjpvX523r87bV+ftq/P21Xn76rznouL31Xn76rx9dd6+Om9fnfesaqL21Xl/hATuq/P21XlPqM4L6TRkFR7WpZCcvxWyfX3q1eV6zd51mhSUm3Vymdzf0/PfO1Mul9T8W4OGEruu0+RWGElBbk7rSmM2EiXwvMcFPUP7mP3ggtZPvbjzQ/taNhslU/kRb3jbH4Ttpo+dnZ5fJGkyCXWFlc5pjBFzqjkUc5/FE7jJZWWCK0ZKoWYN5xMlfk5KoBKNK/rZV+85+yr86KQlCbXoYNhPy/Jk0F8iauuA+3uf2bVctvC+a+eIwNgITft3vVwu/w9HHQeX","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/get-template"}}');var s=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zIzeOfwXbL5NxtWRLcSZzfrrJx+3OXi52xZ5KXdkuh+qG1Mx0kx2SbVlx6W1/yf60/SVXAMlWtz5sz8dlnSq92GoSJAEQBAEQuE+cmNnk5DK5wKouhUObXKdJjjYzsnZSq+QkuSgQYjd8a1BQO7w5ewuiLPXcQmPRWHAaMupEyBrrdCV/F5MSwcWJU5gXMivAorlFEBYmZYO1kcpZmGoDM1RohJNqBrnOmgqpYy5dAbXBHKdSYQ7WmSZzjUE7hHe1VmCbLENrp03ZruTRkFql4ApkRA26xigLAholf2sQDg4i9I3MDw7AFcJBJhRMkMjJiZqAEHbQmQjq04ontjVmcioJOMw1vFJX6kLWJ/CuLrXIYaEbA2ff/Vc7Bc1LbZcHB9/hpJnBu7cHB9dfFM7V9uTwUNT1UNeorJypUkzsMNPVYU6AdT59SRxEgzQr44rCynIBIs9hLvMZOssUK8h0vYBMa5NL5VlfixmCaqoJGpuCUDlU2iBIBQIMinwxcHrQWIS/n5/+SNtRCTeEs7KxabtcLg1mrlz46YkDkaoXnjOvjml/pJqlUIn3tJHSwW+NzN4T2RYVszXsCfPq4OC8qWttHObwsyfh5OCAer7BUs9BGGT4TFeVVlALIyp0LG20YdRt8LdGGsy9qIiyjLw4uVID2udFjScHB/BW5TIjZvCE1Ap6GmCHHpSYRKDnYWM9aId1tPNeiIknc+H3sy5F5tE0SDLh5C32J75LYUETf4dKRwwKbeTvWjlR8nbconEyE2V32whBFjQnDJ+LWkvlYmtYAf43bA/tHm9KkCtCLSdmVVJxj0W4FWWDNmA1T6EgrH7C2qBl+Q7zEiNVDgXKWbFzPZH/2ljXmxgaS2h2sQhrxV1i9iKzbSpKiyCnPV5W4j12VgPNSkiUQ/hmATlORVO6FCRJnDMNDuFH7UDUdSkz1jakSOjwCNIRA97lIA4BESUq3uMzo29ljqQScjmdoqHDSZ08RRgTsSM5q3kAkccnxxVCgVZrG53pUptNEeLmPh8h08qhckN4cytkych7Yi1IlZVNjjApRfY+ZT2ZgsHcH9wFktZNvbwzCClTz3PmD1gsSQq1IvyVDstLu9JYQ7gopF2dJ+qMrOZFpO1yNZzaqaaViQXxiAFWQpYpMy6FX/UEnHQlpnRga6EWKeTCYQoO79xE36WQFZi9519G5FLDpHGOFDWtmRtd53quAi+nWjkrf99yImPPh3N0nMJxCq9SeJ3C6CiF0TiF0XEKo1cpjF6nMD5KYTxOYXycwviVR2v8OvBatAzuIjAaey67Pw93Se/+IC2fbFKYttXB854OHg3h4KA9TdT2yy+/XKn7KwVwldDhukpO4CppQa6S1PeRzqS+Ufi+o48vx1+HzwV9vhq/Dp9zBh0dh8+CPsejK7UMC16pMWPiRFU/gAV1f1YMwlcQImrjRakt6jNqJEWUxg7aqx4+1LHs0vIl0SKVdFKUdjc5EeIZUbRCaYOoYyKKxXU3Rdz9jMjp4kM9rCZ9F6vVTlc88IzFeIP6r4bhZtlNvF/22dDeQefTSH9FpJNquiDVtJv+Vns9Iyas4/RpnPh6yAYAa+bdfAgAz4gLfYw+jQeviQd0Ke1mAPU+I+o76FBHuOF939HxYPTVYHw0Pu5xgHwjD1BVgzwfLBaLz8E9snnC8mTyRAvVW3bkhk6Nrra4H+wdrKCCTcS/o8n+P2SoT6INizn5fX0PNnp8XSvb6VwsXlg/VRzaGmcEvzLNFh00uYvwYO83K7TMAvIEE02yCTl4Q+LBgDl5mOeHHU5SY54Pqmqw1kifA2Z8p7Gqhnk+XIPc2B3fWEGep7DZvLU9z6Gqqh3Nvv0qYZPqP4YcVGBLbLf0B4A/6gCs5Ly/8IOHg+IBWpW8Njtp20/H2hVSSBU6gqjAGoDBWVMKg3fkbVqplYf+/CcnHpyVvc7eKTt27Pt7VsAXp8EmfxmEmkjoT0Atj4/boKw7icEZ3vEcPixGyMg8xKdskxXkvYlo+hPfV3Ea/spELSlKUKJz3IouG25Dwu9ax8OmXV13sC26HjHCQhy5xcfm7WfxHh3x9RYcjAfutwDxjFT8GkrU6cMV1H15lVSCLQCSMlz91q5Ac5Vct2O8V435I2Ovn3COCpljKSZYbnY9+Qx0aQny1GEMdVRStZEAxvco7XSKu7VO37fccrY8xV2hjko8Ho3IYiiljbGQPr+6o0OwiEN4Cn2wdYIQB8CkFcNPFvMWsafJudcCYXMeWYLggAHbQF1c7ZEVehvTZQzNUUklq6ZqI47TdtbIsirc5l1+0UgKw8cVuru7sYK4e2SFEAjfscCVGnFkIEYUHrD1AsQzUgZrKD18Tj9GTfTuyM90uT1+ACNZ3QO45UokUH8ZtofP7j59QzilC4iinH4Qxa2yDGtHMa5PPZotyk++gjgK1I1s7Za8LtQzkr4taP0/S2CA+2OksEven0gSe2g/WRp9HK8SswecXe5+RvIX8Fnb3CRNdM1vr1q9zZOTxL/jxlfNJOWp0bpvdL5ITu6TEGmnnyGOTUMPf7X0Xnyf2KzAStCviBK9ME9lSVNRsBiNTdKEQy/03Ez8Sk4SPfkVM5ek5EDU9ByGlubgcSf3Ecq/MCZpcMSTk8Q/PSZpgneiqgk4NAGqTJO7W+fTZBkXfGiqtmU1leUf7RMvzUOPeB85DQ9drr2wf9RM3RmWK7auJhPGiEWy/pgfX++ik+bHtc8T5SIeEunoKLRPSgyWpIl0WHVX2bFpRn84pzPURAmHZT90LG+LqD54TRpXF1p91MDwWrKF50/kku/dXLi/ZW/IOcQ8ms2D1QNnCvzIMHxMYiI8Uytm3TW9Ebix5sWuh+/Oe5stdFPm9JKFwgz5/fmjUxs4e0SUWcMJHO3l0KOsRbWlbLRMk7vHibmDTA/iqzp8UeLUQVPXaCDTRqF52Q2tPRvixsfHyzRZPE7e4k9J3te0efPHqfuZ0xFWqRr/Dly/fL1Mk+JxXP/WJkz8G5E9frVc3XVrV/nNROeLm6i3lo8BxkuF4Ch95606NTmaDiMmWpco1AYn3k69daXhBZkiL0Isi9+5pbHxQoG5LEswmCHlzHBIOuoqCDaHfwSH8PZIRtn31MDGom0mlqBUnM/6CScIzsjZDCkvKEDw4PCSj4Lz0CiXhrASU3qk51wfg7dSNzaiVwjLj+0lkj3qCpQ+vUSqWd847HCHEy26tA+7u0MtdMkpevo/vTh7Ai/ZdB2AK9o0Ak+lnwNOL84oe0hOgxk2hHe25URkreiBAJlFcCtFzDBodfvCRxdQMUc0E9tL9RqGvJ0BbCKUS7sVo3QV32xTBTcmXqWX0RbpxlFemwxJE9ZhbXt8ZCxaRl7o5ilS+QgnBcwafh5xdGRjKhHHXFfZP1L5HER2fPLGxISnIBYESQmJKz5FrhBQZ/4UUFk/XMBUWIcmpexE4rxpyLFpp8S7Go1EleFWFhj0rLtpzFa7qc+DfirNu59+CEmFkYZ4KCd0Av3EmENTs9TwSWhTvOLOrZO+YSjR6UBzs8tA2zQ9OBErBNVqNFYroAQqMxNK/u5FmC0SbREmWIjSgwZVQY9LhA+d8D4yUdf+6x//7OC10+LcRMyvIPKcIv2PYMiOrRd4srgN1qQBdR8jmg/Nf65fAoQdH5qbSuftQbJPl/EzyvtzttWLTnOeKJboM1njy0Orb20adawNZiU9QBh+KOCMV10TvXgnreskKcWnxE398BMSH7MODmyG0KkmmVeL7gFv8QrJUKvpOJVK9hPc2mtw7Sw8fJ35+27lkgZVTEmbWllvkY+Pjujf2sb3EovpYLZJx+XiL0n6dH/4YXfAN5MHvimKK4n5phj/zdaqygoSkgqt7Vv0W4Y8QkCXb1KVUuFNZMrN+Ojo5ivi3DJNjrcx51xX6AqWCNIFc6Mp/7cuUVA+qlmAmAmpgJY3n5FXaIw2D1P9YZg9xITjo6ObUcuErzaZ8FbxKwznml/o96j+WEq7yzu/PKF6V7FW82o3kR6I+5Mesd12T6TFrDHSLZKTy/vkbiBqOfD9J5fXy2uSOldoihTV2jLGwhXJSXK4ETjiZH8KS1zeJ3w9JdH0tULl9FSyYf6KWh7ejpJluj5iq7G8ExqbwYcNsE7MpJo9POp6xZtz2j+/RT0OrYIBtfxvpGhA2IAuVJpIkpsCBdnTxHISi59WYbbv4+bGANi2mNZqE9ejVDFI1Ys7rV8VWyJJnUDSZYzicGCmjcskK4KSNnZCP9toyOVKVNvAQ4w7jNhhHx8fs2f79YhdwC9fs3d1/Gp57Rnc8TQ4kNk1l318vGf3haa+HZQka3ZH7/Jfv/t33sM7ruFoe0k11bzlYR9Oa1TnZNrSUbwdbXqzWGa6anN+I/i//vFPHhGvPV7mL3DaGKj1HA2Vt1AS77TEO0nGZKf6hoJ1HMwWVYnWUgRPOZz5yhU549yBaKFlohYTWUrSLQSmfY5ORz3ZIfxcID0pUNcL49MobrEklQSl1lzXQdZE43TVrY6BuTbvp4RSCgImVApANpJFjENQFUJlFOD3J4jtC6pjIZu3NtIiCFkRMNneOJ3KTNLEpEiNyBxUQokZGwope9XEhTom8hs9IdfF6rLxxjmVEyA6TyI/MAzhO3KGmHBqzNHRtufeLrep94uCXg11MhPyQWtaXmZoVwlXJd6iYY3hvdqmLKHWznuaZCl195YmckYoS367RyhuTcu+YD3zGrlYDIFeGegOIxuSBKCU6r2varlsxexnnFjpcBVRmM/nG9rrZX/MX6UrmgnZo3o1bsaNrOu6w9uPl0m6rub6km1wioaosb3aKVFLfyXB5Zuzt3w3QoFlvVqZhmwJgujMHhLg4Tk6MjjtYRz/km4vkgmR8eUaj7Co5VY7mkpg7On0HM2tzDBo/B2sOmTgwyRNSpmhsti5QN/89ewHuIUvh0dJ2rk7nsC8wx/efvv9j+ffEzZ0HXqOjYZHwyMOyWrrKqE6S33rC+kuVup87cGgtS321Xn76rx9dd6+Om9fnbevzttX5+2r8/bVefvqvA2i9tV5++q8fXXevjpvX523r87bV+ftq/P21Xn76rznouL31Xn76rx9dd6+Om9fnfesaqL21Xl/hATuq/P21XlPqM4L6TRkFR7WpZCcvxWyfX3q1eV6zd51mhSUm3Vymdzf0/PfO1Mul9T8W4OGEruu0+RWGElBbk7rSmM2EiXwvMcFPUP7mP3ggtZPvbjzQ/taNhslU/kRb3jbH4Ttpo+dnZ5fJGkyCXWFlc5pjBFzqjkUc5/FE7jJZWWCK0ZKoWYN5xMlfk5KoBKNK/rZV+85+yr86KQlCbXoYNhPy/Jk0F8iauuA+3uf2bVctvC+a+eIwNgITft3vVwu/w9HHQeX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,g={},j=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.911cc9c6.js b/assets/js/bfe4b778.911cc9c6.js deleted file mode 100644 index 381f1941b..000000000 --- a/assets/js/bfe4b778.911cc9c6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4948],{55151:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>f,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"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":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWF9vI7kN/yo8vXQXmNjObu6K+qnp7eIu6OFibLJYoNkgoEccWxeNpJM0dgzDb/0k/Wj9JAWlGXv8Z3Ob9tACfQkcDUmRP1LkT1qLiLMgxnfinS2bmkwM4r4QkkLplYvKGjEWt3OCj05iJOik4HJyBai1XQZoAvkA0UJtpapWgEZCk8XjnEBSRKUD2AoQgqNSVaoE2RoawM82CWKEOFchGbZGrzrr0XbGECpagkOPNUXyoYCVbaBEY2yEco5mljeslCawpiRQMXvQOa0ClJ4wkhyIQlhHHjnEKynGIm/SxScKsdtIjO/WwmBNYiw6Ww9KikIohsdhnItDzK7eccB7u6cYDZFMQU2pjYvtePq1UZ6kGEffUCFCXGneLajaaRKFoCenrSQxrlAHFijnVKMYr0VcuSQZvTIzUYjK+hrjbmWzuc/2KcS/WLlinX1XJ94ulCSYkrY9fHvIR6qdxkgBXmEETRgiWEM92S6A16IQpTWRIRyvBTqnVZlAHv4SeLf1set2+guVCXHPKYmKAn/NgP92gAwOJpjGIqQfW8jFphDGxhebmXCIBJ4WipapnoOamVyffdt7OL5si21V9G1sWEdL8lyRx/Z22ixJBqearm8nPdGptZrQHFUjVxWc5QBsWoSl0hqyDbi+ncCCPB/MlKsBfExnOsl4Kkkt+Pj1RaC0kmChEKhGpQtYzlU554JfQd2ECGTaGmqho96RT0UMZ3DskFThpEdFbgfKzHbt5sgwSOWpjHoFSxXntomAUipWRw0hkguDPorJiy2Qt7bx/zmSCLNGSZIQbeOhsj55mZqVS8eMI1AmRN+UrBxANpzdFAeL8m/nbUkh7HDqUGGhnv0CyISsjlBhiOQLaIxi5H3jIsmtSXpy5BWZkk5CkMB9SP27BTx8PRYT8rWKoYuUU4NSAmlK8wRCU84B83eMjadQgDIqKtShgBCxdqEA6yHSE/cViNZx86QnFSI7v1RyRjGA+lIdfSA+I2XPh8rbOmWfsTGrfiFs/Yr2wNwtJ1WFdmpV2OgIC9TNKcw2hYgq7h3lh95seJhyq91sWM5TcNaE3NXejEbHHXg7VduJwJBxBVSN1qtvfr+Wmpd/q7lgkG9+DJOLHx23mdaly/i80pvRm7dn56Oz0R9vz78bX/xp/O13g9Fo9DdRiKda7/q5YGuij176v7egjFaGHjrUHt6MRg9vWygvTqHXdmvXjrEFaiWhUqQl8J7hdwSQvLf+35wmz/j3XPgcchf8xTOlwySoso2R/+twT3n0fIAXDxfbEL89DvHKZMiYGd7aRzL/jQh38fS3j3l7dnW/qlUWSt/FXrD99RxkoLLxKq4SrXw6Q6fO8vfx3T2TtZri3DIldU3moXEuxmLYdZfhutdnNoLt+UXHUhuvxVjMY3RhPBwGNHJqnwbWkeHOqHEaBqWth+jUcHEuNsWhBjr3Amlqzl6mECLOlJk9r3W/g+iG05gztQfUNl/o1F9pJYouD32plp7PCSX5lDOujg87Kvy+y/E2jYf8saOPX8cID+fjSY7Xp3hC7NG4ltv3+Ui7dHI+d8NbmcomSNqau3Zkbtg7rtjF+ZFbn0iXtqZu/nXi//z7P5JG53Xa5hu4bjw4uyRfNToFXml6UsxGeldAvogxIyOsNYWgV8AkZOb58iDVTEUmYC0VKdHhVGnFR5DFLGt76J3iMIBPc4pz8vzpD55plaQFaT65oK19TIzJAjbR1mmPDuml9Y8Vu1QAwrQJylAIEIg6FTJz5KthV2GJeKDJdNV5FQhQ1SzM5I2qSpWKDXO/8VhGqNHgLDGIAthvRqFt7QG8nTL3DVY3md3xrZgo5hDT3W8A75hNp8B5MV+PSWZiF4pMrNv2w2EYCVMKERxvr0rK3Dei55vYgnw6Ufni22gNznJfVKiZQvVzy4aiRxO4eWeHutRs4WuZZ9pD4moAn81nc8PF0gTiAtDKPIbxZ3MGd9sy+0TToCLdv+pO+XK5PDrdr/d1flBx3kzBk7M7vVlaTL2gr779hy+XB21gv7I9VeQ5moTRjAylCkSncueGu8vJVRohMCftdjuzynFD4tUhCw5vKDITDcNO/zU3ea4JLNMMSpeg3I/+fGgnzQPydbiubsgvVEltR/wCVMMkPBSF0KokE/oN6vKHyU+wgLeDkSh6vfUrwBv+dPX9+59v3rM3PC4yYueD0WDES86GWKPpbXXw4nPYRta7Efz/+kDUzhi+lgydRpUmewJ93U7lO9Fr/uP+29B9IeY2RBZZr6cY6KPXmw0v/9qQ59l/X4gFesW9Po3u9pInt03/i3C/+tC9tsDLnplOBtRNUsNjNF138mB6pNXBe9fmflN045Q9zhLfZ7/ObtnOzsIRK2M2kDUuy5JcfFa2T4MmH29FIabt21WdnsGExyW/m+EyO5uv4okopLW10GhmDc5YNptkAoANZ63PHh4Te2h/cFAn4dinFTkK/ssxnVRYrzMz2Wy28vnTFzVaXDtpzs39ZrP5F2LSnQA=","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":"Revoke Document","permalink":"/docs/API-docs/revokedocument"}}');var o=n(74848),a=n(28453),s=n(33617),d=n.n(s),p=n(17543),l=n.n(p),r=n(86013),c=n.n(r),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const g={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:"eJzdWF9vI7kN/yo8vXQXmNjObu6K+qnp7eIu6OFibLJYoNkgoEccWxeNpJM0dgzDb/0k/Wj9JAWlGXv8Z3Ob9tACfQkcDUmRP1LkT1qLiLMgxnfinS2bmkwM4r4QkkLplYvKGjEWt3OCj05iJOik4HJyBai1XQZoAvkA0UJtpapWgEZCk8XjnEBSRKUD2AoQgqNSVaoE2RoawM82CWKEOFchGbZGrzrr0XbGECpagkOPNUXyoYCVbaBEY2yEco5mljeslCawpiRQMXvQOa0ClJ4wkhyIQlhHHjnEKynGIm/SxScKsdtIjO/WwmBNYiw6Ww9KikIohsdhnItDzK7eccB7u6cYDZFMQU2pjYvtePq1UZ6kGEffUCFCXGneLajaaRKFoCenrSQxrlAHFijnVKMYr0VcuSQZvTIzUYjK+hrjbmWzuc/2KcS/WLlinX1XJ94ulCSYkrY9fHvIR6qdxkgBXmEETRgiWEM92S6A16IQpTWRIRyvBTqnVZlAHv4SeLf1set2+guVCXHPKYmKAn/NgP92gAwOJpjGIqQfW8jFphDGxhebmXCIBJ4WipapnoOamVyffdt7OL5si21V9G1sWEdL8lyRx/Z22ixJBqearm8nPdGptZrQHFUjVxWc5QBsWoSl0hqyDbi+ncCCPB/MlKsBfExnOsl4Kkkt+Pj1RaC0kmChEKhGpQtYzlU554JfQd2ECGTaGmqho96RT0UMZ3DskFThpEdFbgfKzHbt5sgwSOWpjHoFSxXntomAUipWRw0hkguDPorJiy2Qt7bx/zmSCLNGSZIQbeOhsj55mZqVS8eMI1AmRN+UrBxANpzdFAeL8m/nbUkh7HDqUGGhnv0CyISsjlBhiOQLaIxi5H3jIsmtSXpy5BWZkk5CkMB9SP27BTx8PRYT8rWKoYuUU4NSAmlK8wRCU84B83eMjadQgDIqKtShgBCxdqEA6yHSE/cViNZx86QnFSI7v1RyRjGA+lIdfSA+I2XPh8rbOmWfsTGrfiFs/Yr2wNwtJ1WFdmpV2OgIC9TNKcw2hYgq7h3lh95seJhyq91sWM5TcNaE3NXejEbHHXg7VduJwJBxBVSN1qtvfr+Wmpd/q7lgkG9+DJOLHx23mdaly/i80pvRm7dn56Oz0R9vz78bX/xp/O13g9Fo9DdRiKda7/q5YGuij176v7egjFaGHjrUHt6MRg9vWygvTqHXdmvXjrEFaiWhUqQl8J7hdwSQvLf+35wmz/j3XPgcchf8xTOlwySoso2R/+twT3n0fIAXDxfbEL89DvHKZMiYGd7aRzL/jQh38fS3j3l7dnW/qlUWSt/FXrD99RxkoLLxKq4SrXw6Q6fO8vfx3T2TtZri3DIldU3moXEuxmLYdZfhutdnNoLt+UXHUhuvxVjMY3RhPBwGNHJqnwbWkeHOqHEaBqWth+jUcHEuNsWhBjr3Amlqzl6mECLOlJk9r3W/g+iG05gztQfUNl/o1F9pJYouD32plp7PCSX5lDOujg87Kvy+y/E2jYf8saOPX8cID+fjSY7Xp3hC7NG4ltv3+Ui7dHI+d8NbmcomSNqau3Zkbtg7rtjF+ZFbn0iXtqZu/nXi//z7P5JG53Xa5hu4bjw4uyRfNToFXml6UsxGeldAvogxIyOsNYWgV8AkZOb58iDVTEUmYC0VKdHhVGnFR5DFLGt76J3iMIBPc4pz8vzpD55plaQFaT65oK19TIzJAjbR1mmPDuml9Y8Vu1QAwrQJylAIEIg6FTJz5KthV2GJeKDJdNV5FQhQ1SzM5I2qSpWKDXO/8VhGqNHgLDGIAthvRqFt7QG8nTL3DVY3md3xrZgo5hDT3W8A75hNp8B5MV+PSWZiF4pMrNv2w2EYCVMKERxvr0rK3Dei55vYgnw6Ufni22gNznJfVKiZQvVzy4aiRxO4eWeHutRs4WuZZ9pD4moAn81nc8PF0gTiAtDKPIbxZ3MGd9sy+0TToCLdv+pO+XK5PDrdr/d1flBx3kzBk7M7vVlaTL2gr779hy+XB21gv7I9VeQ5moTRjAylCkSncueGu8vJVRohMCftdjuzynFD4tUhCw5vKDITDcNO/zU3ea4JLNMMSpeg3I/+fGgnzQPydbiubsgvVEltR/wCVMMkPBSF0KokE/oN6vKHyU+wgLeDkSh6vfUrwBv+dPX9+59v3rM3PC4yYueD0WDES86GWKPpbXXw4nPYRta7Efz/+kDUzhi+lgydRpUmewJ93U7lO9Fr/uP+29B9IeY2RBZZr6cY6KPXmw0v/9qQ59l/X4gFesW9Po3u9pInt03/i3C/+tC9tsDLnplOBtRNUsNjNF138mB6pNXBe9fmflN045Q9zhLfZ7/ObtnOzsIRK2M2kDUuy5JcfFa2T4MmH29FIabt21WdnsGExyW/m+EyO5uv4okopLW10GhmDc5YNptkAoANZ63PHh4Te2h/cFAn4dinFTkK/ssxnVRYrzMz2Wy28vnTFzVaXDtpzs39ZrP5F2LSnQA=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,v={},y=[];function I(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,o.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,o.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"document_document_id_body"}}}}}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.c60c5a5d.js b/assets/js/bfe4b778.c60c5a5d.js new file mode 100644 index 000000000..7b32e60b8 --- /dev/null +++ b/assets/js/bfe4b778.c60c5a5d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4948],{55151:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>f,contentTitle:()=>g,default:()=>x,frontMatter:()=>y,metadata:()=>o,toc:()=>w});const o=JSON.parse('{"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":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWF1u5LgRvkotXzIzkLvbM54N0k9xdgczRoyx4R8MEI/RoKRSi2uK5JJUtxsNAXnIDXKDHG1PEhQpqdU/9o6ziwTIi9GmisWqr4pVX3HNPJ87Nr1jP+qsrlB5x+4TlqPLrDBeaMWm7KZEuDU59widFJxengGXUi8d1A6tA6+h0rkoVsBVDnUU9yVCjp4L6UAXwMEZzEQhMshbRSP4rIMg9+BL4YJireSq0+51p4xDgUsw3PIKPVqXwErXkHGltIes5GoeDyyERNAqQxA+WtAZLRxkFrnHfMQSpg1aTi6e5WzK4iGdfyxhm4PY9G7NFK+QTVmnayZyljBB8BjuS7aL2dmP5PDW6cFHhZgHp1Js/SI9Fn+uhcWcTb2tMWHOrySd5kRlJLKE4aOROkc2Lbh0JJCVWHE2XTO/MkHSW6HmLGGFthX3m5WmuY/60fm/6HxFe7ZNvbR6IXKEFKUe4DtA3mNlJPfo4BX3IJE7D1rhQLZz4DVLWKaVJwina8aNkSILII9/cnTaet90nf6EWUDcUki8QEdfI+C/7iCBwwNMU+bCjx5y1iRMaf9iNZfkIoLFhcBlyGcn5irm51D3Fo4vO6LPiqGOhvbIHC1l5L6+zW6SRMVTiRc3lwPRVGuJXO1lI2UVHEUHdFiEpZASog64uLmEBVq6mCFWI7gNdzrIWMxQLOj6DUUg0znCQnDAiguZwLIUWUkJv4Kqdh5QtTnUQoeDKx+SGI5g36BcuIMWJbEcCDXflJs9xZALi5mXK1gKX+raA89zQdu5BOfRuNEQxWBFD+SNru1vR5LDvBY55uB1baHQNlgZipUJ14w8EMp5W2e02UFeU3SDHyRKv43VGTq3walDhYQG+hNA5eJ2DgV3Hm0CtRKEvK2Nx7xXiY8GrUCV4UEIArizUL9bwN23Y3GJthLedZ5SaHieA0oM/QRcnZXA43fua4suAaGEF1y6BJznlXEJaAseH6mugNeGiic+CufJ+KXI5+gdiKfy6ArpjmQDGwqrqxB9wkathonQ2+X1jrobCqpwbdcqeC09LLisD2NmMabbrLby0G3dxuo6Nj6M2m+vzmFZosU+7mhjHqVUdqJipDYabhod7Lss6bN9N132KgSvvZ5ZrITK8Vty+xp9AIXC6nWf0rXXFfcig06VG0ErGgPg9TBDK3jVgZdiyRdC29dPAEjqZtSpZ0LNcIF2NbBS1VWKds/Iz2GZ8iPnKwcp+iWiGtrWhTGyiNiByLZliQq2MCEpt3F6y8r3TZMwL/xWtZ4N2v8spW7aNE1wxRmtXGxcbyeT/SbbE6e26dOtoKgVtZSr736/rhmXf61/cJe//eQuTz4ZypPWpFP//Ka3k7fvjo4nR5M/3hx/Pz350/T996PJZPI3lrDHSm5aNiNtbIhe+H+wIJQUCmcdarO3k8nsXQvlySH02oZsWqay4FLkUAiUOdCZ7ncEEK3V9j8kDM/Y95z75HLn/MkzqUM8t9C1yv/X7h6y6HkHT2YnvYvv9108UxEyIv83+gHVf8PDjT/D4308nkzdzmoRhcJ3tuXscD066TCrrfCrMDk8HnEjjuL36d098fEKfalp6jB1HDV8yaZs3FWX8XpQZxpG+uyiG0RCu2Gl98ZNx2PHVZ7qx5E2qKghSJ66UaarMTdivDhmTbK7gxvzAmmsj162wXk+F2r+/K77DUTXFMYYqS2g+nhxI/6KK5Z0cRhKtRNYiZw6HCFP2XG1mXY+dDHuw7g7InQTwreR/t1udJDGD1k8Y1tMvR3fhpSzXTpIwdpv21SDVO609l7uUEd93xBMhQ6Ytkl7YVBdk3uU8ovjPb++oMx0hR1H6sR/+ce/wo7O7WDnd1/VV3VRWzB6ibaoZQCvkPgoqO2SPFbhmwsTO1F35JVE5+QKiK3OLU2ZuZgLT0y95TUZNzwVUtBFJjFNuy0MaoEbwZcSfYmWPv3BEv/OcYGS7n9PXNR8w5mW2j4U9K6QAIe0dkKhc4Cq5CojwS4rAx/lKk4xxgqH4Lwlq0W0TStveeah4orPA6FMtlDKUQq6smB1SuOQ07KOhJ9eQ7QNFD46FJ4ERgTiB5ryLQKtEuuzWNIFWrSs3yVx6oopTC6oHFJ0HgzZIjKMzyVK6uwhPoXUUoLRVEYFl0SahjbSdm+5clTroy1dDHrAWnKJ0cA3b24dUoTPhXpw0zdvvqojuOuT6QumTni8f9UVg+VyuVcEXm/v+Sj8pzqFKzTaCa/tarN7LnxZp6FwDJX0/0RNH1FhyJ9BYdjoyHXm9usQrY5LlGZ8jZ4yxI1PL89C53kNv/z9n3CO3Coo9TJma1ZblCuYd0cRcjHyEba+cYSRj9e+JMSzmHzt4wshSFRpu8htXzuLBVoCPwRyc5wRrfq7zkwg63+Lm9TCKIt5FjpsmOJjtf3zrp7Q7dBW7qK4RrsQGbb1/okIj4PwmCVMigyVG5bf04+X57CAd6MJSwad4xuiPT4/++HD5+sPZA3drIjY8WgymtCS0c5XXA2O2nmy3K1x6w3B+H994Ww7KM3VYyO5CLylHVcj57hjg9Y2HT5u3ies1M6TyHqdcoe3VjYNLf9ch7Zyd5+wBbeCOlkgJu0MmPft6Em4X111z4XwsnfSgw51PEERSQjzeuyRD7jaebBt7pukIwtkcZT4Idp1dEN6Nhr2OCdxnbjjNMvQ+GdlhyTv8vaGJSxtH1+r8I7LLF/Swy9fRmPjW1KgQWFtzSRX85rPSTaqbOJIX25zo4fAjdof5NRBOLZJU/SC/pJPBzes15F3NU0vHz89uaPFtZOm2Nw3TfNvtvudpQ==","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":"Revoke Document","permalink":"/docs/API-docs/revokedocument"}}');var n=i(74848),a=i(28453),s=i(33617),d=i.n(s),r=i(17543),c=i.n(r),p=i(86013),u=i.n(p),l=i(63723),m=i.n(l),h=(i(18766),i(79329),i(9303));const y={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWF1u5LgRvkotXzIzkLvbM54N0k9xdgczRoyx4R8MEI/RoKRSi2uK5JJUtxsNAXnIDXKDHG1PEhQpqdU/9o6ziwTIi9GmisWqr4pVX3HNPJ87Nr1jP+qsrlB5x+4TlqPLrDBeaMWm7KZEuDU59widFJxengGXUi8d1A6tA6+h0rkoVsBVDnUU9yVCjp4L6UAXwMEZzEQhMshbRSP4rIMg9+BL4YJireSq0+51p4xDgUsw3PIKPVqXwErXkHGltIes5GoeDyyERNAqQxA+WtAZLRxkFrnHfMQSpg1aTi6e5WzK4iGdfyxhm4PY9G7NFK+QTVmnayZyljBB8BjuS7aL2dmP5PDW6cFHhZgHp1Js/SI9Fn+uhcWcTb2tMWHOrySd5kRlJLKE4aOROkc2Lbh0JJCVWHE2XTO/MkHSW6HmLGGFthX3m5WmuY/60fm/6HxFe7ZNvbR6IXKEFKUe4DtA3mNlJPfo4BX3IJE7D1rhQLZz4DVLWKaVJwina8aNkSILII9/cnTaet90nf6EWUDcUki8QEdfI+C/7iCBwwNMU+bCjx5y1iRMaf9iNZfkIoLFhcBlyGcn5irm51D3Fo4vO6LPiqGOhvbIHC1l5L6+zW6SRMVTiRc3lwPRVGuJXO1lI2UVHEUHdFiEpZASog64uLmEBVq6mCFWI7gNdzrIWMxQLOj6DUUg0znCQnDAiguZwLIUWUkJv4Kqdh5QtTnUQoeDKx+SGI5g36BcuIMWJbEcCDXflJs9xZALi5mXK1gKX+raA89zQdu5BOfRuNEQxWBFD+SNru1vR5LDvBY55uB1baHQNlgZipUJ14w8EMp5W2e02UFeU3SDHyRKv43VGTq3walDhYQG+hNA5eJ2DgV3Hm0CtRKEvK2Nx7xXiY8GrUCV4UEIArizUL9bwN23Y3GJthLedZ5SaHieA0oM/QRcnZXA43fua4suAaGEF1y6BJznlXEJaAseH6mugNeGiic+CufJ+KXI5+gdiKfy6ArpjmQDGwqrqxB9wkathonQ2+X1jrobCqpwbdcqeC09LLisD2NmMabbrLby0G3dxuo6Nj6M2m+vzmFZosU+7mhjHqVUdqJipDYabhod7Lss6bN9N132KgSvvZ5ZrITK8Vty+xp9AIXC6nWf0rXXFfcig06VG0ErGgPg9TBDK3jVgZdiyRdC29dPAEjqZtSpZ0LNcIF2NbBS1VWKds/Iz2GZ8iPnKwcp+iWiGtrWhTGyiNiByLZliQq2MCEpt3F6y8r3TZMwL/xWtZ4N2v8spW7aNE1wxRmtXGxcbyeT/SbbE6e26dOtoKgVtZSr736/rhmXf61/cJe//eQuTz4ZypPWpFP//Ka3k7fvjo4nR5M/3hx/Pz350/T996PJZPI3lrDHSm5aNiNtbIhe+H+wIJQUCmcdarO3k8nsXQvlySH02oZsWqay4FLkUAiUOdCZ7ncEEK3V9j8kDM/Y95z75HLn/MkzqUM8t9C1yv/X7h6y6HkHT2YnvYvv9108UxEyIv83+gHVf8PDjT/D4308nkzdzmoRhcJ3tuXscD066TCrrfCrMDk8HnEjjuL36d098fEKfalp6jB1HDV8yaZs3FWX8XpQZxpG+uyiG0RCu2Gl98ZNx2PHVZ7qx5E2qKghSJ66UaarMTdivDhmTbK7gxvzAmmsj162wXk+F2r+/K77DUTXFMYYqS2g+nhxI/6KK5Z0cRhKtRNYiZw6HCFP2XG1mXY+dDHuw7g7InQTwreR/t1udJDGD1k8Y1tMvR3fhpSzXTpIwdpv21SDVO609l7uUEd93xBMhQ6Ytkl7YVBdk3uU8ovjPb++oMx0hR1H6sR/+ce/wo7O7WDnd1/VV3VRWzB6ibaoZQCvkPgoqO2SPFbhmwsTO1F35JVE5+QKiK3OLU2ZuZgLT0y95TUZNzwVUtBFJjFNuy0MaoEbwZcSfYmWPv3BEv/OcYGS7n9PXNR8w5mW2j4U9K6QAIe0dkKhc4Cq5CojwS4rAx/lKk4xxgqH4Lwlq0W0TStveeah4orPA6FMtlDKUQq6smB1SuOQ07KOhJ9eQ7QNFD46FJ4ERgTiB5ryLQKtEuuzWNIFWrSs3yVx6oopTC6oHFJ0HgzZIjKMzyVK6uwhPoXUUoLRVEYFl0SahjbSdm+5clTroy1dDHrAWnKJ0cA3b24dUoTPhXpw0zdvvqojuOuT6QumTni8f9UVg+VyuVcEXm/v+Sj8pzqFKzTaCa/tarN7LnxZp6FwDJX0/0RNH1FhyJ9BYdjoyHXm9usQrY5LlGZ8jZ4yxI1PL89C53kNv/z9n3CO3Coo9TJma1ZblCuYd0cRcjHyEba+cYSRj9e+JMSzmHzt4wshSFRpu8htXzuLBVoCPwRyc5wRrfq7zkwg63+Lm9TCKIt5FjpsmOJjtf3zrp7Q7dBW7qK4RrsQGbb1/okIj4PwmCVMigyVG5bf04+X57CAd6MJSwad4xuiPT4/++HD5+sPZA3drIjY8WgymtCS0c5XXA2O2nmy3K1x6w3B+H994Ww7KM3VYyO5CLylHVcj57hjg9Y2HT5u3ies1M6TyHqdcoe3VjYNLf9ch7Zyd5+wBbeCOlkgJu0MmPft6Em4X111z4XwsnfSgw51PEERSQjzeuyRD7jaebBt7pukIwtkcZT4Idp1dEN6Nhr2OCdxnbjjNMvQ+GdlhyTv8vaGJSxtH1+r8I7LLF/Swy9fRmPjW1KgQWFtzSRX85rPSTaqbOJIX25zo4fAjdof5NRBOLZJU/SC/pJPBzes15F3NU0vHz89uaPFtZOm2Nw3TfNvtvudpQ==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,f={},w=[];function b(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,n.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(c(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(u(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.4600e4ad.js b/assets/js/f0ff4a36.4600e4ad.js deleted file mode 100644 index 3065de813..000000000 --- a/assets/js/f0ff4a36.4600e4ad.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7315],{56397:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>h,contentTitle:()=>y,default:()=>D,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/getdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getdocument","permalink":"/docs/API-docs/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9GNty2zb2V07xss0MrYutJF091bPNum47TWbtTmbW0WhA8pBEDAIoAErWaPjWL9lP2y/ZOeBFlKXYUTfNiy0C534/2DLPc8fmd+wHnVQlKu/YImIpusQK44VWbM5uC4Qr9NCBwOW7a0DFY4kONroCr8GitwJXCCl6LqQDHuvKAwdnMBGZSCBtsUcsYtqg5UT9OmVzlqPvLlnEDLe8RI+WxNoyxUtkc9YBLEXKIiZILMN9wR7LquOPmPjrFHTWy8siZvH3SlhM2dzbCiPm/EYSWSdKI5FFDB+M1CmyecalI4CkwJKz+Zb5jQmQ3gqVs4hl2pbcD0/wgQcqc2Z+nMZFcl6YmNX1gtg6o5VDR4TOJxP6ty+vq5IEncsqCb1RWMQSrTxJPt8ybowUSbgYf3SEtD2UrlGbrGeJjBcNS+e5r9ypWgh1ZqzOLTrH6qg36alk/nkl7s8v4uK3n4hKJujwNAqF98bNx+P2pLJylOiSqCWkY0Zm+dNEByQGhL3wp8vpwg+KcCKh9OlCGYncITiRqz5RgtW0TNE+7+gv46Mm106j0EgIAbXeGXCXsK0KFEhrtafLZ9H/qBFiRMIn64Sy0FPg1vIN1QOPpXveSlYf9+2OW4L6KUMcFQtLLuSz0DHi9+1BF2um0OoZNrOXr86nF9+9nhL8WqQ5+v9D/+b2kN9+SbqUUq8xhRWXFTo4C1HJfWUxAud5aUbPpUMHT0I/DBiqqozRDrH7kx77fDarI7Y5Eev1lOxzItLFd3XEihORZq/IczzHE/Gmw+TwWBrJPS5vmpBedq6tn4IK+eVQpdfqrd0vC7HWErkaMqRGR5XSIveYXvqnA+18cn5xNp2cTV7fTl/NZ3+fv3w1mkwm/2YReyhDdHeNmEruMM/b78qkX4VPM3fc6urz1LeYCouJX1b2aI4+FcfEjlMyLEudNq1CaOWe5hvmB0KsUuGX3u7XhhMT9k+XlpXANR7tBl/QFaEe/7VMjjSUtfBFM9cshzYOoF3CiGekGgCCcKCV3ABfcSEptmBdoAJfYN+JCabNI8isLoFDR2EUGD9S5UBS9qQelPV1xGbH5sMbXaIvhMphTYKsrVZ5BO244O0GeM6FAhLFfvPlBke0Vh9t1TsbnibZ0JNCSaFw2Q3Hy9lkspz2RpgdGqFfPJT2kOlKpV9X1WP8n1ZotrzoFXp5qNC1WnEp0rBI3ep7VF9XnyF737A/jGLRAIV7tqfs8LxR0mFSWeE3YWN7OONGnDX387sF7UEUKbpd9cKK5ws2Z+MuFcbbwXpXM6JnV90CGAp3P7U7rtJYP4y0QUX1R/LYUdEbcyPGKxqTHmNwY06AxursNATneS5U/jTWYmeiG3Jj46k9Q+1ahBE/I/WI1g9DqHbzLZCHkbqm70wH5NY7bw0qGheCb1fTg+HuPcpEl0grO1W4Dvy/f/wnYHR+CKH3DbytLBi9Rkv7KVcpZBIfBNVIAg69sX8BcMhLic7JDQjlMbfcI6QiF57LMEJSqUi44bGQgoKVwDRhWxjEuxvB+wJ9gZau/mYROKS4QkkxDlLre6LjNfDK6zLw6LJzre19RiJFwCGunFDoHDjEDgVVwVWC0PkiAm2BK0Dl0RorHAIXJQFn2gJmmUgEEabMtDzxUHLFcyRmEZDcZAVj9Uqk6MDquHIenJZVUIQ4loi+UVEhpm4EP4gVNorTYfNYginkFZGIINEpQpuopIZKIUbnwRB7kWAg6jy3HiSu0IbYC57MKinBaKoggkt6/hj6lgh5y5WjeacRqHNNbz5jNT1FBB4p34zgg/qgqMpD5ZACQAp17+Yf1Bnc9WH2HmMnPC6+7fJhvV4f5MGLfZwr4YsqBotG7/DycBiyZojef7ygiWE/YfYj22KGlrQJNspRYYhAbkRT4+Du8t11KLZQoDQ7zoRymLp0OibA8Q16L1Tuxh3+i/ACoZXniR9MaZS53z+mEyon2tK9zW7QrkTSPUF8wlTjADxmEZMiQeVwUJEvr979Aiu4GE1YNKhCn2G88S/X/3jz682bMBqidY3FpqPJaBIWUe18ydWA1fC573EN2e461V/wNNhWQY8PfmwkF6H3tMN70zfu2OC1cD58GFxErNDOE8h2G3OHv1lZ13T8e4WWutMiYituBckXmksqHP1O+3e/T2r67b/aJ8QX8Ik3xqOSd0VdUUUPGzUtFhG7x82jV816QdtoU9lJtAbiMknQ+AHuwWiw11+v3twy2j18sd9R7kNHaX8Q9aNy7beaRgD6S13vKMJ223Sruu7hm6tPYrQKdtBkpEVd1/8DPLvBeA==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/update-document"}}');var r=n(74848),a=n(28453),o=n(33617),p=n.n(o),s=n(17543),m=n.n(s),l=n(86013),c=n.n(l),d=n(63723),u=n.n(d),b=(n(18766),n(79329),n(9303));const g={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9GNty2zb2V07xss0MrYutJF091bPNum47TWbtTmbW0WhA8pBEDAIoAErWaPjWL9lP2y/ZOeBFlKXYUTfNiy0C534/2DLPc8fmd+wHnVQlKu/YImIpusQK44VWbM5uC4Qr9NCBwOW7a0DFY4kONroCr8GitwJXCCl6LqQDHuvKAwdnMBGZSCBtsUcsYtqg5UT9OmVzlqPvLlnEDLe8RI+WxNoyxUtkc9YBLEXKIiZILMN9wR7LquOPmPjrFHTWy8siZvH3SlhM2dzbCiPm/EYSWSdKI5FFDB+M1CmyecalI4CkwJKz+Zb5jQmQ3gqVs4hl2pbcD0/wgQcqc2Z+nMZFcl6YmNX1gtg6o5VDR4TOJxP6ty+vq5IEncsqCb1RWMQSrTxJPt8ybowUSbgYf3SEtD2UrlGbrGeJjBcNS+e5r9ypWgh1ZqzOLTrH6qg36alk/nkl7s8v4uK3n4hKJujwNAqF98bNx+P2pLJylOiSqCWkY0Zm+dNEByQGhL3wp8vpwg+KcCKh9OlCGYncITiRqz5RgtW0TNE+7+gv46Mm106j0EgIAbXeGXCXsK0KFEhrtafLZ9H/qBFiRMIn64Sy0FPg1vIN1QOPpXveSlYf9+2OW4L6KUMcFQtLLuSz0DHi9+1BF2um0OoZNrOXr86nF9+9nhL8WqQ5+v9D/+b2kN9+SbqUUq8xhRWXFTo4C1HJfWUxAud5aUbPpUMHT0I/DBiqqozRDrH7kx77fDarI7Y5Eev1lOxzItLFd3XEihORZq/IczzHE/Gmw+TwWBrJPS5vmpBedq6tn4IK+eVQpdfqrd0vC7HWErkaMqRGR5XSIveYXvqnA+18cn5xNp2cTV7fTl/NZ3+fv3w1mkwm/2YReyhDdHeNmEruMM/b78qkX4VPM3fc6urz1LeYCouJX1b2aI4+FcfEjlMyLEudNq1CaOWe5hvmB0KsUuGX3u7XhhMT9k+XlpXANR7tBl/QFaEe/7VMjjSUtfBFM9cshzYOoF3CiGekGgCCcKCV3ABfcSEptmBdoAJfYN+JCabNI8isLoFDR2EUGD9S5UBS9qQelPV1xGbH5sMbXaIvhMphTYKsrVZ5BO244O0GeM6FAhLFfvPlBke0Vh9t1TsbnibZ0JNCSaFw2Q3Hy9lkspz2RpgdGqFfPJT2kOlKpV9X1WP8n1ZotrzoFXp5qNC1WnEp0rBI3ep7VF9XnyF737A/jGLRAIV7tqfs8LxR0mFSWeE3YWN7OONGnDX387sF7UEUKbpd9cKK5ws2Z+MuFcbbwXpXM6JnV90CGAp3P7U7rtJYP4y0QUX1R/LYUdEbcyPGKxqTHmNwY06AxursNATneS5U/jTWYmeiG3Jj46k9Q+1ahBE/I/WI1g9DqHbzLZCHkbqm70wH5NY7bw0qGheCb1fTg+HuPcpEl0grO1W4Dvy/f/wnYHR+CKH3DbytLBi9Rkv7KVcpZBIfBNVIAg69sX8BcMhLic7JDQjlMbfcI6QiF57LMEJSqUi44bGQgoKVwDRhWxjEuxvB+wJ9gZau/mYROKS4QkkxDlLre6LjNfDK6zLw6LJzre19RiJFwCGunFDoHDjEDgVVwVWC0PkiAm2BK0Dl0RorHAIXJQFn2gJmmUgEEabMtDzxUHLFcyRmEZDcZAVj9Uqk6MDquHIenJZVUIQ4loi+UVEhpm4EP4gVNorTYfNYginkFZGIINEpQpuopIZKIUbnwRB7kWAg6jy3HiSu0IbYC57MKinBaKoggkt6/hj6lgh5y5WjeacRqHNNbz5jNT1FBB4p34zgg/qgqMpD5ZACQAp17+Yf1Bnc9WH2HmMnPC6+7fJhvV4f5MGLfZwr4YsqBotG7/DycBiyZojef7ygiWE/YfYj22KGlrQJNspRYYhAbkRT4+Du8t11KLZQoDQ7zoRymLp0OibA8Q16L1Tuxh3+i/ACoZXniR9MaZS53z+mEyon2tK9zW7QrkTSPUF8wlTjADxmEZMiQeVwUJEvr979Aiu4GE1YNKhCn2G88S/X/3jz682bMBqidY3FpqPJaBIWUe18ydWA1fC573EN2e461V/wNNhWQY8PfmwkF6H3tMN70zfu2OC1cD58GFxErNDOE8h2G3OHv1lZ13T8e4WWutMiYituBckXmksqHP1O+3e/T2r67b/aJ8QX8Ik3xqOSd0VdUUUPGzUtFhG7x82jV816QdtoU9lJtAbiMknQ+AHuwWiw11+v3twy2j18sd9R7kNHaX8Q9aNy7beaRgD6S13vKMJ223Sruu7hm6tPYrQKdtBkpEVd1/8DPLvBeA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,h={},f=[];function x(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,r.jsx)(p(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,r.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(m(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},audit_trail:{type:"array",items:{type:"object",properties:{email:{type:"string",example:"joebee@example.com"},viewed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},signed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"documentwithstatus_audit_trail"}},template_id:{type:"string",example:"template_id is only available when the document is created from a template."}},xml:{name:"documentwithstatus"},title:"documentwithstatus"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function D(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.4e6daff2.js b/assets/js/f0ff4a36.4e6daff2.js new file mode 100644 index 000000000..a148e476f --- /dev/null +++ b/assets/js/f0ff4a36.4e6daff2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7315],{56397:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>x,contentTitle:()=>f,default:()=>G,frontMatter:()=>y,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/getdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getdocument","permalink":"/docs/API-docs/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9GFtuG8nxKrX9k7Ux4kOi7Q2/VkgcrRIjNlYyDEQWiJ6ZIqetnu7e7hpSBEEgH7lBbpCj7UmC6uEMhyItmbte/9hiT73fVStBchbE+Eb81WZViYaCuE1EjiHzypGyRozFdYFwgQQNCJy/uwQ0MtUYYGkrIAseySucI+RIUukAMrUVgYTgMFNTlUG+we6JRFiHXjL1y1yMxQyp+SgS4aSXJRJ6FmsljCxRjEUDMFG5SIRisZykQjyU1aafMKPLHOy0lVckwuMvlfKYizH5ChMRaKmZbFCl0ygSgfdO2xzFeCp1YICswFKK8UrQ0kVI8srMRCKm1peSui94LyOVsXA/DdMiOy1cKtbrW2YbnDUBAxM6HQz4v115Q5VlGMK00tAaRSQis4ZY8vFKSOe0yuKH/qfASKt96Wq12XqeyZCqWQaSVIVjtVDmxHk78xiCWCetSY8l87cLdXd6lhbv/85Upoofj6NQELkw7vc3L5XXvcyWTC1jHadslt9MtEOiQ5gUHS9niH9whDMJY48XymmUASGomWkTJVrN6hz9047+Oj6qc+04CrWEEFHXWwNuE3ajAgfSwuzo8kX0P1mEFJHx2TqxLLQUpPdyyfWAsAxPW8nbw77dcsvQPmaIg2JhKZV+EjpF/HHz0MSaK6x5gs3oxcvT4dkPr4YMv1D5DOl36F9/3ee3W5LOtbYLzGEudYUBTmJUSqo8JhBIlq73VDo08Cz0fYehqcoUfRe7fWmxT0ejdSKWR2K9GrJ9jkQ6+2GdiOJIpNFL9pyc4ZF4w25yEJZOS8LJVR3Sk8a168egYn4FNPmleet3y0JqrUZpugy50XGl9CgJ83N6PNBOB6dnJ8PByeDV9fDlePTn8YuXvcFg8C+RiPsyRnfTiLnkdvN887ty+TfhU88d17b6MvU95spjRpPKH8zRx+KY2UlOhklp87pVKGvC43zj/MCIVa5oQn63NhyZsL+5tMwVLvBgN/iKroj1+I9lcqChLBQV9Vwz6do4gjYJo56QqgMIKoA1eglyLpXm2IJFgQaowLYTM8wmj2DqbQkSGgq9GCQV2YnHUpkns7IJjxp6Yk2GE2UmOEd/sOa1iANW8IHJ9iwiHrUXV5d1IkaH5tArWyIVysxgwQovvDWzBDZjCfklyJlUBlhl/93XG1DRe3twJNj66jjJuhGjjFYGJ80QPhkNBpNha4TRvhHaBcdYgqmtTP5tVT3E/3GFRpOzVqEX+wpdmrnUKo8L27W9Q/Nt9emyp5r9fhSrGih+FzvKdt9rJQNmlVe0jJvh/Yl06qT+Pr655X2LI8VuVsq4SlIhxqLfpEJ/1Vkj14Lp+XmzaMYG0W4HQZo8tfc969BwndMyDVxc+9Kp/pzHsYcY0rkjoLE6OQ4hkJwpM3sc63Zroit2Y+2pHUNtW5FT/0DuRRs/dKE2G3aBMo7ua/49tRF54523Dg2PJdG38+HeEPkBdWZL5NMAV9IG/Nf//C9iNH6IoffdR/PRvK08OLtAz6uwNDlMNd4rLsfx2lDGb+25IaAsNYagl6AM4cxLQsjVTJHUcV7lepFJJ1OlFUcsg1nG9tAJ+tCDDwVSgZ4//ckjSMhxjpoDHbisl5KYVNsJFtbfTbVdhAQkpFVQBkMANIU0GQM25k/AepAG0BB65xUvd+RZalXLZg15mRGU0sgZMu1kx0o5asWxCd6mVSAIVldRZOD7ivWYQ6OQQcxDj434mq8YHoFfM1s6jwVHyhxhVqkcQwKZzRHqfZVVMDmkGAgcy6IyDEy0Mtpmd9Fv00prcJbrhZKajypdGRmdvDSBp6halsYHrcGct3zgwFrA58/fB2QPv1HmLoyfP/9oTuCmDaYPmAZFePt9E/WLxWIv2p/t4lwo+qlK4Wd0NiiyfrnFnikqqjRmSJdI+6OmdIEGY/x0MmBLI7dZ2E84fu0XqF3/CokjJPTP313GEvsMfv33f+ENSm+gsIs6WrPKo17CrGHFlqs9X5utrZAwtTHwCrZ4VgcfH68wEFuQx6bdbN5NO49T9Gz86MgtO6c25G8aMYGl/z1qxjOMNSQz6oyqXFZ+fEgnlnX0ZXg7vUI/V1lzh/mMh/sRuC8SoVWGJmCnXZxfvHsDczjrDUTSKZFf4O3+m8u/vP7n1es4H6MPtcWGvUFvELdxG6iUpsOqe/N8WOBW2zb6B9xHNyWa8J76TksVG+Nmg6mb2o3onEzH3evobSIKG4hBVqtUBnzv9XrNz79Ucci8uU3EXHrF8sXOl6vAf+ft8fOzmn7/8+aO+gw+c2g9KHnTcQy3m3hW4O0qEXe4fHDaXd/ySl63HRathjjPMnTUwd2bW3aa/8XraxGH8mK33d3Fdrf5g6kflGu3D9YC8L/ckg8irFZ1K12vW/j602cxNgo20Gyk2/V6/X/ZtCMd","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/update-document"}}');var i=a(74848),o=a(28453),s=a(33617),r=a.n(s),p=a(17543),l=a.n(p),m=a(86013),d=a.n(m),c=a(63723),u=a.n(c),g=(a(18766),a(79329),a(9303));const y={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9GFtuG8nxKrX9k7Ux4kOi7Q2/VkgcrRIjNlYyDEQWiJ6ZIqetnu7e7hpSBEEgH7lBbpCj7UmC6uEMhyItmbte/9hiT73fVStBchbE+Eb81WZViYaCuE1EjiHzypGyRozFdYFwgQQNCJy/uwQ0MtUYYGkrIAseySucI+RIUukAMrUVgYTgMFNTlUG+we6JRFiHXjL1y1yMxQyp+SgS4aSXJRJ6FmsljCxRjEUDMFG5SIRisZykQjyU1aafMKPLHOy0lVckwuMvlfKYizH5ChMRaKmZbFCl0ygSgfdO2xzFeCp1YICswFKK8UrQ0kVI8srMRCKm1peSui94LyOVsXA/DdMiOy1cKtbrW2YbnDUBAxM6HQz4v115Q5VlGMK00tAaRSQis4ZY8vFKSOe0yuKH/qfASKt96Wq12XqeyZCqWQaSVIVjtVDmxHk78xiCWCetSY8l87cLdXd6lhbv/85Upoofj6NQELkw7vc3L5XXvcyWTC1jHadslt9MtEOiQ5gUHS9niH9whDMJY48XymmUASGomWkTJVrN6hz9047+Oj6qc+04CrWEEFHXWwNuE3ajAgfSwuzo8kX0P1mEFJHx2TqxLLQUpPdyyfWAsAxPW8nbw77dcsvQPmaIg2JhKZV+EjpF/HHz0MSaK6x5gs3oxcvT4dkPr4YMv1D5DOl36F9/3ee3W5LOtbYLzGEudYUBTmJUSqo8JhBIlq73VDo08Cz0fYehqcoUfRe7fWmxT0ejdSKWR2K9GrJ9jkQ6+2GdiOJIpNFL9pyc4ZF4w25yEJZOS8LJVR3Sk8a168egYn4FNPmleet3y0JqrUZpugy50XGl9CgJ83N6PNBOB6dnJ8PByeDV9fDlePTn8YuXvcFg8C+RiPsyRnfTiLnkdvN887ty+TfhU88d17b6MvU95spjRpPKH8zRx+KY2UlOhklp87pVKGvC43zj/MCIVa5oQn63NhyZsL+5tMwVLvBgN/iKroj1+I9lcqChLBQV9Vwz6do4gjYJo56QqgMIKoA1eglyLpXm2IJFgQaowLYTM8wmj2DqbQkSGgq9GCQV2YnHUpkns7IJjxp6Yk2GE2UmOEd/sOa1iANW8IHJ9iwiHrUXV5d1IkaH5tArWyIVysxgwQovvDWzBDZjCfklyJlUBlhl/93XG1DRe3twJNj66jjJuhGjjFYGJ80QPhkNBpNha4TRvhHaBcdYgqmtTP5tVT3E/3GFRpOzVqEX+wpdmrnUKo8L27W9Q/Nt9emyp5r9fhSrGih+FzvKdt9rJQNmlVe0jJvh/Yl06qT+Pr655X2LI8VuVsq4SlIhxqLfpEJ/1Vkj14Lp+XmzaMYG0W4HQZo8tfc969BwndMyDVxc+9Kp/pzHsYcY0rkjoLE6OQ4hkJwpM3sc63Zroit2Y+2pHUNtW5FT/0DuRRs/dKE2G3aBMo7ua/49tRF54523Dg2PJdG38+HeEPkBdWZL5NMAV9IG/Nf//C9iNH6IoffdR/PRvK08OLtAz6uwNDlMNd4rLsfx2lDGb+25IaAsNYagl6AM4cxLQsjVTJHUcV7lepFJJ1OlFUcsg1nG9tAJ+tCDDwVSgZ4//ckjSMhxjpoDHbisl5KYVNsJFtbfTbVdhAQkpFVQBkMANIU0GQM25k/AepAG0BB65xUvd+RZalXLZg15mRGU0sgZMu1kx0o5asWxCd6mVSAIVldRZOD7ivWYQ6OQQcxDj434mq8YHoFfM1s6jwVHyhxhVqkcQwKZzRHqfZVVMDmkGAgcy6IyDEy0Mtpmd9Fv00prcJbrhZKajypdGRmdvDSBp6halsYHrcGct3zgwFrA58/fB2QPv1HmLoyfP/9oTuCmDaYPmAZFePt9E/WLxWIv2p/t4lwo+qlK4Wd0NiiyfrnFnikqqjRmSJdI+6OmdIEGY/x0MmBLI7dZ2E84fu0XqF3/CokjJPTP313GEvsMfv33f+ENSm+gsIs6WrPKo17CrGHFlqs9X5utrZAwtTHwCrZ4VgcfH68wEFuQx6bdbN5NO49T9Gz86MgtO6c25G8aMYGl/z1qxjOMNSQz6oyqXFZ+fEgnlnX0ZXg7vUI/V1lzh/mMh/sRuC8SoVWGJmCnXZxfvHsDczjrDUTSKZFf4O3+m8u/vP7n1es4H6MPtcWGvUFvELdxG6iUpsOqe/N8WOBW2zb6B9xHNyWa8J76TksVG+Nmg6mb2o3onEzH3evobSIKG4hBVqtUBnzv9XrNz79Ucci8uU3EXHrF8sXOl6vAf+ft8fOzmn7/8+aO+gw+c2g9KHnTcQy3m3hW4O0qEXe4fHDaXd/ySl63HRathjjPMnTUwd2bW3aa/8XraxGH8mK33d3Fdrf5g6kflGu3D9YC8L/ckg8irFZ1K12vW/j602cxNgo20Gyk2/V6/X/ZtCMd",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,x={},h=[];function j(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},audit_trail:{type:"array",items:{type:"object",properties:{email:{type:"string",example:"joebee@example.com"},viewed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},signed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"documentwithstatus_audit_trail"}},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"documentwithstatus"},title:"documentwithstatus"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function G(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.4a2b9b90.js b/assets/js/fa40969b.4a2b9b90.js deleted file mode 100644 index 9c5250370..000000000 --- a/assets/js/fa40969b.4a2b9b90.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[724],{17556:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>y,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/getdocumentlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getdocumentlist","permalink":"/docs/API-docs/getdocumentlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar_label":"Get Document list from status","hide_title":true,"hide_table_of_contents":true,"api":"eJztWN1y2zYWfpVT5GKbDCVRtpx0dVVPk3q829lkYncyU1vjAckjETEIoACon9Hwbp+kj9Yn6RyQlChLdqy2k6veJBZ4/s93foA183zm2PiGvdVpWaDyjk0ilqFLrTBeaMXG7MWLF9B+huuVQTe+VR/RW4FzBA5SOA96ClkrAhLuMAOtwK8M3qpbNezDq1dvLZ/6jSQ3fvXqVgEA9LZn4HPugVuEtLQWlZcrEAqywOk896Xrk7wTknepeh+snll07k9JNQ1zkHhKEn/QhZHoMXuOvJzPERJEBa5MU3RuWkq5gnQjYyF8DlxKsPhrKSxm4MRMcV9arHWOSOe7pQnfnqsRG3qusuCS0iC1mqEFHqwQicQg/SzEHFMp1LEOZS1XsgKfI5QObf9WsYhpg5YTLi4zNmYz9G3SCQQsYoZbXqBHS6BaM8ULZGOW6ZSQwCImCFCG+5w9RNl1jgEuu0jyGmyDNBaxNpBs7G2JEXN+JUm+ExRzFjFcGqkzZOMpl44I0hwLzsZrFvSPmfNWqBlRqrIg3AdoBcNaOLCIbXJYiwwqyd46KmxSVdHGNykK4VvPfi3RrnYMbQ1pLJ1qW3TtbPzYmFnwpSjIsrM4jlqjVVkkaFlFfDx4Oh7GHRPcvTB/mwWP64yrCcl1RiuHjmhP4pj+203kthpgg5YQU+VReaLnxkiRhg+Dz46Y1vsG6OQzpgFSlsR4Uau06ErpO3TcWk4OC4+F+zJ/fUzo3ccEhYb7HZS0vrMfL8T9yWmS//wfislU0OFxEnLvjRsPBs1JaWU/1QVJ88IfL86FP6hUSITS/mgJRiJ3GJrSpuKCc1pmaL9WKGsMHyehthACa7UNIGu9uGtcqCKmF2rHl2fJ/6xDIyR+ik7oZn8WcFYfzu1WW4r6qUAcNAsLLuQXqRPE75uDFmsm1+oLakZnr0+Gp9+9GRL9QmQz9H/B//rrvr7dpnEupV5gBnMuS3TQ247KiOZ+YfpfKoeWnoxe7jeyDvfmZMN9MhpVEVsdyfVmSPE5kun0uypi+ZFMo9eUOT7DI/mG3eLwWBjJPd5d1ZC+a1NbPUUV6suhyi7Ve7vbFhKtJXLVVUjDpIpYapF7zM7900A7iU9Oe8O4F7+5Hr4ej/49Pnvdj+P4FxaxZRHQ3e4P3CPr1nnzuzTZV9GDiicSr3X5PPctZsJi6u9Ke7BGn8IxqeNUDHeFzsS0GZPuab1hxJPdbfLEwaa81dIhBOFAK7kCPudCkp+wyFGFva/tp0TT5BSmVhfAoZXQDwB5EMbOMHnYmnfRJhRtVHftUnF3Esd3IyKpIjaKR/vLxUc02npQ2m/t/ebv2y7QWn1wWmxDd9iCp5waxaO7s41TZ/tOXao5lyKD8w+XcK3vUX1dj7rqfa1+P6eiJgrf2Y6z3fPaSYdpaYVfhSvAsseN6NXfxzcT2iEL9Llu7g/hzuBzNmaD7lVisG7uDBUjeXbe3ihCSW12KcdVluhlXxtUNAEkTxxNugE3YjCnAfaQgxtzBDWWveMYnOczoWZPc022IbqiNNaZ2gnUdtoa8V+kcdvkoUvVrPw58rDsVPR7qgNzk533BhU18pDb+XBv7H5CmeoC6ZpF9d6S//7/3wJHm5EAvW/gfWnB6AVa2u3p/jmVuKT7ZiAOXcvBSpckziEvJDoXrtoeZ5Z7hEzMhOcyDHehZpBywxMhBYGVyDRxW+jg3fXhU44+R0uf/mXpvSHDOUrCOEit70mO18BLr4ugo+1ZC23vp2RSBByS0glFDwUOsWVBlXOVIrS5iEBb4ApQebTGCofARUHEU20Bp1ORChJMlWl56qHgis+QlEVAdlMUjNVzkaEDq5PSeXBalsER0lgg+tpFhZi5PrwVc6wdp8MMPRcSM5iVJCKCVGd04Q+FSm6oDBJ0HgypFykGoc5z60HiHG3AXsgkvUWA0dRBBJd0p+7mlgR5y5WjSVQb1KZmEz5jNV3jgo6Mr/pAbwpXBJbSIQFACnVPL0E9uNnA7BMmTnicfNvWw2Kx2KuDl7s8F8LnZQIWjd7yzcJhqJou++bHS5rduwWzi2yLU7TkTYjRDBUGBHIj6h4HN+cfLkOzhRyl2Womlv3SpdMBEQ6u0HuhZm7Q8r+kdkiY4Gno1s1qTpX7/UM5oXOiLdz76RXauUjbi+EjoRoE4gGLmBQpKoedjnx+8eEnmMNpP2ZRpws9I3iDny5/ePe/q3dkDTXWOmLDftyPwxVBO19w1VF1gdt3u/q5L2wB9YPcw6ay3o6uf54O/3k63DwdNgPN49IPjOQirBHNhlyvADfswWviuH04nEQs184TyXpNEPnZyqqi4/q9izaDTDjaxbYvXve46rzPhZtlvWA/Sts8pG1JJ/TDCqI9rONR5H/7scncS3jOy+bB4LQrgFp1jWqNbWNTTehGWe8AZGP99TxN0XT93lsidzaxi3fXLGK89Pnu7nEfdo/mD5J+0KbdpaQ2gP6lUB9kWK/rvaaqNvT1p0c5GgdbagrQpKqqPwC+ZYbZ","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"}}');var i=n(74848),r=n(28453),p=n(33617),l=n.n(p),a=n(17543),o=n.n(a),m=n(86013),d=n.n(m),c=n(63723),u=n.n(c),h=(n(18766),n(79329),n(9303));const y={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1y2zYWfpVT5GKbDCVRtpx0dVVPk3q829lkYncyU1vjAckjETEIoACon9Hwbp+kj9Yn6RyQlChLdqy2k6veJBZ4/s93foA183zm2PiGvdVpWaDyjk0ilqFLrTBeaMXG7MWLF9B+huuVQTe+VR/RW4FzBA5SOA96ClkrAhLuMAOtwK8M3qpbNezDq1dvLZ/6jSQ3fvXqVgEA9LZn4HPugVuEtLQWlZcrEAqywOk896Xrk7wTknepeh+snll07k9JNQ1zkHhKEn/QhZHoMXuOvJzPERJEBa5MU3RuWkq5gnQjYyF8DlxKsPhrKSxm4MRMcV9arHWOSOe7pQnfnqsRG3qusuCS0iC1mqEFHqwQicQg/SzEHFMp1LEOZS1XsgKfI5QObf9WsYhpg5YTLi4zNmYz9G3SCQQsYoZbXqBHS6BaM8ULZGOW6ZSQwCImCFCG+5w9RNl1jgEuu0jyGmyDNBaxNpBs7G2JEXN+JUm+ExRzFjFcGqkzZOMpl44I0hwLzsZrFvSPmfNWqBlRqrIg3AdoBcNaOLCIbXJYiwwqyd46KmxSVdHGNykK4VvPfi3RrnYMbQ1pLJ1qW3TtbPzYmFnwpSjIsrM4jlqjVVkkaFlFfDx4Oh7GHRPcvTB/mwWP64yrCcl1RiuHjmhP4pj+203kthpgg5YQU+VReaLnxkiRhg+Dz46Y1vsG6OQzpgFSlsR4Uau06ErpO3TcWk4OC4+F+zJ/fUzo3ccEhYb7HZS0vrMfL8T9yWmS//wfislU0OFxEnLvjRsPBs1JaWU/1QVJ88IfL86FP6hUSITS/mgJRiJ3GJrSpuKCc1pmaL9WKGsMHyehthACa7UNIGu9uGtcqCKmF2rHl2fJ/6xDIyR+ik7oZn8WcFYfzu1WW4r6qUAcNAsLLuQXqRPE75uDFmsm1+oLakZnr0+Gp9+9GRL9QmQz9H/B//rrvr7dpnEupV5gBnMuS3TQ247KiOZ+YfpfKoeWnoxe7jeyDvfmZMN9MhpVEVsdyfVmSPE5kun0uypi+ZFMo9eUOT7DI/mG3eLwWBjJPd5d1ZC+a1NbPUUV6suhyi7Ve7vbFhKtJXLVVUjDpIpYapF7zM7900A7iU9Oe8O4F7+5Hr4ej/49Pnvdj+P4FxaxZRHQ3e4P3CPr1nnzuzTZV9GDiicSr3X5PPctZsJi6u9Ke7BGn8IxqeNUDHeFzsS0GZPuab1hxJPdbfLEwaa81dIhBOFAK7kCPudCkp+wyFGFva/tp0TT5BSmVhfAoZXQDwB5EMbOMHnYmnfRJhRtVHftUnF3Esd3IyKpIjaKR/vLxUc02npQ2m/t/ebv2y7QWn1wWmxDd9iCp5waxaO7s41TZ/tOXao5lyKD8w+XcK3vUX1dj7rqfa1+P6eiJgrf2Y6z3fPaSYdpaYVfhSvAsseN6NXfxzcT2iEL9Llu7g/hzuBzNmaD7lVisG7uDBUjeXbe3ihCSW12KcdVluhlXxtUNAEkTxxNugE3YjCnAfaQgxtzBDWWveMYnOczoWZPc022IbqiNNaZ2gnUdtoa8V+kcdvkoUvVrPw58rDsVPR7qgNzk533BhU18pDb+XBv7H5CmeoC6ZpF9d6S//7/3wJHm5EAvW/gfWnB6AVa2u3p/jmVuKT7ZiAOXcvBSpckziEvJDoXrtoeZ5Z7hEzMhOcyDHehZpBywxMhBYGVyDRxW+jg3fXhU44+R0uf/mXpvSHDOUrCOEit70mO18BLr4ugo+1ZC23vp2RSBByS0glFDwUOsWVBlXOVIrS5iEBb4ApQebTGCofARUHEU20Bp1ORChJMlWl56qHgis+QlEVAdlMUjNVzkaEDq5PSeXBalsER0lgg+tpFhZi5PrwVc6wdp8MMPRcSM5iVJCKCVGd04Q+FSm6oDBJ0HgypFykGoc5z60HiHG3AXsgkvUWA0dRBBJd0p+7mlgR5y5WjSVQb1KZmEz5jNV3jgo6Mr/pAbwpXBJbSIQFACnVPL0E9uNnA7BMmTnicfNvWw2Kx2KuDl7s8F8LnZQIWjd7yzcJhqJou++bHS5rduwWzi2yLU7TkTYjRDBUGBHIj6h4HN+cfLkOzhRyl2Womlv3SpdMBEQ6u0HuhZm7Q8r+kdkiY4Gno1s1qTpX7/UM5oXOiLdz76RXauUjbi+EjoRoE4gGLmBQpKoedjnx+8eEnmMNpP2ZRpws9I3iDny5/ePe/q3dkDTXWOmLDftyPwxVBO19w1VF1gdt3u/q5L2wB9YPcw6ay3o6uf54O/3k63DwdNgPN49IPjOQirBHNhlyvADfswWviuH04nEQs184TyXpNEPnZyqqi4/q9izaDTDjaxbYvXve46rzPhZtlvWA/Sts8pG1JJ/TDCqI9rONR5H/7scncS3jOy+bB4LQrgFp1jWqNbWNTTehGWe8AZGP99TxN0XT93lsidzaxi3fXLGK89Pnu7nEfdo/mD5J+0KbdpaQ2gP6lUB9kWK/rvaaqNvT1p0c5GgdbagrQpKqqPwC+ZYbZ",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={},j=[{value:"Document Types:",id:"document-types",level:3}];function f(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(o(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},template_id:{type:"string",example:"template_id is only available when the document is created from a template."}},xml:{name:"document"},title:"document"}}},title:"inline_response_200_4"}}}},404:{description:"Report not available!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Report not available!"}},title:"inline_response_404_5"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.ac3256b6.js b/assets/js/fa40969b.ac3256b6.js new file mode 100644 index 000000000..703335721 --- /dev/null +++ b/assets/js/fa40969b.ac3256b6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[724],{17556:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/getdocumentlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getdocumentlist","permalink":"/docs/API-docs/getdocumentlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar_label":"Get Document list from status","hide_title":true,"hide_table_of_contents":true,"api":"eJztWF9v2zgS/yqz7MO1gWLLidPu+WmD3V4ud8W2aFIUuMQwKGlssaFILUnZMQwB93Df4L7BfbT9JIehJEuKnTTeXfRpX9qYmv/z43BmNszxhWWTG/aTjosMlbNsGrAEbWxE7oRWbMJevHgBzWe4XudoJ7fqIzojcInAQQrrQM8haURAxC0moBW4dY636laNBnB09JPhc7eVZCdHR7cKAOC4PQOXcgfcIMSFMaicXINQkHhO67gr7IDknZC8S3X8weiFQWt/k9S8ZvYST0nijzrLJTpMniMv5UuECFGBLeIYrZ0XUq4h3spYCZcClxIM/lIIgwlYsVDcFQYrnWPS+fY+99+eqxFreq4S75LSILVaoAHurRCRRC/9zMccYynUoQ4lDVe0BpciFBbN4FaxgOkcDSdcXCZswhbomqQTCFjAcm54hg4NgWrDFM+QTViiY0ICC5ggQOXcpewhyq5T9HDpI8lpMDXSWMCaQLKJMwUGzLq1JPlWUMxZwPA+lzpBNplzaYkgTjHjbLJhXv+EWWeEWhClKjLCvYeWN6yBAwvYNoeVSK+S7K2iwqZlGWx9kyITrvHslwLNumdoY0ht6VybrGtn7cfWzIzfi4wsOwvDoDFaFVmEhpXEx72nk1HYMcHeifwPs+BxnWE5Jbk218qiJdqTMKT/+olsbwNs0eJjqhwqR/Q8z6WI/YfhF0tMm10DdPQFYw8pQ2KcqFQatIV0HTpuDCeHhcPMfp2/Oib07mKCQsNdDyWN7+xvF+Lu5DRKP/2DYjIXdHiYhNS53E6Gw/qkMHIQ64ykOeEOF2f9H3RVSITS7mAJuURu0Rel7Y3zzmmZoPlWoawwfJiEykLwrGUbQNZ4MatdKAOmV6rny7Pkf9G+EBI/RcdXs98KOKP357bVFqN+KhB7zcKMC/lV6gjxh/qgwVqeavUVNeOz1yej0+/fjIh+JZIFut/hf/V1V1+/aJxLqVeYwJLLAi0ct09lQO9+lg++dh0aejL6freQdbi3J1vuk/G4DNj6QK43I4rPgUyn35cBSw9kGr+mzPEFHsg36l4Oh1kuucPZVQXpWZPa8ikqf78squRSvTf9shBpLZGrrkJ6TMqAxQa5w+TcPQ20k/Dk9HgUHodvrkevJ+O/Ts5eD8Iw/BcL2H3m0d30D9wh697z+neRJ99EDyoeSbzWxfPcN5gIg7GbFWbvHX0Kx6SO02WYZToR8/qZtE/r9U882d0kT+wtyq2WDiEIC1rJNfAlF5L8hFWKyvd9TT0lmjqnMDc6Aw6NhIE3uHB6ZjAT6jGE9G/7FTrq7Chc9H8VXiApGXcihkaUHUBN6j2kPxJhPbFLMYOXCc55IR1EmPKl0ObVYF9YKnEzrWKcCTXDJbVIe25S38if/bFvR/naQoRuRb1xx7brVNg2fFVTs41fLyZEZVune1aGdMMe4LDzGj982/rXVShqSWdNVzY7CcPZmEjKgI3D8W539hFzbRwo7dqEf/fHtWdojN773LbY22/BU06Nw/HsbOvU2a5Tl2rJpUjg/MMlXOs7VN/Wo656V6nfzamoiPx31nO2e145aTEujHBrP0PdH/NcHFffJzdTasIzdKmuBzA/dLmUTdiwO4sNN/XQVTKSZ5bNSOZr0rYZtVwlkb4f6BwVPaGSR5ZahSHPxXBJHcBDDp7nB1BjcXwYg3V8IdTiaa5pG6IrSmOVqV6g2nYlF/9E6lfqPHSp6pkpRe67xZJ+z7VnrrPzPkdFL6HP7XK0UyQ+o4x15isTFcyG/Nf//M9zNBnx0PuOpvL3hYFcr9DQfEQz/FziPc3snh4z/83CWhck0yLPJFrrFxYOF4Y7hEQshOPSt0hCLSDmOY+EFIRYItPEbaADejuAzym6FA19+ouhrU2CS5QE9G3dVYu24K+0uZtLvbIBcIgKKxRtWVClXMVE2IQ/AG2AK0Dl0ORG0DzhDFktKtu0cobHDjKu+AJJdtCLUoJSEDbB6KiwDqyWhTcZHBdS06ajcUghJtXi5C0NrwaBTmlWN5gSUpYIi0IkaAOIdYJQjUjkgkogQusgJ1tEjH6xUCip4zufN1rdQK6pXgguqeZ3bSR2Z7iy9HBXtjQ52AYsN5qm3nqzc3T0ySJl+J1Qd9XK5RhutmD6jJEVDqcvG9SvVqsdtL/q81wI9/ciAqqeVjht1i33Qri0iPwN6QrZ/qgkXaBCj5/ODWhlJDq2uxeOTocpynx4hY4QYofnHy59iX0Fv/77v/AOuVGQ6lWF1rgwKNewaFRR5KrMV2HbVkiYaw+8lCIeV+CjlQVaZ6tN04Pb3L92BudoKPg+ka26XNTibxozgaz/PW5SrSYU89g/JfXgRWXlh4dyfFlHk9n38ys0SxE3Y/8jGR564iELmBQxKoud5+L84sM7WMLpIGRBp0Q+I9vDd5c/vv356i1ZQzerithoEA5CPwBq6zKuOqousN3KVstc3+NV69aHFW/Tvqt/Lob/XAxvF8P1a+vw3g1zyYXvcer5p+pPbtiDXfGkWQtPA5Zq64hksyGIfDKyLOm42mZS21L3/e0+8w7Xne2r3xtU49OjtPWatCWd0g8jiHa/jkeR//JjnblX8Jy99d7gNP2JWneNaoxtYlNOaV9QNShkY/X1PI4x7/q90+H22sSLt9fMT2lpvzG6841R/QdJ32tTv2OqDKB/KdR7GTabqukqyy199elRjtrBhpoCNC3L8v/V5jZY","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"}}');var i=n(74848),r=n(28453),l=n(33617),a=n.n(l),o=n(17543),c=n.n(o),d=n(86013),p=n.n(d),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v2zgS/yqz7MO1gWLLidPu+WmD3V4ud8W2aFIUuMQwKGlssaFILUnZMQwB93Df4L7BfbT9JIehJEuKnTTeXfRpX9qYmv/z43BmNszxhWWTG/aTjosMlbNsGrAEbWxE7oRWbMJevHgBzWe4XudoJ7fqIzojcInAQQrrQM8haURAxC0moBW4dY636laNBnB09JPhc7eVZCdHR7cKAOC4PQOXcgfcIMSFMaicXINQkHhO67gr7IDknZC8S3X8weiFQWt/k9S8ZvYST0nijzrLJTpMniMv5UuECFGBLeIYrZ0XUq4h3spYCZcClxIM/lIIgwlYsVDcFQYrnWPS+fY+99+eqxFreq4S75LSILVaoAHurRCRRC/9zMccYynUoQ4lDVe0BpciFBbN4FaxgOkcDSdcXCZswhbomqQTCFjAcm54hg4NgWrDFM+QTViiY0ICC5ggQOXcpewhyq5T9HDpI8lpMDXSWMCaQLKJMwUGzLq1JPlWUMxZwPA+lzpBNplzaYkgTjHjbLJhXv+EWWeEWhClKjLCvYeWN6yBAwvYNoeVSK+S7K2iwqZlGWx9kyITrvHslwLNumdoY0ht6VybrGtn7cfWzIzfi4wsOwvDoDFaFVmEhpXEx72nk1HYMcHeifwPs+BxnWE5Jbk218qiJdqTMKT/+olsbwNs0eJjqhwqR/Q8z6WI/YfhF0tMm10DdPQFYw8pQ2KcqFQatIV0HTpuDCeHhcPMfp2/Oib07mKCQsNdDyWN7+xvF+Lu5DRKP/2DYjIXdHiYhNS53E6Gw/qkMHIQ64ykOeEOF2f9H3RVSITS7mAJuURu0Rel7Y3zzmmZoPlWoawwfJiEykLwrGUbQNZ4MatdKAOmV6rny7Pkf9G+EBI/RcdXs98KOKP357bVFqN+KhB7zcKMC/lV6gjxh/qgwVqeavUVNeOz1yej0+/fjIh+JZIFut/hf/V1V1+/aJxLqVeYwJLLAi0ct09lQO9+lg++dh0aejL6freQdbi3J1vuk/G4DNj6QK43I4rPgUyn35cBSw9kGr+mzPEFHsg36l4Oh1kuucPZVQXpWZPa8ikqf78squRSvTf9shBpLZGrrkJ6TMqAxQa5w+TcPQ20k/Dk9HgUHodvrkevJ+O/Ts5eD8Iw/BcL2H3m0d30D9wh697z+neRJ99EDyoeSbzWxfPcN5gIg7GbFWbvHX0Kx6SO02WYZToR8/qZtE/r9U882d0kT+wtyq2WDiEIC1rJNfAlF5L8hFWKyvd9TT0lmjqnMDc6Aw6NhIE3uHB6ZjAT6jGE9G/7FTrq7Chc9H8VXiApGXcihkaUHUBN6j2kPxJhPbFLMYOXCc55IR1EmPKl0ObVYF9YKnEzrWKcCTXDJbVIe25S38if/bFvR/naQoRuRb1xx7brVNg2fFVTs41fLyZEZVune1aGdMMe4LDzGj982/rXVShqSWdNVzY7CcPZmEjKgI3D8W539hFzbRwo7dqEf/fHtWdojN773LbY22/BU06Nw/HsbOvU2a5Tl2rJpUjg/MMlXOs7VN/Wo656V6nfzamoiPx31nO2e145aTEujHBrP0PdH/NcHFffJzdTasIzdKmuBzA/dLmUTdiwO4sNN/XQVTKSZ5bNSOZr0rYZtVwlkb4f6BwVPaGSR5ZahSHPxXBJHcBDDp7nB1BjcXwYg3V8IdTiaa5pG6IrSmOVqV6g2nYlF/9E6lfqPHSp6pkpRe67xZJ+z7VnrrPzPkdFL6HP7XK0UyQ+o4x15isTFcyG/Nf//M9zNBnx0PuOpvL3hYFcr9DQfEQz/FziPc3snh4z/83CWhck0yLPJFrrFxYOF4Y7hEQshOPSt0hCLSDmOY+EFIRYItPEbaADejuAzym6FA19+ouhrU2CS5QE9G3dVYu24K+0uZtLvbIBcIgKKxRtWVClXMVE2IQ/AG2AK0Dl0ORG0DzhDFktKtu0cobHDjKu+AJJdtCLUoJSEDbB6KiwDqyWhTcZHBdS06ajcUghJtXi5C0NrwaBTmlWN5gSUpYIi0IkaAOIdYJQjUjkgkogQusgJ1tEjH6xUCip4zufN1rdQK6pXgguqeZ3bSR2Z7iy9HBXtjQ52AYsN5qm3nqzc3T0ySJl+J1Qd9XK5RhutmD6jJEVDqcvG9SvVqsdtL/q81wI9/ciAqqeVjht1i33Qri0iPwN6QrZ/qgkXaBCj5/ODWhlJDq2uxeOTocpynx4hY4QYofnHy59iX0Fv/77v/AOuVGQ6lWF1rgwKNewaFRR5KrMV2HbVkiYaw+8lCIeV+CjlQVaZ6tN04Pb3L92BudoKPg+ka26XNTibxozgaz/PW5SrSYU89g/JfXgRWXlh4dyfFlHk9n38ys0SxE3Y/8jGR564iELmBQxKoud5+L84sM7WMLpIGRBp0Q+I9vDd5c/vv356i1ZQzerithoEA5CPwBq6zKuOqousN3KVstc3+NV69aHFW/Tvqt/Lob/XAxvF8P1a+vw3g1zyYXvcer5p+pPbtiDXfGkWQtPA5Zq64hksyGIfDKyLOm42mZS21L3/e0+8w7Xne2r3xtU49OjtPWatCWd0g8jiHa/jkeR//JjnblX8Jy99d7gNP2JWneNaoxtYlNOaV9QNShkY/X1PI4x7/q90+H22sSLt9fMT2lpvzG6841R/QdJ32tTv2OqDKB/KdR7GTabqukqyy199elRjtrBhpoCNC3L8v/V5jZY",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,b={},y=[{value:"Document Types:",id:"document-types",level:3}];function j(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(c(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:0}},xml:{name:"document"},title:"document"}}},title:"inline_response_200_4"}}}},404:{description:"Report not available!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Report not available!"}},title:"inline_response_404_5"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.c43d8780.js b/assets/js/runtime~main.505599aa.js similarity index 82% rename from assets/js/runtime~main.c43d8780.js rename to assets/js/runtime~main.505599aa.js index 233649d6f..499186326 100644 --- a/assets/js/runtime~main.c43d8780.js +++ b/assets/js/runtime~main.505599aa.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n<e.length;n++){c=e[n][0],f=e[n][1],b=e[n][2];for(var r=!0,o=0;o<c.length;o++)(!1&b||d>=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,b<d&&(d=b));if(r){e.splice(n--,1);var l=f();void 0!==l&&(a=l)}}return a}b=b||0;for(var n=e.length;n>0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({157:"8001f939",291:"4f7a2d40",490:"ce589067",539:"cfb1e6eb",560:"500027af",724:"fa40969b",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",962:"046910c8",1019:"5ce9853b",1179:"489b8a4d",1235:"a7456010",1381:"a2bc1463",1440:"277a78f5",1519:"78b2b753",1640:"c9fa5aa5",1688:"9640838e",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2089:"c7b98810",2131:"299c7a47",2223:"5a2de241",2264:"17e5210b",2634:"c4f5d8e4",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3213:"a9f09360",3249:"ccc49370",3276:"e5aefb32",3381:"42f80fc5",3392:"reactPlayerVidyard",3451:"70853c19",3605:"a88a3db3",3637:"f4f34a3a",3694:"8717b14a",3841:"56b5f4f8",3844:"bbdfc22d",3891:"8e4d0438",3976:"0e384e19",4134:"393be207",4212:"621db11d",4317:"0028a090",4469:"52d5c0f9",4553:"451a5132",4584:"f82cd581",4813:"6875c492",4948:"bfe4b778",5277:"8320e026",5305:"87a6df42",5378:"38e3d9c8",5510:"02d4f5c5",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5772:"28b19cd2",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6382:"5c04ee3b",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6685:"ae010e44",6743:"e226bb09",6792:"4d665321",6887:"reactPlayerFacebook",6969:"14eb3368",7068:"e92d0461",7098:"a7bd4aaa",7315:"f0ff4a36",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7605:"770b40a9",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7910:"e4f5c862",8025:"5e90a9b3",8097:"ab2a161b",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8209:"01a85c17",8211:"1f73ca32",8446:"reactPlayerYouTube",8462:"3217192f",8472:"13fdae3b",8503:"012b45bf",8609:"925b3f96",8669:"05632a52",8672:"8a725248",8734:"reactPlayerPreview",8737:"7661071f",8790:"2304e9ae",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9180:"8a855f99",9190:"6cb65baf",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9426:"38ec836e",9441:"377084eb",9599:"2c586be5",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9938:"7b076186",9979:"reactPlayerSoundCloud",9983:"ada7accb"}[e]||e)+"."+{157:"be2f595e",291:"fb6bc395",490:"06dc6e05",539:"7c131767",560:"1a361da4",724:"4a2b9b90",746:"8736e4d6",841:"82197ec0",849:"c75adfba",850:"3ac080ec",962:"4682dbdb",1019:"336a8868",1179:"b551b44c",1235:"e0fce024",1381:"504ac772",1440:"5dc69857",1463:"6c989e27",1519:"05461463",1640:"d2ce80bf",1688:"be33b996",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2089:"11b02d02",2131:"d7f2b515",2223:"fbd45b06",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"732a63bb",3213:"f206504f",3249:"d6c50b29",3276:"00ab24d9",3381:"dfcbba2f",3392:"a7951473",3451:"1727838e",3605:"168a453c",3637:"ffa80471",3694:"4d710693",3841:"aca67209",3844:"cb265dda",3891:"ef6c3502",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"f2e37798",4469:"ab1067bd",4553:"63947840",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"911cc9c6",5013:"b10f6f78",5277:"6e628336",5305:"760fdd56",5378:"73b1ae3a",5510:"92a4db7d",5550:"80901a1f",5557:"dffbf1c4",5597:"6d12f149",5742:"ac359952",5772:"20fd84d2",5939:"59375399",5970:"91dc704f",6007:"690277f8",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c63bec71",6382:"f55f760f",6463:"665cb544",6473:"0243df4f",6505:"fb48c691",6648:"49c57187",6653:"fdbc0c47",6685:"7182f56e",6743:"a3fe848c",6792:"9d8377ce",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b2ebdef8",7098:"c920e4e4",7315:"4600e4ad",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7605:"e63b830b",7627:"df6df631",7643:"4bb958af",7696:"6ededead",7757:"8c5bade9",7910:"65b14ba4",8025:"18e81984",8097:"43a7d9e8",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8209:"b9e31ef1",8211:"89441e90",8446:"594ab8ca",8462:"d040ed86",8472:"64fc90ce",8503:"45b8fe0a",8609:"6bdc8628",8669:"ecfd1686",8672:"ec40bb7e",8734:"1f259505",8737:"f138d21c",8790:"531003b7",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9180:"d1b9f1c1",9190:"dd359a70",9241:"77521554",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9426:"4597631d",9441:"1793addd",9599:"29f1f4c8",9611:"ed784bfd",9647:"2f22c378",9858:"939e017f",9938:"d801eba3",9979:"84827225",9983:"5ec1ab32"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n<l.length;n++){var i=l[n];if(i.getAttribute("src")==e||i.getAttribute("data-webpack")==b+c){r=i;break}}r||(o=!0,(r=document.createElement("script")).charset="utf-8",r.timeout=120,t.nc&&r.setAttribute("nonce",t.nc),r.setAttribute("data-webpack",b+c),r.src=e),f[e]=[a];var u=(a,c)=>{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325","8001f939":"157","4f7a2d40":"291",ce589067:"490",cfb1e6eb:"539","500027af":"560",fa40969b:"724",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","046910c8":"962","5ce9853b":"1019","489b8a4d":"1179",a7456010:"1235",a2bc1463:"1381","277a78f5":"1440","78b2b753":"1519",c9fa5aa5:"1640","9640838e":"1688",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",c7b98810:"2089","299c7a47":"2131","5a2de241":"2223","17e5210b":"2264",c4f5d8e4:"2634","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",a9f09360:"3213",ccc49370:"3249",e5aefb32:"3276","42f80fc5":"3381",reactPlayerVidyard:"3392","70853c19":"3451",a88a3db3:"3605",f4f34a3a:"3637","8717b14a":"3694","56b5f4f8":"3841",bbdfc22d:"3844","8e4d0438":"3891","0e384e19":"3976","393be207":"4134","621db11d":"4212","0028a090":"4317","52d5c0f9":"4469","451a5132":"4553",f82cd581:"4584","6875c492":"4813",bfe4b778:"4948","8320e026":"5277","87a6df42":"5305","38e3d9c8":"5378","02d4f5c5":"5510","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","28b19cd2":"5772","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353","5c04ee3b":"6382",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",ae010e44:"6685",e226bb09:"6743","4d665321":"6792",reactPlayerFacebook:"6887","14eb3368":"6969",e92d0461:"7068",a7bd4aaa:"7098",f0ff4a36:"7315",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570","770b40a9":"7605",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757",e4f5c862:"7910","5e90a9b3":"8025",ab2a161b:"8097","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","1f73ca32":"8211",reactPlayerYouTube:"8446","3217192f":"8462","13fdae3b":"8472","012b45bf":"8503","925b3f96":"8609","05632a52":"8669","8a725248":"8672",reactPlayerPreview:"8734","7661071f":"8737","2304e9ae":"8790",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","8a855f99":"9180","6cb65baf":"9190","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","38ec836e":"9426","377084eb":"9441","2c586be5":"9599","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858","7b076186":"9938",reactPlayerSoundCloud:"9979",ada7accb:"9983"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l<d.length;l++)b=d[l],t.o(e,b)&&e[b]&&e[b][0](),e[b]=0;return t.O(n)},c=self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[];c.forEach(a.bind(null,0)),c.push=a.bind(null,c.push.bind(c))})()})(); \ No newline at end of file +(()=>{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n<e.length;n++){c=e[n][0],f=e[n][1],b=e[n][2];for(var r=!0,o=0;o<c.length;o++)(!1&b||d>=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,b<d&&(d=b));if(r){e.splice(n--,1);var l=f();void 0!==l&&(a=l)}}return a}b=b||0;for(var n=e.length;n>0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({157:"8001f939",291:"4f7a2d40",490:"ce589067",539:"cfb1e6eb",560:"500027af",724:"fa40969b",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",962:"046910c8",1019:"5ce9853b",1179:"489b8a4d",1235:"a7456010",1381:"a2bc1463",1440:"277a78f5",1519:"78b2b753",1640:"c9fa5aa5",1688:"9640838e",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2089:"c7b98810",2131:"299c7a47",2223:"5a2de241",2264:"17e5210b",2634:"c4f5d8e4",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3213:"a9f09360",3249:"ccc49370",3276:"e5aefb32",3381:"42f80fc5",3392:"reactPlayerVidyard",3451:"70853c19",3605:"a88a3db3",3637:"f4f34a3a",3694:"8717b14a",3841:"56b5f4f8",3844:"bbdfc22d",3891:"8e4d0438",3976:"0e384e19",4134:"393be207",4212:"621db11d",4317:"0028a090",4469:"52d5c0f9",4553:"451a5132",4584:"f82cd581",4813:"6875c492",4948:"bfe4b778",5277:"8320e026",5305:"87a6df42",5378:"38e3d9c8",5510:"02d4f5c5",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5772:"28b19cd2",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6382:"5c04ee3b",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6685:"ae010e44",6743:"e226bb09",6792:"4d665321",6887:"reactPlayerFacebook",6969:"14eb3368",7068:"e92d0461",7098:"a7bd4aaa",7315:"f0ff4a36",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7605:"770b40a9",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7910:"e4f5c862",8025:"5e90a9b3",8097:"ab2a161b",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8209:"01a85c17",8211:"1f73ca32",8446:"reactPlayerYouTube",8462:"3217192f",8472:"13fdae3b",8503:"012b45bf",8609:"925b3f96",8669:"05632a52",8672:"8a725248",8734:"reactPlayerPreview",8737:"7661071f",8790:"2304e9ae",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9180:"8a855f99",9190:"6cb65baf",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9426:"38ec836e",9441:"377084eb",9599:"2c586be5",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9938:"7b076186",9979:"reactPlayerSoundCloud",9983:"ada7accb"}[e]||e)+"."+{157:"be2f595e",291:"fb6bc395",490:"06dc6e05",539:"7c131767",560:"1a361da4",724:"ac3256b6",746:"8736e4d6",841:"82197ec0",849:"d66f92df",850:"3ac080ec",962:"4682dbdb",1019:"e5a454ea",1179:"b551b44c",1235:"e0fce024",1381:"b30f8ee5",1440:"5dc69857",1463:"6c989e27",1519:"5a4dcd6c",1640:"d2ce80bf",1688:"be33b996",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2089:"11b02d02",2131:"d7f2b515",2223:"85cab8cc",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"732a63bb",3213:"09056bb0",3249:"d6c50b29",3276:"00ab24d9",3381:"dfcbba2f",3392:"a7951473",3451:"b02fe1ab",3605:"b00e16a9",3637:"ffa80471",3694:"4d710693",3841:"aca67209",3844:"a23572a7",3891:"ef6c3502",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"7094d241",4469:"4cc28061",4553:"5eff7d00",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"c60c5a5d",5013:"b10f6f78",5277:"6e628336",5305:"760fdd56",5378:"69204c41",5510:"92a4db7d",5550:"80901a1f",5557:"dffbf1c4",5597:"6d12f149",5742:"ac359952",5772:"6d63629e",5939:"59375399",5970:"91dc704f",6007:"690277f8",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c63bec71",6382:"24d5c460",6463:"665cb544",6473:"0243df4f",6505:"fb48c691",6648:"49c57187",6653:"fdbc0c47",6685:"101476aa",6743:"a3fe848c",6792:"3e8376ec",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b2ebdef8",7098:"c920e4e4",7315:"4e6daff2",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7605:"64935506",7627:"df6df631",7643:"4bb958af",7696:"6ededead",7757:"8c5bade9",7910:"65b14ba4",8025:"18e81984",8097:"43a7d9e8",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8209:"b9e31ef1",8211:"21256d76",8446:"594ab8ca",8462:"d040ed86",8472:"27c9c261",8503:"45b8fe0a",8609:"6bdc8628",8669:"f39cb8ab",8672:"a786571b",8734:"1f259505",8737:"f138d21c",8790:"bb7f0628",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9180:"b5c8d3ca",9190:"dd359a70",9241:"77521554",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9426:"4597631d",9441:"a6437b0c",9599:"ae975503",9611:"ed784bfd",9647:"2f22c378",9858:"939e017f",9938:"74d6bcf5",9979:"84827225",9983:"0a9d5bbe"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n<l.length;n++){var i=l[n];if(i.getAttribute("src")==e||i.getAttribute("data-webpack")==b+c){r=i;break}}r||(o=!0,(r=document.createElement("script")).charset="utf-8",r.timeout=120,t.nc&&r.setAttribute("nonce",t.nc),r.setAttribute("data-webpack",b+c),r.src=e),f[e]=[a];var u=(a,c)=>{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325","8001f939":"157","4f7a2d40":"291",ce589067:"490",cfb1e6eb:"539","500027af":"560",fa40969b:"724",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","046910c8":"962","5ce9853b":"1019","489b8a4d":"1179",a7456010:"1235",a2bc1463:"1381","277a78f5":"1440","78b2b753":"1519",c9fa5aa5:"1640","9640838e":"1688",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",c7b98810:"2089","299c7a47":"2131","5a2de241":"2223","17e5210b":"2264",c4f5d8e4:"2634","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",a9f09360:"3213",ccc49370:"3249",e5aefb32:"3276","42f80fc5":"3381",reactPlayerVidyard:"3392","70853c19":"3451",a88a3db3:"3605",f4f34a3a:"3637","8717b14a":"3694","56b5f4f8":"3841",bbdfc22d:"3844","8e4d0438":"3891","0e384e19":"3976","393be207":"4134","621db11d":"4212","0028a090":"4317","52d5c0f9":"4469","451a5132":"4553",f82cd581:"4584","6875c492":"4813",bfe4b778:"4948","8320e026":"5277","87a6df42":"5305","38e3d9c8":"5378","02d4f5c5":"5510","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","28b19cd2":"5772","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353","5c04ee3b":"6382",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",ae010e44:"6685",e226bb09:"6743","4d665321":"6792",reactPlayerFacebook:"6887","14eb3368":"6969",e92d0461:"7068",a7bd4aaa:"7098",f0ff4a36:"7315",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570","770b40a9":"7605",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757",e4f5c862:"7910","5e90a9b3":"8025",ab2a161b:"8097","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","1f73ca32":"8211",reactPlayerYouTube:"8446","3217192f":"8462","13fdae3b":"8472","012b45bf":"8503","925b3f96":"8609","05632a52":"8669","8a725248":"8672",reactPlayerPreview:"8734","7661071f":"8737","2304e9ae":"8790",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","8a855f99":"9180","6cb65baf":"9190","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","38ec836e":"9426","377084eb":"9441","2c586be5":"9599","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858","7b076186":"9938",reactPlayerSoundCloud:"9979",ada7accb:"9983"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l<d.length;l++)b=d[l],t.o(e,b)&&e[b]&&e[b][0](),e[b]=0;return t.O(n)},c=self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[];c.forEach(a.bind(null,0)),c.push=a.bind(null,c.push.bind(c))})()})(); \ No newline at end of file diff --git a/blog/archive/index.html b/blog/archive/index.html index c9a6777a9..70e417d44 100644 --- a/blog/archive/index.html +++ b/blog/archive/index.html @@ -5,7 +5,7 @@ <meta name="generator" content="Docusaurus v3.7.0"> <title data-rh="true">Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index 94bf3e7af..8544e39a1 100644 --- a/blog/authors/index.html +++ b/blog/authors/index.html @@ -5,7 +5,7 @@ Authors | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 585de33c9..ae6b31b63 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 38f6cea02..722d556e8 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 1b858678a..cabf2f25b 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 747c4dcdd..720c9eac1 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 2f1e132fe..98ef3481b 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 88f957df7..8de954fa7 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 a7cf0618a..e28d3069f 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 8c2e30399..14f7cf6ac 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 d8f54d758..c8b0aee99 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 2eb5b2a6d..605e93a6d 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 33fe8ceec..369d48cba 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 921a24499..42bcfa38f 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 8ce5f5b53..476d36dd7 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 7bddd1fff..583d005c1 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index 1ce358d2e..e77c28864 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 78c1bf8e3..fa0f066aa 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index cf0513d66..601f203ef 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 4fe2b706f..0124d6a77 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 9fd1d4558..909db4f0d 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 db34912e2..90f6853a5 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 60d461c3e..874188ef2 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftdocument/index.html b/docs/API-docs/draftdocument/index.html index cc9af5d91..5d66d1743 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index bf73cc45b..2f73d0759 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index 2aeb8d4fc..462578fd7 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 554822d81..73928cb13 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 114c46ea6..539c18349 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 fd52c1059..58f38fe37 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 7ccda03fe..782fc94e4 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 6177292ea..090f86f8b 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 0ecda9262..e3dfb53ce 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 64dc37b92..230f9cdef 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 c328c1e28..ef6de3f36 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 a0808d774..caf49bf2f 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 4a78f4bcd..1d257507a 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -3,19 +3,22 @@ -OpenSign API v1 | OpenSign™ +OpenSign API v1 | OpenSign™ - +
Skip to main content
Version: 1.0.0

OpenSign API v1

-

Welcome to the OpenSign™ API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign™ and transform your digital document processes today.

-

Some useful links:

+

Welcome to the OpenSign™ API documentation!

+

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

+

Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign™ and transform your digital document processes.

+

Useful Links:

Authentication​

Security Scheme Type:

apiKey

Header parameter name:

x-api-token

diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index bed3c99ab..ae8154d6f 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/revokedocument/index.html b/docs/API-docs/revokedocument/index.html index a6fe5dc85..2c8ba1e23 100644 --- a/docs/API-docs/revokedocument/index.html +++ b/docs/API-docs/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 193196c0a..f32ad5562 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/selfsign/index.html b/docs/API-docs/selfsign/index.html index 573d85f47..f4636ff80 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 18d04cc43..3d1508a5b 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 269b2f46e..a4432cec8 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index 6972d3ca3..0639edcf9 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 35aa91bf2..086aef893 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 15f14092f..ff4f7b2dc 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 44b62bca2..0e258da29 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/documents/index.html b/docs/category/documents/index.html index b97d63950..91cff7bb9 100644 --- a/docs/category/documents/index.html +++ b/docs/category/documents/index.html @@ -5,7 +5,7 @@ Documents | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 42b34f635..cd23393d6 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 ee8cdb5ca..6e50cd145 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 39e293b18..25f381836 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index f82f806b4..9650b43b9 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 d88ad7a94..01e2e9f89 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 21a449350..51a0b9242 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 7ddb8a382..9089c75ba 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 0370d454e..4ff0d2df8 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 80063303d..32472d363 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 5b5f7d3d1..379a99b42 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 ee1896b2e..4f5d72e37 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 dcd8db634..c7a772400 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/edit-document-before-sending/index.html b/docs/help/New-Document/edit-document-before-sending/index.html index a3644c39e..a7527ac14 100644 --- a/docs/help/New-Document/edit-document-before-sending/index.html +++ b/docs/help/New-Document/edit-document-before-sending/index.html @@ -5,7 +5,7 @@ Editing Your Document Before Sending | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index 1b1bc9c94..82d59dbb1 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index 3b43dbe8e..feb260ebc 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 990c80783..da24d3949 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 d26de97ef..1a3aae1ba 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 59d5f71d9..bdf5f3040 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 f354c5985..550360180 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 7a9d18517..f452b1401 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 4f9c4e067..ca899ee40 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 23943e94b..6180e3ecd 100644 --- a/docs/help/Reports/completed/index.html +++ b/docs/help/Reports/completed/index.html @@ -5,7 +5,7 @@ Completed | OpenSign™ - + diff --git a/docs/help/Reports/contactbook/index.html b/docs/help/Reports/contactbook/index.html index 0d1a2c585..80b6e90ac 100644 --- a/docs/help/Reports/contactbook/index.html +++ b/docs/help/Reports/contactbook/index.html @@ -5,7 +5,7 @@ Contactbook | OpenSign™ - + diff --git a/docs/help/Reports/declined/index.html b/docs/help/Reports/declined/index.html index bfd5730f0..3d9c99b2d 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 b06991714..4c77b6c32 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 d9addb94d..d38e941f1 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 a49a851a3..f4d9eb464 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 0c6a38c15..26a55d721 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/APIToken/index.html b/docs/help/Settings/APIToken/index.html index 12b558a0a..be3433278 100644 --- a/docs/help/Settings/APIToken/index.html +++ b/docs/help/Settings/APIToken/index.html @@ -5,7 +5,7 @@ API Token | OpenSign™ - + diff --git a/docs/help/Settings/Teams/index.html b/docs/help/Settings/Teams/index.html index 56941367a..0e78c2576 100644 --- a/docs/help/Settings/Teams/index.html +++ b/docs/help/Settings/Teams/index.html @@ -5,7 +5,7 @@ Manage Teams | OpenSign™ - + diff --git a/docs/help/Settings/Webhook/index.html b/docs/help/Settings/Webhook/index.html index a903942aa..ab5953d81 100644 --- a/docs/help/Settings/Webhook/index.html +++ b/docs/help/Settings/Webhook/index.html @@ -5,7 +5,7 @@ Webhook | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index 9d9fc5dae..d68014b95 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 a3688c302..c65033b91 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 613683335..c3fe13e88 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 8a6582d02..369a61940 100644 --- a/docs/help/Templates/create-template/index.html +++ b/docs/help/Templates/create-template/index.html @@ -5,7 +5,7 @@ Create Templates | OpenSign™ - + diff --git a/docs/help/Templates/embed-template/index.html b/docs/help/Templates/embed-template/index.html index a487abdb6..7a98d27fa 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index a9d114be2..2028f7fa8 100644 --- a/docs/help/Templates/publicTemplate/index.html +++ b/docs/help/Templates/publicTemplate/index.html @@ -5,7 +5,7 @@ Setting up an OpenSign template for public signing | OpenSign™ - + diff --git a/docs/help/Templates/quick-send/index.html b/docs/help/Templates/quick-send/index.html index e2dd682d0..c710d7029 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 f628ee8e4..27367c1ac 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 58c3fd4f4..bcb140b8a 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 ffcddac39..db3bcc3a8 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 8881f16d6..f102dbb35 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 79283843f..017638548 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 2f03ca99c..36dcf0fa4 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 4cdf04875..e10241831 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/azure-vm-setup/index.html b/docs/self-host/guides/azure-vm-setup/index.html index 9a93a61f6..25045115b 100644 --- a/docs/self-host/guides/azure-vm-setup/index.html +++ b/docs/self-host/guides/azure-vm-setup/index.html @@ -5,7 +5,7 @@ OpenSign Deployment Guide on Azure VM via command-line | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index c263d5f35..b5b9a2f3d 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 416cdc195..a74211a38 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 f1bc64fa6..bf9c015e8 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 0063160f5..f9283b9d4 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 8ef51a57e..c64c60147 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 01964ecc3..fc11c21a3 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +