From 2d27b870006166a244899c95b820dfed0f6bbc3c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 5 Feb 2025 13:06:47 +0000 Subject: [PATCH] deploy: d919e8514bbe565b8b9ccb389507e7d78100b04b --- 404.html | 2 +- assets/js/a9f09360.524e33af.js | 1 + assets/js/a9f09360.553c32a0.js | 1 - assets/js/ae010e44.84114f8b.js | 1 + assets/js/ae010e44.a965d111.js | 1 - .../js/{runtime~main.a74dc2c1.js => runtime~main.9115d433.js} | 2 +- blog/archive/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 2 +- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 2 +- docs/API-docs/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 | 4 ++-- 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 | 2 +- docs/API-docs/resendrequestmail/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 2 +- docs/API-docs/selfsign/index.html | 4 ++-- 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 +- docs/category/create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- docs/category/manage-docs-using-opensign-drive/index.html | 2 +- docs/category/reports/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/index.html | 2 +- docs/help/New-Document/enforce-email-verification/index.html | 2 +- docs/help/New-Document/navigate-between-pages/index.html | 2 +- docs/help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/OpenSign™ Drive/create-document/index.html | 2 +- docs/help/OpenSign™ Drive/list-grid-view/index.html | 2 +- docs/help/OpenSign™ Drive/organize-documents/index.html | 2 +- docs/help/OpenSign™ Drive/rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/contactbook/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- docs/help/Settings/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 +- docs/self-host/One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/cloud-storage/s3/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- docs/self-host/docker/upgrade-deployment/index.html | 2 +- docs/self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- docs/self-host/guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 98 files changed, 98 insertions(+), 98 deletions(-) create mode 100644 assets/js/a9f09360.524e33af.js delete mode 100644 assets/js/a9f09360.553c32a0.js create mode 100644 assets/js/ae010e44.84114f8b.js delete mode 100644 assets/js/ae010e44.a965d111.js rename assets/js/{runtime~main.a74dc2c1.js => runtime~main.9115d433.js} (98%) diff --git a/404.html b/404.html index 5b331921b..0c2444960 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/a9f09360.524e33af.js b/assets/js/a9f09360.524e33af.js new file mode 100644 index 000000000..f89694154 --- /dev/null +++ b/assets/js/a9f09360.524e33af.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8888],{63135:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcI7IyYOIhC8OTkCURR6bqG2aCw4DVNUaIRDUDiHPE4H4wVURl/LXKop5MIJmEs3g7Gw+OoAUGU6xxwmssDBuTpXp7I6hA9VoUUOC10bOHn3P81stAy1ne3svMNxPYUPRzs7F1/NnKvs4d6eqKqBrlBZOVWFGNtBpsu9nACrfPI8hfkMDdKskAkFKKwsFiDyHOYyn6KzKbgZKsh0tYBMa5NLJRzaFCoxRVB1OUZjUxAqh1IbBKlAgEGRL3ad3q0twv++P/4BJtqUwg3gpKht2iyXS4OZKxZ+ejfDZlfPbKSGdUaqaQqluCJqSQe/1DK7om1bVDn9pYFvTo6YVjs77+uq0sZhDj/5LRzu7FDPN1joOQiDDJ/pstQKKmFEiY6PayYcdxv8pZYGc38ooigiLQ7P1S7s7LhFhYc7O3CkcpkRMXhCagU9CbADD0pEItD3FWZyIgNoh3SgFcxnMpsxTebCn2dViMyjadBWmDl5jf2Jb1JY0MTvUOmIwUwb+atWThR8HNdonMxE0T02QpBArRPGETkrLZWLrWEF+Ec4Hjo9PpTAV4RaTsQqpeIei3AtihptwGqewoyw+hErg5ZZPcxLhFQ5zFBOZxvXE/nH2rrexFBbQrOLRVgrnhKTF5lsE1FYBDnp0bIUV9hZDTSLsCgG8M0CcpyIunApSOI4Z2ocwA/agaiqQmZiXCBxLpDwCFcb3OVTDuwQEFGi5DM+YYlGCwJyOZmgIeGkTp4ijInYEZ+1KoAlx82EAq1WDjrThTY0/QoPcXufkJBp5VC5Aby5FrJg7P1uLUiVFXWOMC5EdpXCuKgxBYO5l9wFkt5KgxYiEBA2EJ0JBBYLYkOtaANKh+WlBRuwygdwOpO2FSjqjLTmRaTtkjWI7UTTykSDKGOApZBFypRL4aMeg5OuwJQkthJqkZLCxBQc3rixvkkhm2F2xb+MyKWGce2cVn5judFVrucqEHOilbPy1zUiGXs+naKjFA5SeJXC6xSG+ykMRykMD1IYvkph+DqF0X4Ko1EKo4MURq88WqPXgdaiIXAXgeHIU9n9cahLivc7aVm0SWPaRgnPe0r4XA0HsLPTCBQ3//zzz+fq9lwBnCckYOfJ4XnSgJwnKfg+0pvnyeEwhdBwc54cwovR1xFgQd+viLr+e07fQzoN/z2j79HwXC3DoiNGxomyugcR6v7tkYifgZ+okVemtqjbqJGUkoelHjo3am3Qoo5lu6EXtCGppJOisJv3FCGe3rZazFZ2dkA7Y+7dvC3ufnp7imjFHlaevouVbacrqgFGZLRCgpeD9rrZQAG/6FMjQMDqS/f/ivbf6KzNRGhAnh4luqh9KTm+HrB9wHp7MzECwNMjRYvYlxLiNRGC7q3NVKDep0eCgFXsCLaA79s/2B2+3B3tjw56ZCA3ygOU5W6e7y4Wiy8kITDByDwK67O1GaxZbwSSBzsxulzjqrAn0UIF84l/R/P+ezLqx9HexZx8RHZConHTeIddi9zpXCyeWT9VHNrYcQTfWnGLDprcRXiwp5zNtMwC8gQTrbcxOYMDIsIuET7f+/77vQ4pfeNuWUb6Qmyl710mfbe1LAd5PliF7Z1Qp7WEPE9hTfv6jjyHsiw3tfsOui7P1Z9JEILptlkWAsDvIw5ruL5df6OstB0i16rg9dm7Wy8rK/fLTKrQEfgGVgAMTutCGLwhN9VKrZguv4EmWpGiKEStmc9eLTuEHDPwlICvjoMp/zwwOO2gPwG1PDzuzsa6kxic4g3PkdXW6ZKQkbmgGVKwdTYjp09Ej4HI3sZ3+CsTlaToQoHOcSu6bLAOCX9oHc+cDnXVMbfoepsRFuLINb45nz47GsN9vveCX3LPxRcgnp7a72AWO320g7rPzpNSBNMlmWD7W7sZmvPkohnjfXLMO2Nh3WC4uEeeoBWaHAsxxuKurD1aGrrbCZzVIQ51lFI1oQRGeT9iwL3iZqU3dC7XyJnfdpfBo3KPYhLpDIW0MZ7SJ1p3dAg4cRhQIXJkcYwQB1DQNkrxl7J8g9gjeD4qhHA6D6xAcMCATawvLnaPUNEKvZPp0oXmKKWSZV02QctJM2ukWBku+S65aCSFwuMK3dO9s4K4eWAFihBuXuBcDTmyEGMSrBdgvS0YQJ6eYuhg9vAN+Dkqo3drfu599+mCGPfVFcQ11ySB+guyEUK7WQoHcEyXEkVM/SAKgWUZVo7CZV8qog3Kj7uWhhxJ6obINl9MXajfmwc3MdNjuHMF79+MDwPcl9leRLXHMWN3G38ghuyh/WhbyccDS5+G2hQMLJn1npoyDGit3PxJmuiKcqpSq6M8OUxyysLGtGGS8tRo3Tc6XySHt0mI4NPPEB+nkXsfLaVxbxObzbAU9CuiRIlfyrwmacKBGsr9EqmSw0SPP2JGa1SGcHASLY1k6MPbCOUTlkkanPXkMPGZzCRN8EaUFQEnK6neKp8ky7jgfVM1Le1Uln80mVOah3KCnznNDzSUUSnxVL/V1OjwnVjYzoT+kk5Wk+I0hlg2C6MgFwtLUlBbb05losjqgtx0vKmkWTQxA/bVO4fYINqs1CA6fLlMOTmApouSMEYskjSRDstu+4YzM/rTCZ2hJspwNPdTx37UOEb8S2igJDyfkyg/GYuPGmGMfEbVTKtPHj8cvRiOhi+GI5ohJGc+n46+9y4GfcZ4Q04l5tHE3m0TqilwHmPwEHNGeN62mOLDzHi6KdHeSe/Zma6LnBJnKMyA892fXUrR5+/m5hg8wM3LNLl5eDM3kOndmMWHrwqcOKirCg1k2ig0z7vhuSezudHBwTJNFg9vb/GH3N7XdHjzh3f3E5c/tKUh/wlcX7xepsnsYVz/1hRo/AeRPXi1bC/DJDMoHMbL4XKs88Vl1FvLhwDjRUFwE13kaMhouKuvWlVDGoYKiy5X9fxY6wKFWqNoeon5UAJGJhxZbyE+PZ8h2cCtZcezt8ZksPU8tpTsx5WQobRkspkaz5MBHE06pim7+au1ARGW8/RKwzNe79LWrMaf7YVvotGzbhEU1aW0cfmIAgODw7IquIpoLouC8KZ7fQDNP7bOGkoSAvG6jAs/fFW89aFJXjAM6pfgQDDwBvBWqKYKo1/tALe3DRswdyyXcHtLp4rmki7d5TJtG2itXgPfq77FYIbyujeqacJ2YNPWGepNnEsycXxDSHh1EZBTJdX0sjbFcjm4w4btGT2abnfIFM6OJvl/QDFC50gdmxzNIyT3aOK9Kw3PiFmfhTA3U0Ya64I8enYPCPvM1QYqh+IFcsq+beTb1mNLUCrO18qPM3I6RSo1DBA8ONQGochmXjMwVmJCos3lgwavpa5tRG8mbGNy5wQhvbhINe07hx3qcOlWd++DdaKrqJjo+PTkEbRk13XXayLv8fld+jng+PSEChLlJDhgA/hgG0pE0ooeCJBrBNdSxJqlxnxb+GgjKqaIV5u96tFBKAXchbsI5dKuxShtUx9N+e6diduKVToiXTsqlZWhDMs6rGyPjoxFQ8hTXT+GKx+gpIBpzVlUR7dyVI2cjmkLCqWyztQ+0gp5bWINZWALgszQ2pZOkSoE1Jk/BVTWDxcwEdahSaFWkihvagpsNFPiTYVGospwLQkMetKR5D6szfrFeR9+/C7UKcc9RKEckwT6iTGHumKuYUloqkbjya1ufYO27ai8h9Hk6k5tgvSHeHuFxmpFzdpMhZK/em7WnpPGOBPFhA2sJpfOly6qPOJMs/XxixbWv//5L0KVOfWy1HnDvfbxjHVC9bvONsrIaa73xgJ9cXrMBDZKzqZRsdngrlFC0HDijrelK9oP3kjrOrWGMc1/Vyh/RKJn1sGBzXsSJWI0tehKVYNXqGlsp2PDS/brVBvzcoUBO2ZiL2Dkb1c2I9sAUFB/VHutlfWO7mh/n/70KdrU/gfTk2hHzDWpi2LxpyR9fPTpfi+7wVauNV7v85xnH+Xo15vsenRCjLNB+O6dIBj6tSmoop/4dLc5A45jdGgrVSEVXjKJL3OdXRq0l6P9/csh0XiZJgfryPhel+hmzDpEzLnRVPBfFSioAN0sQEyFVEC2p/kNqYrGaHO/M/BpmK2hROShy4MeEV7eJcKR4qQpPyM51Veoft+ddpd3fnlC9aZkhvHqMJEeiPuT3ma77X6TFrPaSLdIDs9uk5tdUcld3394drG8SBMirKYAbqUtYyzcLDlM9lbjuRbNNYf6zm49+zYcaYXKKa95x/0Uldy7HibLdHXEWmd1I7R1YirVdPfeURftTt/TaXiC9/bbxtYq+Xek4FogZxcqTSRxwQwF2a5EQDrkH9tg9rfxqGLAeV0MuT2S1ahwDAr34rzrw7zDl50A61mMlXL4s4l+rgtoNvuKIcomQtkJOnZijmctPzbhvRjdG3JYbHRwwPGjr4ccaHnxmmMYB6+WzEGtP58kfZ+dUwqrnmeS9D2qOKjxF8Ko1uj1KbKe9Raa+tZMO3PPeujd2hsu7WgeSTXRzCnh+I4rVO/J+iR5vB7ejSlhkemyKfSP4P/+5794RDx2XuZPcFwbqPQczaT2rwUmBd5Isvc6j9ZixAJFWaC1xQLIzJvy87VcTrnyJxpRmajEWBaSFAyBaR/B7+goO4Cf2pjHM+OLoK6xIL0Ehdb8motsj9rpkteIl+lcm6sJoZSCgDE9AEJL3grGIahmQmVkM3nBY2uEXq+RWVoZaRGELAmYzGOcTGQm+ZbWyhmROSiFElM2K1KObREVqvh8x+gxeRdWF7W3n+kREaLzW+Qc4ADekb/CG+fMBTohC8y96WxT77oE2Qiv48bkJla0vMzQtqWTBV6jYUXjHc+6KKDSzjuDZFd1z5YmckYoSzd2yJqEo2nIFwxcXiMXiwFQIpAuMvJriAEKqa78W7azhs1+wrGVDtu43nw+v6P0nvfH/FW6WT0Gg5Vux025kVVkd3jz8ZyUDprSHk/eo7mWWbQxNqy5x8B74S4UPoQUlZCo5F9WB9C9VMgMlcXOzfXmryffwTW8GOwnaUfNPwLhve+O3n77w/tvaV66iLz8DQf7g31ORmjrSqE6S/Wfha5KbicjuX1Eun1Eun1Eun1Eun1E+od55rh9RLp9RLp9RLp9RLp9RLp9RLp9RPoESLF9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RPo03uxtH5FuH5E+KYbcPiKNj0hD5QnZjXtVIaTqlMf5UqSzlaelF2kyo1Klw7Pk9pbyih+oBp2af6nRUJ3TRZpcCyMpeM5VTmks56FSlyukmpO3Phewe0rLp57tOZG9UtxF1Uh+xBs+/Hthu9VUJ8fvT5M0iY8GSp3TGCPm9DRWzJPDhHQ2v6Jt6ka5/TYphJrWXH2T+HmpCknUbtYvYbriEqbwo1PEI9Sig2W/tslvhf6nja0d8F+U+v47Lv67Afc9GwcE2kZoOsGL5XL5f5vwpBI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/draftdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftdocument",permalink:"/docs/API-docs/draftdocument",draft:!1,unlisted:!1,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 base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcI7IyYOIhC8OTkCURR6bqG2aCw4DVNUaIRDUDiHPE4H4wVURl/LXKop5MIJmEs3g7Gw+OoAUGU6xxwmssDBuTpXp7I6hA9VoUUOC10bOHn3P81stAy1ne3svMNxPYUPRzs7F1/NnKvs4d6eqKqBrlBZOVWFGNtBpsu9nACrfPI8hfkMDdKskAkFKKwsFiDyHOYyn6KzKbgZKsh0tYBMa5NLJRzaFCoxRVB1OUZjUxAqh1IbBKlAgEGRL3ad3q0twv++P/4BJtqUwg3gpKht2iyXS4OZKxZ+ejfDZlfPbKSGdUaqaQqluCJqSQe/1DK7om1bVDn9pYFvTo6YVjs77+uq0sZhDj/5LRzu7FDPN1joOQiDDJ/pstQKKmFEiY6PayYcdxv8pZYGc38ooigiLQ7P1S7s7LhFhYc7O3CkcpkRMXhCagU9CbADD0pEItD3FWZyIgNoh3SgFcxnMpsxTebCn2dViMyjadBWmDl5jf2Jb1JY0MTvUOmIwUwb+atWThR8HNdonMxE0T02QpBArRPGETkrLZWLrWEF+Ec4Hjo9PpTAV4RaTsQqpeIei3AtihptwGqewoyw+hErg5ZZPcxLhFQ5zFBOZxvXE/nH2rrexFBbQrOLRVgrnhKTF5lsE1FYBDnp0bIUV9hZDTSLsCgG8M0CcpyIunApSOI4Z2ocwA/agaiqQmZiXCBxLpDwCFcb3OVTDuwQEFGi5DM+YYlGCwJyOZmgIeGkTp4ijInYEZ+1KoAlx82EAq1WDjrThTY0/QoPcXufkJBp5VC5Aby5FrJg7P1uLUiVFXWOMC5EdpXCuKgxBYO5l9wFkt5KgxYiEBA2EJ0JBBYLYkOtaANKh+WlBRuwygdwOpO2FSjqjLTmRaTtkjWI7UTTykSDKGOApZBFypRL4aMeg5OuwJQkthJqkZLCxBQc3rixvkkhm2F2xb+MyKWGce2cVn5judFVrucqEHOilbPy1zUiGXs+naKjFA5SeJXC6xSG+ykMRykMD1IYvkph+DqF0X4Ko1EKo4MURq88WqPXgdaiIXAXgeHIU9n9cahLivc7aVm0SWPaRgnPe0r4XA0HsLPTCBQ3//zzz+fq9lwBnCckYOfJ4XnSgJwnKfg+0pvnyeEwhdBwc54cwovR1xFgQd+viLr+e07fQzoN/z2j79HwXC3DoiNGxomyugcR6v7tkYifgZ+okVemtqjbqJGUkoelHjo3am3Qoo5lu6EXtCGppJOisJv3FCGe3rZazFZ2dkA7Y+7dvC3ufnp7imjFHlaevouVbacrqgFGZLRCgpeD9rrZQAG/6FMjQMDqS/f/ivbf6KzNRGhAnh4luqh9KTm+HrB9wHp7MzECwNMjRYvYlxLiNRGC7q3NVKDep0eCgFXsCLaA79s/2B2+3B3tjw56ZCA3ygOU5W6e7y4Wiy8kITDByDwK67O1GaxZbwSSBzsxulzjqrAn0UIF84l/R/P+ezLqx9HexZx8RHZConHTeIddi9zpXCyeWT9VHNrYcQTfWnGLDprcRXiwp5zNtMwC8gQTrbcxOYMDIsIuET7f+/77vQ4pfeNuWUb6Qmyl710mfbe1LAd5PliF7Z1Qp7WEPE9hTfv6jjyHsiw3tfsOui7P1Z9JEILptlkWAsDvIw5ruL5df6OstB0i16rg9dm7Wy8rK/fLTKrQEfgGVgAMTutCGLwhN9VKrZguv4EmWpGiKEStmc9eLTuEHDPwlICvjoMp/zwwOO2gPwG1PDzuzsa6kxic4g3PkdXW6ZKQkbmgGVKwdTYjp09Ej4HI3sZ3+CsTlaToQoHOcSu6bLAOCX9oHc+cDnXVMbfoepsRFuLINb45nz47GsN9vveCX3LPxRcgnp7a72AWO320g7rPzpNSBNMlmWD7W7sZmvPkohnjfXLMO2Nh3WC4uEeeoBWaHAsxxuKurD1aGrrbCZzVIQ51lFI1oQRGeT9iwL3iZqU3dC7XyJnfdpfBo3KPYhLpDIW0MZ7SJ1p3dAg4cRhQIXJkcYwQB1DQNkrxl7J8g9gjeD4qhHA6D6xAcMCATawvLnaPUNEKvZPp0oXmKKWSZV02QctJM2ukWBku+S65aCSFwuMK3dO9s4K4eWAFihBuXuBcDTmyEGMSrBdgvS0YQJ6eYuhg9vAN+Dkqo3drfu599+mCGPfVFcQ11ySB+guyEUK7WQoHcEyXEkVM/SAKgWUZVo7CZV8qog3Kj7uWhhxJ6obINl9MXajfmwc3MdNjuHMF79+MDwPcl9leRLXHMWN3G38ghuyh/WhbyccDS5+G2hQMLJn1npoyDGit3PxJmuiKcqpSq6M8OUxyysLGtGGS8tRo3Tc6XySHt0mI4NPPEB+nkXsfLaVxbxObzbAU9CuiRIlfyrwmacKBGsr9EqmSw0SPP2JGa1SGcHASLY1k6MPbCOUTlkkanPXkMPGZzCRN8EaUFQEnK6neKp8ky7jgfVM1Le1Uln80mVOah3KCnznNDzSUUSnxVL/V1OjwnVjYzoT+kk5Wk+I0hlg2C6MgFwtLUlBbb05losjqgtx0vKmkWTQxA/bVO4fYINqs1CA6fLlMOTmApouSMEYskjSRDstu+4YzM/rTCZ2hJspwNPdTx37UOEb8S2igJDyfkyg/GYuPGmGMfEbVTKtPHj8cvRiOhi+GI5ohJGc+n46+9y4GfcZ4Q04l5tHE3m0TqilwHmPwEHNGeN62mOLDzHi6KdHeSe/Zma6LnBJnKMyA892fXUrR5+/m5hg8wM3LNLl5eDM3kOndmMWHrwqcOKirCg1k2ig0z7vhuSezudHBwTJNFg9vb/GH3N7XdHjzh3f3E5c/tKUh/wlcX7xepsnsYVz/1hRo/AeRPXi1bC/DJDMoHMbL4XKs88Vl1FvLhwDjRUFwE13kaMhouKuvWlVDGoYKiy5X9fxY6wKFWqNoeon5UAJGJhxZbyE+PZ8h2cCtZcezt8ZksPU8tpTsx5WQobRkspkaz5MBHE06pim7+au1ARGW8/RKwzNe79LWrMaf7YVvotGzbhEU1aW0cfmIAgODw7IquIpoLouC8KZ7fQDNP7bOGkoSAvG6jAs/fFW89aFJXjAM6pfgQDDwBvBWqKYKo1/tALe3DRswdyyXcHtLp4rmki7d5TJtG2itXgPfq77FYIbyujeqacJ2YNPWGepNnEsycXxDSHh1EZBTJdX0sjbFcjm4w4btGT2abnfIFM6OJvl/QDFC50gdmxzNIyT3aOK9Kw3PiFmfhTA3U0Ya64I8enYPCPvM1QYqh+IFcsq+beTb1mNLUCrO18qPM3I6RSo1DBA8ONQGochmXjMwVmJCos3lgwavpa5tRG8mbGNy5wQhvbhINe07hx3qcOlWd++DdaKrqJjo+PTkEbRk13XXayLv8fld+jng+PSEChLlJDhgA/hgG0pE0ooeCJBrBNdSxJqlxnxb+GgjKqaIV5u96tFBKAXchbsI5dKuxShtUx9N+e6diduKVToiXTsqlZWhDMs6rGyPjoxFQ8hTXT+GKx+gpIBpzVlUR7dyVI2cjmkLCqWyztQ+0gp5bWINZWALgszQ2pZOkSoE1Jk/BVTWDxcwEdahSaFWkihvagpsNFPiTYVGospwLQkMetKR5D6szfrFeR9+/C7UKcc9RKEckwT6iTGHumKuYUloqkbjya1ufYO27ai8h9Hk6k5tgvSHeHuFxmpFzdpMhZK/em7WnpPGOBPFhA2sJpfOly6qPOJMs/XxixbWv//5L0KVOfWy1HnDvfbxjHVC9bvONsrIaa73xgJ9cXrMBDZKzqZRsdngrlFC0HDijrelK9oP3kjrOrWGMc1/Vyh/RKJn1sGBzXsSJWI0tehKVYNXqGlsp2PDS/brVBvzcoUBO2ZiL2Dkb1c2I9sAUFB/VHutlfWO7mh/n/70KdrU/gfTk2hHzDWpi2LxpyR9fPTpfi+7wVauNV7v85xnH+Xo15vsenRCjLNB+O6dIBj6tSmoop/4dLc5A45jdGgrVSEVXjKJL3OdXRq0l6P9/csh0XiZJgfryPhel+hmzDpEzLnRVPBfFSioAN0sQEyFVEC2p/kNqYrGaHO/M/BpmK2hROShy4MeEV7eJcKR4qQpPyM51Veoft+ddpd3fnlC9aZkhvHqMJEeiPuT3ma77X6TFrPaSLdIDs9uk5tdUcld3394drG8SBMirKYAbqUtYyzcLDlM9lbjuRbNNYf6zm49+zYcaYXKKa95x/0Uldy7HibLdHXEWmd1I7R1YirVdPfeURftTt/TaXiC9/bbxtYq+Xek4FogZxcqTSRxwQwF2a5EQDrkH9tg9rfxqGLAeV0MuT2S1ahwDAr34rzrw7zDl50A61mMlXL4s4l+rgtoNvuKIcomQtkJOnZijmctPzbhvRjdG3JYbHRwwPGjr4ccaHnxmmMYB6+WzEGtP58kfZ+dUwqrnmeS9D2qOKjxF8Ko1uj1KbKe9Raa+tZMO3PPeujd2hsu7WgeSTXRzCnh+I4rVO/J+iR5vB7ejSlhkemyKfSP4P/+5794RDx2XuZPcFwbqPQczaT2rwUmBd5Isvc6j9ZixAJFWaC1xQLIzJvy87VcTrnyJxpRmajEWBaSFAyBaR/B7+goO4Cf2pjHM+OLoK6xIL0Ehdb8motsj9rpkteIl+lcm6sJoZSCgDE9AEJL3grGIahmQmVkM3nBY2uEXq+RWVoZaRGELAmYzGOcTGQm+ZbWyhmROSiFElM2K1KObREVqvh8x+gxeRdWF7W3n+kREaLzW+Qc4ADekb/CG+fMBTohC8y96WxT77oE2Qiv48bkJla0vMzQtqWTBV6jYUXjHc+6KKDSzjuDZFd1z5YmckYoSzd2yJqEo2nIFwxcXiMXiwFQIpAuMvJriAEKqa78W7azhs1+wrGVDtu43nw+v6P0nvfH/FW6WT0Gg5Vux025kVVkd3jz8ZyUDprSHk/eo7mWWbQxNqy5x8B74S4UPoQUlZCo5F9WB9C9VMgMlcXOzfXmryffwTW8GOwnaUfNPwLhve+O3n77w/tvaV66iLz8DQf7g31ORmjrSqE6S/Wfha5KbicjuX1Eun1Eun1Eun1Eun1E+od55rh9RLp9RLp9RLp9RLp9RLp9RLp9RPoESLF9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RPo03uxtH5FuH5E+KYbcPiKNj0hD5QnZjXtVIaTqlMf5UqSzlaelF2kyo1Klw7Pk9pbyih+oBp2af6nRUJ3TRZpcCyMpeM5VTmks56FSlyukmpO3Phewe0rLp57tOZG9UtxF1Uh+xBs+/Hthu9VUJ8fvT5M0iY8GSp3TGCPm9DRWzJPDhHQ2v6Jt6ka5/TYphJrWXH2T+HmpCknUbtYvYbriEqbwo1PEI9Sig2W/tslvhf6nja0d8F+U+v47Lv67Afc9GwcE2kZoOsGL5XL5f5vwpBI=",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"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "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 "readonly": false,\n "required": true, \n "name": "radio button",\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)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"document_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-send-document.com"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "document_id": "hji2zxcv2P",\n "url": "https://url-to-send-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.553c32a0.js b/assets/js/a9f09360.553c32a0.js deleted file mode 100644 index 7cbf67696..000000000 --- a/assets/js/a9f09360.553c32a0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8888],{63135:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO39zGzeuXwW3/6TxrGVLcdKc582bS5O+O79ra0/jTOfG9rjULiQx3iW3JNey6tF/90nuo90neQOQ3B+yZDtJp+fOU/6ItSRIgiAAAiBwmzgxtcnhWfJOZ3WJytnkIk1ytJmRlZNaJYfJ6QzhnRETBxEI3pwcgSgKPbdQWzQWnIYpKjTCISicQx6ng/ECKqOvZS7VFHLhBMylm8FYWHx1AKgynWMOE1ng4Fydq1NZHcKHqtAih4WuDZy8+59mNlqG2s52dt7huJ7Ch6OdnYuvZs5V9nBvT1TVQFeorJyqQoztINPlXk6AVT55nsJ8hgZpVsiEAhRWFgsQeQ5zmU/R2RTcDBVkulpAprXJpRIObQqVmCKouhyjsSkIlUOpDYJUIMCgyBe7Tu/WFuF/3x//ABNtSuEGcFLUNm2Wy6XBzBULP72bYbOrZzZSwzoj1TSFUlwRtaSDX2qZXdG2Laqc/tLANydHTKudnfd1VWnjMIef/BYOd3ao5xss9ByEQYbPdFlqBZUwokTHxzUTjrsN/lJLg7k/FFEUkRaH52oXdnbcosLDnR04UrnMiBg8IbWCngTYgQclIhHo+wozOZEBtEM60ArmM5nNmCZz4c+zKkTm0TRoK8ycvMb+xDcpLGjid6h0xGCmjfxVKycKPo5rNE5mougeGyFIoNYJ44iclZbKxdawAvwjHA+dHh9K4CtCLSdilVJxj0W4FkWNNmA1T2FGWP2IlUHLrB7mJUKqHGYop7ON64n8Y21db2KoLaHZxSKsFU+JyYtMtokoLIKc9GhZiivsrAaaRVgUA/hmATlORF24FCRxnDM1DuAH7UBUVSEzMS6QOBdIeISrDe7yKQd2CIgoUfIZn7BEowUBuZxM0JBwUidPEcZE7IjPWhXAkuNmQoFWKwed6UIbmn6Fh7i9T0jItHKo3ADeXAtZMPZ+txakyoo6RxgXIrtKYVzUmILB3EvuAklvpUELEQgIG4jOBAKLBbGhVrQBpcPy0oINWOUDOJ1J2woUdUZa8yLSdskaxHaiaWWiQZQxwFLIImXKpfBRj8FJV2BKElsJtUhJYWIKDm/cWN+kkM0wu+JfRuRSw7h2Tiu/sdzoKtdzFYg50cpZ+esakYw9n07RUQoHKbxK4XUKw/0UhqMUhgcpDF+lMHydwmg/hdEohdFBCqNXHq3R60Br0RC4i8Bw5Kns/jjUJcX7nbQs2qQxbaOE5z0lfK6GA9jZaQSKm3/++edzdXuuAM4TErDz5PA8aUDOkxR8H+nN8+RwmEJouDlPDuHF6OsIsKDvV0Rd/z2n7yGdhv+e0fdoeK6WYdERI+NEWd2DCHX/9kjEz8BP1MgrU1vUbdRISsnDUg+dG7U2aFHHst3QC9qQVNJJUdjNe4oQT29bLWYrOzugnTH3bt4Wdz+9PUW0Yg8rT9/FyrbTFdUAIzJaIcHLQXvdbKCAX/SpESBg9aX7f0X7b3TWZiI0IE+PEl3UvpQcXw/YPmC9vZkYAeDpkaJF7EsJ8ZoIQffWZipQ79MjQcAqdgRbwPftH+wOX+6O9kcHPTKQG+UBynI3z3cXi8UXkhCYYGQehfXZ2gzWrDcCyYOdGF2ucVXYk2ihgvnEv6N5/z0Z9eNo72JOPiI7IdG4abzDrkXudC4Wz6yfKg5t7DiCb624RQdN7iI82FPOZlpmAXmCidbbmJzBARFhlwif733//V6HlL5xtywjfSG20vcuk77bWpaDPB+swvZOqNNaQp6nsKZ9fUeeQ1mWm9p9B12X5+rPJAjBdNssCwHg9xGHNVzfrr9RVtoOkWtV8Prs3a2XlZX7ZSZV6Ah8AysABqd1IQzekJtqpVZMl99AE61IURSi1sxnr5YdQo4ZeErAV8fBlH8eGJx20J+AWh4ed2dj3UkMTvGG58hq63RJyMhc0Awp2DqbkdMnosdAZG/jO/yViUpSdKFA57gVXTZYh4Q/tI5nToe66phbdL3NCAtx5BrfnE+fHY3hPt97wS+55+ILEE9P7Xcwi50+2kHdZ+dJKYLpkkyw/a3dDM15ctGM8T455p2xsG4wXNwjT9AKTY6FGGNxV9YeLQ3d7QTO6hCHOkqpmlACo7wfMeBecbPSGzqXa+TMb7vL4FG5RzGJdIZC2hhP6ROtOzoEnDgMqBA5sjhGiAMoaBul+EtZvkHsETwfFUI4nQdWIDhgwCbWFxe7R6hohd7JdOlCc5RSybIum6DlpJk1UqwMl3yXXDSSQuFxhe7p3llB3DywAkUINy9wroYcWYgxCdYLsN4WDCBPTzF0MHv4BvwcldG7NT/3vvt0QYz76grimmuSQP0F2Qih3SyFAzimS4kipn4QhcCyDCtH4bIvFdEG5cddS0OOJHVDZJsvpi7U782Dm5jpMdy5gvdvxocB7stsL6La45ixu40/EEP20H60reTjgaV/htoUDCyZ9Z6aMgxordz8SZroit5UpVZHeXKY5PQKG58Nk5SnRuu+0fkiObxNQgSffob4OI3c+2jpGfc2sdkMS0G/Ikr08Esvr0macKCG3n6JVMlhoscfMaM1KkM4OImWRjL04W2E8g+WSRqc9eQw8S+ZSZrgjSgrAk5WnnqrfJIs44L3TdW0tFNZ/tG8nNI8vbfqz5rtXWeGZZrQI+NnzvQDDeW9lXiq32pqdPhOLGxnQn/rJ6uv7DSGZCALoyAXC0tiVVtvn2WiyOqC/H68qaRZNEEIdv47XNEg2qzUIDp8uUz5tQFNFyVhjFgkaSIdlt32DUxg9KefXIaaKMPh4U8d+1HjGPEvoYFe9fmcRPnJWHzUCGPkM6pmWn3y+OHoxXA0fDEc0Qzhtefz6eh772LQZ4w35KViHm323faFNgV+GBk8xJwRnrctpvgwM55uernvvBfama6LnF7iUJgBP6B/dm5Gn7+bq2jwADcv0+Tm4c3cQKZ3Y1oAfFXgxEFdVWgg00ahed6N9z2ZzY0ODpZpsnh4e4s/5Pa+psObP7y7nzifos01+U/g+uL1Mk1mD+P6tybj4z+I7MGrZXu7JplB4TBeDpdjnS8uo95aPgQYLwqCm+giR0NWyF191aoa0jCUqXS5qufHWhco1BpF03vpDzllZBOSORgC3vMZklHdmoo8e2udBuPRY0vZA7gSg5SWbEBT43kygKNJx9bluMFqskGE5Yd/peEZr3dpa1bjz/bCN9HoWTerihJd2kB/RIGBwWFZFZyWNJdFQXjTvT6A5h+bew0lCYF4XcaFH74q3vpYJy8YBvVzeiBYjAN4K1ST1tFPn4Db24YNmDuWS7i9pVNFc0mX7nKZtg20Vq+B71XfYjBDed0b1TRhO7Bp6wz1Js4lmTi+IbygdRGQUyXV9LI2xXI5uMOG7Rk9mm53yBTOjib5f0AxQudIHZsczSMk92ji3TUNz4hZn4W4OVNGGuuCPHp2Dwj7p7ANVA7ZEOTlfdvIt63HlqBUnK+VH2fkdIqUuxggeHBINkKRzbxmYKzEhESb8xENXktd24jeTNjG5M4JQnpxkWra9zY71OFcsO7eB+tEV1F20vHpySNoyb7wrtdE3oX0u/RzwPHpCWU4yknw6AbwwTaUiKQVPRAgXwuupYhJUI35tvDhS1RMEa82e+mog5BbuAt3EcqlXYtR2r6lNPnAdyZuU2DpiHTtKPdWhrwu67CyPToyFg0hT3X9GK58gJICpjU/yzq6laNq5PedNkNRKutM7UO3kNcmJmUGtiDIDK1t6RSpQkCd+VNAZf1wARNhHZoUaiWJ8qamSEkzJd5UaCSqDNeSwKAnHUnuw9qsn+334cfvQuJz3EMUyjFJoJ8Yc6gr5hqWhCYNNZ7c6tY3aNuOynsYTU4X1SZIfwjgV2isVtSszVQo+avnZu05aYwzUUzYwGoe5/nSRZVHnGm2Pn7Rwvr3P/9FqDKnXpY6b7jXPp6xTigh2NlGGTnNCeRYoM92j0+LjZKzaVRsNrhr9MJo+CWQt6Ur2g/eSOs6yYsxb+CuUP6IRM+sgwOb9yRKxGhq0ZWqBq+QJNlOx4aX7Ce+NublCgN2zMReBMrfrmxGthGloP4omVsr6x3d0f4+/elTtCkmCKYn0Y6Ya1IXxeJPSfr4cNb9XnaDrVxrvN7nOc8+ytGvN9n16IQYZ4Pw3TtBMPRrU1CJAPHpbnMGHMfo0FaqQiq8ZBJf5jq7NGgvR/v7l0Oi8TJNDtaR8b0u0c2YdYiYc6OpgqAqUFBGu1mAmAqpgGxP8xtSFY3R5n5n4NMwW0OJyEOXBz0ivLxLhCPFr7Bcl3Kqr1D9vjvtLu/88oTqTckM49VhIj0Q9ye9zXbb/SYtZrWRbpEcnt0mN7uikru+//DsYnmRJkRYTRHhSlvGWLhZcpjsrQaILZprDvWd3Xr2bTjSCpXTQ+kd91NUcu96mCzT1RFrndWN0NaJqVTT3XtHXbQ7fU+n4Qne228bW6vk35GCa4GcXag0kcQFMxRkuxIB6ZB/bKPj38ajihHsdUHp9khWw8yrl8GawHGMG/dCwesjwcOXnRjsWQyncoS0CZCui3k2W49RzCaI2YlLdsKSZy3LNhHAGAAccuRsdHDAIaavhxyLefGawxwHr5bMZK3LnyR9t56fMVad0yTpO11xUONShFGtXeyf5XoGXmjqGzztzD0Do3exb7jXowUl1UQzM4UTPq5QvScDlUT2eng37IRFpsumuCCC//uf/+IRkTN4mT/BcW2g0nM0k9pXKEwKvJFkEnYK5WJQA0VZoLXFAsgSnHLJXC6nnG0U7axMVGIsC0k6iMC0D/J31JgdwE9tWOSZ8YlX11iQ6oJCa64gI/OkdrrkNeJ9O9fmakIopSBgTEVHaMmhwTgE1UyojMwqL5tssFDFHFmulZEWQciSgMmCxslEZpIvcq2cEZmDUigxZcsj5fAXUaGKJUNGj8kBsbqovYlNhUuIzm+R3x0H8I5cGt44P26gE7LA3FvXNvXeTZCNUJE3Jk+youVlhrZN1yzwGg3rIu+b1kUBlXbeXyTTq3u2NJEzQlm61MPDSjiahnzBBuY1crEYAD0+0l1Hrg8xQCHVla+fO2vY7CccW+mwDf3N5/M7evF5f8xfpZvVYzBY6XbclBtZi3aHNx/PSemgKe3x5D2aa5lFM2TDmnsMvBeuS+GjTFEJiUr+ZXUAXV2FzFBZ7Fxub/568h1cw4vBfpJ2boJHILz33dHbb394/y3NS3eVl7/hYH+wz+8V2rpSqM5S/VLUVcntvIJuC1e3havbwtVt4eq2cPUPU1q5LVzdFq5uC1e3havbwtVt4eq2cPUJkGJbuLotXN0Wrm4LV7eFq9vC1W3h6rZwdVu4ui1c3RaubgtXn0ad4LZwdVu4+qQYclu4GgtXQ+YJ2Y17VSGk6mTQ+Wyls5Vy1os0mVE20+FZcntL74ofKE2dmn+p0VAq1EWaXAsjKXjOiVBpzPihVJcrpJyTt/4tYPeUlk892/ND9kr+FyUs+RFv+PDvhe0mXJ0cvz9N0iTWFZQ6pzFGzKkcV8yTw4R0NlfuNqml3H6bFEJNa86+Sfy8lKgkajfrZzldcZZT+NFJ4hFq0cGyn/7kt0L/08bWDvgvevr+Oy7+uwH3PRsHBNpGaDrBi+Vy+X9W+805",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/draftdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftdocument",permalink:"/docs/API-docs/draftdocument",draft:!1,unlisted:!1,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 base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO39zGzeuXwW3/6TxrGVLcdKc582bS5O+O79ra0/jTOfG9rjULiQx3iW3JNey6tF/90nuo90neQOQ3B+yZDtJp+fOU/6ItSRIgiAAAiBwmzgxtcnhWfJOZ3WJytnkIk1ytJmRlZNaJYfJ6QzhnRETBxEI3pwcgSgKPbdQWzQWnIYpKjTCISicQx6ng/ECKqOvZS7VFHLhBMylm8FYWHx1AKgynWMOE1ng4Fydq1NZHcKHqtAih4WuDZy8+59mNlqG2s52dt7huJ7Ch6OdnYuvZs5V9nBvT1TVQFeorJyqQoztINPlXk6AVT55nsJ8hgZpVsiEAhRWFgsQeQ5zmU/R2RTcDBVkulpAprXJpRIObQqVmCKouhyjsSkIlUOpDYJUIMCgyBe7Tu/WFuF/3x//ABNtSuEGcFLUNm2Wy6XBzBULP72bYbOrZzZSwzoj1TSFUlwRtaSDX2qZXdG2Laqc/tLANydHTKudnfd1VWnjMIef/BYOd3ao5xss9ByEQYbPdFlqBZUwokTHxzUTjrsN/lJLg7k/FFEUkRaH52oXdnbcosLDnR04UrnMiBg8IbWCngTYgQclIhHo+wozOZEBtEM60ArmM5nNmCZz4c+zKkTm0TRoK8ycvMb+xDcpLGjid6h0xGCmjfxVKycKPo5rNE5mougeGyFIoNYJ44iclZbKxdawAvwjHA+dHh9K4CtCLSdilVJxj0W4FkWNNmA1T2FGWP2IlUHLrB7mJUKqHGYop7ON64n8Y21db2KoLaHZxSKsFU+JyYtMtokoLIKc9GhZiivsrAaaRVgUA/hmATlORF24FCRxnDM1DuAH7UBUVSEzMS6QOBdIeISrDe7yKQd2CIgoUfIZn7BEowUBuZxM0JBwUidPEcZE7IjPWhXAkuNmQoFWKwed6UIbmn6Fh7i9T0jItHKo3ADeXAtZMPZ+txakyoo6RxgXIrtKYVzUmILB3EvuAklvpUELEQgIG4jOBAKLBbGhVrQBpcPy0oINWOUDOJ1J2woUdUZa8yLSdskaxHaiaWWiQZQxwFLIImXKpfBRj8FJV2BKElsJtUhJYWIKDm/cWN+kkM0wu+JfRuRSw7h2Tiu/sdzoKtdzFYg50cpZ+esakYw9n07RUQoHKbxK4XUKw/0UhqMUhgcpDF+lMHydwmg/hdEohdFBCqNXHq3R60Br0RC4i8Bw5Kns/jjUJcX7nbQs2qQxbaOE5z0lfK6GA9jZaQSKm3/++edzdXuuAM4TErDz5PA8aUDOkxR8H+nN8+RwmEJouDlPDuHF6OsIsKDvV0Rd/z2n7yGdhv+e0fdoeK6WYdERI+NEWd2DCHX/9kjEz8BP1MgrU1vUbdRISsnDUg+dG7U2aFHHst3QC9qQVNJJUdjNe4oQT29bLWYrOzugnTH3bt4Wdz+9PUW0Yg8rT9/FyrbTFdUAIzJaIcHLQXvdbKCAX/SpESBg9aX7f0X7b3TWZiI0IE+PEl3UvpQcXw/YPmC9vZkYAeDpkaJF7EsJ8ZoIQffWZipQ79MjQcAqdgRbwPftH+wOX+6O9kcHPTKQG+UBynI3z3cXi8UXkhCYYGQehfXZ2gzWrDcCyYOdGF2ucVXYk2ihgvnEv6N5/z0Z9eNo72JOPiI7IdG4abzDrkXudC4Wz6yfKg5t7DiCb624RQdN7iI82FPOZlpmAXmCidbbmJzBARFhlwif733//V6HlL5xtywjfSG20vcuk77bWpaDPB+swvZOqNNaQp6nsKZ9fUeeQ1mWm9p9B12X5+rPJAjBdNssCwHg9xGHNVzfrr9RVtoOkWtV8Prs3a2XlZX7ZSZV6Ah8AysABqd1IQzekJtqpVZMl99AE61IURSi1sxnr5YdQo4ZeErAV8fBlH8eGJx20J+AWh4ed2dj3UkMTvGG58hq63RJyMhc0Awp2DqbkdMnosdAZG/jO/yViUpSdKFA57gVXTZYh4Q/tI5nToe66phbdL3NCAtx5BrfnE+fHY3hPt97wS+55+ILEE9P7Xcwi50+2kHdZ+dJKYLpkkyw/a3dDM15ctGM8T455p2xsG4wXNwjT9AKTY6FGGNxV9YeLQ3d7QTO6hCHOkqpmlACo7wfMeBecbPSGzqXa+TMb7vL4FG5RzGJdIZC2hhP6ROtOzoEnDgMqBA5sjhGiAMoaBul+EtZvkHsETwfFUI4nQdWIDhgwCbWFxe7R6hohd7JdOlCc5RSybIum6DlpJk1UqwMl3yXXDSSQuFxhe7p3llB3DywAkUINy9wroYcWYgxCdYLsN4WDCBPTzF0MHv4BvwcldG7NT/3vvt0QYz76grimmuSQP0F2Qih3SyFAzimS4kipn4QhcCyDCtH4bIvFdEG5cddS0OOJHVDZJsvpi7U782Dm5jpMdy5gvdvxocB7stsL6La45ixu40/EEP20H60reTjgaV/htoUDCyZ9Z6aMgxordz8SZroit5UpVZHeXKY5PQKG58Nk5SnRuu+0fkiObxNQgSffob4OI3c+2jpGfc2sdkMS0G/Ikr08Esvr0macKCG3n6JVMlhoscfMaM1KkM4OImWRjL04W2E8g+WSRqc9eQw8S+ZSZrgjSgrAk5WnnqrfJIs44L3TdW0tFNZ/tG8nNI8vbfqz5rtXWeGZZrQI+NnzvQDDeW9lXiq32pqdPhOLGxnQn/rJ6uv7DSGZCALoyAXC0tiVVtvn2WiyOqC/H68qaRZNEEIdv47XNEg2qzUIDp8uUz5tQFNFyVhjFgkaSIdlt32DUxg9KefXIaaKMPh4U8d+1HjGPEvoYFe9fmcRPnJWHzUCGPkM6pmWn3y+OHoxXA0fDEc0Qzhtefz6eh772LQZ4w35KViHm323faFNgV+GBk8xJwRnrctpvgwM55uernvvBfama6LnF7iUJgBP6B/dm5Gn7+bq2jwADcv0+Tm4c3cQKZ3Y1oAfFXgxEFdVWgg00ahed6N9z2ZzY0ODpZpsnh4e4s/5Pa+psObP7y7nzifos01+U/g+uL1Mk1mD+P6tybj4z+I7MGrZXu7JplB4TBeDpdjnS8uo95aPgQYLwqCm+giR0NWyF191aoa0jCUqXS5qufHWhco1BpF03vpDzllZBOSORgC3vMZklHdmoo8e2udBuPRY0vZA7gSg5SWbEBT43kygKNJx9bluMFqskGE5Yd/peEZr3dpa1bjz/bCN9HoWTerihJd2kB/RIGBwWFZFZyWNJdFQXjTvT6A5h+bew0lCYF4XcaFH74q3vpYJy8YBvVzeiBYjAN4K1ST1tFPn4Db24YNmDuWS7i9pVNFc0mX7nKZtg20Vq+B71XfYjBDed0b1TRhO7Bp6wz1Js4lmTi+IbygdRGQUyXV9LI2xXI5uMOG7Rk9mm53yBTOjib5f0AxQudIHZsczSMk92ji3TUNz4hZn4W4OVNGGuuCPHp2Dwj7p7ANVA7ZEOTlfdvIt63HlqBUnK+VH2fkdIqUuxggeHBINkKRzbxmYKzEhESb8xENXktd24jeTNjG5M4JQnpxkWra9zY71OFcsO7eB+tEV1F20vHpySNoyb7wrtdE3oX0u/RzwPHpCWU4yknw6AbwwTaUiKQVPRAgXwuupYhJUI35tvDhS1RMEa82e+mog5BbuAt3EcqlXYtR2r6lNPnAdyZuU2DpiHTtKPdWhrwu67CyPToyFg0hT3X9GK58gJICpjU/yzq6laNq5PedNkNRKutM7UO3kNcmJmUGtiDIDK1t6RSpQkCd+VNAZf1wARNhHZoUaiWJ8qamSEkzJd5UaCSqDNeSwKAnHUnuw9qsn+334cfvQuJz3EMUyjFJoJ8Yc6gr5hqWhCYNNZ7c6tY3aNuOynsYTU4X1SZIfwjgV2isVtSszVQo+avnZu05aYwzUUzYwGoe5/nSRZVHnGm2Pn7Rwvr3P/9FqDKnXpY6b7jXPp6xTigh2NlGGTnNCeRYoM92j0+LjZKzaVRsNrhr9MJo+CWQt6Ur2g/eSOs6yYsxb+CuUP6IRM+sgwOb9yRKxGhq0ZWqBq+QJNlOx4aX7Ce+NublCgN2zMReBMrfrmxGthGloP4omVsr6x3d0f4+/elTtCkmCKYn0Y6Ya1IXxeJPSfr4cNb9XnaDrVxrvN7nOc8+ytGvN9n16IQYZ4Pw3TtBMPRrU1CJAPHpbnMGHMfo0FaqQiq8ZBJf5jq7NGgvR/v7l0Oi8TJNDtaR8b0u0c2YdYiYc6OpgqAqUFBGu1mAmAqpgGxP8xtSFY3R5n5n4NMwW0OJyEOXBz0ivLxLhCPFr7Bcl3Kqr1D9vjvtLu/88oTqTckM49VhIj0Q9ye9zXbb/SYtZrWRbpEcnt0mN7uikru+//DsYnmRJkRYTRHhSlvGWLhZcpjsrQaILZprDvWd3Xr2bTjSCpXTQ+kd91NUcu96mCzT1RFrndWN0NaJqVTT3XtHXbQ7fU+n4Qne228bW6vk35GCa4GcXag0kcQFMxRkuxIB6ZB/bKPj38ajihHsdUHp9khWw8yrl8GawHGMG/dCwesjwcOXnRjsWQyncoS0CZCui3k2W49RzCaI2YlLdsKSZy3LNhHAGAAccuRsdHDAIaavhxyLefGawxwHr5bMZK3LnyR9t56fMVad0yTpO11xUONShFGtXeyf5XoGXmjqGzztzD0Do3exb7jXowUl1UQzM4UTPq5QvScDlUT2eng37IRFpsumuCCC//uf/+IRkTN4mT/BcW2g0nM0k9pXKEwKvJFkEnYK5WJQA0VZoLXFAsgSnHLJXC6nnG0U7axMVGIsC0k6iMC0D/J31JgdwE9tWOSZ8YlX11iQ6oJCa64gI/OkdrrkNeJ9O9fmakIopSBgTEVHaMmhwTgE1UyojMwqL5tssFDFHFmulZEWQciSgMmCxslEZpIvcq2cEZmDUigxZcsj5fAXUaGKJUNGj8kBsbqovYlNhUuIzm+R3x0H8I5cGt44P26gE7LA3FvXNvXeTZCNUJE3Jk+youVlhrZN1yzwGg3rIu+b1kUBlXbeXyTTq3u2NJEzQlm61MPDSjiahnzBBuY1crEYAD0+0l1Hrg8xQCHVla+fO2vY7CccW+mwDf3N5/M7evF5f8xfpZvVYzBY6XbclBtZi3aHNx/PSemgKe3x5D2aa5lFM2TDmnsMvBeuS+GjTFEJiUr+ZXUAXV2FzFBZ7Fxub/568h1cw4vBfpJ2boJHILz33dHbb394/y3NS3eVl7/hYH+wz+8V2rpSqM5S/VLUVcntvIJuC1e3havbwtVt4eq2cPUPU1q5LVzdFq5uC1e3havbwtVt4eq2cPUJkGJbuLotXN0Wrm4LV7eFq9vC1W3h6rZwdVu4ui1c3RaubgtXn0ad4LZwdVu4+qQYclu4GgtXQ+YJ2Y17VSGk6mTQ+Wyls5Vy1os0mVE20+FZcntL74ofKE2dmn+p0VAq1EWaXAsjKXjOiVBpzPihVJcrpJyTt/4tYPeUlk892/ND9kr+FyUs+RFv+PDvhe0mXJ0cvz9N0iTWFZQ6pzFGzKkcV8yTw4R0NlfuNqml3H6bFEJNa86+Sfy8lKgkajfrZzldcZZT+NFJ4hFq0cGyn/7kt0L/08bWDvgvevr+Oy7+uwH3PRsHBNpGaDrBi+Vy+X9W+805",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"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "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 "readonly": false,\n "required": true, \n "name": "radio button",\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)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"document_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-send-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "document_id": "hji2zxcv2P",\n "url": "https://url-to-send-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.84114f8b.js b/assets/js/ae010e44.84114f8b.js new file mode 100644 index 000000000..cd1e8aef5 --- /dev/null +++ b/assets/js/ae010e44.84114f8b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4930],{80204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),p=s(9472),m=s(85162);const h={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:"eJztW1uPGzeW/itn+OK4UVK35LbjFRaDcezsjGeS2Eh3EAxajQ5VdaSim0VWSFZLSkPAPMzP2H3Zn5Zfsji8VJXUN3sczPRg5Qdbxes5Hw8Pz83XzPGFZZMz9kbnTYXKWXaesQJtbkTthFZswk5LBItybsVCwav3b2GBCg13aIHDD99/A67kDlDxmUQLc4No3Voi0HihFqDnwKGI6w/hr7qBnCvg0moQKpdNgaD9ZlxCbXBQ4FwoLGApigU6m8GyFHkJrgxrovHzsRAOtAFc1VwV0NRaAbegEAsshnBaCgu10Vei8IQmanBVoxGoclqsEpIbcNqv/evf/vuEWPyrbgzx++vf/gfmUi9BKN//rkblB/C6Hk7VVJ2KegI/1FLzAta6MfD+zX+1jNKq1HZ2cPAGZ80Cfnh7cHD+RelcbSeHh7SGrlERWZLP7DDX1WFBA+ti/pRYRoO0auCVWyHXwIseKK5EBbmu15BrbQqh6EQyqPkCQTXVDI3NgJCptEHigYNBXqwHTg8ai/Dnk3ffwVybirshvJeNzdrtCmEwd3IdlifeE1dPLMy4xRfHYJ0RapFBxS8JVuHg50bkl8S2RVUkUF+9f+uxOjg4aepaG4cF/BhYmBwcUM9XSBhzg358rqtKK6i54RU6NDZIF3Ub/LkRxsuFK4FLmbCYTNUADg7cusbJwQG8VYXIvXjSgtRKIhjGDsNQAomGntSYi7mIQ3vQgVZR6giTJQ/nWUueBzIN2hpzJ65we+FVBmta+A0qnSgotRG/aOW49MdxhcaJnMv+sRGBXrwdN47grLVQLrXGHdqbQ6fnDyXKFZFWEFiVUL7HIlxx2aCNVC0zKImq77E2aOmWp3UJSFVAiWJR3rkfLz401m0tDI0lMvtUxL3SKXl40cM259IiiPkWlhW/xN5urQYYwldrKHDOG+kyECRxzjQ4hO+0o5snRU6KhiTX32nuGoMDf8pRHCIhilf+jN93OqAQ8zkaupzU6ZeIcxJ1JGdBaRB7/ua4kivQauegcy21oeV3ZMi3bwMJuVbOq75XV1xIT33g1rb6byZ5fpnBTDaYgcEi3Nw1SqmXWRB4P4Q0XADdA0R6mcRQK2JA6bi9sGAjVa0mTBeKOlttS5sI24c1Xtu5pp0Jg3THACsuZOaRy+CDnoETTmJGN7bmap1BwR1m4HDlZnqVQV5ifjnTqwjYXCtnxS+3XLvU8+mojTM4zuBFBi8zGB1lMBpnMDrOYPQig9HLDMZHGYzHGYyPMxi/CJiOX0Y8eQtin4DROCDpHheCpEC/EdZfUdJ8tlWmyy1lOlWjIRwctBfDN//0009TdT1VAFNGF2XKJlPWDpmyDEIf6b8pm4wyiA2rKZvAs/GXacCavl8QguF7Sd8jQjx8l/Q9Hk3VJm469sQ4XtX3EELdvz0R6TPKDDX6nakt6ShqJOUSxlIPnQ21tmRRx6Zj6BkxJJRwgkt7N09pxONjq6Nsh7Nj4sxL6N1s+e7Hx1MiK/V4JRi6vNLsdaWr7gkZ70DwfNg9G3cgEDZ9bABEqj6X/xfEf6uX7gahHfL4kOiT9rlwfDn077zXzXeDEQc8Pig6wj4XiJcEBL1Nd6NAvY8PgkhV6ojvfeg7Oh6Mng/GR+PjLRjIHQoDqmpQFIP1ev2ZEIIHjEyguL+3GqNVGow57hDmRle3uBzeI+hGRRPJ/05m+rdknM+S3YpF8ldbA6b18vqWtdMFXz+xYak0tbXVaHxnqa17ZPouosN7vHmpRR6JpzHJQpuRUzckEAYEfHH47beHPShD46CqEr6QWul74KHvt1bVsCiGu2O3TqjXWkFRZHBL++0dRQFVVd3VHjrouZyq/6CLEM2zu+9CHPDPvQ6d0HfbP3xVKCCglfT7ey/t9ruy876UQsWOKDewM8DgopHc4IrcTSu08rj8Bppo5xalS9SZ8t479Y6d9/0DFPDFu2iuP40CThxsL0AtD8+7wVh/EYMLXPk18sY6XRExouC0Qga2yUty3njyCgj2Lk7jv3JeC4oSSHTOt6LLh7cREQ6t52HTqe462BbdFjPcQpp5i4/tT987GqMj/+5F3+Oehy+OeHxqv0dZ6gxRC+o+m7KKR9OFzbH7rV2JZsrO2znBt8aiNxdumwzn2d33CbpLU6DkM5Q379rn3IZAXF8MkwpOwpzQAClsil5ss9afHcM7PuhGoVSSpBlCmgCzVnA+WzBbwj5OMsO9jSA+sAWNAz+wDa21zvS9su+9Z1GF8OBdzl3l5fyxSX0ka0dGWMZ0TdF6odXbgk1YiuSzzK+K1n2lizWbXLMYcKGfMZxBkw4/WMoCXDObl1hx+pWoobzBXEhkGQtxecsy5q1vSiIQXmzC9OwD5o5l9FbUFPpES2v4eZPrNCpEk1kWLTA2YSHMzDKGK17VNDg2Aapck5lTF3O2SRvet1Tb0i1l/Y82rE3rUMD2H1zmO5rqSanwVL/W1OjwDV/b3oJB17Pd7ArNIZHN4ywo+NpSSKmx4fblXOaNJNsLV7Uw69YQ9AZYy0GP0HanltDR8006ox5FdxyN0Z+OZ46aAPCe+KfO/aBxhviH2ECJEH8cvPpkKj5ohBn6o6hLrT55/mj8bDQePRuNaYUYWOutwY3ha5Yx4bCyD+MYem9SsH3+r8ggwCIp3kEX1M7Ax6CGD8lgGu/Z5gt8WOZO70p29MKvttSNLCiwidwMfc7hH05nbYsxbeK5HT4gtJuMrR5mZgW5HqRMCnwhce6gqWvKEmqj0Dztu1aPhrnx8fEmY+uH2Vv/W7L3JR3e8mHufvQpqC4996+g9dnLTcbKh2n9U5sk+xcSe/xi0715LDfIHaY34GKmi/VF0lub/sD06m8PjS/ChnaUBRoyEG7qq07V0EhK7l7s6vmZ1hK5ukXRbCVOvPNjvaVGdmCMLSxLJNO7M+D86ra1PKPVGCwMSsbgjrsnLJlnpsEpG8LbeYdlsP12czdprM/dKA1P/H4XtvFq/Mlh/CaEnvQT0ZQb7GIqiQQ/GBxWtfSZ3KWQkuim53sI7R9vibVIEgHpuUwbP/xUvA5upd8wTtpOg0K06Ibwmqs2S7adjYLr61YIvHRsNnB9TaeK5oIe3c0m6xpor60G/66GFoM5iqutWW0TdhPbtt7UYMlckCUTGmKwsk9AqNe4aIzcbIY3xLA7o4/G7QZM8exokf8PiPkCnVPdmI+4uN6pGoTLExySINhhEeCwaHyo0ZH6SzLoYxZd9lwo60yTB2+0aEwqGEiVOLXROVo7jPUBAyiEDRnUEvvrZ4DKhukc5tw6NBk0SiiHxjQ1eaU3i3u2+PcbbMjhCZUtBNHDYrOdpaZCp1CU06tDSpc9LYyxDika822JRKoJ2mV955AeUthBp3fuV1QjVIyilQ1W5/joiP7ZZiVVd0F8MCgcRQTMGynXv2PZx/t+95u8ofn2Z+Q+G7b8IMa/rPKr8XuS1DtO594F4pPbGEn1TYTcoC058x5FD1uhpFB4kWC7GB8dXYwI203Gjm+D70RX6EqfyycQl0ZT5VMtkVMljlkDX3ChgB4A8xuiicZoc/+L/GmU3QfC8RYIz2+C8Fb5eKavADzVl6j+uZz2t3dheyJ1VXlZCd4iE2GQ72dbzPbbA5MW88YIt2aTs2u2GvBaDEL/5Ox8c54xAlZTxKTW1lPMXckm7LAXQLForijqQSt4oW3l0HJVULDphvnHa3F4NWKbbHfGrcbinaOt4wuhFoN7Z513TJ7QQQSst1jtfNta/AXJuY1I9kdlTJAAlMgLshY3GaPz/b6LHn2dTinFdW4L1fR0207wJcVetsIpt0dTRs/7cYwQqfDBhzb2cFs4oeUqBQja+EDP5e95/GedILbOdfKtR94pHR8fe+/ty5F3c5699B7E8YvN+ZYxzdi2wexjd7tmH2Pb5oz/7j3WIVi883j5J12oufZnGIFtK1TpklyNbnpbKHNdtSVKafivf/9fPyMdiL/Dv4N3jYFaL9HMm1DnNJe4EvRA0+AdWx55JdFauQZ6lxdUHgyFWPh8Rnr1cl7zmZCCbj0N0yGE1VMcdgg/dt7AExNSO1coSVmA1NrXmjoNvHG68nukl22pzSVV61LRK8yoPBGtBYuYpqAqua/6jVcio+Jhqq0lO6I2wiJwUdFgsmdwPhe58E+mVs7w3EHFFV8gbZZ5r49QaAuMjZ5RGtZq2QSDh0ocEV1gkSLpdghvqF7UM+5Dd+i4kFgEW8dSHVhBQT4vt7F2d0Zmak3bixxtlxCWeIXGq4BgrDZSQq1JFQsuye3pny0t5AxXll7QGDaMR9PCFy0Sv0fB10OgcDi9LuTIkABIoS5Dpe1ZK2Y/4swKh53Hu1wub6ijp9tz/ihc2czAYK27eQvf6JVXf3r78ZTUAZrKvpufoLkSeXrz79jz0A8+jA8UD85VUhC8Fn/YnUC3SYoclcXec/Lqj++/gSt4NjxiWU8BfwTBh9+8ff31dydf07r0RIT7NxoeDY98mE5bV3HV2+oE5RxOwrOydWl7cfl9Jf6+En9fib+vxN9X4u8r8feV+PtK/H0l/r4S/3HxtK/E31fi7yvx95X4+0r8fSX+vhJ/X4m/r8TfV+LvK/H3lfj7Snxf/xWTiqQHDmvJhepVO4T08llXn3+esZIyz5Mzdn1Nod4fqK6Hmn9u0FDa+jxjV9wIinX4pHWWUrSUwLxESiW+DqGbwSntnIXL51MgO7l6yjCHGa/yHGt379h+cvz9u5NTlrFUiFXpguYYvqT/X8CXbMLoufH/C8GD6dO23FeGSq4Wjc+psrAuZZZ548rttPSlT0vHH73ULFfrHpXb+erACv1NjN064T8pf/IXXP++HR567pwQsU2j6fDON5vN/wFupzFe",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW1uPGzeW/itn+OK4UVK35LbjFRaDcezsjGeS2Eh3EAxajQ5VdaSim0VWSFZLSkPAPMzP2H3Zn5Zfsji8VJXUN3sczPRg5Qdbxes5Hw8Pz83XzPGFZZMz9kbnTYXKWXaesQJtbkTthFZswk5LBItybsVCwav3b2GBCg13aIHDD99/A67kDlDxmUQLc4No3Voi0HihFqDnwKGI6w/hr7qBnCvg0moQKpdNgaD9ZlxCbXBQ4FwoLGApigU6m8GyFHkJrgxrovHzsRAOtAFc1VwV0NRaAbegEAsshnBaCgu10Vei8IQmanBVoxGoclqsEpIbcNqv/evf/vuEWPyrbgzx++vf/gfmUi9BKN//rkblB/C6Hk7VVJ2KegI/1FLzAta6MfD+zX+1jNKq1HZ2cPAGZ80Cfnh7cHD+RelcbSeHh7SGrlERWZLP7DDX1WFBA+ti/pRYRoO0auCVWyHXwIseKK5EBbmu15BrbQqh6EQyqPkCQTXVDI3NgJCptEHigYNBXqwHTg8ai/Dnk3ffwVybirshvJeNzdrtCmEwd3IdlifeE1dPLMy4xRfHYJ0RapFBxS8JVuHg50bkl8S2RVUkUF+9f+uxOjg4aepaG4cF/BhYmBwcUM9XSBhzg358rqtKK6i54RU6NDZIF3Ub/LkRxsuFK4FLmbCYTNUADg7cusbJwQG8VYXIvXjSgtRKIhjGDsNQAomGntSYi7mIQ3vQgVZR6giTJQ/nWUueBzIN2hpzJ65we+FVBmta+A0qnSgotRG/aOW49MdxhcaJnMv+sRGBXrwdN47grLVQLrXGHdqbQ6fnDyXKFZFWEFiVUL7HIlxx2aCNVC0zKImq77E2aOmWp3UJSFVAiWJR3rkfLz401m0tDI0lMvtUxL3SKXl40cM259IiiPkWlhW/xN5urQYYwldrKHDOG+kyECRxzjQ4hO+0o5snRU6KhiTX32nuGoMDf8pRHCIhilf+jN93OqAQ8zkaupzU6ZeIcxJ1JGdBaRB7/ua4kivQauegcy21oeV3ZMi3bwMJuVbOq75XV1xIT33g1rb6byZ5fpnBTDaYgcEi3Nw1SqmXWRB4P4Q0XADdA0R6mcRQK2JA6bi9sGAjVa0mTBeKOlttS5sI24c1Xtu5pp0Jg3THACsuZOaRy+CDnoETTmJGN7bmap1BwR1m4HDlZnqVQV5ifjnTqwjYXCtnxS+3XLvU8+mojTM4zuBFBi8zGB1lMBpnMDrOYPQig9HLDMZHGYzHGYyPMxi/CJiOX0Y8eQtin4DROCDpHheCpEC/EdZfUdJ8tlWmyy1lOlWjIRwctBfDN//0009TdT1VAFNGF2XKJlPWDpmyDEIf6b8pm4wyiA2rKZvAs/GXacCavl8QguF7Sd8jQjx8l/Q9Hk3VJm469sQ4XtX3EELdvz0R6TPKDDX6nakt6ShqJOUSxlIPnQ21tmRRx6Zj6BkxJJRwgkt7N09pxONjq6Nsh7Nj4sxL6N1s+e7Hx1MiK/V4JRi6vNLsdaWr7gkZ70DwfNg9G3cgEDZ9bABEqj6X/xfEf6uX7gahHfL4kOiT9rlwfDn077zXzXeDEQc8Pig6wj4XiJcEBL1Nd6NAvY8PgkhV6ojvfeg7Oh6Mng/GR+PjLRjIHQoDqmpQFIP1ev2ZEIIHjEyguL+3GqNVGow57hDmRle3uBzeI+hGRRPJ/05m+rdknM+S3YpF8ldbA6b18vqWtdMFXz+xYak0tbXVaHxnqa17ZPouosN7vHmpRR6JpzHJQpuRUzckEAYEfHH47beHPShD46CqEr6QWul74KHvt1bVsCiGu2O3TqjXWkFRZHBL++0dRQFVVd3VHjrouZyq/6CLEM2zu+9CHPDPvQ6d0HfbP3xVKCCglfT7ey/t9ruy876UQsWOKDewM8DgopHc4IrcTSu08rj8Bppo5xalS9SZ8t479Y6d9/0DFPDFu2iuP40CThxsL0AtD8+7wVh/EYMLXPk18sY6XRExouC0Qga2yUty3njyCgj2Lk7jv3JeC4oSSHTOt6LLh7cREQ6t52HTqe462BbdFjPcQpp5i4/tT987GqMj/+5F3+Oehy+OeHxqv0dZ6gxRC+o+m7KKR9OFzbH7rV2JZsrO2znBt8aiNxdumwzn2d33CbpLU6DkM5Q379rn3IZAXF8MkwpOwpzQAClsil5ss9afHcM7PuhGoVSSpBlCmgCzVnA+WzBbwj5OMsO9jSA+sAWNAz+wDa21zvS9su+9Z1GF8OBdzl3l5fyxSX0ka0dGWMZ0TdF6odXbgk1YiuSzzK+K1n2lizWbXLMYcKGfMZxBkw4/WMoCXDObl1hx+pWoobzBXEhkGQtxecsy5q1vSiIQXmzC9OwD5o5l9FbUFPpES2v4eZPrNCpEk1kWLTA2YSHMzDKGK17VNDg2Aapck5lTF3O2SRvet1Tb0i1l/Y82rE3rUMD2H1zmO5rqSanwVL/W1OjwDV/b3oJB17Pd7ArNIZHN4ywo+NpSSKmx4fblXOaNJNsLV7Uw69YQ9AZYy0GP0HanltDR8006ox5FdxyN0Z+OZ46aAPCe+KfO/aBxhviH2ECJEH8cvPpkKj5ohBn6o6hLrT55/mj8bDQePRuNaYUYWOutwY3ha5Yx4bCyD+MYem9SsH3+r8ggwCIp3kEX1M7Ax6CGD8lgGu/Z5gt8WOZO70p29MKvttSNLCiwidwMfc7hH05nbYsxbeK5HT4gtJuMrR5mZgW5HqRMCnwhce6gqWvKEmqj0Dztu1aPhrnx8fEmY+uH2Vv/W7L3JR3e8mHufvQpqC4996+g9dnLTcbKh2n9U5sk+xcSe/xi0715LDfIHaY34GKmi/VF0lub/sD06m8PjS/ChnaUBRoyEG7qq07V0EhK7l7s6vmZ1hK5ukXRbCVOvPNjvaVGdmCMLSxLJNO7M+D86ra1PKPVGCwMSsbgjrsnLJlnpsEpG8LbeYdlsP12czdprM/dKA1P/H4XtvFq/Mlh/CaEnvQT0ZQb7GIqiQQ/GBxWtfSZ3KWQkuim53sI7R9vibVIEgHpuUwbP/xUvA5upd8wTtpOg0K06Ibwmqs2S7adjYLr61YIvHRsNnB9TaeK5oIe3c0m6xpor60G/66GFoM5iqutWW0TdhPbtt7UYMlckCUTGmKwsk9AqNe4aIzcbIY3xLA7o4/G7QZM8exokf8PiPkCnVPdmI+4uN6pGoTLExySINhhEeCwaHyo0ZH6SzLoYxZd9lwo60yTB2+0aEwqGEiVOLXROVo7jPUBAyiEDRnUEvvrZ4DKhukc5tw6NBk0SiiHxjQ1eaU3i3u2+PcbbMjhCZUtBNHDYrOdpaZCp1CU06tDSpc9LYyxDika822JRKoJ2mV955AeUthBp3fuV1QjVIyilQ1W5/joiP7ZZiVVd0F8MCgcRQTMGynXv2PZx/t+95u8ofn2Z+Q+G7b8IMa/rPKr8XuS1DtO594F4pPbGEn1TYTcoC058x5FD1uhpFB4kWC7GB8dXYwI203Gjm+D70RX6EqfyycQl0ZT5VMtkVMljlkDX3ChgB4A8xuiicZoc/+L/GmU3QfC8RYIz2+C8Fb5eKavADzVl6j+uZz2t3dheyJ1VXlZCd4iE2GQ72dbzPbbA5MW88YIt2aTs2u2GvBaDEL/5Ox8c54xAlZTxKTW1lPMXckm7LAXQLForijqQSt4oW3l0HJVULDphvnHa3F4NWKbbHfGrcbinaOt4wuhFoN7Z513TJ7QQQSst1jtfNta/AXJuY1I9kdlTJAAlMgLshY3GaPz/b6LHn2dTinFdW4L1fR0207wJcVetsIpt0dTRs/7cYwQqfDBhzb2cFs4oeUqBQja+EDP5e95/GedILbOdfKtR94pHR8fe+/ty5F3c5699B7E8YvN+ZYxzdi2wexjd7tmH2Pb5oz/7j3WIVi883j5J12oufZnGIFtK1TpklyNbnpbKHNdtSVKafivf/9fPyMdiL/Dv4N3jYFaL9HMm1DnNJe4EvRA0+AdWx55JdFauQZ6lxdUHgyFWPh8Rnr1cl7zmZCCbj0N0yGE1VMcdgg/dt7AExNSO1coSVmA1NrXmjoNvHG68nukl22pzSVV61LRK8yoPBGtBYuYpqAqua/6jVcio+Jhqq0lO6I2wiJwUdFgsmdwPhe58E+mVs7w3EHFFV8gbZZ5r49QaAuMjZ5RGtZq2QSDh0ocEV1gkSLpdghvqF7UM+5Dd+i4kFgEW8dSHVhBQT4vt7F2d0Zmak3bixxtlxCWeIXGq4BgrDZSQq1JFQsuye3pny0t5AxXll7QGDaMR9PCFy0Sv0fB10OgcDi9LuTIkABIoS5Dpe1ZK2Y/4swKh53Hu1wub6ijp9tz/ihc2czAYK27eQvf6JVXf3r78ZTUAZrKvpufoLkSeXrz79jz0A8+jA8UD85VUhC8Fn/YnUC3SYoclcXec/Lqj++/gSt4NjxiWU8BfwTBh9+8ff31dydf07r0RIT7NxoeDY98mE5bV3HV2+oE5RxOwrOydWl7cfl9Jf6+En9fib+vxN9X4u8r8feV+PtK/H0l/r4S/3HxtK/E31fi7yvx95X4+0r8fSX+vhJ/X4m/r8TfV+LvK/H3lfj7Snxf/xWTiqQHDmvJhepVO4T08llXn3+esZIyz5Mzdn1Nod4fqK6Hmn9u0FDa+jxjV9wIinX4pHWWUrSUwLxESiW+DqGbwSntnIXL51MgO7l6yjCHGa/yHGt379h+cvz9u5NTlrFUiFXpguYYvqT/X8CXbMLoufH/C8GD6dO23FeGSq4Wjc+psrAuZZZ548rttPSlT0vHH73ULFfrHpXb+erACv1NjN064T8pf/IXXP++HR567pwQsU2j6fDON5vN/wFupzFe",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"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Self Sign"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/selfsign"}),"\n",(0,i.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,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."]}),"\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."]}),"\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:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "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 }\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"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signer"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.a965d111.js b/assets/js/ae010e44.a965d111.js deleted file mode 100644 index 86b432e42..000000000 --- a/assets/js/ae010e44.a965d111.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4930],{80204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={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:"eJztO11zGzeSf6UXL45VQ0qkZcfHurpax87t+jaJXZFSqS1RpYAzTRIWBpgAGJGMilX7cD9j9+V+Wn7JVeNjZkiRkh2ndnV1zIPDARqN7kaj0V+6ZY7PLBtdsDc6r0tUzrLLjBVocyMqJ7RiI3Y+R7Aop1bMFLx6/xZmqNBwhxY4/PD9N+Dm3AEqPpFoYWoQrVtJBIIXagZ6ChyKiL8Pf9U15FwBl1aDULmsCwTtN+MSKoO9AqdCYQELUczQ2QwWc5HPwc0DTjR+PRbCgTaAy4qrAupKK+AWFGKBRR/O58JCZfSNKDyhiRpcVmgEqpyQlUJyA0573L/+7e9nxOJfdW2I31//9g+YSr0Aofz8uwqVB+BV1R+rsToX1Qh+qKTmBax0beD9m/9sGCWsNHZxdPQGJ/UMfnh7dHT5xdy5yo6OjwmHrlARWZJPbD/X5XFBgFUxfUoso0HCGnjlVsgV8KIjFDdHBbmuVpBrbQqh6EQyqPgMQdXlBI3NgCRTaoPEAweDvFj1nO7VFuG/zt59B1NtSu768F7WNmu2K4TB3MlVQE+8J66eWJhwiy9OwToj1CyDkl+TWIWDn2uRXxPbFlWRhPrq/Vsvq6Ojs7qqtHFYwI+BhdHREc18hSRjbtDD57ostYKKG16iQ2ODdtG0wZ9rYbxeuDlwKZMsRmPVg6Mjt6pwdHQEb1Uhcq+ehJBGSQUDbD+AkpAI9KzCXExFBO2IDrSKWkcyWfBwnpXkeSDToK0wd+IGNxEvM1gR4jeodKJgro34RSvHpT+OGzRO5Fx2j40I9OrtuHEkzkoL5dJo3KG5OXR6/lCiXhFpBQmrFMrPWIQbLmu0kapFBnOi6nusDFq65QkvCVIVMEcxm+/djxcfaus2EENticwuFXGvdEpevOjFNuXSIojphixLfo2d3RoL0IevVlDglNfSZSBI45ypsQ/faUc3T4qcDA1prr/T3NUGe/6UozpEQhQv/Rm/b21AIaZTNHQ5adKjiGsSdaRnwWgQe/7muDlXoNXWQedaakPot3TIj28KEnKtnDd9r264kJ76wK1t7N9E8vw6g4msMQODRbi5K5RSL7Kg8B6ELFwQuhcQ2WVSQ62IAaXj9sKCjVQ1ljBdKJpsrC1tImxXrPHaTjXtTDJIdwyw5EJmXnIZfNATcMJJzOjGVlytMii4wwwcLt1ELzPI55hfT/QyCmyqlbPilx3XLs18utSGGZxm8CKDlxkMTjIYDDMYnGYweJHB4GUGw5MMhsMMhqcZDF8EmQ5fRnnyRohdAgbDIEn3uCRIBvQbYf0VJctnG2O62DCmYzXow9FRczH88E8//TRWt2MFMGZ0UcZsNGYNyJhlEObI/o3ZaJBBHFiO2QieDb9MACv6fkESDN8L+h6QxMP3nL6Hg7Fax02HnhjHy+oeQmj69ycifUadoUG/M40lG0WDZFwCLM3Q2dBoQxZNrFuGnhFDQgknuLT7eUoQj4+tlrItzk6JM6+h+9ny04+Pp0RWmvFGMEx5o9mZSlfdEzLcEsHzfvts7JFA2PSxCSBS9bn8vyD+G7u0XwgNyOOTRJe0zxXHl33/znvbvF8YEeDxiaIl7HMF8ZIEQW/TfinQ7OMTQaQqTcT3PsydnPYGz3vDk+HphhgoHAoAZdkrit5qtfpMEYIXGLlAcX/vNUavNDhz3CFMjS53hBw+Imihoovkfyc3/VtyzifJb8UixauNA9NEeV3P2umCr57YgCotbXw1gm89tVWHTD9FdPiIN59rkUfiCSZ5aBMK6vokhB4Jvjj+9tvjjijDYK8sk3whjdJ3z4u+O1qW/aLob8NunFBntISiyGDH+O6JooCyLPeNhwl6Lsfq3+giRPds/12IAP/c69Aqfbv9w1eFEgJaSb+/j9J235Wt92UuVJyIegNbAAZnteQGlxRuWqGVl8vvYIm2blG6RK0r76NTH9j52D+IAr54F931p1HBiYNNBDTy8Lo7jHWRGJzh0uPIa+t0ScSIghOGDGydzyl44ykqILG3eRr/lfNKUJZAonN+FF3e30VEOLROhE2nuh1gW3QbzHALaeWOGNufvg80Bif+3Yuxxz0PX4R4fGa/Q1maDFkLmr4Ys5JH14VNsf2t3RzNmF02a0JsjUVnLexaDJfZ/vsE7aUpUPIJyrt37XNuQyCuq4bJBCdlTtIAKWzKXmyy1l0d0zs+6UapVNKkCUJaAJNGcT5bMRvCPk4zw72NQnxgC4IDD9ik1ppg+l7d99GzKEN6cF9wV3o9f2xaH8na0hGWMV1Rtl5o9bZgI5Yy+SzzWNG6r3SxYqNbFhMu9DOmM2jR8QdLVYBbZvM5lpx+JWqobjAVElnGQl7esox575uKCCQvNmJ68gFzxzJ6KypKfaIlHH7d6DZBhWwyy6IHxkYspJlZxnDJy4qA4xCgyjW5OVUxZeu04X2ompEWlfU/mrQ24dkoevwmbG86GNYZowzwb8T0HS31vJV4rl9rGnT4hq9sB2F4PNh2uYbW0B3I4yoo+MpSjqq24TrnXOa1JGcOl5Uwq8az9B5dI5IOoc1ODaGD5+t06B2K9py10Z9+QDlqEoAP7T917QeNE8Q/xgGqrPjj4OUnU/FBI0zQH0U11+qT1w+GzwbDwbPBkDDETF0HBzeGr1jGhMPSPizHMHuXgs3zf0UeBhbJkvfaLHkGPqnVf0gHE7xnm8/wYZ0731c96eRz7VzXsqBMKXLT90WM31wf21Rj2sRz239AadcZWz7MzBJy3UulGfhC4tRBXVVUdtRGoXnajdUeDXPD09N1xlYPs7f6P8nel3R4i4e5+9HXtNp637+C1mcv1xmbP0zrn5uq27+Q2NMX6/YRZblB7jC9AVcTXayukt1adwGTG7EJGl+ENe0oCzTkcdy1V62pIUiqFl9t2/mJ1hK52mFoNioxPpqy3vUjxzImKxZzJF++9Qg9dtu4stENDS4LVXdwK34Ulvw9U+OY9eHttJVlcCa3i0EJ1heDlIYnfr8rW3sz/uQ4fpOEnnQr21RsbJM0iQQPDA7LSvrS8EJISXTT892H5j/v2jWSJALSc5k2fvipeB3iVL9hXLRZV4XoIvbhNVdN2W2zvAW3t40SeO1Yr+H2lk4VzRU9uut11g7QXhsD/l0NIwZzFDcbq5ohbBc2Y52lwZO5Ik8mDMTsZ5eA0AByVRu5XvfvqGF7Rh8ttztiimdHSP4/SMx3/Jzr2nzExfVRWi9cnhDhBMUOSIDDrPa5S0fmL+mgT4K05XihrDN1HsLbojapAyG19lRG52htPzYc9KAQNpRk59jFnwEqG5ZzmHLr0GRQK6EcGlNXFObe7Rba4N9vsKYIKrTKkIgeVpvNsjd1ToUun05jU7rsCTHGxqbozDc9F6nJaJv1rUN6yGAHm97Gc9GMUHeLVjZ4ncOTE/rfJiupXQzig0H5LSJgWku5+gPLPj6YvN/lDcO7n5H7fNj5BzH8ZZnfDN+Tpu45nXsRxCe3NpIapkhyvaaHzUcUHdkKJYXCqyS2q+HJydWAZLvO2Oku8Z3pEt3cNweQEBdGUytVJZFTa49ZAZ9xoYAeAPM7ShON0eb+F/nTKLtPCKcbQnh+VwhvlU+Q+pbCc32N6p/LaXd7F7YnUpel15UQLTIRgPw822C2Ox6YtJjXRrgVG13csmWPV6IX5kcXl+vLjJFgNaVgKm09xdzN2YgddzIyFs0NpVEIg1faRg8tVwVlr+64f7wSxzcDts62V+x0FvdCW8dnQs169666bJk8o4MIst5gtY1tK/EXpOA2SrILlTFBCjBHXpC3uM4Yne/3bTrq63RKKVG0K/fTsW1b2Zxtw7sjP5PSMxsZl90Jl8HzbqojJDN8fqJJT+zKODSMpxxCk0LoZAU6SYGLVleb+DuF3wMftw5PT32A9+XAR0LPXvog4/TF+nLD32Zs06f2+cJtz5CxTY/Hf3fe85Cg3nrf/Ksv1FT7Y46yb7pi6R7dDO4GZChzXTZtUQn81//+H78inZm/5n+Ad7WBSi/QTOvQWzWVuBT0hhPwlruPvJRorVwBPd0zakmGQsx8DSU9jDmv+ERIQYaBwHTIcnVsi+3Dj23A8MSEctINSrInILX2/a1OA6+dLv0e6fFbaHNNHcLUaAsTaolEa8EipiWo5tx3Gsdbk1HDMvXzkqtRGWERuCgJmFwenE5FLvyrqpUzPHdQcsVnSJtlPjAkKTRNzUZPqPRrtayDT0RtlYgusEjZe9uHN9Sj6hn32T10XEgsgjtkqfesoDyg19vYLzwhT7ai7UWOti1CS7xB461E8GdrKaHSZK0FlxQZdc+WEDnDlaVHNmYW49E04otOi9+j4Ks+UAqeHiCKdUgBpFDXobv3olGzH3FihcM2KF4sFncs1tPNNX8Sbl5PwGCl23UzP+jtW3d58/GUzAGa0r6bnqG5EXlyC/bseeyBj+MbxkP8lQwEr8QftxfQbZIiR2Wx8+K8+tP7b+AGnvVPWNax0R9B8PE3b19//d3Z14SXXpFw/wb9k/6Jz+Rp60quOludoZzCWXh5trLfzTN86P4/dP8fuv8P3f+H7v9D9/+h+//Q/X/o/j90/z8ung7d/4fu/0P3/6H7/9D9f+j+P3T/H7r/D93/h+7/Q/f/ofv/0P3vW8RiUZHswHEluVCdhohQgb5o/ybgMmNzKk6PLtjtLaV6f6DWHxr+uUZDle3LjN1wIyjX4evaWariUgHzGqmU+DqkbnrntHMWLp8vgWyV86kIHVa8ynOs3L2w3fr5+3dn5yxjqVer1AWtMXxBf9PAF2zE6Lnxf/nghenLttw3j0quZrWvqbKAl4rPvHbzzcr1ta9cxx+d0ixXqw6VmyXtwAr9S4ztXPDvVD/5C67+owEPM3sXRNkmaDq8y/V6/b9fCVqF",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztO11zGzeSf6UXL45VQ0qkZcfHurpax87t+jaJXZFSqS1RpYAzTRIWBpgAGJGMilX7cD9j9+V+Wn7JVeNjZkiRkh2ndnV1zIPDARqN7kaj0V+6ZY7PLBtdsDc6r0tUzrLLjBVocyMqJ7RiI3Y+R7Aop1bMFLx6/xZmqNBwhxY4/PD9N+Dm3AEqPpFoYWoQrVtJBIIXagZ6ChyKiL8Pf9U15FwBl1aDULmsCwTtN+MSKoO9AqdCYQELUczQ2QwWc5HPwc0DTjR+PRbCgTaAy4qrAupKK+AWFGKBRR/O58JCZfSNKDyhiRpcVmgEqpyQlUJyA0573L/+7e9nxOJfdW2I31//9g+YSr0Aofz8uwqVB+BV1R+rsToX1Qh+qKTmBax0beD9m/9sGCWsNHZxdPQGJ/UMfnh7dHT5xdy5yo6OjwmHrlARWZJPbD/X5XFBgFUxfUoso0HCGnjlVsgV8KIjFDdHBbmuVpBrbQqh6EQyqPgMQdXlBI3NgCRTaoPEAweDvFj1nO7VFuG/zt59B1NtSu768F7WNmu2K4TB3MlVQE+8J66eWJhwiy9OwToj1CyDkl+TWIWDn2uRXxPbFlWRhPrq/Vsvq6Ojs7qqtHFYwI+BhdHREc18hSRjbtDD57ostYKKG16iQ2ODdtG0wZ9rYbxeuDlwKZMsRmPVg6Mjt6pwdHQEb1Uhcq+ehJBGSQUDbD+AkpAI9KzCXExFBO2IDrSKWkcyWfBwnpXkeSDToK0wd+IGNxEvM1gR4jeodKJgro34RSvHpT+OGzRO5Fx2j40I9OrtuHEkzkoL5dJo3KG5OXR6/lCiXhFpBQmrFMrPWIQbLmu0kapFBnOi6nusDFq65QkvCVIVMEcxm+/djxcfaus2EENticwuFXGvdEpevOjFNuXSIojphixLfo2d3RoL0IevVlDglNfSZSBI45ypsQ/faUc3T4qcDA1prr/T3NUGe/6UozpEQhQv/Rm/b21AIaZTNHQ5adKjiGsSdaRnwWgQe/7muDlXoNXWQedaakPot3TIj28KEnKtnDd9r264kJ76wK1t7N9E8vw6g4msMQODRbi5K5RSL7Kg8B6ELFwQuhcQ2WVSQ62IAaXj9sKCjVQ1ljBdKJpsrC1tImxXrPHaTjXtTDJIdwyw5EJmXnIZfNATcMJJzOjGVlytMii4wwwcLt1ELzPI55hfT/QyCmyqlbPilx3XLs18utSGGZxm8CKDlxkMTjIYDDMYnGYweJHB4GUGw5MMhsMMhqcZDF8EmQ5fRnnyRohdAgbDIEn3uCRIBvQbYf0VJctnG2O62DCmYzXow9FRczH88E8//TRWt2MFMGZ0UcZsNGYNyJhlEObI/o3ZaJBBHFiO2QieDb9MACv6fkESDN8L+h6QxMP3nL6Hg7Fax02HnhjHy+oeQmj69ycifUadoUG/M40lG0WDZFwCLM3Q2dBoQxZNrFuGnhFDQgknuLT7eUoQj4+tlrItzk6JM6+h+9ny04+Pp0RWmvFGMEx5o9mZSlfdEzLcEsHzfvts7JFA2PSxCSBS9bn8vyD+G7u0XwgNyOOTRJe0zxXHl33/znvbvF8YEeDxiaIl7HMF8ZIEQW/TfinQ7OMTQaQqTcT3PsydnPYGz3vDk+HphhgoHAoAZdkrit5qtfpMEYIXGLlAcX/vNUavNDhz3CFMjS53hBw+Imihoovkfyc3/VtyzifJb8UixauNA9NEeV3P2umCr57YgCotbXw1gm89tVWHTD9FdPiIN59rkUfiCSZ5aBMK6vokhB4Jvjj+9tvjjijDYK8sk3whjdJ3z4u+O1qW/aLob8NunFBntISiyGDH+O6JooCyLPeNhwl6Lsfq3+giRPds/12IAP/c69Aqfbv9w1eFEgJaSb+/j9J235Wt92UuVJyIegNbAAZnteQGlxRuWqGVl8vvYIm2blG6RK0r76NTH9j52D+IAr54F931p1HBiYNNBDTy8Lo7jHWRGJzh0uPIa+t0ScSIghOGDGydzyl44ykqILG3eRr/lfNKUJZAonN+FF3e30VEOLROhE2nuh1gW3QbzHALaeWOGNufvg80Bif+3Yuxxz0PX4R4fGa/Q1maDFkLmr4Ys5JH14VNsf2t3RzNmF02a0JsjUVnLexaDJfZ/vsE7aUpUPIJyrt37XNuQyCuq4bJBCdlTtIAKWzKXmyy1l0d0zs+6UapVNKkCUJaAJNGcT5bMRvCPk4zw72NQnxgC4IDD9ik1ppg+l7d99GzKEN6cF9wV3o9f2xaH8na0hGWMV1Rtl5o9bZgI5Yy+SzzWNG6r3SxYqNbFhMu9DOmM2jR8QdLVYBbZvM5lpx+JWqobjAVElnGQl7esox575uKCCQvNmJ68gFzxzJ6KypKfaIlHH7d6DZBhWwyy6IHxkYspJlZxnDJy4qA4xCgyjW5OVUxZeu04X2ompEWlfU/mrQ24dkoevwmbG86GNYZowzwb8T0HS31vJV4rl9rGnT4hq9sB2F4PNh2uYbW0B3I4yoo+MpSjqq24TrnXOa1JGcOl5Uwq8az9B5dI5IOoc1ODaGD5+t06B2K9py10Z9+QDlqEoAP7T917QeNE8Q/xgGqrPjj4OUnU/FBI0zQH0U11+qT1w+GzwbDwbPBkDDETF0HBzeGr1jGhMPSPizHMHuXgs3zf0UeBhbJkvfaLHkGPqnVf0gHE7xnm8/wYZ0731c96eRz7VzXsqBMKXLT90WM31wf21Rj2sRz239AadcZWz7MzBJy3UulGfhC4tRBXVVUdtRGoXnajdUeDXPD09N1xlYPs7f6P8nel3R4i4e5+9HXtNp637+C1mcv1xmbP0zrn5uq27+Q2NMX6/YRZblB7jC9AVcTXayukt1adwGTG7EJGl+ENe0oCzTkcdy1V62pIUiqFl9t2/mJ1hK52mFoNioxPpqy3vUjxzImKxZzJF++9Qg9dtu4stENDS4LVXdwK34Ulvw9U+OY9eHttJVlcCa3i0EJ1heDlIYnfr8rW3sz/uQ4fpOEnnQr21RsbJM0iQQPDA7LSvrS8EJISXTT892H5j/v2jWSJALSc5k2fvipeB3iVL9hXLRZV4XoIvbhNVdN2W2zvAW3t40SeO1Yr+H2lk4VzRU9uut11g7QXhsD/l0NIwZzFDcbq5ohbBc2Y52lwZO5Ik8mDMTsZ5eA0AByVRu5XvfvqGF7Rh8ttztiimdHSP4/SMx3/Jzr2nzExfVRWi9cnhDhBMUOSIDDrPa5S0fmL+mgT4K05XihrDN1HsLbojapAyG19lRG52htPzYc9KAQNpRk59jFnwEqG5ZzmHLr0GRQK6EcGlNXFObe7Rba4N9vsKYIKrTKkIgeVpvNsjd1ToUun05jU7rsCTHGxqbozDc9F6nJaJv1rUN6yGAHm97Gc9GMUHeLVjZ4ncOTE/rfJiupXQzig0H5LSJgWku5+gPLPj6YvN/lDcO7n5H7fNj5BzH8ZZnfDN+Tpu45nXsRxCe3NpIapkhyvaaHzUcUHdkKJYXCqyS2q+HJydWAZLvO2Oku8Z3pEt3cNweQEBdGUytVJZFTa49ZAZ9xoYAeAPM7ShON0eb+F/nTKLtPCKcbQnh+VwhvlU+Q+pbCc32N6p/LaXd7F7YnUpel15UQLTIRgPw822C2Ox6YtJjXRrgVG13csmWPV6IX5kcXl+vLjJFgNaVgKm09xdzN2YgddzIyFs0NpVEIg1faRg8tVwVlr+64f7wSxzcDts62V+x0FvdCW8dnQs169666bJk8o4MIst5gtY1tK/EXpOA2SrILlTFBCjBHXpC3uM4Yne/3bTrq63RKKVG0K/fTsW1b2Zxtw7sjP5PSMxsZl90Jl8HzbqojJDN8fqJJT+zKODSMpxxCk0LoZAU6SYGLVleb+DuF3wMftw5PT32A9+XAR0LPXvog4/TF+nLD32Zs06f2+cJtz5CxTY/Hf3fe85Cg3nrf/Ksv1FT7Y46yb7pi6R7dDO4GZChzXTZtUQn81//+H78inZm/5n+Ad7WBSi/QTOvQWzWVuBT0hhPwlruPvJRorVwBPd0zakmGQsx8DSU9jDmv+ERIQYaBwHTIcnVsi+3Dj23A8MSEctINSrInILX2/a1OA6+dLv0e6fFbaHNNHcLUaAsTaolEa8EipiWo5tx3Gsdbk1HDMvXzkqtRGWERuCgJmFwenE5FLvyrqpUzPHdQcsVnSJtlPjAkKTRNzUZPqPRrtayDT0RtlYgusEjZe9uHN9Sj6hn32T10XEgsgjtkqfesoDyg19vYLzwhT7ai7UWOti1CS7xB461E8GdrKaHSZK0FlxQZdc+WEDnDlaVHNmYW49E04otOi9+j4Ks+UAqeHiCKdUgBpFDXobv3olGzH3FihcM2KF4sFncs1tPNNX8Sbl5PwGCl23UzP+jtW3d58/GUzAGa0r6bnqG5EXlyC/bseeyBj+MbxkP8lQwEr8QftxfQbZIiR2Wx8+K8+tP7b+AGnvVPWNax0R9B8PE3b19//d3Z14SXXpFw/wb9k/6Jz+Rp60quOludoZzCWXh5trLfzTN86P4/dP8fuv8P3f+H7v9D9/+h+//Q/X/o/j90/z8ung7d/4fu/0P3/6H7/9D9f+j+P3T/H7r/D93/h+7/Q/f/ofv/0P3vW8RiUZHswHEluVCdhohQgb5o/ybgMmNzKk6PLtjtLaV6f6DWHxr+uUZDle3LjN1wIyjX4evaWariUgHzGqmU+DqkbnrntHMWLp8vgWyV86kIHVa8ynOs3L2w3fr5+3dn5yxjqVer1AWtMXxBf9PAF2zE6Lnxf/nghenLttw3j0quZrWvqbKAl4rPvHbzzcr1ta9cxx+d0ixXqw6VmyXtwAr9S4ztXPDvVD/5C67+owEPM3sXRNkmaDq8y/V6/b9fCVqF",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"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Self Sign"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/selfsign"}),"\n",(0,i.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,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."]}),"\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."]}),"\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:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "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 }\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"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signer"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.a74dc2c1.js b/assets/js/runtime~main.9115d433.js similarity index 98% rename from assets/js/runtime~main.a74dc2c1.js rename to assets/js/runtime~main.9115d433.js index 145f18c1b..a6d04b651 100644 --- a/assets/js/runtime~main.a74dc2c1.js +++ b/assets/js/runtime~main.9115d433.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,d,f={},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 f[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=f,t.c=r,e=[],t.O=(a,c,b,d)=>{if(!c){var f=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var f={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,t.d(d,f),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",3965:"reactPlayerVidyard",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"a9f09360",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e283f01a",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"28386b54",1477:"b31b2642",1512:"9637e502",1520:"523b2d80",1531:"3855f22e",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"6b36ff91",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"a965d111",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"5f8c6828",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"a94482e8",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"8bd89dab",8140:"901b2f91",8141:"81bec72f",8163:"4d9dbd85",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"9bc6455d",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"553c32a0",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"b14fac44",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},d="OpenSign-Docs:",t.l=(e,a,c,f)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743",reactPlayerVidyard:"3965","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",a9f09360:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var f=t.p+t.u(a),r=new Error;t.l(f,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",r.name="ChunkLoadError",r.type=d,r.request=f,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,f=c[0],r=c[1],o=c[2],l=0;if(f.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,d,f={},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 f[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=f,t.c=r,e=[],t.O=(a,c,b,d)=>{if(!c){var f=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var f={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,t.d(d,f),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",3965:"reactPlayerVidyard",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"a9f09360",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e283f01a",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"28386b54",1477:"b31b2642",1512:"9637e502",1520:"523b2d80",1531:"3855f22e",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"6b36ff91",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"84114f8b",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"5f8c6828",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"a94482e8",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"8bd89dab",8140:"901b2f91",8141:"81bec72f",8163:"4d9dbd85",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"9bc6455d",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"524e33af",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"b14fac44",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},d="OpenSign-Docs:",t.l=(e,a,c,f)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743",reactPlayerVidyard:"3965","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",a9f09360:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var f=t.p+t.u(a),r=new Error;t.l(f,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",r.name="ChunkLoadError",r.type=d,r.request=f,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,f=c[0],r=c[1],o=c[2],l=0;if(f.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index aa81fcfda..5d034c712 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 3013f1b5a..22e017dc4 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 29326f6ae..3950d5169 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 0d708c09e..d3a5ccd95 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 da274e0d1..d9ef1c448 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 ca7644de1..d4328caba 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 6ddc35983..70d29e194 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 eed92a2de..822a8db7e 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 6606ab2f1..78e9e99f3 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 9eabe17e7..1b57a54ce 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 8b0e16209..c06f16394 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 6cef8bb3f..fbba82f3f 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 6234a40ef..35244e729 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 2af953758..336492d5d 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 103a456bc..cc906b15c 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 d77e76278..f6350558c 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 9cc3162eb..69a1bcfec 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 636168ac2..3e5d0ce4d 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 87d302d7e..3f48f4cee 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 8ea4559d2..09484950f 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 a7bff91eb..196f48570 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 190b782fe..7ada5fa67 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + @@ -119,7 +119,7 @@
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}

Request

-

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

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

    signers

    object[]

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

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

    x number

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

    y number

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

    w number

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

    h number

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

  • ]

  • ]

  • folderId string
    send_email boolean

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

    email_subject string

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

    email_body string

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

    sendInOrder boolean

    If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.

    enableOTP boolean

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

    enableTour boolean

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

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    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.

+

Body

required

    file base64required
    title stringrequired
    note string
    timeToCompleteDays number

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

    signers

    object[]

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

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

    x number

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

    y number

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

    w number

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

    h number

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

  • ]

  • ]

  • folderId string
    send_email boolean

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

    email_subject string

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

    email_body string

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

    sendInOrder boolean

    If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.

    enableOTP boolean

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

    enableTour boolean

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

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    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.

Responses

Document created successfully!

Schema

    document_id string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index cfd593c29..b4a838b5a 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 75e4e750b..9364a1e79 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 b5f8fb73c..0b13ee35f 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 700ba05b5..22cddcc51 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 cbd3453bb..c70eb2d19 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 694cfd97b..145b94ad9 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 24a5a82f1..b12f3dfb5 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 a6249e187..19a1dce98 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 c715c6f6c..fa4c247d1 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 350666102..521468ffc 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 732a43fc5..ed45b0184 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 6f0042dec..a4b2b8848 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index b3646280d..81db85db9 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index c67247fab..02366f5d2 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 d5ee6f917..1d9da09e6 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + @@ -99,7 +99,7 @@
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}

Request

-

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

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

    signer

    object

    role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

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

    x number

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

    y number

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

    w number

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

    h number

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

  • ]

  • folderId string
    send_email boolean

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

    email_subject string

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

    email_body string

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

    enableTour boolean

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

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

+

Body

required

    file base64required
    title stringrequired
    note string
    timeToCompleteDays number

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

    signer

    object

    role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

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

    x number

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

    y number

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

    w number

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

    h number

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

  • ]

  • folderId string
    send_email boolean

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

    email_subject string

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

    email_body string

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

    enableTour boolean

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

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

Responses

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 318b6e85d..cee9a5edd 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 191eb9ad7..3319fb5b7 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 3d0dcdb3c..15e5dc44a 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 368b32f9f..3eb7a0a7d 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 88fa7f8a9..394cc0c6d 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 a8977f573..60d94fa9f 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 210f585aa..36bf6651f 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 917530d9c..584af5a59 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 f7e367261..dceb3bae0 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index d24061615..14390da75 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index 164a66c12..875e68d8f 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 01802a2b9..466445da4 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 ba9a9138c..dd1588bd4 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 07a63802d..41aff315d 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 015d6274e..7a9e46f99 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 5daf96e5e..56d1b1b78 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 2f9d9cd5e..5a0acf7a9 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 a8bdcff97..6d928edfc 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 2857ba1ab..2dde10fb8 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index 4fb1f4725..b535834c8 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 92d2ec2ea..6247ca6dd 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 7c7c0153d..31c75d9ec 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 d9e5581ad..91afddf7a 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 5ca31a18f..8c14c4654 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 09919ca82..cf5dc9acd 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 e191836d8..14253cd9e 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 a3336bd7d..90bdb5bab 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 744852873..38e5f83b1 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 556f10ac9..59a257777 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 2e80f879a..8505e06e1 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 3cd31d1fb..24ed128f0 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 6e67fa6f6..99d7b70a5 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 d4abe78bd..409dcb05e 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 7c32733e3..828ccf917 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index 0ebc70ee8..a89da22be 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 f40314540..c3ccad484 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 3bb57ea40..f50f1041c 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 21b541bd8..aee20058a 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 31d8e1569..03701b15c 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 73342c71d..183cbe4ab 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 96a43788b..57c7f0c84 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 a4fd2593d..af5cfd7eb 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 149d513f6..9de144476 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 74ca940ae..b7c5070d6 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 9c58d8bff..98154507e 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 6f0960e36..b2a669cd4 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 29f7bc463..13af67cc1 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 649e95789..19b78df3c 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 4b3341135..d8ddca293 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 45a384bde..c4fbdd44a 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 a8c49df76..3c4c682bc 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 755ecca89..bcf661077 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 a050d7998..679919d32 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 1d951598d..b53fe2379 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +