diff --git a/404.html b/404.html index b06b807de..3cc4466e2 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/02e5f5c4.60be571e.js b/assets/js/02e5f5c4.60be571e.js deleted file mode 100644 index f287d15a6..000000000 --- a/assets/js/02e5f5c4.60be571e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>S,contentTitle:()=>h,default:()=>I,frontMatter:()=>j,metadata:()=>a,toc:()=>g});const a=JSON.parse('{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.1/createfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createfolder","permalink":"/docs/API-docs/v1.1/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV1FvGzcS/itzfOlVWEuym7S4fapbpKnbIDFqFwbqCMHs7miXMZdkSa5kQRCQh/sH99TX/rT8ksOQWmklp7lzWxR9MazhzHDmmxnOt2sRsPYivxXfGFWRE7NMVORLJ22QRotcXDcEXzvCQJBU4PzyAlAps/SwMh0EA2U6n8fzsciEseSQHVxUIhfpOJ2KTDj6uSMfvjLVSuTro+sunVnIiqAgZZZg0WFLgdyDW0QmSqMD6cA+0Foly3jj5K1nR2vhy4Za5P/4Qumo4jSTtcaWONWwsiRyYYq3VAaRCes48iDJs13Sfcm6+brX9cFJXYtMzI1rMQwldI+tVaykadnHucmERUc6JPQYkMf5EptNJoIM8Udy+qZg7DZ8sM8tuI6iwFujfcrgbDp9CHHysYWzAt+VJXk/75Ra/eMxsH4cvCR+fLq2OS2a+7O3lpH7e1TguzON/umdvCT2tcXtPHzIzd7obHr22cnp9GT6xfXp5/mTf+VPPx9Pp9OfRCbuW8W2sQlzUWGIfvsS9787W/0F92yO1RJoFQWUyosHrcddt8nEkw811pVpKTRS17AkHWDpjK4zsIrQEwS3AqxRalAYyP2JnUbOGfdxkB4X2XDgpFZS05t+qt48mU7fnO5AePoQhAu9QCWr+EpemzvSf22mw+tDuv5hjWVSiufiINmhPCXpqeycDCuR367F/QlaeZLO89vZZpYJBtbwK2+NjxFjaEQuJkePvie3IOejl84pkYsmBOvzycSjrgpzPzaWtJe1Vlj4cWnaCVo5WZyOT8UmO7ZBax+lT93JY018wFrq+n/ZzfYIXXEVU6EOcNqVC638nlYi68sw1MqE5O5pCNOQZYKb44f9qnzWl/hwLw0fuofvnODqSj03MYptlV9Z0ley1rFHYhbHO/+GVGla4qUbGoLRqDd5/+9fd1ajEVSm7FrSIXbz+LV+rV91DqxZkpt3ClBXMFd0LwtF0YzaeLbjDZ6wVeS9WoHUgWrH+72StQyogAHniS3RYiGV5CFgNcPWDgZz5Mdw01BoyPHRJ44AoaIFKZ4dwC6YFgO76uOFpXF3c2YwGSAUnZeavAfSDeqSFfuSZmAcoAbSgZx10hP44DhqmWIzOjgsA7SosSb2ncEQrIqU5L4HZ4rOB/BGdTFk4PfVOKqgT0gTVT6C+Oze8hGwtDStddRw/y0I6k5W5DMoTUXgY0NwCrqCgnwAy7HIkjw77bQy5V0sIO92sIafIIkKzPwgRjYPDrXnHZhi6WuwA8w6wySBUoCj0Y+euMIvpL7z+Wj0Wp/A7a6vbqjwMtDsn/0sLZfLBzP06aHNcxm+7Qr4gazxMhi32lvXMjRdEedu6GT3I3l6Tppi/wymau+jMqV/OMYsnTSk7OSKAneIn5xfXsRX+1N4/+4/8ILQaWjMMnVr2TlSK6j7qxi5VPkE2+7RhbmJjdcw4mVqvi3t7RG8aTC8f/eLh5e0BKm3I8WpjEaXXaFkCdfUWl5JfjTKew4eehmEBgOUqKEg8A1yKy0kAoJN1krquzGc6xV0nhwsZWhiM7A82h2kwbjsyu2hQE8VGB0t+jvH+4hY3npSC/LsS5vAYVAlmVGGxpmuTrcNg9km52gulYIbWdUUYm7nVQV2K14mMQM+CIfmPBChoRWgI/Ckwxguj0ziSWetcRyFTMHPDX+qcAFIV9ZIHXwOlcN52PvP9o0e15Y0+gOiBCHu4Mi2bnYlSZO4zXgnHb/m1/1oIxy+t47m5PjCmPa+LlZu2+m2b0vgbv0jbR0ZrNEBy8hGqEWp0mr68thPZAbkWv9qfkVuIUvarsffmOhJVJ6ITChZkvY0YBznzy9fwOKz8VRkgz37fwz35MXF189eXj3jYPghTYCdjqfjaST2xocW9eCmg2/V48223jOx3/dhu93kge7DxCqUkT7FhNZb5nN7+Lk7y0TDxCi/Fes1T9WPTm02LP65I8esapaJBTqJBS/n29km60kAU6U7WnFOKeiTa76d1VWX+MQRlWQWkyzOy5Js+KjukLtdvrq6Fpkotp/kranYxuGSP9dxyUSCP+rj5opf1CxbC4W67rBm3eSTeQs/e4ek5y6Snu0/nFV/pFeDCA/ZUEqD/3JSHzRYrxOh2mx2+unoNy22wPbaXL3ZZrP5L6iA87Q=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"}}');var o=r(74848),n=r(28453),s=r(33617),l=r.n(s),i=r(17543),d=r.n(i),p=r(86013),c=r.n(p),m=r(63723),f=r.n(m),u=(r(18766),r(79329),r(9303));const j={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV1FvGzcS/itzfOlVWEuym7S4fapbpKnbIDFqFwbqCMHs7miXMZdkSa5kQRCQh/sH99TX/rT8ksOQWmklp7lzWxR9MazhzHDmmxnOt2sRsPYivxXfGFWRE7NMVORLJ22QRotcXDcEXzvCQJBU4PzyAlAps/SwMh0EA2U6n8fzsciEseSQHVxUIhfpOJ2KTDj6uSMfvjLVSuTro+sunVnIiqAgZZZg0WFLgdyDW0QmSqMD6cA+0Foly3jj5K1nR2vhy4Za5P/4Qumo4jSTtcaWONWwsiRyYYq3VAaRCes48iDJs13Sfcm6+brX9cFJXYtMzI1rMQwldI+tVaykadnHucmERUc6JPQYkMf5EptNJoIM8Udy+qZg7DZ8sM8tuI6iwFujfcrgbDp9CHHysYWzAt+VJXk/75Ra/eMxsH4cvCR+fLq2OS2a+7O3lpH7e1TguzON/umdvCT2tcXtPHzIzd7obHr22cnp9GT6xfXp5/mTf+VPPx9Pp9OfRCbuW8W2sQlzUWGIfvsS9787W/0F92yO1RJoFQWUyosHrcddt8nEkw811pVpKTRS17AkHWDpjK4zsIrQEwS3AqxRalAYyP2JnUbOGfdxkB4X2XDgpFZS05t+qt48mU7fnO5AePoQhAu9QCWr+EpemzvSf22mw+tDuv5hjWVSiufiINmhPCXpqeycDCuR367F/QlaeZLO89vZZpYJBtbwK2+NjxFjaEQuJkePvie3IOejl84pkYsmBOvzycSjrgpzPzaWtJe1Vlj4cWnaCVo5WZyOT8UmO7ZBax+lT93JY018wFrq+n/ZzfYIXXEVU6EOcNqVC638nlYi68sw1MqE5O5pCNOQZYKb44f9qnzWl/hwLw0fuofvnODqSj03MYptlV9Z0ley1rFHYhbHO/+GVGla4qUbGoLRqDd5/+9fd1ajEVSm7FrSIXbz+LV+rV91DqxZkpt3ClBXMFd0LwtF0YzaeLbjDZ6wVeS9WoHUgWrH+72StQyogAHniS3RYiGV5CFgNcPWDgZz5Mdw01BoyPHRJ44AoaIFKZ4dwC6YFgO76uOFpXF3c2YwGSAUnZeavAfSDeqSFfuSZmAcoAbSgZx10hP44DhqmWIzOjgsA7SosSb2ncEQrIqU5L4HZ4rOB/BGdTFk4PfVOKqgT0gTVT6C+Oze8hGwtDStddRw/y0I6k5W5DMoTUXgY0NwCrqCgnwAy7HIkjw77bQy5V0sIO92sIafIIkKzPwgRjYPDrXnHZhi6WuwA8w6wySBUoCj0Y+euMIvpL7z+Wj0Wp/A7a6vbqjwMtDsn/0sLZfLBzP06aHNcxm+7Qr4gazxMhi32lvXMjRdEedu6GT3I3l6Tppi/wymau+jMqV/OMYsnTSk7OSKAneIn5xfXsRX+1N4/+4/8ILQaWjMMnVr2TlSK6j7qxi5VPkE2+7RhbmJjdcw4mVqvi3t7RG8aTC8f/eLh5e0BKm3I8WpjEaXXaFkCdfUWl5JfjTKew4eehmEBgOUqKEg8A1yKy0kAoJN1krquzGc6xV0nhwsZWhiM7A82h2kwbjsyu2hQE8VGB0t+jvH+4hY3npSC/LsS5vAYVAlmVGGxpmuTrcNg9km52gulYIbWdUUYm7nVQV2K14mMQM+CIfmPBChoRWgI/Ckwxguj0ziSWetcRyFTMHPDX+qcAFIV9ZIHXwOlcN52PvP9o0e15Y0+gOiBCHu4Mi2bnYlSZO4zXgnHb/m1/1oIxy+t47m5PjCmPa+LlZu2+m2b0vgbv0jbR0ZrNEBy8hGqEWp0mr68thPZAbkWv9qfkVuIUvarsffmOhJVJ6ITChZkvY0YBznzy9fwOKz8VRkgz37fwz35MXF189eXj3jYPghTYCdjqfjaST2xocW9eCmg2/V48223jOx3/dhu93kge7DxCqUkT7FhNZb5nN7+Lk7y0TDxCi/Fes1T9WPTm02LP65I8esapaJBTqJBS/n29km60kAU6U7WnFOKeiTa76d1VWX+MQRlWQWkyzOy5Js+KjukLtdvrq6Fpkotp/kranYxuGSP9dxyUSCP+rj5opf1CxbC4W67rBm3eSTeQs/e4ek5y6Snu0/nFV/pFeDCA/ZUEqD/3JSHzRYrxOh2mx2+unoNy22wPbaXL3ZZrP5L6iA87Q=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,S={},g=[];function y(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,o.jsx)(l(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,o.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(d(),{parameters:void 0}),"\n",(0,o.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,o.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/02e5f5c4.ebd704b1.js b/assets/js/02e5f5c4.ebd704b1.js new file mode 100644 index 000000000..a476145a3 --- /dev/null +++ b/assets/js/02e5f5c4.ebd704b1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>I,contentTitle:()=>b,default:()=>g,frontMatter:()=>P,metadata:()=>o,toc:()=>u});const o=JSON.parse('{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.1/createfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createfolder","permalink":"/docs/API-docs/v1.1/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNWM1uIzcSfpVaXrIR2pLszCRIn9YJZidOJjNC7MDAeoRBdXepmyM2yZBsyYIgIId9gz3tdR9tniQoUq0/O7PrJAj2YljFqmLVVz/8pLUIWHuR34m/G1WRE9NMVORLJ22QRotc3DQEXzvCQJBU4HJyBaiUWXpYmQ6CgTKdz+L5UGTCWHLIDq4qkYt0nE5FJhz91JEPX5lqJfL1yXUTZxayIihImSVYdNhSIPfgFpGJ0uhAOrAPtFbJMt44eu/Z0Vr4sqEW+T++UDqqOM1krbElTjWsLIlcmOI9lUFkwjqOPEjybJd0X7Nuvu51fXBS1yITM+NaDIcSusfWKlbStOzj3GTCoiMdEnoMyNN8ic0mE0GG+CE5fVcwdhs+2OcWXEdR4K3RPmVwMR4/hDj52MJZge/KkryfdUqt/vIUWD8OXhI/PV3bnBfN/cV7y8j9f1Tg2wuN/vlcToh9bXG7DI+52RtdjC8+Ozsfn42/uDn/PH/2Zf788+F4PP6HyMR9q9g2NmEuKgzRb1/i/nNnqz/hns2pWgKtooBSefGg9bjrNpl49lhjXZuWQiN1DUvSAZbO6DoDqwg9QXArwBqlBoWB3B/YaeSccR8H6WmRHQ6c1EpqetdP1btn4/G78x0Izx+CcKUXqGQVt+SNmZP+czM9vD6k6x/WWCaleC6Okj2UpyQ9lZ2TYSXyu7W4P0Mrz9J5fjfdTDPBwBre8tb4GDGGRuRidLL0PbkFOR+9nHTNEuua3DddEYO+7IKB7005T5l1TolcNCFYn49GC+lC8jT0yazpimFp2tHEIW+w17iYoxsZS3p0PhwPx2KTrU+ceNRVYe6HrORlrRUWPvpAK0eL8+H5IzZo7ZP0qTt7qokPWEtd/ze76b4k19w2qTOOCrPrD7TyO1qJrK/7oVYmJKPfEKapzgR34w/7t/lF31PHD+HhZn24WAW3k9QzE6PYttUbS/pa1jrWN2ZxSjJuSZWmJX7lQ0MwGPQmH/75n53VYACVKbuWdIjjM3yr3+o3nQNrluRmnQLUFcwU3ctCUTSjNp7tiIonbBV5r1YgdaDaMaGoZC0DKmDAeUWUaLGQSvLUsZphawcHg+uHcNtQaMjx0SeOAKGiBSkeVsAumBYDu+rjhaVx8xlTpgwQis5LTd4D6QZ1yYp9STMwDlAD6UDOOukJfHActUyxGR0clgFa1FgT+87gEKyKlORBA2eKzgfwRnUxZOCFbhxV0CekiSofQXxxb/kIWFqa1jpquP8WBHUnK/IZlKYi8LEhOAVdQUE+gOVYZEmenXZamXIeC8ijCNbwzpOowMyOYmTz4FB7fnRTLH0NdoBZZ5iVUApwMPjRE1f4ldRznw8Gb/UZ3O366pYKLwNN/9rP0nK5fDBDnx7bvJSBV84PZI2XwbjV3rqWoV8rh052H5Knl6Qp9s/BVO19VKb0D8eYpaOGlB1dU+AO8aPLyVV8Jj6FDz//C14ROg2NWaZuLTtHagV1fxUjlyqfYNtteZiZ2HgNI16m5tvy7B7B2wbDh5//7eE1LUHq7UhxKoPBpCuULOGGWstvoB8M8p70h14GocEAJWooCHyD3EoLiYBgk7WSej6ES72CzpODpQxNbAaWR7ujNBiXXbk9FOipAqOjRX/ncB8Ry1tPakGefWkTOAyqJFPY0DjT1em2w2C2yTmaSaXgVlY1hZjbZVWB3YqXScyAH4RDMx6I0NAK0BF40mEIkxOTeNJZaxxHIVPwM8PfjbgApCtrpA4+h8rhLOz9Z/tGj++kNPoRUYIQd3BkWze7kqRJ3Ga8kw7f8nY/eRGO962jGTm+MKa9r4uV23a669sSuFt/T1tHymx0wDLSH2pRqvQ0/e3UT6Qi5Fr/ZnZNbiFL2j6PvzLRo6g8EplQsiTt6YDiXL6cvILFZ8PxEYf4H4Z79Orq6xevr19wMLxIE2A9l4gsp0V9cNPRl+PTl229p36/7Zv09iUPdB9GVqGMfC0mtN5Srbvj79fTTDTMxPI7sV7zVP3o1GbD4p86ckzjpplYoJNY8ON8N91kPQlgbjanFeeUgj674dtZXXWJT5xwV2YxyeKyLMmGj+oeksXJm+sbkYli+xtAayq2cbjk3wdwyUSCf0WIL1f8Cs+ytVCo6w5r1k0+mbfw2jsmPfNIerb/cFb9kV4dRHjMhlIa/JeTetRgvU6EarPZ6aejX7XYAttrc/Wmm83mF5v5G24=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"}}');var a=r(74848),l=r(28453),n=r(33617),i=r.n(n),d=r(17543),p=r.n(d),s=r(86013),c=r.n(s),m=r(63723),j=r.n(m),f=(r(18766),r(79329),r(9303));const P={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNWM1uIzcSfpVaXrIR2pLszCRIn9YJZidOJjNC7MDAeoRBdXepmyM2yZBsyYIgIId9gz3tdR9tniQoUq0/O7PrJAj2YljFqmLVVz/8pLUIWHuR34m/G1WRE9NMVORLJ22QRotc3DQEXzvCQJBU4HJyBaiUWXpYmQ6CgTKdz+L5UGTCWHLIDq4qkYt0nE5FJhz91JEPX5lqJfL1yXUTZxayIihImSVYdNhSIPfgFpGJ0uhAOrAPtFbJMt44eu/Z0Vr4sqEW+T++UDqqOM1krbElTjWsLIlcmOI9lUFkwjqOPEjybJd0X7Nuvu51fXBS1yITM+NaDIcSusfWKlbStOzj3GTCoiMdEnoMyNN8ic0mE0GG+CE5fVcwdhs+2OcWXEdR4K3RPmVwMR4/hDj52MJZge/KkryfdUqt/vIUWD8OXhI/PV3bnBfN/cV7y8j9f1Tg2wuN/vlcToh9bXG7DI+52RtdjC8+Ozsfn42/uDn/PH/2Zf788+F4PP6HyMR9q9g2NmEuKgzRb1/i/nNnqz/hns2pWgKtooBSefGg9bjrNpl49lhjXZuWQiN1DUvSAZbO6DoDqwg9QXArwBqlBoWB3B/YaeSccR8H6WmRHQ6c1EpqetdP1btn4/G78x0Izx+CcKUXqGQVt+SNmZP+czM9vD6k6x/WWCaleC6Okj2UpyQ9lZ2TYSXyu7W4P0Mrz9J5fjfdTDPBwBre8tb4GDGGRuRidLL0PbkFOR+9nHTNEuua3DddEYO+7IKB7005T5l1TolcNCFYn49GC+lC8jT0yazpimFp2tHEIW+w17iYoxsZS3p0PhwPx2KTrU+ceNRVYe6HrORlrRUWPvpAK0eL8+H5IzZo7ZP0qTt7qokPWEtd/ze76b4k19w2qTOOCrPrD7TyO1qJrK/7oVYmJKPfEKapzgR34w/7t/lF31PHD+HhZn24WAW3k9QzE6PYttUbS/pa1jrWN2ZxSjJuSZWmJX7lQ0MwGPQmH/75n53VYACVKbuWdIjjM3yr3+o3nQNrluRmnQLUFcwU3ctCUTSjNp7tiIonbBV5r1YgdaDaMaGoZC0DKmDAeUWUaLGQSvLUsZphawcHg+uHcNtQaMjx0SeOAKGiBSkeVsAumBYDu+rjhaVx8xlTpgwQis5LTd4D6QZ1yYp9STMwDlAD6UDOOukJfHActUyxGR0clgFa1FgT+87gEKyKlORBA2eKzgfwRnUxZOCFbhxV0CekiSofQXxxb/kIWFqa1jpquP8WBHUnK/IZlKYi8LEhOAVdQUE+gOVYZEmenXZamXIeC8ijCNbwzpOowMyOYmTz4FB7fnRTLH0NdoBZZ5iVUApwMPjRE1f4ldRznw8Gb/UZ3O366pYKLwNN/9rP0nK5fDBDnx7bvJSBV84PZI2XwbjV3rqWoV8rh052H5Knl6Qp9s/BVO19VKb0D8eYpaOGlB1dU+AO8aPLyVV8Jj6FDz//C14ROg2NWaZuLTtHagV1fxUjlyqfYNtteZiZ2HgNI16m5tvy7B7B2wbDh5//7eE1LUHq7UhxKoPBpCuULOGGWstvoB8M8p70h14GocEAJWooCHyD3EoLiYBgk7WSej6ES72CzpODpQxNbAaWR7ujNBiXXbk9FOipAqOjRX/ncB8Ry1tPakGefWkTOAyqJFPY0DjT1em2w2C2yTmaSaXgVlY1hZjbZVWB3YqXScyAH4RDMx6I0NAK0BF40mEIkxOTeNJZaxxHIVPwM8PfjbgApCtrpA4+h8rhLOz9Z/tGj++kNPoRUYIQd3BkWze7kqRJ3Ga8kw7f8nY/eRGO962jGTm+MKa9r4uV23a669sSuFt/T1tHymx0wDLSH2pRqvQ0/e3UT6Qi5Fr/ZnZNbiFL2j6PvzLRo6g8EplQsiTt6YDiXL6cvILFZ8PxEYf4H4Z79Orq6xevr19wMLxIE2A9l4gsp0V9cNPRl+PTl229p36/7Zv09iUPdB9GVqGMfC0mtN5Srbvj79fTTDTMxPI7sV7zVP3o1GbD4p86ckzjpplYoJNY8ON8N91kPQlgbjanFeeUgj674dtZXXWJT5xwV2YxyeKyLMmGj+oeksXJm+sbkYli+xtAayq2cbjk3wdwyUSCf0WIL1f8Cs+ytVCo6w5r1k0+mbfw2jsmPfNIerb/cFb9kV4dRHjMhlIa/JeTetRgvU6EarPZ6aejX7XYAttrc/Wmm83mF5v5G24=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,I={},u=[];function y(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,a.jsx)(i(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(p(),{parameters:void 0}),"\n",(0,a.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,a.jsx)(j(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/03e06346.07e3d435.js b/assets/js/03e06346.07e3d435.js new file mode 100644 index 000000000..5256d8b02 --- /dev/null +++ b/assets/js/03e06346.07e3d435.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kt2AhLPdUXRR3mxMYubWts7Wgkho517JIcDroquxtiFVAGUGy2GR0xD/MH+7Sv82n+ko1MAHX0QVIi5ZEnyg8yu3AlEpmJPJB5FVk+M9HBcfQO8iLjFkx0GkcpmESLwgolo4Po3RzYUTnJRMJCL3Z49ILxLFMLw0oD2jCrWKIBm2yYidk5t8yAvgDGDZtkJRRaSGvYVGk2AwmaWyFnLFVJmQM2LISds0JDClMhIWXG6jKxpQYzYD/OQTJeTc+EYaZMEjBmWmbZ0i+fxszOHXwabKmlYZyVUvxUAuv1wuAzkfZ6jMuUcdbrFbS5s1Jnvd6A4Xbb33Ap9ztbMk5LikkGND7nSzYBZuZcQ+rg53JJSIkZSD7JcId2DjmiyG/aDTViJht7n3ADKVOS4A+ADtgPagEXOFnzMxPWQDZlCZdSWQQgV6mYCkiZnWtVzubMzoVh79+8/D0TFvsxJTMCtcRl8ATC0g5zQskKKiFngxN5It+J4oC9LzLFU7ZUpWZH3/2hHmYVw2/Hvd53MCln7P2LXu/0wdzawhwMh7woBqoAifNlfGIGicqHKXYs0unDmC3moAFnJeCAG4HITRGH6QysoQ1LlqhiyRKldCokElXMCj4DJst8AtrE7gyUBiaQODTwdNm3ql8aYP/59vUr3GjO7YAdZaWJq+VSoSGxSDQ4PWI27OordxBP9pH2hJzFLOfneITCsp9KkZzjtg3IFP/vKY1w1eu9LYtCaQsp+9Ft4aDXw5ZvIFMLxjVQ/0TluZKs4JrnYIl1kE2wWcNPpajJKMsCLg5OZJ/1epLncNDrsfeOnEUK0uKhazpOOnA3YOD622VB/V/IVCSeI4HhV6am7a6IVOz6toAEp3RdG6hGwlzMRTInHC64O/8i44nblgZTQGLFBbQnvozZEif+DqQKEMyVFj8raXlGx3cB2oqEZ81jRgCxq7Fck4wolJA2fPUrsP/2x4mnTYfo6RBBSxG5uZDUYoBd8KwE46FaxGyOUL2BQoMh9vPzEv+mbA5iNt+5Hk8/lMa2Jmal8YxeQeHXCqdK6AVC25RnBpiYtnCZ83NorMYUyV+eDdg3S5bClJeZjZlACrW6hAF7pSzjRZGJhKM0QhpAZuMoL/t0yp58Bm3yOdLqQqSAgjEV0yloZGZspCn8mAAd0mVBA3B7xGl2TtJk7aATlSm9SUL0uY1HlihpQdoBO7zgIiPg3WYNEzLJyhTYJOPJeUx3Rsw0SnU8lSXglRM7/qAueLE4nBN+mIEMqVBJhF8qvzxeFR6qFAU8yvPAf9gYUE2LCNPEqufyqcKVEQWBJRnkXGQxIS5mH9SEWWEziJHBCy6XMUu5hZhZuLQTdRmzZA7JOf2leSoUm5TWKuk2lmpVpGohPS6nSlojft7CkaHl4zG6F7P9mD2J2bOYjUcxG+/FbLwfs/GTmI2fxWxvFLO9vZjt7cds74kDa++ZxzWvENwEYLznsGx/O9hFOf1SGOJsFLCmktmLlsweD1ivV3ETfvvLX/5yIq9OJGMnETLXSXTATqKqy0kUuzaUmdg29r8v8cejvaf+5xJ/Ptl75n8uqOt43/+c48+98Ylc+QVP5B5BYnleXAMFNt8rBP6XJyL8RovityDP8CMKojg04Fm14MGGVXMvj3AvQgoreGZ2byf0+IJ2VIO0sal93BSR6+4dUfMXtJ0mPNhCYtI1kVhtNAWGJyj2Nnb/eOBvlt2bd8t+MXtvgHO3rT/BraNoeoeiaff+K+n1BSFhHaa7YeLpgBQAksy78eA7fEFYaEN0Nxw8QxzgpbQbAdj6Be2+AQ42+BvetY32++PH/b3R3n4LA2hLuQ553k/T/nK5vA/soc7jl0eVJ2ioTrNDc3eqVb7F/CDroO7ldSL6O6jsf0JFfRJ0WEjRTiTDImgslYXY1LKtSvnyK+OmCkMr5Qz716rZsgEmNSEcZC0ncyUSDzz2CSrZBA3CAeKgT5gcpumwgUn8mKb9PO+vfcSffUJ842OeD9J0sNZz43Tcx5ylacw2P2/9nqYsz/Mdn9331udhnm/uYpDnHjZSvr4ekBOGdLbdfOI7/FqsUnNEe+Fr2Qg9DehRwQYy57bz0dplMxfSN3iiYmsdNMzKjGu4RLvUCCVd7/vnscBitWZPdqz3JEBQrNmD1157f+jJH7fQngC/3DxuY2c4ySFLSmNVzjTM4JIV3FrQkia74JlInVuqTx/gkucFmgDDP5+cpL/71yE5INDGt863lYqZQL/R8M/Hh/3/Od3SoywK0Ak3wDLAlUzMwCYDdjyHrKhdV4vFYrB4ZJK5UpnzW30wGqbu3zM1+XBG4BYDboqH23bqSKNh8CPprNv7BmwLY9ywMHKLyU80Rjw0HtFt6+2da65b3+MLunHWQMJG5z3B5uOTKOekkCApQ/23snPQJ9FpNcYZ+ZDeMPb0Fsw6FylkfALZZtOtGa36nPGlKj1/B6dWe6ueoht4w4ZcyMpvQdsZxY1GfrnW6NpWW/jbIaTJneHKCewZToBlwgTPTRudzdHetUUOSglAPk90dvsBbFJR6Z25oALsdmzgJJE/uxuWwH6MOlZuxbDaDSu0DqaJGJwjF1LkZV75R6fVrAFludc9mvjCkRgcCCs0T3djBX55wwrojNy9wIkckx8j+D+u0Ux9jy9IVqyBdD0bf4oUad3T93TB3syAYVtNBtxyLWNXdyFXzGd2c9+AvcbrDX2ybhB62ZIECoseubuyZgXyrW8o8lk1/XC7Ka/Z6wuivi1gfWYK9P3u+/b5JCJt7v43RKgtsG9NrM4pmfPZNZY7NX9B5Onh2XBCjMkZ6e6Laxxy1H79dsaj1nYet7fzZPQJ1lVr2bsbV6PqY21VPZcYc9hYCO3yMuNB1N+HpPdTImV+q/KitE1WIIuf2D3c3SGq5qKEv4tZP2a9mA1j9iBmDwfsDVAcLqlidv4qF9pF5gS+FCgxZJKUGuP4micYDIfBbMCurn4qubTCLlcr1mNXV/jEYLUaIG+cS7VwYbvjC2GEZRh2r02dVCVmS5heJWaINtHwFSz63/nQ+NCD9pA9UGuMeq1h6VHwsZbkrmGf2bzCCNGRhqnIskYcn4VP4XgwLgoZ5D527CP4qC9SNElIqxAF4a1ErzeBqcJIEj4kwHhk88GIU9icbGw+RnAvM5Rmc26cIUuWM24PX0rgqxIf03qlLLiAtimUNOBkebEF6Dog3eutBcRCtzooJmTYOEqT8f15b/a+HjXFy/jJ45a0fNyWL6Nd8uUa5w1KEYeL4PGGuqnB+SR/wvdNtl/n+zApIttJm0BkjvpUmaUsE+cU20yFKTK+RLIId6WHcj1o/u1cKVP38HFrz2fmoB0PVxpD4g8HVXjwrm7n8dNHLWH/7B58aWve5fZhjPaH48fDa93La07Rj5fXjN3m5Mhve6uTo5710XVu4E91A98P4T+6Ty/Y+OleS3l7NLo7A9yTs6vJODe4ue7DmXVvXqUmu93Sn/Sr+XXuTn37n8PCXRPDT8f3IIZ3GLJ3pcQNe/XeaI/dl7G6jQBvYa1ea6LemUCbwH52In18P5bteNTS1b5uqWpf7zWJ8vHjWxFlc9E1yjqJxH998/rNYvTH72fq8PDw8NXb9/Pn72eHh4c5/h4MBludGttOm5ZBHda/6PX3Mt3xO1YZDAaIwpRbfkDDh4Wc/d6Nj3ePGfjXIJ/J0/r4PoKbWxyqd5cCVddf56LZ5j39fHx+Vw6M4kgVlOSg5Is0OohcEkF4xB/F5AEBY79R6TI6uIr8M0780z+SxKHDDwbzMK4ik8wh5/hXMOEwc2MqMpwKDXjQJoojeteDaRxIddFBpCYfILFRjDHnAh2DYHAOGndwFXq55+5R7NXw6CByVB/FkY+8Vp8YyEThW4oinUarsOB1U1Vf6qkM/VFlNOA8+EL8E6ehoau1zJVPmqk5w6pGaz0Z15ovo/UkmfA0PMT13bjq7Wu2DJeDsOiKqN4rU7cojoSFvLnKjkPT6uMxnYDCndCbv48dS8fC849eE8cVcyU/aaB/lvUpQz+oydknkSMO9v6PLWd9y9NxrZsLt0nlEB87Qxq04X79aj9m9HJ2cBOlhv6EZT5rrum8ZhtrvtuVzdF4RG7mZALzogCuB5RU8cn5PZQPxrOkpGylShy3dlaBWu1svIqjy5s3c8kS1Q+pIuxBBlPrnnawRGkJ+mHzvdgXs7m9/f1VHC1v3t7yN7m9p3h4i5t39yPl2NT5R/8IWB89W8XR/GZYf6iygP6BwO4/WdV3bOSyHKs8xolKl2dBbq1u6hguM+yHOWwv5Gudgm4gYqJUBlxuYOLF1DnUFfsKLZ2vYvegipI3hDbhImMLdDdrSAATweidZZBVzOs6LrOD+Qf16Ix/jh9IPTPlxGAvGeYzbsIJMKvFbAboMvc9aLBPTwGezDEpzz/z4tPg3Ss0XAhVmgAe+tHxdsnAUqokxldCwmPLGmtgh7z1zb0PmqeDX/ByxUxPeP3u6Ba4JFOx7/L1nH7gdunmYK/fHWFKnJh69W/A3psKEwG1vNWFoTrGLgQPaTOVbF+6Ryjg/J3K5Zw2QwwDn4zWZ5sApcJshSh2qb8YyaqSfzcmrnMs8YhUaTFkIXwmkLFQmBYeCYoKke9UeRuqvAGTnM1KevNrkWVDfhw9+6tT2oR0ScZkZ6SlDll8niywJyb81ngKWMFOjfkx29e44ZxNubGYs1tKgZjXJVoV1ZRwWYAWGO3bigINDnWYfHyzNtHOD3v/5qXPrA17CEw5QQ50E0PKyoKohjihylsMJ7e+9Q1FCbkD9NkuxXBT9aAYpneBFKCNkmgmKT3jUvzsSJg0ErSyJjDnmevqRQW6yhEe5PA2MEHW/vK3vzfg2qnpbgLmVuBpio9Sb4CQTElH8KjpayhQAqo2RDgf6P9YvwQQOmKaM5eo7RjJ3J7Gj+gZq6nkog8BViFIUyZzNCwqeWviIGONVysN2aZkwFIMscD9wqUwtpF5F97Hb8qHN4B4TBowkBqCXI00L5dNBq9Do2ptOsoPFO2szeoa3OAFXlp1piEX8nb3VNMbZ1UlCEqrcm5FwsJUZtDOxXUhn8DXOXsQQENqvBBKP9zBqjjdmZIJnAl5hon6t1DwXlXv+VK+ROK2CwDZhC0gyV1ndb7kgmogNHHSuJ0oK7hFjI9jpLsc9AzOEjRTiPDgFnjs9XC2Xo/1HSxerJpSe5eKT2Un+YGipJ4dIfJJp1W2RX3nNisINIobFBngs2w04938iFJGkPuKDs0V6rIHBjDVFCeuwms5F3VZBR/hpvOi3bxwVnjiPDo4C6Ze4zrxdXsKIrRKI+GYPh1WdxzhNoduFcYzRSxl57UcTttAvaDM2TldQXSE6AJ264R0drWQoH/56/8ZCuS79yFmgFvY2Uohfp4Z5dJym7MGig407xxUGyTt3wxsM3av93gEAeJ0DyrqkE/w9Rc9fCCNim4aVTs92tbzZzO/r7OlfTy+s6R/Q6bmeDT6Z7akH41+O5b0/ug3ZEk/Q2C90/5mabJLu90qO0IQ4voBHxQ4/2am9PU90be/iquQyTYE1+ywt3L/1cZ/EOI3OAScx6AOJnhjNmyG0LA3GuH/1oRgqEPkiy61KjH9SxTfPpJxg0Sv6zVdj6/Di2dHeSHzZE6SvCredP2oJrH5r0RnbjyS3r8HCET6b+01cjCmfWFsWcCXzbLXo6t5SkJmQsJZOIKztZCRO+b9bWfyVuXg9IkFGnELrbB6kVesrF4yPkPNCKfR93hEoPVNxPxxkF2Hjf3R6GxcIeHxJhJeSMqyovpf79Q5yF93p83lrVseQb3Ms1qiRMJ1ovaotdnmd7dJA0mphV1GB8dX0WWfF6Lv2g+OT1enSIV2rii0qAxBzO08OoiGG5FGKsOGcazjDbpZcPSs/VBOCOzD0ir2J5Wcu70RD1WMciG0dTMNjBs2LyfEMkeaIzW/4hfnXA9Rcg/Hg9FgFK3iq7VJDJcpvtHZEO+8EMOL8WC8ZczW6+Ca/lD2P3aIsXwm5Oymcaf1obxFwnG00TqaWn8txB8BFVh/8s1ecSQQ+3PgaNniWSM9vqkDws8DVYVQ7bboa0096/HUEE5tRUjXr+UtMc9GyPM4xBsphFhFEKN6Q1EV5YuiRtwOfzQicfizUu6Pa/6pwlhB9x6T0rq3v0/a3dMxqUGPnpGGsf9kdeqQ3/BbU9ZA0/nqXh61vIj+U9urFkVrXqyWK2ndk7TTq7PDqeOXXHNeVIBs8xmgrb7VVPejGmbZFlQGTaSNSHy4g4h8NCJE7o8Ikc9GLSXIb7+eoVZlSF+p1BXSSZoqCeodp0i4Qk4VUb0/7tcFyLfoD0Z5QlyzobpClqi8qv/U64Uhv/zt79WoXq+ymJ0jHM3m16VmhVqAnpauoNQ0g0uqxojDIKc2QzY+JQHwPANjMPwuLczIWKc8cXRCezdnwgs+EZlAOe8e7tOz3cZV4apPUj7HUpVfaZfdcAEZXg+Vd6lRyZItlD6fYnnMmHE2wawP9C+CnHOZOFemEyHkkkNTGd3EhRYGS95phFo42JS0mieW5VzyGfnUYtZEVgqZQMHOtJqgp9+orHS+bMtFprR7ZEkbolcwhMTnlwU2kf6NTKthjoR94R3aJnYBBScdfJHFCcZuCoRFoJ/BKlbKTGE9RIwBlVnGCmVdXAbV/CaMONxqLg3q5g6WcAYVwryvGYz32Lw3gCf8UshzV5Orz44ruvoRJkZYaGfsrzPnw/aY74XFK+4NFMoIq/SyHj0TNlxjzUmqH26m70PtzoYUv30izVuwSCFmeHj0ghSTh+yXv/4vewlcSzZXC0etSakhW7bLhLqTd2ir9AqKZvASS2RaIlI5CwG2gMEf59ySe+gVLNAP51jKvWxaK+dqer0D9u3W8q0hw9ilq2CIiftaqCwT8nzADn2109rbhd9p3CdUO33XWB1yA9kFmIa7D1JhWzVOoQWM31w7ewf3dpimG8kw6PKtwXFOKoqYceetwqKhW/JnWskx7eJ1IFMqU2kOWKr51Nbzx5vFVrd8CtlAAR2xn6Y6EseJRduoMM6Rt6aBtOUtOQhxQdOuQlsIT07HgSxZuxTGx5O1M3Cl5Qkp3OEG5YXYGhTBIp3m9fQt6AuRBJtsB0cPqfMwiqNMJOCtbX9/HX5/9JJdPBqMWjrrLZh7+PLFt89fvX2OwKAgdQgLuivp1TmXjZXWeGf9bmu84usqJ3eVk7vKyV3l5K5yclc5uauc3FVO7iond5WTu8rJXeXkrnJyVzm5q5zcVU7uKid3JTO6ysld5eSucnJXObmrnNxVTu4qJ3eVk7vKyV3l5K5yclc5uauc3FVO7iond5WTu8rJXeXkrnJyVzm5q5zcuYG7ysld5eSucnJXOXmX2O4qJ3eVk7vKyV3l5H+KysmNzMZhkXFBqdI+o99lOR+v11M+jaM5pkEfHEdXV0h573W2WuHnn0pKsjw+jaMLrgW+oKQM6jjk32Iu5TlgHua37kFo/x2uH7uDpvyVtcRxTCB2Iw5p79f2bWZqH71++y6Ko4mv+ZyrlAo+8AXmXvKFy01tJGjSt6so43JWUnJn5OZcufJY83a+8TnlG/s/GhmimJdbQ9hORHbbwH9xU1sHXF25XObVqurvmnaO8IgNvfH8Tler1f8DhTxuiA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kt2AhLPdUXRR3mxMYubWts7Wgkho517JIcDroquxtiFVAGUGy2GR0xD/MH+7Sv82n+ko1MAHX0QVIi5ZEnyg8yu3AlEpmJPJB5FVk+M9HBcfQO8iLjFkx0GkcpmESLwgolo4Po3RzYUTnJRMJCL3Z49ILxLFMLw0oD2jCrWKIBm2yYidk5t8yAvgDGDZtkJRRaSGvYVGk2AwmaWyFnLFVJmQM2LISds0JDClMhIWXG6jKxpQYzYD/OQTJeTc+EYaZMEjBmWmbZ0i+fxszOHXwabKmlYZyVUvxUAuv1wuAzkfZ6jMuUcdbrFbS5s1Jnvd6A4Xbb33Ap9ztbMk5LikkGND7nSzYBZuZcQ+rg53JJSIkZSD7JcId2DjmiyG/aDTViJht7n3ADKVOS4A+ADtgPagEXOFnzMxPWQDZlCZdSWQQgV6mYCkiZnWtVzubMzoVh79+8/D0TFvsxJTMCtcRl8ATC0g5zQskKKiFngxN5It+J4oC9LzLFU7ZUpWZH3/2hHmYVw2/Hvd53MCln7P2LXu/0wdzawhwMh7woBqoAifNlfGIGicqHKXYs0unDmC3moAFnJeCAG4HITRGH6QysoQ1LlqhiyRKldCokElXMCj4DJst8AtrE7gyUBiaQODTwdNm3ql8aYP/59vUr3GjO7YAdZaWJq+VSoSGxSDQ4PWI27OordxBP9pH2hJzFLOfneITCsp9KkZzjtg3IFP/vKY1w1eu9LYtCaQsp+9Ft4aDXw5ZvIFMLxjVQ/0TluZKs4JrnYIl1kE2wWcNPpajJKMsCLg5OZJ/1epLncNDrsfeOnEUK0uKhazpOOnA3YOD622VB/V/IVCSeI4HhV6am7a6IVOz6toAEp3RdG6hGwlzMRTInHC64O/8i44nblgZTQGLFBbQnvozZEif+DqQKEMyVFj8raXlGx3cB2oqEZ81jRgCxq7Fck4wolJA2fPUrsP/2x4mnTYfo6RBBSxG5uZDUYoBd8KwE46FaxGyOUL2BQoMh9vPzEv+mbA5iNt+5Hk8/lMa2Jmal8YxeQeHXCqdK6AVC25RnBpiYtnCZ83NorMYUyV+eDdg3S5bClJeZjZlACrW6hAF7pSzjRZGJhKM0QhpAZuMoL/t0yp58Bm3yOdLqQqSAgjEV0yloZGZspCn8mAAd0mVBA3B7xGl2TtJk7aATlSm9SUL0uY1HlihpQdoBO7zgIiPg3WYNEzLJyhTYJOPJeUx3Rsw0SnU8lSXglRM7/qAueLE4nBN+mIEMqVBJhF8qvzxeFR6qFAU8yvPAf9gYUE2LCNPEqufyqcKVEQWBJRnkXGQxIS5mH9SEWWEziJHBCy6XMUu5hZhZuLQTdRmzZA7JOf2leSoUm5TWKuk2lmpVpGohPS6nSlojft7CkaHl4zG6F7P9mD2J2bOYjUcxG+/FbLwfs/GTmI2fxWxvFLO9vZjt7cds74kDa++ZxzWvENwEYLznsGx/O9hFOf1SGOJsFLCmktmLlsweD1ivV3ETfvvLX/5yIq9OJGMnETLXSXTATqKqy0kUuzaUmdg29r8v8cejvaf+5xJ/Ptl75n8uqOt43/+c48+98Ylc+QVP5B5BYnleXAMFNt8rBP6XJyL8RovityDP8CMKojg04Fm14MGGVXMvj3AvQgoreGZ2byf0+IJ2VIO0sal93BSR6+4dUfMXtJ0mPNhCYtI1kVhtNAWGJyj2Nnb/eOBvlt2bd8t+MXtvgHO3rT/BraNoeoeiaff+K+n1BSFhHaa7YeLpgBQAksy78eA7fEFYaEN0Nxw8QxzgpbQbAdj6Be2+AQ42+BvetY32++PH/b3R3n4LA2hLuQ553k/T/nK5vA/soc7jl0eVJ2ioTrNDc3eqVb7F/CDroO7ldSL6O6jsf0JFfRJ0WEjRTiTDImgslYXY1LKtSvnyK+OmCkMr5Qz716rZsgEmNSEcZC0ncyUSDzz2CSrZBA3CAeKgT5gcpumwgUn8mKb9PO+vfcSffUJ842OeD9J0sNZz43Tcx5ylacw2P2/9nqYsz/Mdn9331udhnm/uYpDnHjZSvr4ekBOGdLbdfOI7/FqsUnNEe+Fr2Qg9DehRwQYy57bz0dplMxfSN3iiYmsdNMzKjGu4RLvUCCVd7/vnscBitWZPdqz3JEBQrNmD1157f+jJH7fQngC/3DxuY2c4ySFLSmNVzjTM4JIV3FrQkia74JlInVuqTx/gkucFmgDDP5+cpL/71yE5INDGt863lYqZQL/R8M/Hh/3/Od3SoywK0Ak3wDLAlUzMwCYDdjyHrKhdV4vFYrB4ZJK5UpnzW30wGqbu3zM1+XBG4BYDboqH23bqSKNh8CPprNv7BmwLY9ywMHKLyU80Rjw0HtFt6+2da65b3+MLunHWQMJG5z3B5uOTKOekkCApQ/23snPQJ9FpNcYZ+ZDeMPb0Fsw6FylkfALZZtOtGa36nPGlKj1/B6dWe6ueoht4w4ZcyMpvQdsZxY1GfrnW6NpWW/jbIaTJneHKCewZToBlwgTPTRudzdHetUUOSglAPk90dvsBbFJR6Z25oALsdmzgJJE/uxuWwH6MOlZuxbDaDSu0DqaJGJwjF1LkZV75R6fVrAFludc9mvjCkRgcCCs0T3djBX55wwrojNy9wIkckx8j+D+u0Ux9jy9IVqyBdD0bf4oUad3T93TB3syAYVtNBtxyLWNXdyFXzGd2c9+AvcbrDX2ybhB62ZIECoseubuyZgXyrW8o8lk1/XC7Ka/Z6wuivi1gfWYK9P3u+/b5JCJt7v43RKgtsG9NrM4pmfPZNZY7NX9B5Onh2XBCjMkZ6e6Laxxy1H79dsaj1nYet7fzZPQJ1lVr2bsbV6PqY21VPZcYc9hYCO3yMuNB1N+HpPdTImV+q/KitE1WIIuf2D3c3SGq5qKEv4tZP2a9mA1j9iBmDwfsDVAcLqlidv4qF9pF5gS+FCgxZJKUGuP4micYDIfBbMCurn4qubTCLlcr1mNXV/jEYLUaIG+cS7VwYbvjC2GEZRh2r02dVCVmS5heJWaINtHwFSz63/nQ+NCD9pA9UGuMeq1h6VHwsZbkrmGf2bzCCNGRhqnIskYcn4VP4XgwLgoZ5D527CP4qC9SNElIqxAF4a1ErzeBqcJIEj4kwHhk88GIU9icbGw+RnAvM5Rmc26cIUuWM24PX0rgqxIf03qlLLiAtimUNOBkebEF6Dog3eutBcRCtzooJmTYOEqT8f15b/a+HjXFy/jJ45a0fNyWL6Nd8uUa5w1KEYeL4PGGuqnB+SR/wvdNtl/n+zApIttJm0BkjvpUmaUsE+cU20yFKTK+RLIId6WHcj1o/u1cKVP38HFrz2fmoB0PVxpD4g8HVXjwrm7n8dNHLWH/7B58aWve5fZhjPaH48fDa93La07Rj5fXjN3m5Mhve6uTo5710XVu4E91A98P4T+6Ty/Y+OleS3l7NLo7A9yTs6vJODe4ue7DmXVvXqUmu93Sn/Sr+XXuTn37n8PCXRPDT8f3IIZ3GLJ3pcQNe/XeaI/dl7G6jQBvYa1ea6LemUCbwH52In18P5bteNTS1b5uqWpf7zWJ8vHjWxFlc9E1yjqJxH998/rNYvTH72fq8PDw8NXb9/Pn72eHh4c5/h4MBludGttOm5ZBHda/6PX3Mt3xO1YZDAaIwpRbfkDDh4Wc/d6Nj3ePGfjXIJ/J0/r4PoKbWxyqd5cCVddf56LZ5j39fHx+Vw6M4kgVlOSg5Is0OohcEkF4xB/F5AEBY79R6TI6uIr8M0780z+SxKHDDwbzMK4ik8wh5/hXMOEwc2MqMpwKDXjQJoojeteDaRxIddFBpCYfILFRjDHnAh2DYHAOGndwFXq55+5R7NXw6CByVB/FkY+8Vp8YyEThW4oinUarsOB1U1Vf6qkM/VFlNOA8+EL8E6ehoau1zJVPmqk5w6pGaz0Z15ovo/UkmfA0PMT13bjq7Wu2DJeDsOiKqN4rU7cojoSFvLnKjkPT6uMxnYDCndCbv48dS8fC849eE8cVcyU/aaB/lvUpQz+oydknkSMO9v6PLWd9y9NxrZsLt0nlEB87Qxq04X79aj9m9HJ2cBOlhv6EZT5rrum8ZhtrvtuVzdF4RG7mZALzogCuB5RU8cn5PZQPxrOkpGylShy3dlaBWu1svIqjy5s3c8kS1Q+pIuxBBlPrnnawRGkJ+mHzvdgXs7m9/f1VHC1v3t7yN7m9p3h4i5t39yPl2NT5R/8IWB89W8XR/GZYf6iygP6BwO4/WdV3bOSyHKs8xolKl2dBbq1u6hguM+yHOWwv5Gudgm4gYqJUBlxuYOLF1DnUFfsKLZ2vYvegipI3hDbhImMLdDdrSAATweidZZBVzOs6LrOD+Qf16Ix/jh9IPTPlxGAvGeYzbsIJMKvFbAboMvc9aLBPTwGezDEpzz/z4tPg3Ss0XAhVmgAe+tHxdsnAUqokxldCwmPLGmtgh7z1zb0PmqeDX/ByxUxPeP3u6Ba4JFOx7/L1nH7gdunmYK/fHWFKnJh69W/A3psKEwG1vNWFoTrGLgQPaTOVbF+6Ryjg/J3K5Zw2QwwDn4zWZ5sApcJshSh2qb8YyaqSfzcmrnMs8YhUaTFkIXwmkLFQmBYeCYoKke9UeRuqvAGTnM1KevNrkWVDfhw9+6tT2oR0ScZkZ6SlDll8niywJyb81ngKWMFOjfkx29e44ZxNubGYs1tKgZjXJVoV1ZRwWYAWGO3bigINDnWYfHyzNtHOD3v/5qXPrA17CEw5QQ50E0PKyoKohjihylsMJ7e+9Q1FCbkD9NkuxXBT9aAYpneBFKCNkmgmKT3jUvzsSJg0ErSyJjDnmevqRQW6yhEe5PA2MEHW/vK3vzfg2qnpbgLmVuBpio9Sb4CQTElH8KjpayhQAqo2RDgf6P9YvwQQOmKaM5eo7RjJ3J7Gj+gZq6nkog8BViFIUyZzNCwqeWviIGONVysN2aZkwFIMscD9wqUwtpF5F97Hb8qHN4B4TBowkBqCXI00L5dNBq9Do2ptOsoPFO2szeoa3OAFXlp1piEX8nb3VNMbZ1UlCEqrcm5FwsJUZtDOxXUhn8DXOXsQQENqvBBKP9zBqjjdmZIJnAl5hon6t1DwXlXv+VK+ROK2CwDZhC0gyV1ndb7kgmogNHHSuJ0oK7hFjI9jpLsc9AzOEjRTiPDgFnjs9XC2Xo/1HSxerJpSe5eKT2Un+YGipJ4dIfJJp1W2RX3nNisINIobFBngs2w04938iFJGkPuKDs0V6rIHBjDVFCeuwms5F3VZBR/hpvOi3bxwVnjiPDo4C6Ze4zrxdXsKIrRKI+GYPh1WdxzhNoduFcYzRSxl57UcTttAvaDM2TldQXSE6AJ264R0drWQoH/56/8ZCuS79yFmgFvY2Uohfp4Z5dJym7MGig407xxUGyTt3wxsM3av93gEAeJ0DyrqkE/w9Rc9fCCNim4aVTs92tbzZzO/r7OlfTy+s6R/Q6bmeDT6Z7akH41+O5b0/ug3ZEk/Q2C90/5mabJLu90qO0IQ4voBHxQ4/2am9PU90be/iquQyTYE1+ywt3L/1cZ/EOI3OAScx6AOJnhjNmyG0LA3GuH/1oRgqEPkiy61KjH9SxTfPpJxg0Sv6zVdj6/Di2dHeSHzZE6SvCredP2oJrH5r0RnbjyS3r8HCET6b+01cjCmfWFsWcCXzbLXo6t5SkJmQsJZOIKztZCRO+b9bWfyVuXg9IkFGnELrbB6kVesrF4yPkPNCKfR93hEoPVNxPxxkF2Hjf3R6GxcIeHxJhJeSMqyovpf79Q5yF93p83lrVseQb3Ms1qiRMJ1ovaotdnmd7dJA0mphV1GB8dX0WWfF6Lv2g+OT1enSIV2rii0qAxBzO08OoiGG5FGKsOGcazjDbpZcPSs/VBOCOzD0ir2J5Wcu70RD1WMciG0dTMNjBs2LyfEMkeaIzW/4hfnXA9Rcg/Hg9FgFK3iq7VJDJcpvtHZEO+8EMOL8WC8ZczW6+Ca/lD2P3aIsXwm5Oymcaf1obxFwnG00TqaWn8txB8BFVh/8s1ecSQQ+3PgaNniWSM9vqkDws8DVYVQ7bboa0096/HUEE5tRUjXr+UtMc9GyPM4xBsphFhFEKN6Q1EV5YuiRtwOfzQicfizUu6Pa/6pwlhB9x6T0rq3v0/a3dMxqUGPnpGGsf9kdeqQ3/BbU9ZA0/nqXh61vIj+U9urFkVrXqyWK2ndk7TTq7PDqeOXXHNeVIBs8xmgrb7VVPejGmbZFlQGTaSNSHy4g4h8NCJE7o8Ikc9GLSXIb7+eoVZlSF+p1BXSSZoqCeodp0i4Qk4VUb0/7tcFyLfoD0Z5QlyzobpClqi8qv/U64Uhv/zt79WoXq+ymJ0jHM3m16VmhVqAnpauoNQ0g0uqxojDIKc2QzY+JQHwPANjMPwuLczIWKc8cXRCezdnwgs+EZlAOe8e7tOz3cZV4apPUj7HUpVfaZfdcAEZXg+Vd6lRyZItlD6fYnnMmHE2wawP9C+CnHOZOFemEyHkkkNTGd3EhRYGS95phFo42JS0mieW5VzyGfnUYtZEVgqZQMHOtJqgp9+orHS+bMtFprR7ZEkbolcwhMTnlwU2kf6NTKthjoR94R3aJnYBBScdfJHFCcZuCoRFoJ/BKlbKTGE9RIwBlVnGCmVdXAbV/CaMONxqLg3q5g6WcAYVwryvGYz32Lw3gCf8UshzV5Orz44ruvoRJkZYaGfsrzPnw/aY74XFK+4NFMoIq/SyHj0TNlxjzUmqH26m70PtzoYUv30izVuwSCFmeHj0ghSTh+yXv/4vewlcSzZXC0etSakhW7bLhLqTd2ir9AqKZvASS2RaIlI5CwG2gMEf59ySe+gVLNAP51jKvWxaK+dqer0D9u3W8q0hw9ilq2CIiftaqCwT8nzADn2109rbhd9p3CdUO33XWB1yA9kFmIa7D1JhWzVOoQWM31w7ewf3dpimG8kw6PKtwXFOKoqYceetwqKhW/JnWskx7eJ1IFMqU2kOWKr51Nbzx5vFVrd8CtlAAR2xn6Y6EseJRduoMM6Rt6aBtOUtOQhxQdOuQlsIT07HgSxZuxTGx5O1M3Cl5Qkp3OEG5YXYGhTBIp3m9fQt6AuRBJtsB0cPqfMwiqNMJOCtbX9/HX5/9JJdPBqMWjrrLZh7+PLFt89fvX2OwKAgdQgLuivp1TmXjZXWeGf9bmu84usqJ3eVk7vKyV3l5K5yclc5uauc3FVO7iond5WTu8rJXeXkrnJyVzm5q5zcVU7uKid3JTO6ysld5eSucnJXObmrnNxVTu4qJ3eVk7vKyV3l5K5yclc5uauc3FVO7iond5WTu8rJXeXkrnJyVzm5q5zcuYG7ysld5eSucnJXOXmX2O4qJ3eVk7vKyV3l5H+KysmNzMZhkXFBqdI+o99lOR+v11M+jaM5pkEfHEdXV0h573W2WuHnn0pKsjw+jaMLrgW+oKQM6jjk32Iu5TlgHua37kFo/x2uH7uDpvyVtcRxTCB2Iw5p79f2bWZqH71++y6Ko4mv+ZyrlAo+8AXmXvKFy01tJGjSt6so43JWUnJn5OZcufJY83a+8TnlG/s/GhmimJdbQ9hORHbbwH9xU1sHXF25XObVqurvmnaO8IgNvfH8Tler1f8DhTxuiA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},b=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," and a ",(0,i.jsx)(n.strong,{children:"public_url"}),". The ",(0,i.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": ""\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/03e06346.9fd48efe.js b/assets/js/03e06346.9fd48efe.js deleted file mode 100644 index 6eaf94019..000000000 --- a/assets/js/03e06346.9fd48efe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>f,frontMatter:()=>b,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPGtzHDdyfwWZSpWtzexylyIlmVephLZ1NnOKxJKouBKSx8PO9O5AnAHGAIbLNYtV9+H+QT7l6/00/5JUN4B57IOkRMqmrtYfZO7g1Wh0N/qB7qvI8qmJ9o6jIyjKnFsw0WkcpWASLUorlIz2oqMM2GE1zkXCQi+2f3jAeJ6rmWGVAW2YVSzRgE02zMRsxi0zoC+AccPGeQWlFtIaNlGaTUGC5lbIKUtVUhWADTNhM1ZqSGEiJKTMWF0lttJgBuynDCTj9fRMGGaqJAFjJlWez/3yacxs5uDTYCstDeOskuLnClivFwafibTXY1ymjLNer6TNnVU67/UGDLfb/YZLud/5nHFaUoxzoPEFn7MxMJNxDamDn8s5ISVmIPk4xx3aDApEkd+0G2rEVLb2PuYGUqYkwR8AHbAf1QwucLL2ZyasgXzCEi6lsghAoVIxEZAym2lVTTNmM2HY+7ev/sCExX5MyZxArXAZPIGwtMOcULKGSsjp4ESeyCNR7rH3Za54yuaq0uzw+z82w6xi+O241/sextWUvT/o9U6/zqwtzd7WFi/LgSpB4nw5H5tBooqtFDuW6eRJzGYZaMBZCTjgRiByU8RhOgVraMOSJaqcs0QpnQqJRBWzkk+ByaoYgzaxOwOlgQkkDg08nfet6lcG2H+8e/MaN1pwO2CHeWXierlUaEgsEg1Oj5gNu/rKHcSzHaQ9IacxK/g5HqGw7OdKJOe4bQMyxf97SiNc9XrvqrJU2kLKfnJb2Ov1sOVbyNWMcQ3UP1FFoSQrueYFWGIdZBNs1vBzJRoyyvOAi70T2UfqnZew1+uxA5mKxHMYMPzK1MT3HbiuiCTs+q6EBOnCdW2hDgltlokkI5zMuDvPMueJA1ODKSGx4gK6E1/GbI4Tfw9SBQgypcUvSlqe03FcgLYi4Xn72BBA7Gos18TzpRLShq9+Bfbf/njw9OhQPF0haCkiqxCSWgywC55XYDxUs5hlCNVbKDUYYic/L/FjyjIQ02ztejz9UBnbmZhVxjNuDYVfK5wSoRcIbROeG2Bi0sFlwc+htRpTJE95PmDfzlkKE17lNmYCKc7qCgbstbKMl2UuEo7SBVkUmYej/OvTKXty8IBIXtAZH2p1IVJAQZeKyQQ0Mic20hR+TIAO6aykAbg94hybkXRYOOhE5UovkxB97uKRJUpakHbA9i+4yAl4t1nDhEzyKgU2znlyHtMdEDONUhpPZQ54hcSO3qkLXhQO54QfZiBHKlQS4ZfKL4+i30OVosBG+Rz4CRsDqmkRYdpY9Vw7UbgyoiCwGIOCizwmxMXsgxozK2wOMTJsyeU8Zim3EDMLl3asLmOWZJCc01+ap0KxcWWtkm5jqVZlqmbS43KipDXilxUcGVo+HqPbMduJ2bOYvYjZaBiz0XbMRjsxGz2L2ehFzLaHMdvejtn2Tsy2nzmwtl94XPMawW0ARtsOy/bLwS7K3VfCEGejwDS1DJ51ZPBowHq9mpvw21/+8pcTeXUiGTuJkLlOoj12EtVdTqLYtaHMxLaR/32JP55uP/c/5/jz2fYL/3NGXUc7/meGP7dHJ/LaL3gitwkSy4vyBiiw+UEh8L88EeE3WhS/BXmGH1EQxaEBz6oDDzZct/fyFPcipLCC52b9dkKPR7SjBqSlTe3gpohc1++Imh/RdtrwYAuJSddEYrXVFBieoNhe2v3uwN8s6zfvln00e2+Bc7+tP8Oto2g6QtG0fv+19HpESFiE6X6YeD4gBYAk83o8+A6PCAtdiO6HgxeIA7yU1iMAWx/R7lvgYIO/4V3bcKc/2u1vD7d3OhhA28h1KIp+mvbn8/lDYA91Hr88qjxBQ3WaHZqvE62KFeYHWQdNL68T0d9BZf9PVNTHQYeFFO0+MiyCxlJbfG0t26qUz78ybqowtFbOsH+jms1bYFITwkHWb5IpkXjgsU9QycZo4A0QB33C5FaabrUwiR/TtF8U/YWP+LNPiG99LIpBmg4Wei6djvtYsDSN2fLnld/TlBVFseaz+975vFUUy7sYFIWHjZSvbwbkVCGdbT2f+A6/Fas0HNFd+EY2Qs8Bekiwgcy51Xy0cNlkQvoGT1RsoYOGaZVzDZdolxqhpOv98DwWWKzR7MmOJRPQeY4IFezrN157f+LJH7fQnQC/3D5uaWc4yT5LKmNVwTRM4ZKV3FrQkia74LlInZupTx/gkhclmgBbfz45Sf/ln7fIAYE2vnW+qlRMBfqBtv58vN//n9MVPaqyBJ1wAywHXMnEDGwyYMcZ5GXjiprNZoPZU5NkSuXOD/XBaJi4f8/U+MMZgVsOuCmfrNqpI42WwY+ks2jvG7AdjHHDwsgVJj/RGPHQaEi3rbd3brhufY9HdOMsgISNznuCzccnUcFJIUFShuZvZTPQJ9FpPcYZ+ZDeMvb0DsyaiRRyPoZ8uenOjFZ/zvlcVZ6/g1Oru1VP0S28YUMhZO23oO0M41Yjv1xodG3XK/jbIaTNneHKCewZToDlwgTPTRed7dHetUUORwlAPkx0XvsBbFxT6b25oAbsbmzgJJE/u1uWwH6MOtZuxbDaLSt0DqaNGJyjEFIUVVH7Ryf1rAFlhdc92vjCkejsDyu0T3dpBX55ywrojFy/wIkckR8j+D9u0Ex9j0ckKxZAupmNP0WKdO7pB7pgb2fAsK02A664lrGru5Br5jPruW/A3uD1hj5ZNwi9bEkCpUWP3H1Zswb5zjcU+azafrj1lNfu9YiobwVYn5kCfb+Hvn0+iUjbu/+CCLUD9p2J1TklCz69wXKn5kdEnh6eJSdEr3eoYSLyvBVSZOFTiOxgSAdyKHzYywcT8aojR7iQVqFZEMK2vd4YJgqd4BjTxFBKO3bt7hp3rO24qAsSK80ybpwOTko/HhcGbTHA7d3xr5UFF4szpZIGHBmWK4BuYmm93oIvP3Rr/PlCho3jsY4ezvDc/mbYPujRs93OQe8OOwc9XHfQN9idSAIOF8FZB01TSzAQjYTvy3fTIt+HSRHZLyUGZ4L54bhJVXnKcnFOYZlUmDLncySLwOYeysV433eZUqbp4UNuX/sN73VDeUpjNO/JoI5s3NdjNnr+tH0auy8ewA2w4BjrHsZwZ2u0u3WjZ2zBn/PxSgVjdzk5cjnd6eSoZ3N0Gw/Wp3qwHobwnz6kAT96vt25d54O788AD2SntxnnFgv9IezwBzOI2+x2R1P4NzNJ7099O59DOV8Qw89HDyCG1+jg96XEJVX7wWiPPZSevYoA76Bo36hd35tA28B+diLdfRilfDTs6GrfdFS1b7bbRLm7eyeibC+6QFknkfivb9+8nQ3/9MNU7e/v779+9z57+X66v79f4O/BYLDSHlt12rQM6rD+caG/l+mOX7PKYDBAFKbc8j0avlXK6R/c+Hj9mIEPZH8mJ9HuQ8RlVviC7i8F6q6/n+Pn8/H5fTkwiiNV0ntrJQ/SaC9y75nDe+IoJisVjP1WpfNo7yryL9DwT/++C4dufTD4JPwqMkkGBce/ggmHj8gnIsep8BEVaBPFET1JwBflSHXRXqTGHyCxUYzhshJ9GmBwDhq3dxV6uZe3UezV8GgvclQfxZEPGtWfGMhEYRi4TCfRdVjwpqnqL81Uhv6oH1fjPPi49ROnoaHXC4/oP2mm9gzXDVqbybjWfB4tvtcPr1pDSNKNq5/t5fNwOQiLXpX6qSV1i+JIWCjaq6w5NK0+HtMJKNwJPVf62LF0LLz46DVxXJkp+UkD/YuSTxn6QY3PPokccbD3f6w46zuejmtdXrhLKvv4ThPSoA33mwfHMaNHf4PbKDX0JyzzaXtNF+ZYWvNo3UP01vtXk5EJzMsSuB7Qe/BPTjWg1BSeJxUlTtTiuLOzGtR6Z6PrOLq8fTOXLFH98MqdfZ3DxLqoNEuUlqCftJ+6PJrNbe/sXMfR/Pbtzb/I7T3Hw5vdvrufKD2gSZ34PWB9+uI6jrLbYf2xTmD4HYHdeXbd3LGRS7iqU6rGKp2fBbl1fVvHcJlhP0ynOZBvdAq6hYixUjlwuYSJg4kLECj2FVo6X8XuLQi9OxfahIuMzdDdrCEBzGGhJ2JBVjGv67hH6cy/Bca4wkv8QOqZqcYGe8kwn3ETjoFZLaZTQJe570GD/ct64EmG+UH+hQqfBO9eqeFCqMoE8NCPjrdLDpaytkDoOveqY421sEPe+vbeB+3TwS94uWLSGbw5OrwDLslU7LtcMacfuF26Odibo0PM5hETr/4N2HtTYyKglne6MFTH2IXg4cV/LdvnLn4Ozt+pXPpbO8Qw8Hk0fbYMUCrMSohil4WIqQZ1HuLSxE26Fx6RqiyGLIRPYjAWStPBI0FRI/JIVXehylswydm0oueKFlk2pPbQi6UmG0dIl+9IdkZa6ZCA5MkCe2LuYYOngBXs1JofEw+NG87ZhBuL6YOVFIh5XaFVUU8JlyVoATKBlSjQ4FCHeZC3axPd1Jb3b1/5JL+wh8CUY+RANzGkrCqJaogT6pSrcHKLW19SlJA7QJ+tUwyXVQ9KjPIukBK0URLNJKWnXIpfHAmTRoJW1hgynruuXlSgqxzhQQ7vAhNk7a9/+3sLrrWa7jJgbgWepvie7hYIyZR0BI+avoYSJaDqQoTzgf73xUsAoSOmOXM5o46RzN1p/JBe4JlaLvoQYB2CNFWSoWFRy1sTBxlrvFppyDYlA5ZiiCXuFy6Fsa2kofC0d1k+vAXEY9KCgdQQ5GqkeTlvM3gTGlUL01Fqk+gmnNXX4BIv8MqqMw2FkHe7p9reOKtqQVBZVXArEhamMoNuGqEL+QS+LtjXATSkxguh9JM1rIrTnSmZwJmQZ5gzfAcF73X9FCnlcyRuOwOQbdgCktx11qR6zSgdu42T1u1ECY0dYtyNke4K0FM4S9BMIcKDO+Cx18PZej3Wd7B4sWoq7V0qPquW5AeKkmZ2hMjny9UPxZs7t53M3MqzLnPAF6Voxrv5EaWMIPfJ5e0VmgxsA5glhxPX4bWCiybD20e46bxoNwfOCk+cRwdnwaxRXCe+aU9BhNYv4DlmfobVHUe4zaFbhfFcEUvZrJHDaReoA0r6y+gKoiNEF7BbJ2TiqpkE/etf/89QIB9TTBPMyT+YrG+lED/PjXIZhe1ZA0UHmncOqiWS9m8GVhm7N3s8ggBxugfllxdjfLhCDx9Io6KbRjVOj671/NnM75tsaR+P31jSX5CpORoO/5Et6afDL8eS3hl+QZb0CwTWO+1vlybrtNuVsiMEIW4e8EGB82/mSt/cE33713EdMlmF4IYdtq/df43xH4T4LQ4B5zFoggnemA2bITRsD4f4vwUhGEqi+PovnaIw/xTFd49k3CLRm9IxN+Nr/+LFYVHKIslIktd1ZG4e1SY2/5XozI1H0vu3AIFI/7W7RgHGdC+MFQv4Cj72ZnS1T0nIXEg4C0dwthAycse8s+pM3qkCnD4xQyNuphUWUvGKldVzxqeoGeE0+gGPCLS+jZg/DrKbsLEzHJ6NaiTsLiPhQFKCCJUiOlLnIH/bnbaXt255BPWyyBuJEgnXidqjzmbb390mDSSVFnYe7R1fRZd9Xoq+a987Pr0+RSq0maLQojIEMbdZtBdtLUUaqSIUxrGOryLii5r4DZcpPplZkra8FFsXo8Eouo4Xx6yUzjf0h6r/sUOM5VMhp7eNO21w9A7P0R1VB1ONOlmKPwHqk/4g2r3iSCD9ZMDR0ETUI3m8beKzL8Mhh8jpqmBoc5iL4c0Q3ewELBdvyRUhyFYE8jiE/yiiVwf0omZDUR10i6JWGA1/tAJj+LPWtY8bcq6jSkEVHpEOub2zQ8rW8xFpJU9f0IW/8+z61CG/5Uamh9ZtX6h7CNRx6vlPXSdXFC04lTqenUXHzlonyxofi19ywZdQA7LKhEfTeaXl7Ee1rKQVqAyKQReR+I4GEfl0SIjcGRIiXww7OonffjNDo1mQ+lBrD6QitDUEVANOkXCFnCiien/cb0qQ79A9i1KJuGZJk4Q8UUVdSabXC0N+/dvf61G9Xm3AOr80WrFvKs1KNQM9qVxpmkkOl1SnDYdBQW2GTG7KMeBFDsZgNFxamJLtTBmn6BP2XseEl3wscoFi172jp1e0Lcnt6tLhwxRs+kq7BNwLyFFa186eVo07NlP6fIKF82LG2RirTKG7D2TGZeI8i06EkIcMLVf02pZaGCyepRFq4WBT0mqeWFZwyafk4opZG1kp5ALlLNNqjI53o/LKuZYtF7nS7s0jbYgepRASX16W2ETqMDKthgwJ+8L7l03s/PtOOvjya2MMpZQIi0Cz3ypWyVxhpTQMyVR5zkplXZgEte42jDjcai4NqsoOlnAGNcK86xeMd6C8N4An/ErIc1fdp8+Oa7r6CcZGWOjm/i4y55PumB+E/bEaY+0wZYRVet6MngqbVWOS8+1J6h9uph9CVb+WFG/mSFViVtgPKjFbmKa89Q4sUojZ2j88ID3hCfv1r//LXgHXkmVq5qg1qTTk824BQXfyDm31NU/BBV5h8TxLRCqnId4VMPhTxi15a17DDN1ijqXcQ6OFQo+m19tj360s7BhyFV32CEZ8uK+SyHIhzwds39dBbJxP+J3GfUIdxKPW6lAYyC/AtLxvkArbqX4IHWD85rrJNLi3/TRdyk1BD2wDjvMZUQCLO+cRlhNckc7SyVXplsECmVLBO7PHUs0ntpk/Xi7DuOJTSM4J6Ij9NPWROE4suzq+cX61BQ2kK2/JX4cLmm59ylJ4cjoOZMm6SfUfT9bO3pSWJ6T/hhuUl2JljALL/Zk3k3egL0QSTKQ1HL1FnbeiOMpFAt749ffX/g+Hr9jF08Ewilt63R2Ye+vVwXcvX797icCgIHUIGw2GgyFZdsrYgsvWSgu8s3i3tR7VbWqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqPirsbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqPhZZsamp+lhKVW5qqv4WFLipqbqpqbqpqbqpqbqpqbqpqbqpqfpIPVibmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqr/yDVVW0lWW2XOBSVR+lxfl/94vFhp9TSOMkyQ3DuOrq6Q8t7r/PoaP/9cUb7X8WkcXXAt8PEX5VbGIRUQ07rOAVPCvnNv2fpHuH7sDpqe0i+klGIuoxuxT3u/sW87h/PwzbujKI7GvhpsoVJKBeczTAPjM5cm18oVo29XUc7ltKI8s8jNee0K52Td1MdzSn30f7SS1TBFsIGwmxPptoH/4qZWDri6cmmV19d1f9e0doRHbOiN53d6fX39//GFBz0=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var s=t(74848),l=t(28453),o=t(33617),r=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const b={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHDdyfwWZSpWtzexylyIlmVephLZ1NnOKxJKouBKSx8PO9O5AnAHGAIbLNYtV9+H+QT7l6/00/5JUN4B57IOkRMqmrtYfZO7g1Wh0N/qB7qvI8qmJ9o6jIyjKnFsw0WkcpWASLUorlIz2oqMM2GE1zkXCQi+2f3jAeJ6rmWGVAW2YVSzRgE02zMRsxi0zoC+AccPGeQWlFtIaNlGaTUGC5lbIKUtVUhWADTNhM1ZqSGEiJKTMWF0lttJgBuynDCTj9fRMGGaqJAFjJlWez/3yacxs5uDTYCstDeOskuLnClivFwafibTXY1ymjLNer6TNnVU67/UGDLfb/YZLud/5nHFaUoxzoPEFn7MxMJNxDamDn8s5ISVmIPk4xx3aDApEkd+0G2rEVLb2PuYGUqYkwR8AHbAf1QwucLL2ZyasgXzCEi6lsghAoVIxEZAym2lVTTNmM2HY+7ev/sCExX5MyZxArXAZPIGwtMOcULKGSsjp4ESeyCNR7rH3Za54yuaq0uzw+z82w6xi+O241/sextWUvT/o9U6/zqwtzd7WFi/LgSpB4nw5H5tBooqtFDuW6eRJzGYZaMBZCTjgRiByU8RhOgVraMOSJaqcs0QpnQqJRBWzkk+ByaoYgzaxOwOlgQkkDg08nfet6lcG2H+8e/MaN1pwO2CHeWXierlUaEgsEg1Oj5gNu/rKHcSzHaQ9IacxK/g5HqGw7OdKJOe4bQMyxf97SiNc9XrvqrJU2kLKfnJb2Ov1sOVbyNWMcQ3UP1FFoSQrueYFWGIdZBNs1vBzJRoyyvOAi70T2UfqnZew1+uxA5mKxHMYMPzK1MT3HbiuiCTs+q6EBOnCdW2hDgltlokkI5zMuDvPMueJA1ODKSGx4gK6E1/GbI4Tfw9SBQgypcUvSlqe03FcgLYi4Xn72BBA7Gos18TzpRLShq9+Bfbf/njw9OhQPF0haCkiqxCSWgywC55XYDxUs5hlCNVbKDUYYic/L/FjyjIQ02ztejz9UBnbmZhVxjNuDYVfK5wSoRcIbROeG2Bi0sFlwc+htRpTJE95PmDfzlkKE17lNmYCKc7qCgbstbKMl2UuEo7SBVkUmYej/OvTKXty8IBIXtAZH2p1IVJAQZeKyQQ0Mic20hR+TIAO6aykAbg94hybkXRYOOhE5UovkxB97uKRJUpakHbA9i+4yAl4t1nDhEzyKgU2znlyHtMdEDONUhpPZQ54hcSO3qkLXhQO54QfZiBHKlQS4ZfKL4+i30OVosBG+Rz4CRsDqmkRYdpY9Vw7UbgyoiCwGIOCizwmxMXsgxozK2wOMTJsyeU8Zim3EDMLl3asLmOWZJCc01+ap0KxcWWtkm5jqVZlqmbS43KipDXilxUcGVo+HqPbMduJ2bOYvYjZaBiz0XbMRjsxGz2L2ehFzLaHMdvejtn2Tsy2nzmwtl94XPMawW0ARtsOy/bLwS7K3VfCEGejwDS1DJ51ZPBowHq9mpvw21/+8pcTeXUiGTuJkLlOoj12EtVdTqLYtaHMxLaR/32JP55uP/c/5/jz2fYL/3NGXUc7/meGP7dHJ/LaL3gitwkSy4vyBiiw+UEh8L88EeE3WhS/BXmGH1EQxaEBz6oDDzZct/fyFPcipLCC52b9dkKPR7SjBqSlTe3gpohc1++Imh/RdtrwYAuJSddEYrXVFBieoNhe2v3uwN8s6zfvln00e2+Bc7+tP8Oto2g6QtG0fv+19HpESFiE6X6YeD4gBYAk83o8+A6PCAtdiO6HgxeIA7yU1iMAWx/R7lvgYIO/4V3bcKc/2u1vD7d3OhhA28h1KIp+mvbn8/lDYA91Hr88qjxBQ3WaHZqvE62KFeYHWQdNL68T0d9BZf9PVNTHQYeFFO0+MiyCxlJbfG0t26qUz78ybqowtFbOsH+jms1bYFITwkHWb5IpkXjgsU9QycZo4A0QB33C5FaabrUwiR/TtF8U/YWP+LNPiG99LIpBmg4Wei6djvtYsDSN2fLnld/TlBVFseaz+975vFUUy7sYFIWHjZSvbwbkVCGdbT2f+A6/Fas0HNFd+EY2Qs8Bekiwgcy51Xy0cNlkQvoGT1RsoYOGaZVzDZdolxqhpOv98DwWWKzR7MmOJRPQeY4IFezrN157f+LJH7fQnQC/3D5uaWc4yT5LKmNVwTRM4ZKV3FrQkia74LlInZupTx/gkhclmgBbfz45Sf/ln7fIAYE2vnW+qlRMBfqBtv58vN//n9MVPaqyBJ1wAywHXMnEDGwyYMcZ5GXjiprNZoPZU5NkSuXOD/XBaJi4f8/U+MMZgVsOuCmfrNqpI42WwY+ks2jvG7AdjHHDwsgVJj/RGPHQaEi3rbd3brhufY9HdOMsgISNznuCzccnUcFJIUFShuZvZTPQJ9FpPcYZ+ZDeMvb0DsyaiRRyPoZ8uenOjFZ/zvlcVZ6/g1Oru1VP0S28YUMhZO23oO0M41Yjv1xodG3XK/jbIaTNneHKCewZToDlwgTPTRed7dHetUUORwlAPkx0XvsBbFxT6b25oAbsbmzgJJE/u1uWwH6MOtZuxbDaLSt0DqaNGJyjEFIUVVH7Ryf1rAFlhdc92vjCkejsDyu0T3dpBX55ywrojFy/wIkckR8j+D9u0Ex9j0ckKxZAupmNP0WKdO7pB7pgb2fAsK02A664lrGru5Br5jPruW/A3uD1hj5ZNwi9bEkCpUWP3H1Zswb5zjcU+azafrj1lNfu9YiobwVYn5kCfb+Hvn0+iUjbu/+CCLUD9p2J1TklCz69wXKn5kdEnh6eJSdEr3eoYSLyvBVSZOFTiOxgSAdyKHzYywcT8aojR7iQVqFZEMK2vd4YJgqd4BjTxFBKO3bt7hp3rO24qAsSK80ybpwOTko/HhcGbTHA7d3xr5UFF4szpZIGHBmWK4BuYmm93oIvP3Rr/PlCho3jsY4ezvDc/mbYPujRs93OQe8OOwc9XHfQN9idSAIOF8FZB01TSzAQjYTvy3fTIt+HSRHZLyUGZ4L54bhJVXnKcnFOYZlUmDLncySLwOYeysV433eZUqbp4UNuX/sN73VDeUpjNO/JoI5s3NdjNnr+tH0auy8ewA2w4BjrHsZwZ2u0u3WjZ2zBn/PxSgVjdzk5cjnd6eSoZ3N0Gw/Wp3qwHobwnz6kAT96vt25d54O788AD2SntxnnFgv9IezwBzOI2+x2R1P4NzNJ7099O59DOV8Qw89HDyCG1+jg96XEJVX7wWiPPZSevYoA76Bo36hd35tA28B+diLdfRilfDTs6GrfdFS1b7bbRLm7eyeibC+6QFknkfivb9+8nQ3/9MNU7e/v779+9z57+X66v79f4O/BYLDSHlt12rQM6rD+caG/l+mOX7PKYDBAFKbc8j0avlXK6R/c+Hj9mIEPZH8mJ9HuQ8RlVviC7i8F6q6/n+Pn8/H5fTkwiiNV0ntrJQ/SaC9y75nDe+IoJisVjP1WpfNo7yryL9DwT/++C4dufTD4JPwqMkkGBce/ggmHj8gnIsep8BEVaBPFET1JwBflSHXRXqTGHyCxUYzhshJ9GmBwDhq3dxV6uZe3UezV8GgvclQfxZEPGtWfGMhEYRi4TCfRdVjwpqnqL81Uhv6oH1fjPPi49ROnoaHXC4/oP2mm9gzXDVqbybjWfB4tvtcPr1pDSNKNq5/t5fNwOQiLXpX6qSV1i+JIWCjaq6w5NK0+HtMJKNwJPVf62LF0LLz46DVxXJkp+UkD/YuSTxn6QY3PPokccbD3f6w46zuejmtdXrhLKvv4ThPSoA33mwfHMaNHf4PbKDX0JyzzaXtNF+ZYWvNo3UP01vtXk5EJzMsSuB7Qe/BPTjWg1BSeJxUlTtTiuLOzGtR6Z6PrOLq8fTOXLFH98MqdfZ3DxLqoNEuUlqCftJ+6PJrNbe/sXMfR/Pbtzb/I7T3Hw5vdvrufKD2gSZ34PWB9+uI6jrLbYf2xTmD4HYHdeXbd3LGRS7iqU6rGKp2fBbl1fVvHcJlhP0ynOZBvdAq6hYixUjlwuYSJg4kLECj2FVo6X8XuLQi9OxfahIuMzdDdrCEBzGGhJ2JBVjGv67hH6cy/Bca4wkv8QOqZqcYGe8kwn3ETjoFZLaZTQJe570GD/ct64EmG+UH+hQqfBO9eqeFCqMoE8NCPjrdLDpaytkDoOveqY421sEPe+vbeB+3TwS94uWLSGbw5OrwDLslU7LtcMacfuF26Odibo0PM5hETr/4N2HtTYyKglne6MFTH2IXg4cV/LdvnLn4Ozt+pXPpbO8Qw8Hk0fbYMUCrMSohil4WIqQZ1HuLSxE26Fx6RqiyGLIRPYjAWStPBI0FRI/JIVXehylswydm0oueKFlk2pPbQi6UmG0dIl+9IdkZa6ZCA5MkCe2LuYYOngBXs1JofEw+NG87ZhBuL6YOVFIh5XaFVUU8JlyVoATKBlSjQ4FCHeZC3axPd1Jb3b1/5JL+wh8CUY+RANzGkrCqJaogT6pSrcHKLW19SlJA7QJ+tUwyXVQ9KjPIukBK0URLNJKWnXIpfHAmTRoJW1hgynruuXlSgqxzhQQ7vAhNk7a9/+3sLrrWa7jJgbgWepvie7hYIyZR0BI+avoYSJaDqQoTzgf73xUsAoSOmOXM5o46RzN1p/JBe4JlaLvoQYB2CNFWSoWFRy1sTBxlrvFppyDYlA5ZiiCXuFy6Fsa2kofC0d1k+vAXEY9KCgdQQ5GqkeTlvM3gTGlUL01Fqk+gmnNXX4BIv8MqqMw2FkHe7p9reOKtqQVBZVXArEhamMoNuGqEL+QS+LtjXATSkxguh9JM1rIrTnSmZwJmQZ5gzfAcF73X9FCnlcyRuOwOQbdgCktx11qR6zSgdu42T1u1ECY0dYtyNke4K0FM4S9BMIcKDO+Cx18PZej3Wd7B4sWoq7V0qPquW5AeKkmZ2hMjny9UPxZs7t53M3MqzLnPAF6Voxrv5EaWMIPfJ5e0VmgxsA5glhxPX4bWCiybD20e46bxoNwfOCk+cRwdnwaxRXCe+aU9BhNYv4DlmfobVHUe4zaFbhfFcEUvZrJHDaReoA0r6y+gKoiNEF7BbJ2TiqpkE/etf/89QIB9TTBPMyT+YrG+lED/PjXIZhe1ZA0UHmncOqiWS9m8GVhm7N3s8ggBxugfllxdjfLhCDx9Io6KbRjVOj671/NnM75tsaR+P31jSX5CpORoO/5Et6afDL8eS3hl+QZb0CwTWO+1vlybrtNuVsiMEIW4e8EGB82/mSt/cE33713EdMlmF4IYdtq/df43xH4T4LQ4B5zFoggnemA2bITRsD4f4vwUhGEqi+PovnaIw/xTFd49k3CLRm9IxN+Nr/+LFYVHKIslIktd1ZG4e1SY2/5XozI1H0vu3AIFI/7W7RgHGdC+MFQv4Cj72ZnS1T0nIXEg4C0dwthAycse8s+pM3qkCnD4xQyNuphUWUvGKldVzxqeoGeE0+gGPCLS+jZg/DrKbsLEzHJ6NaiTsLiPhQFKCCJUiOlLnIH/bnbaXt255BPWyyBuJEgnXidqjzmbb390mDSSVFnYe7R1fRZd9Xoq+a987Pr0+RSq0maLQojIEMbdZtBdtLUUaqSIUxrGOryLii5r4DZcpPplZkra8FFsXo8Eouo4Xx6yUzjf0h6r/sUOM5VMhp7eNO21w9A7P0R1VB1ONOlmKPwHqk/4g2r3iSCD9ZMDR0ETUI3m8beKzL8Mhh8jpqmBoc5iL4c0Q3ewELBdvyRUhyFYE8jiE/yiiVwf0omZDUR10i6JWGA1/tAJj+LPWtY8bcq6jSkEVHpEOub2zQ8rW8xFpJU9f0IW/8+z61CG/5Uamh9ZtX6h7CNRx6vlPXSdXFC04lTqenUXHzlonyxofi19ywZdQA7LKhEfTeaXl7Ee1rKQVqAyKQReR+I4GEfl0SIjcGRIiXww7OonffjNDo1mQ+lBrD6QitDUEVANOkXCFnCiien/cb0qQ79A9i1KJuGZJk4Q8UUVdSabXC0N+/dvf61G9Xm3AOr80WrFvKs1KNQM9qVxpmkkOl1SnDYdBQW2GTG7KMeBFDsZgNFxamJLtTBmn6BP2XseEl3wscoFi172jp1e0Lcnt6tLhwxRs+kq7BNwLyFFa186eVo07NlP6fIKF82LG2RirTKG7D2TGZeI8i06EkIcMLVf02pZaGCyepRFq4WBT0mqeWFZwyafk4opZG1kp5ALlLNNqjI53o/LKuZYtF7nS7s0jbYgepRASX16W2ETqMDKthgwJ+8L7l03s/PtOOvjya2MMpZQIi0Cz3ypWyVxhpTQMyVR5zkplXZgEte42jDjcai4NqsoOlnAGNcK86xeMd6C8N4An/ErIc1fdp8+Oa7r6CcZGWOjm/i4y55PumB+E/bEaY+0wZYRVet6MngqbVWOS8+1J6h9uph9CVb+WFG/mSFViVtgPKjFbmKa89Q4sUojZ2j88ID3hCfv1r//LXgHXkmVq5qg1qTTk824BQXfyDm31NU/BBV5h8TxLRCqnId4VMPhTxi15a17DDN1ijqXcQ6OFQo+m19tj360s7BhyFV32CEZ8uK+SyHIhzwds39dBbJxP+J3GfUIdxKPW6lAYyC/AtLxvkArbqX4IHWD85rrJNLi3/TRdyk1BD2wDjvMZUQCLO+cRlhNckc7SyVXplsECmVLBO7PHUs0ntpk/Xi7DuOJTSM4J6Ij9NPWROE4suzq+cX61BQ2kK2/JX4cLmm59ylJ4cjoOZMm6SfUfT9bO3pSWJ6T/hhuUl2JljALL/Zk3k3egL0QSTKQ1HL1FnbeiOMpFAt749ffX/g+Hr9jF08Ewilt63R2Ye+vVwXcvX797icCgIHUIGw2GgyFZdsrYgsvWSgu8s3i3tR7VbWqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqPirsbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqqPhZZsamp+lhKVW5qqv4WFLipqbqpqbqpqbqpqbqpqbqpqbqpqfpIPVibmqqbmqqbmqqbmqqbmqqbmqqbmqqbmqr/yDVVW0lWW2XOBSVR+lxfl/94vFhp9TSOMkyQ3DuOrq6Q8t7r/PoaP/9cUb7X8WkcXXAt8PEX5VbGIRUQ07rOAVPCvnNv2fpHuH7sDpqe0i+klGIuoxuxT3u/sW87h/PwzbujKI7GvhpsoVJKBeczTAPjM5cm18oVo29XUc7ltKI8s8jNee0K52Td1MdzSn30f7SS1TBFsIGwmxPptoH/4qZWDri6cmmV19d1f9e0doRHbOiN53d6fX39//GFBz0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,y={},g=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,s.jsx)(r(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," and a ",(0,s.jsx)(n.strong,{children:"public_url"}),". The ",(0,s.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.27742ef4.js b/assets/js/138cee78.27742ef4.js deleted file mode 100644 index ee40c4616..000000000 --- a/assets/js/138cee78.27742ef4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>g,default:()=>X,frontMatter:()=>f,metadata:()=>n,toc:()=>P});const n=JSON.parse('{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/v1.1/createcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createcontact","permalink":"/docs/API-docs/v1.1/createcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar_label":"Create Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWM1u5MYRfpVKXxIPqPmR1g7Ck5XFYiNk4RUsGQKiFYQiWUO21OxudzfnB4MBfPAb5JRrHm2fJKgmOcMZadcWbGwSYLEYVVdV1399zY0IWHqR3orXRgfMgxd3iSjI507aII0WqbiuCF47wkDQMcH55QWgUmbpYW0aCAZoPjcuKPJerSFvuTUtIe/UQqgwQI4aWB49eFlqch7mxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkohCpaDV3SkUiHP3YkA9/NcVapJsjwy+dWciCICNllmDRYU2BHJvbWbhXxL9IB1aC1iqZxzsnD541bYTPK6qRf/GN0lHBMaMapRKJ0FgTxy2sLYlUmOyBolLr2PogybNk5Eo3PZcPTupSJGJuXI1hSKEV1lYx04Nh80lsk+6yl8tnRN92hHFualZlK6NfbMrs9Ox0djY7O52xitzUFvX6pUqMJc2ZZxUPJrsPMqgXW1LQQmy3ieiED4viPuNa2PL5PlXBNRQJ3hrt23ScTqdPS6Yv8FZlAb7Jc/J+3ii1/sNLyuTzpdCSuaJf5rmtZlm1On2wHL//83p6NTubncZ//xP1lHRlVJyH5+T33KfT07OT2fRk+ufr2Tfpq7+kX38znk6n/xCJWNVq3+iiwBAD3Zdp/3djiy9wz/aYreuPggJK5YcC/RTcxq559VxfXJmaQiV1CUvSAZbO6DIBqwg9QXBrwBKlBoWB3O/YJ+SccZ8P08ssG44NqZXUdN8PhftX0+n9bBeE2aeHAypHWKyBVtIH/2Xd/ZQNn3dsNnDs66eOXegFKlnEtX5tHkl/WZ+G14f2+qflK1umeC4OnB3SWyc95Y2TYS3S241YnaCVJ+15enu3vUsEV4xhOGGNjxZjqEQqJsfowpNbkPNRTeOUSEUVgvXpZOJRF5lZjfv5ozDzPA0naOVkMRvzTDuWQWtfxE/NyUtFfMBS6vKX5O72IbriNLaZOgjULl9o5d9p3YOc9IArEZLLpyIsyMWccXV8v8dkb/oc79LYL6Dd/nlupew2yhB0DHbEfuwfTP1+kEs9N9GDjvzekr6SpY4FFiNwDHFvSOWmJkaGoSIYjXqRjz//eyc1Gu2QaWyF8Qf9Qb9vHFizJDdvFKAuYK5oJTNFUYzqeLZDyZ6w7jCy1IFKxyC0kKUMqCIi5jmWo8VMKskdxGymxceDJvRjuKkoVBSh8x8dAUJBC1LceIBNMDUGVtXbC0vjHueM1xNAyBovNXkPpCvUOTP25ZCAcYAaSAdy1klP4INjq2Vrm9HB8fypUWNJrDuBYbAKUpJ7BpzJGh/AG9VEk4HXjnFUQO+QJip8DOKbleUjYCon2VHF+V0QlI0syCeQm4LAxwphF3QBGfkAlm2ROXlW2mhl8seYQMZrYA3PL4kKzPzARhYPDrVnUNDa0udgFzDrDAM/ag0cjX7wxBl+J/WjT0ejD/oEbnd1dUOZl4Hu/tT34XK5fNJ/Xx3KvJXhb00G35M1Xgbj1nvpUoaqyWLPDpXs/mg1vSVNsX4GHbnXUZjcPx0BTJ1UpOzkigJXiJ+cX17Ekf8VfPzpn/CO0GmozLKt1rxxpNZQ9ldx5NrMt2HbTez4jMMmVBzxvC2+7m3WR/CmwvDxp395+I6WIHXXUuzKaHTZZErmcE215UXtR6O0f3KGnrZ/QWYEvkIupYVEQLCttJL6cQzneg2NJwdLGapYDEyPcgducFz2L03I0FMBRkeJ/s7x3iKm157Ugjzr0iawGVRIfiWEypmmbG8bGtM552gulYIbWZQUom/nRQG2Iy9bMgd8YA7NuSFCRWtAR+BJhzFcHonEk8byu5kKjmmsfcMPc04A6cIaqYNPoXA4Hzysk32hx50njX6G1IYQd+FIOjW7lLSd2Hm8o44/8Fw+2iaH89bRnBxfGN3e58XKrpxu+7IErtbfUtbt46Ld6AxHuq2DVn57rCfCCnK1fz+/IreQOXWr9RMdPYnME5EIJXPSfrjnzt9evoPF2XgqksGO/hXNPXl38frNd1dv2BgepG3AZuPpeBqfWsaHGvXgpsNPM8erbbPHcf/lDzkdngi0ChOrUEYUF0Oz6QDY7dHnnbtEVAzQ0lux2XCD/uDUdsvkHxtyjO7uErFAJzHjPX97t016LMKI7ZHWHWAmHU6u+XpmV00La44gLYOpVuI8z8mGz/IOMeTl+6trkYis+wRVm4JlHC758xQuRSriV6y4BOMHJKZthEJdNlhGTBR1MnziCXqIvR4j9up+sFf9kV4PLDwEZa0b/D879azAZtPiuu12x98efVKiC2zPzem72263/wHx/A75","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var o=a(74848),r=a(28453),s=a(33617),i=a.n(s),c=a(17543),p=a.n(c),l=a(86013),d=a.n(l),m=a(63723),u=a.n(m),x=(a(18766),a(79329),a(9303));const f={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWM1u5MYRfpVKXxIPqPmR1g7Ck5XFYiNk4RUsGQKiFYQiWUO21OxudzfnB4MBfPAb5JRrHm2fJKgmOcMZadcWbGwSYLEYVVdV1399zY0IWHqR3orXRgfMgxd3iSjI507aII0WqbiuCF47wkDQMcH55QWgUmbpYW0aCAZoPjcuKPJerSFvuTUtIe/UQqgwQI4aWB49eFlqch7mxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkohCpaDV3SkUiHP3YkA9/NcVapJsjwy+dWciCICNllmDRYU2BHJvbWbhXxL9IB1aC1iqZxzsnD541bYTPK6qRf/GN0lHBMaMapRKJ0FgTxy2sLYlUmOyBolLr2PogybNk5Eo3PZcPTupSJGJuXI1hSKEV1lYx04Nh80lsk+6yl8tnRN92hHFualZlK6NfbMrs9Ox0djY7O52xitzUFvX6pUqMJc2ZZxUPJrsPMqgXW1LQQmy3ieiED4viPuNa2PL5PlXBNRQJ3hrt23ScTqdPS6Yv8FZlAb7Jc/J+3ii1/sNLyuTzpdCSuaJf5rmtZlm1On2wHL//83p6NTubncZ//xP1lHRlVJyH5+T33KfT07OT2fRk+ufr2Tfpq7+kX38znk6n/xCJWNVq3+iiwBAD3Zdp/3djiy9wz/aYreuPggJK5YcC/RTcxq559VxfXJmaQiV1CUvSAZbO6DIBqwg9QXBrwBKlBoWB3O/YJ+SccZ8P08ssG44NqZXUdN8PhftX0+n9bBeE2aeHAypHWKyBVtIH/2Xd/ZQNn3dsNnDs66eOXegFKlnEtX5tHkl/WZ+G14f2+qflK1umeC4OnB3SWyc95Y2TYS3S241YnaCVJ+15enu3vUsEV4xhOGGNjxZjqEQqJsfowpNbkPNRTeOUSEUVgvXpZOJRF5lZjfv5ozDzPA0naOVkMRvzTDuWQWtfxE/NyUtFfMBS6vKX5O72IbriNLaZOgjULl9o5d9p3YOc9IArEZLLpyIsyMWccXV8v8dkb/oc79LYL6Dd/nlupew2yhB0DHbEfuwfTP1+kEs9N9GDjvzekr6SpY4FFiNwDHFvSOWmJkaGoSIYjXqRjz//eyc1Gu2QaWyF8Qf9Qb9vHFizJDdvFKAuYK5oJTNFUYzqeLZDyZ6w7jCy1IFKxyC0kKUMqCIi5jmWo8VMKskdxGymxceDJvRjuKkoVBSh8x8dAUJBC1LceIBNMDUGVtXbC0vjHueM1xNAyBovNXkPpCvUOTP25ZCAcYAaSAdy1klP4INjq2Vrm9HB8fypUWNJrDuBYbAKUpJ7BpzJGh/AG9VEk4HXjnFUQO+QJip8DOKbleUjYCon2VHF+V0QlI0syCeQm4LAxwphF3QBGfkAlm2ROXlW2mhl8seYQMZrYA3PL4kKzPzARhYPDrVnUNDa0udgFzDrDAM/ag0cjX7wxBl+J/WjT0ejD/oEbnd1dUOZl4Hu/tT34XK5fNJ/Xx3KvJXhb00G35M1Xgbj1nvpUoaqyWLPDpXs/mg1vSVNsX4GHbnXUZjcPx0BTJ1UpOzkigJXiJ+cX17Ekf8VfPzpn/CO0GmozLKt1rxxpNZQ9ldx5NrMt2HbTez4jMMmVBzxvC2+7m3WR/CmwvDxp395+I6WIHXXUuzKaHTZZErmcE215UXtR6O0f3KGnrZ/QWYEvkIupYVEQLCttJL6cQzneg2NJwdLGapYDEyPcgducFz2L03I0FMBRkeJ/s7x3iKm157Ugjzr0iawGVRIfiWEypmmbG8bGtM552gulYIbWZQUom/nRQG2Iy9bMgd8YA7NuSFCRWtAR+BJhzFcHonEk8byu5kKjmmsfcMPc04A6cIaqYNPoXA4Hzysk32hx50njX6G1IYQd+FIOjW7lLSd2Hm8o44/8Fw+2iaH89bRnBxfGN3e58XKrpxu+7IErtbfUtbt46Ld6AxHuq2DVn57rCfCCnK1fz+/IreQOXWr9RMdPYnME5EIJXPSfrjnzt9evoPF2XgqksGO/hXNPXl38frNd1dv2BgepG3AZuPpeBqfWsaHGvXgpsNPM8erbbPHcf/lDzkdngi0ChOrUEYUF0Oz6QDY7dHnnbtEVAzQ0lux2XCD/uDUdsvkHxtyjO7uErFAJzHjPX97t016LMKI7ZHWHWAmHU6u+XpmV00La44gLYOpVuI8z8mGz/IOMeTl+6trkYis+wRVm4JlHC758xQuRSriV6y4BOMHJKZthEJdNlhGTBR1MnziCXqIvR4j9up+sFf9kV4PLDwEZa0b/D879azAZtPiuu12x98efVKiC2zPzem72263/wHx/A75",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},P=[];function b(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(i(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,o.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(p(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{title:"Body",body:{description:"Provide below parameter to create contact",content:{"application/json":{schema:{required:["email","name"],type:"object",properties:{name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"1232131321"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function X(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.a3f62faa.js b/assets/js/138cee78.a3f62faa.js new file mode 100644 index 000000000..2cc67823c --- /dev/null +++ b/assets/js/138cee78.a3f62faa.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>b,default:()=>y,frontMatter:()=>u,metadata:()=>a,toc:()=>x});const a=JSON.parse('{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/v1.1/createcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createcontact","permalink":"/docs/API-docs/v1.1/createcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar_label":"Create Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWF9v3LgR/ypTvrS3kPePnbuiejo3CFKjaWKcfTBQxzBG0qxEmyJ5JLV/sFjgHvoN7ule+9HySYqhpF3t2klrtEhbIAjWI85wZvibmR+5EQFLL9Jb8drogHnw4i4RBfncSRuk0SIV1xXBa0cYCLpFcH55AaiUWXpYmwaCAZrPjQuKvFdryNvVmpaQd2YhVBggRw2sjx68LDU5D3Pj2IYDWVvjAuoAhcmbmnTwY5EIY8khe3JRiFS0ljujIhGOfmrIhz+aYi3SzZHjl84sZEGQkTJLsOiwpkCO3e083BviX6QDG0FrlczjnpMHz5Y2wucV1ci/eEfpqOCcUY1SiURorInzFtaWRCpM9kDRqHXsfZDkWTOuSjf9Kh+c1KVIxNy4GsNQQiusreJFD4bdJ7FNus1erp8Rfd8Jxrmp2ZStjH6xK7PTs9PZ2ezsdMYmclNb1OuXGjGWNJ88m3gw2X2QQb3Yk4IWYrtNRKd8CIr7jLGw5e/7owquoSjw1mjfHsfpdPoUMj3AW5MF+CbPyft5o9T6Ny+ByZeh0IoZ0S+L3FazrFqdPljO3/85nl7Nzman8d//BJ6SDkbFeXhOf7/6dHp6djKbnkx/fz37Ln31h/Tb78bT6fSvIhGrWu0LXRQYYqJ7mPZ/N7b4Cvtsj5d19VFQQKn8UKHvgttYNa+eq4srU1OopC5hSTrA0hldJmAVoScIbg1YotSgMJD7D9YJOWfcl9P0Ms+GbUNqJTXd903h/tV0ej/bJWH2+eaAyhEWa6CV9MF/3XA/58OXA5sNAvv2aWAXeoFKFnGsX5tH0l83puH2od3+KXxluyh+FwfBDuVtkJ7yxsmwFuntRqxO0MqT9nt6e7e9SwQjxjCdsMZHjzFUIhWTY3bhyS3I+WjmqB6WWJbk/tRk0evzJhj4i8kf29Aap0QqqhCsTyeThXShtTT2rVrVZNw6J5cOebK8x8Ujugn3sslsPB1PxTbZHBnxqIvMrMZ9w1OY+WgDrZwsZuPZMzpo7YvWU3PyUhUfsJS6/Gd6d/szuWLctNA4OJkdQNDKP9O6Z1XpwapESM5+RViQiyBhOP6wJ4FvelDtcNNPvN3Ae26G7UbYkOUMhtJ+zhyMmX5ySD03MYJO/MGSvpKljtiIGTjm1DekclMTU9FQEYxGvcqnv/19pzUa7ahwrL3xR/1Rf2gcWLMkN28UoC5grmglM0VRjer4bUfLPWHdkXKpA5WOWW8hSxlQRQrOjTNHi5lUkkuWl5mWkA+q3o/hpqJQUeTqv3UECAUtSHGlAzbB1BjYVO8vLI17nPMFIQGErPFSk/dAukKd88IeDgkYB6iBdCBnnfQEPjj2Wra+GR0cN7waNZbEthMYJqsgJblIwZms8QG8UU10GXjOGUcF9AFposLHJL5ZWf4ELOVDdlTx+S4IykYW5BPITUHgI0I4BF1ARj6AZV9kTp6NNlqZ/DEeIJcxWMMNU6ICMz/wkdWDQ+2ZhbS+9GewS5h1hpkmtQ6ORj964hN+J/WjT0ejj/oEbne4uqHMy0B3v+vrcLlcPqm/bw513srA7eoHssbLYNx6r13K0LekoZHdH62lt6Qp4mdQkXsbhcn90xbA0klFyk6uKDBC/OT88iLOmG/g08+/wDtCp6EyyxateeNIraHst+LMtSffpm03IuK9EZtQccbzFnzdZbDP4E2F4dPPv3p4T0uQuispDmU0umwyJXO4ptoyM/CjUdrfcUMv219ZMwJfIUNpIREQbKutpH4cw7leQ+PJwVKGKoKB5VHvIAzOy/5qCxl6KsDoqNHvOd57xPLak1qQZ1vaBHaDCsnXklA505TtbkNnuuAczaVScCOLkkKM7bwowHbiZSvmhA/coTkXRKhoDegIPOkwhssjlfilsXxRp4JzGrFv+CWAD4B0YY3UwadQOJwPbvLJHuhxyEqjnxG1KcRdOpLOzO5I2krsIt5Jxx+5Lx9Nk8N+62hOjjeMYe/PxcoOTrc9LIHR+u/Aur3NtBSC+U83ddDK74/tRB5DrvYf5lfkFjKnbrR+pqIncfFEJELJnLQfzrnzt5fvYHE2nh7wj3+huCfvLl6/eX/1hp3hRtomrOchkSLVqAc7Hb4FHY+2zZ44/pdfjjo+EWgVJlahjLQxpmbTMb7bo/eku0RUzAjTW7HZcIH+6NR2y+KfGnJMJ+8SsUAnMeM5f3u3TXouwhTxkdYdQycdTq55e16umpbWHHFoJlOtxnmekw1fXDskrZcfrq5FIrLuzas2Bes4XPJ7GC5FKuKzWRyC8cWKZRuhUJcNlpETRZtMn7iDHnKvx8i9uh8cVf9JrwceHpKyNgz+n4N6VmGzaXnddrtb3376rEaX2H41H9/ddrv9B0HQNqQ=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var s=n(74848),r=n(28453),o=n(33617),c=n.n(o),i=n(17543),p=n.n(i),l=n(86013),d=n.n(l),m=n(63723),h=n.n(m),j=(n(18766),n(79329),n(9303));const u={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWF9v3LgR/ypTvrS3kPePnbuiejo3CFKjaWKcfTBQxzBG0qxEmyJ5JLV/sFjgHvoN7ule+9HySYqhpF3t2klrtEhbIAjWI85wZvibmR+5EQFLL9Jb8drogHnw4i4RBfncSRuk0SIV1xXBa0cYCLpFcH55AaiUWXpYmwaCAZrPjQuKvFdryNvVmpaQd2YhVBggRw2sjx68LDU5D3Pj2IYDWVvjAuoAhcmbmnTwY5EIY8khe3JRiFS0ljujIhGOfmrIhz+aYi3SzZHjl84sZEGQkTJLsOiwpkCO3e083BviX6QDG0FrlczjnpMHz5Y2wucV1ci/eEfpqOCcUY1SiURorInzFtaWRCpM9kDRqHXsfZDkWTOuSjf9Kh+c1KVIxNy4GsNQQiusreJFD4bdJ7FNus1erp8Rfd8Jxrmp2ZStjH6xK7PTs9PZ2ezsdMYmclNb1OuXGjGWNJ88m3gw2X2QQb3Yk4IWYrtNRKd8CIr7jLGw5e/7owquoSjw1mjfHsfpdPoUMj3AW5MF+CbPyft5o9T6Ny+ByZeh0IoZ0S+L3FazrFqdPljO3/85nl7Nzman8d//BJ6SDkbFeXhOf7/6dHp6djKbnkx/fz37Ln31h/Tb78bT6fSvIhGrWu0LXRQYYqJ7mPZ/N7b4Cvtsj5d19VFQQKn8UKHvgttYNa+eq4srU1OopC5hSTrA0hldJmAVoScIbg1YotSgMJD7D9YJOWfcl9P0Ms+GbUNqJTXd903h/tV0ej/bJWH2+eaAyhEWa6CV9MF/3XA/58OXA5sNAvv2aWAXeoFKFnGsX5tH0l83puH2od3+KXxluyh+FwfBDuVtkJ7yxsmwFuntRqxO0MqT9nt6e7e9SwQjxjCdsMZHjzFUIhWTY3bhyS3I+WjmqB6WWJbk/tRk0evzJhj4i8kf29Aap0QqqhCsTyeThXShtTT2rVrVZNw6J5cOebK8x8Ujugn3sslsPB1PxTbZHBnxqIvMrMZ9w1OY+WgDrZwsZuPZMzpo7YvWU3PyUhUfsJS6/Gd6d/szuWLctNA4OJkdQNDKP9O6Z1XpwapESM5+RViQiyBhOP6wJ4FvelDtcNNPvN3Ae26G7UbYkOUMhtJ+zhyMmX5ySD03MYJO/MGSvpKljtiIGTjm1DekclMTU9FQEYxGvcqnv/19pzUa7ahwrL3xR/1Rf2gcWLMkN28UoC5grmglM0VRjer4bUfLPWHdkXKpA5WOWW8hSxlQRQrOjTNHi5lUkkuWl5mWkA+q3o/hpqJQUeTqv3UECAUtSHGlAzbB1BjYVO8vLI17nPMFIQGErPFSk/dAukKd88IeDgkYB6iBdCBnnfQEPjj2Wra+GR0cN7waNZbEthMYJqsgJblIwZms8QG8UU10GXjOGUcF9AFposLHJL5ZWf4ELOVDdlTx+S4IykYW5BPITUHgI0I4BF1ARj6AZV9kTp6NNlqZ/DEeIJcxWMMNU6ICMz/wkdWDQ+2ZhbS+9GewS5h1hpkmtQ6ORj964hN+J/WjT0ejj/oEbne4uqHMy0B3v+vrcLlcPqm/bw513srA7eoHssbLYNx6r13K0LekoZHdH62lt6Qp4mdQkXsbhcn90xbA0klFyk6uKDBC/OT88iLOmG/g08+/wDtCp6EyyxateeNIraHst+LMtSffpm03IuK9EZtQccbzFnzdZbDP4E2F4dPPv3p4T0uQuispDmU0umwyJXO4ptoyM/CjUdrfcUMv219ZMwJfIUNpIREQbKutpH4cw7leQ+PJwVKGKoKB5VHvIAzOy/5qCxl6KsDoqNHvOd57xPLak1qQZ1vaBHaDCsnXklA505TtbkNnuuAczaVScCOLkkKM7bwowHbiZSvmhA/coTkXRKhoDegIPOkwhssjlfilsXxRp4JzGrFv+CWAD4B0YY3UwadQOJwPbvLJHuhxyEqjnxG1KcRdOpLOzO5I2krsIt5Jxx+5Lx9Nk8N+62hOjjeMYe/PxcoOTrc9LIHR+u/Aur3NtBSC+U83ddDK74/tRB5DrvYf5lfkFjKnbrR+pqIncfFEJELJnLQfzrnzt5fvYHE2nh7wj3+huCfvLl6/eX/1hp3hRtomrOchkSLVqAc7Hb4FHY+2zZ44/pdfjjo+EWgVJlahjLQxpmbTMb7bo/eku0RUzAjTW7HZcIH+6NR2y+KfGnJMJ+8SsUAnMeM5f3u3TXouwhTxkdYdQycdTq55e16umpbWHHFoJlOtxnmekw1fXDskrZcfrq5FIrLuzas2Bes4XPJ7GC5FKuKzWRyC8cWKZRuhUJcNlpETRZtMn7iDHnKvx8i9uh8cVf9JrwceHpKyNgz+n4N6VmGzaXnddrtb3376rEaX2H41H9/ddrv9B0HQNqQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,f={},x=[];function k(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(j.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,s.jsx)(c(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,s.jsx)(j.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:void 0}),"\n",(0,s.jsx)(d(),{title:"Body",body:{description:"Provide below parameter to create contact",content:{"application/json":{schema:{required:["email","name"],type:"object",properties:{name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"1232131321"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/18b84479.33c9f705.js b/assets/js/18b84479.33c9f705.js deleted file mode 100644 index ff55be753..000000000 --- a/assets/js/18b84479.33c9f705.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>P,default:()=>v,frontMatter:()=>j,metadata:()=>d,toc:()=>x});const d=JSON.parse('{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.1/deletedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletedocument","permalink":"/docs/API-docs/v1.1/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnejDEx1sgYsQMD62kYlFiSGFMkQ1LdbjQE5JA3yCnXfbR5kkVRP622PZMMdjcXu1Ws36+KVcUdC7z0LL1jb0ze1KiDZ6uECfS5kzZIo1nKbiqEN6gwIIieC86uLoArZTYetqaBYMBhbdYI3mIuC5nvWQtnamJyI8nPWcKMRcfJwoVgKRNR/8DAEma54zUGdOTdjmleI7H1DPdSsIRJ8s7yULGnLl85s5YCwWQ/Yh4uBJhi71Aw0JljCXP4UyMdCpYG12DCfNgqMuRlbRUx4KNVRiBLC648MeQV1pylOxa2NnIGJ3XJElYYV/MwpeAjj1pSZquTrDrhXrC2XZFVb4326EnPyXJJ/w4DGNLReyrAN3mO3heNUtu/sITlRgdCKt0xbq2SecRy8aMn8d1zNzskCFhHyAfZGR8Aeimgvfv/eCTn7bf2NWuTIVdn4dNCJ8uT10fHy6Pl326Ov0pP/55++dV8uVz+iyXssVYkOySVByS9QQa1/26fsXU5mzL2lJaYT1+C8drUGCqpS9gQmBtndJmAVcg9QnBb4CWXGhQP6P6HqKJzxn0anc/zrJ1ELbWSGu+HGro/XS7vj0cQTj9RS9oEKEyjxZ8b6kv2Px3Q6f3rMaAvnwd0oddcSRGb0I15QP3nxjM1Hzrzz6tVdkzxnB0EO6V3QXrMGyfDNna6xyNu5VF3nt6tqF1QpZh9l4zdMVQsZYuhpy12k87YMlLp1kPvbJxiKatCsD5dLDzXIjOPc2NRe1lqxTM/z0294FYu1sfzY9YmT2W4tZ/Fj83R54r4wEupy9+TW+3RuqaMdkk7wGxMHbfyn7hlyZCSKVc/PCrkAl1Mn9SFicJ9ot5Z1Ney1DHN0fjTIXOLKjc10jwJFcJsNoh8+OXfo9RsNg6eWJDz9/q9ftc4sGaDrmgUcC2gUPgoM4VRDOt4Nk5Wj7xW6L3agtQBS8dpEstSBq6AcKIuknPLM6kk1TGxmW7kTq6Cn8NthaFCR0d/dQgcBK5RUfkDb4KpeSBV46DcGPdQ0IxPgEPWeKnRe0BdcZ0T45CJBIwDrgF1QGed9Ag+OPJadr4ZHRzPA9Rc8xJJdwJTsAQqSeUKzmSND+CNaqLLELhUxqGAISCNKHwE8Zwms0Mgam5q67CislkjlI0U6BPIjUDw8dpSCFpAhj6AJV9kjp6UNlqZ/CEmkGYrWENdRHJFK8PURxIPjmtPc77fZ/ocjIBZZ2hIY+fgbPaDR8rwpdQPPp3N3usjuBvr6hYzLwOuvhiuwGazeVb6rw5l3srwbZPB92iNl8G47V66lKFqsnhdpkrGj07TW9QY62dyGfY6hMn989tH1EWFyi6uMVCF+MXZ1UVsvK/gw8+/wiVyp6Eym65a88ah2kI5mCLkusx3sI19EwoTC68ixPOu+GghQx8GBG8rHj78/JuH73ADUvdXikKZza6aTMkcbrC2NCb9bJbCNw7JZBhoECoeIOcaMgRfcSqlteTAwXbSSuqHOZzpLTQeHWxkqGIxED3KHYRBuOzXWMi4RwFGR4nB5nzvEdFrj2qNnnTR/MsQUEja6ELlTFN21qbO9ME5LKRScCtFiSHGdiYE2J686chxl927gwVdiFDhFrhD8KjDHK6eiMSTxlrjyAvZOV8YWuYpAaiFNVIHn4JwvAh7/cm+0HOCWRr9AqmDkI9wJL2aMSXdTewjHqnz99SUnzTyw37rsMD4iIhh7/NiZV9Od0NZAlXrf1PWNLGpa/E8LhRYc6m6ifL1Uz1xuKOr/bviGt1a5thPtY/c6EVkXrCEKZmj9jhZGs7eXl3C+vV8yZLJePwDl3txefHN+XfX5+QMNdIOsOP5cr4kkjU+1FxPLPXvuTf7B9cB1rv9OvV/ev71MzrgY1hYxWVckmLMu367uWOT52A6ffmtElYZH4hlt6M7+INTbUvknxp0tEatErbmTvKMRvndjgnp6bcYn3EfjfaL7/sX4Sv4w4/IF2MZlhBNG8iaq4a+WMIecPvkIduu2mTYRMjZjuMsz9GGieyzrfZgNXxzfnl+c84SRv30cAl6iEtQ/4MMvOja4XbU+UB/aVV7UWC36xasth35u6OPSvQxDtyE06pt2/8AT6PPnQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"}}');var s=n(74848),o=n(28453),i=n(33617),c=n.n(i),a=n(17543),l=n.n(a),r=n(86013),u=n.n(r),p=n(63723),m=n.n(p),h=(n(18766),n(79329),n(9303));const j={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnejDEx1sgYsQMD62kYlFiSGFMkQ1LdbjQE5JA3yCnXfbR5kkVRP622PZMMdjcXu1Ws36+KVcUdC7z0LL1jb0ze1KiDZ6uECfS5kzZIo1nKbiqEN6gwIIieC86uLoArZTYetqaBYMBhbdYI3mIuC5nvWQtnamJyI8nPWcKMRcfJwoVgKRNR/8DAEma54zUGdOTdjmleI7H1DPdSsIRJ8s7yULGnLl85s5YCwWQ/Yh4uBJhi71Aw0JljCXP4UyMdCpYG12DCfNgqMuRlbRUx4KNVRiBLC648MeQV1pylOxa2NnIGJ3XJElYYV/MwpeAjj1pSZquTrDrhXrC2XZFVb4326EnPyXJJ/w4DGNLReyrAN3mO3heNUtu/sITlRgdCKt0xbq2SecRy8aMn8d1zNzskCFhHyAfZGR8Aeimgvfv/eCTn7bf2NWuTIVdn4dNCJ8uT10fHy6Pl326Ov0pP/55++dV8uVz+iyXssVYkOySVByS9QQa1/26fsXU5mzL2lJaYT1+C8drUGCqpS9gQmBtndJmAVcg9QnBb4CWXGhQP6P6HqKJzxn0anc/zrJ1ELbWSGu+HGro/XS7vj0cQTj9RS9oEKEyjxZ8b6kv2Px3Q6f3rMaAvnwd0oddcSRGb0I15QP3nxjM1Hzrzz6tVdkzxnB0EO6V3QXrMGyfDNna6xyNu5VF3nt6tqF1QpZh9l4zdMVQsZYuhpy12k87YMlLp1kPvbJxiKatCsD5dLDzXIjOPc2NRe1lqxTM/z0294FYu1sfzY9YmT2W4tZ/Fj83R54r4wEupy9+TW+3RuqaMdkk7wGxMHbfyn7hlyZCSKVc/PCrkAl1Mn9SFicJ9ot5Z1Ney1DHN0fjTIXOLKjc10jwJFcJsNoh8+OXfo9RsNg6eWJDz9/q9ftc4sGaDrmgUcC2gUPgoM4VRDOt4Nk5Wj7xW6L3agtQBS8dpEstSBq6AcKIuknPLM6kk1TGxmW7kTq6Cn8NthaFCR0d/dQgcBK5RUfkDb4KpeSBV46DcGPdQ0IxPgEPWeKnRe0BdcZ0T45CJBIwDrgF1QGed9Ag+OPJadr4ZHRzPA9Rc8xJJdwJTsAQqSeUKzmSND+CNaqLLELhUxqGAISCNKHwE8Zwms0Mgam5q67CislkjlI0U6BPIjUDw8dpSCFpAhj6AJV9kjp6UNlqZ/CEmkGYrWENdRHJFK8PURxIPjmtPc77fZ/ocjIBZZ2hIY+fgbPaDR8rwpdQPPp3N3usjuBvr6hYzLwOuvhiuwGazeVb6rw5l3srwbZPB92iNl8G47V66lKFqsnhdpkrGj07TW9QY62dyGfY6hMn989tH1EWFyi6uMVCF+MXZ1UVsvK/gw8+/wiVyp6Eym65a88ah2kI5mCLkusx3sI19EwoTC68ixPOu+GghQx8GBG8rHj78/JuH73ADUvdXikKZza6aTMkcbrC2NCb9bJbCNw7JZBhoECoeIOcaMgRfcSqlteTAwXbSSuqHOZzpLTQeHWxkqGIxED3KHYRBuOzXWMi4RwFGR4nB5nzvEdFrj2qNnnTR/MsQUEja6ELlTFN21qbO9ME5LKRScCtFiSHGdiYE2J686chxl927gwVdiFDhFrhD8KjDHK6eiMSTxlrjyAvZOV8YWuYpAaiFNVIHn4JwvAh7/cm+0HOCWRr9AqmDkI9wJL2aMSXdTewjHqnz99SUnzTyw37rsMD4iIhh7/NiZV9Od0NZAlXrf1PWNLGpa/E8LhRYc6m6ifL1Uz1xuKOr/bviGt1a5thPtY/c6EVkXrCEKZmj9jhZGs7eXl3C+vV8yZLJePwDl3txefHN+XfX5+QMNdIOsOP5cr4kkjU+1FxPLPXvuTf7B9cB1rv9OvV/ev71MzrgY1hYxWVckmLMu367uWOT52A6ffmtElYZH4hlt6M7+INTbUvknxp0tEatErbmTvKMRvndjgnp6bcYn3EfjfaL7/sX4Sv4w4/IF2MZlhBNG8iaq4a+WMIecPvkIduu2mTYRMjZjuMsz9GGieyzrfZgNXxzfnl+c84SRv30cAl6iEtQ/4MMvOja4XbU+UB/aVV7UWC36xasth35u6OPSvQxDtyE06pt2/8AT6PPnQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},P=void 0,f={},x=[];function M(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(M,{...e})}):M(e)}}}]); \ No newline at end of file diff --git a/assets/js/18b84479.781d6d29.js b/assets/js/18b84479.781d6d29.js new file mode 100644 index 000000000..5a7d0a5f2 --- /dev/null +++ b/assets/js/18b84479.781d6d29.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>y,default:()=>O,frontMatter:()=>f,metadata:()=>o,toc:()=>I});const o=JSON.parse('{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.1/deletedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletedocument","permalink":"/docs/API-docs/v1.1/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V91u20YWfpWzc7ONQEuy47Yor9ZtjNRYNzFqFwbqCMaIPCSnGs5MZw4lC4KAXvQNetXbPlqeZHGGpETZTrbBdnuTWIfn//ebjSBZBpHeiVc2a2o0FMQsETmGzCtHyhqRipsK4RVqJIS844KzqwuQWttVgLVtgCx4rO0SITjMVKGyPWvhbc1MfkcKY5EI69BLtnCRi1TkUX/PIBLhpJc1Enr2biOMrJHZOoZ7lYtEKPbOSarEY5evvF2qHMHOf8KMLnKwxd4hstCaE4nw+HOjPOYiJd9gIgKtNRsKqnaaGfDBaZujSAupAzNkFdZSpBtBaxc5yStTikQU1teShhR8kFFLKlx1Mq9OZMjFdjtjq8FZEzCwnpPplP87DKAvR+dpDqHJMgyhaLRe/0MkIrOGOFPpRkjntMpiLic/BRbfPHWzzQQn1nPmSbXG+wQ9F9De/a8f2Hn3rXsptklfqzP6uNDJ9OTl0fH0aPrlzfEX6elX6edfjKfT6Y8iEQ+1Ztm+qJKQ9ZIivf+9fcLW1mzI2FG2zHz6XBqvbY1UKVPCipO58taUCTiNMiCQX4MspTKgJaH/C7OK3lv/8ex8mmfbQdTKaGXwvu+h+9Pp9P54l4TTj/SSsQSFbUz+94b6nP2PB3R6/3IX0OdPA7owS6lVHpfQjV2g+XvjGZqn1vzTblUtU/wuDoId0tsgA2aNV7SOm+7hSDp11H5P72a8LrhT7H5Lxu1IlUjFpN9pk81gM24Fq/TLfnc+GomVLEv03zbzGMBZQxa+s9mijbLxWqSiInIhnUyWylOraRxasaqZjzNbT6685FX0Ri4X0k+sQzM5Hk/HU7FNNo+UBGnyuX0YM1NQpdFyHqIO6dRkeTw+fkZGOvdJ/NgcfapIIFkqU/43udm+PNfcQm2XHBRp1yvSqX/jWiR9Dwy5umtVoczRx35RprBRuOuMtw7NtSpNLEs0/viq3aLObI18wKhCGI16kfe//rGTGo12ly5OwPideWfeNh6cXaEvGg3S5FBofFBzjVEM6/htd8oDylpjCHoNyhCWXvLpV6UiqYHzxGsrk07OlVY8OMxm2xs/mL0whtsKqULPn/7pESTkuETN8wayIVtLYlW7y7yyflEwqEhAwrwJymAIgKaSJmPGvhIJWA/SABpC77wKCIE8e61a36whLzOCWhpZIutOYJisHLXi+QBv500gCFY30WUgqbT1mEMfkEHMQ0ziOUMBj8DUzNbOY8Vts0QoG5VjSCCzOUKIe4JDMDnMMRA49kVlGFhpY7TNFrGAPEHgLK8tJTVjlKGPLE5emsDAogNQXQ12CXPeMirA1sHR6IeAXOFLZRYhHY3emSO42/XVLc6DIpx91o/AarV60vovDmVeK+JN8T06GxRZv95Ll4r6bTBUsvvRanqNBmP/DIZhryO3WXg6fUydVKjd5BqJOyRMzq4u4qZ/Ae9/+Q0uUXoDlV213Zo1HvUayt4UZ66tfJu23aKGwsbGqzjjWdt8jAAxUJ/B20rS+19+D/AGV6BMN1Icymh01cy1yuAGa8d3OYxGKXzjkU1STwOqJEEmDcwRQiW5lZZKggTXSmtlFmM4M2toAnpYKapiMzA9yh2EwXnZ42aYy4A5WBMlepvjvUdMrwPqJQbWxQd3joC5YghJlbdN2VobOtMF57FQWsOtykukGNtZnoPryKuWHMHz3h0seCCowjVIjxDQ0BiuHonEL41z1rMXqnW+sPx64AKgyZ1VhkIKuZcF7fUn+0bPOM3KmmdIbQrlLh1Jp2ZXknYSu4h31PE7XsqPFvnhvvVYYHy1xLD3dXGqa6e7vi2Bu/V/aWuGCLy1ZBYRDNZS6fai/Ouxnogm0NfhbXGNfqky7K7aByZ6EpknIhFaZWgCDlDK2eurS1i+HE8PTv+fGO7J5cU352+uz9kZXqRtwnoIIJwNVEszsNQ9IF/tX3gHud7s8dv/6b3Z3WjCB5o4LVVEZTHmTQen7sTg/ZkOn5qzRFQ2ELNsNjyDP3i93TL55wY947ZZIpbSKznnU86YSwX+O9+9Gz8Y7Wffd0/QF/CnX63PxtKDEMMIZCl1w79EIha4fvRy3s62SY9E2NmW4yzL0NFA9gmMPsCir84vz2/ORSJ4nx6CoEUEQd0fbOBZ1w7RUesD/8tQ7VmBzaYFWNvtjr/99EGJLsaem/M02263/wF3NPdI","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"}}');var s=n(74848),i=n(28453),a=n(33617),d=n.n(a),l=n(17543),p=n.n(l),r=n(86013),c=n.n(r),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const f={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V91u20YWfpWzc7ONQEuy47Yor9ZtjNRYNzFqFwbqCMaIPCSnGs5MZw4lC4KAXvQNetXbPlqeZHGGpETZTrbBdnuTWIfn//ebjSBZBpHeiVc2a2o0FMQsETmGzCtHyhqRipsK4RVqJIS844KzqwuQWttVgLVtgCx4rO0SITjMVKGyPWvhbc1MfkcKY5EI69BLtnCRi1TkUX/PIBLhpJc1Enr2biOMrJHZOoZ7lYtEKPbOSarEY5evvF2qHMHOf8KMLnKwxd4hstCaE4nw+HOjPOYiJd9gIgKtNRsKqnaaGfDBaZujSAupAzNkFdZSpBtBaxc5yStTikQU1teShhR8kFFLKlx1Mq9OZMjFdjtjq8FZEzCwnpPplP87DKAvR+dpDqHJMgyhaLRe/0MkIrOGOFPpRkjntMpiLic/BRbfPHWzzQQn1nPmSbXG+wQ9F9De/a8f2Hn3rXsptklfqzP6uNDJ9OTl0fH0aPrlzfEX6elX6edfjKfT6Y8iEQ+1Ztm+qJKQ9ZIivf+9fcLW1mzI2FG2zHz6XBqvbY1UKVPCipO58taUCTiNMiCQX4MspTKgJaH/C7OK3lv/8ex8mmfbQdTKaGXwvu+h+9Pp9P54l4TTj/SSsQSFbUz+94b6nP2PB3R6/3IX0OdPA7owS6lVHpfQjV2g+XvjGZqn1vzTblUtU/wuDoId0tsgA2aNV7SOm+7hSDp11H5P72a8LrhT7H5Lxu1IlUjFpN9pk81gM24Fq/TLfnc+GomVLEv03zbzGMBZQxa+s9mijbLxWqSiInIhnUyWylOraRxasaqZjzNbT6685FX0Ri4X0k+sQzM5Hk/HU7FNNo+UBGnyuX0YM1NQpdFyHqIO6dRkeTw+fkZGOvdJ/NgcfapIIFkqU/43udm+PNfcQm2XHBRp1yvSqX/jWiR9Dwy5umtVoczRx35RprBRuOuMtw7NtSpNLEs0/viq3aLObI18wKhCGI16kfe//rGTGo12ly5OwPideWfeNh6cXaEvGg3S5FBofFBzjVEM6/htd8oDylpjCHoNyhCWXvLpV6UiqYHzxGsrk07OlVY8OMxm2xs/mL0whtsKqULPn/7pESTkuETN8wayIVtLYlW7y7yyflEwqEhAwrwJymAIgKaSJmPGvhIJWA/SABpC77wKCIE8e61a36whLzOCWhpZIutOYJisHLXi+QBv500gCFY30WUgqbT1mEMfkEHMQ0ziOUMBj8DUzNbOY8Vts0QoG5VjSCCzOUKIe4JDMDnMMRA49kVlGFhpY7TNFrGAPEHgLK8tJTVjlKGPLE5emsDAogNQXQ12CXPeMirA1sHR6IeAXOFLZRYhHY3emSO42/XVLc6DIpx91o/AarV60vovDmVeK+JN8T06GxRZv95Ll4r6bTBUsvvRanqNBmP/DIZhryO3WXg6fUydVKjd5BqJOyRMzq4u4qZ/Ae9/+Q0uUXoDlV213Zo1HvUayt4UZ66tfJu23aKGwsbGqzjjWdt8jAAxUJ/B20rS+19+D/AGV6BMN1Icymh01cy1yuAGa8d3OYxGKXzjkU1STwOqJEEmDcwRQiW5lZZKggTXSmtlFmM4M2toAnpYKapiMzA9yh2EwXnZ42aYy4A5WBMlepvjvUdMrwPqJQbWxQd3joC5YghJlbdN2VobOtMF57FQWsOtykukGNtZnoPryKuWHMHz3h0seCCowjVIjxDQ0BiuHonEL41z1rMXqnW+sPx64AKgyZ1VhkIKuZcF7fUn+0bPOM3KmmdIbQrlLh1Jp2ZXknYSu4h31PE7XsqPFvnhvvVYYHy1xLD3dXGqa6e7vi2Bu/V/aWuGCLy1ZBYRDNZS6fai/Ouxnogm0NfhbXGNfqky7K7aByZ6EpknIhFaZWgCDlDK2eurS1i+HE8PTv+fGO7J5cU352+uz9kZXqRtwnoIIJwNVEszsNQ9IF/tX3gHud7s8dv/6b3Z3WjCB5o4LVVEZTHmTQen7sTg/ZkOn5qzRFQ2ELNsNjyDP3i93TL55wY947ZZIpbSKznnU86YSwX+O9+9Gz8Y7Wffd0/QF/CnX63PxtKDEMMIZCl1w79EIha4fvRy3s62SY9E2NmW4yzL0NFA9gmMPsCir84vz2/ORSJ4nx6CoEUEQd0fbOBZ1w7RUesD/8tQ7VmBzaYFWNvtjr/99EGJLsaem/M02263/wF3NPdI",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,v={},I=[];function P(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(d(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function O(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.e44b2367.js b/assets/js/19e5ad2a.e44b2367.js deleted file mode 100644 index c20dc0d90..000000000 --- a/assets/js/19e5ad2a.e44b2367.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>V,contentTitle:()=>g,default:()=>T,frontMatter:()=>u,metadata:()=>i,toc:()=>x});const i=JSON.parse('{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/v1.1/contactlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/contactlist","permalink":"/docs/API-docs/v1.1/contactlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar_label":"Get Contact list","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tu5LgR/ZUKX5JtyH3xzGwQPa0xGDhGjB0j9sJAPMaAkqoluimSS5a63Wg0sA/5gzzlNZ82XxIUdWm17dmNk8UigGFbxbpfWIc7QbIMIr0T760hmVMQ94koMOReOVLWiFTcVAjdKVyqQHB2dQFYO7tBH2BrGyALHskrXCNI0Mxjl5B3GhNw3q5VoUwJEnJbO48VmqDWCGuFG+aVWoNcS6VlpnGQBGVYv+8JmbWrqUiEdegle3dRiFR0h2xWJMJJL2sk9BzVThhZo0iFVrXiU8UB/dig34pEePyxUR4LkS6lDpiIQFvN3Evra5EIfHTaFihS8g2f5hXWUqQ7UctHVTe1SN/N54mgrWMh09QZerFnOVk7VrSY75PBhbBS7lfz4Os25/t71hucNQED857O5/znuKihyXMMYdloGLIpkphLNMT80jmt8ngwewgstHvugM0eMI9p96yGVGvSY2g0jfik95IDVoR1+GX5lszVHTgDeWVKkcTUSBpThtiFqxZZ9Xj64Dglbd5fp+DBImSIMaO1VPq/kM8Qv+sI09zWrMpV1rzalbeLN4vT+MMqeGyk2b5WiXU8aKVhFQ82+0yK9Ks9KXAdXfAoCYszekn+wH06P31zspifzP94s/g2ffun9N230/l8/jeRiMc6JrQbiEJSTHTn0/DduOI3sLN/ytZdIwWSVDqMBboTsd+PiMpoZfBzP2mfecr2kePtS/N2bWukiq/ADRqCjbemTMBplAGB/BZkKZUBLQn97369QUTvrf/5PL7Os59Lwdv5/PNiSMK750m4MGupVREXyI1dofltIx2bp9b88zZQLVM8F0fBjultkAHzxivaxk3zeCKdOmnP07t7voY5sZZXVIntaqJKpGJ2vLAC+nW/rRqvRSoqIhfS2SxIU2T2cdoPsZZZ4CtlJp2arRdTvhieykjnXsWPzclrRQLJUpnyl+TuD/m55hq2ZTrK0mE9OPUX5P3QFWHM1a3MCmXBq27P30sbhbvSfHRorlVpYmGj8acQ5hZ1bmtkoEIVwmTSi3z5+78GqckECps3NRqKLTj9ZD6Zj42HiHR4U0pTwFLjo2KQ8hIKCihrjSHoLShDWHpJCIUqFUkNnCces1w6mSmtuHOZzbYYZ9T8YQq3FVKFno9+7xlVFbhGzQ0PsiFbS2JVvb+wsX611HYTEpCQNUEZDAHQVNLkzNhXIgHrQRpAQ+idVwEhkGevVeubNeQZ6NXSyBJZdwLjZBWoFbcreJs1gSBY3USXga9N67GAPiCDWISYxA8MYzxCC+XG+K9sVIEhgdwWCCEOKodgCsgwEDj2ReUYWGljtM1XsYDLRmtwlu8NJTUDyLGPLE5emsBLrfWlr8GQMOct4x9sHZxMfgjIFb5UZhXSyeSTOYG7oa9uMQuK8P4P/QhsNptnrf/Nscy5oj83GfwVnQ2KrN8epEtFVZPFcRkrGT5aTedoMPbPaBgOOgqbh+fTx9RZhdrNrpG4Q8Ls7OoiXrXfwJef/gGXKL2Bym7abs0bj3oLZW+KM9dWvk3bcFPC0sbGqzjjedt8DF4xUJ/B20rSl5/+GeB73DBwb0eKQ5lMrppMqxxusHa8R8JkksL7CCeAehpQJQlyaSBDCJXkVlorCRJcK62VWU3hzGyhCehho6iKzcD0KHcUBudlKHeATAYswJoo0ducHjxieh1QrzGwLmOJ3cBCEXd05W1TttbGznTBeVwqreFWFSVSjO2sKMB15E1L5oSP3MElDwRVuAXpEQIamsLVE5F40jhnPXuhWueXVmu74QKgKZxVhkIKhZdLOuhPDo0eUZuy5gVSm0I5pCPp1AwlaSexi3igTj/xpfzkIj++bz0u0bPBGPahLk517XTXtyVwt/4vbd2C4xagMQxoUTtvlO+e6onrHH0dPi6v0a9Vjt1W+8pEzyLzTCRCqxxNwBFMODu/uoT1m+lcJKP1+B8M9+zy4v2H768/sDN8kbYJW0zn03l8KthAtTQjS+dIw/O7gwxHyd4dENT/4VO9W/CEjzRzWqqIqWLCdh0eujt6wN8norKBmLzb8dD+4PV+z+T2zcwoqVCBbR9ezSvcjt74a6kbthmhy1d4u8f4gfWeP7xi3ojekh5wsMFW5izP0Y0NPIOrR5jv/MONSATfmcdAZxWBTvcPa++PzHak+xgBtQ7wb47pRYHdrgVR+/3A3x59VaILsOfm0tzv9/t/A7ATTaM=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"}}');var s=o(74848),a=o(28453),n=o(33617),r=o.n(n),l=o(17543),c=o.n(l),p=o(86013),d=o.n(p),m=o(63723),h=o.n(m),b=(o(18766),o(79329),o(9303));const u={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tu5LgR/ZUKX5JtyH3xzGwQPa0xGDhGjB0j9sJAPMaAkqoluimSS5a63Wg0sA/5gzzlNZ82XxIUdWm17dmNk8UigGFbxbpfWIc7QbIMIr0T760hmVMQ94koMOReOVLWiFTcVAjdKVyqQHB2dQFYO7tBH2BrGyALHskrXCNI0Mxjl5B3GhNw3q5VoUwJEnJbO48VmqDWCGuFG+aVWoNcS6VlpnGQBGVYv+8JmbWrqUiEdegle3dRiFR0h2xWJMJJL2sk9BzVThhZo0iFVrXiU8UB/dig34pEePyxUR4LkS6lDpiIQFvN3Evra5EIfHTaFihS8g2f5hXWUqQ7UctHVTe1SN/N54mgrWMh09QZerFnOVk7VrSY75PBhbBS7lfz4Os25/t71hucNQED857O5/znuKihyXMMYdloGLIpkphLNMT80jmt8ngwewgstHvugM0eMI9p96yGVGvSY2g0jfik95IDVoR1+GX5lszVHTgDeWVKkcTUSBpThtiFqxZZ9Xj64Dglbd5fp+DBImSIMaO1VPq/kM8Qv+sI09zWrMpV1rzalbeLN4vT+MMqeGyk2b5WiXU8aKVhFQ82+0yK9Ks9KXAdXfAoCYszekn+wH06P31zspifzP94s/g2ffun9N230/l8/jeRiMc6JrQbiEJSTHTn0/DduOI3sLN/ytZdIwWSVDqMBboTsd+PiMpoZfBzP2mfecr2kePtS/N2bWukiq/ADRqCjbemTMBplAGB/BZkKZUBLQn97369QUTvrf/5PL7Os59Lwdv5/PNiSMK750m4MGupVREXyI1dofltIx2bp9b88zZQLVM8F0fBjultkAHzxivaxk3zeCKdOmnP07t7voY5sZZXVIntaqJKpGJ2vLAC+nW/rRqvRSoqIhfS2SxIU2T2cdoPsZZZ4CtlJp2arRdTvhieykjnXsWPzclrRQLJUpnyl+TuD/m55hq2ZTrK0mE9OPUX5P3QFWHM1a3MCmXBq27P30sbhbvSfHRorlVpYmGj8acQ5hZ1bmtkoEIVwmTSi3z5+78GqckECps3NRqKLTj9ZD6Zj42HiHR4U0pTwFLjo2KQ8hIKCihrjSHoLShDWHpJCIUqFUkNnCces1w6mSmtuHOZzbYYZ9T8YQq3FVKFno9+7xlVFbhGzQ0PsiFbS2JVvb+wsX611HYTEpCQNUEZDAHQVNLkzNhXIgHrQRpAQ+idVwEhkGevVeubNeQZ6NXSyBJZdwLjZBWoFbcreJs1gSBY3USXga9N67GAPiCDWISYxA8MYzxCC+XG+K9sVIEhgdwWCCEOKodgCsgwEDj2ReUYWGljtM1XsYDLRmtwlu8NJTUDyLGPLE5emsBLrfWlr8GQMOct4x9sHZxMfgjIFb5UZhXSyeSTOYG7oa9uMQuK8P4P/QhsNptnrf/Nscy5oj83GfwVnQ2KrN8epEtFVZPFcRkrGT5aTedoMPbPaBgOOgqbh+fTx9RZhdrNrpG4Q8Ls7OoiXrXfwJef/gGXKL2Bym7abs0bj3oLZW+KM9dWvk3bcFPC0sbGqzjjedt8DF4xUJ/B20rSl5/+GeB73DBwb0eKQ5lMrppMqxxusHa8R8JkksL7CCeAehpQJQlyaSBDCJXkVlorCRJcK62VWU3hzGyhCehho6iKzcD0KHcUBudlKHeATAYswJoo0ducHjxieh1QrzGwLmOJ3cBCEXd05W1TttbGznTBeVwqreFWFSVSjO2sKMB15E1L5oSP3MElDwRVuAXpEQIamsLVE5F40jhnPXuhWueXVmu74QKgKZxVhkIKhZdLOuhPDo0eUZuy5gVSm0I5pCPp1AwlaSexi3igTj/xpfzkIj++bz0u0bPBGPahLk517XTXtyVwt/4vbd2C4xagMQxoUTtvlO+e6onrHH0dPi6v0a9Vjt1W+8pEzyLzTCRCqxxNwBFMODu/uoT1m+lcJKP1+B8M9+zy4v2H768/sDN8kbYJW0zn03l8KthAtTQjS+dIw/O7gwxHyd4dENT/4VO9W/CEjzRzWqqIqWLCdh0eujt6wN8norKBmLzb8dD+4PV+z+T2zcwoqVCBbR9ezSvcjt74a6kbthmhy1d4u8f4gfWeP7xi3ojekh5wsMFW5izP0Y0NPIOrR5jv/MONSATfmcdAZxWBTvcPa++PzHak+xgBtQ7wb47pRYHdrgVR+/3A3x59VaILsOfm0tzv9/t/A7ATTaM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,V={},x=[];function P(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,s.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,s.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(c(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function T(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.e69f4137.js b/assets/js/19e5ad2a.e69f4137.js new file mode 100644 index 000000000..01374c670 --- /dev/null +++ b/assets/js/19e5ad2a.e69f4137.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>I,contentTitle:()=>f,default:()=>j,frontMatter:()=>v,metadata:()=>i,toc:()=>F});const i=JSON.parse('{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/v1.1/contactlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/contactlist","permalink":"/docs/API-docs/v1.1/contactlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar_label":"Get Contact list","hide_title":true,"hide_table_of_contents":true,"api":"eJzNWF9v47gR/ypTvrRnKP6T3b2ifrpgsUiDbneDSw4Bmg0WlDSWGFMkjxzZMQwD99Bv0Ke+9qPtJymGlGw5yd417eFQIEii4cxw/s9P2gqSVRDzW/HWGpIFBXGXiRJD4ZUjZY2Yi+saoTuF9yoQnF1eADbOrtEH2NgWyIJH8gpXCBI089gFFJ3GDJy3K1UqU4GEwjbOY40mqBXCSuGaeaXWIFdSaZlr3EuCMqzf94Tc2uVYZMI69JKtuyjFXHSHfK3IhJNeNkjo2autMLJBMRdaNYpPFTv0Y4t+IzLh8cdWeSzFfCF1wEwE2mjmXljfiEzgg9O2RDEn3/JpUWMjxXwrGvmgmrYR8zfTaSZo41jItE2OXuxYTjaOFc2mu2xvQlgq96tZ8PU7p7s71hucNQED855Op/znOKmhLQoMYdFq2EdTZDGWaIj5pXNaFfFgch9YaPvUAJvfYxHD7lkNqXSlx9BqGvBJ7yU7rAib8MvyiczZ3XMG8spUIouhkTSk7H0Xrp7l9cPpveOQpLi/TMG9RcgRY0QbqfR/IZ8jftcRxoVtWJWrrXmxKa9nr2an8YdVcNtIs3mpEuu40SrDKu5t/pkU6RdbUuIqmuBREpZn9Jz8gft0evrqZDY9mf7xevbt/PWf5m++HU+n07+JTDw0MaBdQ5SSYqA7m/bPrSt/g3t2j9m6MVIiSaXDUKA7EbvdgKiMVgY/9532mbtsFzleP9dvV7ZBqnkErtEQrL01VQZOowwI5DcgK6kMaEnof/frNSJ6b/3Px/Fllv1cCF5Pp59n+yC8eRqEC7OSWpVxgVzbJZrf1tPh9ZSuf1oGKjHFc3Hk7JCenAxYtF7RJm6ahxPp1Ek6n9/e8RjmwFpeURWm1US1mIvJ8cIK6Ff9tnpUM2tZVej/3ObR5LOWLPzVFsvkV+u1mIuayIX5ZLJSnpKmcUhidZvz/Jlcerlotf4gV0vpJzwQJrPxdDwVvJuOlQRpytw+jPupoWUeog7p1GQ1G8+ekZHOvYgf25OXigSSlTLVL8ndHRJyxUWT6uIoLYd95NRfkBdSl/UhV7eja5Ql79YdPy9sFO5q4aNDc6UqE9MSL3+MmW5QF7ZBRkZUI4xGvciXv/9rLzUaQWmLtkFDsebHn8wn87H1EKEVr2ZpSlhofFCMip6DXQFlozEEvQFlCCsvCaFUlSKpgePEfV1IJ3OlFbcKs9kEqgbdFsZwUyPV6Pno955hXIkr1NxhIFuyjSRW1dsLa+uXC23XIQMJeRuUwRAATS1NwYx9JjKwHqQBNITeeRUQAnm2WiXbrCHPyLKRRlbIujMYBqtErbg/wNu8DQTB6jaaDDynrccSeocMYhliEN8xbvIICTsOAWfVqhJDBoUtEUKcDOyCKSHHQODYFlVgYKWt0bZYxgRyB4GzPKiU1IxYhzayOHlpAm/RZEufg33AnLcMuDAZOBr9EJAz/F6ZZZiPRp/MCdzu6+oG86AI7/7Qt8B6vX5S+t8cy5wr4knxPTobFFm/OUhXivppMFSyf0iaztFgrJ9BMxx0lLYIT7uPqZMatZtcIXGFhMnZ5UWc7d/Al5/+Ae9RegO1XadqLVqPegNVfxVHLmU+hW0/mmFhY+HVHPEiFR+jZQzUR/CmlvTlp38G+IBrflNILcWujEaXba5VAdfYOF5cYTSaw9uIX4B6GlAtCQppIEcIteRSWikJElyS1sosx3BmNtAG9LBWVMdiYHqUO3KD47JPd4BcBizBmijR3zk+WMT0JqBeYWBdxhKbgaUiruja27ZKtw2N6ZzzuFBaw40qK6To21lZguvI60TmgA/MwQU3BNW4AekRAhoaw+UjkXjSOmc9W6GS8QurtV1zAtCUzipDYQ6llws66M8OhR5horLmGVIKodyHI+vU7FOSOrHzeE8df+Kh/GiQH89bjwv0fGF0+5AXp7pyuu3LErha/5eyTmg8IULGHek1gTfKd4/1RPyAvgkfF1foV6rAbqt9paMnkXkiMqFVgSbgAJecnV++h9Wr8fRo9f8HzT15f/H23Yerd2wMD9IUsB4CCGcDNdIMbjpH2r/vdxjlKNjbA2T7P/w20C14wgeaOC1VBHExYNsOgN0efTG4y0RtAzF5u+Wm/cHr3Y7J6SU9wjIV+O7Da/oSN4OPCiupW74zQpev8HZv/wfWO37winkjXMx6wMEXJpmzokA3vOAJPj4CmefvrkUmeGYeA51lBDrdP6y9PzKbge5jBJQM4N/s07MC220CUbvdnj8dfVWic7Dn5tTc7Xa7fwNscHVO","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"}}');var n=a(74848),o=a(28453),r=a(33617),s=a.n(r),c=a(17543),l=a.n(c),p=a(86013),m=a.n(p),d=a(63723),g=a.n(d),u=(a(18766),a(79329),a(9303));const v={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNWF9v47gR/ypTvrRnKP6T3b2ifrpgsUiDbneDSw4Bmg0WlDSWGFMkjxzZMQwD99Bv0Ke+9qPtJymGlGw5yd417eFQIEii4cxw/s9P2gqSVRDzW/HWGpIFBXGXiRJD4ZUjZY2Yi+saoTuF9yoQnF1eADbOrtEH2NgWyIJH8gpXCBI089gFFJ3GDJy3K1UqU4GEwjbOY40mqBXCSuGaeaXWIFdSaZlr3EuCMqzf94Tc2uVYZMI69JKtuyjFXHSHfK3IhJNeNkjo2autMLJBMRdaNYpPFTv0Y4t+IzLh8cdWeSzFfCF1wEwE2mjmXljfiEzgg9O2RDEn3/JpUWMjxXwrGvmgmrYR8zfTaSZo41jItE2OXuxYTjaOFc2mu2xvQlgq96tZ8PU7p7s71hucNQED855Op/znOKmhLQoMYdFq2EdTZDGWaIj5pXNaFfFgch9YaPvUAJvfYxHD7lkNqXSlx9BqGvBJ7yU7rAib8MvyiczZ3XMG8spUIouhkTSk7H0Xrp7l9cPpveOQpLi/TMG9RcgRY0QbqfR/IZ8jftcRxoVtWJWrrXmxKa9nr2an8YdVcNtIs3mpEuu40SrDKu5t/pkU6RdbUuIqmuBREpZn9Jz8gft0evrqZDY9mf7xevbt/PWf5m++HU+n07+JTDw0MaBdQ5SSYqA7m/bPrSt/g3t2j9m6MVIiSaXDUKA7EbvdgKiMVgY/9532mbtsFzleP9dvV7ZBqnkErtEQrL01VQZOowwI5DcgK6kMaEnof/frNSJ6b/3Px/Fllv1cCF5Pp59n+yC8eRqEC7OSWpVxgVzbJZrf1tPh9ZSuf1oGKjHFc3Hk7JCenAxYtF7RJm6ahxPp1Ek6n9/e8RjmwFpeURWm1US1mIvJ8cIK6Ff9tnpUM2tZVej/3ObR5LOWLPzVFsvkV+u1mIuayIX5ZLJSnpKmcUhidZvz/Jlcerlotf4gV0vpJzwQJrPxdDwVvJuOlQRpytw+jPupoWUeog7p1GQ1G8+ekZHOvYgf25OXigSSlTLVL8ndHRJyxUWT6uIoLYd95NRfkBdSl/UhV7eja5Ql79YdPy9sFO5q4aNDc6UqE9MSL3+MmW5QF7ZBRkZUI4xGvciXv/9rLzUaQWmLtkFDsebHn8wn87H1EKEVr2ZpSlhofFCMip6DXQFlozEEvQFlCCsvCaFUlSKpgePEfV1IJ3OlFbcKs9kEqgbdFsZwUyPV6Pno955hXIkr1NxhIFuyjSRW1dsLa+uXC23XIQMJeRuUwRAATS1NwYx9JjKwHqQBNITeeRUQAnm2WiXbrCHPyLKRRlbIujMYBqtErbg/wNu8DQTB6jaaDDynrccSeocMYhliEN8xbvIICTsOAWfVqhJDBoUtEUKcDOyCKSHHQODYFlVgYKWt0bZYxgRyB4GzPKiU1IxYhzayOHlpAm/RZEufg33AnLcMuDAZOBr9EJAz/F6ZZZiPRp/MCdzu6+oG86AI7/7Qt8B6vX5S+t8cy5wr4knxPTobFFm/OUhXivppMFSyf0iaztFgrJ9BMxx0lLYIT7uPqZMatZtcIXGFhMnZ5UWc7d/Al5/+Ae9RegO1XadqLVqPegNVfxVHLmU+hW0/mmFhY+HVHPEiFR+jZQzUR/CmlvTlp38G+IBrflNILcWujEaXba5VAdfYOF5cYTSaw9uIX4B6GlAtCQppIEcIteRSWikJElyS1sosx3BmNtAG9LBWVMdiYHqUO3KD47JPd4BcBizBmijR3zk+WMT0JqBeYWBdxhKbgaUiruja27ZKtw2N6ZzzuFBaw40qK6To21lZguvI60TmgA/MwQU3BNW4AekRAhoaw+UjkXjSOmc9W6GS8QurtV1zAtCUzipDYQ6llws66M8OhR5horLmGVIKodyHI+vU7FOSOrHzeE8df+Kh/GiQH89bjwv0fGF0+5AXp7pyuu3LErha/5eyTmg8IULGHek1gTfKd4/1RPyAvgkfF1foV6rAbqt9paMnkXkiMqFVgSbgAJecnV++h9Wr8fRo9f8HzT15f/H23Yerd2wMD9IUsB4CCGcDNdIMbjpH2r/vdxjlKNjbA2T7P/w20C14wgeaOC1VBHExYNsOgN0efTG4y0RtAzF5u+Wm/cHr3Y7J6SU9wjIV+O7Da/oSN4OPCiupW74zQpev8HZv/wfWO37winkjXMx6wMEXJpmzokA3vOAJPj4CmefvrkUmeGYeA51lBDrdP6y9PzKbge5jBJQM4N/s07MC220CUbvdnj8dfVWic7Dn5tTc7Xa7fwNscHVO",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,I={},F=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,n.jsx)(s(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,n.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(l(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,n.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/23f866da.77dde85a.js b/assets/js/23f866da.77dde85a.js new file mode 100644 index 000000000..89bb0c21d --- /dev/null +++ b/assets/js/23f866da.77dde85a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zG0dyf6WzlSpZuAVAQJSssBTV0ZJjK9FJLJMq1YXk0YPdBnbE3Zn1zCxBmIUqP9w/yFOqkpf7afolqe6ZXeyCIClZOltJ4AeZmI+e7p7unu6enr2KnJjZaO84eq6TqkDlbHQaRynaxMjSSa2ivegoQ7CYT62cKdg/eAEzVGiEQwsC3vzwElwmHKASkxwtTA2idYscgcZLNQM9BQFpgD+AP+sKEqFA5FaDVElepQiaFxM5lAb7KU6lwhTmMp2hszHMM5lk4DIPEw3Px1Q60AbwshQqharUCoQFhZhiOoCjTFoojb6QKSNaY4OXJRqJKiFghcyFAacZ9vtf/uuQSPyzrgzR+/6X/4ZprucgFfe/LlHxAFGWgxN1oo5kuQdvylyLFBa6MnDw/F8aQgkqtR33es9xUs3gzYte7/SrzLnS7g2HBEOXqAitXEzsINHFMKWBZTq9TySjQYLqaRVW5gsQaYspLkMFiS4XkGhtUqloR2IoxQxBVcUEjY2BOFNog0SDAIMiXfSd7lcW4V8PX7+CqTaFcAM4yCsbN8ul0mDi8oUHT7TXVN2zMBEWH+2CdUaqWQyFOCe2Sgc/VTI5J7ItqrRm6v7BC+ZVr3dYlaU2DlN460nY6/Wo5xskHguDPD7RRaEVlMKIAh0a66WLug3+VEnDcuEyEHle82LvRPWh11OiwL1eD94o+VOFIFNUTk4lGqISHMmDnzDw492i5PEvVCoTFmdCgFpJZDtDiak09LDEhED6oS1Wg1ZBSomHc+H3v8xF4skyaEtMnLzALuDLGBYE+DkqXWOQaSN/1sqJnLfvAo2Ticjb20wIsjo4YRyxv9RSubo1rNBoGu02b2KQQ0ItJeYWUnGPRbgQeYU2YDWPISOsfsDSoCWrUMMlxqsUMpSz7Mb1RPqusq4DGCpLaLaxCGvVu8rsRWbbVOQWQU47vCzEObZWayzGAL5ZQIpTUeUuBkkS6kyFA3ilHWlqLhMyTCwDpGzCVQb7vMtBfAZd8TlY2YxUTqdoSJmpk0GEOTV2JJfeyBB5rGkuEwq0WtvoROfaXBchbu7yERKtHFvK/Qshc0beE2sbcznJRXIewySvMAaDqVf0Bea5nsdeP3gIGUTPc+YPmXGSQq0If6XD8tKCDVg1hrPWP+psjDMtIm2bq0HLp5pWJhbUKglYCJnHzLgY3ukJOOlyjEnBS6EWMaTCYQwOL91EX8aQZJicT/Rl4NdUK2flzxu0ru75eK6NY9iN4VEMj2MY7cQwGscw2o1h9CiG0eMYxjsxjMcxjHdjGD/yPB0/DvwUDRPbCIzGnpPuy+Ig2duX0rKGkqG0je2dd2zvaAC9XqMV1Pbjjz+eqKsTBXASkZKcRHtwEjVDTqLY95Hto75R+H1JPx6Mvw4/F/Tz0fhx+DnnoaPd8DOjn+PRiVqGBU/UmDFxoihvwYK6PysG4VcQFGrjRamttkvUSAYlrjtoPzr4UMeyTcsDokUq6aTI7c3k1CO+IIpWKF0japeIYpG8mSLu/oLIaeNDPWzufBebx1ZXrdSMxfga9Q8H4YS4mXi/7BdDewudTyP9EZFO5ueIzM/N9DcW6gtiwjpOn8aJrwd8kLP1vZkPYcAXxIUuRp/Gg8fEAzp4bmYA9X5B1LfQoY5wivu+nd3+6GF/vDPe7XCAYiI/oCj6adpfLBafg3vk14Tlya2pPU3voQmHMDW62BBGsJe/GhX8Hv67dr3/RA73pPZFMa1j1sYraSK9trfsdCoW96wHVU9tHDAav3K/Fi00uYvw4Kg3ybRMAvI0pna7JhTYDYgHfebkME2HLU5SY5r2i6K/1kg/+8z4VmNRDNJ0sDby2u74xgLSNIbrzRvb0xSKorih2bd3modFcZ2KQVEE3JjeE/VPpCbBM7tZU8KA30pZVjrRXfhWRaKcgVY5r82B2WZNWjtuMqlCRxArWBtgcFblwuAlRZhWauVHf34tq5Vs5b9zRBpyAli7z/DV6+Cj3w8KQCR0AVDL3fOuUUZA9iGprNMFGJzhJZTCOTSKgV2IXKaCg7I+N+ClKEpy9Id/OTlJ//CPQ04lULTugHYCUjmTlAEa/uV4v//vpxtGVGWJJhEWIUdaycaALhnAcYZ5uUpCzefzwfyBTTKtc5+BemcNTv2/Z3ry7ozRLQfClvc3UepFoxW6k+isR+4WXYdjwkI9c0PwzjLGIcxoh8/bENXccuCGEV/QmbOGEnX6PAh1H59EhWCXhEQZV39rl6E5iU6bOT5cx/SOuacfoKyZTDEXE8yvd32wojXNuVjoKuh3nZ7qkhokusU36iikajIQTM5O3OoUl2udvm+5Qb89Q9raWR86tXrWOwC5tHUOpsvO9uyQpOJUIyWQSWwnCPUEmDRS+sla0CD2YWrgLVHYuzuWoHHAA5sEYZMTuH2Fzsa0GUMwCqlkURVNpnPaQK1ZVgTvo80vmllZNPUK7d29toK4vGMFSivevMCJGnEmQxZidotjyt1fkJUI+FzzsUecDPHMuCXe5P7byRntdMh52CXn0c6vcB06y36657DTslC1y/CtorTZtYXI7axyUTsKn8NPCCBJHp/poqycl8fgIZBDyza5Fsw6+euT2X+IoR9DL4ZhDF/FcH8APyCni5MmtRzkVBqfQJYKUl1R1i+pTL6AiREJ3dngYDaAq6ufKqGcdIvlEnpwdUVXbMvlgDT7XOm5zy4fX0grHdDt0OocT3ViN9wm6cQO6cAfvsJ5v77gGwbU7sNXes2S3eo1BRZ8rJt007S/q+8QxZEu6YpSavUijfai+voyillc0bpvdLqI9q6ikDamP0NSliYN31m6+ryKbJJhIeivWszpsnQqc4ziyF9G2iiOOMdAN6ekntFepCfvMHFRTN5vSQckWoLB8/au6lH+Ci2KQ8QZ7UX+bi2Ko+ADNk2AKtEU15XpNFrWC94GqmlZgbL8R3OXR3Do1ulXgnlFU5drl8W/CtLzFgSmrcAjTfqYo8PnYmFbcL08Ret31DSH5CUJsyAVC0uZ9sr60zwReVLlFL3iZSnNogmlOYRtWNLCt1mpwXf0cFlvegujG/ba6I/foAQ1MYDTlh87953GCeIfQwMZAN5fUXw0Fu80wgR5b8tMq4+ePxo/GI1HD0ZjghByTx8LozZmBOKdnpz9KnlP8YLmB4PXmi2MEYsojqTDwt69lb73+tpdEdynCxxMa1+yv7ptjIFvCgZ3aUM9njkvZni32B/ddAvduhizma7ylK6cUJgBXwb/6rqEriY1R+XgDr1ZxtHl3cRcQqL79RU3fJXj1PlAFhJtFJr77fzYF0PceHd3GUeLu8lb/K8k72vavPnd1L3l2oBV3cTvgeuDx8s4yu7G9fumeuF3RHb30XJ1jkeJQeHQYVESkLOJThdntd1atgfWnkx9Yvmh4VBa0op5ioacnuv2amVqaCRV6ZytHzUTrXMUaoOh6VxpC7J1lj01ctJCgnieIXvLjQPH0G0TTAeXzntNdE2Oazk5aSnCMRWeRAN4MW354hzOrt+q12P5Vl1puMfrndmKzfi9YfhNHLrXriiioo1VYrxGgQdDvQVUK5TnhDd5EANo/mPvsuEkIVCf2PXCdx8Vz3wukBcMk7r1KRC81AE8E6qpX+jWCcDVVSMELB3LJVxd0a6iOaNzf7mMVw20VqeBj3bfYjBBedGZ1TThamLT1prqnamzlEMVagjnfRsBX3h3VpkAh3zO5XLQEcg1xCFjR595gGkjZ1R8d53qxmXinf5g7l9jdpAAAvL/hu9Pyqffyw2oPBmWT5+UT99SNVqJXvc8e6ZSpV7z55jnA3hindFq9nSNBU+GoX3zVhq8kDhnxeVdXUFZ520DaBBwovLM1uZJC4mpEilyToIbnWBdIsjxJ146sA5LS7GjdL4OlIuJ2PMXM4PI9ZqEi6gcV99xEFgv+ERAZnD6z/fWeHrvKVeDUij+ZCiehtEvfACbiQsEoRbAhHNqUhufW5xWhs1kkgsjpyHijKHMkRL2FJCKxEe9nqM1HkeZUOc2fjIxT49QFE096vu//o1GsBpwEe6RrswH2HSOt/t+b30qwNs8DwQEzCq+SnTEp9o88V3CquJNKutM5bN6kFamLvKrq215P6wdhJq+PqTS+rKnDNvwY0Bl/XQBU2EdmhgqJSkTZKqSJOd6AW9HlHmBJcX3vnqV9uhuW9AtLaNiZl9426o1rs+BGjCGWuMQajZljXXd7zrpGw/eoCd3I0iHJOeOQkK3RGO1IlnSZiZUEFXv+GtLgVsmcj/U66uki1jCh87fwcYg6/1f/9bC68bo8zpifgWRpnTTdQeGnMalfK3lZK7BMl+A012MCB6aP677WoRdgWaGZwlFZawz+AES3uuRjPd60Pc1eUG8beXLNF1dccz7SFu6gk58C/a/uUyvkwtpp9B7AN/rOV6QwAYVJkPr4WvKBTLmaexBtFZIhKLCQXaNyDshwM0leiE4WRiW8BV9LOJMTTAydHHn1+MKWVonvo2mWpSbKgHBlfFhdS/wnjjKVIHINdcjulbtfdpF6gUXP2ZsCixl6ygT59epq471XKF5/8t/UjV+nR+1jXu3sZc9NH4fwJWVbai1t1aXCQ+6/pi3Anf5y96lXmX0ghdHRdpaWR/0j3d26H9dgaqTqOD99RRslZCST6s8X/xDFH94OvH2jINv3uzF35ZCyN7J8c+XycX4gFTmBgt4K4AQ8VQmp3cCxLl+s+GsiS3eSpVLhWc1287GOztnI+LtMo52N7HvUBfohWVOTJzTud5ojTMLEDMSe/K/zWfkJhqjze0B0cdhdhsTdjtMeHidCS8U34/yS5ojfY7qt6W0vbzzyxOqlwXLij+UIukHcX/UIbbd7om0mFRGukW0d3wVXfZFKfu+f+/4dHlKhttlmpLwpbaMsXBZtBcNWzl5i+aCEukEYU1i5mI2Q/N9NWGE9yun4U86OfdUsYA3MnshjfOQBtZPy6oJh+oHRpCGvhIX58IM6XQZjgY7g51oGV+tAbFCpXRfei3cF6UcXowGow1zNqYHbhmPVf9jp1gnZlLN7pp3utqOQxIZLxWdTVklQUv5b0hZ0LDn7VFxJIn7GYqU0gqUhLVa/bC6Ovm2lqf6UmPTPUXLCq/dPNQXD527hPXTe8PtwObLgdHDdlreJ945l96k0jdlxxvC63x3k+5uZbBbCexVTrqTkuYscyvJfLxSviafW6dzR5wHHe/ucsLw6xFn1h485qTV7qPlaSd/E0XdHA3fra5nGj4tcO7Gzdtg8P9QMNiNBf31+1psVAtYE4t0AoL1eOBG33yja15HY1JNNducoCzNG0qy5myzriWSMU900byL6fValDWzer3GlvjdIV/0dWWg1HM008o/tJnmeCkp2KRpWHDfKmmJosjR2nwBFGXO2APmyjqRNzFcIkoxkbmk85WG6SAnqyPaDuDtKu15z/gr8wvM6VgmEdKF4BixiQ/n2pzTs1J6nQkTKiWg4AlVJlTi4zRvwGOSEXr7STFwaaSl536GsJYeN62cIeEohBIzFtu4LQaQYk5abMHoCRXoWJ1XXvickLk2/mKUCSJRtMzEby9L6uJsOJk+gxnt90WI1i09P0oRvG0OD0wnlDwrCRdJzrvTUKlc01tQSpxVeQ6lJu+G1FJPOzjSdGeEsuSUhrvYsAcNw0IgjTaEQW8s0g6/lOrcv2Pqw3EjV29xYqXDbo3jusze7875TjpyMH7AUlvptFmsZs+kq52INpDmh4f0XXgQDa0z9MOrMw7RkYTY4f7BC3YI78P7X/4DXqIwCjI999KaVAbzRfP22r/s5Z33bGv8OU7VkO0ijide+ILJrTn4NhOOY65XyK+bvUr5woyDapLLBI7qPHivtwfPONpp5cY7NVmZIFG6kAIElH52LtX5APbVgiP+lQGmdp7XIYONfr3d/oFxClqFwg+/5mCFEbUXFvMLtK0Ymp6Dk0RnRlczv1obmUCcwSlFkeEFMtG2n6YcesrVe2J+H7tCB6f+WScu/M0Bx/wHa1O4p3llFxIGq6QxqpSf6No9SI2YuhX8eCXoHFSy+b/WVL9BrNkRBzDNlnhNDBQ3rT46XvP/uvaWo25akMle7Uspgzgd12IJ3eLhjxdrXw/AJxoHK+FgEaXcmPGhB8r29fQQzYVM6uD0Bo0e8uBhFEe5TFBZbAUz+98dvISLB4OdTsTwAco9fPni2bevDr8lZMiQeobVkQPHM4VQrZUOMZ/CoXcR18pimgBv+zmF7ecUtp9T2H5OYfs5he3nFLafU9h+TuHzPUbYfk5h+zmF7ecUtp9T+PsxYfs5he3nFLafU9h+TmH7OQXYfk5h+zmF7ecUfqsTd/s5he3nFLafU9h+TmH7OYXt5xS2n1P4HT6nEEraaN6wzIVUrfpiX9B5vPrIwmkcZVTruXccXV3R/dYbqpCi5p8qNFQoehpHF8JIythymWhclxpS+dw5UjHaM5+A7h/RyrE/7/myeK06lmol/Yz9JMHS3Tq2XY568PrwKIqj+s1YoVOaY8ScPhIh5r4+Kigv1xUKfgabCzWruJov8jCpOpLKLbqlledcWhn+aBUFUinhCsNuzaUng/4lojZOuLryZZtcvOfH+64bZwTG1qNp506Xy+X/ALmcPjw=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztPF1zG0dyf6WzlSpZuAVAQJSssBTV0ZJjK9FJLJMq1YXk0YPdBnbE3Zn1zCxBmIUqP9w/yFOqkpf7afolqe6ZXeyCIClZOltJ4AeZmI+e7p7unu6enr2KnJjZaO84eq6TqkDlbHQaRynaxMjSSa2ivegoQ7CYT62cKdg/eAEzVGiEQwsC3vzwElwmHKASkxwtTA2idYscgcZLNQM9BQFpgD+AP+sKEqFA5FaDVElepQiaFxM5lAb7KU6lwhTmMp2hszHMM5lk4DIPEw3Px1Q60AbwshQqharUCoQFhZhiOoCjTFoojb6QKSNaY4OXJRqJKiFghcyFAacZ9vtf/uuQSPyzrgzR+/6X/4ZprucgFfe/LlHxAFGWgxN1oo5kuQdvylyLFBa6MnDw/F8aQgkqtR33es9xUs3gzYte7/SrzLnS7g2HBEOXqAitXEzsINHFMKWBZTq9TySjQYLqaRVW5gsQaYspLkMFiS4XkGhtUqloR2IoxQxBVcUEjY2BOFNog0SDAIMiXfSd7lcW4V8PX7+CqTaFcAM4yCsbN8ul0mDi8oUHT7TXVN2zMBEWH+2CdUaqWQyFOCe2Sgc/VTI5J7ItqrRm6v7BC+ZVr3dYlaU2DlN460nY6/Wo5xskHguDPD7RRaEVlMKIAh0a66WLug3+VEnDcuEyEHle82LvRPWh11OiwL1eD94o+VOFIFNUTk4lGqISHMmDnzDw492i5PEvVCoTFmdCgFpJZDtDiak09LDEhED6oS1Wg1ZBSomHc+H3v8xF4skyaEtMnLzALuDLGBYE+DkqXWOQaSN/1sqJnLfvAo2Ticjb20wIsjo4YRyxv9RSubo1rNBoGu02b2KQQ0ItJeYWUnGPRbgQeYU2YDWPISOsfsDSoCWrUMMlxqsUMpSz7Mb1RPqusq4DGCpLaLaxCGvVu8rsRWbbVOQWQU47vCzEObZWayzGAL5ZQIpTUeUuBkkS6kyFA3ilHWlqLhMyTCwDpGzCVQb7vMtBfAZd8TlY2YxUTqdoSJmpk0GEOTV2JJfeyBB5rGkuEwq0WtvoROfaXBchbu7yERKtHFvK/Qshc0beE2sbcznJRXIewySvMAaDqVf0Bea5nsdeP3gIGUTPc+YPmXGSQq0If6XD8tKCDVg1hrPWP+psjDMtIm2bq0HLp5pWJhbUKglYCJnHzLgY3ukJOOlyjEnBS6EWMaTCYQwOL91EX8aQZJicT/Rl4NdUK2flzxu0ru75eK6NY9iN4VEMj2MY7cQwGscw2o1h9CiG0eMYxjsxjMcxjHdjGD/yPB0/DvwUDRPbCIzGnpPuy+Ig2duX0rKGkqG0je2dd2zvaAC9XqMV1Pbjjz+eqKsTBXASkZKcRHtwEjVDTqLY95Hto75R+H1JPx6Mvw4/F/Tz0fhx+DnnoaPd8DOjn+PRiVqGBU/UmDFxoihvwYK6PysG4VcQFGrjRamttkvUSAYlrjtoPzr4UMeyTcsDokUq6aTI7c3k1CO+IIpWKF0japeIYpG8mSLu/oLIaeNDPWzufBebx1ZXrdSMxfga9Q8H4YS4mXi/7BdDewudTyP9EZFO5ueIzM/N9DcW6gtiwjpOn8aJrwd8kLP1vZkPYcAXxIUuRp/Gg8fEAzp4bmYA9X5B1LfQoY5wivu+nd3+6GF/vDPe7XCAYiI/oCj6adpfLBafg3vk14Tlya2pPU3voQmHMDW62BBGsJe/GhX8Hv67dr3/RA73pPZFMa1j1sYraSK9trfsdCoW96wHVU9tHDAav3K/Fi00uYvw4Kg3ybRMAvI0pna7JhTYDYgHfebkME2HLU5SY5r2i6K/1kg/+8z4VmNRDNJ0sDby2u74xgLSNIbrzRvb0xSKorih2bd3modFcZ2KQVEE3JjeE/VPpCbBM7tZU8KA30pZVjrRXfhWRaKcgVY5r82B2WZNWjtuMqlCRxArWBtgcFblwuAlRZhWauVHf34tq5Vs5b9zRBpyAli7z/DV6+Cj3w8KQCR0AVDL3fOuUUZA9iGprNMFGJzhJZTCOTSKgV2IXKaCg7I+N+ClKEpy9Id/OTlJ//CPQ04lULTugHYCUjmTlAEa/uV4v//vpxtGVGWJJhEWIUdaycaALhnAcYZ5uUpCzefzwfyBTTKtc5+BemcNTv2/Z3ry7ozRLQfClvc3UepFoxW6k+isR+4WXYdjwkI9c0PwzjLGIcxoh8/bENXccuCGEV/QmbOGEnX6PAh1H59EhWCXhEQZV39rl6E5iU6bOT5cx/SOuacfoKyZTDEXE8yvd32wojXNuVjoKuh3nZ7qkhokusU36iikajIQTM5O3OoUl2udvm+5Qb89Q9raWR86tXrWOwC5tHUOpsvO9uyQpOJUIyWQSWwnCPUEmDRS+sla0CD2YWrgLVHYuzuWoHHAA5sEYZMTuH2Fzsa0GUMwCqlkURVNpnPaQK1ZVgTvo80vmllZNPUK7d29toK4vGMFSivevMCJGnEmQxZidotjyt1fkJUI+FzzsUecDPHMuCXe5P7byRntdMh52CXn0c6vcB06y36657DTslC1y/CtorTZtYXI7axyUTsKn8NPCCBJHp/poqycl8fgIZBDyza5Fsw6+euT2X+IoR9DL4ZhDF/FcH8APyCni5MmtRzkVBqfQJYKUl1R1i+pTL6AiREJ3dngYDaAq6ufKqGcdIvlEnpwdUVXbMvlgDT7XOm5zy4fX0grHdDt0OocT3ViN9wm6cQO6cAfvsJ5v77gGwbU7sNXes2S3eo1BRZ8rJt007S/q+8QxZEu6YpSavUijfai+voyillc0bpvdLqI9q6ikDamP0NSliYN31m6+ryKbJJhIeivWszpsnQqc4ziyF9G2iiOOMdAN6ekntFepCfvMHFRTN5vSQckWoLB8/au6lH+Ci2KQ8QZ7UX+bi2Ko+ADNk2AKtEU15XpNFrWC94GqmlZgbL8R3OXR3Do1ulXgnlFU5drl8W/CtLzFgSmrcAjTfqYo8PnYmFbcL08Ret31DSH5CUJsyAVC0uZ9sr60zwReVLlFL3iZSnNogmlOYRtWNLCt1mpwXf0cFlvegujG/ba6I/foAQ1MYDTlh87953GCeIfQwMZAN5fUXw0Fu80wgR5b8tMq4+ePxo/GI1HD0ZjghByTx8LozZmBOKdnpz9KnlP8YLmB4PXmi2MEYsojqTDwt69lb73+tpdEdynCxxMa1+yv7ptjIFvCgZ3aUM9njkvZni32B/ddAvduhizma7ylK6cUJgBXwb/6rqEriY1R+XgDr1ZxtHl3cRcQqL79RU3fJXj1PlAFhJtFJr77fzYF0PceHd3GUeLu8lb/K8k72vavPnd1L3l2oBV3cTvgeuDx8s4yu7G9fumeuF3RHb30XJ1jkeJQeHQYVESkLOJThdntd1atgfWnkx9Yvmh4VBa0op5ioacnuv2amVqaCRV6ZytHzUTrXMUaoOh6VxpC7J1lj01ctJCgnieIXvLjQPH0G0TTAeXzntNdE2Oazk5aSnCMRWeRAN4MW354hzOrt+q12P5Vl1puMfrndmKzfi9YfhNHLrXriiioo1VYrxGgQdDvQVUK5TnhDd5EANo/mPvsuEkIVCf2PXCdx8Vz3wukBcMk7r1KRC81AE8E6qpX+jWCcDVVSMELB3LJVxd0a6iOaNzf7mMVw20VqeBj3bfYjBBedGZ1TThamLT1prqnamzlEMVagjnfRsBX3h3VpkAh3zO5XLQEcg1xCFjR595gGkjZ1R8d53qxmXinf5g7l9jdpAAAvL/hu9Pyqffyw2oPBmWT5+UT99SNVqJXvc8e6ZSpV7z55jnA3hindFq9nSNBU+GoX3zVhq8kDhnxeVdXUFZ520DaBBwovLM1uZJC4mpEilyToIbnWBdIsjxJ146sA5LS7GjdL4OlIuJ2PMXM4PI9ZqEi6gcV99xEFgv+ERAZnD6z/fWeHrvKVeDUij+ZCiehtEvfACbiQsEoRbAhHNqUhufW5xWhs1kkgsjpyHijKHMkRL2FJCKxEe9nqM1HkeZUOc2fjIxT49QFE096vu//o1GsBpwEe6RrswH2HSOt/t+b30qwNs8DwQEzCq+SnTEp9o88V3CquJNKutM5bN6kFamLvKrq215P6wdhJq+PqTS+rKnDNvwY0Bl/XQBU2EdmhgqJSkTZKqSJOd6AW9HlHmBJcX3vnqV9uhuW9AtLaNiZl9426o1rs+BGjCGWuMQajZljXXd7zrpGw/eoCd3I0iHJOeOQkK3RGO1IlnSZiZUEFXv+GtLgVsmcj/U66uki1jCh87fwcYg6/1f/9bC68bo8zpifgWRpnTTdQeGnMalfK3lZK7BMl+A012MCB6aP677WoRdgWaGZwlFZawz+AES3uuRjPd60Pc1eUG8beXLNF1dccz7SFu6gk58C/a/uUyvkwtpp9B7AN/rOV6QwAYVJkPr4WvKBTLmaexBtFZIhKLCQXaNyDshwM0leiE4WRiW8BV9LOJMTTAydHHn1+MKWVonvo2mWpSbKgHBlfFhdS/wnjjKVIHINdcjulbtfdpF6gUXP2ZsCixl6ygT59epq471XKF5/8t/UjV+nR+1jXu3sZc9NH4fwJWVbai1t1aXCQ+6/pi3Anf5y96lXmX0ghdHRdpaWR/0j3d26H9dgaqTqOD99RRslZCST6s8X/xDFH94OvH2jINv3uzF35ZCyN7J8c+XycX4gFTmBgt4K4AQ8VQmp3cCxLl+s+GsiS3eSpVLhWc1287GOztnI+LtMo52N7HvUBfohWVOTJzTud5ojTMLEDMSe/K/zWfkJhqjze0B0cdhdhsTdjtMeHidCS8U34/yS5ojfY7qt6W0vbzzyxOqlwXLij+UIukHcX/UIbbd7om0mFRGukW0d3wVXfZFKfu+f+/4dHlKhttlmpLwpbaMsXBZtBcNWzl5i+aCEukEYU1i5mI2Q/N9NWGE9yun4U86OfdUsYA3MnshjfOQBtZPy6oJh+oHRpCGvhIX58IM6XQZjgY7g51oGV+tAbFCpXRfei3cF6UcXowGow1zNqYHbhmPVf9jp1gnZlLN7pp3utqOQxIZLxWdTVklQUv5b0hZ0LDn7VFxJIn7GYqU0gqUhLVa/bC6Ovm2lqf6UmPTPUXLCq/dPNQXD527hPXTe8PtwObLgdHDdlreJ945l96k0jdlxxvC63x3k+5uZbBbCexVTrqTkuYscyvJfLxSviafW6dzR5wHHe/ucsLw6xFn1h485qTV7qPlaSd/E0XdHA3fra5nGj4tcO7Gzdtg8P9QMNiNBf31+1psVAtYE4t0AoL1eOBG33yja15HY1JNNducoCzNG0qy5myzriWSMU900byL6fValDWzer3GlvjdIV/0dWWg1HM008o/tJnmeCkp2KRpWHDfKmmJosjR2nwBFGXO2APmyjqRNzFcIkoxkbmk85WG6SAnqyPaDuDtKu15z/gr8wvM6VgmEdKF4BixiQ/n2pzTs1J6nQkTKiWg4AlVJlTi4zRvwGOSEXr7STFwaaSl536GsJYeN62cIeEohBIzFtu4LQaQYk5abMHoCRXoWJ1XXvickLk2/mKUCSJRtMzEby9L6uJsOJk+gxnt90WI1i09P0oRvG0OD0wnlDwrCRdJzrvTUKlc01tQSpxVeQ6lJu+G1FJPOzjSdGeEsuSUhrvYsAcNw0IgjTaEQW8s0g6/lOrcv2Pqw3EjV29xYqXDbo3jusze7875TjpyMH7AUlvptFmsZs+kq52INpDmh4f0XXgQDa0z9MOrMw7RkYTY4f7BC3YI78P7X/4DXqIwCjI999KaVAbzRfP22r/s5Z33bGv8OU7VkO0ijide+ILJrTn4NhOOY65XyK+bvUr5woyDapLLBI7qPHivtwfPONpp5cY7NVmZIFG6kAIElH52LtX5APbVgiP+lQGmdp7XIYONfr3d/oFxClqFwg+/5mCFEbUXFvMLtK0Ymp6Dk0RnRlczv1obmUCcwSlFkeEFMtG2n6YcesrVe2J+H7tCB6f+WScu/M0Bx/wHa1O4p3llFxIGq6QxqpSf6No9SI2YuhX8eCXoHFSy+b/WVL9BrNkRBzDNlnhNDBQ3rT46XvP/uvaWo25akMle7Uspgzgd12IJ3eLhjxdrXw/AJxoHK+FgEaXcmPGhB8r29fQQzYVM6uD0Bo0e8uBhFEe5TFBZbAUz+98dvISLB4OdTsTwAco9fPni2bevDr8lZMiQeobVkQPHM4VQrZUOMZ/CoXcR18pimgBv+zmF7ecUtp9T2H5OYfs5he3nFLafU9h+TuHzPUbYfk5h+zmF7ecUtp9T+PsxYfs5he3nFLafU9h+TmH7OQXYfk5h+zmF7ecUfqsTd/s5he3nFLafU9h+TmH7OYXt5xS2n1P4HT6nEEraaN6wzIVUrfpiX9B5vPrIwmkcZVTruXccXV3R/dYbqpCi5p8qNFQoehpHF8JIythymWhclxpS+dw5UjHaM5+A7h/RyrE/7/myeK06lmol/Yz9JMHS3Tq2XY568PrwKIqj+s1YoVOaY8ScPhIh5r4+Kigv1xUKfgabCzWruJov8jCpOpLKLbqlledcWhn+aBUFUinhCsNuzaUng/4lojZOuLryZZtcvOfH+64bZwTG1qNp506Xy+X/ALmcPjw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,x={},j=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": ""\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/23f866da.d15a44d4.js b/assets/js/23f866da.d15a44d4.js deleted file mode 100644 index 4ff6ceb51..000000000 --- a/assets/js/23f866da.d15a44d4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11zG0dyf6WzlSpZyAIgIFpWWIrqaMmxmSgWy6RLdSF59GC3gR1xd2Y9MwsQZqHKD/cP7umqkpf7afolqe6ZXeyCICnZrrOSQA8Udj56unu6e7p7em4iJ2Y2OjiLXumkKlA5G13EUYo2MbJ0UqvoIDrNECzmUytnCg6Pj2CGCo1waEHA99+9BpcJB6jEJEcLU4No3TJHoPFSzUBPQUAa4A/gj7qCRCgQudUgVZJXKYLmxUQOpcF+ilOpMIWFTGfobAyLTCYZuMzDRMPzMZUOtAG8LoVKoSq1AmFBIaaYDuA0kxZKo+cyZURrbPC6RCNRJQSskLkw4DTDfv/zf50QiX/UlSF63//83zDN9QKk4v43JSoeIMpycK7O1aksD+D7MtcihaWuDBy/+teGUIJKbWe93iucVDP4/qjXu/gsc660B8MhwdAlKkIrFxM7SHQxTGlgmU4fE8lokKB6WoWV+RJE2mKKy1BBosslJFqbVCrakRhKMUNQVTFBY2MgzhTaINEgwKBIl32n+5VF+LeTN9/CVJtCuAEc55WNm+VSaTBx+dKDJ9prqh5ZmAiLT/fBOiPVLIZCXBFbpYMfK5lcEdkWVVoz9fD4iHnV651UZamNwxTeehIOej3q+RKJx8Igj090UWgFpTCiQIfGeumiboM/VtKwXLgMRJ7XvDg4V33o9dyyxINeD45UKhMWTwJIrSSCfuzADyUm0dCTEhM5lWFoi3WgVZA64slC+P0sc5F4NA3aEhMn59gFfB3DkgC/QqVrDDJt5E9aOZHzdszROJmIvL1thCCLtxPGETtLLZWrW8MKjebQ7vGmBLki1FJiViEV91iEucgrtAGrRQwZYfUdlgYtaXkNlxipUshQzrI71xPpu8q6DmCoLKHZxiKsVe8SsxeZbVORWwQ57fCyEFfYWq2xAAP4cgkpTkWVuxgkSZwzFQ7gW+1I83KZkKEhyWWdFq4y2OddDuIQEFGi4D0+XtuAVE6naEg5qZNBhDk1diRn3mgQeaw5LhMKtNrY6ETn2twWIW7u8hESrRxbvsO5kDkj74m1jfmb5CK5imGSVxiDwdQr7hLzXC9iL+88hAyc5znzh8wySaFWhL/SYXlpwQasGkNY6xN1NsaWFpG2zdWgtVNNKxMLahUDLITMY2ZcDO/0BJx0OcaksKVQyxhS4TAGh9duoq9jSDJMrib6OvBrqpWz8qctWlf3fDzXxjHsx/A0hmcxjPZiGI1jGO3HMHoaw+hZDOO9GMbjGMb7MYyfep6OnwV+ioaJbQRGY89J92lxkOzna2lZQ8nw2caWLjq2dDSAXq/RCmr74YcfztXNuQI4j0hJzqMDOI+aIedR7PvI9lHfKHxf08eT8Rfhc0mfT8fPwueCh472w2dGn+PRuVqFBc/VmDFxoijvwYK6f1MMwlcQFGrjRamttkvUSAYlrjtoPzr4UMeqTcsTokUq6aTI7d3k1CM+IYrWKN0iap+IYpG8myLu/oTIaeNDPWzufBebx1ZXrdSMxfgW9Z8PwglxN/F+2U+G9hY6v470p0Q6mZ9TMj93099YqE+ICZs4/TpOfDHgg5yt7918CAM+IS50Mfp1PHhGPKCD524GUO8nRH0LHeoIp7jv29vvjz7vj/fG+x0OUIzjBxRFP037y+Xyt+Ae+TVheXJrak/Te2jCIUyNLraEEezlr0cFv4d/1673f5DDPal9UUzrGLTxSprIre0tO52K5SPrQdVTGweMxq/dr2ULTe4iPDiKTTItk4A8jandrgkFagPiQZ85OUzTYYuT1Jim/aLobzTSZ58Z32osikGaDjZG3tod31hAmsZwu3lre5pCURR3NPv2TvOwKG5TMSiKgBvTe67+mdQkeGZ3a0oY8PdSlrVOdBe+V5EoB6BVzmtzYLZdkzaOm0yq0BHECjYGGJxVuTB4TRGmlVr50b+9ltVKtvbfOSLlYI7jfc8K+OxN8NEfBwUgEroAqOXhebcoIyCHkFTW6QIMzvAaSuEcGsXA5iKXqeCgrM8NeC2Kkhz94Z/Oz9N/+schpxIoWndAOwGpnEnK6Az/dHbY/8+LLSOqskSTCIuQI61kY0CXDOAsw7xcJ5UWi8Vg8cQmmda5zyi9swan/u+lnry7ZHTLgbDl422UetFohe4kOpuRu0XX4ZiwUM/cEryzjHEIM9rj8zZENfccuGHEJ3TmbKBEnT4PQt1n51Eh2CUhUcb1b+0yNOfRRTPHh+uYPjD34gOUNZMp5mKC+e2uD1a0pjkXS10F/a7TU11Sg0S3+EYdhVRNBoLJ2YtbneJ6o9P3rbbot2dIWzvrQ6dWz3oHIJe2zsF02dmeHZJUnDqkhDCJ7QShngCTRkp/tRY0iH2YGnhLFPbugSVoHPDAJkHY5ATuX6GzMW3GEIxCKllURZPpnDZQa5YVwfto84tmVhZNvUJ7d2+tIK4fWIHSincvcK5GnMmQhZjd45hy9ydkJQI+G/IdxZEu6b5EanWURgdRfZcSxQwUrftSp8vo4CYKOS/6GTJKNGn4ztI9zE1kkwwLQb9qZOjmZipzjOLI34zYKI44QKJrHOJUdBDpyTtMXBTT0V2SdqMlGDzv4KYe5fP5URzc5egg8on+KI7CAdY0AapEk1NaptNoVS94H6imZQ3K8o/mYoHgUMr8F4L5lqauNm6ufhGkVy0ITFuBp/qlpj6Hr8TStuB6+Y42L8xoDulvEmZBKpaW0oSV9aYoEXlS5eR643UpzbKJA9j/bljSwrdZqcF39Pmq3vQWRnfstdEfv0EJamIA51w+du47jRPEP4QG8kR4f0Xx0Vi80wgT5L0tM60+ev5o/GQ0Hj0ZjQlCCJw/FkZ9T0cg3unJ5S+S9xTnND/ka1uzhTFiGcWRdFjYh7fS995euyuCh5R9xrQ+CPvrq5IYOM05eEgb6vHMeTHDh8X+9K4rtFZW32a6ylPKl6MwA77J+sWXpF1NokWY2sEDerOKo+uHibmGRPfr+zn4LMep8144JNooNI/bwf0nQ9x4f38VR8uHyVv+ryTvC9q8xcPUveWLzfWl7++B65NnqzjKHsb1m+bq9XdEdv/pan2OR4lB4dBhURKQy4lOl5e13Vq1B9aeTH1i+aHhUFrRinmKhpye2/ZqbWpoJJUMXG4eNROtcxRqi6Hp3McJsnWWPWfyy0N2a5EhhV9rh5qh2yYSCF6895rojg83EgrSkrNpKjyPBnA0XfPS++KbV4L1WL4SVBoe8XqXtmIz/mgYvolDj9rlDXTjvM7q1SjwYKi3wMJC5jnhTR7EAJp/7F02nCQE6hO7Xvjho+KlT2TwgmFS93Idgpc6gJdCNZev3UtOuLlphIClY7WCmxvaVTSXdO6vVvG6gdbqNPDR7lsMJijnnVlNE64nNm2tqd6ZuiRnyjeE876NgK8CuqxMgEM+52o16AjkBuKQcWjHPMC0kTOqBLpNdeMy8U5/MPdvMTtIAAH5f8P35+WLb+QWVJ4PyxfPyxdvqZSmRK97nj1TqVKv+QvM8wE8t85oNXuxwYLnw9C+fSsNziUuWHF5V9dQNnnbABoEnKhWrLV50kJiqkSKnDN4RidY1yvRvim8dmAdlpayBdL5ojSuhGDPX8wMIhePES6iclw6xEFgveBzAZnB6b882uDpoxdcmkZVY8+H4kUYfeQTCpmYIwi1BCac8yra+MTItDJsJpNcGDkNEWcMZY6UbaSAVCQ+0eE5WuNxmgl1ZePnE/PiFEXRFMe9//PfaASrAVcEnurKfIBN5/xH3++tD7+9zfNAQMCs4nsQR3yqzRMnQtflOlJZZyqfkoC0MnWFUl36x/th7SAUJPUhldbXbGTYhh8DKuunC5gK69DEUCmpHBpTlSQ5t6sJO6LMC6wovveldLRHD9uCbl0MVVb6KsBW4WN9DtSAMRQ+hlCzqcmqixA3Sd968AY9eRhBOiS5cipko0o0ViuSJW1mQgVR9Y6/thS4ZSL3Q72+SrpFInzo/B1sDbLe//lvLbzujD5vI+ZXEGlKafoHMOQcFCWbLGeiDJb5EpzuYkTw0Pxh09ci7Ao0M7xMKCpjncEPkPBej2S814O+LygK4m0rX2Pm6vJH3kfa0jV04luw/81NYJ1cSDtVpwP4Ri9wTgIbVJgMrYevqeaVMU9jD6K1QiIUVT2xa0TeCQFubgALIdV6CV+OxCLO1AQjQ7cOfj0u76N14vtoqkW5ueIUXKYbVvcC74mjTBWIXHMxlWsVAqddpI64citjU2ApQUuZUb9OXTKpFwrN+5//SqXByLWACdrGvdvayx4aFytzWVgbau2t1TWOg64/5q3AQ/6yd6nXGb3gxVGFqVbWB/3jvT36rytQdck2eH89BVslpOTTKs+X/xDFH55OvD/j4Ju3e/H3pRCyd3L803UyHx+TytxhAe8FECKeyuRUtEyc6zcbzprY4q1UuVR4WbPtcry3dzki3q7iaH8b+050gV5YFsTEBZ3rjdY4swQxI7En/9v8htxEY7S5PyD6OMzuY8J+hwmf32bCkeLLHS7rP9VXqP6+lLaXd355QvW6YFnxh1Ik/SDujzrEtts9kRaTyki3jA7ObqLrvihl3/cfnF2sLshwu0xTEr7UljEWLosOomErJ2/RzCmRThBYaBs5tEKldPdyK/oWpRzOR4NRtIo352yN1u8Zj1X/Y6dYJ2ZSzR6ad7HmzgntoN+kDo/WOclS/jtSUjJsQXtUHEmSnAxFSlE+5UStVt+tbzK+qre3vmPYdm3QMoobFwH1PUAntb95mG5J1m/P1Y8+b2fJfR6cU9tNZntbsrohvE4/N9nnVkK5lU9ep4g7GWJO+rZyvmdrXWjSq3V2dcRpyfH+PufvvhhxouvJM84h7T9dXXTSKVHUTZnwhdRm4P/r4thuGLuLzf4PxWbd0MwXD2yEKrWANaFBxz/fdM/vdJW3esp1cCTVVLPNCcrSvK+i04Bt1q28LuaJLpoa+16vRVkzq9drbInfHXIN31QGSr1AM6180f40x2tJsR9Nw4L71jlEFEWO1uZLoKBvxg4pV+mIvAmpElGKicwlHXc0TAc5WZ+YdgBv11nIR8YXLc0xp1OSREgXgkO2JlxbaHNFT87o5RZM6I0NxTKoMqESHzZ5Ax6TjNC7MApJSyMtPR0yhLX0uGnlDAlHIZSYsdjGbTGAFHPSYgtGT+iy3+q88sLnhMy18feUTBCJomUmfnVdUhcnp8n0Gcxov+cheLb0lCFF8LY5PD6bUC6rJFwk+dJOQ6VyTe/EKI9V5TmUmpwNUks97eBI050RypKPGK5Gwx40DAtxLdoQlXxvkXb4tVRX/k1EH84auXqLEysdduulNmX2cXfO19J9U03o5ZS20mmzXM+eSZdVEz5l20CaDw/p6/BYElpn6BpGqhO7JZuvEzuk0q7hCTqSEDs8PD5i/+wxvP/5L/AahVGQ6YWX1qQymC+bd5n+1R/vvGdb415x5oRsF3E88cIXTG7NwbeZcBwCfYv88tGrlC/6OK4muUzgtE5L93oH8JKDj1aqulPfkQkSpbkUIKD0s3OprgZwqJYcgK8NMLXzvA4ZbPTr7faPD1PQKhSg+TUHa4yovbCYz9G2Qlp6KkoSnRldzfxqbWQCcQanFNSF14lE22GaciQo128N+a3dGh2c+idiuPSJfA7BjzemcE/zYifE7+scLqqUn/vZA0iNmLo1/Hgt6Bzjsfm/1VS/Z6rZEQcwzZZ4TQwUN60+WN3w/7r2loNgWpDJXu9LKYM4ndViCd1CxI8Xa389zycaxw7hYBGl3JqAoceO9s30BM1cJnWseIdGD3nwMIqjXCaoLLZii8Ovj1/D/MlgL4pbXvUHKPfw9dHLr749+YqQIUPqGTYa7A32+MZcW1cI1VrpBPMpnHgXcaNKpYm3dk+td0+td0+td0+td0+td0+td0+td0+td0+td0+td0+td0+td0+tf7eHX7un1run1run1run1run1run1run1run1run1run1run1r+7lbjzqXWoryGDOSxzIVWr9tAXe52tH2BfxFFGdWAHZ9HNDSXbv6dyDWr+sUJDRWQXcTQXRlK6iUvI4rruiWp5rpAqY1767Fn/lFaOvbHim6uNyjkq3PIzDpMES3fv2Hap2vGbk9Mojur3JIVOaY4RC3pALha+WCPwkYucBD+Ry4WaVVxaFHmYVKpFd7/dOq8rrvMKP1oVSlTXtMawWwDmyaC/RNTWCTc3voaMK4n8eN9154zA2Ho07dzFarX6H+Yb2Ho=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var r=t(74848),s=t(28453),o=t(33617),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zG0dyf6WzlSpZyAIgIFpWWIrqaMmxmSgWy6RLdSF59GC3gR1xd2Y9MwsQZqHKD/cP7umqkpf7afolqe6ZXeyCICnZrrOSQA8Udj56unu6e7p7em4iJ2Y2OjiLXumkKlA5G13EUYo2MbJ0UqvoIDrNECzmUytnCg6Pj2CGCo1waEHA99+9BpcJB6jEJEcLU4No3TJHoPFSzUBPQUAa4A/gj7qCRCgQudUgVZJXKYLmxUQOpcF+ilOpMIWFTGfobAyLTCYZuMzDRMPzMZUOtAG8LoVKoSq1AmFBIaaYDuA0kxZKo+cyZURrbPC6RCNRJQSskLkw4DTDfv/zf50QiX/UlSF63//83zDN9QKk4v43JSoeIMpycK7O1aksD+D7MtcihaWuDBy/+teGUIJKbWe93iucVDP4/qjXu/gsc660B8MhwdAlKkIrFxM7SHQxTGlgmU4fE8lokKB6WoWV+RJE2mKKy1BBosslJFqbVCrakRhKMUNQVTFBY2MgzhTaINEgwKBIl32n+5VF+LeTN9/CVJtCuAEc55WNm+VSaTBx+dKDJ9prqh5ZmAiLT/fBOiPVLIZCXBFbpYMfK5lcEdkWVVoz9fD4iHnV651UZamNwxTeehIOej3q+RKJx8Igj090UWgFpTCiQIfGeumiboM/VtKwXLgMRJ7XvDg4V33o9dyyxINeD45UKhMWTwJIrSSCfuzADyUm0dCTEhM5lWFoi3WgVZA64slC+P0sc5F4NA3aEhMn59gFfB3DkgC/QqVrDDJt5E9aOZHzdszROJmIvL1thCCLtxPGETtLLZWrW8MKjebQ7vGmBLki1FJiViEV91iEucgrtAGrRQwZYfUdlgYtaXkNlxipUshQzrI71xPpu8q6DmCoLKHZxiKsVe8SsxeZbVORWwQ57fCyEFfYWq2xAAP4cgkpTkWVuxgkSZwzFQ7gW+1I83KZkKEhyWWdFq4y2OddDuIQEFGi4D0+XtuAVE6naEg5qZNBhDk1diRn3mgQeaw5LhMKtNrY6ETn2twWIW7u8hESrRxbvsO5kDkj74m1jfmb5CK5imGSVxiDwdQr7hLzXC9iL+88hAyc5znzh8wySaFWhL/SYXlpwQasGkNY6xN1NsaWFpG2zdWgtVNNKxMLahUDLITMY2ZcDO/0BJx0OcaksKVQyxhS4TAGh9duoq9jSDJMrib6OvBrqpWz8qctWlf3fDzXxjHsx/A0hmcxjPZiGI1jGO3HMHoaw+hZDOO9GMbjGMb7MYyfep6OnwV+ioaJbQRGY89J92lxkOzna2lZQ8nw2caWLjq2dDSAXq/RCmr74YcfztXNuQI4j0hJzqMDOI+aIedR7PvI9lHfKHxf08eT8Rfhc0mfT8fPwueCh472w2dGn+PRuVqFBc/VmDFxoijvwYK6f1MMwlcQFGrjRamttkvUSAYlrjtoPzr4UMeqTcsTokUq6aTI7d3k1CM+IYrWKN0iap+IYpG8myLu/oTIaeNDPWzufBebx1ZXrdSMxfgW9Z8PwglxN/F+2U+G9hY6v470p0Q6mZ9TMj93099YqE+ICZs4/TpOfDHgg5yt7918CAM+IS50Mfp1PHhGPKCD524GUO8nRH0LHeoIp7jv29vvjz7vj/fG+x0OUIzjBxRFP037y+Xyt+Ae+TVheXJrak/Te2jCIUyNLraEEezlr0cFv4d/1673f5DDPal9UUzrGLTxSprIre0tO52K5SPrQdVTGweMxq/dr2ULTe4iPDiKTTItk4A8jandrgkFagPiQZ85OUzTYYuT1Jim/aLobzTSZ58Z32osikGaDjZG3tod31hAmsZwu3lre5pCURR3NPv2TvOwKG5TMSiKgBvTe67+mdQkeGZ3a0oY8PdSlrVOdBe+V5EoB6BVzmtzYLZdkzaOm0yq0BHECjYGGJxVuTB4TRGmlVr50b+9ltVKtvbfOSLlYI7jfc8K+OxN8NEfBwUgEroAqOXhebcoIyCHkFTW6QIMzvAaSuEcGsXA5iKXqeCgrM8NeC2Kkhz94Z/Oz9N/+schpxIoWndAOwGpnEnK6Az/dHbY/8+LLSOqskSTCIuQI61kY0CXDOAsw7xcJ5UWi8Vg8cQmmda5zyi9swan/u+lnry7ZHTLgbDl422UetFohe4kOpuRu0XX4ZiwUM/cEryzjHEIM9rj8zZENfccuGHEJ3TmbKBEnT4PQt1n51Eh2CUhUcb1b+0yNOfRRTPHh+uYPjD34gOUNZMp5mKC+e2uD1a0pjkXS10F/a7TU11Sg0S3+EYdhVRNBoLJ2YtbneJ6o9P3rbbot2dIWzvrQ6dWz3oHIJe2zsF02dmeHZJUnDqkhDCJ7QShngCTRkp/tRY0iH2YGnhLFPbugSVoHPDAJkHY5ATuX6GzMW3GEIxCKllURZPpnDZQa5YVwfto84tmVhZNvUJ7d2+tIK4fWIHSincvcK5GnMmQhZjd45hy9ydkJQI+G/IdxZEu6b5EanWURgdRfZcSxQwUrftSp8vo4CYKOS/6GTJKNGn4ztI9zE1kkwwLQb9qZOjmZipzjOLI34zYKI44QKJrHOJUdBDpyTtMXBTT0V2SdqMlGDzv4KYe5fP5URzc5egg8on+KI7CAdY0AapEk1NaptNoVS94H6imZQ3K8o/mYoHgUMr8F4L5lqauNm6ufhGkVy0ITFuBp/qlpj6Hr8TStuB6+Y42L8xoDulvEmZBKpaW0oSV9aYoEXlS5eR643UpzbKJA9j/bljSwrdZqcF39Pmq3vQWRnfstdEfv0EJamIA51w+du47jRPEP4QG8kR4f0Xx0Vi80wgT5L0tM60+ev5o/GQ0Hj0ZjQlCCJw/FkZ9T0cg3unJ5S+S9xTnND/ka1uzhTFiGcWRdFjYh7fS995euyuCh5R9xrQ+CPvrq5IYOM05eEgb6vHMeTHDh8X+9K4rtFZW32a6ylPKl6MwA77J+sWXpF1NokWY2sEDerOKo+uHibmGRPfr+zn4LMep8144JNooNI/bwf0nQ9x4f38VR8uHyVv+ryTvC9q8xcPUveWLzfWl7++B65NnqzjKHsb1m+bq9XdEdv/pan2OR4lB4dBhURKQy4lOl5e13Vq1B9aeTH1i+aHhUFrRinmKhpye2/ZqbWpoJJUMXG4eNROtcxRqi6Hp3McJsnWWPWfyy0N2a5EhhV9rh5qh2yYSCF6895rojg83EgrSkrNpKjyPBnA0XfPS++KbV4L1WL4SVBoe8XqXtmIz/mgYvolDj9rlDXTjvM7q1SjwYKi3wMJC5jnhTR7EAJp/7F02nCQE6hO7Xvjho+KlT2TwgmFS93Idgpc6gJdCNZev3UtOuLlphIClY7WCmxvaVTSXdO6vVvG6gdbqNPDR7lsMJijnnVlNE64nNm2tqd6ZuiRnyjeE876NgK8CuqxMgEM+52o16AjkBuKQcWjHPMC0kTOqBLpNdeMy8U5/MPdvMTtIAAH5f8P35+WLb+QWVJ4PyxfPyxdvqZSmRK97nj1TqVKv+QvM8wE8t85oNXuxwYLnw9C+fSsNziUuWHF5V9dQNnnbABoEnKhWrLV50kJiqkSKnDN4RidY1yvRvim8dmAdlpayBdL5ojSuhGDPX8wMIhePES6iclw6xEFgveBzAZnB6b882uDpoxdcmkZVY8+H4kUYfeQTCpmYIwi1BCac8yra+MTItDJsJpNcGDkNEWcMZY6UbaSAVCQ+0eE5WuNxmgl1ZePnE/PiFEXRFMe9//PfaASrAVcEnurKfIBN5/xH3++tD7+9zfNAQMCs4nsQR3yqzRMnQtflOlJZZyqfkoC0MnWFUl36x/th7SAUJPUhldbXbGTYhh8DKuunC5gK69DEUCmpHBpTlSQ5t6sJO6LMC6wovveldLRHD9uCbl0MVVb6KsBW4WN9DtSAMRQ+hlCzqcmqixA3Sd968AY9eRhBOiS5cipko0o0ViuSJW1mQgVR9Y6/thS4ZSL3Q72+SrpFInzo/B1sDbLe//lvLbzujD5vI+ZXEGlKafoHMOQcFCWbLGeiDJb5EpzuYkTw0Pxh09ci7Ao0M7xMKCpjncEPkPBej2S814O+LygK4m0rX2Pm6vJH3kfa0jV04luw/81NYJ1cSDtVpwP4Ri9wTgIbVJgMrYevqeaVMU9jD6K1QiIUVT2xa0TeCQFubgALIdV6CV+OxCLO1AQjQ7cOfj0u76N14vtoqkW5ueIUXKYbVvcC74mjTBWIXHMxlWsVAqddpI64citjU2ApQUuZUb9OXTKpFwrN+5//SqXByLWACdrGvdvayx4aFytzWVgbau2t1TWOg64/5q3AQ/6yd6nXGb3gxVGFqVbWB/3jvT36rytQdck2eH89BVslpOTTKs+X/xDFH55OvD/j4Ju3e/H3pRCyd3L803UyHx+TytxhAe8FECKeyuRUtEyc6zcbzprY4q1UuVR4WbPtcry3dzki3q7iaH8b+050gV5YFsTEBZ3rjdY4swQxI7En/9v8htxEY7S5PyD6OMzuY8J+hwmf32bCkeLLHS7rP9VXqP6+lLaXd355QvW6YFnxh1Ik/SDujzrEtts9kRaTyki3jA7ObqLrvihl3/cfnF2sLshwu0xTEr7UljEWLosOomErJ2/RzCmRThBYaBs5tEKldPdyK/oWpRzOR4NRtIo352yN1u8Zj1X/Y6dYJ2ZSzR6ad7HmzgntoN+kDo/WOclS/jtSUjJsQXtUHEmSnAxFSlE+5UStVt+tbzK+qre3vmPYdm3QMoobFwH1PUAntb95mG5J1m/P1Y8+b2fJfR6cU9tNZntbsrohvE4/N9nnVkK5lU9ep4g7GWJO+rZyvmdrXWjSq3V2dcRpyfH+PufvvhhxouvJM84h7T9dXXTSKVHUTZnwhdRm4P/r4thuGLuLzf4PxWbd0MwXD2yEKrWANaFBxz/fdM/vdJW3esp1cCTVVLPNCcrSvK+i04Bt1q28LuaJLpoa+16vRVkzq9drbInfHXIN31QGSr1AM6180f40x2tJsR9Nw4L71jlEFEWO1uZLoKBvxg4pV+mIvAmpElGKicwlHXc0TAc5WZ+YdgBv11nIR8YXLc0xp1OSREgXgkO2JlxbaHNFT87o5RZM6I0NxTKoMqESHzZ5Ax6TjNC7MApJSyMtPR0yhLX0uGnlDAlHIZSYsdjGbTGAFHPSYgtGT+iy3+q88sLnhMy18feUTBCJomUmfnVdUhcnp8n0Gcxov+cheLb0lCFF8LY5PD6bUC6rJFwk+dJOQ6VyTe/EKI9V5TmUmpwNUks97eBI050RypKPGK5Gwx40DAtxLdoQlXxvkXb4tVRX/k1EH84auXqLEysdduulNmX2cXfO19J9U03o5ZS20mmzXM+eSZdVEz5l20CaDw/p6/BYElpn6BpGqhO7JZuvEzuk0q7hCTqSEDs8PD5i/+wxvP/5L/AahVGQ6YWX1qQymC+bd5n+1R/vvGdb415x5oRsF3E88cIXTG7NwbeZcBwCfYv88tGrlC/6OK4muUzgtE5L93oH8JKDj1aqulPfkQkSpbkUIKD0s3OprgZwqJYcgK8NMLXzvA4ZbPTr7faPD1PQKhSg+TUHa4yovbCYz9G2Qlp6KkoSnRldzfxqbWQCcQanFNSF14lE22GaciQo128N+a3dGh2c+idiuPSJfA7BjzemcE/zYifE7+scLqqUn/vZA0iNmLo1/Hgt6Bzjsfm/1VS/Z6rZEQcwzZZ4TQwUN60+WN3w/7r2loNgWpDJXu9LKYM4ndViCd1CxI8Xa389zycaxw7hYBGl3JqAoceO9s30BM1cJnWseIdGD3nwMIqjXCaoLLZii8Ovj1/D/MlgL4pbXvUHKPfw9dHLr749+YqQIUPqGTYa7A32+MZcW1cI1VrpBPMpnHgXcaNKpYm3dk+td0+td0+td0+td0+td0+td0+td0+td0+td0+td0+td0+td0+tf7eHX7un1run1run1run1run1run1run1run1run1run1run1r+7lbjzqXWoryGDOSxzIVWr9tAXe52tH2BfxFFGdWAHZ9HNDSXbv6dyDWr+sUJDRWQXcTQXRlK6iUvI4rruiWp5rpAqY1767Fn/lFaOvbHim6uNyjkq3PIzDpMES3fv2Hap2vGbk9Mojur3JIVOaY4RC3pALha+WCPwkYucBD+Ry4WaVVxaFHmYVKpFd7/dOq8rrvMKP1oVSlTXtMawWwDmyaC/RNTWCTc3voaMK4n8eN9154zA2Ho07dzFarX6H+Yb2Ho=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,f={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,r.jsx)(a(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,r.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,r.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,r.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,r.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,r.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"6",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"7",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"8",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,r.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"9",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,r.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"10",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"11",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,r.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(d(),{parameters:void 0}),"\n",(0,r.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.5dc12157.js b/assets/js/34593b53.5dc12157.js new file mode 100644 index 000000000..0c7e95f61 --- /dev/null +++ b/assets/js/34593b53.5dc12157.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kt2AhZPcXqQ9RhrlYxtK21teORGBK1jllSw0FXZXdDrALKAIrNHkZHzMP8wT7t63yav2QjE0AdfZCURHtkb/tBZqNwJBKZiTxxFVk+NdHBSfSNSqsCpDXRuzjKwKRalFYoGR1ExzNgX2vgFljoxQ6PXjCe52puWGVAG2YVm4IEjb0kzFkW5mPjBSu1uhCZkFOWccvZXNgZG3MDj/YZyFRlkLGJyCE5lafyWJQH7G2ZK56xhao0O/rmP+rZcBlsO+n1voFxNWVvX/R6776YWVuag36fl2WiSpBGTGXOxyZJVdHPsGOZTe7HbD4DDTgrS7lkwI3IF4xnGZuLbArWxMzOQLJUlQuWKqUzIbkFE7OST4HJqhiDNjHjMmOF0sCEZJxp4Nliz6q9ygD7zzevXrKJ0gW3CTvKKxPXy2VCQ2rzhZvezqDe1T0TsGGsFnIas4KfI7aEZT9WIj3HbRuQGf4fBx4evSBc9XpvqrJU2kLGfnBbOOj18MtXkKs54xqof6qKQklWcs0LsHRcM27ps4YfK6Ehc4fC8zzg4uBU7rFeT/ICDno99laKHytgIgNpxUSAxl0yOxPGD0hcf7soqf8LmYkUkUcAYCtTk25XRCp2fVNCilO6ri1UMyXZfCbSGeFwzt35lzlP3bY0mBJSKy6gO/FlzBY48TcgVYBgprT4q5KW53R8F6CtSHnePmYEELsay7VF9JdKSBta/QrsT/448bTpED0dImgZIrcQkr4YYBc8r8B4qOYxmyFUr6HUYIg1/LyIeJmxGYjpbOt6PHtfGduZmFUGwWxD4dcKp0roBULbhOcGmJh0cFnwc2itxhTxPM8T9tWCZTDhVW5jJpBCra4gYS+VZbwsc5HycQ5EA8hs3FYa9uiUPfkkXfI5IgkAhnGWickENDIzfqQp/JgAHdJlIzKI0+yMS6bkykGnKld6nYSouYtHlippQdqEHV5wkRPwbrOGCZnmVQZsnPP0PGbjvIKYacgcoy8AxVzshRZ2Ydx4nBN+mIEcqVBJhF8qv7wwzHiosoQdI6PU/IcfA6ppEWHaWPVcPlG4MqIgsCSDgos8JsTF7L0aMytsDjEyeMnlIkb5CjGzcGnH6jJm6QzSc/pL80woNq6sVdJtLNOqzNRcelxOlLRG/HUDR4YvH47RUcz2Y/YoZk9iNhzEbDiK2XA/ZsNHMRs+idloELPRKGaj/ZiNHjmwRk88rnmN4DYAw5HDsv31YBfl9PfCEGejgDW1zJ53ZPYwYb1ezU3Y9pe//OVUXp1Kxk4jZK7T6ICdRnWX0yh231Bm4reh/32JPx6MHvufC/z5aPTE/5xT1+G+/znDn6PhqVz6BU/liCCxvCivgQI/3ykE/pcnImyjRbEtyDNsREEUhw94Vh148MOyvZcHuBchhRU8N9u3E3p8RjtqQFrb1D5uish1+47o82e0nTY8+IXEpPtEYrX1KTA8QTFa2/3DxN8s2zfvlv1s9t4C59O2/gi3jqLpGEXT9v3X0uszQsIqTJ+GiccJKQAkmbfjwXf4jLDQhejTcPAEcYCX0nYE4NfPaPctcPCDv+Hdt8H+3vDh3mgw2u9gAG0p16Eo9rJsb7FY3AX2UOfxy6PKEzRUp9mhFTvRqthgfpB10PTyOhH9HVT2P6KiPg46LGRoJ5JhETSW2kJsa9lWZXxxz7ipwtBaOcP+jWq2aIFJnxAOspbTmRKpBx77BJVsjAZhgjjYI0z2s6zfwiQ2ZtleUeytNOLPPUJ8q7EokixLVnqunY5rLFiWxWy9eWN7lrGiKLY0u/ZOc78o1neRFIWHjZSvL5FJvM62nU98h1+KVRqO6C58LRuhp0HJnNYmc24zH61cNjMh/QdPVGylg4ZplXMNl2iXGqGk6333PBZYrNHsyY71ngQIijX74pXX3u978sctdCfAlpvHre0MJzlkaWWsKpiGKVyyklsLWtJkFzwXGSdTbo8a4JIXJZoA/T+fnma/+9c+OSDQxrcMT4JlYirQb9T/88nh3n+/29CjKkvQKTfAcsCVTMzApgk7mUFeNq6r+XyezB+YdKZU7vxW742Gifv3TI3fnxG4ZcJNeX/TTh1ptAx+JJ1Ve9+A7WCMGxZGbjD5icaIh4YDum29vXPNdet7fEY3zgpI+NF5T/DzyWlUcFJIkJSh+VvZGejT6F09xhn5kN0w9t0tmHUmMsj5GPL1T7dmtLo55wtVef4OTq3uVj1Ft/CGHwoha78FbWcQtz7yy5WP7ttyA387hLS5M1w5gT3DCbBcmOC56aKzPdq7tshBKQHI5zkGFgagOzlIj0/lghqw27GBk0T+7G5YAvsx6li7FcNqN6zQOZg2YnCOQkhRVEXtH53UswaUFV73aOMLR6KXPqzQPt21FfjlDSugM3L7AqdySH6M4P+4RjP1PT4jWbEC0vVs/DFSpHNP39EFezMDhm21GXDDtYxd3YVcM5/Zzn0Je4XXG/pk3SD0sqUplBY9cp/KmjXIt76hyGfV9sNtp7x2r8+I+jaA9TNToO9317fPRxFpe/e/IkLtgH1rYnVOyYJPr7Hc6fNnRJ4enjUnxJCcke6+uMYhR9+v385w0NnOw+52Hg0+wrrqLPvpxtWgbmysqucSYw5rC6FdXuU8iPq7kPR+SqTMr1VRVrbNCmTxE7uHuztE1VyU8Hcx24tZL2b9mH0Rs/sJew0Uh0vrmJ2/yoV2kTkhWaYqDJmklc4XbKx5isFwSKYJu7r6seLSCrtYLlmPXV1h5H+5TJA3zqWau7DdyYUwwjIMuzemTqZSsyFMr1LTR5uo/xLmeyHRoO9Bu8++UCuMeq1h6VHwoZbktmE/s3nV6x1pmIg8b0XxWWgKh4NRUcih8JFjH79HbZFiSUJahQgImRK93hgmCuNImEaA0cgZb+L8Tl1zkrGdisBSTPRQms24cWYs2c24OcyTsDMoPMQvlQUXzjalkgacJC83AN2Eo3u9lXBY6NaExIQMG0dZMrw7383oy0FbuAwfPezIyodd6TLYJl2ucd2gDHG4CP5uaD61+J6kT2hfZ/pVrg+TIrKdrAkk5mhPVXnGcnFOkc1MmDLnCySLcFN6KFdD5l/PlDJNDx+19lxmDrrRcKUxIH4/qYODn+p0Hj5+0BH1T+7Ak7biW+4exmC/P3zYv9a5vOIS/XBpzdhtTo68trc6OerZHN3OCfyxTuC7IfwHd+kDGz4edVS3B4NPZ4A7cnW1GecGJ9dduLLuzKfUZrdbepN+Ma/Op1Pf/s9h366I4cfDOxDDW8zYT6XENWv1zmiP3ZWpuokAb2GrXmugfjKBtoH92Yn04d3YtcNBR1f7sqOqfTlqE+XDh7ciyvaiK5R1Gon/+urV6/ngD99O1eHh4eHLN29nz99ODw8PC/ydJMlGl8am06ZlUIf1+bz+XqY7fssqSZIgCjEx+oCG90s5/Tc3Pt4+JjmVURypEjOuhZIvsuggIt0dgiofxWTsgrFfqWwRHVxFPmMP//T5cDi0/95gmvdVZNIZFBz/Cvo6JoZjYnYUU9IZaBPFEaVwYJY4Hml0EKnxe0hxtVIjOFaAwTlo3MFV6OUym6PY61zRQeS2GMWRD7LVTXVOeJlNomVY8Lqp6pZmKkN/1HYNzoPJwB85DRo7OEUnMf6jZvqmNQPtrYBjhdZ8Dha+4QvTmtdZo9FqPj6OQWZP/SiW8YVBoVEZd8GlPE+rHPVCuCyFXtSZCqQctuijhrdeqYZ3+HDZHHoDEteaL6I4EhaKdvsWItDqw08uBYWYoXSxDx37XsEY4Pe+Af0KdPC8+GAo3itgY6BDL2dKfvD44ejBcDR8MBzhDD7n50PnCD4SnOK9Gp99FCNkcIHjvaX98Ufpvq6v3aXNQ0yqhSzoXXtNdnjMKEMzuYlNQn/CPJ/CzfxwvK1qoJWsbGZkbPGyBK4TSt7/6DqSLovVF3xyA0Mt4+jy5s1cslTthZIE9kUOE+tSCFiqtAR9v52X9NlsbrS/v4yjxc3bW/wqt/cYD29+8+5+oFqOps7lnwHrgyfLOJrdDOt3dbXJPxHY/UfL5oJf0V/OxipbnAW5tbypY7irsN9E5Rlo1InW5VUjalDCYFXV2epVM1YqBy43CJpOmYGvf0P9G32/3icznwE54Wu1nGZvdH7vKXbQYukCrGRDCYPqsq7gNErYi0nLgiCNfrXSIfSlqgOp2D1a78xUJMbv9f1vxNG9dgUYemabhMQAAnVmFooyp5KoOTpzxxTdzxJW/0fKZ41JBCDc2GHhm6+Kr10WFi3oB3XriZhXXxP2NZd1TUm3doNdXdVkQNSxXLKrKzxV0Gd47y+XcdOAa3Ua6Gp3LRpSEBedUXUTNAPrttZQp2WdZRQBwQZ/37cBEFMp5PSs0n4eVEaXy6RDkCuAkw/e4wCyms7EVG7Yda0y0UnfGvtryPYUgJP8v8H70/LZd2IDKE/75bOn5bMfsHqwBMd7Dj0TITPH+XPI84Q9NVYrOX22goKnfd+++Sg1XAiYE+PSqTazrOK2nijxMP0JBXVzeMKwVFep4DmlH2qVQgj1UFgLjXhjoTQYkhKWRroCLzIJ+FQDBZYIFl5ZqpYk6zAs+JSzmYbJv99bwem9Z28QdIzwPe3zZ773C+eWmPELYFwuGG2cfChKOz/cpNIkJtOcazHxpmjMyhwwVRItVZ66YJrDaIDjeMbluYmfjvWzY+AFe1WCRAh++vs/sEeQ6S/kK52BvoVQfzFxYTvF7qEcuxe7tE0id6GN9aLaSUJPIQ6uLazjy3Yw5Pe8Fv2mGhvsJcN8jWi1WkyngKE534MG+yI44OnMXRoEFZ+EKEKJxKMqE8BDAgsGYeajuP6gul6fFnYoKtjee7JJqkusmnt1fHQLXJJLas8xivPHuF26Odir4yMsvK2PO2FvTY2JgFre6cLQE8AuBA/FebVmv3CpbuDiKl4utkOZiS953WPrAGXCbIQodpc6Sri6rH1t4qaSG49IVRZDo8LXGxKXdfBIUNSIPFbVbajyBkxyNq2ossAi+4Zbk5KLm8JZIY3VlUvzY1mlQ62wJwsnJoxp8BSwgp1a88cMpHHDOZtwY0HHrJICMa8r9FLWU8JlCVpgTsFGFGhwqEPRcfMV1a1Cffv6e1+/H/YQmHKMHOgmhoxVJVENcUJdHR1ObnXrG/VBL75vBhB1N8qU8K7WErRREkWc0lMuvQR19ij6U8cw47nr6kUFhuQQHuTwZKPt/9Pf/9GCa6tTZB0wtwLPMkx9vwFCck07gsfsTg0lSkDVhQjnA/37VRMAoSOmOStUVjOSuT2NH1GyvKnlok81qFMdTJXO8Nqq5a2Jg4w13qlgyAtNrmrKVShxv3ApjG3V94YqnHX58BoQj2kLBjJCkauR5uWizeBNCoZamY7MA9GtDa+NoDVe4JVVZxoKIW93T7W9/lbVgqCyquBWpCxMZZJuxb8LLQe+LtgXATSkxguh9P0trIrTnSmZwpmQZ3AB+hbm/cs6a5h8kmOwcwDZhi0gyV1nTVX2HB/e6OCkdTvR2wNtKNE5WYCewlmKHiqiOrgFEns9nKrXY3sOEC9TTaV9fMa/lkHCA+VIMzuC43XhuqCruXDbj5Qk7Ds1R4TV6gwqnW5+xCcjyLPYTdFaIeUSC9vJTERLDSeuY/gFp3wsv4RLo6HDot14hSt1gRucBV93wHXi6/YU5GddqcbxhYawumMHtzl05zOeK+Inr1b6zx2gXlBx/ozuHzo/jDO5dcKLGWouQf/0t/81lC3kUtBMbepu/ErWKs+NcpX/7VkDOQeCT7q2aaBnn5i0yc/ZJZHw3kYolgrSwyke9G5MMcYEU8quInWKrplg0685Tn82z+t1blSf9LNzov6KvIzDweC37ER9MPj1OFH3B78iJ+oTBNaHv2+WJttU242yI8S4rx/wXoGLcuVKX98TY8rkn3VJGJsQ3LDDaOn+a/y+QYjf4At2zuImiO0t2bAZQsNoMMD/dY/zm04WLNo1VYp2wqTK88W/RPHtI+jXn4Fr3uyfvk6qz96L0V8v04vRUeSjs11D6gMvlo8KseKY1QDrFnPu2q14hqh0jm+n4V72akWCpm2dsZC5kHAWDvAsU+lZ2P2SVEFjurfcrWCoj5scLN2zvmH5yBHm/iYqeqMKcBrQHOedo+OuVgWtXjA+RV0OeVzfIVGB1jex34dBdh0K9geDs2GNhIfrSHghqfSUHgo8Vucgf9mdtpe3bnkE9bLIGxkYCdeJvkedzbbb3SYNpJUWdhEdnFxFl3u8FHvu+8HJu+U7JEE7U5iEUypDEHM7iw6i/lpOjgF9QTkVJ2t0M+foCPyuGhPYh5VV7I8qPXd7Ix6r2eZCaOtmSowbNqvGdJkcaY4k/JJfnHPdx7umP0wGySBaxlcrkxguM0xdXLuQeCn6F8NkuGHMxgvsmv5Q7X3oEGP5VMjpTePeNYfyBgnH0UbnaBrBWIo/AEpGf/LtXnEkEPsz4GiI41kjPb5uUqeeB6oKSU2b8pQa6lnNPAqJR51colVFYkN20ObkoOHDVlrOSciwoaSZOmdmUxpMvfWQ2FLntbRSVVqZKk3ySSf3hNJJWtkkJw0T1okbweQYkq4+2t8npfbxkLS/B09Isdp/tCS2aSK1UdSNxlJx1mpM8dNCZN0I2S7s8xsK+6xEfTzxNKELlx/c8cH7pq5POlBh7QPuOGJX/bBbfaJbXKJ+yRXXXw3IJo/bw42OLj+k5dTYwJFBj+/yI+bWIj8+GBA/7g+IH58MOiaE33szQ2MIkLZfK/uk0bcVetTa36EQFXKiSAJ7wRFOjO42kuBrhh/kqSrqBxp7vdYh16N6vVqyOkJFp9OrSrNSzUFPKvfi4ySHS4FuRRwGBX1rMjWAFzkYk2OxjYUpubroIReM3/gIQcpLPha5QJ3D1dY5lmnUFpOwH5pcj3valR9eQI6qSu2YxTePg5o5V/p8gjkjMeNsjGWZ6JoHOeMydVEAd52RNxsdTRhhKbUw+CatRqiFg01Jq5FPCi75lDg4bnMEyyBHgWaYVmMMkhmVV44PLRe50i5NlDZECemExOeXJX4i6xWvAQ0zpOoLHwsysYvFuZvKv4I8xrBnibAI9NJZxSqZK3ywGMOnVZ6zUlkX0kQjuQ0jDreaS4Maus9M9WdQI8yHacB4f+dbA3jC3wt57h7N3GMnNV39AGMjLHSf1FnlzPvdMd8Ki+rWayiVEVbpRTN6KmxQqdqT1D/cTN+GN69bGsXtK13fgEUKMf3DoxekJN9nP/3tf9j3wLVkMzV31JpWGvJF87w2PT9NJ+/QVuu4FAhEMY4YTx3x+dsnYPCHGbfkXH0Jc/RiO5ZyCe1H1TgXKTsOyT+93kF497tJCOo8AeIqSjE6y1npRudCnifsUC4ontTcRdhO4zrboPuv9VQ4xwxmJX3lgVszaSCiCIaB/AJMy1kOmXAxb62qqVutDYzfXLfAFvd2mGVr9aoYLWnAcS5eCjZz5+vFV703lLh26le7mTIgM3pH2hywTPOJbeaPV6pu6SZcawoFuwEdsZ+mPhLHiX7Hdatzg69ow115S+51XLD7ejsvhSenk0CWrPtW1YeTtXMP0eXecjygWr4xnoivaJtXkzegL0QavAVbOLpPnftRHOUiBe+r8vfX4bdH37OLB8mgYz/dgrn737/4+vnLN88RGBSkDmHBjiIbr+CytdLK+/ird1ur9mL3nP7uOf3dc/q75/R3z+nvntPfPae/e05/95z+L/V+1e45/d1z+rvn9LdgYvec/u45/U99tmX3nP5v/iWl3XP6u+f0d8/p757T3z2nv3tOf/ec/u45/d1z+r+KV8p3z+n/EhS4e05/95z+7jn93XP6u+f0d8/p757Tb0uX3XP6u+f0d8/pn/5GnMC75/R3z+nvntPfPae/e05/95z+b+o5/VbhVL/MuZCt4nZX0Huy+sj+uziaYcXvwUl0dYXLvMXyOGz+saICrpN3cXTBtcBkOSoWjkOpKZZqnQNWIn7tcv/2jnH92PE2pcev1EhjrawbcUgEfW3fdlHy0as3x1EchadBC5XRawx8jqVdfO7q3lr1X9R2FeVcTiuqHYvcnEv3cNWsW1p7TqW1/o9WARoWkjYQdmtu3TbwX9zUxgFXV65slyo3XX/3aesIj9jQG8/v3XK5/D9flIrT","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kt2AhZPcXqQ9RhrlYxtK21teORGBK1jllSw0FXZXdDrALKAIrNHkZHzMP8wT7t63yav2QjE0AdfZCURHtkb/tBZqNwJBKZiTxxFVk+NdHBSfSNSqsCpDXRuzjKwKRalFYoGR1ExzNgX2vgFljoxQ6PXjCe52puWGVAG2YVm4IEjb0kzFkW5mPjBSu1uhCZkFOWccvZXNgZG3MDj/YZyFRlkLGJyCE5lafyWJQH7G2ZK56xhao0O/rmP+rZcBlsO+n1voFxNWVvX/R6776YWVuag36fl2WiSpBGTGXOxyZJVdHPsGOZTe7HbD4DDTgrS7lkwI3IF4xnGZuLbArWxMzOQLJUlQuWKqUzIbkFE7OST4HJqhiDNjHjMmOF0sCEZJxp4Nliz6q9ygD7zzevXrKJ0gW3CTvKKxPXy2VCQ2rzhZvezqDe1T0TsGGsFnIas4KfI7aEZT9WIj3HbRuQGf4fBx4evSBc9XpvqrJU2kLGfnBbOOj18MtXkKs54xqof6qKQklWcs0LsHRcM27ps4YfK6Ehc4fC8zzg4uBU7rFeT/ICDno99laKHytgIgNpxUSAxl0yOxPGD0hcf7soqf8LmYkUkUcAYCtTk25XRCp2fVNCilO6ri1UMyXZfCbSGeFwzt35lzlP3bY0mBJSKy6gO/FlzBY48TcgVYBgprT4q5KW53R8F6CtSHnePmYEELsay7VF9JdKSBta/QrsT/448bTpED0dImgZIrcQkr4YYBc8r8B4qOYxmyFUr6HUYIg1/LyIeJmxGYjpbOt6PHtfGduZmFUGwWxD4dcKp0roBULbhOcGmJh0cFnwc2itxhTxPM8T9tWCZTDhVW5jJpBCra4gYS+VZbwsc5HycQ5EA8hs3FYa9uiUPfkkXfI5IgkAhnGWickENDIzfqQp/JgAHdJlIzKI0+yMS6bkykGnKld6nYSouYtHlippQdqEHV5wkRPwbrOGCZnmVQZsnPP0PGbjvIKYacgcoy8AxVzshRZ2Ydx4nBN+mIEcqVBJhF8qv7wwzHiosoQdI6PU/IcfA6ppEWHaWPVcPlG4MqIgsCSDgos8JsTF7L0aMytsDjEyeMnlIkb5CjGzcGnH6jJm6QzSc/pL80woNq6sVdJtLNOqzNRcelxOlLRG/HUDR4YvH47RUcz2Y/YoZk9iNhzEbDiK2XA/ZsNHMRs+idloELPRKGaj/ZiNHjmwRk88rnmN4DYAw5HDsv31YBfl9PfCEGejgDW1zJ53ZPYwYb1ezU3Y9pe//OVUXp1Kxk4jZK7T6ICdRnWX0yh231Bm4reh/32JPx6MHvufC/z5aPTE/5xT1+G+/znDn6PhqVz6BU/liCCxvCivgQI/3ykE/pcnImyjRbEtyDNsREEUhw94Vh148MOyvZcHuBchhRU8N9u3E3p8RjtqQFrb1D5uish1+47o82e0nTY8+IXEpPtEYrX1KTA8QTFa2/3DxN8s2zfvlv1s9t4C59O2/gi3jqLpGEXT9v3X0uszQsIqTJ+GiccJKQAkmbfjwXf4jLDQhejTcPAEcYCX0nYE4NfPaPctcPCDv+Hdt8H+3vDh3mgw2u9gAG0p16Eo9rJsb7FY3AX2UOfxy6PKEzRUp9mhFTvRqthgfpB10PTyOhH9HVT2P6KiPg46LGRoJ5JhETSW2kJsa9lWZXxxz7ipwtBaOcP+jWq2aIFJnxAOspbTmRKpBx77BJVsjAZhgjjYI0z2s6zfwiQ2ZtleUeytNOLPPUJ8q7EokixLVnqunY5rLFiWxWy9eWN7lrGiKLY0u/ZOc78o1neRFIWHjZSvL5FJvM62nU98h1+KVRqO6C58LRuhp0HJnNYmc24zH61cNjMh/QdPVGylg4ZplXMNl2iXGqGk6333PBZYrNHsyY71ngQIijX74pXX3u978sctdCfAlpvHre0MJzlkaWWsKpiGKVyyklsLWtJkFzwXGSdTbo8a4JIXJZoA/T+fnma/+9c+OSDQxrcMT4JlYirQb9T/88nh3n+/29CjKkvQKTfAcsCVTMzApgk7mUFeNq6r+XyezB+YdKZU7vxW742Gifv3TI3fnxG4ZcJNeX/TTh1ptAx+JJ1Ve9+A7WCMGxZGbjD5icaIh4YDum29vXPNdet7fEY3zgpI+NF5T/DzyWlUcFJIkJSh+VvZGejT6F09xhn5kN0w9t0tmHUmMsj5GPL1T7dmtLo55wtVef4OTq3uVj1Ft/CGHwoha78FbWcQtz7yy5WP7ttyA387hLS5M1w5gT3DCbBcmOC56aKzPdq7tshBKQHI5zkGFgagOzlIj0/lghqw27GBk0T+7G5YAvsx6li7FcNqN6zQOZg2YnCOQkhRVEXtH53UswaUFV73aOMLR6KXPqzQPt21FfjlDSugM3L7AqdySH6M4P+4RjP1PT4jWbEC0vVs/DFSpHNP39EFezMDhm21GXDDtYxd3YVcM5/Zzn0Je4XXG/pk3SD0sqUplBY9cp/KmjXIt76hyGfV9sNtp7x2r8+I+jaA9TNToO9317fPRxFpe/e/IkLtgH1rYnVOyYJPr7Hc6fNnRJ4enjUnxJCcke6+uMYhR9+v385w0NnOw+52Hg0+wrrqLPvpxtWgbmysqucSYw5rC6FdXuU8iPq7kPR+SqTMr1VRVrbNCmTxE7uHuztE1VyU8Hcx24tZL2b9mH0Rs/sJew0Uh0vrmJ2/yoV2kTkhWaYqDJmklc4XbKx5isFwSKYJu7r6seLSCrtYLlmPXV1h5H+5TJA3zqWau7DdyYUwwjIMuzemTqZSsyFMr1LTR5uo/xLmeyHRoO9Bu8++UCuMeq1h6VHwoZbktmE/s3nV6x1pmIg8b0XxWWgKh4NRUcih8JFjH79HbZFiSUJahQgImRK93hgmCuNImEaA0cgZb+L8Tl1zkrGdisBSTPRQms24cWYs2c24OcyTsDMoPMQvlQUXzjalkgacJC83AN2Eo3u9lXBY6NaExIQMG0dZMrw7383oy0FbuAwfPezIyodd6TLYJl2ucd2gDHG4CP5uaD61+J6kT2hfZ/pVrg+TIrKdrAkk5mhPVXnGcnFOkc1MmDLnCySLcFN6KFdD5l/PlDJNDx+19lxmDrrRcKUxIH4/qYODn+p0Hj5+0BH1T+7Ak7biW+4exmC/P3zYv9a5vOIS/XBpzdhtTo68trc6OerZHN3OCfyxTuC7IfwHd+kDGz4edVS3B4NPZ4A7cnW1GecGJ9dduLLuzKfUZrdbepN+Ma/Op1Pf/s9h366I4cfDOxDDW8zYT6XENWv1zmiP3ZWpuokAb2GrXmugfjKBtoH92Yn04d3YtcNBR1f7sqOqfTlqE+XDh7ciyvaiK5R1Gon/+urV6/ngD99O1eHh4eHLN29nz99ODw8PC/ydJMlGl8am06ZlUIf1+bz+XqY7fssqSZIgCjEx+oCG90s5/Tc3Pt4+JjmVURypEjOuhZIvsuggIt0dgiofxWTsgrFfqWwRHVxFPmMP//T5cDi0/95gmvdVZNIZFBz/Cvo6JoZjYnYUU9IZaBPFEaVwYJY4Hml0EKnxe0hxtVIjOFaAwTlo3MFV6OUym6PY61zRQeS2GMWRD7LVTXVOeJlNomVY8Lqp6pZmKkN/1HYNzoPJwB85DRo7OEUnMf6jZvqmNQPtrYBjhdZ8Dha+4QvTmtdZo9FqPj6OQWZP/SiW8YVBoVEZd8GlPE+rHPVCuCyFXtSZCqQctuijhrdeqYZ3+HDZHHoDEteaL6I4EhaKdvsWItDqw08uBYWYoXSxDx37XsEY4Pe+Af0KdPC8+GAo3itgY6BDL2dKfvD44ejBcDR8MBzhDD7n50PnCD4SnOK9Gp99FCNkcIHjvaX98Ufpvq6v3aXNQ0yqhSzoXXtNdnjMKEMzuYlNQn/CPJ/CzfxwvK1qoJWsbGZkbPGyBK4TSt7/6DqSLovVF3xyA0Mt4+jy5s1cslTthZIE9kUOE+tSCFiqtAR9v52X9NlsbrS/v4yjxc3bW/wqt/cYD29+8+5+oFqOps7lnwHrgyfLOJrdDOt3dbXJPxHY/UfL5oJf0V/OxipbnAW5tbypY7irsN9E5Rlo1InW5VUjalDCYFXV2epVM1YqBy43CJpOmYGvf0P9G32/3icznwE54Wu1nGZvdH7vKXbQYukCrGRDCYPqsq7gNErYi0nLgiCNfrXSIfSlqgOp2D1a78xUJMbv9f1vxNG9dgUYemabhMQAAnVmFooyp5KoOTpzxxTdzxJW/0fKZ41JBCDc2GHhm6+Kr10WFi3oB3XriZhXXxP2NZd1TUm3doNdXdVkQNSxXLKrKzxV0Gd47y+XcdOAa3Ua6Gp3LRpSEBedUXUTNAPrttZQp2WdZRQBwQZ/37cBEFMp5PSs0n4eVEaXy6RDkCuAkw/e4wCyms7EVG7Yda0y0UnfGvtryPYUgJP8v8H70/LZd2IDKE/75bOn5bMfsHqwBMd7Dj0TITPH+XPI84Q9NVYrOX22goKnfd+++Sg1XAiYE+PSqTazrOK2nijxMP0JBXVzeMKwVFep4DmlH2qVQgj1UFgLjXhjoTQYkhKWRroCLzIJ+FQDBZYIFl5ZqpYk6zAs+JSzmYbJv99bwem9Z28QdIzwPe3zZ773C+eWmPELYFwuGG2cfChKOz/cpNIkJtOcazHxpmjMyhwwVRItVZ66YJrDaIDjeMbluYmfjvWzY+AFe1WCRAh++vs/sEeQ6S/kK52BvoVQfzFxYTvF7qEcuxe7tE0id6GN9aLaSUJPIQ6uLazjy3Yw5Pe8Fv2mGhvsJcN8jWi1WkyngKE534MG+yI44OnMXRoEFZ+EKEKJxKMqE8BDAgsGYeajuP6gul6fFnYoKtjee7JJqkusmnt1fHQLXJJLas8xivPHuF26Odir4yMsvK2PO2FvTY2JgFre6cLQE8AuBA/FebVmv3CpbuDiKl4utkOZiS953WPrAGXCbIQodpc6Sri6rH1t4qaSG49IVRZDo8LXGxKXdfBIUNSIPFbVbajyBkxyNq2ossAi+4Zbk5KLm8JZIY3VlUvzY1mlQ62wJwsnJoxp8BSwgp1a88cMpHHDOZtwY0HHrJICMa8r9FLWU8JlCVpgTsFGFGhwqEPRcfMV1a1Cffv6e1+/H/YQmHKMHOgmhoxVJVENcUJdHR1ObnXrG/VBL75vBhB1N8qU8K7WErRREkWc0lMuvQR19ij6U8cw47nr6kUFhuQQHuTwZKPt/9Pf/9GCa6tTZB0wtwLPMkx9vwFCck07gsfsTg0lSkDVhQjnA/37VRMAoSOmOStUVjOSuT2NH1GyvKnlok81qFMdTJXO8Nqq5a2Jg4w13qlgyAtNrmrKVShxv3ApjG3V94YqnHX58BoQj2kLBjJCkauR5uWizeBNCoZamY7MA9GtDa+NoDVe4JVVZxoKIW93T7W9/lbVgqCyquBWpCxMZZJuxb8LLQe+LtgXATSkxguh9P0trIrTnSmZwpmQZ3AB+hbm/cs6a5h8kmOwcwDZhi0gyV1nTVX2HB/e6OCkdTvR2wNtKNE5WYCewlmKHiqiOrgFEns9nKrXY3sOEC9TTaV9fMa/lkHCA+VIMzuC43XhuqCruXDbj5Qk7Ds1R4TV6gwqnW5+xCcjyLPYTdFaIeUSC9vJTERLDSeuY/gFp3wsv4RLo6HDot14hSt1gRucBV93wHXi6/YU5GddqcbxhYawumMHtzl05zOeK+Inr1b6zx2gXlBx/ozuHzo/jDO5dcKLGWouQf/0t/81lC3kUtBMbepu/ErWKs+NcpX/7VkDOQeCT7q2aaBnn5i0yc/ZJZHw3kYolgrSwyke9G5MMcYEU8quInWKrplg0685Tn82z+t1blSf9LNzov6KvIzDweC37ER9MPj1OFH3B78iJ+oTBNaHv2+WJttU242yI8S4rx/wXoGLcuVKX98TY8rkn3VJGJsQ3LDDaOn+a/y+QYjf4At2zuImiO0t2bAZQsNoMMD/dY/zm04WLNo1VYp2wqTK88W/RPHtI+jXn4Fr3uyfvk6qz96L0V8v04vRUeSjs11D6gMvlo8KseKY1QDrFnPu2q14hqh0jm+n4V72akWCpm2dsZC5kHAWDvAsU+lZ2P2SVEFjurfcrWCoj5scLN2zvmH5yBHm/iYqeqMKcBrQHOedo+OuVgWtXjA+RV0OeVzfIVGB1jex34dBdh0K9geDs2GNhIfrSHghqfSUHgo8Vucgf9mdtpe3bnkE9bLIGxkYCdeJvkedzbbb3SYNpJUWdhEdnFxFl3u8FHvu+8HJu+U7JEE7U5iEUypDEHM7iw6i/lpOjgF9QTkVJ2t0M+foCPyuGhPYh5VV7I8qPXd7Ix6r2eZCaOtmSowbNqvGdJkcaY4k/JJfnHPdx7umP0wGySBaxlcrkxguM0xdXLuQeCn6F8NkuGHMxgvsmv5Q7X3oEGP5VMjpTePeNYfyBgnH0UbnaBrBWIo/AEpGf/LtXnEkEPsz4GiI41kjPb5uUqeeB6oKSU2b8pQa6lnNPAqJR51colVFYkN20ObkoOHDVlrOSciwoaSZOmdmUxpMvfWQ2FLntbRSVVqZKk3ySSf3hNJJWtkkJw0T1okbweQYkq4+2t8npfbxkLS/B09Isdp/tCS2aSK1UdSNxlJx1mpM8dNCZN0I2S7s8xsK+6xEfTzxNKELlx/c8cH7pq5POlBh7QPuOGJX/bBbfaJbXKJ+yRXXXw3IJo/bw42OLj+k5dTYwJFBj+/yI+bWIj8+GBA/7g+IH58MOiaE33szQ2MIkLZfK/uk0bcVetTa36EQFXKiSAJ7wRFOjO42kuBrhh/kqSrqBxp7vdYh16N6vVqyOkJFp9OrSrNSzUFPKvfi4ySHS4FuRRwGBX1rMjWAFzkYk2OxjYUpubroIReM3/gIQcpLPha5QJ3D1dY5lmnUFpOwH5pcj3valR9eQI6qSu2YxTePg5o5V/p8gjkjMeNsjGWZ6JoHOeMydVEAd52RNxsdTRhhKbUw+CatRqiFg01Jq5FPCi75lDg4bnMEyyBHgWaYVmMMkhmVV44PLRe50i5NlDZECemExOeXJX4i6xWvAQ0zpOoLHwsysYvFuZvKv4I8xrBnibAI9NJZxSqZK3ywGMOnVZ6zUlkX0kQjuQ0jDreaS4Maus9M9WdQI8yHacB4f+dbA3jC3wt57h7N3GMnNV39AGMjLHSf1FnlzPvdMd8Ki+rWayiVEVbpRTN6KmxQqdqT1D/cTN+GN69bGsXtK13fgEUKMf3DoxekJN9nP/3tf9j3wLVkMzV31JpWGvJF87w2PT9NJ+/QVuu4FAhEMY4YTx3x+dsnYPCHGbfkXH0Jc/RiO5ZyCe1H1TgXKTsOyT+93kF497tJCOo8AeIqSjE6y1npRudCnifsUC4ontTcRdhO4zrboPuv9VQ4xwxmJX3lgVszaSCiCIaB/AJMy1kOmXAxb62qqVutDYzfXLfAFvd2mGVr9aoYLWnAcS5eCjZz5+vFV703lLh26le7mTIgM3pH2hywTPOJbeaPV6pu6SZcawoFuwEdsZ+mPhLHiX7Hdatzg69ow115S+51XLD7ejsvhSenk0CWrPtW1YeTtXMP0eXecjygWr4xnoivaJtXkzegL0QavAVbOLpPnftRHOUiBe+r8vfX4bdH37OLB8mgYz/dgrn737/4+vnLN88RGBSkDmHBjiIbr+CytdLK+/ird1ur9mL3nP7uOf3dc/q75/R3z+nvntPfPae/e05/95z+L/V+1e45/d1z+rvn9LdgYvec/u45/U99tmX3nP5v/iWl3XP6u+f0d8/p757T3z2nv3tOf/ec/u45/d1z+r+KV8p3z+n/EhS4e05/95z+7jn93XP6u+f0d8/p757Tb0uX3XP6u+f0d8/pn/5GnMC75/R3z+nvntPfPae/e05/95z+b+o5/VbhVL/MuZCt4nZX0Huy+sj+uziaYcXvwUl0dYXLvMXyOGz+saICrpN3cXTBtcBkOSoWjkOpKZZqnQNWIn7tcv/2jnH92PE2pcev1EhjrawbcUgEfW3fdlHy0as3x1EchadBC5XRawx8jqVdfO7q3lr1X9R2FeVcTiuqHYvcnEv3cNWsW1p7TqW1/o9WARoWkjYQdmtu3TbwX9zUxgFXV65slyo3XX/3aesIj9jQG8/v3XK5/D9flIrT",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": ""\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.c4b4350f.js b/assets/js/34593b53.c4b4350f.js deleted file mode 100644 index 521f2b69b..000000000 --- a/assets/js/34593b53.c4b4350f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPGtzHDdyfwWZSpWszXD2QVKSGUV1tKTYzCkSy6KiupA6GjvTuwNxBhgDM1yuWay6D/cP8ilf76f5l6S6AcxjHyQl0T7qsv4gczF4NBrdjUa/LoOST02wdxy8UHGVgyxN8CEMEjCxFkUplAz2gqMU2HMNvATme7H9wwPGs0zNDKsMaMNKxaYgQWMvCTOW+PnYeM4Krc5FIuSUJbzkbCbKlI25gUc7DGSsEkjYRGQQncgTeSSKPfauyBRP2FxVmh2++Pd6NlwG2457vRcwrqbs3UGv9+GbtCwLs9fv86KIVAHSiKnM+NhEscr7CXYsksnDkM1S0ICzsphLBtyIbM54krCZSKZQmpCVKUgWq2LOYqV0IiQvwYSs4FNgssrHoE3IuExYrjQwIRlnGngy3yrVVmWA/cfbN6/ZROmclxE7zCoT1sslQkNcZnM7fZlCvasHxmPDlFrIachyfobYEiX7uRLxGW7bgEzw/zhw//CAcNXrva2KQukSEvbebmGv18Mv30GmZoxroP6xynMlWcE1z6Gk40p5SZ81/FwJDYk9FJ5lHhd7J3KL9XrlvIC9Xo8dyETEiAyaEFuZmri+ke2KSMKubwuIxUS4ri3UMSXZLBVxSjiZcXueRcZjC6YGU0BcinPoTnwRsjlO/AKk8hCkSotflCx5RsdxDroUMc/ax4YAYldTcl0iOgslZOlb3QrsT+548PToUBxdIWgJIisXkr4YYOc8q8A4qGYhSxGqH6HQYIjU3byISJmwFMQ0XbseTz5WpuxMzCqDYLahcGv5UyL0AqFtwjMDTEw6uMz5GbRWY4p4mGcR+27OEpjwKitDJpDiSl1BxF6rkvGiyETMxxkg5TJkHl5WGrbolB05OEAkz+mMD4mjwTDOEjGZgEbmxI80hRvjoUM6a0QAcU6ZcsmUXDjoWGVKL5MQNXfxyGIlS5BlxPbPucgIeLtZw4SMsyoBNs54fBaycVZByDQklnHngGIrdEIIuzBuHM4JP8xAhlSoJMIvlVteGGYcVEnEjlJhGn7Cjx7VtIgwbaw6rp0oXBlR4FmMQc5FFhLiQvZRjVkpygxCZNiCy3mI8hJCVsJFOVYXIYtTiM/oL80Todi4Kksl7cYSrYpEzaTD5UTJ0ohfVnCk//LpGB2FbCdkj0L2JGTDQciGo5ANd0I2fBSy4ZOQjQYhG41CNtoJ2eiRBWv0xOGa1whuAzAcWSyXXw92Ue6+EoY4GwWmqWXwrCODhxHr9WpuwraffvrpRF6eSMZOAmSuk2CPnQR1l5MgtN9QZuK3oft9gT+2R4/dzzn+fDR64n7OqOtwx/1M8edoeCKv3IInckSQlDwvroECP98pBO6XIyJso0WxzcszbERBFPoPeFYdePDDVXsv27gXIUUpeGbWb8f3uEc7akBa2tQOborIdf2O6PM92k4bHvxCYtJ+IrHa+uQZnqAYLe1+N3I3y/rN22Xvzd5b4HzZ1h/h1lE0HaFoWr//WnrdIyQswvRlmHgckQJAknk9HlyHe4SFLkRfhoMniAO8lNYjAL/eo923wMEP7oa33wY7W8PdrdFgtNPBAL6NbIc830qSrfl8fhfYQ53HLY8qj9dQrWaHr9KJVvmK5we9DppeTieiv73K/p+oqI+9DgsJvvvoYeE1lvrF19ayS5Xw+QNjp/JDa+UM+zeq2bwFJn1COOj1G6dKxA547ONVsjE+8CLEwRZhsp8k/RYmsTFJtvJ8a6ERf24R4luNeR4lSbTQc+l0bGPOkiRky80r25OE5Xm+ptm2d5r7eb68iyjPHWykfH2LTOJ0tvV84jr8XqzScER34WvZCC0HSma0Nj3nVvPRwmWTCuk+OKJiCx00TKuMa7jAd6kRStred89jnsUazZ7esfQEJCuBRQX75o3T3h868sctdCfAlpvHLe0MJ9lncWVKlTMNU7hgBS9L0JImO+eZSDg95baoAS54XuAToP/nk5PkX/65TwYIfOOXDE+CJWIq0A7U//Px/tZ/f1jRoyoK0DE3wDLAlUzIoIwjdpxCVjSmqNlsFs22TZwqlVk71EejYWL/PVXjj6cEbhFxUzxctVNLGq0HP5LO4nvfQNnBGDfMj1zx5CcaIx4aDui2de+da65b1+Me3TgLIOFHaz3Bz8cnQc5JIUFShuZvVaagT4IP9Rj7yIfkhrEfbsGsqUgg42PIlj/dmtHq5ozPVeX42xu1ult1FN3CG37IhaztFrSdQdj6yC8WPtpvVyv42yKkzZ3+yvHs6U+AZcJ4y00Xne3RzrRFBkcJQDbMMTA/AM3DXnp8KRfUgN2ODawkcmd3wxLYj1HH2qzoV7thhc7BtBGDc+RCirzKa/vopJ7Voyx3ukcbXzgSre5+hfbpLq3AL25YAY2R6xc4kUOyY3j7xzWaqetxj2TFAkjXs/HnSJHOPX1HF+zNDOi31WbAFdcydrUXcs18Zj33RewNXm9ok7WD0MoWx1CUaJH7UtasQb71DUU2q7Ydbj3ltXvdI+pbAdZvTIGu313fPp9FpO3df0WE2gH71sRqjZI5n17zcqfP94g8HTxLRohe71DDRGRZy6XIfJP37KBLBzLIndvLORPxqiNDuJClwmeBd9v2emOYKDSCo08TXSkpb5yO9q6xx9r2i7IYvc5Ks5Qbq4OT0o/HhU7bMoXcmeNfqxKsL84UShqwZFisALrxpfV6C7Z8362x5wvpN47HOry7h+fo20H7oIePdjsHvTvoHPRg3UFf8+5EErC48MY6aD61BAPRiG9fvpsW+d5Pish+KdE5458flptUlSUsE2fklkmEKTI+R7LwbO6gXPT3PU+VMk0P53L7xm14r+vKUxq9eQ+j2rPxpRaz4ePt9mnsPrkDM8CCYax7GIOd/nC3f61lbMGe8+lKBWO3OTkyOd3q5Khnc3QbC9bnWrDuhvC37/IBP3w86tw724MvZ4A7eqe3GeeGF/pdvMPv7EHcZrdbPoV/tyfpl1Pfzm+hnC+I4cfDOxDDa3TwL6XEJVX7zmiP3ZWevYoAb6FoX6tdfzGBtoH9zYl0926U8uGgo6t921HVvh21iXJ391ZE2V50gbJOAvFf3735cTb44/dTtb+/v//67bv05bvp/v5+jr+jKFr5Hlt12rQM6rAuuNDdy3THr1kliiJEIUZp7tHwfiGn/2rHh+vHRCcyCANVYPinUPIgCfYC0t3Bq/JBSE8SMOV3KpkHe5eBCzfCP10wDw7tfzQYc3oZmDiFnONfXl/HKFWMEg1CipgBbYIwIP8zhqzikQZ7gRp/hBhXKzSCUwowOAeN27v0vWyYZRA6nSvYC+wWgzBwHoK6qQ5QLZJJcOUXvG6quqWZytAf9bsG58FIxs+cBh87OEUnSvezZnrRmoH2lsOReq7wWwkv+Ny05rUGxGAxOBjHILPHbhRL+Nyg0KiMveBinsVVhnohXBRCz2s3KymHLfqo4a1XquEd7l41h96AxLXm8yAMRAl5u30NEWj16ScXg0LMUKzLp479qGAM8AfXgD4gOniefzIUHxWwMdChF6mSnzx+ONoejobbwxHO4AIWPnUOH1eNU3xU49PPYoQEznG8e2l//lHar8trd2lzHyMCIfF611YT2hoyCi+LbmIT358wz6dwMz8crQt5bkVampQeW7wogOuIIo8/O6i9y2L1BR/dwFBXYXBx82YuWKy2fDw1+yaDSWn9nyxWWoJ+2A6quDebG+3sXIXB/Obtzb/K7T3Gw5vdvLv3FIjeBOn/PWDdfnIVBunNsP5Qh8r/HYHdeXTVXPAL+svpWCXzUy+3rm7q6O8q7DdRWQIadaJledWIGpQwmOJxunjVjJXKgMsVgqYTI+2ScVD/Rmu2s8nMUsBnTKOW0+yNzu9s3xZajLuGhVAOYVBd1hWcBBE7mLReEKTRL4Zp+74UMi0Ve0DrnZqKxPiDvvuNOHrQTkdBy2wTTeVBoM6shLzIKJ9jhsbcMbkmk4jV/5HyWWMSAfA3tl/45qviuQ0hoQXdoG4yBHPqa8Sec1kHxHcDz9nlZU0GRB1XV+zyEk8V9Cne+1dXYdOAa3Ua6Gq3LRpiEOedUXUTNAPrttZQq2WdopZlG9x93wZATKWQ09NKu3lQGb26ijoEuQA42eAdDiCp6UxM5Ypd1yoTnfStsb+EbEcBOMn/G7w/LZ79IFaA8rRfPHtaPHuPqU8FWN6z6JkImVjOn0GWReypKbWS02cLKHjad+2rj1LDuYAZMS6dajPLIm7riSIH059QUDeHJwyLdRULnlHslFYxeFcPnpvER7wpoTDoXxMljbTZKfQk4FMN5FgiWHhVUqoXvQ79gk85SzVM/u3BAk4fPHuLoGOW39M+f+Z6H1izRMrPgXE5Z7RxsqEobe1wk0qTmIwzrsXEPUVDVmSAcV74UuWxdQ9ajHo4jlIuz0z4dKyfHQHP2ZsCJELw61//hj28TD+Qb3QC+hZC/WBiHZGKPUA59iC0MWdE7kKb0olqKwkdhVi41rCOyzlA/+XLWvSbamywl/TzNaK11GI6BXTNuR402GXwAI9Te2kQVHzivQgFEo+qjAcPCcw/CMlPJyx9CDntWn1a2CGvYHvv0SqpLjHl583R4S1wSSapLcso1h5jd2nnYG+ODjFrsD7uiL0zNSY8anmnC0NLADsX3GcW1Zr93MbpgPWrOLnYdmVGLl9viy0DlAizEqLQXuoo4eoc26WJm7RSPCJVlegaFS5Zirisg0eCokbkkapuQ5U3YJKzaUVh0SWyr781KTKyyfoT0pS6sjFKLKm0T3R0ZGHFhDENnjxWsFNr/pCBNHY4ZxNuStAhq6RAzOsKrZT1lHBRgBYgY1iJAg0WdSg6br6iuil073585ZKJ/R48U46RA+3EkLCqIKohTqhTO/3JLW59pT7oxPfNAKLuRgmYztRagDZKoohTesqlk6D2PYr21DGkPLNdnahAlxzCgxwerXz7//rXv7XgWmsUWQbMrsCTBON2b4CQTNOW4DE0TUOBElB1IcL5QP9h8QmA0BHTnOYqqRnJ3J7GDynS19Ry0YUa1KEOpopTvLZqeWtCL2ONMyoYskKTqZpiFQrcL1wIU7aSE30KwbJ8+BEQj3ELBnqEIlcjzct5m8GbEAy1MB09D0Q3sbV+BC3xAq9KdaohF/J291Tb6l+qWhBUpcp5KWLmpzJRN13ZupY9X+fsGw8aUuO5UPrhGlbF6U6VjOFUyFM4B32L5/3rOuSRbJJjKGcAsg2bR5K9zpqU0hlWAejgpHU7UeJ0G0o0Tuagp3Aao4WKqA5ugcReD6fq9diWBcTJVFNp559xqfskPFCONLMjOE4XrrNRmgu3XTEhYj+oGSKsVmdQ6bTzIz4ZQZ6EdorWCjGXmJVLz0R8qeHEtQ8/50I2S9gwGjos2o1TuGLruMFZMDUd1wmv25OXn3WaDcf0cr+6ZQe7OTTnM54p4ienVrrPHaAOKLM4pfuHzg/9THYdn+6vZhL0r3/5X0PRQpjHHoOpn7orv9JrlWdG2bTl9qyenD3BR923qadnF5i0ys7ZJRFfLMBnenjpYRUPKmKRjzE6jqKrSJ2ia8a/6ZcMp7+Z5fU6M6oL+tkYUb8iK+NwMPhHNqJuD74eI+rO4Csyoj5BYJ37+2Zpsk61XSk7vI/7+gEfFVgvV6b09T3Rp0z2WRuEsQrBDTuMrux/jd3XC/EbbMHWWNw4sd1L1m+G0DAaDPB/3eN80YmCxXdNFeM7YVJl2fyfgvD2HvTrz8A2r7ZPXyfV049i9MtFfD46DJx3tvuQ+sSL5bNcrDhm0cG65jl37VYcQ1Q6w0JOuJetWpGgaVtnLGQmJJz6AzxNVHzqd39FqqAx3VvuVjDUx00Glu5Z37B8YAlzZxUVvVU5WA1ohvPO0HBXq4KlnjM+RV0OeVzfIVGB1jex36dBdh0KdgaD02GNhN1lJBxIypujqmVH6gzk77vT9vKlXR5BvcizRgYGwnai70Fns+12u0kDcaVFOQ/2ji+Diy1eiC37fe/4w9UHJMEyVRiEUyhDEPMyDfaC/lJMjgF9TjEVx5eWb2pWMFwmGEm4dD/wQvTPh9EwuAoXx6y8T67pD9XWpw4xJZ8KOb1p3IcGR2/xHO1RdTDVyKlC/BFQULmDaPcKA4H0kwLHdzGiHsnjxyaS6aU/ZB9jtCpsqDnMxUAgHwfUCe1ZvNdXBOusjtUZ7raiZI59wAvFsNQhLKuiUuqt+ziTOsykFTnSChxpYkE6oSAU3dEK7jhueKKOo/AvgCGpzqOdHdIxHw9JGdt+QnrOzqMrouLGcRoEXecoZbQsuvi+zGPVdVhtvDD/QF6YBSeMI57Gk2DDdTsmcdfUNRF7KqxNsh276KJZdK2Jco2F0i25YImrAVllANtdaXdyQ1o2hhUc6dXqLj9iqCvy4/aA+HFnQPz4ZNDR6N3emxkavZyU71r3JgW7rV+jEv0BhaiQE0US2AkOf2J0Q5IEX3qHQRarvC721uu1Drke1evVktUSKtqA3lSaFWoGelLZ6nGTDC4EWvlwGOT0rQmcAJ5nYEyGuS8lTMnyREUh0J3iDPYxL/hYZAJVAJvqZlmm0SJMxN43oRcPtK2RcQ4Zag61nRTroXqtb6b02QRDOELG2RgLQaKlHGTKZWyN8vY6I+My2n3Q4VFoYbC+pUaohYVNyVIjn+Rc8ilxcNjmCJZAhgLNMK3G6LMyKqssH5ZcZErbqE3aEMWHExJfXhT4iR6TeA1oSJGqz51rxoTWNWZvKlchdYxeyAJhEWg0KxWrZKawmCl6M6ssY4UqrYcR36xtGHF4qbk0qDC7QFF3BjXCnNcEjDM/vjOAJ/xKyDNbgG+LHdd09R7GRpTQLc+xyJkPu2O+F+UP1RjLeyojSqXnzeipKNNqTDpHe5L6h53pe18Pt6VRNHMkKjYrXt8qNn2sJNJ/CyVSiOnvHx6QzvqQ/fqX/2GvgGvJUjWz1BpXGrJ5U3qXStPSyVu01Son+eVQjCPGY0t87vbxGHyf8pJsna9hhkZly1I2vvywGmciZkc+FqfX2/M1gZv4nE45AZvgic5Szgo7OhPyLGL7ck7uneYuwnYa19kG3X+tMsIcA4qVdIkAds2ogYgcCgayczAt2zUkwrqgtaqmdrU2MG5z3XxX3Nt+kiylj6LzogHHWlzJ98ut6RUr/q7IOO2kk3YDV0AmVJPW7LFE80nZzB8uJMHSTbjU5PNnPTpCN019JJYT3Y7rVmuVXtCGu/KWrN24YLeyMy+EI6djT5asW/fm08naWmvocm/ZAVAtX+new4q85s3kLehzEfvH+xqO7lPnfhAGmYjBmY7c/bX//eErdr4dDYKw9ca4BXP3Xx08f/n67UsEBgWpRdgwGkQDsnArU+ZctlZaqJ29eLe1UiE2pbY3pbY3pbY3pbY3pba/mmLQm1Lbm1Lbm1Lbm1Lbm1Lbm1Lbvx0SNqW2N6W2N6W2N6W2N6W2N6W2N6W2N6W2N6W2N6W2N6W2N6W274+s2JTavi8VjDeltn8PCtyU2t6U2t6U2t6U2t6U2t6U2t6U2r6nFqxNqe1Nqe1Nqe1Nqe1Nqe1Nqe1/qFLbrSyOfpFxIVuJrzbZ73ixAPeHMEgxG3DvOLi8xGXeYa4ONv9cUTbJ8YcwOOdaYKQPJRKGPu8N80bOANOintvApa0jXD+0vE2xugv5k5i4Z0fsE0Ff27edsHj45u1REAa+bGCuEsrU5jPMM+Ezm4TTSkahtssg43JaUSJLYOe8skVt0m6e3xnl+bk/WtkwmNXWQNhNALTbwH9xUysHXF7aHEJKI7P97ae1IxxifW88vw9XV1f/B8WFJRw=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHDdyfwWZSpWszXD2QVKSGUV1tKTYzCkSy6KiupA6GjvTuwNxBhgDM1yuWay6D/cP8ilf76f5l6S6AcxjHyQl0T7qsv4gczF4NBrdjUa/LoOST02wdxy8UHGVgyxN8CEMEjCxFkUplAz2gqMU2HMNvATme7H9wwPGs0zNDKsMaMNKxaYgQWMvCTOW+PnYeM4Krc5FIuSUJbzkbCbKlI25gUc7DGSsEkjYRGQQncgTeSSKPfauyBRP2FxVmh2++Pd6NlwG2457vRcwrqbs3UGv9+GbtCwLs9fv86KIVAHSiKnM+NhEscr7CXYsksnDkM1S0ICzsphLBtyIbM54krCZSKZQmpCVKUgWq2LOYqV0IiQvwYSs4FNgssrHoE3IuExYrjQwIRlnGngy3yrVVmWA/cfbN6/ZROmclxE7zCoT1sslQkNcZnM7fZlCvasHxmPDlFrIachyfobYEiX7uRLxGW7bgEzw/zhw//CAcNXrva2KQukSEvbebmGv18Mv30GmZoxroP6xynMlWcE1z6Gk40p5SZ81/FwJDYk9FJ5lHhd7J3KL9XrlvIC9Xo8dyETEiAyaEFuZmri+ke2KSMKubwuIxUS4ri3UMSXZLBVxSjiZcXueRcZjC6YGU0BcinPoTnwRsjlO/AKk8hCkSotflCx5RsdxDroUMc/ax4YAYldTcl0iOgslZOlb3QrsT+548PToUBxdIWgJIisXkr4YYOc8q8A4qGYhSxGqH6HQYIjU3byISJmwFMQ0XbseTz5WpuxMzCqDYLahcGv5UyL0AqFtwjMDTEw6uMz5GbRWY4p4mGcR+27OEpjwKitDJpDiSl1BxF6rkvGiyETMxxkg5TJkHl5WGrbolB05OEAkz+mMD4mjwTDOEjGZgEbmxI80hRvjoUM6a0QAcU6ZcsmUXDjoWGVKL5MQNXfxyGIlS5BlxPbPucgIeLtZw4SMsyoBNs54fBaycVZByDQklnHngGIrdEIIuzBuHM4JP8xAhlSoJMIvlVteGGYcVEnEjlJhGn7Cjx7VtIgwbaw6rp0oXBlR4FmMQc5FFhLiQvZRjVkpygxCZNiCy3mI8hJCVsJFOVYXIYtTiM/oL80Todi4Kksl7cYSrYpEzaTD5UTJ0ohfVnCk//LpGB2FbCdkj0L2JGTDQciGo5ANd0I2fBSy4ZOQjQYhG41CNtoJ2eiRBWv0xOGa1whuAzAcWSyXXw92Ue6+EoY4GwWmqWXwrCODhxHr9WpuwraffvrpRF6eSMZOAmSuk2CPnQR1l5MgtN9QZuK3oft9gT+2R4/dzzn+fDR64n7OqOtwx/1M8edoeCKv3IInckSQlDwvroECP98pBO6XIyJso0WxzcszbERBFPoPeFYdePDDVXsv27gXIUUpeGbWb8f3uEc7akBa2tQOborIdf2O6PM92k4bHvxCYtJ+IrHa+uQZnqAYLe1+N3I3y/rN22Xvzd5b4HzZ1h/h1lE0HaFoWr//WnrdIyQswvRlmHgckQJAknk9HlyHe4SFLkRfhoMniAO8lNYjAL/eo923wMEP7oa33wY7W8PdrdFgtNPBAL6NbIc830qSrfl8fhfYQ53HLY8qj9dQrWaHr9KJVvmK5we9DppeTieiv73K/p+oqI+9DgsJvvvoYeE1lvrF19ayS5Xw+QNjp/JDa+UM+zeq2bwFJn1COOj1G6dKxA547ONVsjE+8CLEwRZhsp8k/RYmsTFJtvJ8a6ERf24R4luNeR4lSbTQc+l0bGPOkiRky80r25OE5Xm+ptm2d5r7eb68iyjPHWykfH2LTOJ0tvV84jr8XqzScER34WvZCC0HSma0Nj3nVvPRwmWTCuk+OKJiCx00TKuMa7jAd6kRStred89jnsUazZ7esfQEJCuBRQX75o3T3h868sctdCfAlpvHLe0MJ9lncWVKlTMNU7hgBS9L0JImO+eZSDg95baoAS54XuAToP/nk5PkX/65TwYIfOOXDE+CJWIq0A7U//Px/tZ/f1jRoyoK0DE3wDLAlUzIoIwjdpxCVjSmqNlsFs22TZwqlVk71EejYWL/PVXjj6cEbhFxUzxctVNLGq0HP5LO4nvfQNnBGDfMj1zx5CcaIx4aDui2de+da65b1+Me3TgLIOFHaz3Bz8cnQc5JIUFShuZvVaagT4IP9Rj7yIfkhrEfbsGsqUgg42PIlj/dmtHq5ozPVeX42xu1ult1FN3CG37IhaztFrSdQdj6yC8WPtpvVyv42yKkzZ3+yvHs6U+AZcJ4y00Xne3RzrRFBkcJQDbMMTA/AM3DXnp8KRfUgN2ODawkcmd3wxLYj1HH2qzoV7thhc7BtBGDc+RCirzKa/vopJ7Voyx3ukcbXzgSre5+hfbpLq3AL25YAY2R6xc4kUOyY3j7xzWaqetxj2TFAkjXs/HnSJHOPX1HF+zNDOi31WbAFdcydrUXcs18Zj33RewNXm9ok7WD0MoWx1CUaJH7UtasQb71DUU2q7Ydbj3ltXvdI+pbAdZvTIGu313fPp9FpO3df0WE2gH71sRqjZI5n17zcqfP94g8HTxLRohe71DDRGRZy6XIfJP37KBLBzLIndvLORPxqiNDuJClwmeBd9v2emOYKDSCo08TXSkpb5yO9q6xx9r2i7IYvc5Ks5Qbq4OT0o/HhU7bMoXcmeNfqxKsL84UShqwZFisALrxpfV6C7Z8362x5wvpN47HOry7h+fo20H7oIePdjsHvTvoHPRg3UFf8+5EErC48MY6aD61BAPRiG9fvpsW+d5Pish+KdE5458flptUlSUsE2fklkmEKTI+R7LwbO6gXPT3PU+VMk0P53L7xm14r+vKUxq9eQ+j2rPxpRaz4ePt9mnsPrkDM8CCYax7GIOd/nC3f61lbMGe8+lKBWO3OTkyOd3q5Khnc3QbC9bnWrDuhvC37/IBP3w86tw724MvZ4A7eqe3GeeGF/pdvMPv7EHcZrdbPoV/tyfpl1Pfzm+hnC+I4cfDOxDDa3TwL6XEJVX7zmiP3ZWevYoAb6FoX6tdfzGBtoH9zYl0926U8uGgo6t921HVvh21iXJ391ZE2V50gbJOAvFf3735cTb44/dTtb+/v//67bv05bvp/v5+jr+jKFr5Hlt12rQM6rAuuNDdy3THr1kliiJEIUZp7tHwfiGn/2rHh+vHRCcyCANVYPinUPIgCfYC0t3Bq/JBSE8SMOV3KpkHe5eBCzfCP10wDw7tfzQYc3oZmDiFnONfXl/HKFWMEg1CipgBbYIwIP8zhqzikQZ7gRp/hBhXKzSCUwowOAeN27v0vWyYZRA6nSvYC+wWgzBwHoK6qQ5QLZJJcOUXvG6quqWZytAf9bsG58FIxs+cBh87OEUnSvezZnrRmoH2lsOReq7wWwkv+Ny05rUGxGAxOBjHILPHbhRL+Nyg0KiMveBinsVVhnohXBRCz2s3KymHLfqo4a1XquEd7l41h96AxLXm8yAMRAl5u30NEWj16ScXg0LMUKzLp479qGAM8AfXgD4gOniefzIUHxWwMdChF6mSnzx+ONoejobbwxHO4AIWPnUOH1eNU3xU49PPYoQEznG8e2l//lHar8trd2lzHyMCIfF611YT2hoyCi+LbmIT358wz6dwMz8crQt5bkVampQeW7wogOuIIo8/O6i9y2L1BR/dwFBXYXBx82YuWKy2fDw1+yaDSWn9nyxWWoJ+2A6quDebG+3sXIXB/Obtzb/K7T3Gw5vdvLv3FIjeBOn/PWDdfnIVBunNsP5Qh8r/HYHdeXTVXPAL+svpWCXzUy+3rm7q6O8q7DdRWQIadaJledWIGpQwmOJxunjVjJXKgMsVgqYTI+2ScVD/Rmu2s8nMUsBnTKOW0+yNzu9s3xZajLuGhVAOYVBd1hWcBBE7mLReEKTRL4Zp+74UMi0Ve0DrnZqKxPiDvvuNOHrQTkdBy2wTTeVBoM6shLzIKJ9jhsbcMbkmk4jV/5HyWWMSAfA3tl/45qviuQ0hoQXdoG4yBHPqa8Sec1kHxHcDz9nlZU0GRB1XV+zyEk8V9Cne+1dXYdOAa3Ua6Gq3LRpiEOedUXUTNAPrttZQq2WdopZlG9x93wZATKWQ09NKu3lQGb26ijoEuQA42eAdDiCp6UxM5Ypd1yoTnfStsb+EbEcBOMn/G7w/LZ79IFaA8rRfPHtaPHuPqU8FWN6z6JkImVjOn0GWReypKbWS02cLKHjad+2rj1LDuYAZMS6dajPLIm7riSIH059QUDeHJwyLdRULnlHslFYxeFcPnpvER7wpoTDoXxMljbTZKfQk4FMN5FgiWHhVUqoXvQ79gk85SzVM/u3BAk4fPHuLoGOW39M+f+Z6H1izRMrPgXE5Z7RxsqEobe1wk0qTmIwzrsXEPUVDVmSAcV74UuWxdQ9ajHo4jlIuz0z4dKyfHQHP2ZsCJELw61//hj28TD+Qb3QC+hZC/WBiHZGKPUA59iC0MWdE7kKb0olqKwkdhVi41rCOyzlA/+XLWvSbamywl/TzNaK11GI6BXTNuR402GXwAI9Te2kQVHzivQgFEo+qjAcPCcw/CMlPJyx9CDntWn1a2CGvYHvv0SqpLjHl583R4S1wSSapLcso1h5jd2nnYG+ODjFrsD7uiL0zNSY8anmnC0NLADsX3GcW1Zr93MbpgPWrOLnYdmVGLl9viy0DlAizEqLQXuoo4eoc26WJm7RSPCJVlegaFS5Zirisg0eCokbkkapuQ5U3YJKzaUVh0SWyr781KTKyyfoT0pS6sjFKLKm0T3R0ZGHFhDENnjxWsFNr/pCBNHY4ZxNuStAhq6RAzOsKrZT1lHBRgBYgY1iJAg0WdSg6br6iuil073585ZKJ/R48U46RA+3EkLCqIKohTqhTO/3JLW59pT7oxPfNAKLuRgmYztRagDZKoohTesqlk6D2PYr21DGkPLNdnahAlxzCgxwerXz7//rXv7XgWmsUWQbMrsCTBON2b4CQTNOW4DE0TUOBElB1IcL5QP9h8QmA0BHTnOYqqRnJ3J7GDynS19Ry0YUa1KEOpopTvLZqeWtCL2ONMyoYskKTqZpiFQrcL1wIU7aSE30KwbJ8+BEQj3ELBnqEIlcjzct5m8GbEAy1MB09D0Q3sbV+BC3xAq9KdaohF/J291Tb6l+qWhBUpcp5KWLmpzJRN13ZupY9X+fsGw8aUuO5UPrhGlbF6U6VjOFUyFM4B32L5/3rOuSRbJJjKGcAsg2bR5K9zpqU0hlWAejgpHU7UeJ0G0o0Tuagp3Aao4WKqA5ugcReD6fq9diWBcTJVFNp559xqfskPFCONLMjOE4XrrNRmgu3XTEhYj+oGSKsVmdQ6bTzIz4ZQZ6EdorWCjGXmJVLz0R8qeHEtQ8/50I2S9gwGjos2o1TuGLruMFZMDUd1wmv25OXn3WaDcf0cr+6ZQe7OTTnM54p4ienVrrPHaAOKLM4pfuHzg/9THYdn+6vZhL0r3/5X0PRQpjHHoOpn7orv9JrlWdG2bTl9qyenD3BR923qadnF5i0ys7ZJRFfLMBnenjpYRUPKmKRjzE6jqKrSJ2ia8a/6ZcMp7+Z5fU6M6oL+tkYUb8iK+NwMPhHNqJuD74eI+rO4Csyoj5BYJ37+2Zpsk61XSk7vI/7+gEfFVgvV6b09T3Rp0z2WRuEsQrBDTuMrux/jd3XC/EbbMHWWNw4sd1L1m+G0DAaDPB/3eN80YmCxXdNFeM7YVJl2fyfgvD2HvTrz8A2r7ZPXyfV049i9MtFfD46DJx3tvuQ+sSL5bNcrDhm0cG65jl37VYcQ1Q6w0JOuJetWpGgaVtnLGQmJJz6AzxNVHzqd39FqqAx3VvuVjDUx00Glu5Z37B8YAlzZxUVvVU5WA1ohvPO0HBXq4KlnjM+RV0OeVzfIVGB1jex36dBdh0KdgaD02GNhN1lJBxIypujqmVH6gzk77vT9vKlXR5BvcizRgYGwnai70Fns+12u0kDcaVFOQ/2ji+Diy1eiC37fe/4w9UHJMEyVRiEUyhDEPMyDfaC/lJMjgF9TjEVx5eWb2pWMFwmGEm4dD/wQvTPh9EwuAoXx6y8T67pD9XWpw4xJZ8KOb1p3IcGR2/xHO1RdTDVyKlC/BFQULmDaPcKA4H0kwLHdzGiHsnjxyaS6aU/ZB9jtCpsqDnMxUAgHwfUCe1ZvNdXBOusjtUZ7raiZI59wAvFsNQhLKuiUuqt+ziTOsykFTnSChxpYkE6oSAU3dEK7jhueKKOo/AvgCGpzqOdHdIxHw9JGdt+QnrOzqMrouLGcRoEXecoZbQsuvi+zGPVdVhtvDD/QF6YBSeMI57Gk2DDdTsmcdfUNRF7KqxNsh276KJZdK2Jco2F0i25YImrAVllANtdaXdyQ1o2hhUc6dXqLj9iqCvy4/aA+HFnQPz4ZNDR6N3emxkavZyU71r3JgW7rV+jEv0BhaiQE0US2AkOf2J0Q5IEX3qHQRarvC721uu1Drke1evVktUSKtqA3lSaFWoGelLZ6nGTDC4EWvlwGOT0rQmcAJ5nYEyGuS8lTMnyREUh0J3iDPYxL/hYZAJVAJvqZlmm0SJMxN43oRcPtK2RcQ4Zag61nRTroXqtb6b02QRDOELG2RgLQaKlHGTKZWyN8vY6I+My2n3Q4VFoYbC+pUaohYVNyVIjn+Rc8ilxcNjmCJZAhgLNMK3G6LMyKqssH5ZcZErbqE3aEMWHExJfXhT4iR6TeA1oSJGqz51rxoTWNWZvKlchdYxeyAJhEWg0KxWrZKawmCl6M6ssY4UqrYcR36xtGHF4qbk0qDC7QFF3BjXCnNcEjDM/vjOAJ/xKyDNbgG+LHdd09R7GRpTQLc+xyJkPu2O+F+UP1RjLeyojSqXnzeipKNNqTDpHe5L6h53pe18Pt6VRNHMkKjYrXt8qNn2sJNJ/CyVSiOnvHx6QzvqQ/fqX/2GvgGvJUjWz1BpXGrJ5U3qXStPSyVu01Son+eVQjCPGY0t87vbxGHyf8pJsna9hhkZly1I2vvywGmciZkc+FqfX2/M1gZv4nE45AZvgic5Szgo7OhPyLGL7ck7uneYuwnYa19kG3X+tMsIcA4qVdIkAds2ogYgcCgayczAt2zUkwrqgtaqmdrU2MG5z3XxX3Nt+kiylj6LzogHHWlzJ98ut6RUr/q7IOO2kk3YDV0AmVJPW7LFE80nZzB8uJMHSTbjU5PNnPTpCN019JJYT3Y7rVmuVXtCGu/KWrN24YLeyMy+EI6djT5asW/fm08naWmvocm/ZAVAtX+new4q85s3kLehzEfvH+xqO7lPnfhAGmYjBmY7c/bX//eErdr4dDYKw9ca4BXP3Xx08f/n67UsEBgWpRdgwGkQDsnArU+ZctlZaqJ29eLe1UiE2pbY3pbY3pbY3pbY3pba/mmLQm1Lbm1Lbm1Lbm1Lbm1Lbm1Lbvx0SNqW2N6W2N6W2N6W2N6W2N6W2N6W2N6W2N6W2N6W2N6W2N6W274+s2JTavi8VjDeltn8PCtyU2t6U2t6U2t6U2t6U2t6U2t6U2r6nFqxNqe1Nqe1Nqe1Nqe1Nqe1Nqe1/qFLbrSyOfpFxIVuJrzbZ73ixAPeHMEgxG3DvOLi8xGXeYa4ONv9cUTbJ8YcwOOdaYKQPJRKGPu8N80bOANOintvApa0jXD+0vE2xugv5k5i4Z0fsE0Ff27edsHj45u1REAa+bGCuEsrU5jPMM+Ezm4TTSkahtssg43JaUSJLYOe8skVt0m6e3xnl+bk/WtkwmNXWQNhNALTbwH9xUysHXF7aHEJKI7P97ae1IxxifW88vw9XV1f/B8WFJRw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

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

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.9876c768.js b/assets/js/851f8f65.9876c768.js new file mode 100644 index 000000000..8bef889c7 --- /dev/null +++ b/assets/js/851f8f65.9876c768.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>r,toc:()=>f});const r=JSON.parse('{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kt2AhZPcXqQ5Qsc7WKoSWvrR2PxJCodcySGg66KrsbYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6IOkJNoje9sPMhuFI5HITOSJq8jyqYkOTqLnKq0KkNZE7+IoA5NqUVqhZHQQHc+APdd8YlnoxA6PXjCe52puWGVAG2YVm4IEzS0wCXOWhenYeMFKrS5EJuSUZdxyNhd2xjgbcwOP9hnIVGWQsYnIITmVp/JYlAfsbZkrnrGFqjQ7ev4f9Xy4ELad9HrPYVxN2dsXvd67L2bWluag3+dlmagSpBFTmfOxSVJV9DPsWGaT+zGbz0ADzspSLhlwI/IF41nG5iKbgjUxszOQLFXlgqVK6UxIbsHErORTYLIqxqBNzLjMWKE0MCEZZxp4ttizaq8ywP7zzauXbKJ0wW3CjvLKxPVymdCQ2nzhprczqHd1zwRsGKuFnMas4OeIL2HZj5VIz3HbBmSG/8eBh0cvCFe93puqLJW2kLEf3BYOej388jXkas64BuqfqqJQkpVc8wIsHdiMW/qs4cdKaMj8seR5wMXBqdxjvZ7kBRz0euytFD9WwEQG0oqJAI27ZHYmjB+QuP52UVL/FzITKSKPAMBWpibdrohU7PqmhBSndF1bqGZKsvlMpDPC4Zy78y9znrptaTAlpFZcQHfiy5gtcOLnIFWAYKa0+KuSlud0fBegrUh53j5mBBC7Gsu1RfSXSkgbWv0K7E/+OPG06RA9HSJoGSK3EJK+GGAXPK/AeKjmMZshVK+h1GCIOfy8iHiZsRmI6Wzrejx7XxnbmZhVBsFsQ+HXCqdK6AVC24TnBpiYdHBZ8HNorcYUMT3PE/b1gmUw4VVuYyaQQq2uIGEvlWW8LHOR8nEORAPIbNxWGvbolD35JF3yOSIZAIZxlonJBDQyM36kKfyYAB3SZSM0iNPsjEum5MpBpypXep2EqLmLR5YqaUHahB1ecJET8G6zhgmZ5lUGbJzz9Dxm47yCmGnIHKMvAAVd7PiDujBuPM4JP8xAjlSoJMIvlV9eGGY8VFnCjpFRav7DjwHVtIgwbax6Lp8oXBlREFiSQcFFHhPiYvZejZkVNocYGbzkchGjhIWYWbi0Y3UZs3QG6Tn9pXkmFBtX1irpNpZpVWZqLj0uJ0paI/66gSPDlw/H6Chm+zF7FLPHMRsOYjYcxWy4H7Pho5gNH8dsNIjZaBSz0X7MRo8cWKPHcbgiAoLbAAxHDsv214NdlNPfC0OcjQLW1DJ73pHZw4T1ejU3Ydtf/vKXU3l1Khk7jZC5TqMDdhrVXU6j2H1DmYnfhv73Jf54MPrS/1zgz0ejx/7nnLoO9/3PGf4cDU/l0i94KkcEieVFeQ0U+PlOIfC/PBFhGy2KbUGeYSMKojh8wLPqwIMflu29PMC9CCms4LnZvp3Q4zPaUQPS2qb2cVNErtt3RJ8/o+204cEvJCbdJxKrrU+B4QmK0druHyb+Ztm+ebfsZ7P3FjiftvVHuHUUTccomrbvv5ZenxESVmH6NEx8mZACQJJ5Ox58h88IC12IPg0HjxEHeCltRwB+/Yx23wIHP/gb3n0b7O8NH+6NBqP9DgbQlnIdimIvy/YWi8VdYA91Hr88qjxBQ3WaHdqxE62KDeYHWQdNL68T0d9BZf8jKurjoMNChnYiGRZBY6ktxLaWbVXGF/eMmyoMrZUz7N+oZosWmPQJ4SBrOZ0pkXrgsU9QycZoECaIgz3CZD/L+i1MYmOW7RXF3koj/twjxLcaiyLJsmSl59rpuMaCZVnM1ps3tmcZK4piS7Nr7zT3i2J9F0lReNhI+foKmcTrbNv5xHf4pVil4YjuwteyEXoalMxpbTLnNvPRymUzE9J/8ETFVjpomFY513CJdqkRSrred89jgcUazZ7sWO9JgKBYsy9eee39vid/3EJ3Amy5edzaznCSQ5ZWxqqCaZjCJSu5taAlTXbBc5FxMuX2qAEueVGiCdD/8+lp9rt/7ZMDAm18y/AkWCamAv1G/T+fHO7997sNPaqyBJ1yAywHXMnEDGyasJMZ5GXjuprP58n8gUlnSuXOb/XeaJi4f8/U+P0ZgVsm3JT3N+3UkUbL4EfSWbX3DdgOxrhhYeQGk59ojHhoOKDb1ts711y3vsdndOOsgIQfnfcEP5+cRgUnhQRJGZq/lZ2BPo3e1WOckQ/ZDWPf3YJZZyKDnI8hX/90a0arm3O+UJXn7+DU6m7VU3QLb/ihELL2W9B2BnHrI79c+ei+LTfwt0NImzvDlRPYM5wAy4UJnpsuOtujvWuLHJQSgHyeY2BhADqUg/T4VC6oAbsdGzhJ5M/uhiWwH6OOtVsxrHbDCp2DaSMG5yiEFEVV1P7RST1rQFnhdY82vnAk+unDCu3TXVuBX96wAjojty9wKofkxwj+j2s0U9/jM5IVKyBdz8YfI0U69/QdXbA3M2DYVpsBN1zL2NVdyDXzme3cl7BXeL2hT9YNQi9bmkJp0SP3qaxZg3zrG4p8Vs4P9zX54bZTXttb9xlR3wawfmYK9P3u+vb5KCJt7/5XRKgdsG9NrM4pWfDpNZY7ff6MyNPDs+aEGJIz0t0X1zjk6Pv12xkOOtt52N3Oo8FHWFedZT/duBrUjY1V9Y3EmMPaQmiXVzkPov4uJL2fEinzmSrKyrZZgSx+Yvdwd4eomosS/i5mezHrxawfsy9idj9hr4HicGkds/NXudAuMicky1SFIZO00vmCjTVPMRgOyTRhV1c/VlxaYRfLJeuxqyuM/S+XCfLGuVRzF7Y7uRBGWIZh98bUyVRqNoTpVWr6aBP1X8J8L6Qa9D1o99kXaoVRrzUsPQo+1JLcNuxnNq8wQnSkYSLyvBXHZ6EpHA/GRSGHwseOfQQf9UWKJglpFaIg5Er0emOYKIwkYSIBxiNnvIn0O4XNycZ2MgJLNXCrNJtx4wxZspxxe5gpYWdQ+JjWS2XBBbRNqaQBJ8vLDUA3AelebyUgFro1QTEhw8ZRmgzvznsz+mrQFi/DRw870vJhV74MtsmXa5w3KEUcLoLHG5pPLc4n+RPa19l+le/DpIhsJ20CkTnqU1WesVycU2wzE6bM+QLJItyVHsrVoPmzmVKm6eHj1p7PzEE3Hq40hsTvJ3V48FPdzsMvH3SE/eM78KWteJe7hzHY7w8f9q91L684RT9cXjN2m5Mjv+2tTo56Nke3cwN/rBv4bgj/wV16wYZfjjrK24PBpzPAHTm72oxzg5vrLpxZd+ZVarPbLf1Jv5hf59Opb7+xcMd3ZuGuiOEvh3cghrcYsp9KiWv26p3RHrsrY3UTAd7CWr3WRP1kAm0D+7MT6cO7sWyHg46u9lVHVftq1CbKhw9vRZTtRVco6zQS//X1q9fzwR++narDw8PDl2/ezr55Oz08PCzwd5IkG50am06blkEd1mf0+nuZ7vgtqyRJgijE5OgDGt4v5fTf3Ph4+5jkVEZxpErMuhZKvsiigyjDPO2gyUcxWbtg7NcqW0QHV5FP2cM/fUIcjuy/N5jofRWZdAYFx7+Cuo6p4ZiZHcURZW5gdjieY3QQqfF7SHGNUiMMVoDBkdT74Cr0cgnNUewVreggcvuK4sjH1uqmOhW8zCbRMix43VR1SzOVoT9qYwbnwRzgj5wGLRycopMQ/1EzPW/NQHsr4FihEZ+Dhed8YVrzOiM0Ws3DxzHI4akfxTK+MCgpKuNutZTnaZWjMgiXpdCLOkGBNMIWVdTw1ivV8A4fLmNKMATdBolrzRdRHAkLRbt9CxFo9eEnl4JCzFCW2IeOfa9gDPB734DuBDp4XnwwFO8VsDHQoZczJT94/HD0YDgaPhiOcAaf6vOhcwTXCE7xXo3PPooRMrjA8d68/vijdF/X1+7S5iHm0kIWlK29Jik8ZpSYmdzEJqE/YZ5P4WZ+ON5WLNDKUTYzsrB4WQLXCeXsf3T5SJfF6ls9uYGhlnF0efNmLlmq9kIlAvsih4l1mQMsVVqCvt9OR/psNjfa31/G0eLm7S1+ldv7Eg9vfvPufqASjqa85Z8B64PHyzia3Qzrd3WRyT8R2P1Hy+aCj8jhCOF+OhurbHEW5Nbypo7hrsJ+E5VnoFERWpdXjahBCYPFVGerV81YqRy43CBoOtUFvvANlW50+XpHzHwG5HuvdXGavVH0vYPYQYsVC7CSBCUM6si6gtMoYS8mLbOB1PjVAofQl4oNpGL3aL0zU5EYv9f3vxFH99qFX+iObfIQAwjUmVkoypwqoebowR1TUD9LWP0faZw1JhGAcGOHhW++Kp655Cta0A/qlhExr7Qm7BmXdSlJt2SDXV3VZEDUsVyyqys8VdBneO8vl3HTgGt1Guhqdy0aUhAXnVF1EzQD67bWUKdlnWUU+MAGf9+3ARBTKeT0rNJ+HlRGl8ukQ5ArgJPj3eMAsprOxFRu2HWtMtFJ3xr7a8j2FICT/L/B+5Py6XdiAyhP+uXTJ+XTH7BosATHew49EyEzx/lzyPOEPTFWKzl9uoKCJ33fvvkoNVwImBPj0qk2s6zitp4o8TD9CQV1c3jCsFRXqeA5ZR1qlUKI71A0Cy13Y6E0GIkSlka6ui4yCfhUA0WTCBZeWSqSJJswLPiEs5mGyb/fW8HpvadvEHQM7D3p86e+9wvni5jxC2BcLhhtnBwnSjvn26TSJCbTnGsx8QZozMocMEMS7VOeuhiaw2iA43jG5bmJn4z102PgBXtVgkQIfvr7P7BHkOkv5Cudgb6FUH8xcdE6xe6hHLsXu2xNInehjfWi2klCTyEOri2s46t1MNL3TS36TTU22EuG+RrRarWYTgHjcb4HDfa1b8DTmbs0CCo+CaGDEolHVSaAhwQWDMLMB2/9QXVdPS3sUCiwvfdkk1SXWCz36vjoFrgkP9SeYxTnhHG7dHOwV8dHWG9bH3fC3poaEwG1vNOFoSeAXQgeavJqzX7hMtzABVO8XGzHLxNf6brH1gHKhNkIUewudZRwdT372sRNATcekaosxkOFLzMkLuvgkaCoEXmsqttQ5Q2Y5GxaUUGBRfYNtyblFDf1skIaqyuX3ceySocSYU8WTkwY0+ApYAU7teaPGUjjhnM24caCjlklBWJeV+iarKeEyxK0wFSCjSjQ4FCHouPmK6pbfPr29fe+bD/sITDlGDnQTQwZq0qiGuKEuig6nNzq1jfqg1583wwg6m6UIOH9qyVooySKOKWnXHoJ6uxRdKKOYcZz19WLCozDITzI4clG2/+nv/+jBddWp8g6YG4FnmWY8X4DhOSPdgSPSZ0aSpSAqgsRzgf696smAEJHTHNWqKxmJHN7Gj+iHHlTy0WfX1DnN5gqneG1VctbEwcZa7xTwZDrmfzTlKBQ4n7hUhjbKusNxTfr8uE1IB7TFgxkhCJXI83LRZvBm7wLtTIdmQeiWxJeG0FrvMArq840FELe7p5qu/qtqgVBZVXBrUhZmMok3UJ/F08OfF2wLwJoSI0XQun7W1gVpztTMoUzIc/gAvQtzPuXdbIw+STHYOcAsg1bQJK7zppi7Dm+t9HBSet2oicHOsT4MEa6K0BP4SxFJxURHtwCj70eztbrsT0HixerptI+LuPfySD5gaKkmR0h8upwXcrV3Lnt50kS9p2aI85qjQb1Tjc/opQR5FnspmitkHKJJe1kKaKxhhPXsfuCUyaWX8Klz9B50W68zpW6gA3Ogu864DrxdXsKIrSuUeP4NkNY3XGE2xx69BnPFbGU1yz95w5QL6gsf0ZXEB0hxpfcOuGtDDWXoH/62/8ayhJyyWemtnY3fiWDledGuZr/9qyBogPNJ13zNJC0T0ja5Orskkh4aSOUSQUB4nQPejGmGGNqKWVVkUZFN00w69d8pz+b8/U6T6pP9tn5UX9FjsbhYPBb9qM+GPx6/Kj7g1+RH/UxAuvD3jdLk23a7UbZEWLb1w94r8AFunKlr++JwWRy0brki00IbthhtHT/Na7fIMTbbZ1gt/N/0ZgmeO1t2bAXwsJoMMD/dU/zeSf5FS2bKkVLYVLl+eJfovj2kfPrj6CGVmx0Ul8n12fvxeivl+nF6AjxuMWSunYCT4iVzvG1Mry+9uoLnDT6Fm6FzIWEM0LxWabSMw3mbDQYnA0jdzD7m9D4RhXgNIA5InOOvqtaFbJ6wfgUdRmkcX2HWAWtbyK/D4NsAyYCDZ3td5DwcB0JLyQVXdIjecfqHOQvu9P28tYtj6BeFnkjAyLhOtH3qLPZdrvbpIG00sIuooOTq+hyj5diz30/OHm3fIfauJ0pTD4plSGIuZ1FB1F/NRfFgL6grIKTNbKZc3SFfVeNCerDyir2R5Weu60RqdfUeyG0dTMlxg2bVWOSpUeaI7u+5BfnXPdR1PaHySAZRMv4amUSw2WGGXtr8piXon8xTIYbxmyU39f0h2rvQ4cYy6dCTm8a9645kzdIN440OifTKJyl+AOgxukPvt0rjgRifwYcTVE8aiTH103K0DeBqEJaz6ZMnYZ4VnNvQupNJ5tm9R7dkB+zOT1m+LCVmHISckwobaTOGtmUCFJvPaR21JkdrWSNVq5Gk37Ryb6ghIpWPsVJw4N16kLQuIekqo7290mn+3JIys+Dx6RX7D9aEtc0scoo6sYjqSppNar2aUGiboxoF/j4DQU+VuIennga571Li+14oX1T1ysbqLD2gnZckaueyK1ewS1OQb/kivOrBmSTzwl9PRtdPX5Uy6zfwJRBk+2yJGaVIks+GBBL7g+IJR8POkq0334zQ6MKk75bq7uk07ZVWtRb36EcFXKiSAh72REOja43EuJrpg/kqSrqxwl7vdY516N6vVq4OlpFt8urSrNSzUFPKvfa4SSHS4G+NRwGBX1r0hWAFzkYk2OZiYUpOXvoERMMYng3ecpLPha5QK3DVZU5rmkUF5OwH5qEh3vald5dQI7KSu2dxBd/g2I9V/p8gokTMb79iyWJ6J8GOeMyda5wd6ORSxddLRhmKLUw+B6rRqiFg01Jq5FVCi75lJg4bjMFyyBHmWaYVmOMFBmVV44VLRe50i5XkjZEqdiExG8uS/xE9hveBBpmSNgXPiBiYheQcpeVfwF4jLG/EmER6KeyilUyV/hYL8YQqzxnpbIurodmYhtGHG41lwb1dZ+e6c+gRpiPVYDxHr+3BvCEvxfy3D0YucdOarr6AcZGWOg+J7PKnPe7Y74VFjWu11AqI6zSi2b0VNigVbUnqX+4mb4NLz63lIrbV3m+AYsUYvqHRy9ITb7Pfvrb/7DvgWvJZmruqDWtNOSL5nFpenqZTt6hrdZyKRqGkhwxnjri8xdQwOAPM27JvfgS5ujHdSzlUrmPqnEuUnYcMmB6vQP2jGzBVlZM5/kLV0uJIUrOSjc6F/I8YYdyQUGV5jrCdhrX2QZdga2Hsjmm8Srpc+7dmkkDEbnxDeQXYFruYsiEC/xqVU3dam1g/Oa6paW4t8MsW6vUxJBBA45zclLElTtvJ75ovaG4s1O52U0XAZnRG8rmgJE10Mwfr9Sb0mW41hRKVQM6Yj9NfSSOE/2O61bnCF5RiLvylhzMuGD37XJeCk9OJ4EsWfedpg8na+cgofudTDh/g/JSbAyq4QvS5tXkDegLkQa7fQtH96lzP4qjXKTgvTX+/jr89uh7dvEgGXRMqFswd//7F8++efnmGwQGBalDWDClyMoruGyt1H0cfvVqa1Ud7J6S3z0lv3tKfveU/O4p+d1T8run5HdPye+ekv/F3m7aPSW/e0p+95T8FkzsnpLfPSX/qQ+W7J6S/82/IbR7Sn73lPzuKfndU/K7p+R3T8nvnpLfPSW/e0r+V/FC9+4p+V+CAndPye+ekt89Jb97Sn73lPzuKfndU/K7p+R3T8nvnpL/bbqBd0/J756S3z0lv3tKfveU/O4p+d/UU/Kt0ql+mXMhW4Xmrqj3ZOWB+XdxNMOi34OT6OoKV3mLJXLY/GNFRVwn7+LogmuB2XJULxyHclOs1ToHrPN65pL/9o5x+dixNuXHr5RJY72sG3FI9Hxt33Zd8tGrN8dRHIUHMguV0YMEfI61XXzuat9aBWDUdhXlXE4rKh6L3JxL93zTrFtee07ltf6PVgUaFpM2EHbrbt028F/c1MYBV1eudJeqN11/92nrCI/Y0BuP791yufw/Y3guAw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var i=t(74848),s=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kt2AhZPcXqQ5Qsc7WKoSWvrR2PxJCodcySGg66KrsbYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6IOkJNoje9sPMhuFI5HITOSJq8jyqYkOTqLnKq0KkNZE7+IoA5NqUVqhZHQQHc+APdd8YlnoxA6PXjCe52puWGVAG2YVm4IEzS0wCXOWhenYeMFKrS5EJuSUZdxyNhd2xjgbcwOP9hnIVGWQsYnIITmVp/JYlAfsbZkrnrGFqjQ7ev4f9Xy4ELad9HrPYVxN2dsXvd67L2bWluag3+dlmagSpBFTmfOxSVJV9DPsWGaT+zGbz0ADzspSLhlwI/IF41nG5iKbgjUxszOQLFXlgqVK6UxIbsHErORTYLIqxqBNzLjMWKE0MCEZZxp4ttizaq8ywP7zzauXbKJ0wW3CjvLKxPVymdCQ2nzhprczqHd1zwRsGKuFnMas4OeIL2HZj5VIz3HbBmSG/8eBh0cvCFe93puqLJW2kLEf3BYOej388jXkas64BuqfqqJQkpVc8wIsHdiMW/qs4cdKaMj8seR5wMXBqdxjvZ7kBRz0euytFD9WwEQG0oqJAI27ZHYmjB+QuP52UVL/FzITKSKPAMBWpibdrohU7PqmhBSndF1bqGZKsvlMpDPC4Zy78y9znrptaTAlpFZcQHfiy5gtcOLnIFWAYKa0+KuSlud0fBegrUh53j5mBBC7Gsu1RfSXSkgbWv0K7E/+OPG06RA9HSJoGSK3EJK+GGAXPK/AeKjmMZshVK+h1GCIOfy8iHiZsRmI6Wzrejx7XxnbmZhVBsFsQ+HXCqdK6AVC24TnBpiYdHBZ8HNorcYUMT3PE/b1gmUw4VVuYyaQQq2uIGEvlWW8LHOR8nEORAPIbNxWGvbolD35JF3yOSIZAIZxlonJBDQyM36kKfyYAB3SZSM0iNPsjEum5MpBpypXep2EqLmLR5YqaUHahB1ecJET8G6zhgmZ5lUGbJzz9Dxm47yCmGnIHKMvAAVd7PiDujBuPM4JP8xAjlSoJMIvlV9eGGY8VFnCjpFRav7DjwHVtIgwbax6Lp8oXBlREFiSQcFFHhPiYvZejZkVNocYGbzkchGjhIWYWbi0Y3UZs3QG6Tn9pXkmFBtX1irpNpZpVWZqLj0uJ0paI/66gSPDlw/H6Chm+zF7FLPHMRsOYjYcxWy4H7Pho5gNH8dsNIjZaBSz0X7MRo8cWKPHcbgiAoLbAAxHDsv214NdlNPfC0OcjQLW1DJ73pHZw4T1ejU3Ydtf/vKXU3l1Khk7jZC5TqMDdhrVXU6j2H1DmYnfhv73Jf54MPrS/1zgz0ejx/7nnLoO9/3PGf4cDU/l0i94KkcEieVFeQ0U+PlOIfC/PBFhGy2KbUGeYSMKojh8wLPqwIMflu29PMC9CCms4LnZvp3Q4zPaUQPS2qb2cVNErtt3RJ8/o+204cEvJCbdJxKrrU+B4QmK0druHyb+Ztm+ebfsZ7P3FjiftvVHuHUUTccomrbvv5ZenxESVmH6NEx8mZACQJJ5Ox58h88IC12IPg0HjxEHeCltRwB+/Yx23wIHP/gb3n0b7O8NH+6NBqP9DgbQlnIdimIvy/YWi8VdYA91Hr88qjxBQ3WaHdqxE62KDeYHWQdNL68T0d9BZf8jKurjoMNChnYiGRZBY6ktxLaWbVXGF/eMmyoMrZUz7N+oZosWmPQJ4SBrOZ0pkXrgsU9QycZoECaIgz3CZD/L+i1MYmOW7RXF3koj/twjxLcaiyLJsmSl59rpuMaCZVnM1ps3tmcZK4piS7Nr7zT3i2J9F0lReNhI+foKmcTrbNv5xHf4pVil4YjuwteyEXoalMxpbTLnNvPRymUzE9J/8ETFVjpomFY513CJdqkRSrred89jgcUazZ7sWO9JgKBYsy9eee39vid/3EJ3Amy5edzaznCSQ5ZWxqqCaZjCJSu5taAlTXbBc5FxMuX2qAEueVGiCdD/8+lp9rt/7ZMDAm18y/AkWCamAv1G/T+fHO7997sNPaqyBJ1yAywHXMnEDGyasJMZ5GXjuprP58n8gUlnSuXOb/XeaJi4f8/U+P0ZgVsm3JT3N+3UkUbL4EfSWbX3DdgOxrhhYeQGk59ojHhoOKDb1ts711y3vsdndOOsgIQfnfcEP5+cRgUnhQRJGZq/lZ2BPo3e1WOckQ/ZDWPf3YJZZyKDnI8hX/90a0arm3O+UJXn7+DU6m7VU3QLb/ihELL2W9B2BnHrI79c+ei+LTfwt0NImzvDlRPYM5wAy4UJnpsuOtujvWuLHJQSgHyeY2BhADqUg/T4VC6oAbsdGzhJ5M/uhiWwH6OOtVsxrHbDCp2DaSMG5yiEFEVV1P7RST1rQFnhdY82vnAk+unDCu3TXVuBX96wAjojty9wKofkxwj+j2s0U9/jM5IVKyBdz8YfI0U69/QdXbA3M2DYVpsBN1zL2NVdyDXzme3cl7BXeL2hT9YNQi9bmkJp0SP3qaxZg3zrG4p8Vs4P9zX54bZTXttb9xlR3wawfmYK9P3u+vb5KCJt7/5XRKgdsG9NrM4pWfDpNZY7ff6MyNPDs+aEGJIz0t0X1zjk6Pv12xkOOtt52N3Oo8FHWFedZT/duBrUjY1V9Y3EmMPaQmiXVzkPov4uJL2fEinzmSrKyrZZgSx+Yvdwd4eomosS/i5mezHrxawfsy9idj9hr4HicGkds/NXudAuMicky1SFIZO00vmCjTVPMRgOyTRhV1c/VlxaYRfLJeuxqyuM/S+XCfLGuVRzF7Y7uRBGWIZh98bUyVRqNoTpVWr6aBP1X8J8L6Qa9D1o99kXaoVRrzUsPQo+1JLcNuxnNq8wQnSkYSLyvBXHZ6EpHA/GRSGHwseOfQQf9UWKJglpFaIg5Er0emOYKIwkYSIBxiNnvIn0O4XNycZ2MgJLNXCrNJtx4wxZspxxe5gpYWdQ+JjWS2XBBbRNqaQBJ8vLDUA3AelebyUgFro1QTEhw8ZRmgzvznsz+mrQFi/DRw870vJhV74MtsmXa5w3KEUcLoLHG5pPLc4n+RPa19l+le/DpIhsJ20CkTnqU1WesVycU2wzE6bM+QLJItyVHsrVoPmzmVKm6eHj1p7PzEE3Hq40hsTvJ3V48FPdzsMvH3SE/eM78KWteJe7hzHY7w8f9q91L684RT9cXjN2m5Mjv+2tTo56Nke3cwN/rBv4bgj/wV16wYZfjjrK24PBpzPAHTm72oxzg5vrLpxZd+ZVarPbLf1Jv5hf59Opb7+xcMd3ZuGuiOEvh3cghrcYsp9KiWv26p3RHrsrY3UTAd7CWr3WRP1kAm0D+7MT6cO7sWyHg46u9lVHVftq1CbKhw9vRZTtRVco6zQS//X1q9fzwR++narDw8PDl2/ezr55Oz08PCzwd5IkG50am06blkEd1mf0+nuZ7vgtqyRJgijE5OgDGt4v5fTf3Ph4+5jkVEZxpErMuhZKvsiigyjDPO2gyUcxWbtg7NcqW0QHV5FP2cM/fUIcjuy/N5jofRWZdAYFx7+Cuo6p4ZiZHcURZW5gdjieY3QQqfF7SHGNUiMMVoDBkdT74Cr0cgnNUewVreggcvuK4sjH1uqmOhW8zCbRMix43VR1SzOVoT9qYwbnwRzgj5wGLRycopMQ/1EzPW/NQHsr4FihEZ+Dhed8YVrzOiM0Ws3DxzHI4akfxTK+MCgpKuNutZTnaZWjMgiXpdCLOkGBNMIWVdTw1ivV8A4fLmNKMATdBolrzRdRHAkLRbt9CxFo9eEnl4JCzFCW2IeOfa9gDPB734DuBDp4XnwwFO8VsDHQoZczJT94/HD0YDgaPhiOcAaf6vOhcwTXCE7xXo3PPooRMrjA8d68/vijdF/X1+7S5iHm0kIWlK29Jik8ZpSYmdzEJqE/YZ5P4WZ+ON5WLNDKUTYzsrB4WQLXCeXsf3T5SJfF6ls9uYGhlnF0efNmLlmq9kIlAvsih4l1mQMsVVqCvt9OR/psNjfa31/G0eLm7S1+ldv7Eg9vfvPufqASjqa85Z8B64PHyzia3Qzrd3WRyT8R2P1Hy+aCj8jhCOF+OhurbHEW5Nbypo7hrsJ+E5VnoFERWpdXjahBCYPFVGerV81YqRy43CBoOtUFvvANlW50+XpHzHwG5HuvdXGavVH0vYPYQYsVC7CSBCUM6si6gtMoYS8mLbOB1PjVAofQl4oNpGL3aL0zU5EYv9f3vxFH99qFX+iObfIQAwjUmVkoypwqoebowR1TUD9LWP0faZw1JhGAcGOHhW++Kp655Cta0A/qlhExr7Qm7BmXdSlJt2SDXV3VZEDUsVyyqys8VdBneO8vl3HTgGt1Guhqdy0aUhAXnVF1EzQD67bWUKdlnWUU+MAGf9+3ARBTKeT0rNJ+HlRGl8ukQ5ArgJPj3eMAsprOxFRu2HWtMtFJ3xr7a8j2FICT/L/B+5Py6XdiAyhP+uXTJ+XTH7BosATHew49EyEzx/lzyPOEPTFWKzl9uoKCJ33fvvkoNVwImBPj0qk2s6zitp4o8TD9CQV1c3jCsFRXqeA5ZR1qlUKI71A0Cy13Y6E0GIkSlka6ui4yCfhUA0WTCBZeWSqSJJswLPiEs5mGyb/fW8HpvadvEHQM7D3p86e+9wvni5jxC2BcLhhtnBwnSjvn26TSJCbTnGsx8QZozMocMEMS7VOeuhiaw2iA43jG5bmJn4z102PgBXtVgkQIfvr7P7BHkOkv5Cudgb6FUH8xcdE6xe6hHLsXu2xNInehjfWi2klCTyEOri2s46t1MNL3TS36TTU22EuG+RrRarWYTgHjcb4HDfa1b8DTmbs0CCo+CaGDEolHVSaAhwQWDMLMB2/9QXVdPS3sUCiwvfdkk1SXWCz36vjoFrgkP9SeYxTnhHG7dHOwV8dHWG9bH3fC3poaEwG1vNOFoSeAXQgeavJqzX7hMtzABVO8XGzHLxNf6brH1gHKhNkIUewudZRwdT372sRNATcekaosxkOFLzMkLuvgkaCoEXmsqttQ5Q2Y5GxaUUGBRfYNtyblFDf1skIaqyuX3ceySocSYU8WTkwY0+ApYAU7teaPGUjjhnM24caCjlklBWJeV+iarKeEyxK0wFSCjSjQ4FCHouPmK6pbfPr29fe+bD/sITDlGDnQTQwZq0qiGuKEuig6nNzq1jfqg1583wwg6m6UIOH9qyVooySKOKWnXHoJ6uxRdKKOYcZz19WLCozDITzI4clG2/+nv/+jBddWp8g6YG4FnmWY8X4DhOSPdgSPSZ0aSpSAqgsRzgf696smAEJHTHNWqKxmJHN7Gj+iHHlTy0WfX1DnN5gqneG1VctbEwcZa7xTwZDrmfzTlKBQ4n7hUhjbKusNxTfr8uE1IB7TFgxkhCJXI83LRZvBm7wLtTIdmQeiWxJeG0FrvMArq840FELe7p5qu/qtqgVBZVXBrUhZmMok3UJ/F08OfF2wLwJoSI0XQun7W1gVpztTMoUzIc/gAvQtzPuXdbIw+STHYOcAsg1bQJK7zppi7Dm+t9HBSet2oicHOsT4MEa6K0BP4SxFJxURHtwCj70eztbrsT0HixerptI+LuPfySD5gaKkmR0h8upwXcrV3Lnt50kS9p2aI85qjQb1Tjc/opQR5FnspmitkHKJJe1kKaKxhhPXsfuCUyaWX8Klz9B50W68zpW6gA3Ogu864DrxdXsKIrSuUeP4NkNY3XGE2xx69BnPFbGU1yz95w5QL6gsf0ZXEB0hxpfcOuGtDDWXoH/62/8ayhJyyWemtnY3fiWDledGuZr/9qyBogPNJ13zNJC0T0ja5Orskkh4aSOUSQUB4nQPejGmGGNqKWVVkUZFN00w69d8pz+b8/U6T6pP9tn5UX9FjsbhYPBb9qM+GPx6/Kj7g1+RH/UxAuvD3jdLk23a7UbZEWLb1w94r8AFunKlr++JwWRy0brki00IbthhtHT/Na7fIMTbbZ1gt/N/0ZgmeO1t2bAXwsJoMMD/dU/zeSf5FS2bKkVLYVLl+eJfovj2kfPrj6CGVmx0Ul8n12fvxeivl+nF6AjxuMWSunYCT4iVzvG1Mry+9uoLnDT6Fm6FzIWEM0LxWabSMw3mbDQYnA0jdzD7m9D4RhXgNIA5InOOvqtaFbJ6wfgUdRmkcX2HWAWtbyK/D4NsAyYCDZ3td5DwcB0JLyQVXdIjecfqHOQvu9P28tYtj6BeFnkjAyLhOtH3qLPZdrvbpIG00sIuooOTq+hyj5diz30/OHm3fIfauJ0pTD4plSGIuZ1FB1F/NRfFgL6grIKTNbKZc3SFfVeNCerDyir2R5Weu60RqdfUeyG0dTMlxg2bVWOSpUeaI7u+5BfnXPdR1PaHySAZRMv4amUSw2WGGXtr8piXon8xTIYbxmyU39f0h2rvQ4cYy6dCTm8a9645kzdIN440OifTKJyl+AOgxukPvt0rjgRifwYcTVE8aiTH103K0DeBqEJaz6ZMnYZ4VnNvQupNJ5tm9R7dkB+zOT1m+LCVmHISckwobaTOGtmUCFJvPaR21JkdrWSNVq5Gk37Ryb6ghIpWPsVJw4N16kLQuIekqo7290mn+3JIys+Dx6RX7D9aEtc0scoo6sYjqSppNar2aUGiboxoF/j4DQU+VuIennga571Li+14oX1T1ysbqLD2gnZckaueyK1ewS1OQb/kivOrBmSTzwl9PRtdPX5Uy6zfwJRBk+2yJGaVIks+GBBL7g+IJR8POkq0334zQ6MKk75bq7uk07ZVWtRb36EcFXKiSAh72REOja43EuJrpg/kqSrqxwl7vdY516N6vVq4OlpFt8urSrNSzUFPKvfa4SSHS4G+NRwGBX1r0hWAFzkYk2OZiYUpOXvoERMMYng3ecpLPha5QK3DVZU5rmkUF5OwH5qEh3vald5dQI7KSu2dxBd/g2I9V/p8gokTMb79iyWJ6J8GOeMyda5wd6ORSxddLRhmKLUw+B6rRqiFg01Jq5FVCi75lJg4bjMFyyBHmWaYVmOMFBmVV44VLRe50i5XkjZEqdiExG8uS/xE9hveBBpmSNgXPiBiYheQcpeVfwF4jLG/EmER6KeyilUyV/hYL8YQqzxnpbIurodmYhtGHG41lwb1dZ+e6c+gRpiPVYDxHr+3BvCEvxfy3D0YucdOarr6AcZGWOg+J7PKnPe7Y74VFjWu11AqI6zSi2b0VNigVbUnqX+4mb4NLz63lIrbV3m+AYsUYvqHRy9ITb7Pfvrb/7DvgWvJZmruqDWtNOSL5nFpenqZTt6hrdZyKRqGkhwxnjri8xdQwOAPM27JvfgS5ujHdSzlUrmPqnEuUnYcMmB6vQP2jGzBVlZM5/kLV0uJIUrOSjc6F/I8YYdyQUGV5jrCdhrX2QZdga2Hsjmm8Srpc+7dmkkDEbnxDeQXYFruYsiEC/xqVU3dam1g/Oa6paW4t8MsW6vUxJBBA45zclLElTtvJ75ovaG4s1O52U0XAZnRG8rmgJE10Mwfr9Sb0mW41hRKVQM6Yj9NfSSOE/2O61bnCF5RiLvylhzMuGD37XJeCk9OJ4EsWfedpg8na+cgofudTDh/g/JSbAyq4QvS5tXkDegLkQa7fQtH96lzP4qjXKTgvTX+/jr89uh7dvEgGXRMqFswd//7F8++efnmGwQGBalDWDClyMoruGyt1H0cfvVqa1Ud7J6S3z0lv3tKfveU/O4p+d1T8run5HdPye+ekv/F3m7aPSW/e0p+95T8FkzsnpLfPSX/qQ+W7J6S/82/IbR7Sn73lPzuKfndU/K7p+R3T8nvnpLfPSW/e0r+V/FC9+4p+V+CAndPye+ekt89Jb97Sn73lPzuKfndU/K7p+R3T8nvnpL/bbqBd0/J756S3z0lv3tKfveU/O4p+d/UU/Kt0ql+mXMhW4Xmrqj3ZOWB+XdxNMOi34OT6OoKV3mLJXLY/GNFRVwn7+LogmuB2XJULxyHclOs1ToHrPN65pL/9o5x+dixNuXHr5RJY72sG3FI9Hxt33Zd8tGrN8dRHIUHMguV0YMEfI61XXzuat9aBWDUdhXlXE4rKh6L3JxL93zTrFtee07ltf6PVgUaFpM2EHbrbt028F/c1MYBV1eudJeqN11/92nrCI/Y0BuP791yufw/Y3guAw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": ""\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/98334e25.163938f2.js b/assets/js/98334e25.163938f2.js deleted file mode 100644 index 5baaed62e..000000000 --- a/assets/js/98334e25.163938f2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7024],{16460:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>k,metadata:()=>s,toc:()=>I});const s=JSON.parse('{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/v1.1/get-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-webhook","permalink":"/docs/API-docs/v1.1/get-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar_label":"Get Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vs1u20YQfpXpXtoItKSkKQroFCMwXKNGYtQOfLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZyNIlkHM7sQtppW1CzFPRI4h88qRskbMxE2FcI4EHQOcXl2A1NquYG0bIAslEqy6x8ZrkQjr0EsWv8jFTJRIvfJEeAzOmoBBzDbi2XTKX4f2rpsswxCKRsNOj0hEZg2hIeaXzmmVxYfJu8BCGxGyCmvJv2jtUMyETd9hRiIRzrMaUq3JztEBYyCvTCkSgQ+ydppJFZELs8lkbRt/0kmcNF6/6FjGma3FdpsIUhQFlNHK4Ns+uLfPptO3P4rtlnmeT58/DvJNQA/GEhS2Mfk3/1186L31X47u2PaXAmHn+zB+eBzGhVlKrfKIiRu7QPP/RjI0T615dvWh1ixnZN2GFJniuzgIdUhvgwyYNV7RWszuNuLhRDp10r7P7ubbeSJqpMp2mGaHJVViJiarHbwD+iX6EOW5F/ZYCtLkqX0YW4cmqNJomQbG0UQ6NVk+HT8V2+RYRjr3VfzYnHytSCBZKlP+ldx8n5trrl9booMM7QolnfoZ1yLpCzDkSoRi3FQoc/SxWMoUNgp3ZXnt0Fyr0sSiRuPHA+kWdWZr5NFDFcJo1It8/PWPndRoBLnNmhoNRfiN7829ed14cHaFnoeLNDkUGh9UqjGKYR3fQj/XAspaYwh6DcoQll4SQq5KRVID50mZEjLpZKq0YtQym2VpDwPghzHcVkgVen761iNIyHGJmsEOsiFbS2JVvb+wsn5RaLsKCUhIm6AMhgBoKmkyZuwrkYD1IA2gIfTOq4AQyLPXqvXNGvIyI6ilkSWy7gSGycpRK4YreJs2gSBY3USXgaTS1mMOfUAGMQ8xiWcPjp+AqZmtnceKYbNEKBuVY0ggszlCiE3KIZgcUgwEjn1RGQZW2hhts0UsYNFoDc7yzFBSgy0OfGRx8tKEwvq69aWvwS5hzlteGdg6OBq9CcgVvlRmEWaj0b05gbsdrm4xDYpw/l3fAqvV6hH0nxzKnCv6qUnhF3Q2KLJ+vZcuFVVNGttlqGT3p9V0jgYjfgbNsNeR2yw87j6mTirUbnKNxAgJk9Orizhmn8DHD7/BJUpvoLKrFq1Z41GvoexNcebayrdp201JKGwEXsUZz1rweXzfYKA+g7eVpI8ffg/wClegTNdSHMpodNWkWmVwg7XTkjCMRjN46ZFNUk8DqiRBJg2kCKGSDKWlkiDBtdJamcUYTs0aGl5HK0VVBAPTo9xBGJyXXbkDpDJgDtZEid7meO8R0+uAeomBdfGuSxEwV8SIrrxtytba0JkuOI+F0hpuVV4ixdhO8xxcR161ZE74wB0suCGowjVIjxDQ0BiujkTiS+Oc9eyFap0vLF9SXAA0ubPKUJhB7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddXzPQ/lokB/OW48FejYY2muvr4tTHZzuelgCo/XfwJr3M08tmcXzAWupdLtRXhzriascfR1eF9folyrrD7fPdPQkMk9EIrTK0AQcnAin51eXsPx+PBXJYD3+jeaeXF68PHt1fcbO8CBtE/Z0PB1PmeRsoFqagaXBIX281zb7w+mf3Nzd8iV8oInTUsVbJwaz6e6Uu93xO09EZQMxabPhZnrj9XbL5PcNer5+5olYSq9kyjv5br5N+pXNh80C15y0LEPHV9BS6qbd+0fH3sHFdH52IxLBU+fwVFjEU6H7wdr7J7Me6D68IVoH+JMPmk8KbDbtGbLd7vjbp89KdAH23JzA+Xa7/RPRNKSi","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"}}');var i=t(74848),n=t(28453),r=t(33617),p=t.n(r),l=t(17543),a=t.n(l),d=t(86013),c=t.n(d),h=t(63723),b=t.n(h),m=(t(18766),t(79329),t(9303));const k={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u20YQfpXpXtoItKSkKQroFCMwXKNGYtQOfLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZyNIlkHM7sQtppW1CzFPRI4h88qRskbMxE2FcI4EHQOcXl2A1NquYG0bIAslEqy6x8ZrkQjr0EsWv8jFTJRIvfJEeAzOmoBBzDbi2XTKX4f2rpsswxCKRsNOj0hEZg2hIeaXzmmVxYfJu8BCGxGyCmvJv2jtUMyETd9hRiIRzrMaUq3JztEBYyCvTCkSgQ+ydppJFZELs8lkbRt/0kmcNF6/6FjGma3FdpsIUhQFlNHK4Ns+uLfPptO3P4rtlnmeT58/DvJNQA/GEhS2Mfk3/1186L31X47u2PaXAmHn+zB+eBzGhVlKrfKIiRu7QPP/RjI0T615dvWh1ixnZN2GFJniuzgIdUhvgwyYNV7RWszuNuLhRDp10r7P7ubbeSJqpMp2mGaHJVViJiarHbwD+iX6EOW5F/ZYCtLkqX0YW4cmqNJomQbG0UQ6NVk+HT8V2+RYRjr3VfzYnHytSCBZKlP+ldx8n5trrl9booMM7QolnfoZ1yLpCzDkSoRi3FQoc/SxWMoUNgp3ZXnt0Fyr0sSiRuPHA+kWdWZr5NFDFcJo1It8/PWPndRoBLnNmhoNRfiN7829ed14cHaFnoeLNDkUGh9UqjGKYR3fQj/XAspaYwh6DcoQll4SQq5KRVID50mZEjLpZKq0YtQym2VpDwPghzHcVkgVen761iNIyHGJmsEOsiFbS2JVvb+wsn5RaLsKCUhIm6AMhgBoKmkyZuwrkYD1IA2gIfTOq4AQyLPXqvXNGvIyI6ilkSWy7gSGycpRK4YreJs2gSBY3USXgaTS1mMOfUAGMQ8xiWcPjp+AqZmtnceKYbNEKBuVY0ggszlCiE3KIZgcUgwEjn1RGQZW2hhts0UsYNFoDc7yzFBSgy0OfGRx8tKEwvq69aWvwS5hzlteGdg6OBq9CcgVvlRmEWaj0b05gbsdrm4xDYpw/l3fAqvV6hH0nxzKnCv6qUnhF3Q2KLJ+vZcuFVVNGttlqGT3p9V0jgYjfgbNsNeR2yw87j6mTirUbnKNxAgJk9Orizhmn8DHD7/BJUpvoLKrFq1Z41GvoexNcebayrdp201JKGwEXsUZz1rweXzfYKA+g7eVpI8ffg/wClegTNdSHMpodNWkWmVwg7XTkjCMRjN46ZFNUk8DqiRBJg2kCKGSDKWlkiDBtdJamcUYTs0aGl5HK0VVBAPTo9xBGJyXXbkDpDJgDtZEid7meO8R0+uAeomBdfGuSxEwV8SIrrxtytba0JkuOI+F0hpuVV4ixdhO8xxcR161ZE74wB0suCGowjVIjxDQ0BiujkTiS+Oc9eyFap0vLF9SXAA0ubPKUJhB7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddXzPQ/lokB/OW48FejYY2muvr4tTHZzuelgCo/XfwJr3M08tmcXzAWupdLtRXhzriascfR1eF9folyrrD7fPdPQkMk9EIrTK0AQcnAin51eXsPx+PBXJYD3+jeaeXF68PHt1fcbO8CBtE/Z0PB1PmeRsoFqagaXBIX281zb7w+mf3Nzd8iV8oInTUsVbJwaz6e6Uu93xO09EZQMxabPhZnrj9XbL5PcNer5+5olYSq9kyjv5br5N+pXNh80C15y0LEPHV9BS6qbd+0fH3sHFdH52IxLBU+fwVFjEU6H7wdr7J7Me6D68IVoH+JMPmk8KbDbtGbLd7vjbp89KdAH23JzA+Xa7/RPRNKSi",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,g={},I=[];function f(e){const o={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,i.jsx)(p(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{webhook:{type:"string",example:"https://your-webhook-url@example.com"}},title:"inline_response_200_7"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/98334e25.740e393e.js b/assets/js/98334e25.740e393e.js new file mode 100644 index 000000000..8a2e62234 --- /dev/null +++ b/assets/js/98334e25.740e393e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7024],{16460:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>m,contentTitle:()=>Z,default:()=>I,frontMatter:()=>u,metadata:()=>n,toc:()=>v});const n=JSON.parse('{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/v1.1/get-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-webhook","permalink":"/docs/API-docs/v1.1/get-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar_label":"Get Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vs1uGzcQfpUpL22EtVZpUxTQKUZguEbdxKgd+GALAXd3dpcRl2TIWcmCICCHvkFPvfbR8iTFcHf15yRt2qIX/QznG87PN8NZC5JVENM7cYtZbe1czBJRYMi9cqSsEVNxUyOcI0GvAKdXFyC1tktY2RbIQoUEy/6w9Vokwjr0kuEXhZiKCmkwngiPwVkTMIjpWnw7mfDX4X3XbZ5jCGWrYWtHJCK3htAQ60vntMrjQfo2MGgtQl5jI/kXrRyKqbDZW8xJJMJ5NkOqu7J3dE8xkFemEonAB9k4zaKayIVpmq5s6096xEnr9fNeZZzbRmw2iSBFEaCMVgbfDMG9+XYyefOD2GxY59nk2eMgXwf0YCxBaVtTfPXfxYfeW//56I7v/lwg7PwQxvePw7gwC6lVETlxY+do/t9I9q+n7np29aHRjDOy6UKKSvFcHIS6L++CDJi3XtFKTO/W4uFEOnXSnU/vZptZIhqk2vacZocl1WIq0uWW3gH9An2I+CNaL2VVof+xzaK7py1Z+Nnm8y4m7psd7xbKU2dpHDpY3WZMuvTKy7LV+qVczKVPrUOTPh1PxhOxSdZHRoI0RWYfxqwUVGW0zEK0IZ1KF0/HTz+Ckc59kT62J18KCSQrZaq/ws12xbhmwnScOCjJlhnSqZ9wJZKh4vtaiVCc/RplgT6yQ5nSRnDPg1cOzbWqTCxLvPx4At6izm2DPOuoRhiNBsiHX//YokYjKGzeNmgo8n18b+7Nq9aDs0v0PM2kKaDU+KAyjRGGTTwLwyANKBuNIegVKENYeUkIhaoUSQ2cJ2UqyKWTmdKK24TVLKM97HVaGMNtjVSj56OvPYKEAheoubtAtmQbSWxq8BeW1s9LbZchAQlZG5TBEABNLU3OikMlErAepAE0hN55FRACefZadb5ZQ17mBI00skK2ncB+sgrUivsDvM3aQBCsbqPLQFJp67GAISCDWISYxLMHx0fA0tw2zmPNtFkgVK0qMCSQ2wIhxKnAIZgCMgwEjn1ROQY22hpt83ksIHcQOMtDSkkNtjzwkeHkpQml9U3ny1CDbcKct/xGYefgaPQ6IFf4Upl5mI5G9+YE7ra8usUsKMLZN0MLLJfLR9R/cog5V8ST4hd0NiiyfrVDV4qGabBvZPuns3SOBiN/9pphZ6OweXjcfSxNa9QuvUZihoT09OoizvUn8OH9b3CJ0huo7bJja9561Cuohqs4c13lu7RtxzKUNhKv5oznHfk8vmsx0JDB21rSh/e/B3iJS1CmbykOZTS6ajOtcrjBxmlJGEajKbzwyFfSIAOqJUEuDWQIoZZMpYWSIMF1aK3MfAynZgUtv39LRXUkA8sj7iAMzsu23AEyGbAAayJiuHO884jlTUC9wMC2+HHNELBQxIyuvW2r7rZ9Z/rgPJZKa7hVRYUUYzstCnC9eNmJOeF77mDJDUE1rkB6hICGxnB1BIknrXPWsxeqc760vLpxAdAUzipDYQqFlyXt7Cc7ouecZmXNR0RdCuU2HUlvZluSrhP7iLfS8T0P5aNBfjhvPZbo+cLQrZdDXZzq6XQ30BKYrf+G1rwQ8NSSedxXsJFKdy/K82M7cXdA34RX5TX6hcqHTfETHZ1G5VQkQqscTcC9neT0/OoSFt+NJwdP/99o7vTy4sXZy+szdoYHaZewYQUQzgZqpNm7aW9zP37X1rtN7Z8s+f3jS/hAqdNSxeUqBrPuF6O77bY9S0RtA7FoveZmeu31ZsPidy16XrdmiVhIr2TGb/LdbJMMTzZvUnNccdLyHB2vXQup2+7dP9ouD1a087MbkQieOoerwjyuCv0Ptj4cmdWe7cMdonOAP3mh+Shgve7WkM1mq98dfRLRBzhocwJnm83mTzBVzE0=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"}}');var s=t(74848),i=t(28453),a=t(33617),c=t.n(a),r=t(17543),d=t.n(r),p=t(86013),h=t.n(p),l=t(63723),k=t.n(l),b=(t(18766),t(79329),t(9303));const u={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1uGzcQfpUpL22EtVZpUxTQKUZguEbdxKgd+GALAXd3dpcRl2TIWcmCICCHvkFPvfbR8iTFcHf15yRt2qIX/QznG87PN8NZC5JVENM7cYtZbe1czBJRYMi9cqSsEVNxUyOcI0GvAKdXFyC1tktY2RbIQoUEy/6w9Vokwjr0kuEXhZiKCmkwngiPwVkTMIjpWnw7mfDX4X3XbZ5jCGWrYWtHJCK3htAQ60vntMrjQfo2MGgtQl5jI/kXrRyKqbDZW8xJJMJ5NkOqu7J3dE8xkFemEonAB9k4zaKayIVpmq5s6096xEnr9fNeZZzbRmw2iSBFEaCMVgbfDMG9+XYyefOD2GxY59nk2eMgXwf0YCxBaVtTfPXfxYfeW//56I7v/lwg7PwQxvePw7gwC6lVETlxY+do/t9I9q+n7np29aHRjDOy6UKKSvFcHIS6L++CDJi3XtFKTO/W4uFEOnXSnU/vZptZIhqk2vacZocl1WIq0uWW3gH9An2I+CNaL2VVof+xzaK7py1Z+Nnm8y4m7psd7xbKU2dpHDpY3WZMuvTKy7LV+qVczKVPrUOTPh1PxhOxSdZHRoI0RWYfxqwUVGW0zEK0IZ1KF0/HTz+Ckc59kT62J18KCSQrZaq/ws12xbhmwnScOCjJlhnSqZ9wJZKh4vtaiVCc/RplgT6yQ5nSRnDPg1cOzbWqTCxLvPx4At6izm2DPOuoRhiNBsiHX//YokYjKGzeNmgo8n18b+7Nq9aDs0v0PM2kKaDU+KAyjRGGTTwLwyANKBuNIegVKENYeUkIhaoUSQ2cJ2UqyKWTmdKK24TVLKM97HVaGMNtjVSj56OvPYKEAheoubtAtmQbSWxq8BeW1s9LbZchAQlZG5TBEABNLU3OikMlErAepAE0hN55FRACefZadb5ZQ17mBI00skK2ncB+sgrUivsDvM3aQBCsbqPLQFJp67GAISCDWISYxLMHx0fA0tw2zmPNtFkgVK0qMCSQ2wIhxKnAIZgCMgwEjn1ROQY22hpt83ksIHcQOMtDSkkNtjzwkeHkpQml9U3ny1CDbcKct/xGYefgaPQ6IFf4Upl5mI5G9+YE7ra8usUsKMLZN0MLLJfLR9R/cog5V8ST4hd0NiiyfrVDV4qGabBvZPuns3SOBiN/9pphZ6OweXjcfSxNa9QuvUZihoT09OoizvUn8OH9b3CJ0huo7bJja9561Cuohqs4c13lu7RtxzKUNhKv5oznHfk8vmsx0JDB21rSh/e/B3iJS1CmbykOZTS6ajOtcrjBxmlJGEajKbzwyFfSIAOqJUEuDWQIoZZMpYWSIMF1aK3MfAynZgUtv39LRXUkA8sj7iAMzsu23AEyGbAAayJiuHO884jlTUC9wMC2+HHNELBQxIyuvW2r7rZ9Z/rgPJZKa7hVRYUUYzstCnC9eNmJOeF77mDJDUE1rkB6hICGxnB1BIknrXPWsxeqc760vLpxAdAUzipDYQqFlyXt7Cc7ouecZmXNR0RdCuU2HUlvZluSrhP7iLfS8T0P5aNBfjhvPZbo+cLQrZdDXZzq6XQ30BKYrf+G1rwQ8NSSedxXsJFKdy/K82M7cXdA34RX5TX6hcqHTfETHZ1G5VQkQqscTcC9neT0/OoSFt+NJwdP/99o7vTy4sXZy+szdoYHaZewYQUQzgZqpNm7aW9zP37X1rtN7Z8s+f3jS/hAqdNSxeUqBrPuF6O77bY9S0RtA7FoveZmeu31ZsPidy16XrdmiVhIr2TGb/LdbJMMTzZvUnNccdLyHB2vXQup2+7dP9ouD1a087MbkQieOoerwjyuCv0Ptj4cmdWe7cMdonOAP3mh+Shgve7WkM1mq98dfRLRBzhocwJnm83mTzBVzE0=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},Z=void 0,m={},v=[];function x(e){const o={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,s.jsx)(c(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(k(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{webhook:{type:"string",example:"https://your-webhook-url@example.com"}},title:"inline_response_200_7"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.139b2f10.js b/assets/js/9c9cb35e.139b2f10.js new file mode 100644 index 000000000..ee6e1b34c --- /dev/null +++ b/assets/js/9c9cb35e.139b2f10.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>f,default:()=>y,frontMatter:()=>x,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zGzeSfwU3dVWJucPhhyXb0b2ckngT32ZtlS1f6k7SKuBMk4Q1A0wAjChGxap92H9wT/e6Py2/5KobwHCGH5JsyVllj3lwxMFXo9Hd6A90X0eWT0x0cBIdQ1Hm3IKJzuIoA5NqUVqhZHQQHU+BhWb2jQaO39nh0SvG81zNDKsMaMOsYik2AksrY1UhfuGjHJgNE8dsNhXplBnQl8C4YaO8glILaQ0bK80mIEFzK+SEZSqtCsCGmbBTVmrIYCwkZMxYXaW20mAS9r5UkpkqTcGYcZXXKzkwhJIxs1MgQDXYSkvDOKuk+LkC1umE3uci63SYnXLLUi7ZCHA7Ge7GAwQNcEYc25SkiU0JqRgL7OznSk7lqTwW5QF7X+aKZ2yuKs2Ovv1jPQXOi99OOp1vYVRN2PtXnc7Zl1NrS3PQ6/GyTFQJ0oiJzPnIJKkqehl2LLPxE8QgaMBZCVbgRuRzxrOMzUQ2AWtox5KlqpyzVCmdCelQX/IJMFkVI9AmZlxmrFAamJCMMw08m3et6lYG2H+8e/Maj6PgNmFHeWXierlMaEhtPnfTIwbCrr5wmHm2h+cj5CRmBb/AgxSW/VyJ9AK3bUASWv2ZEK46nXdVWSptIWM/ui0cdDrY8jXkasa4BuqfqqJQkpVc8wIsURseGDZr+LkSGjJHKjzPAy4OTmWXdTqSF3DQ6bD37uBFBtLiqWkiOjsVxg9IXH87L6n/K5mJFJFHAOBXpsbtrohU7PrOE4Lr2kA1UoojesThjLvzL3Oeum1pQBqy4hLaE1/FbI4TfwtSBQimSotflLQ8p+O7BG1FyvPmMSOARJiWa+KjUglpw1e/Avsvf5x42nSIng4RtAyRWwhJLQbYJc8rMB6qWcymCNVbKDUY4gc/LyJeZmwKYjLduh7PPlTGtiZmlUEwm1D4tcKpEnqB0DbmuQEmxi1cFvwCGqsxRUKL5wn7es4yGPMqtzETSKFWV5Cw18oyXpa5SEk6IQ0gs3GUKV06ZU8+SZt8jrS6FBmgCMnEeAwamRkbaQo/JkCHdFnSANwecZqdcsmUXDnoVOVKr5MQfW7jkaVKWpA2YYeXXOQEvNusYUKmeZUBG+U8vYhJrsZMQ+YYfQ4opWPHH9QFha/DOeGHGciRCpVE+KXyywuzlHAJO0ZGqfkPGwOqaRFhmlj1XD5WuDKiILAkg4KLPCbExeyDGjErbA4xMnjJ5TxmGbcQMwtXdqSuYpZOIb2gvzTPhGKjyloU7LhmplWZqZn0uBwraY34ZQNHhpaPx+gwZnsxexazFzEb9GM2GMZssBezwbOYDV7EbNiP2XAYs+FezIbPHFjDFx7XvEZwE4DB0GHZ/n6wi3L6B2GIs1HAmlpmz1oye5CwTqfmJvz2008/ncrrU8nYaYTMdRodsNOo7nIaxa4NZSa2DfzvK/zxdPjc/5zjz2fDF/7njLoO9vzPKf4cDk7lwi94KocEieVFeQMU2PygEPhfnojwGy2K34I8w48oiOLQgGfVggcbFs29PMW9CCms4LnZvp3Q4xHtaAnS2qb2cFNErtt3RM2PaDtNeLCFxKRrIrHaaAoMT1AM13a/n/ibZfvm3bKPZu8NcO639We4dRRNxyiatu+/ll6PCAmrMN0PE88TUgBIMm/Hg+/wiLDQhuh+OHiBOMBLaTsCsPUR7b4BDjb4G9619fe6g/3usD/ca2EAbSnXoSi6Wdadz+cPgT3UefzyqPIEDdVpdmi2jrUqNpgfZB0se3mdiP4OKvufUVEfBR0WMrQT2xZvsBCbWrZVGZ9/YdxUYWitnGH/pWo2b4BJTQgHWcvpVInUA499gko2QoMwQRx0CZO9LOs1MIkfs6xbFN2Vj/izS4hvfCyKJMuSlZ5rp+M+FizLYrb+eeP3LGNFUWz57L63PveKYn0XSVF42Ej5+iohdwXpbNv5xHf4rVhlyRHthW9kI/Q0KJnT2mTObeajlctmKqRv8ETFVjpomFQ513CFdqkRSrreD89jgcWWmj3Zsd6TAEGxZl++8dr7E0/+uIX2BPjl9nFrO8NJDr2DjWmYwBUrubWgJU12yXOROf9clz7AFS9KNAF6fzk9zf7wrz1yQKCNbxmeBMvERKDfqPeXk8Puf59t6FGVJeiUG2A54EomZmDThJ1MIS+XrqvZbJbMnpp0qlTu/FYfjIax+/dcjT6cE7hlwk35ZNNOHWk0DH4knVV734BtYYwbFkZuMPmJxoiHBn26bb29c8N163s8ohtnBSRsdN4TbD45jQpOCgmSMiz/VnYK+jQ6q8c4Ix+yW8ae3YFZpyKDnI8gX2+6M6PVn3M+V5Xn7+DUam/VU3QDb9hQCFn7LWg7/bjRyK9WGl3bYgN/O4Q0uTNcOYE9wwmwXJjguWmjsznau7bIQSnBuZJHwMIANqqp9N5cUAN2NzZwksif3S1LYD9GHWu3YljtlhVaB9NEDM5RCCmKqqj9o+N61oCywuseTXzhSAwyhBWap7u2Ar+6ZQXv5t+ywKkckB8j+D9u0Ex9j0ckK1ZAupmNP0WKtO7pB7pgb2fAsK0mA264lrGru5Br5jPbuS9hb/B6Q5+sG4RetjSF0qJH7r6sWYN85xuKfFZNP9x2ymv2ekTUtwGsz0yBvt9D3z6fRKTN3f+OCLUF9p2J1TklCz65wXKn5kdEnh6eNSfEgJyR7r64wSFH7TdvZ9BvbWe/vZ1n/U+wrlrL3t+46tcfl1bVS4kxh7WF0C6vch5E/UNIej8lUuY3qigr22QFsviJ3cPdHaJqLkr4h5h1Y9aJWS9mX8bsScLeAsXh0jpm569yoV1kTkiWqQpDJmml8zkbaZ5iMBySScKur3+uuLTCzhcL1mHX1xjqXywS5I0LqWYubHdyKYywDMPuS1MnU6nZEKZXqemhTdR7DbPutz403vOgPWFfqhVGvdGw9Cj4WEty27DPbF5hhOhIw1jkeSOOz8KncDwYF4UcCh879hF81BcpmiSkVYiC8Fai0xnBWGEkCR8SYDxyypeRfqewOdnYfIzgnn8ozabcOEOWLGfcHr6UsFMofEzrtbLgAtqmVNKAk+XlBqCXAelOZyUgFrotg2JCho2jNBk8nPdm+FW/KV4Gz/Zb0nK/LV/62+TLDc4blCIOF8HjDcumBueT/Anf19l+le/DpIhsJ20CkTnqU1WesVxcUGwzE6bM+RzJItyVHsrVoPk3U6XMsoePW3s+MwfteLjSGBJ/ktThwfu6nQfPn7aE/YsH8KWteJfbh9Hf6w32eze6l1ecoh8vrxm7y8mR3/ZOJ0c9l0e3cwN/qhv4YQj/6UN6wQbPhy3l7Wn//gzwQM6uJuPc4uZ6CGfWg3mVmux2R3/Sb+bXuT/17X0OC3dFDD8fPIAY3mLI3pcS1+zVB6M99lDG6iYCvIO1eqOJem8CbQL72Yl0/2Es20G/pat91VLVvho2iXJ//05E2Vx0hbJOI/GfX795O+v/6buJOjw8PHz97v305fvJ4eFhgb+TJNno1Nh02rQM6rD+Ra+/l+mO37JKkiSIwoxbfkDDe6Wc/JsbH28fk/jXIJ/J07r/EMHNDQ7V+0uBuutvc9Fs8p5+Pj6/Hwcy/9+pjOJIlZQQoOSrLDqIXHJBeGofxeQJAWO/Vtk8OriO/HNO/NM/lsShvQ8GkxiuI5NOoeD4VzDlMO1hLHKcCg150CaKI3rfgzkQSH3RQaRGHyC1UYyx5xIdhGBwDhp3cB16uWfvUezV8eggctQfxZGPwNafGMhU4ZuKMhtHi7DgTVPVX5ZTGfqjzjvAefCl+CdOQ0MXK2kfnzRTc4bFEq3LybjWfB6tZpiEJ+Ihvu/G1W9g83m4JIRFl0T9bpm6RXEkLBTNVbYcmlYfj+kUFO6E3v597Fg6Fl589Jo4rpwq+UkD/fOsTxn6QY3OP4kccbD3g2w46zuejmtdX7hNKof46BmyoBV3l6/3Y0YvaJPbKDX0JyzzSXNN5z1bW/N4W1ZH4zG5mZIpzMsSuE4oueKT83wolYrnaUXZTLVYbu2sBrXe2WARR1e3b+aKpaobUkbYlzmMrXviwVKlJegnzXdjj2Zzw729RRzNb9/e/He5ved4eLPbd/cj5dos85D+EbA+fbGIo+ntsH5fZwP9A4Hde7ZY3rErKsT5SGXz8yC3Frd1DJcZ9sNctlfyjc5ANxAxUioHLtcw8WrsHOuKfYEWzxexe1hFSRxCm3CRsRm6nTWkgAlh9N4yyCrmdR2X4cH8w3p0yr/ED6SmmWpksJcM8xk34QiY1WIyAXSd+x402KepAKekTOmfe/Fx8PKVGi6FqkwAD/3peLvkgF5uF2fBJiEnbausgR3y2jf3njRPB7/g5Soxr+XN8dEdcEkmY9fl7Tn9wO3SzcHeHB9hapwYe/UvYe9NjYmAWt7qwlAdY5eCh/SZWrbP3WMUcH5PRZtthRoSn5TWZesAZcJshCh2WbMY0arzZtcmXuZa4hGpymLoQviMIGOhNC08EhQ1Io9VdReqvAWTnE0qevtrkWVDnhw9/1umtgnpEnLJ3sgqHbL5PFlgT8zOXeIpYAU7NeaPGUjjhnM25saCjjFVFzGvK7Qu6inhqgQtMOq3EQUaHOrOK71RX2vjoJ0n9v7tDz7DNuwhMOUIOdBNDBmrSqIa4oQ6fzGc3OrW1xQl5A7Q59sUw3XVg2KZ3hVSgjZKormk9IRL8YsjYdJI0NoawZTnrqsXFegyR3iQw9vABFn769/+3oBrq6a7DphbgWcZPk69BUIyKR3Bo6avoUQJqNoQ4Xyg/331EkDoiGnOC5XVjGTuTuNH9JzV1HLRhwLrUKSp0ikaFrW8NXGQscarlYZsVDJkKZZY4n7hShjbyMAL7+TX5cNbQDymDRhIDUGuRpqX8yaDL0OkamU6yhMU7ezN+hpc4wVeWXWuoRDybvdU0ytnVS0IKqsKbkXKwlQmaefkutBP4OuCfRlAQ2q8FEo/2cKqON25kimcC3kOl6DvoOC9rt/1ZXyOxG1nALIJW0CSu86WeZMzTI1v4aRxO1F2cIsY92OkuwL0BM5TNFOI8OAOeOx0cLZOh3UdLF6smkp714pPaSf5gaJkOTtC5JNP66yL5Z3brCSQsO/VDHEWszIHfJ6NZrybH1HKCPLM1UBorpByidmn5NXBlFOcuA6zFZweTfglXKSbzot288pZ4anz7OAsmIKN68Q37SmI0DqdhGMadVjdcYTbHLpVGM8VsZSdLuVw1gbqFWXQTukKoiNEV7BbJ6S1q5kE/etf/9dQQN+9EzEJbmFrK4X6eW6US89tzhooOtB8Qg6qNZL2bwc2Gbs3ezyCAHG6BxV3KEb4CoweQJBGRTeNWjo92tbzZzO/b7KlfVx+Z0n/jkzNQb//z2xJP+3/fizpvf7vyJJ+gcB65/3t0mSbdrtRdoRgxM0DPihw/s1c6Zt7om9/Edehk00IXrLDcOH+Wxr/QYjf4hBwHoNlMMEbs2EzhIZhv4//WxGCrTpFaNrUNYzy+b9E8d0jGTefgfuMsZObkPX1dPi9KWWRTp26Y0xbkm8YcssGmngTMhcSzgNSzof9/vl+5PC9twk571QB7mKfoTU10wrLCXkNx+o54xNUUXB5/YC4Aq1vo6qPg+wmJOz1++eDGgn760h4JSntiUpXHasLkL/tTpvLW7c8gnpV5EvWjoTrRO1Ra7PN726TBtJKCzuPDk6uo6suL0XXtR+cnC3OkOrsVGGMr1SGIOZ2Gh1EvbWQH9UOw4DSyRrdzDi6uL6vRgT2YWUV+7NKL9zeyBkQBfF4KbR1MyXGDZtWI5KRR5ojEb/mlxdc91CE9gZJP+lHi/h6ZRLDZYaPZtbkLC9F73KQDDaM2SiXb+gPVfdjhxjLJ0JObht3tjyUd0g4jjZaR7NUJEvxJ0BN0p98s1ccCcT+FDiamHjWSI9vl5HZl4GqQsx0Uxh0ST2rgc0Q12yFKlfvxw3Bx0bs8SQE/iiWV4fyouWGojrcFkWNABr+aITE8GetZZ8s+aeOJwUleEDa43Bvj9Ss5wPSR56+oKt+79nizCG/4UCmZ/xNL6h7CtRy5/lPbfdWFK24k1o+nVWXzlb3yhbvil9yxYtQA7LJeEejeaPN7Ec17KMNqAwqQRuR+JIGEfm0T4jc6xMiX/Rb2ojf/nKGpU5BikOtN5By0NQNUAE4Q8IVcqyI6v1xvylBvkPHLMoT4po1HRLyVBV1QaZOJwz59W9/r0d1OrXp6jzSaL++qTQr1Qw01i3EakvjHK4EOilwGBTUZsjYplf5vMjBGIyDSwsTV5QQE7fRG+z9jSkv+UjkAuW8e0lP72gbV4VJ2I9ToASLuaq+0C7d4BJyvB5qN0+j/CKbKX0xxhKPMeNshGkY6OgDOeUydT5FJ0LIN4Y2K/prSy0M1qDTCLVwsClpNU8tK7jkE3JuxayJrAxygYKdaTVCl7tReeWcypaLXGn36pE2RM9SCIkvr0psIkUYmVbDFAn70nuWTew8+046+KqHIwyilAiLQIPfKlbJXGGBQgzGVHnOSmVdgAT17SaMONxqLg0qyQ6WcAY1wrzTF4x3nbw3gCf8g5AXrkhWl53UdPUjjIyw0E6hX2XOJ+0x3wmLV9xbKJURVun5cvRE2HCNNSepf7iZvgtFLRtS/O6ZLe/AIoWY3uHRK1JMnrBf//o/7AfgWrKpmjlqTSsN+XxZP5PKTdLJO7TVegWFFXiFNSstEamchEhXwOCPU27JT/MaZugQcyzlnhodVaNcpHVtUtPpHLj6pI2qo+2UX5c/grEezko3OhfyImGHck7e6aXbCb/TuNY2KFKzpR5oXQV0CRH5Qw3kl2AafjfIhIugaVVN3GpNYPzm2uk0uLfDLFvLTkHf6xIc5y2i0BV3biOs4rkhoaWVrdKuJgcyo7qR5oBlmo/tcv54JceGollrn0J6TkBH7KdpFIJFTPod11+dR21FA2nLW/LU4YKmVZ6Vl8KT00kgS9auTfHxZO0sTWl5Sgp3uEF5KTZGJ7Bqpnkzfgf6UqTg1bEtHN2jzr0ojnKRgjd7/f11+N3RD+zyadJv6ax3YO7eD6++efn63UsEBgWpQ1jQXUmvLrhsrOT55HipaK28/qrNjV393139313931393139313938daoXZX/3dX/3dX/3dX/3dX/3dX//fzIWFX/3dX/3dX/3dX/3dX/3dX/3dX/3dX/3dX/3dX/3dX/3dX//fxyIpd/d/HUlZ1V//3t6DAXf3fXf3fXf3fXf3fXf3fXf3fXf3fXf3fXf3fXf3ff0438K7+767+767+767+767+767+767+767+7/+H+r+NtMBemXNBeca+rpdLET5ZrQp8FkdTzCE+OImur5EC3+t8scDPP1eUoXhyFkeXXAt8SUnpx3FIXsVExAvAJMZv3MPQ7jGuH7sDp+SPlaxrzL51Iw4JBzf2baY5H715dxzF0chXLi5URmUL+AwTF/nMJXY2shvp23WUczmpKDMycnMuXJGnaTtZ94KSdf0fjfRKTGpdQtjO4nXbwH9xUxsHXF+7RODFou7vmraO8IgNvfH8zhaLxf8BilC1Sw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var r=t(74848),i=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPF1zGzeSfwU3dVWJucPhhyXb0b2ckngT32ZtlS1f6k7SKuBMk4Q1A0wAjChGxap92H9wT/e6Py2/5KobwHCGH5JsyVllj3lwxMFXo9Hd6A90X0eWT0x0cBIdQ1Hm3IKJzuIoA5NqUVqhZHQQHU+BhWb2jQaO39nh0SvG81zNDKsMaMOsYik2AksrY1UhfuGjHJgNE8dsNhXplBnQl8C4YaO8glILaQ0bK80mIEFzK+SEZSqtCsCGmbBTVmrIYCwkZMxYXaW20mAS9r5UkpkqTcGYcZXXKzkwhJIxs1MgQDXYSkvDOKuk+LkC1umE3uci63SYnXLLUi7ZCHA7Ge7GAwQNcEYc25SkiU0JqRgL7OznSk7lqTwW5QF7X+aKZ2yuKs2Ovv1jPQXOi99OOp1vYVRN2PtXnc7Zl1NrS3PQ6/GyTFQJ0oiJzPnIJKkqehl2LLPxE8QgaMBZCVbgRuRzxrOMzUQ2AWtox5KlqpyzVCmdCelQX/IJMFkVI9AmZlxmrFAamJCMMw08m3et6lYG2H+8e/Maj6PgNmFHeWXierlMaEhtPnfTIwbCrr5wmHm2h+cj5CRmBb/AgxSW/VyJ9AK3bUASWv2ZEK46nXdVWSptIWM/ui0cdDrY8jXkasa4BuqfqqJQkpVc8wIsURseGDZr+LkSGjJHKjzPAy4OTmWXdTqSF3DQ6bD37uBFBtLiqWkiOjsVxg9IXH87L6n/K5mJFJFHAOBXpsbtrohU7PrOE4Lr2kA1UoojesThjLvzL3Oeum1pQBqy4hLaE1/FbI4TfwtSBQimSotflLQ8p+O7BG1FyvPmMSOARJiWa+KjUglpw1e/Avsvf5x42nSIng4RtAyRWwhJLQbYJc8rMB6qWcymCNVbKDUY4gc/LyJeZmwKYjLduh7PPlTGtiZmlUEwm1D4tcKpEnqB0DbmuQEmxi1cFvwCGqsxRUKL5wn7es4yGPMqtzETSKFWV5Cw18oyXpa5SEk6IQ0gs3GUKV06ZU8+SZt8jrS6FBmgCMnEeAwamRkbaQo/JkCHdFnSANwecZqdcsmUXDnoVOVKr5MQfW7jkaVKWpA2YYeXXOQEvNusYUKmeZUBG+U8vYhJrsZMQ+YYfQ4opWPHH9QFha/DOeGHGciRCpVE+KXyywuzlHAJO0ZGqfkPGwOqaRFhmlj1XD5WuDKiILAkg4KLPCbExeyDGjErbA4xMnjJ5TxmGbcQMwtXdqSuYpZOIb2gvzTPhGKjyloU7LhmplWZqZn0uBwraY34ZQNHhpaPx+gwZnsxexazFzEb9GM2GMZssBezwbOYDV7EbNiP2XAYs+FezIbPHFjDFx7XvEZwE4DB0GHZ/n6wi3L6B2GIs1HAmlpmz1oye5CwTqfmJvz2008/ncrrU8nYaYTMdRodsNOo7nIaxa4NZSa2DfzvK/zxdPjc/5zjz2fDF/7njLoO9vzPKf4cDk7lwi94KocEieVFeQMU2PygEPhfnojwGy2K34I8w48oiOLQgGfVggcbFs29PMW9CCms4LnZvp3Q4xHtaAnS2qb2cFNErtt3RM2PaDtNeLCFxKRrIrHaaAoMT1AM13a/n/ibZfvm3bKPZu8NcO639We4dRRNxyiatu+/ll6PCAmrMN0PE88TUgBIMm/Hg+/wiLDQhuh+OHiBOMBLaTsCsPUR7b4BDjb4G9619fe6g/3usD/ca2EAbSnXoSi6Wdadz+cPgT3UefzyqPIEDdVpdmi2jrUqNpgfZB0se3mdiP4OKvufUVEfBR0WMrQT2xZvsBCbWrZVGZ9/YdxUYWitnGH/pWo2b4BJTQgHWcvpVInUA499gko2QoMwQRx0CZO9LOs1MIkfs6xbFN2Vj/izS4hvfCyKJMuSlZ5rp+M+FizLYrb+eeP3LGNFUWz57L63PveKYn0XSVF42Ej5+iohdwXpbNv5xHf4rVhlyRHthW9kI/Q0KJnT2mTObeajlctmKqRv8ETFVjpomFQ513CFdqkRSrreD89jgcWWmj3Zsd6TAEGxZl++8dr7E0/+uIX2BPjl9nFrO8NJDr2DjWmYwBUrubWgJU12yXOROf9clz7AFS9KNAF6fzk9zf7wrz1yQKCNbxmeBMvERKDfqPeXk8Puf59t6FGVJeiUG2A54EomZmDThJ1MIS+XrqvZbJbMnpp0qlTu/FYfjIax+/dcjT6cE7hlwk35ZNNOHWk0DH4knVV734BtYYwbFkZuMPmJxoiHBn26bb29c8N163s8ohtnBSRsdN4TbD45jQpOCgmSMiz/VnYK+jQ6q8c4Ix+yW8ae3YFZpyKDnI8gX2+6M6PVn3M+V5Xn7+DUam/VU3QDb9hQCFn7LWg7/bjRyK9WGl3bYgN/O4Q0uTNcOYE9wwmwXJjguWmjsznau7bIQSnBuZJHwMIANqqp9N5cUAN2NzZwksif3S1LYD9GHWu3YljtlhVaB9NEDM5RCCmKqqj9o+N61oCywuseTXzhSAwyhBWap7u2Ar+6ZQXv5t+ywKkckB8j+D9u0Ex9j0ckK1ZAupmNP0WKtO7pB7pgb2fAsK0mA264lrGru5Br5jPbuS9hb/B6Q5+sG4RetjSF0qJH7r6sWYN85xuKfFZNP9x2ymv2ekTUtwGsz0yBvt9D3z6fRKTN3f+OCLUF9p2J1TklCz65wXKn5kdEnh6eNSfEgJyR7r64wSFH7TdvZ9BvbWe/vZ1n/U+wrlrL3t+46tcfl1bVS4kxh7WF0C6vch5E/UNIej8lUuY3qigr22QFsviJ3cPdHaJqLkr4h5h1Y9aJWS9mX8bsScLeAsXh0jpm569yoV1kTkiWqQpDJmml8zkbaZ5iMBySScKur3+uuLTCzhcL1mHX1xjqXywS5I0LqWYubHdyKYywDMPuS1MnU6nZEKZXqemhTdR7DbPutz403vOgPWFfqhVGvdGw9Cj4WEty27DPbF5hhOhIw1jkeSOOz8KncDwYF4UcCh879hF81BcpmiSkVYiC8Fai0xnBWGEkCR8SYDxyypeRfqewOdnYfIzgnn8ozabcOEOWLGfcHr6UsFMofEzrtbLgAtqmVNKAk+XlBqCXAelOZyUgFrotg2JCho2jNBk8nPdm+FW/KV4Gz/Zb0nK/LV/62+TLDc4blCIOF8HjDcumBueT/Anf19l+le/DpIhsJ20CkTnqU1WesVxcUGwzE6bM+RzJItyVHsrVoPk3U6XMsoePW3s+MwfteLjSGBJ/ktThwfu6nQfPn7aE/YsH8KWteJfbh9Hf6w32eze6l1ecoh8vrxm7y8mR3/ZOJ0c9l0e3cwN/qhv4YQj/6UN6wQbPhy3l7Wn//gzwQM6uJuPc4uZ6CGfWg3mVmux2R3/Sb+bXuT/17X0OC3dFDD8fPIAY3mLI3pcS1+zVB6M99lDG6iYCvIO1eqOJem8CbQL72Yl0/2Es20G/pat91VLVvho2iXJ//05E2Vx0hbJOI/GfX795O+v/6buJOjw8PHz97v305fvJ4eFhgb+TJNno1Nh02rQM6rD+Ra+/l+mO37JKkiSIwoxbfkDDe6Wc/JsbH28fk/jXIJ/J07r/EMHNDQ7V+0uBuutvc9Fs8p5+Pj6/Hwcy/9+pjOJIlZQQoOSrLDqIXHJBeGofxeQJAWO/Vtk8OriO/HNO/NM/lsShvQ8GkxiuI5NOoeD4VzDlMO1hLHKcCg150CaKI3rfgzkQSH3RQaRGHyC1UYyx5xIdhGBwDhp3cB16uWfvUezV8eggctQfxZGPwNafGMhU4ZuKMhtHi7DgTVPVX5ZTGfqjzjvAefCl+CdOQ0MXK2kfnzRTc4bFEq3LybjWfB6tZpiEJ+Ihvu/G1W9g83m4JIRFl0T9bpm6RXEkLBTNVbYcmlYfj+kUFO6E3v597Fg6Fl589Jo4rpwq+UkD/fOsTxn6QY3OP4kccbD3g2w46zuejmtdX7hNKof46BmyoBV3l6/3Y0YvaJPbKDX0JyzzSXNN5z1bW/N4W1ZH4zG5mZIpzMsSuE4oueKT83wolYrnaUXZTLVYbu2sBrXe2WARR1e3b+aKpaobUkbYlzmMrXviwVKlJegnzXdjj2Zzw729RRzNb9/e/He5ved4eLPbd/cj5dos85D+EbA+fbGIo+ntsH5fZwP9A4Hde7ZY3rErKsT5SGXz8yC3Frd1DJcZ9sNctlfyjc5ANxAxUioHLtcw8WrsHOuKfYEWzxexe1hFSRxCm3CRsRm6nTWkgAlh9N4yyCrmdR2X4cH8w3p0yr/ED6SmmWpksJcM8xk34QiY1WIyAXSd+x402KepAKekTOmfe/Fx8PKVGi6FqkwAD/3peLvkgF5uF2fBJiEnbausgR3y2jf3njRPB7/g5Soxr+XN8dEdcEkmY9fl7Tn9wO3SzcHeHB9hapwYe/UvYe9NjYmAWt7qwlAdY5eCh/SZWrbP3WMUcH5PRZtthRoSn5TWZesAZcJshCh2WbMY0arzZtcmXuZa4hGpymLoQviMIGOhNC08EhQ1Io9VdReqvAWTnE0qevtrkWVDnhw9/1umtgnpEnLJ3sgqHbL5PFlgT8zOXeIpYAU7NeaPGUjjhnM25saCjjFVFzGvK7Qu6inhqgQtMOq3EQUaHOrOK71RX2vjoJ0n9v7tDz7DNuwhMOUIOdBNDBmrSqIa4oQ6fzGc3OrW1xQl5A7Q59sUw3XVg2KZ3hVSgjZKormk9IRL8YsjYdJI0NoawZTnrqsXFegyR3iQw9vABFn769/+3oBrq6a7DphbgWcZPk69BUIyKR3Bo6avoUQJqNoQ4Xyg/331EkDoiGnOC5XVjGTuTuNH9JzV1HLRhwLrUKSp0ikaFrW8NXGQscarlYZsVDJkKZZY4n7hShjbyMAL7+TX5cNbQDymDRhIDUGuRpqX8yaDL0OkamU6yhMU7ezN+hpc4wVeWXWuoRDybvdU0ytnVS0IKqsKbkXKwlQmaefkutBP4OuCfRlAQ2q8FEo/2cKqON25kimcC3kOl6DvoOC9rt/1ZXyOxG1nALIJW0CSu86WeZMzTI1v4aRxO1F2cIsY92OkuwL0BM5TNFOI8OAOeOx0cLZOh3UdLF6smkp714pPaSf5gaJkOTtC5JNP66yL5Z3brCSQsO/VDHEWszIHfJ6NZrybH1HKCPLM1UBorpByidmn5NXBlFOcuA6zFZweTfglXKSbzot288pZ4anz7OAsmIKN68Q37SmI0DqdhGMadVjdcYTbHLpVGM8VsZSdLuVw1gbqFWXQTukKoiNEV7BbJ6S1q5kE/etf/9dQQN+9EzEJbmFrK4X6eW6US89tzhooOtB8Qg6qNZL2bwc2Gbs3ezyCAHG6BxV3KEb4CoweQJBGRTeNWjo92tbzZzO/b7KlfVx+Z0n/jkzNQb//z2xJP+3/fizpvf7vyJJ+gcB65/3t0mSbdrtRdoRgxM0DPihw/s1c6Zt7om9/Edehk00IXrLDcOH+Wxr/QYjf4hBwHoNlMMEbs2EzhIZhv4//WxGCrTpFaNrUNYzy+b9E8d0jGTefgfuMsZObkPX1dPi9KWWRTp26Y0xbkm8YcssGmngTMhcSzgNSzof9/vl+5PC9twk571QB7mKfoTU10wrLCXkNx+o54xNUUXB5/YC4Aq1vo6qPg+wmJOz1++eDGgn760h4JSntiUpXHasLkL/tTpvLW7c8gnpV5EvWjoTrRO1Ra7PN726TBtJKCzuPDk6uo6suL0XXtR+cnC3OkOrsVGGMr1SGIOZ2Gh1EvbWQH9UOw4DSyRrdzDi6uL6vRgT2YWUV+7NKL9zeyBkQBfF4KbR1MyXGDZtWI5KRR5ojEb/mlxdc91CE9gZJP+lHi/h6ZRLDZYaPZtbkLC9F73KQDDaM2SiXb+gPVfdjhxjLJ0JObht3tjyUd0g4jjZaR7NUJEvxJ0BN0p98s1ccCcT+FDiamHjWSI9vl5HZl4GqQsx0Uxh0ST2rgc0Q12yFKlfvxw3Bx0bs8SQE/iiWV4fyouWGojrcFkWNABr+aITE8GetZZ8s+aeOJwUleEDa43Bvj9Ss5wPSR56+oKt+79nizCG/4UCmZ/xNL6h7CtRy5/lPbfdWFK24k1o+nVWXzlb3yhbvil9yxYtQA7LJeEejeaPN7Ec17KMNqAwqQRuR+JIGEfm0T4jc6xMiX/Rb2ojf/nKGpU5BikOtN5By0NQNUAE4Q8IVcqyI6v1xvylBvkPHLMoT4po1HRLyVBV1QaZOJwz59W9/r0d1OrXp6jzSaL++qTQr1Qw01i3EakvjHK4EOilwGBTUZsjYplf5vMjBGIyDSwsTV5QQE7fRG+z9jSkv+UjkAuW8e0lP72gbV4VJ2I9ToASLuaq+0C7d4BJyvB5qN0+j/CKbKX0xxhKPMeNshGkY6OgDOeUydT5FJ0LIN4Y2K/prSy0M1qDTCLVwsClpNU8tK7jkE3JuxayJrAxygYKdaTVCl7tReeWcypaLXGn36pE2RM9SCIkvr0psIkUYmVbDFAn70nuWTew8+046+KqHIwyilAiLQIPfKlbJXGGBQgzGVHnOSmVdgAT17SaMONxqLg0qyQ6WcAY1wrzTF4x3nbw3gCf8g5AXrkhWl53UdPUjjIyw0E6hX2XOJ+0x3wmLV9xbKJURVun5cvRE2HCNNSepf7iZvgtFLRtS/O6ZLe/AIoWY3uHRK1JMnrBf//o/7AfgWrKpmjlqTSsN+XxZP5PKTdLJO7TVegWFFXiFNSstEamchEhXwOCPU27JT/MaZugQcyzlnhodVaNcpHVtUtPpHLj6pI2qo+2UX5c/grEezko3OhfyImGHck7e6aXbCb/TuNY2KFKzpR5oXQV0CRH5Qw3kl2AafjfIhIugaVVN3GpNYPzm2uk0uLfDLFvLTkHf6xIc5y2i0BV3biOs4rkhoaWVrdKuJgcyo7qR5oBlmo/tcv54JceGollrn0J6TkBH7KdpFIJFTPod11+dR21FA2nLW/LU4YKmVZ6Vl8KT00kgS9auTfHxZO0sTWl5Sgp3uEF5KTZGJ7Bqpnkzfgf6UqTg1bEtHN2jzr0ojnKRgjd7/f11+N3RD+zyadJv6ax3YO7eD6++efn63UsEBgWpQ1jQXUmvLrhsrOT55HipaK28/qrNjV393139313931393139313938daoXZX/3dX/3dX/3dX/3dX/3dX//fzIWFX/3dX/3dX/3dX/3dX/3dX/3dX/3dX/3dX/3dX/3dX/3dX//fxyIpd/d/HUlZ1V//3t6DAXf3fXf3fXf3fXf3fXf3fXf3fXf3fXf3fXf3fXf3ff0438K7+767+767+767+767+767+767+767+7/+H+r+NtMBemXNBeca+rpdLET5ZrQp8FkdTzCE+OImur5EC3+t8scDPP1eUoXhyFkeXXAt8SUnpx3FIXsVExAvAJMZv3MPQ7jGuH7sDp+SPlaxrzL51Iw4JBzf2baY5H715dxzF0chXLi5URmUL+AwTF/nMJXY2shvp23WUczmpKDMycnMuXJGnaTtZ94KSdf0fjfRKTGpdQtjO4nXbwH9xUxsHXF+7RODFou7vmraO8IgNvfH8zhaLxf8BilC1Sw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,g={},b=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,r.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,r.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,r.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,r.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,r.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,r.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,r.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"6",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"7",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"8",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,r.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"9",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,r.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"10",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"11",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"12",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"13",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ol,{start:"14",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": ""\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,r.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,r.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,r.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,r.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"6",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(d(),{parameters:void 0}),"\n",(0,r.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,r.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.98c04a72.js b/assets/js/9c9cb35e.98c04a72.js deleted file mode 100644 index 093427cbb..000000000 --- a/assets/js/9c9cb35e.98c04a72.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtyG7eSv4Kd2qrE3BFF0pLtaF9WyfFJtMdrq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsyYm9xTw44uDWaHQ3+oLum8jyqYkOTqMTKMqcWzDReRylYBItSiuUjA6ikwxYaGbfaeD4nR0eHzGe52pmWGVAG2YVS7ARWFIZqwrxKx/nwGyYOGazTCQZM6CvgHHDxnkFpRbSGjZRmk1BguZWyClLVVIVgA0zYTNWakhhIiSkzFhdJbbSYPrsXakkM1WSgDGTKq9XcmAIJWNmMyBANdhKS8M4q6T4pQLW64XeFyLt9ZjNuGUJl2wMuJ0Ud+MBghY4Y45tStLEpoRETAR29nP1z+SZPBHlAXtX5oqnbK4qzY7/9Od6CpwXv532en+CcTVl7456vfOvM2tLc7C7y8uyr0qQRkxlzsemn6hiN8WOZTp5ghgEDTgrwQrciHzOeJqymUinYA3tWLJElXOWKKVTIR3qSz4FJqtiDNrEjMuUFUoDE5JxpoGn8x2rdioD7N/fvnmNx1Fw22fHeWXierlUaEhsPnfTIwbCrr5ymHm2h+cj5DRmBb/EgxSW/VKJ5BK3bUASWv2ZEK56vbdVWSptIWU/uS0c9HrY8i3kasa4BuqfqKJQkpVc8wIsURseGDZr+KUSGlJHKjzPAy4OzuQOnvO8hINejx3JVCSIDJoQvzI18X37risiCbu+9QfrurZQhyfviBhxMuPuPMucJw5MDUgTVlxBd+LrmM1x4j+BVAGCTGnxq5KW53QcV6CtSHjePjYEkAjNck18USohbfjqV2D/5Y8HT48OxdMVgpYisgohqcUAu+J5BcZDNYtZhlD9CKUGQ/Tt50VEypRlIKbZxvV4+r4ytjMxqwyC2YbCrxVOidALhLYJzw0wMengsuCX0FqNKRJCPO+zb+cshQmvchszgRRndQV99lpZxssyFwlJGxQkyDwcZcQOnbInBw+I5AWd8bFWVyIFFAmpmExAI3NiI03hxwTokM5KGoDbI86xGZdMyaWDTlSu9CoJ0ecuHlmipAVp++zwioucgHebNUzIJK9SYOOcJ5cxycmYaUgd484BpW7s6J26oDB1OCf8MAM5UqGSCL9UfnlhGonVZyeZMA0/YWNANS0iTBurnmsnCldGFAQWY1BwkceEuJi9V2Nmhc0hRoYtuZzHLOUWYmbh2o7VdcySDJJL+kvzVCg2rqxFQY1rplqVqZpJj8uJktaIX9dwZGj5cIyOYrYXs2cxexGz4SBmw1HMhnsxGz6L2fBFzEaDmI1GMRvtxWz0zIE1euFxzWsEtwEYjhyW7ZeDXZS7r4QhzkaBaWoZPOvI4GGf9Xo1N+G3n3/++UzenEnGziJkrrPogJ1FdZezKHZtKDOxbeh/X+OPp6Pn/uccfz4bvfA/Z9R1uOd/ZvhzNDyTC7/gmRwRJJYX5S1QYPOjQuB/eSLCb7QofgvyDD+iIIpDA55VBx5sWLT38hT3IqSwgudm83ZCj89oRw1IK5vaw00RuW7eETV/Rttpw4MtJCZdE4nVVlNgeIJitLL7/b6/WTZv3i372ey9Bc7Dtv4Mt46i6QRF0+b919LrM0LCMkwPw8TzPikAJJk348F3+Iyw0IXoYTh4gTjAS2kzArD1M9p9Cxxs8De8axvs7Qz3d0aD0V4HA2gbuQ5FsZOmO/P5/DGwhzqPXx5VnqChOs0OzdCJVsUa84Osg6aX14no76Cy/wcq6uOgw0KKdl/Xgg0WX1vLtirl86+MmyoMrZUz7N+oZvMWmNSEcJD1m2RKJB547BNUsjEaeH3EwQ5hcjdNd1uYxI9pulMUO0sf8ecOIb71sSj6adpf6rlyOu5jwdI0Zquf135PU1YUxYbP7nvn825RrO6iXxQeNlK+vumT+4F0ts184jv8XqzScER34VvZCD0HSua0Nplz6/lo6bLJhPQNnqjYUgcN0yrnGq7RLjVCSdf78XkssFij2ZMdSyYgeQkcKtjXb7z2/sSTP26hOwF+uXvcys5wkkPvMGMapnDNSm4taEmTXfFcpM7ftkMf4JoXJZoAu389O0v/5Z93yQGBNr5leBIsFVOBfqDdv54e7vz3+ZoeVVmCTrgBlgOuZGIGNumz0wzysnFFzWaz/uypSTKlcueHem80TNy/F2r8/oLALfvclE/W7dSRRsvgR9JZtvcN2A7GuGFh5BqTn2iMeGg4oNvW2zu3XLe+x2d04yyBhI3Oe4LNp2dRwUkhQVKG5m9lM9Bn0Xk9xhn5kN4x9vwezJqJFHI+hny16d6MVn/O+VxVnr+DU6u7VU/RLbxhQyFk7beg7QziViO/Xmp0bYs1/O0Q0ubOcOUE9gwnwHJhguemi872aO/aIoejBOcaHgMLA9i4ptIHc0EN2P3YwEkif3Z3LIH9GHWs3YphtTtW6BxMGzE4RyGkKKqi9o9O6lkDygqve7TxhSMxaBBWaJ/uygr8+o4VvNt+wwJnckh+jOD/uEUz9T0+I1mxBNLtbPwxUqRzTz/SBXs3A4ZttRlwzbWMXd2FXDOf2cx9ffYGrzf0ybpB6GVLEigteuQeypo1yPe+ochn1fbDbaa8dq/PiPrWgPWJKdD3e+zb56OItL37L4hQO2Dfm1idU7Lg01ssd2r+jMjTw7PihOj1jjVMRJ63QoosfAqRHQzpQA6FD3v5YCJedeQIF9IqNAtC2LbXG8NEoRMcY5oYSsl4E3R0d4071nZc1EWilWYZN04HJ6UfjwuDtjaDwrvjXysLLhZnSiUNODIs1wDdxNJ6vSVffujW+POFDBvHYx0+nuE5+mbQPujhs/3OQe8POgc92HTQt9idSAIOF8FZB01TSzAQjYTvq3fTMt+HSRHZLyUGZ4L54bhJVXnKcnFJYZlUmDLncySLwOYeyuV433eZUqbp4UNuX/sNH3RDeUpjNO9Jv45sPNRjNnz+tH0a+y8ewQ2w5BjrHsZgb3e4v3urZ2zJn/PhSgVj9zk5cjnd6+SoZ3N0Ww/Wx3qwHofwnz6mAT98PurcO08HD2eAR7LT24xzh4X+GHb4oxnEbXa7pyn8u5mkD6e+vU+hnC+J4efDRxDDG3Twh1Liiqr9aLTHHkvPXkeA91C0b9WuH0ygbWA/OZHuP45SPhx0dLVvOqraN6M2Ue7v34so24suUdZZJP7z2zc/zgZ/+X6qDg8PD1+/fZe9fDc9PDws8He/319rj607bVoGdVj/uNDfy3THb1il3+8jClNu+QEN3y3l9F/d+HjzmL4PZH8iJ9H+Y8Rl1viCHi4F6q5/nOPn0/H5wziQ+f/OZBRHqqS3yUoepdFB5N45h1e/UUzWKhj7rUrn0cFN5F+i4Z/+nRcO3X1v8D31TWSSDAqOfwVTDl9gT0SOU+FjKtAmiiN6moDPsZH6ooNIjd9DYqMYw2Yl+jbA4Bw07uAm9HIvcKPYq+PRQeSoP4ojHzyqPzGQicJwcJlOokVY8Lap6i/NVIb+qJ9A4zz4yPUjp6Ghi6UX6B81U3uGRYPWZjKuNZ9Hy4/dw+vWEJp04+rne/k8XBLConelfnJJ3aI4EhaK9iobDk2rD8d0Agp3Qs+WPnQsHQsvPnhNHFdmSn7UQP+y5GOGvlfji48iRxzs/SBrzvqep+NaVxfuksohvteENGjFO83D45jR47/+XZQa+hOW+bS9pgt3rKx5sulBeusdrMnIFOZlCVz36V34R6ccUFYHz5OKEitqsdzZWQ1qvbPhIo6u797MNUvUTnjtzr7OYWJddJolSkvQT9pPXj6bzY329hZxNL97e/MvcnvP8fBmd+/uJ0oTaFIo/ghYn75YxFF2N6w/1IkMfyCwe88WzR27pEJcjFU6vwhya3FXx3CZYT9MqzmSb3QKuoWIsVI5cLmCiaOJCxQo9hVaPF/F7k0IvT8X2oSLjM3Q7awhAcxloadiQVYxr+u4x+nMvwnG+MJL/EBqmqnGBnvJMJ9xE46BWS2mU0DXue9Bg/0Le+CUHyb9SxU+CV6+UsOVUJUJ4KE/HW+XHNDLbTMQLu1DyGnXKmthh7z27b3326eDX/Bylfgk/83J8T1wSSbjDrNZ/bzf7dLNwd6cHGNWj5h49a/P3pkaEwG1vNOFoTrGrgQPL/9r2T53cXRwfk9Fm+2EGvo+n2aHrQKUCrMWotgl8GHKQZ3CtzJxk/aFR6Qqi6EL4ZMZjIXSdPBIUNSIPFHVfajyDkxyNq3o2aJFlg0pPvRyqcnKEdLlBpK9kVY6JCJ5ssCemCjY4ClgBTu15o8ZSOOGczbhxoKOMWsQMa8rtC7qKeG6BC1AJrAWBRoc6i4qvVZf6+Kgm+Ly7sdXPtkv7CEw5Rg50E0MKatKohrihDr1Kpzc8tZXFCXkDtAXmxTDVdWDEqS8K6QEbZREc0npKZfiV0fCpJGgtTWGjOeuqxcV6DJHeJDDu8AEWfvb3//RgmujprsKmFuBpym+q7sDQjIpHcGjpq+hRAmouhDhfKD/bfkSQOiIaS4KldaMZO5P48f0Es/UctGHAutQpKmSDA2LWt6aOMhY49VKQzYqGbIUSyxxv3AtjG0lD4Unvqvy4UdAPCYtGEgNQa5GmpfzNoM3IVK1NB2lOIlu4ll9Da7wAq+sutBQCHm/e6rtlbOqFgSVVQW3ImFhKtPvphO60E/g64J9HUBDarwSSj/ZwKo43YWSCVwIeQFXoO+h4L2unySlfI7EbWcAsg1bQJK7zpqUrxlm6XZw0rqdKLGxQ4z7MdJdAXoKFwmaKUR4cA889no4W6/HdhwsXqyaSnvXis+uJfmBoqSZHSHyeXP1g/Hmzm0nNffZD2qGOItZmQO+LEUz3s2PKGUEeerSsdsrJFxi4hx5dTBbDieuw2wFF7JZwkW66bxoN0fOCk+cZwdnwexRXCe+bU9BhNYv4TlmgIbVHUe4zaFbhfFcEUvZrJHDaReoI0r+y+gKoiNEV7BbJ2TkqpkE/dvf/tdQQB9TTRPMXz+abG6lUD/PjXKZhe1ZA0UHmu+Tg2qFpP3bgXXG7u0ejyBAnO5BeebFGB+w0AMI0qjoplGN06NrPX8y8/s2W9rH5beW9Bdkag4Hg//PlvTTwZdjSe8NviBL+gUC6533d0uTTdrtWtkRghG3D3ivwPk3c6Vv74m+/UVch07WIbhhh9HC/dcY/0GI3+EQcB6DJpjgjdmwGULDaDDA/y0JwU7JFDRt6nIq+fyfovj+kYzbz8B9xtjJbcj6Nhv9YEpZJJlTd4zpSvI1Q+7YQBtvQuZCwkVAysVoMLjYjxy+99Yh560qwF3sM7SmZlphZROv4Vg9Z3yKKgourx8RV6D1XVT1YZDdhoS9weBiWCNhfxUJR5IyNqiKzom6BPn77rS9vHXLI6jXRd6wdiRcJ2qPOpttf3ebNJBUWth5dHB6E13v8FLsuPaD0/PFOVKdzRTG+EplCGJus+gg2l0J+VEZIwwond5EZOBHQeQZLlN8w7Ii9ngpdq+G/WG0iJfHrBWTt/SHaudDhxjLp0JO7xp33uDoLZ6jO6oOphq9rhR/AVTs/EG0e8WRQPrJgKPFh6hH8vixCZS+DIccQpjropLNYS7HGUOYsRM5XL6u1sQCW6HA0xCHo9BaHVmLmg1FdfQrilrxLPzRilDhz1rpPW3IuQ7vBJ10SMrcaG+PtJ7nQ1IPnr6gm3fv2eLcIb/lz6WXz22npHuZ0/Gu+U9db1MULXl3Oi6WZQ/LRm/HBmeHX3LJqK8BWWdLow271oT1o1rmyhpUhhu6i0h82IKIfDogRO4NCJEvBh3lwG+/maG54uker69xuqvbVzXex+dIuEJOFFG9P+43Jci36CdFqURcs6LSQZ6ooi7t0uuFIb/9/R/1qF6vtiSdgxjNyTeVZqWagcaKZli3ZZLDtUCfAQ6DgtoM2b706J8XORiDYWlpYerKlWEKKDpnvfsv4SUfi1yg2HUP2+lZa0tymz77KQN8KYJNX2mXEXsFOUrr2uvSKszGZkpfTrD4W8w4G2PZJ/S7gcy4TJyLz4kQclWhCYnu01ILg9WsNEItHGxKWs0Tywou+ZR8TTFrIyuFXKCcZVqN0QNuVF45H6/lIlfaPUKkDdErEULiy+sSm0gvRabVkCFhX3lHr4mdo91JB18PbYwxjRJhEWh/W8UqmSssXYaxkSrPWamsi1eg+tuGEYdbzaVBndXBEs6gRpj3wYLxnox3BvCEXwl56crt7LDTmq5+grERFrrJuMvM+aQ75nthf6jGWMxLGWGVnjejp8Jm1ZjkfHuS+oeb6ftQ7q4lxZs5UpWYNYq8Sswu5g3vvgWLFGJ2D4+PSE94wn772/+wV8C1ZJmaOWpNKg35vKmsR4Xo6OQd2uprnrz8vMJqdpaIVE5D4Clg8KeMW3KbvIYZ+qccS7mXP8fVOBdJXbXQ9HoHrnJhqx5hN3nQpXNg6IWz0o3Ohbzss0M5J2dx4wXC7zSusw0KnGyoFFjXB2wgIvekgfwKTMsNBqlwAS2tqqlbrQ2M31w3uwX3dpimK8ki6AptwHHOG4okcefFwfp+a/JLOskj3bpUIFOqQGcOWKr5xDbzx0spLxRcWvkUsmUCOmI/TatEJGLS77j+6hxcSxpIV96S4wwXNJ3CjbwUnpxOA1mybpb7h5O1M/yk5Qnpv+EG5aVYGyzA+nvmzeQt6CuRgFfHNnD0LnXejeIoFwl4K9TfX4ffH79iV0/7gyhu6XX3YO7dV0ffvXz99iUCg4LUIWzYH/QH5CxTxhZctlbyfHLSKFpLj7Fq7X9bGXRbGXRbGXRbGXRbGXRbGXRbGXRbGXRbGXRbGXRlU9vKoNvKoNvKoNvKoNvKoNvKoNu6CtvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoI/qjtxWBt1WBt1WBt1WBt1WBt1WBt1WBn2APr6tDLqtDLqtDLqtDLqtDLqtDLqtDLquMmgrQ2m3zLmgDERf8cclD54u1ws9j6MMswsPTqObG6TAdzpfLPDzLxUlS52ex9EV1wIfgVFiYhzy6DAn6hIwn+o796Zt5wTXj92B0zv0pXxMTAR0Iw4JB7f2bSdAHr95exLF0djXNC1USgnNfIY5VHzmcsxaiVb07SbKuZxWlKQVuTkXrvxL1s0bvKS8Qf9HK9ML8+saCLsJhW4b+C9uau2AmxuXk7hY1P1d08YRHrGhN57f+WKx+D9KyU4A","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyG7eSv4Kd2qrE3BFF0pLtaF9WyfFJtMdrq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsyYm9xTw44uDWaHQ3+oLum8jyqYkOTqMTKMqcWzDReRylYBItSiuUjA6ikwxYaGbfaeD4nR0eHzGe52pmWGVAG2YVS7ARWFIZqwrxKx/nwGyYOGazTCQZM6CvgHHDxnkFpRbSGjZRmk1BguZWyClLVVIVgA0zYTNWakhhIiSkzFhdJbbSYPrsXakkM1WSgDGTKq9XcmAIJWNmMyBANdhKS8M4q6T4pQLW64XeFyLt9ZjNuGUJl2wMuJ0Ud+MBghY4Y45tStLEpoRETAR29nP1z+SZPBHlAXtX5oqnbK4qzY7/9Od6CpwXv532en+CcTVl7456vfOvM2tLc7C7y8uyr0qQRkxlzsemn6hiN8WOZTp5ghgEDTgrwQrciHzOeJqymUinYA3tWLJElXOWKKVTIR3qSz4FJqtiDNrEjMuUFUoDE5JxpoGn8x2rdioD7N/fvnmNx1Fw22fHeWXierlUaEhsPnfTIwbCrr5ymHm2h+cj5DRmBb/EgxSW/VKJ5BK3bUASWv2ZEK56vbdVWSptIWU/uS0c9HrY8i3kasa4BuqfqKJQkpVc8wIsURseGDZr+KUSGlJHKjzPAy4OzuQOnvO8hINejx3JVCSIDJoQvzI18X37risiCbu+9QfrurZQhyfviBhxMuPuPMucJw5MDUgTVlxBd+LrmM1x4j+BVAGCTGnxq5KW53QcV6CtSHjePjYEkAjNck18USohbfjqV2D/5Y8HT48OxdMVgpYisgohqcUAu+J5BcZDNYtZhlD9CKUGQ/Tt50VEypRlIKbZxvV4+r4ytjMxqwyC2YbCrxVOidALhLYJzw0wMengsuCX0FqNKRJCPO+zb+cshQmvchszgRRndQV99lpZxssyFwlJGxQkyDwcZcQOnbInBw+I5AWd8bFWVyIFFAmpmExAI3NiI03hxwTokM5KGoDbI86xGZdMyaWDTlSu9CoJ0ecuHlmipAVp++zwioucgHebNUzIJK9SYOOcJ5cxycmYaUgd484BpW7s6J26oDB1OCf8MAM5UqGSCL9UfnlhGonVZyeZMA0/YWNANS0iTBurnmsnCldGFAQWY1BwkceEuJi9V2Nmhc0hRoYtuZzHLOUWYmbh2o7VdcySDJJL+kvzVCg2rqxFQY1rplqVqZpJj8uJktaIX9dwZGj5cIyOYrYXs2cxexGz4SBmw1HMhnsxGz6L2fBFzEaDmI1GMRvtxWz0zIE1euFxzWsEtwEYjhyW7ZeDXZS7r4QhzkaBaWoZPOvI4GGf9Xo1N+G3n3/++UzenEnGziJkrrPogJ1FdZezKHZtKDOxbeh/X+OPp6Pn/uccfz4bvfA/Z9R1uOd/ZvhzNDyTC7/gmRwRJJYX5S1QYPOjQuB/eSLCb7QofgvyDD+iIIpDA55VBx5sWLT38hT3IqSwgudm83ZCj89oRw1IK5vaw00RuW7eETV/Rttpw4MtJCZdE4nVVlNgeIJitLL7/b6/WTZv3i372ey9Bc7Dtv4Mt46i6QRF0+b919LrM0LCMkwPw8TzPikAJJk348F3+Iyw0IXoYTh4gTjAS2kzArD1M9p9Cxxs8De8axvs7Qz3d0aD0V4HA2gbuQ5FsZOmO/P5/DGwhzqPXx5VnqChOs0OzdCJVsUa84Osg6aX14no76Cy/wcq6uOgw0KKdl/Xgg0WX1vLtirl86+MmyoMrZUz7N+oZvMWmNSEcJD1m2RKJB547BNUsjEaeH3EwQ5hcjdNd1uYxI9pulMUO0sf8ecOIb71sSj6adpf6rlyOu5jwdI0Zquf135PU1YUxYbP7nvn825RrO6iXxQeNlK+vumT+4F0ts184jv8XqzScER34VvZCD0HSua0Nplz6/lo6bLJhPQNnqjYUgcN0yrnGq7RLjVCSdf78XkssFij2ZMdSyYgeQkcKtjXb7z2/sSTP26hOwF+uXvcys5wkkPvMGMapnDNSm4taEmTXfFcpM7ftkMf4JoXJZoAu389O0v/5Z93yQGBNr5leBIsFVOBfqDdv54e7vz3+ZoeVVmCTrgBlgOuZGIGNumz0wzysnFFzWaz/uypSTKlcueHem80TNy/F2r8/oLALfvclE/W7dSRRsvgR9JZtvcN2A7GuGFh5BqTn2iMeGg4oNvW2zu3XLe+x2d04yyBhI3Oe4LNp2dRwUkhQVKG5m9lM9Bn0Xk9xhn5kN4x9vwezJqJFHI+hny16d6MVn/O+VxVnr+DU6u7VU/RLbxhQyFk7beg7QziViO/Xmp0bYs1/O0Q0ubOcOUE9gwnwHJhguemi872aO/aIoejBOcaHgMLA9i4ptIHc0EN2P3YwEkif3Z3LIH9GHWs3YphtTtW6BxMGzE4RyGkKKqi9o9O6lkDygqve7TxhSMxaBBWaJ/uygr8+o4VvNt+wwJnckh+jOD/uEUz9T0+I1mxBNLtbPwxUqRzTz/SBXs3A4ZttRlwzbWMXd2FXDOf2cx9ffYGrzf0ybpB6GVLEigteuQeypo1yPe+ochn1fbDbaa8dq/PiPrWgPWJKdD3e+zb56OItL37L4hQO2Dfm1idU7Lg01ssd2r+jMjTw7PihOj1jjVMRJ63QoosfAqRHQzpQA6FD3v5YCJedeQIF9IqNAtC2LbXG8NEoRMcY5oYSsl4E3R0d4071nZc1EWilWYZN04HJ6UfjwuDtjaDwrvjXysLLhZnSiUNODIs1wDdxNJ6vSVffujW+POFDBvHYx0+nuE5+mbQPujhs/3OQe8POgc92HTQt9idSAIOF8FZB01TSzAQjYTvq3fTMt+HSRHZLyUGZ4L54bhJVXnKcnFJYZlUmDLncySLwOYeyuV433eZUqbp4UNuX/sNH3RDeUpjNO9Jv45sPNRjNnz+tH0a+y8ewQ2w5BjrHsZgb3e4v3urZ2zJn/PhSgVj9zk5cjnd6+SoZ3N0Ww/Wx3qwHofwnz6mAT98PurcO08HD2eAR7LT24xzh4X+GHb4oxnEbXa7pyn8u5mkD6e+vU+hnC+J4efDRxDDG3Twh1Liiqr9aLTHHkvPXkeA91C0b9WuH0ygbWA/OZHuP45SPhx0dLVvOqraN6M2Ue7v34so24suUdZZJP7z2zc/zgZ/+X6qDg8PD1+/fZe9fDc9PDws8He/319rj607bVoGdVj/uNDfy3THb1il3+8jClNu+QEN3y3l9F/d+HjzmL4PZH8iJ9H+Y8Rl1viCHi4F6q5/nOPn0/H5wziQ+f/OZBRHqqS3yUoepdFB5N45h1e/UUzWKhj7rUrn0cFN5F+i4Z/+nRcO3X1v8D31TWSSDAqOfwVTDl9gT0SOU+FjKtAmiiN6moDPsZH6ooNIjd9DYqMYw2Yl+jbA4Bw07uAm9HIvcKPYq+PRQeSoP4ojHzyqPzGQicJwcJlOokVY8Lap6i/NVIb+qJ9A4zz4yPUjp6Ghi6UX6B81U3uGRYPWZjKuNZ9Hy4/dw+vWEJp04+rne/k8XBLConelfnJJ3aI4EhaK9iobDk2rD8d0Agp3Qs+WPnQsHQsvPnhNHFdmSn7UQP+y5GOGvlfji48iRxzs/SBrzvqep+NaVxfuksohvteENGjFO83D45jR47/+XZQa+hOW+bS9pgt3rKx5sulBeusdrMnIFOZlCVz36V34R6ccUFYHz5OKEitqsdzZWQ1qvbPhIo6u797MNUvUTnjtzr7OYWJddJolSkvQT9pPXj6bzY329hZxNL97e/MvcnvP8fBmd+/uJ0oTaFIo/ghYn75YxFF2N6w/1IkMfyCwe88WzR27pEJcjFU6vwhya3FXx3CZYT9MqzmSb3QKuoWIsVI5cLmCiaOJCxQo9hVaPF/F7k0IvT8X2oSLjM3Q7awhAcxloadiQVYxr+u4x+nMvwnG+MJL/EBqmqnGBnvJMJ9xE46BWS2mU0DXue9Bg/0Le+CUHyb9SxU+CV6+UsOVUJUJ4KE/HW+XHNDLbTMQLu1DyGnXKmthh7z27b3326eDX/Bylfgk/83J8T1wSSbjDrNZ/bzf7dLNwd6cHGNWj5h49a/P3pkaEwG1vNOFoTrGrgQPL/9r2T53cXRwfk9Fm+2EGvo+n2aHrQKUCrMWotgl8GHKQZ3CtzJxk/aFR6Qqi6EL4ZMZjIXSdPBIUNSIPFHVfajyDkxyNq3o2aJFlg0pPvRyqcnKEdLlBpK9kVY6JCJ5ssCemCjY4ClgBTu15o8ZSOOGczbhxoKOMWsQMa8rtC7qKeG6BC1AJrAWBRoc6i4qvVZf6+Kgm+Ly7sdXPtkv7CEw5Rg50E0MKatKohrihDr1Kpzc8tZXFCXkDtAXmxTDVdWDEqS8K6QEbZREc0npKZfiV0fCpJGgtTWGjOeuqxcV6DJHeJDDu8AEWfvb3//RgmujprsKmFuBpym+q7sDQjIpHcGjpq+hRAmouhDhfKD/bfkSQOiIaS4KldaMZO5P48f0Es/UctGHAutQpKmSDA2LWt6aOMhY49VKQzYqGbIUSyxxv3AtjG0lD4Unvqvy4UdAPCYtGEgNQa5GmpfzNoM3IVK1NB2lOIlu4ll9Da7wAq+sutBQCHm/e6rtlbOqFgSVVQW3ImFhKtPvphO60E/g64J9HUBDarwSSj/ZwKo43YWSCVwIeQFXoO+h4L2unySlfI7EbWcAsg1bQJK7zpqUrxlm6XZw0rqdKLGxQ4z7MdJdAXoKFwmaKUR4cA889no4W6/HdhwsXqyaSnvXis+uJfmBoqSZHSHyeXP1g/Hmzm0nNffZD2qGOItZmQO+LEUz3s2PKGUEeerSsdsrJFxi4hx5dTBbDieuw2wFF7JZwkW66bxoN0fOCk+cZwdnwexRXCe+bU9BhNYv4TlmgIbVHUe4zaFbhfFcEUvZrJHDaReoI0r+y+gKoiNEV7BbJ2TkqpkE/dvf/tdQQB9TTRPMXz+abG6lUD/PjXKZhe1ZA0UHmu+Tg2qFpP3bgXXG7u0ejyBAnO5BeebFGB+w0AMI0qjoplGN06NrPX8y8/s2W9rH5beW9Bdkag4Hg//PlvTTwZdjSe8NviBL+gUC6533d0uTTdrtWtkRghG3D3ivwPk3c6Vv74m+/UVch07WIbhhh9HC/dcY/0GI3+EQcB6DJpjgjdmwGULDaDDA/y0JwU7JFDRt6nIq+fyfovj+kYzbz8B9xtjJbcj6Nhv9YEpZJJlTd4zpSvI1Q+7YQBtvQuZCwkVAysVoMLjYjxy+99Yh560qwF3sM7SmZlphZROv4Vg9Z3yKKgourx8RV6D1XVT1YZDdhoS9weBiWCNhfxUJR5IyNqiKzom6BPn77rS9vHXLI6jXRd6wdiRcJ2qPOpttf3ebNJBUWth5dHB6E13v8FLsuPaD0/PFOVKdzRTG+EplCGJus+gg2l0J+VEZIwwond5EZOBHQeQZLlN8w7Ii9ngpdq+G/WG0iJfHrBWTt/SHaudDhxjLp0JO7xp33uDoLZ6jO6oOphq9rhR/AVTs/EG0e8WRQPrJgKPFh6hH8vixCZS+DIccQpjropLNYS7HGUOYsRM5XL6u1sQCW6HA0xCHo9BaHVmLmg1FdfQrilrxLPzRilDhz1rpPW3IuQ7vBJ10SMrcaG+PtJ7nQ1IPnr6gm3fv2eLcIb/lz6WXz22npHuZ0/Gu+U9db1MULXl3Oi6WZQ/LRm/HBmeHX3LJqK8BWWdLow271oT1o1rmyhpUhhu6i0h82IKIfDogRO4NCJEvBh3lwG+/maG54uker69xuqvbVzXex+dIuEJOFFG9P+43Jci36CdFqURcs6LSQZ6ooi7t0uuFIb/9/R/1qF6vtiSdgxjNyTeVZqWagcaKZli3ZZLDtUCfAQ6DgtoM2b706J8XORiDYWlpYerKlWEKKDpnvfsv4SUfi1yg2HUP2+lZa0tymz77KQN8KYJNX2mXEXsFOUrr2uvSKszGZkpfTrD4W8w4G2PZJ/S7gcy4TJyLz4kQclWhCYnu01ILg9WsNEItHGxKWs0Tywou+ZR8TTFrIyuFXKCcZVqN0QNuVF45H6/lIlfaPUKkDdErEULiy+sSm0gvRabVkCFhX3lHr4mdo91JB18PbYwxjRJhEWh/W8UqmSssXYaxkSrPWamsi1eg+tuGEYdbzaVBndXBEs6gRpj3wYLxnox3BvCEXwl56crt7LDTmq5+grERFrrJuMvM+aQ75nthf6jGWMxLGWGVnjejp8Jm1ZjkfHuS+oeb6ftQ7q4lxZs5UpWYNYq8Sswu5g3vvgWLFGJ2D4+PSE94wn772/+wV8C1ZJmaOWpNKg35vKmsR4Xo6OQd2uprnrz8vMJqdpaIVE5D4Clg8KeMW3KbvIYZ+qccS7mXP8fVOBdJXbXQ9HoHrnJhqx5hN3nQpXNg6IWz0o3Ohbzss0M5J2dx4wXC7zSusw0KnGyoFFjXB2wgIvekgfwKTMsNBqlwAS2tqqlbrQ2M31w3uwX3dpimK8ki6AptwHHOG4okcefFwfp+a/JLOskj3bpUIFOqQGcOWKr5xDbzx0spLxRcWvkUsmUCOmI/TatEJGLS77j+6hxcSxpIV96S4wwXNJ3CjbwUnpxOA1mybpb7h5O1M/yk5Qnpv+EG5aVYGyzA+nvmzeQt6CuRgFfHNnD0LnXejeIoFwl4K9TfX4ffH79iV0/7gyhu6XX3YO7dV0ffvXz99iUCg4LUIWzYH/QH5CxTxhZctlbyfHLSKFpLj7Fq7X9bGXRbGXRbGXRbGXRbGXRbGXRbGXRbGXRbGXRbGXRlU9vKoNvKoNvKoNvKoNvKoNvKoNu6CtvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoNvKoI/qjtxWBt1WBt1WBt1WBt1WBt1WBt1WBn2APr6tDLqtDLqtDLqtDLqtDLqtDLqtDLquMmgrQ2m3zLmgDERf8cclD54u1ws9j6MMswsPTqObG6TAdzpfLPDzLxUlS52ex9EV1wIfgVFiYhzy6DAn6hIwn+o796Zt5wTXj92B0zv0pXxMTAR0Iw4JB7f2bSdAHr95exLF0djXNC1USgnNfIY5VHzmcsxaiVb07SbKuZxWlKQVuTkXrvxL1s0bvKS8Qf9HK9ML8+saCLsJhW4b+C9uau2AmxuXk7hY1P1d08YRHrGhN57f+WKx+D9KyU4A",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.1bbc46c2.js b/assets/js/9cd612ce.1bbc46c2.js new file mode 100644 index 000000000..71a2a119a --- /dev/null +++ b/assets/js/9cd612ce.1bbc46c2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>f,default:()=>h,frontMatter:()=>w,metadata:()=>n,toc:()=>S});const n=JSON.parse('{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/v1.1/deletefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletefolder","permalink":"/docs/API-docs/v1.1/deletefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar_label":"Delete Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V0tvI8cR/ivlvsRLjEhKKzvJnCLYylqxsitYMgRESwjNmZqZNnu62901pAiCgA/5Bznlmp+2vySongdJPTaRHeQicbq63l89eiNIlkGkd+LPVufoxSwROYbMK0fKGpGKmwohR42E0F6Bs6sLkFrbVYC1bYBsTy8ifSwSYR16yQIucpGKltxSRSKc9LJGQs96N8LIGkUqWvK9ykUiFCt2kirx2Bo7/wkzusjBFjAI9PhzozzmIiXfYCICrTWLDKp2GkUi8MFpm6NIC6kDX8gqrKVIN4LWLt4kr0wpElFYX0vaP8EHGaWkYv79cVbkJ5Wbi+12xmqDsyZgYEEn0yn/O7Q2NFmGIRSNhiEiIhGZNYSG+L50TqssEiY/BWbaPLWudZoj51kMqVZlH4vX+vHdIpz8xeHqwolt0iUnP6PnxOyYTqYnb4+Op0fT398cf52e/jH96uvxdDr9m0jEQ62Zt8tjLglZLinSu++9A2W0MnjfR+/+ZDq9Pz4R2y1fOn0ujEddqkEFMJYAa0frBDiMUpkAuc2aGg2B9T0GP5ojuLY1UqVMCSsmrrw1ZQJOowwI5NcgS6kMaEnov/j4mxJjDX4oIpoPU4TeW//5wL7aNY5U8isUvSocrGT2cs5Op9P7t0PKTp+mrPOKXSpsY/Lx/w72L7r6Ocw/tedzkDydnt7/YXDvq6fuXZil1CqPrZDsAs0X/wf/dt48o55NPSxE1V6KdHHg7P5562TArPGK1hHCD0fSqaOWnt7NGAeMHLtr5bGJUyVSMWkDO9kM7XsrWJxf9u39MHDXK1mW6L9r5tH4s4Ys/NVmi9bDxmuRiorIhXQyWSpPraRxaNmqZj7ObD258rJotH4vlwvpJ9ahmRyPp+Op4MI4FBKkyef2YcyXgiqNlvMQZUinJsvj8fEzPNK5V93H5ui1LIFkqUz5n/hmu9RcM3xahBwkaMCJdOp7XIukz//+rW6kVih5YnLGlSlsZO5Q8cGhuValiWmJyh+P3lvUma2R5z1VCKNRz/Lp7/8auEajoWVF9I8/mo/mQ+PB2RV6HoTS5FBofFBzjZEN60gblomAstYYgl6DMoSll4SQq1KR1MBx4haWSSfnSisuGr5mmdvDXt2FMdxWSBV6Jv3OI0jIcYmaaw1kQ7aWxKKGFruyflHwWpOAhHkTlMEQAE0lTcYX+0wk3IylATSE3nkVEAJ5tlq1tllDXmYEtTSyRJadwH6wctSK6wO8nTeBIFjdRJOBpNLWYw69QwYxDzGI57zDeAQ+zWztPFYMmyVC2agcAw+NHCHEHsEumBzmGAgc26IyDCy0Mdpmi5hAriBwlluWkpoXqn0bmZ28NIG7amtLn4MhYM5bXm+wNXA0+jEgZ/hSmUVIRyOewXcDrm5xHhTh7Mu+BFar1RPovznkeaeIO8UP6GxQZP16x10q6rvBvpDho5X0Dg1G/OwVw05GbrPwtPr4dFKhdpNrJEZImJxdXdww6xv49Ms/4BKlN1DZVYvWrPGo11D2qjhybebbsA1NGgobgVdxxLMWfLy6YqA+greVpE+//DPAe1yBMl1JsSuj0VUz1yqDG6wdz+gwGqXwjUdWSf0ZUCUJMmlgjhAqyVBaKgkSXMutlVmM4cysoQnoYaWoimDg88h34AbHZUh3gLkMmIM1kaPXOd5ZxOd1QL3EwLJ42M4RMFfEiK68bcpW274xnXMeC6U13Kq8RIq+neU5uO541R7Ht8bOHCy4IKjCNUiPENDQGK4esURK45z1bIVqjS8sv184AWhyZ5WhkELuZUE7+ckO6BmHWVnzzFEbQjmEI+nEDClpK7HzeDgdx33zUSM/7LceC/SsMLq9y4tTHZzuelgCo/W3wJrXg7hyZnF7wVoq3U6UPz2WEzcJ9HX4UFyjX6oMu6n2QkVP4uWJSIRWGZqAexvK2burS1i+HU8PRv9/UdyTy4tvzt9fn7Mx3EjbgPUrgHA2UC3NnqZv9x+wjyfbZre5/brXbjeACR9o4rRUcd2KDm26PelODI/VdPfQnSWisoGYvNlwcf3o9XbLxz836HkZmyViKb2Sc57RvEypwL/z4SX7oiNf/tA9it/As2/mZ23uNwnDa8RS6oa/RCIWuD54oW9n26RfJtisln6WZehoj/PJFnywSn57fnl+cy4SwS3xcI9ZxD2m+8EKnjXscMFpbeC/vG09y7DZtDvSdjvcb0kvcnQ+9rc5SrPtdvtvYtAJww==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.1/folderlist"}}');var l=o(74848),r=o(28453),i=o(33617),s=o.n(i),d=o(17543),a=o.n(d),p=o(86013),c=o.n(p),m=o(63723),y=o.n(m),u=(o(18766),o(79329),o(9303));const w={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V0tvI8cR/ivlvsRLjEhKKzvJnCLYylqxsitYMgRESwjNmZqZNnu62901pAiCgA/5Bznlmp+2vySongdJPTaRHeQicbq63l89eiNIlkGkd+LPVufoxSwROYbMK0fKGpGKmwohR42E0F6Bs6sLkFrbVYC1bYBsTy8ifSwSYR16yQIucpGKltxSRSKc9LJGQs96N8LIGkUqWvK9ykUiFCt2kirx2Bo7/wkzusjBFjAI9PhzozzmIiXfYCICrTWLDKp2GkUi8MFpm6NIC6kDX8gqrKVIN4LWLt4kr0wpElFYX0vaP8EHGaWkYv79cVbkJ5Wbi+12xmqDsyZgYEEn0yn/O7Q2NFmGIRSNhiEiIhGZNYSG+L50TqssEiY/BWbaPLWudZoj51kMqVZlH4vX+vHdIpz8xeHqwolt0iUnP6PnxOyYTqYnb4+Op0fT398cf52e/jH96uvxdDr9m0jEQ62Zt8tjLglZLinSu++9A2W0MnjfR+/+ZDq9Pz4R2y1fOn0ujEddqkEFMJYAa0frBDiMUpkAuc2aGg2B9T0GP5ojuLY1UqVMCSsmrrw1ZQJOowwI5NcgS6kMaEnov/j4mxJjDX4oIpoPU4TeW//5wL7aNY5U8isUvSocrGT2cs5Op9P7t0PKTp+mrPOKXSpsY/Lx/w72L7r6Ocw/tedzkDydnt7/YXDvq6fuXZil1CqPrZDsAs0X/wf/dt48o55NPSxE1V6KdHHg7P5562TArPGK1hHCD0fSqaOWnt7NGAeMHLtr5bGJUyVSMWkDO9kM7XsrWJxf9u39MHDXK1mW6L9r5tH4s4Ys/NVmi9bDxmuRiorIhXQyWSpPraRxaNmqZj7ObD258rJotH4vlwvpJ9ahmRyPp+Op4MI4FBKkyef2YcyXgiqNlvMQZUinJsvj8fEzPNK5V93H5ui1LIFkqUz5n/hmu9RcM3xahBwkaMCJdOp7XIukz//+rW6kVih5YnLGlSlsZO5Q8cGhuValiWmJyh+P3lvUma2R5z1VCKNRz/Lp7/8auEajoWVF9I8/mo/mQ+PB2RV6HoTS5FBofFBzjZEN60gblomAstYYgl6DMoSll4SQq1KR1MBx4haWSSfnSisuGr5mmdvDXt2FMdxWSBV6Jv3OI0jIcYmaaw1kQ7aWxKKGFruyflHwWpOAhHkTlMEQAE0lTcYX+0wk3IylATSE3nkVEAJ5tlq1tllDXmYEtTSyRJadwH6wctSK6wO8nTeBIFjdRJOBpNLWYw69QwYxDzGI57zDeAQ+zWztPFYMmyVC2agcAw+NHCHEHsEumBzmGAgc26IyDCy0Mdpmi5hAriBwlluWkpoXqn0bmZ28NIG7amtLn4MhYM5bXm+wNXA0+jEgZ/hSmUVIRyOewXcDrm5xHhTh7Mu+BFar1RPovznkeaeIO8UP6GxQZP16x10q6rvBvpDho5X0Dg1G/OwVw05GbrPwtPr4dFKhdpNrJEZImJxdXdww6xv49Ms/4BKlN1DZVYvWrPGo11D2qjhybebbsA1NGgobgVdxxLMWfLy6YqA+greVpE+//DPAe1yBMl1JsSuj0VUz1yqDG6wdz+gwGqXwjUdWSf0ZUCUJMmlgjhAqyVBaKgkSXMutlVmM4cysoQnoYaWoimDg88h34AbHZUh3gLkMmIM1kaPXOd5ZxOd1QL3EwLJ42M4RMFfEiK68bcpW274xnXMeC6U13Kq8RIq+neU5uO541R7Ht8bOHCy4IKjCNUiPENDQGK4esURK45z1bIVqjS8sv184AWhyZ5WhkELuZUE7+ckO6BmHWVnzzFEbQjmEI+nEDClpK7HzeDgdx33zUSM/7LceC/SsMLq9y4tTHZzuelgCo/W3wJrXg7hyZnF7wVoq3U6UPz2WEzcJ9HX4UFyjX6oMu6n2QkVP4uWJSIRWGZqAexvK2burS1i+HU8PRv9/UdyTy4tvzt9fn7Mx3EjbgPUrgHA2UC3NnqZv9x+wjyfbZre5/brXbjeACR9o4rRUcd2KDm26PelODI/VdPfQnSWisoGYvNlwcf3o9XbLxz836HkZmyViKb2Sc57RvEypwL/z4SX7oiNf/tA9it/As2/mZ23uNwnDa8RS6oa/RCIWuD54oW9n26RfJtisln6WZehoj/PJFnywSn57fnl+cy4SwS3xcI9ZxD2m+8EKnjXscMFpbeC/vG09y7DZtDvSdjvcb0kvcnQ+9rc5SrPtdvtvYtAJww==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,v={},S=[];function I(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,l.jsx)(s(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,l.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(a(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,l.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(y(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_12"}}}},400:{description:"- folder is not empty, contains document or folder.\n- Something went wrong, please try again later!\n",content:{"application/json":{schema:{type:"object",oneOf:[{properties:{error:{type:"string",example:"folder is not empty, contains document or folder."}}},{properties:{error:{type:"string",example:"Something went wrong, please try again later!"}}}],title:"inline_response_400_3"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.b75be620.js b/assets/js/9cd612ce.b75be620.js deleted file mode 100644 index e41578926..000000000 --- a/assets/js/9cd612ce.b75be620.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>b,default:()=>S,frontMatter:()=>u,metadata:()=>n,toc:()=>D});const n=JSON.parse('{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/v1.1/deletefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletefolder","permalink":"/docs/API-docs/v1.1/deletefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar_label":"Delete Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uIzcSfpUKL5sR2pLscbKbPq2ROBMnRsaIHRiIRzDY3dVqxmySQ1ZLFgQBOewb7CnXPNo8yaLYP5L8MxsnQS62uor1/7GquBYk50GkN+Jrqwv0YpaIAkPulSNljUjFVYVQoEZCaI/AycUZSK3tMsDKNkC255eRPxaJsA69ZAVnhUhFy265IhFOelkjoWe7a2FkjSIVLftWFSIRig07SZV46I3NfsaczgqwJQwKPb5vlMdCpOQbTESglWaVQdVOo0gE3jttCxRpKXXgA3mFtRTpWtDKxZPklZmLRJTW15J2KXgvo5ZUZN8d5mVxVLlMbDYzNhucNQEDKzqaTvnfvrehyXMMoWw0DBkRicitITTE56VzWuWRMfk5sND6sXdt0Jw5z2pItSb7XLw0jm/uwtG3DpdnTmySrjjFCT2lZit0ND16fXA4PZj+8+rw8/T4i/Szz8fT6fQnkYj7WrNsV8dCErJeUqS33zsEZbQyeNtn7/ZoOr09PBKbDR86fiqNB12pQQUwlgBrR6sEOI1SmQCFzZsaDYH1PQbfmQO4tDVSpcwclsxcemvmCTiNMiCQX4GcS2VAS0L/ybs/VRhr8G0Z0bxfIvTe+o8n9sWhcaaSP2DoRelgI7Pna3Y8nd6+Hkp2/LhkXVQcUmkbU4z/Otg/G+rHMP/Yn49B8nh6fPuvIbzPHod3ZhZSqyK2QrJ3aD75G+LbRvOEeXZ1/yKq9lDki71gd+ltkAHzxitaRQjfH0inDlp+ejNjHDBy7LaVxyZOlUjFpE3sZD20741gdX7Rt/fGa5GKisiFdDIJ0hSZvR9bhyaoudEyC+Pc1hPp1GRxOD4UjO19Genci85jc/BSkUByrsz8/8nNtpm65Gq2BdvL11A26dR3uBJJX47dU92Eq1DyAOMCKFPaKNwV6a1Dc6nmJpY4Gn84Ca9R57ZGHr9UIYxGvciH//w2SI1GQweJYBy/M+/M28aDs0v0PJekKaDUeK8yjVEM68gbZntAWWsMQa9AGcK5l4RQqLkiqYHzxB0ll05mSivGMB+zLO1h5xqEMVxXSBV6Zv3DI0gocIGaoQ+yIVtLYlVDx1taf1fylpGAhKwJymAIgKaSJueDfSUS7o3SABpC77wKCIE8e61a36whL3OCWho5R9adwG6yCtSK4QreZk0gCFY30WUgqbT1WEAfkEEsQkziKa8UHoGpua2dx4phs0CYN6rAwD28QAjxynIIpoAMA4FjX1SOgZU2Rtv8LhawbLQGZ7mDKKl5v9n1kcXJSxO4ybW+9DUYEua85W0DWwdHox8DcoXPlbkL6WjEI/FmwNU1ZkERzj7tr8ByuXwE/Vf7Mm8UfdNk8AM6GxRZv9pKzxVVTRavy66S4aPV9AYNRvzsXIatjsLm4fHtY+qkQu0ml0iMkDA5uTi7YtFX8OGX/8I5Sm+gsssWrXnjUa9g3pvizLWVb9M29EwobQRexRnPW/DxJomB+gxeV5I+/PJrgO9xCcp0V4pDGY0umkyrHK6wdjwyw2iUwpce2ST1NKBKEuTSQIYQKslQWigJElwrrZW5G8OJWUET0MNSURXBwPQotxcG52Uod4BMBizAmijR2xxvPWJ6HVAvMLAunn0ZAhaKGNGVt828tbbrTBecx1JpDdeqmCPF2E6KAlxHXrbkuPpv3cGSLwRVuALpEQIaGsPFA5HIaZyznr1QrfOl5ecEFwBN4awyFFIovCxpqz/ZAj3nNCtrniC1KZRDOpJOzVCS9iZ2EQ/UcVz/HjTy/X7rsUTPBmPY27o41cHppoclMFr/DKx5WscNMI/LBNZS6Xai/PuhnjjY0dfhbXmJfqFy7KbaMzd6Eg9PRCK0ytEE3FkYTt5cnMPi9Xgqkp3x+Dsu9+T87MvT7y9P2RlupG3CDsfT8ZRJzgaqpdmx9NXue/LhZFtvF6k/9vjsBjDhPU2clipuPzGgdbe23Ijh7Zhu352zRFQ2ELPXa75cP3q92TD5fYOed6NZIhbSK5nxjL5Zi0IF/l0MD8tnA/n0h+6N+gqefMI+6XO/SRheIxZSN/wlEnGHq70H82a2Sfplgt1q+Sd5jo52JB8tpXub3Ven56dXpyIR3BL395i7uMd0P9jAk47tLzitD/yXt60nBdbrdkfabIbzLetZiS7G/jRnabbZbP4H92LiCQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.1/folderlist"}}');var l=o(74848),i=o(28453),a=o(33617),s=o.n(a),d=o(17543),r=o.n(d),p=o(86013),c=o.n(p),f=o(63723),m=o.n(f),I=(o(18766),o(79329),o(9303));const u={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uIzcSfpUKL5sR2pLscbKbPq2ROBMnRsaIHRiIRzDY3dVqxmySQ1ZLFgQBOewb7CnXPNo8yaLYP5L8MxsnQS62uor1/7GquBYk50GkN+Jrqwv0YpaIAkPulSNljUjFVYVQoEZCaI/AycUZSK3tMsDKNkC255eRPxaJsA69ZAVnhUhFy265IhFOelkjoWe7a2FkjSIVLftWFSIRig07SZV46I3NfsaczgqwJQwKPb5vlMdCpOQbTESglWaVQdVOo0gE3jttCxRpKXXgA3mFtRTpWtDKxZPklZmLRJTW15J2KXgvo5ZUZN8d5mVxVLlMbDYzNhucNQEDKzqaTvnfvrehyXMMoWw0DBkRicitITTE56VzWuWRMfk5sND6sXdt0Jw5z2pItSb7XLw0jm/uwtG3DpdnTmySrjjFCT2lZit0ND16fXA4PZj+8+rw8/T4i/Szz8fT6fQnkYj7WrNsV8dCErJeUqS33zsEZbQyeNtn7/ZoOr09PBKbDR86fiqNB12pQQUwlgBrR6sEOI1SmQCFzZsaDYH1PQbfmQO4tDVSpcwclsxcemvmCTiNMiCQX4GcS2VAS0L/ybs/VRhr8G0Z0bxfIvTe+o8n9sWhcaaSP2DoRelgI7Pna3Y8nd6+Hkp2/LhkXVQcUmkbU4z/Otg/G+rHMP/Yn49B8nh6fPuvIbzPHod3ZhZSqyK2QrJ3aD75G+LbRvOEeXZ1/yKq9lDki71gd+ltkAHzxitaRQjfH0inDlp+ejNjHDBy7LaVxyZOlUjFpE3sZD20741gdX7Rt/fGa5GKisiFdDIJ0hSZvR9bhyaoudEyC+Pc1hPp1GRxOD4UjO19Genci85jc/BSkUByrsz8/8nNtpm65Gq2BdvL11A26dR3uBJJX47dU92Eq1DyAOMCKFPaKNwV6a1Dc6nmJpY4Gn84Ca9R57ZGHr9UIYxGvciH//w2SI1GQweJYBy/M+/M28aDs0v0PJekKaDUeK8yjVEM68gbZntAWWsMQa9AGcK5l4RQqLkiqYHzxB0ll05mSivGMB+zLO1h5xqEMVxXSBV6Zv3DI0gocIGaoQ+yIVtLYlVDx1taf1fylpGAhKwJymAIgKaSJueDfSUS7o3SABpC77wKCIE8e61a36whL3OCWho5R9adwG6yCtSK4QreZk0gCFY30WUgqbT1WEAfkEEsQkziKa8UHoGpua2dx4phs0CYN6rAwD28QAjxynIIpoAMA4FjX1SOgZU2Rtv8LhawbLQGZ7mDKKl5v9n1kcXJSxO4ybW+9DUYEua85W0DWwdHox8DcoXPlbkL6WjEI/FmwNU1ZkERzj7tr8ByuXwE/Vf7Mm8UfdNk8AM6GxRZv9pKzxVVTRavy66S4aPV9AYNRvzsXIatjsLm4fHtY+qkQu0ml0iMkDA5uTi7YtFX8OGX/8I5Sm+gsssWrXnjUa9g3pvizLWVb9M29EwobQRexRnPW/DxJomB+gxeV5I+/PJrgO9xCcp0V4pDGY0umkyrHK6wdjwyw2iUwpce2ST1NKBKEuTSQIYQKslQWigJElwrrZW5G8OJWUET0MNSURXBwPQotxcG52Uod4BMBizAmijR2xxvPWJ6HVAvMLAunn0ZAhaKGNGVt828tbbrTBecx1JpDdeqmCPF2E6KAlxHXrbkuPpv3cGSLwRVuALpEQIaGsPFA5HIaZyznr1QrfOl5ecEFwBN4awyFFIovCxpqz/ZAj3nNCtrniC1KZRDOpJOzVCS9iZ2EQ/UcVz/HjTy/X7rsUTPBmPY27o41cHppoclMFr/DKx5WscNMI/LBNZS6Xai/PuhnjjY0dfhbXmJfqFy7KbaMzd6Eg9PRCK0ytEE3FkYTt5cnMPi9Xgqkp3x+Dsu9+T87MvT7y9P2RlupG3CDsfT8ZRJzgaqpdmx9NXue/LhZFtvF6k/9vjsBjDhPU2clipuPzGgdbe23Ijh7Zhu352zRFQ2ELPXa75cP3q92TD5fYOed6NZIhbSK5nxjL5Zi0IF/l0MD8tnA/n0h+6N+gqefMI+6XO/SRheIxZSN/wlEnGHq70H82a2Sfplgt1q+Sd5jo52JB8tpXub3Ven56dXpyIR3BL395i7uMd0P9jAk47tLzitD/yXt60nBdbrdkfabIbzLetZiS7G/jRnabbZbP4H92LiCQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,x={},D=[];function y(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,l.jsx)(s(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,l.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(r(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,l.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_12"}}}},400:{description:"- folder is not empty, contains document or folder.\n- Something went wrong, please try again later!\n",content:{"application/json":{schema:{type:"object",oneOf:[{properties:{error:{type:"string",example:"folder is not empty, contains document or folder."}}},{properties:{error:{type:"string",example:"Something went wrong, please try again later!"}}}],title:"inline_response_400_3"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function S(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.403772ac.js b/assets/js/ac7da374.403772ac.js new file mode 100644 index 000000000..3879ddf29 --- /dev/null +++ b/assets/js/ac7da374.403772ac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>x,contentTitle:()=>f,default:()=>T,frontMatter:()=>I,metadata:()=>a,toc:()=>k});const a=JSON.parse('{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/v1.1/delete-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-template","permalink":"/docs/API-docs/v1.1/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV91u3MYVfpWTuWm8oHZXtuIivKoaC45QxRYiBQIqL4RZ8pCc7HBmMnO4q8WCQC76Br3qbR/NTxKcIbl/kp0aLYLe2NrD8//7zUaQLINI78Ut1k5LwiBmicgxZF45UtaIVNxWCG9QIyEMXHB+fQnO26XKMcDaNrBSVAFVCHKutKI1kAWPtV0iSAgOM1WoDGiQL7ytI/tACWO4LEDuOFQAY0FbU6IHg5hjLhJhHXrJfl3mIhV59GpwSiTCSS9rJPQc00YYWaNIxaDzQbEKxTE5SZU4DvTyDdjiwCugSlK0HjigOUJnkvV4/KVRHnORkm8wEYHWmq0FVTvNzuCj0zZHkRZSB2bIKqylSDeC1i5yklemFIkorK8l7ShtO2P9wVkTMLDEy+mU/zsqzOBl7xSEJsswhKLRev2VSERmDaEhlpTOaZXF1E1+Diy+eeqQnf+MGXEePSeaVGe8I3PGn7qOjzKGm4q/PlYvZXDfu1eiTfrS5Of0eaGX05evTk6nJ9M/356+Ts++Tb95PZ5Op38XiXisNcv2Ncy5wG0iSJHe/W6fsEWzB4w9pWXms+fSeGNrpEqZElZoCFbemjIBp1EGBPJrkKVUBjjT/n+YVfTe+s9n58s8a/eiVkYrgw9DDz2cTacPp9sknH2ml4wlKGxj8j821Ofsfz6gs4fX24C+eRrQpVlKrfK4qW7tAs0fG8++eerMP+1W1THF7+Ig2H16F2TArPGK1nGxPZ5Ip0667+n9jNcFd4rdLcW4DKkSqZgMy2yy2VuErWCVfjmsyqORWMmyRP99M48BnDdk4QebLbooG69FKioiF9LJZKk8dZrGoROrmvk4s/Xk2kteRe/kciH9xDo0k9PxdDwVbbI5UhKkyef2ccxMQZVGy3mIOqRTk+Xp+PQZGencF/Fjc/KlIoFkqUz5e3KzXXluuIW6Ljko0rZXpFN/w7VIhh7Y5+qPU4UyRx/7RZnCRuG+M947NDeqNLEs0fjxEbtDndka+VzxJRuNBpGP//j3Vmo0gtxmTY2G4gSMP5gP5n3jwdkV+qLRIE0OhcZHNdfdtcc6fuuuPVkIKGuNIeg1KENY+niIVKlIauA88drKpOvwgMLAbJalPezNXhjDXYVUoedPf/IMF3JcouZ5A9mQrSWxqsFfWFm/KLRdhQQkzJugDIYAaCppMmYcKpGA9SANoCH0zquAEMiz16rzzRryMiOopZElsu4E9pOVo1Y8H+DtvAkEweomugwklbYecxgCigghJvGCj75HYGpma+ex4rZZIpQNg6UEMpsjhLgnOASTwxwDgWNfVIYRaDRG22wRC8gTBM7y2lJSM0DZ95HFyUsTGEJ0vgw12CbMecuoADsHR6OfAnKFr5RZhHQ0+mBO4H7bV3c4D4pw9vUwAqvV6knrvziUeauIN8WP6GxQZP16J10qGrbBvpLtj07TWzQY+2dvGHY6cpuFp9PH1EmF2k1ukLhDwuT8+jJu+hfw8dd/whVKb6Cyq65bs8ajXkM5mOLMdZXv0rZd1FDY2HgVZzzrmo+xHgYaMnhXSfr4678CvMMVKNOPFIcyGl03c62yLVIOo1EK33mMYHKgdbAyk4YRZagkt9JSSZDgOmmtzGIM52YNTUC/A9dMj3IHYXBetuUOMJcBc7DmAMmOdx4xvQ6olxhYFx/cOQLmiiEkVd42ZWdt35k+OI+F0hruVF4ixdjO8xxcT151ZE74njtY8EBQhWuQHiGgoTFcH4nEL41z1rMXqnO+sFrbFRcATe6sMhRSyL0saKc/2TV6xmlW1jxD6lK4e14kvZptSbpJ7CPePUo+8FI+WuSH+9ZjgZ4NxrB3dXGqb6f7oS2Bu/W/aWuGCLy1ZBYRDNZS6e6i/OVYT0QT6OvwvrhBv1QZ9lftExM9icwTkQitMjQB91DK+dvrK1i+Gk8PTv9/MNyTq8vvLt7dXLAzvEi7hA0QQDgbqJZmz9LRK/P4tm12+O3/6lHaX3bCR5o4LVXEcjFTmx6E3W/foCIR6f57dJaIygZils2GJ/cnr9uWyb806BntzRKxlF7JOQMARmoq8N/59l35yRx9/WP/RH0BX/a0fTagAb8YBi9LqRv+JRKxwPXRG7udtckAYtjjjuM8y9DRnuwTBH4AY99cXF3cXohE8Co+xE+LiJ/6P9jAs64dAqvOB/6XUd6zAptNh83adsvfffqkRB/jwM15mrVt+xunERfw","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"}}');var l=i(74848),n=i(28453),o=i(33617),p=i.n(o),s=i(17543),r=i.n(s),d=i(86013),m=i.n(d),c=i(63723),u=i.n(c),h=(i(18766),i(79329),i(9303));const I={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV91u3MYVfpWTuWm8oHZXtuIivKoaC45QxRYiBQIqL4RZ8pCc7HBmMnO4q8WCQC76Br3qbR/NTxKcIbl/kp0aLYLe2NrD8//7zUaQLINI78Ut1k5LwiBmicgxZF45UtaIVNxWCG9QIyEMXHB+fQnO26XKMcDaNrBSVAFVCHKutKI1kAWPtV0iSAgOM1WoDGiQL7ytI/tACWO4LEDuOFQAY0FbU6IHg5hjLhJhHXrJfl3mIhV59GpwSiTCSS9rJPQc00YYWaNIxaDzQbEKxTE5SZU4DvTyDdjiwCugSlK0HjigOUJnkvV4/KVRHnORkm8wEYHWmq0FVTvNzuCj0zZHkRZSB2bIKqylSDeC1i5yklemFIkorK8l7ShtO2P9wVkTMLDEy+mU/zsqzOBl7xSEJsswhKLRev2VSERmDaEhlpTOaZXF1E1+Diy+eeqQnf+MGXEePSeaVGe8I3PGn7qOjzKGm4q/PlYvZXDfu1eiTfrS5Of0eaGX05evTk6nJ9M/356+Ts++Tb95PZ5Op38XiXisNcv2Ncy5wG0iSJHe/W6fsEWzB4w9pWXms+fSeGNrpEqZElZoCFbemjIBp1EGBPJrkKVUBjjT/n+YVfTe+s9n58s8a/eiVkYrgw9DDz2cTacPp9sknH2ml4wlKGxj8j821Ofsfz6gs4fX24C+eRrQpVlKrfK4qW7tAs0fG8++eerMP+1W1THF7+Ig2H16F2TArPGK1nGxPZ5Ip0667+n9jNcFd4rdLcW4DKkSqZgMy2yy2VuErWCVfjmsyqORWMmyRP99M48BnDdk4QebLbooG69FKioiF9LJZKk8dZrGoROrmvk4s/Xk2kteRe/kciH9xDo0k9PxdDwVbbI5UhKkyef2ccxMQZVGy3mIOqRTk+Xp+PQZGencF/Fjc/KlIoFkqUz5e3KzXXluuIW6Ljko0rZXpFN/w7VIhh7Y5+qPU4UyRx/7RZnCRuG+M947NDeqNLEs0fjxEbtDndka+VzxJRuNBpGP//j3Vmo0gtxmTY2G4gSMP5gP5n3jwdkV+qLRIE0OhcZHNdfdtcc6fuuuPVkIKGuNIeg1KENY+niIVKlIauA88drKpOvwgMLAbJalPezNXhjDXYVUoedPf/IMF3JcouZ5A9mQrSWxqsFfWFm/KLRdhQQkzJugDIYAaCppMmYcKpGA9SANoCH0zquAEMiz16rzzRryMiOopZElsu4E9pOVo1Y8H+DtvAkEweomugwklbYecxgCigghJvGCj75HYGpma+ex4rZZIpQNg6UEMpsjhLgnOASTwxwDgWNfVIYRaDRG22wRC8gTBM7y2lJSM0DZ95HFyUsTGEJ0vgw12CbMecuoADsHR6OfAnKFr5RZhHQ0+mBO4H7bV3c4D4pw9vUwAqvV6knrvziUeauIN8WP6GxQZP16J10qGrbBvpLtj07TWzQY+2dvGHY6cpuFp9PH1EmF2k1ukLhDwuT8+jJu+hfw8dd/whVKb6Cyq65bs8ajXkM5mOLMdZXv0rZd1FDY2HgVZzzrmo+xHgYaMnhXSfr4678CvMMVKNOPFIcyGl03c62yLVIOo1EK33mMYHKgdbAyk4YRZagkt9JSSZDgOmmtzGIM52YNTUC/A9dMj3IHYXBetuUOMJcBc7DmAMmOdx4xvQ6olxhYFx/cOQLmiiEkVd42ZWdt35k+OI+F0hruVF4ixdjO8xxcT151ZE74njtY8EBQhWuQHiGgoTFcH4nEL41z1rMXqnO+sFrbFRcATe6sMhRSyL0saKc/2TV6xmlW1jxD6lK4e14kvZptSbpJ7CPePUo+8FI+WuSH+9ZjgZ4NxrB3dXGqb6f7oS2Bu/W/aWuGCLy1ZBYRDNZS6e6i/OVYT0QT6OvwvrhBv1QZ9lftExM9icwTkQitMjQB91DK+dvrK1i+Gk8PTv9/MNyTq8vvLt7dXLAzvEi7hA0QQDgbqJZmz9LRK/P4tm12+O3/6lHaX3bCR5o4LVXEcjFTmx6E3W/foCIR6f57dJaIygZils2GJ/cnr9uWyb806BntzRKxlF7JOQMARmoq8N/59l35yRx9/WP/RH0BX/a0fTagAb8YBi9LqRv+JRKxwPXRG7udtckAYtjjjuM8y9DRnuwTBH4AY99cXF3cXohE8Co+xE+LiJ/6P9jAs64dAqvOB/6XUd6zAptNh83adsvfffqkRB/jwM15mrVt+xunERfw",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,x={},k=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,l.jsx)(p(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,l.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(r(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,l.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function T(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.4a1b8c9b.js b/assets/js/ac7da374.4a1b8c9b.js deleted file mode 100644 index f38eb6e75..000000000 --- a/assets/js/ac7da374.4a1b8c9b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>h,contentTitle:()=>g,default:()=>S,frontMatter:()=>f,metadata:()=>a,toc:()=>y});const a=JSON.parse('{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/v1.1/delete-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-template","permalink":"/docs/API-docs/v1.1/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV19v47gR/ypTvvTWUGxnN7dF9dT0NtgLGtwGlxwCNGsEtDSSeKFIHjmyYxgC7qHfoE997UfbT1IMJdmyk9120eLQl8Qazv8Zzvy4FSTLINJ7cYu105IwiEUicgyZV46UNSIVtxXCO9RICAMXnF9fgvN2pXIMsLENrBVVQBWCXCqtaANkwWNtVwgSgsNMFSoDGuQLb+vIPlDCFC4LkHsOFcBY0NaU6MEg5piLRFiHXrJfl7lIRR69GpwSiXDSyxoJPce0FUbWKFIx6HxQrEJxTE5SJY4DvXwHtjjwCqiSFK0HDmiJ0JlkPR5/aZTHXKTkG0xEoI1ma0HVTrMz+OS0zVGkhdSBGbIKaynSraCNi5zklSlFIgrra0l7StsuWH9w1gQMLPF6Pud/R4UZvOydgtBkGYZQNFpvficSkVlDaIglpXNaZTF1s58Di2+fO2SXP2NGnEfPiSbVGe/InPHnruOTjOGm4s9P1WsZ3PfujWiTvjT5OX1Z6PX89ZuT0/nJ/A+3p2/Tsz+m376dzufzv4pEPNWaZfsa5lzgNhGkSO+/22ds0ewBY09pmfnspTTe2BqpUqaENRqCtbemTMBplAGB/AZkKZUBzrT/H2YVvbf+y9n5Os/aUdTKaGXwYeihh7P5/OF0l4SzL/SSsQSFbUz+24b6kv0vB3T28HYX0LfPA7o0K6lVHifVrX1E89vGMzZPnfnn3ao6pnguDoId07sgA2aNV7SJg+3pRDp10p2n9wseF9wpdj8U4zCkSqRiNgyz2XY0CFvBKv1qGJWN1yIVFZEL6WwWpMmX9mlqHZqgSqPlMkwzW8+kU7PV6fRUtMmxjHTuq/ixOflakUCyVKb8d3KLfbZuuKJd0Q5ytiuddOovuBHJUJIxV78rKpQ5+lg+ZQobhftCfXBoblRpYpmj8eOdcoc6szXy9uDFMpkMIp/+9s+d1GQCuc2aGg3Fhpx+NB/Nh8aDs2v0RaNBmhwKjU9qqbvli3U865YvWQgoa40h6A0oQ1j6uBdUqUhq4DzxFMmk69azwsBslqU9jK5CmMJdhVSh56Pfe97eOa5Qc/uDbMjWkljV4C+srX8stF2HBCQsm6AMhgBoKmkyZhwqkYD1IA2gIfTOq4AQyLPXqvPNGvIyI6ilkSWy7gTGycpRK25X8HbZBIJgdRNdBpJKW485DAHFhR2TeME72CMwNbO181hx26wQyoaxSwKZzRFCvLYcgslhiYHAsS8qw7j3G6Nt9hgLyLsVnOUpoqRmvDD2kcXJSxN4o3e+DDXYJcx5y0saOwcnk58CcoWvlHkM6WTy0ZzA/a6v7nAZFOHim+EKrNfrZ63/6lDmvaLvmyX8iM4GRdZv9tKloqpZxusyVrL76DS9R4Oxf0aXYa8jt1l4fvuYOqtQu9kNEndImJ1fX8bB+wo+/fp3uELpDVR23XVr1njUGygHU5y5rvJd2nZzEwobG6/ijGdd8zH0wkBDBu8qSZ9+/UeAH3ANyvRXikOZTK6bpVbZDriGySSF7zxGbDfQOpSXScMAL1SSW2mlJEhwnbRW5nEK52YDTUC/x7pMj3IHYXBeduUOsJQBc7DmAFhO9x4xvQ6oVxhYF++/JQLmihEdVd42ZWdt7EwfnMdCaQ13Ki+RYmzneQ6uJ687Mid85A4WfCGowg1IjxDQ0BSuj0TiSeOc9eyF6pwvrNZ2zQVAkzurDIUUci8L2utP9o2ecZqVNS+QuhTu0X7Sq9mVpLuJfcT7N8JHHspHg/xw3nos0LPBGPa+Lk717XQ/tCVwt/43bc0bm6eWzCKgwFoq3W2UPx3ricsdfR0+FDfoVyrDfqt95kbPIvNMJEKrDE3AEWg4f399Bas307lIRuvxP7jcs6vL7y5+uLlgZ3iQdgk7nc6ncyY5G6iWZmTp6NF3vNu2ezj1f/VG7Dc74RPNnJYqQquYqW2Pie53T0KRiHT8PFwkorKBmGW75Zv7k9dty+RfGvQMvhaJWEmv5JIBwP1W5Crw73z3zPtsjr75sX8xvoKve2m+GNCAXwyDl5XUDX+JRDzi5ujJ2y7aZAAx7HHHcZ5l6Ggk+wwQH6DKdxdXF7cXIhE8ig/x02PET/0PNvCia4fAqvOB/zLKe1Fgu+2wWdvu+Lujz0r0MQ7cnKdF27b/AsJK8DY=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"}}');var l=i(74848),s=i(28453),p=i(33617),n=i.n(p),o=i(17543),d=i.n(o),r=i(86013),m=i.n(r),c=i(63723),v=i.n(c),u=(i(18766),i(79329),i(9303));const f={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV19v47gR/ypTvvTWUGxnN7dF9dT0NtgLGtwGlxwCNGsEtDSSeKFIHjmyYxgC7qHfoE997UfbT1IMJdmyk9120eLQl8Qazv8Zzvy4FSTLINJ7cYu105IwiEUicgyZV46UNSIVtxXCO9RICAMXnF9fgvN2pXIMsLENrBVVQBWCXCqtaANkwWNtVwgSgsNMFSoDGuQLb+vIPlDCFC4LkHsOFcBY0NaU6MEg5piLRFiHXrJfl7lIRR69GpwSiXDSyxoJPce0FUbWKFIx6HxQrEJxTE5SJY4DvXwHtjjwCqiSFK0HDmiJ0JlkPR5/aZTHXKTkG0xEoI1ma0HVTrMz+OS0zVGkhdSBGbIKaynSraCNi5zklSlFIgrra0l7StsuWH9w1gQMLPF6Pud/R4UZvOydgtBkGYZQNFpvficSkVlDaIglpXNaZTF1s58Di2+fO2SXP2NGnEfPiSbVGe/InPHnruOTjOGm4s9P1WsZ3PfujWiTvjT5OX1Z6PX89ZuT0/nJ/A+3p2/Tsz+m376dzufzv4pEPNWaZfsa5lzgNhGkSO+/22ds0ewBY09pmfnspTTe2BqpUqaENRqCtbemTMBplAGB/AZkKZUBzrT/H2YVvbf+y9n5Os/aUdTKaGXwYeihh7P5/OF0l4SzL/SSsQSFbUz+24b6kv0vB3T28HYX0LfPA7o0K6lVHifVrX1E89vGMzZPnfnn3ao6pnguDoId07sgA2aNV7SJg+3pRDp10p2n9wseF9wpdj8U4zCkSqRiNgyz2XY0CFvBKv1qGJWN1yIVFZEL6WwWpMmX9mlqHZqgSqPlMkwzW8+kU7PV6fRUtMmxjHTuq/ixOflakUCyVKb8d3KLfbZuuKJd0Q5ytiuddOovuBHJUJIxV78rKpQ5+lg+ZQobhftCfXBoblRpYpmj8eOdcoc6szXy9uDFMpkMIp/+9s+d1GQCuc2aGg3Fhpx+NB/Nh8aDs2v0RaNBmhwKjU9qqbvli3U865YvWQgoa40h6A0oQ1j6uBdUqUhq4DzxFMmk69azwsBslqU9jK5CmMJdhVSh56Pfe97eOa5Qc/uDbMjWkljV4C+srX8stF2HBCQsm6AMhgBoKmkyZhwqkYD1IA2gIfTOq4AQyLPXqvPNGvIyI6ilkSWy7gTGycpRK25X8HbZBIJgdRNdBpJKW485DAHFhR2TeME72CMwNbO181hx26wQyoaxSwKZzRFCvLYcgslhiYHAsS8qw7j3G6Nt9hgLyLsVnOUpoqRmvDD2kcXJSxN4o3e+DDXYJcx5y0saOwcnk58CcoWvlHkM6WTy0ZzA/a6v7nAZFOHim+EKrNfrZ63/6lDmvaLvmyX8iM4GRdZv9tKloqpZxusyVrL76DS9R4Oxf0aXYa8jt1l4fvuYOqtQu9kNEndImJ1fX8bB+wo+/fp3uELpDVR23XVr1njUGygHU5y5rvJd2nZzEwobG6/ijGdd8zH0wkBDBu8qSZ9+/UeAH3ANyvRXikOZTK6bpVbZDriGySSF7zxGbDfQOpSXScMAL1SSW2mlJEhwnbRW5nEK52YDTUC/x7pMj3IHYXBeduUOsJQBc7DmAFhO9x4xvQ6oVxhYF++/JQLmihEdVd42ZWdt7EwfnMdCaQ13Ki+RYmzneQ6uJ687Mid85A4WfCGowg1IjxDQ0BSuj0TiSeOc9eyF6pwvrNZ2zQVAkzurDIUUci8L2utP9o2ecZqVNS+QuhTu0X7Sq9mVpLuJfcT7N8JHHspHg/xw3nos0LPBGPa+Lk717XQ/tCVwt/43bc0bm6eWzCKgwFoq3W2UPx3ricsdfR0+FDfoVyrDfqt95kbPIvNMJEKrDE3AEWg4f399Bas307lIRuvxP7jcs6vL7y5+uLlgZ3iQdgk7nc6ncyY5G6iWZmTp6NF3vNu2ezj1f/VG7Dc74RPNnJYqQquYqW2Pie53T0KRiHT8PFwkorKBmGW75Zv7k9dty+RfGvQMvhaJWEmv5JIBwP1W5Crw73z3zPtsjr75sX8xvoKve2m+GNCAXwyDl5XUDX+JRDzi5ujJ2y7aZAAx7HHHcZ5l6Ggk+wwQH6DKdxdXF7cXIhE8ig/x02PET/0PNvCia4fAqvOB/zLKe1Fgu+2wWdvu+Lujz0r0MQ7cnKdF27b/AsJK8DY=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,h={},y=[];function D(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,l.jsx)(n(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,l.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,l.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(v(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function S(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(D,{...e})}):D(e)}}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.102fca2b.js b/assets/js/b2e6bd40.102fca2b.js deleted file mode 100644 index c46654463..000000000 --- a/assets/js/b2e6bd40.102fca2b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7960],{48597:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>v,default:()=>P,frontMatter:()=>g,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/v1.1/resendrequestmail.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/resendrequestmail","permalink":"/docs/API-docs/v1.1/resendrequestmail","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar_label":"Resend request mail","hide_title":true,"hide_table_of_contents":true,"api":"eJztWN1uW7kRfpUpb9IVjiUlTW8E11jXDbJGg40Re2EUjiFQ58zR4ZqH5PJHsioI2Iu+Qa/2dh8tT1IMef4ka5NNg7ZAsTeGPOQMZ74ZznyHW+b50rHZHfuLzkONyjt2n7ECXW6F8UIrNmPv0KEqwOIPAZ2HmgsJXkNwaKHUFpxYKqGWUDQmxu8Vy5g2aDlZuCw6G40JssAy1vz3Z11s2GzLcq08Kk8/uTFS5FF78r0jJ7bM5RXWnH6RnrBYkNvtmXNRsIxhtHyfMb8xyGZML77H3LOMGUvueIGODAyVZtt2s/NWqCVZeeS1kSQyVq9EgV1kIAq2a485ormPW6sdgYqolVbXES60jiC0ePIE2oRe7wNpf938O8513TkwdyGF90lHLoLzzcHcB4vdedEONHZAKPD46CeVryUltuZ+DBdcgVC5DAVCqaXUa0r1ilvBFxIdwHbbwemFl7jbwXZLUaGdK17jbpf1AjpvT2AqrZotFnMUqz2tToS9YicbqOKjEXYzL7hvBLmuDVeboQOpSOfBNnaUps3jPawPHIeKuxYrLGCjAyWNLB2Jus/LoinoL0oKGfktI+zUnH0jjrhyOjFnp+bsFqHSBsFXwjXAlUIVLuZqjVKO4dR5q9Xy7ACC00kjP55kiyuBa+CqSPnurRxi2xkaNz79TQc7SKtwkNuQCx6bprE6RyxgLXwFvkJQ+OjBeTQOuAPhUzctBcYYLPClRYy9h3zhwVfair/H1tgeeMqhslj+6dkBps/Orsn1Ci2eTvhZs/uyjDFWfIXA1QZi4EIrB9qCIt/KYH2FFnLJrSibPpyBkcgdArVpnvvofEK09eOm4urBZacLe3aDvIa3BhV58OEfP9MOtttlLILGZszGedBflx0t9o3d24BR4IxWLnXtF9NpbN57t4hlv35ufHwoWHRBHm2m6eIdnxCpgVJ6XMhzdK4MUm7Ge7EKJYXCeRvM/MV0On8+pZB3GXv5n40KrdX2c4O61jX6irrKmiJbU3l/PKSX0+n8RRfRy6cRnfQzVGkPpQ6qAFEOJyvdFFrLtbWYE4s4SaNzT6EZqkVaSle+UTSxqOIcSzMWpHAedH9KHK3/S2SPgKDtQZSfQvrl/HmH9B+fIn2pVlyKAs6vLuFGP6D63X8h5j7C4fE+HU+uPtaRMFHvjUHFTXGd7QU7lKcgHebBCr9hs7stezzhRpyk9dnd/e4+Y1Sqmiim0S56zH3FZmzSdxhGRuwKrYs2gpVsxirvjZtNJo6rYqEfx9qgoqqRfOGIZk24EZPV8/FztssOdbgxn7Ufw8nnqjjPl0ItP6V33+NzTTlMadpDqUsWN+KvuGFZm4ThrowJqp0KeYE2JoxK411P0F+1CT5gz0cpcseQn5LXJ9z1yzjXPuX6jS38P7EFqslSxwJu2kO7JTaXeAEOSfUtylzXSNjRiaPRwGqnNRp11ZqQea/eq7fBgtFrtGWQEbxS4qNYSIxqWMc119Uj8lqic5I4usel5R6hEEvhuey+h3Nu+EJIQd2TtukmR30DdmO4rTDCt9HhmUXgUOAKJTVdSp+uuR9+WsNa24dS6rXLgMMiOKHQOUBVcZXTxrYbZJQfrgCVR2uscAjOW/JaJN+08pYSU3PFl7FksmEKoEBJN8iB1YvgPDgtQ0q850JqiwW0AVEZuAjiq0dDS0BSIvwWK2pdK4RlEAW6DHJdILjYDygEVcCCvnkM+SJyjF/FQUmdP8QEEpsCo2l20ZXQ5Z6PpO4tV45GbvKlzUEHWLxCzmFycDT6ziFl+I1QD242GhHJuOvq6hYXTni8/33bhtfr9ZP2+9W+zmvhvwkLeIdGO+G13fTaS+GrsIgte2ik+ydZeo0KY/0MGnJvo9C5ezoBSDqpUJrJNXqqEDc5v7qM4/4r+PDjP+ENcqug0utUrXmwKDewbI8i5FLmE2zdtI4POtQ3CPE8FV/T7loEbyvuP/z4k4NvcU1cK10pCmU0ugoLKXK4wdpI7tGNRjO4sEhH+lYGvuIecq5ggeAqTqW0Ehw4mKQthXoYw7naJGLUNT+SR729MGLDbdPtYMEdFqBV1GjPHPcekbx2KFfoyBaxrgUCFoLaua+sDst02tCZJjiLpZASbkWxRB9jOy8Kop1RvE5iAnzgDpZ0IXyFG+A29kA/hqsDlbgSjNGWvBDJ+f7bHlVhtFDezaCwvPS9/awv9Jxgjq33iShByDs4ssZMl5J0E5uIO2l6iTogE/v91mKJlg6MYfd5MaIpp7u2LIGq9UvKmgZCM00iFW0YBjfi60M7kVKird3b8hrtSuTYMKtfuNGTuHnCMiZFjsrhgKqev756A6s/jKcsG1C0X3G5J28uL159e/2KnKFGmgB7Pp6OpyQitlpzNTjpyDPr4XwbPJL+m6+yDReMr0pGchHpd4xr2zDnu8G3OT2lVkSrZ3dsu6Wr9R1RBRL/ENASJ7/PWPv0FBl51pJIotoPSKzsIvl8ckNn03YZEh89+BAhFpw0zvMcjf/o3iHzv3p7fcMy1r671bqITwx8TY/MfJ0+qHXEMH3qk2zLJFfLwJe0N9kk3ku9b580P0TS3PygqNoltRl4uM+mUxj0l4I6qrDdJkIeWWzan5Z+UaMBtt1Nubvf7Xb/AtkJjmI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var i=n(74848),r=n(28453),o=n(33617),a=n.n(o),d=n(17543),l=n.n(d),p=n(86013),u=n.n(p),c=n(63723),m=n.n(c),q=(n(18766),n(79329),n(9303));const g={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uW7kRfpUpb9IVjiUlTW8E11jXDbJGg40Re2EUjiFQ58zR4ZqH5PJHsioI2Iu+Qa/2dh8tT1IMef4ka5NNg7ZAsTeGPOQMZ74ZznyHW+b50rHZHfuLzkONyjt2n7ECXW6F8UIrNmPv0KEqwOIPAZ2HmgsJXkNwaKHUFpxYKqGWUDQmxu8Vy5g2aDlZuCw6G40JssAy1vz3Z11s2GzLcq08Kk8/uTFS5FF78r0jJ7bM5RXWnH6RnrBYkNvtmXNRsIxhtHyfMb8xyGZML77H3LOMGUvueIGODAyVZtt2s/NWqCVZeeS1kSQyVq9EgV1kIAq2a485ormPW6sdgYqolVbXES60jiC0ePIE2oRe7wNpf938O8513TkwdyGF90lHLoLzzcHcB4vdedEONHZAKPD46CeVryUltuZ+DBdcgVC5DAVCqaXUa0r1ilvBFxIdwHbbwemFl7jbwXZLUaGdK17jbpf1AjpvT2AqrZotFnMUqz2tToS9YicbqOKjEXYzL7hvBLmuDVeboQOpSOfBNnaUps3jPawPHIeKuxYrLGCjAyWNLB2Jus/LoinoL0oKGfktI+zUnH0jjrhyOjFnp+bsFqHSBsFXwjXAlUIVLuZqjVKO4dR5q9Xy7ACC00kjP55kiyuBa+CqSPnurRxi2xkaNz79TQc7SKtwkNuQCx6bprE6RyxgLXwFvkJQ+OjBeTQOuAPhUzctBcYYLPClRYy9h3zhwVfair/H1tgeeMqhslj+6dkBps/Orsn1Ci2eTvhZs/uyjDFWfIXA1QZi4EIrB9qCIt/KYH2FFnLJrSibPpyBkcgdArVpnvvofEK09eOm4urBZacLe3aDvIa3BhV58OEfP9MOtttlLILGZszGedBflx0t9o3d24BR4IxWLnXtF9NpbN57t4hlv35ufHwoWHRBHm2m6eIdnxCpgVJ6XMhzdK4MUm7Ge7EKJYXCeRvM/MV0On8+pZB3GXv5n40KrdX2c4O61jX6irrKmiJbU3l/PKSX0+n8RRfRy6cRnfQzVGkPpQ6qAFEOJyvdFFrLtbWYE4s4SaNzT6EZqkVaSle+UTSxqOIcSzMWpHAedH9KHK3/S2SPgKDtQZSfQvrl/HmH9B+fIn2pVlyKAs6vLuFGP6D63X8h5j7C4fE+HU+uPtaRMFHvjUHFTXGd7QU7lKcgHebBCr9hs7stezzhRpyk9dnd/e4+Y1Sqmiim0S56zH3FZmzSdxhGRuwKrYs2gpVsxirvjZtNJo6rYqEfx9qgoqqRfOGIZk24EZPV8/FztssOdbgxn7Ufw8nnqjjPl0ItP6V33+NzTTlMadpDqUsWN+KvuGFZm4ThrowJqp0KeYE2JoxK411P0F+1CT5gz0cpcseQn5LXJ9z1yzjXPuX6jS38P7EFqslSxwJu2kO7JTaXeAEOSfUtylzXSNjRiaPRwGqnNRp11ZqQea/eq7fBgtFrtGWQEbxS4qNYSIxqWMc119Uj8lqic5I4usel5R6hEEvhuey+h3Nu+EJIQd2TtukmR30DdmO4rTDCt9HhmUXgUOAKJTVdSp+uuR9+WsNa24dS6rXLgMMiOKHQOUBVcZXTxrYbZJQfrgCVR2uscAjOW/JaJN+08pYSU3PFl7FksmEKoEBJN8iB1YvgPDgtQ0q850JqiwW0AVEZuAjiq0dDS0BSIvwWK2pdK4RlEAW6DHJdILjYDygEVcCCvnkM+SJyjF/FQUmdP8QEEpsCo2l20ZXQ5Z6PpO4tV45GbvKlzUEHWLxCzmFycDT6ziFl+I1QD242GhHJuOvq6hYXTni8/33bhtfr9ZP2+9W+zmvhvwkLeIdGO+G13fTaS+GrsIgte2ik+ydZeo0KY/0MGnJvo9C5ezoBSDqpUJrJNXqqEDc5v7qM4/4r+PDjP+ENcqug0utUrXmwKDewbI8i5FLmE2zdtI4POtQ3CPE8FV/T7loEbyvuP/z4k4NvcU1cK10pCmU0ugoLKXK4wdpI7tGNRjO4sEhH+lYGvuIecq5ggeAqTqW0Ehw4mKQthXoYw7naJGLUNT+SR729MGLDbdPtYMEdFqBV1GjPHPcekbx2KFfoyBaxrgUCFoLaua+sDst02tCZJjiLpZASbkWxRB9jOy8Kop1RvE5iAnzgDpZ0IXyFG+A29kA/hqsDlbgSjNGWvBDJ+f7bHlVhtFDezaCwvPS9/awv9Jxgjq33iShByDs4ssZMl5J0E5uIO2l6iTogE/v91mKJlg6MYfd5MaIpp7u2LIGq9UvKmgZCM00iFW0YBjfi60M7kVKird3b8hrtSuTYMKtfuNGTuHnCMiZFjsrhgKqev756A6s/jKcsG1C0X3G5J28uL159e/2KnKFGmgB7Pp6OpyQitlpzNTjpyDPr4XwbPJL+m6+yDReMr0pGchHpd4xr2zDnu8G3OT2lVkSrZ3dsu6Wr9R1RBRL/ENASJ7/PWPv0FBl51pJIotoPSKzsIvl8ckNn03YZEh89+BAhFpw0zvMcjf/o3iHzv3p7fcMy1r671bqITwx8TY/MfJ0+qHXEMH3qk2zLJFfLwJe0N9kk3ku9b580P0TS3PygqNoltRl4uM+mUxj0l4I6qrDdJkIeWWzan5Z+UaMBtt1Nubvf7Xb/AtkJjmI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,j={},f=[];function h(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(q.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,i.jsx)(q.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(u(),{title:"Body",body:{content:{"application/json":{schema:{required:["document_id","email"],type:"object",properties:{document_id:{type:"string",example:"provide document id"},email:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"},email_subject:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

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

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"}},title:"resendmail_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",format:"string",example:"mail sent successfully."}},title:"inline_response_200_10"}}}},400:{description:"",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Something went wrong."}},title:"inline_response_400_2"}}}},404:{description:"- document not found if document id is not correct.\n- user not found if provided user email is not present in signer list of document\n",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"document not found or user not found."}},title:"inline_response_404_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(q,{...e})}):q(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.bc214206.js b/assets/js/b93339ed.bc214206.js deleted file mode 100644 index 12a3043e1..000000000 --- a/assets/js/b93339ed.bc214206.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>h,default:()=>y,frontMatter:()=>I,metadata:()=>a,toc:()=>w});const a=JSON.parse('{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/v1.1/updatefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/updatefolder","permalink":"/docs/API-docs/v1.1/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WN1u47gVfpVT3nTHUGwnm922umo6mM6mO5gJJhkEaMYIKOlI4oYiuSRlxzAE7EXfoFe97aPNkxSHlGQ5yaQN2u1NYpM8h9/5zi+9Y55XjqU37M9aFmjZKmEFutwK44VWLGVXNcInU3CPEI/A2cU5cCn1xsFWt+A1tDrsl3Ff8QaBO9iglPTfcIvKR+HzYs4Spg1aTvrPC5ayNmiPwixhhlveoEdLsHaMtLGUxe1bUbCECcJluK/ZQ7A6+wlzf16ALmFUaPHnVlgsWOptiwlzfitJpRONkcgShvdG6gJZWnLp6EBeY8NZumN+a8JJb4WqWMJKbRvupyt4z4OWlGU/HudlcVKbjHXdKl6Lzv9JF1tSdQj0wuq1KBAylHoDo8lEZm5xTyZLWK6VR+VJBzdGijwwt/jJkaLdBOzezpuersDdKhnMiOwQxZY84AU6kotn3weeX2ayws2AswuOm/j5pbpY1yXMCy8n3s6Iu66jHYvOaOUi4pPl8jGlrs1zdK5sJYzx9RL6nidpiKyXmvXDnTv5i8HNuSGKYqgXZ/4pNXuhk+XJt0fHy6Pl766Ov09P/5B+9/18uVz+lSXsvpEk22cFaWMT3uL3yYJQUii8Hdi7PVkub4+Pe05Pn6LxUjfoa6Eq2KDysLFaVQkYidwheLsFXnGhQHKP9jf/O37RWm2fZ+VlyJ5j4ZRYGEk4fUzCUMm0h1K3KhStX9vQ56LoMZ7nzTu9/f1o3nePzTtXay5FESq513eo/r+OfOJ6gnoY2iIeCvvswNjpejTSYd5a4behYdwfcSOO4n56s6JSTHGjqdWYNgCm1pGyRWR1sRt7S8dIl10Pvae1kqWs9t64dLFwXBWZvp9rg8qJSkmeuXmumwU3YrE+nh+zLnkow4150Xlsj14q4jyvhKr+ndxqT9MluTJ664Cs0WfciB9xy5LBF9NTffutkYey3yWMIuTjvtm9Gfx82FmmzeJxr2DkYqFKHVD0rv5gUF2KSoVACVY87PfXKHPdILVNXyPMZoPIl7/9c5SazaDQedug8iGk55/VZ/WhtWD0Bi31C64KKCXei0xiEMMm7I0DjkPeSHRObkEoj5WlDl2ISngugQinqpRzwzMhBWUCHdMkbWGSTG4O1zX6Gi1t/dYicChwjZISCHjrdcM9qRrwwkbbu5JGrQQ4ZK0TCp0DVDVXOR0cXJqAtsAVoPJojRUOwXlLqEXEppW3PPfQcMUrJN0JTMkqUAqKe7A6a50Hp2UbIIPnQmqLBQwGKcTCBRLf0OBkEWg1142xWFP8rRGqVhToEsh1geBCQJAJqoAMnQdDWESOLkyPSur8LjiwbKUEo6kOCS5piptiJHFvuXJUKiOWwQcjYcZqmgIwApzNPjkkD78T6s6ls9lndQQ3Y1xdY+aEx9U3Qy5tNptHOfTqUOat8D+0GXxEo53w2m730pXwdZuFvJsqGb9ETW9RYYifSVbtdRQ6d4/TmFYXNUqzuERPEeIWZxfnVyT6Cr788nd4h9wqqPUmRmveWpRbqIariLno+UjbWHmh1CHwamI8j8HXD64Dg9c1919++YeD97gBofqUIlNms4s2kyKHK2wMtV03m6XwOs6vflgDX3MPOVeQIbiaUyitBQcOJkpLoe7mcKa20Dq0sBG+DsFA60HuwAziZXS3g4w7LECrIDHcOd8jovXGoVyjI13UQTMELISniK6tbqt42xRMb5zFUkgJ16Ko0AfbzooCTL+8ictE+AQOlpQQvsYtcIvgUPk5XDwQCTutMdoSChHBl5reVOQAVIXRQnmXQmF56ff6k32gh2eC0OqJpUghH+lIejWjS2Im9haPq/PPVN0fdITDemuxREsXBrP3fjGiD6ebISyBovW/CWtqCFS1eB5GEmy4kLE1/fGhnjAeoG3ch/IS7Vrk2LfHr2T0IhxesIRJkaNyOBk7zt5evIP1t/MlSyZ99j9I7sW789dv3l++ITBUSCNhx/PlfBkeR9r5hqvJTQeP6oedbbcfx36VF3jf6D3e+4WRXIQRK9i768ej4Q3JEpbuH9+rhNXaedre7Sj3PlnZdbT8c4uWBrBVwtbcCp5RC7/ZsUI4+lyMr+uv2vnNx/4B+wqefMc/iXmYWBSNK2su2/CWTNgdbg9+NehWXTIMLQQr7r+Olx9dkZa9/KP5l6auKHGW52j8s2enA+fFpyuWsKz/DaAJvzIwyzf0swTfRKg6cBHGsbC2Y5KrquUVnY0qacyiKn04o92FGa3/QEY9Scbh8BatoL9k05MCu12c/7puPB+3virR8zqcJs+suq77F6OBb6o=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"}}');var d=o(74848),n=o(28453),s=o(33617),i=o.n(s),l=o(17543),r=o.n(l),p=o(86013),c=o.n(p),u=o(63723),m=o.n(u),f=(o(18766),o(79329),o(9303));const I={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WN1u47gVfpVT3nTHUGwnm922umo6mM6mO5gJJhkEaMYIKOlI4oYiuSRlxzAE7EXfoFe97aPNkxSHlGQ5yaQN2u1NYpM8h9/5zi+9Y55XjqU37M9aFmjZKmEFutwK44VWLGVXNcInU3CPEI/A2cU5cCn1xsFWt+A1tDrsl3Ff8QaBO9iglPTfcIvKR+HzYs4Spg1aTvrPC5ayNmiPwixhhlveoEdLsHaMtLGUxe1bUbCECcJluK/ZQ7A6+wlzf16ALmFUaPHnVlgsWOptiwlzfitJpRONkcgShvdG6gJZWnLp6EBeY8NZumN+a8JJb4WqWMJKbRvupyt4z4OWlGU/HudlcVKbjHXdKl6Lzv9JF1tSdQj0wuq1KBAylHoDo8lEZm5xTyZLWK6VR+VJBzdGijwwt/jJkaLdBOzezpuersDdKhnMiOwQxZY84AU6kotn3weeX2ayws2AswuOm/j5pbpY1yXMCy8n3s6Iu66jHYvOaOUi4pPl8jGlrs1zdK5sJYzx9RL6nidpiKyXmvXDnTv5i8HNuSGKYqgXZ/4pNXuhk+XJt0fHy6Pl766Ov09P/5B+9/18uVz+lSXsvpEk22cFaWMT3uL3yYJQUii8Hdi7PVkub4+Pe05Pn6LxUjfoa6Eq2KDysLFaVQkYidwheLsFXnGhQHKP9jf/O37RWm2fZ+VlyJ5j4ZRYGEk4fUzCUMm0h1K3KhStX9vQ56LoMZ7nzTu9/f1o3nePzTtXay5FESq513eo/r+OfOJ6gnoY2iIeCvvswNjpejTSYd5a4behYdwfcSOO4n56s6JSTHGjqdWYNgCm1pGyRWR1sRt7S8dIl10Pvae1kqWs9t64dLFwXBWZvp9rg8qJSkmeuXmumwU3YrE+nh+zLnkow4150Xlsj14q4jyvhKr+ndxqT9MluTJ664Cs0WfciB9xy5LBF9NTffutkYey3yWMIuTjvtm9Gfx82FmmzeJxr2DkYqFKHVD0rv5gUF2KSoVACVY87PfXKHPdILVNXyPMZoPIl7/9c5SazaDQedug8iGk55/VZ/WhtWD0Bi31C64KKCXei0xiEMMm7I0DjkPeSHRObkEoj5WlDl2ISngugQinqpRzwzMhBWUCHdMkbWGSTG4O1zX6Gi1t/dYicChwjZISCHjrdcM9qRrwwkbbu5JGrQQ4ZK0TCp0DVDVXOR0cXJqAtsAVoPJojRUOwXlLqEXEppW3PPfQcMUrJN0JTMkqUAqKe7A6a50Hp2UbIIPnQmqLBQwGKcTCBRLf0OBkEWg1142xWFP8rRGqVhToEsh1geBCQJAJqoAMnQdDWESOLkyPSur8LjiwbKUEo6kOCS5piptiJHFvuXJUKiOWwQcjYcZqmgIwApzNPjkkD78T6s6ls9lndQQ3Y1xdY+aEx9U3Qy5tNptHOfTqUOat8D+0GXxEo53w2m730pXwdZuFvJsqGb9ETW9RYYifSVbtdRQ6d4/TmFYXNUqzuERPEeIWZxfnVyT6Cr788nd4h9wqqPUmRmveWpRbqIariLno+UjbWHmh1CHwamI8j8HXD64Dg9c1919++YeD97gBofqUIlNms4s2kyKHK2wMtV03m6XwOs6vflgDX3MPOVeQIbiaUyitBQcOJkpLoe7mcKa20Dq0sBG+DsFA60HuwAziZXS3g4w7LECrIDHcOd8jovXGoVyjI13UQTMELISniK6tbqt42xRMb5zFUkgJ16Ko0AfbzooCTL+8ictE+AQOlpQQvsYtcIvgUPk5XDwQCTutMdoSChHBl5reVOQAVIXRQnmXQmF56ff6k32gh2eC0OqJpUghH+lIejWjS2Im9haPq/PPVN0fdITDemuxREsXBrP3fjGiD6ebISyBovW/CWtqCFS1eB5GEmy4kLE1/fGhnjAeoG3ch/IS7Vrk2LfHr2T0IhxesIRJkaNyOBk7zt5evIP1t/MlSyZ99j9I7sW789dv3l++ITBUSCNhx/PlfBkeR9r5hqvJTQeP6oedbbcfx36VF3jf6D3e+4WRXIQRK9i768ej4Q3JEpbuH9+rhNXaedre7Sj3PlnZdbT8c4uWBrBVwtbcCp5RC7/ZsUI4+lyMr+uv2vnNx/4B+wqefMc/iXmYWBSNK2su2/CWTNgdbg9+NehWXTIMLQQr7r+Olx9dkZa9/KP5l6auKHGW52j8s2enA+fFpyuWsKz/DaAJvzIwyzf0swTfRKg6cBHGsbC2Y5KrquUVnY0qacyiKn04o92FGa3/QEY9Scbh8BatoL9k05MCu12c/7puPB+3virR8zqcJs+suq77F6OBb6o=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,j={},w=[];function P(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,d.jsx)(i(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,d.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,d.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,d.jsx)(r(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,d.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,d.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.d3620018.js b/assets/js/b93339ed.d3620018.js new file mode 100644 index 000000000..6f7dc50f4 --- /dev/null +++ b/assets/js/b93339ed.d3620018.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>f,default:()=>v,frontMatter:()=>y,metadata:()=>r,toc:()=>P});const r=JSON.parse('{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/v1.1/updatefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/updatefolder","permalink":"/docs/API-docs/v1.1/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WM1y5LYRfpU2LvFOUTMjWXaSOVnZ2qxlb3ZVK22pytopFUj2kPCAAAyAQ01NscqHvIFPvubR9klSDZAcjqSVo0qci34AdKP7678P3DHPC8cWN+zvWuZo2TJhObrMCuOFVmzBrkqEDybnHiEegbOLc+BS6sbBVtfgNdQ67K/ivuIVAnfQoJT023CLykfh83zKEqYNWk76z3O2YHXQHoVZwgy3vEKPlszaMdLGFixu34qcJUyQXYb7kt03Vqc/YebPc9ArGBRa/LkWFnO28LbGhDm/laTSicpIZAnDOyN1jmyx4tLRgazEirPFjvmtCSe9FapgCVtpW3E/XsE7HrQsWPrDcbbKT0qTsrZdxmvR+b/pfEuqDg29sHojcoQUpW5gcJnAzCzuwWQJy7TyqDzp4MZIkQXkZj85UrQbGbv386aDK2C3THo3IjoEsaUIeIGO5OLZtwHn57mssOntbEPgRnF+ri7WtgnzwstRtFPCrm1px6IzWrlo8cl8/hBSV2cZOreqJQz59Rz4ngapz6znuvXd2p18b7A5NwRRTPX8zD+mZi90Mj/56uh4fjT/89XxN4vTvy6+/mY6n89/ZAm7qyTJdlVB2tgIt/j/aEEoKRTe9ujdnsznt8fHHaanj8F4qSv0pVAFNKg8NFarIgEjkTsEb7fACy4USO7RfvG/wxet1fZpVJ5n2VMonBIKAwinD0HoO5n2sNK1Ck3rj3b0qSx6aM/T7p3e/mVw7+uH7p2rDZciD53c6zWq/28gH7meTD1MbREPhX124Ox4PTrpMKut8NswMO6OuBFHcX9xs6RWTHmjadSYOhhMo2PBZhHV2W6YLS0jXXbTz557ldHwokD7XZ0Gy89qr+EfOltH92or2YKV3hu3mM02wvqoaeqiWFmn00xXswvLV7WUb/lmze1MG1Sz4+l8OmdtsrunxHGVp/puSoecKJTkqQs6uBGzzfH0+BEZbsyzzmN99FwR53khVPF7cst9XC4pd2J6HERnSBJuxA+4ZUkf/PGpbt6XyMOcaRNGKfl+P11f9Yl1OMrG0+nhcGKUU0KtdLCiy613BtWlKFSIb/DiPsG4RpnpCmlO+xJhMulFPv3zX4PUZAK5zuoKlQ81NP2oPqp3tQWjG7Q0oLjKYSXxTqQSgxhWYW9gVA55JdE5uQWhPBaWKEEuCuG5BAKc2mDGDU+FFFR6dEyTtIVR9bopXJfoS7S09SeLwCHHDUqqWOC11xX3pKq3Fxpt1yvidglwSGsnFDoHqEquMjrYhzQBbYErQOXRGiscgvOWrBbRNq285ZmHiiteIOlOYAxWjlJQoYHVae08OC3rYDJ4LqS2mEPvkELMXQDxFTE1i0Crma6MxZLyb4NQ1CJHl0CmcwQXEoJcUDmk6DwYskVk6AJdVVJn6xBAKkUwmhqf4JJo49hGEveWK0e9OdrSx2AAzFhNtAOjgZPJB4cU4TdCrd1iMvmojuBmyKtrTJ3wuPyyr6WmaR7U0ItDmdfCU8t5j0Y74bXd7qUL4fu2MlYy/BM1vUaFIX9GVbXXkevMPSxjWp2VKM3sEj1liJudXZxfkegL+PTLr/AGuVVQ6iZma1ZblFso+qsIuRj5CNvQ6mGlQ+KVhHgWk69jyj2C1yX3n375zcFbbECorqTIlcnkok6lyOAKK0Nz3k0mC3gZCbPv18CX3EPGFaQIruSUShvBgYOJ0lKo9RTO1BZqhxYa4cuQDLQe5A7cIFyGcDtIucMctAoS/Z3TvUW0XjmUG3Ski0Z2ioC58JTRpdV1EW8bG9M5Z3ElpIRrkRfog29neQ6mW27iMgE+MgdXVBC+xC1wi+BQ+Slc3BMJO7Ux2pIVIhq/0vSIowCgyo0WyrsF5Jav/F5/sk/08C4RWj2yFCHkAxxJp2YISazEzuNhdfqRuvu9iXDYby2u0NKFwe19XIzo0ummT0ugbP1v0poGAnUtngUOhBUXMo6mb+/rCXwEbeXerS7RbkSG3Xj8TEXPwuEZS5gUGSqHI55z9vriDWy+ms4POMR/UNyzN+cvX729fEXGUCONgPVcghntfMXV6KaDV/z9ybbb878/5MnfDXqPd35mJBeB0wV/dx0f6x+tLGGL/Wt/mbBSO0/bux3V3gcr25aWf67REuNbJmzDreApjXAibcLR3/nwnP+sn1++717ML+DRDweP2twzFkV0ZcNlHR6vCVvj9uAzRbtsk560kFlx/2W8/OiKtOzlHxBuYl1R4izL0Pgnz44Z7sWHK5awtPvoUIXPGszyhr6D8CaaqgMWgY6FtR2TXBU1L+hsVEk0i7r0IUdbB47W/UFOPQrGIXmLXtBP8ulRgd0u8r+2Hc7Hrc9KdLj2pykyy7Zt/w0TFJdV","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"}}');var n=o(74848),a=o(28453),s=o(33617),d=o.n(s),l=o(17543),i=o.n(l),p=o(86013),c=o.n(p),u=o(63723),m=o.n(u),b=(o(18766),o(79329),o(9303));const y={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WM1y5LYRfpU2LvFOUTMjWXaSOVnZ2qxlb3ZVK22pytopFUj2kPCAAAyAQ01NscqHvIFPvubR9klSDZAcjqSVo0qci34AdKP7678P3DHPC8cWN+zvWuZo2TJhObrMCuOFVmzBrkqEDybnHiEegbOLc+BS6sbBVtfgNdQ67K/ivuIVAnfQoJT023CLykfh83zKEqYNWk76z3O2YHXQHoVZwgy3vEKPlszaMdLGFixu34qcJUyQXYb7kt03Vqc/YebPc9ArGBRa/LkWFnO28LbGhDm/laTSicpIZAnDOyN1jmyx4tLRgazEirPFjvmtCSe9FapgCVtpW3E/XsE7HrQsWPrDcbbKT0qTsrZdxmvR+b/pfEuqDg29sHojcoQUpW5gcJnAzCzuwWQJy7TyqDzp4MZIkQXkZj85UrQbGbv386aDK2C3THo3IjoEsaUIeIGO5OLZtwHn57mssOntbEPgRnF+ri7WtgnzwstRtFPCrm1px6IzWrlo8cl8/hBSV2cZOreqJQz59Rz4ngapz6znuvXd2p18b7A5NwRRTPX8zD+mZi90Mj/56uh4fjT/89XxN4vTvy6+/mY6n89/ZAm7qyTJdlVB2tgIt/j/aEEoKRTe9ujdnsznt8fHHaanj8F4qSv0pVAFNKg8NFarIgEjkTsEb7fACy4USO7RfvG/wxet1fZpVJ5n2VMonBIKAwinD0HoO5n2sNK1Ck3rj3b0qSx6aM/T7p3e/mVw7+uH7p2rDZciD53c6zWq/28gH7meTD1MbREPhX124Ox4PTrpMKut8NswMO6OuBFHcX9xs6RWTHmjadSYOhhMo2PBZhHV2W6YLS0jXXbTz557ldHwokD7XZ0Gy89qr+EfOltH92or2YKV3hu3mM02wvqoaeqiWFmn00xXswvLV7WUb/lmze1MG1Sz4+l8OmdtsrunxHGVp/puSoecKJTkqQs6uBGzzfH0+BEZbsyzzmN99FwR53khVPF7cst9XC4pd2J6HERnSBJuxA+4ZUkf/PGpbt6XyMOcaRNGKfl+P11f9Yl1OMrG0+nhcGKUU0KtdLCiy613BtWlKFSIb/DiPsG4RpnpCmlO+xJhMulFPv3zX4PUZAK5zuoKlQ81NP2oPqp3tQWjG7Q0oLjKYSXxTqQSgxhWYW9gVA55JdE5uQWhPBaWKEEuCuG5BAKc2mDGDU+FFFR6dEyTtIVR9bopXJfoS7S09SeLwCHHDUqqWOC11xX3pKq3Fxpt1yvidglwSGsnFDoHqEquMjrYhzQBbYErQOXRGiscgvOWrBbRNq285ZmHiiteIOlOYAxWjlJQoYHVae08OC3rYDJ4LqS2mEPvkELMXQDxFTE1i0Crma6MxZLyb4NQ1CJHl0CmcwQXEoJcUDmk6DwYskVk6AJdVVJn6xBAKkUwmhqf4JJo49hGEveWK0e9OdrSx2AAzFhNtAOjgZPJB4cU4TdCrd1iMvmojuBmyKtrTJ3wuPyyr6WmaR7U0ItDmdfCU8t5j0Y74bXd7qUL4fu2MlYy/BM1vUaFIX9GVbXXkevMPSxjWp2VKM3sEj1liJudXZxfkegL+PTLr/AGuVVQ6iZma1ZblFso+qsIuRj5CNvQ6mGlQ+KVhHgWk69jyj2C1yX3n375zcFbbECorqTIlcnkok6lyOAKK0Nz3k0mC3gZCbPv18CX3EPGFaQIruSUShvBgYOJ0lKo9RTO1BZqhxYa4cuQDLQe5A7cIFyGcDtIucMctAoS/Z3TvUW0XjmUG3Ski0Z2ioC58JTRpdV1EW8bG9M5Z3ElpIRrkRfog29neQ6mW27iMgE+MgdXVBC+xC1wi+BQ+Slc3BMJO7Ux2pIVIhq/0vSIowCgyo0WyrsF5Jav/F5/sk/08C4RWj2yFCHkAxxJp2YISazEzuNhdfqRuvu9iXDYby2u0NKFwe19XIzo0ummT0ugbP1v0poGAnUtngUOhBUXMo6mb+/rCXwEbeXerS7RbkSG3Xj8TEXPwuEZS5gUGSqHI55z9vriDWy+ms4POMR/UNyzN+cvX729fEXGUCONgPVcghntfMXV6KaDV/z9ybbb878/5MnfDXqPd35mJBeB0wV/dx0f6x+tLGGL/Wt/mbBSO0/bux3V3gcr25aWf67REuNbJmzDreApjXAibcLR3/nwnP+sn1++717ML+DRDweP2twzFkV0ZcNlHR6vCVvj9uAzRbtsk560kFlx/2W8/OiKtOzlHxBuYl1R4izL0Pgnz44Z7sWHK5awtPvoUIXPGszyhr6D8CaaqgMWgY6FtR2TXBU1L+hsVEk0i7r0IUdbB47W/UFOPQrGIXmLXtBP8ulRgd0u8r+2Hc7Hrc9KdLj2pykyy7Zt/w0TFJdV",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,g={},P=[];function F(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,n.jsx)(d(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(i(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.67affa68.js b/assets/js/c195e1f1.67affa68.js deleted file mode 100644 index a3dedb8d5..000000000 --- a/assets/js/c195e1f1.67affa68.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>g,default:()=>y,frontMatter:()=>f,metadata:()=>r,toc:()=>j});const r=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztW19z3DaS/yp9fHE8RY3+xM7tqXyuVRxvolpfrLLlc21pVBMM2TOETQJcAJzRrGqq9mG/wT7d6360fJKrboAkOBpJljf3sqdUKtGQQHej/6Hxa/A6cWJhk+OL5AedNRUqZ5PLNMnRZkbWTmqVHCfnBcIrg8IhtKNgbnQFDqu6pMcnZ6cgylKvLKx1A07DAhUaeqVwBXlLG2Zr+NRYB7XRS5lLtehoTGUOUlmHIgc9h6YuteABgknMZYnfSAWuQJhrU9GYmbD43TPQBmZSCbN+CrhEswYnK2Q5FGJOwmReeNEJMobzwNYSNTBY04i8XENjMWduFjKhYIZhdu6X3Fg0IJVDMxcZgnBwMRr9gLNmAR9OR6PLbwrnanu8vy/qeqxrVFYuVClmdpzpaj+ngXU+f0pCN5bX3yv3PFLneKIm6k+6YSG8thBynIumdLAUZcNqIKXDSuYLJN0KEl2zjqQBJSocvLdNXWvjAK8yrB2QYMI1BlOwTlR1ClJJJ0VpU5CVWOB4og7HMBphJWQ5Gk3UL7/8MlHXEwUwSYj6JDmGScKvJ0nqnxsUuVblmt7NRWkxPA+iR1N+j1eiqkskxUySidoEBhN1RFyJwe1M/V8P4flJ45DLt8Tlk57BuXTlHaxoiKMhD+OXoR7ye0b8Ml3VQq1v5xYGPFCfXpNQLx2ULh/yfU58c+HuWCK9fRjHw8O9g+d7RwdHz4fMviNmDq/cTF/dzi8MeBjLag00b8jv31mpBWaf72TYjngIx4tJojkD7h1Nksue6R6p0w87Ho2gjdFCLBG0QorsShsEVwjFD3y0ukI4TkiWMtIMwWKJGeWV2boNbA7637G9jK5zvVJ32CyMeJgS/YoOh0r8D+JoRC41zBrn9B1cedRvwHI0OjM4l2UJH312IlW2j9qEJQwCluh3DtYfPZHKoiG9SeV0lNNhhnPSu3QgLdhCGMxhJV0BgrP2GN6qcs35tpvCqV0bKISFGk0lrZWUQDWIPKeh1dhLa9DWWln0YvpsTJQi29pCN2VOW0lJOwO9xStpHSX5dnqg9kZaRxvYVmbmNbVaIBsc3h9Nu4LJ8+KXQuUGVzDDQfI7enBK6EjCJDl4tn/4fP/o4OhZTPPbr47EnvbFJKkEJ1qYJHP0f2+FXmyJ/6JSgnboQltUoSaJ9c7msaTqli+FmlRe0zS0LT/GXYp+QCCEUbfoyYv/m0gfc7t1BRD+CSmf9/DbF8CvdzuN/O/v375bHfzxx4U+OTk5+fn9h+L1h8XJyUlFv8fjcVhVIP3dVyesWFutuX8TfbW8btfVRCVpomuqUaVWp3lynIQ6L+QGyhztcJknaVILIyp0aKhcvuaFJcdJVL4maSKpXK6FK5LtGlrPPmHmTrm2beu8JE0M/rmRBvPk2JkG08S6dUlkraQNPUkTvKpLnWNy7PNrYrMCK5EcXyduXfNIZ6RaJGlCVbFw8ZNQFpBIPx3OiuyoqGfJZnPp2aJ13+t8TaQyrRwqR3+Kui5lxkrZ/2RJ9OuIZy/uRUL1IynjMm1F8WskVRnSrJNoWVAqnh4q8c/RscGXXzdUeqLA7y2ihM44YGvM5HzdltY8lUtl+qVwVa67gr4/DZzOQVfSOczTgZ/8+tf/sYHEinamGfrzwWDLTjZpp4x+lcIYsSaXcFjFz29RktG7ddRr5CTLdOOUUI4Ycgl9p1J5QEzgk8a45iYq3onv4vpJI+0eNLgutLpn9OHRt/Tvt4c0PpSyD7V8e2giEp/0bPpV7pPjkuaHDfbrzXK/gsL2O+UltwVRNGWmdYlCxXM4lDdpWybdTT+UvTN9lWw2aRtMW8kqykLT994Vp+3aNw+axkzmuszRUFK8SzL2e1T5dNsX+yVv4wjSRpE6BAxC3MKqQFeg4ccroRww9b5opnSgIcTbGAibGB6LpaUThmlwknBg92Waph8DEaKxIFQOSsMT5je1DTvEk/3we6bz9ZN+pi9OvcySUkkQgQd36cMOssZ4MvACYtsGcstul8KHOnzVWKcrYDZhEme37jQPIbeP4ZVQIFVWNqFWnWtSOCVGuL5uXcCH12YD19dkSzRTcvnNJu0fEK/BA04E/onBDOVyMKt7hP3E7lk0Fa9qadZTKjT9g5AvYgHkQkm1mDYm0FGaBo8HbrglONfyQQeYd94lF2rHqrtMyvb9Yu3fUHawOxH5f6P3F/XLn+QOUV7s1y9f1C8/IhS6Rh9xXj1zqXIf7yssyzG8sM5otXi5pYIX++H5blMaXEpccbiyVXsq27rtCI2DTH/STRwp0kJmmkyKkujWRmfYHhl9sXDlwDqsLQhLx0pWy1wir8GAWBjkwynLIhpXaCP/wqVTy/CFgMLg/D+fbOn0yUtKt1CgwRf74mUYfTrnNTKSINQaeOFSK0uYAmOZ88ZwcsxKYeQ81Gkp1CUKi0BlnMgcC+812spxXgj12aYvZublOYoK3taoSIJf//YPGtFm8lP11uRoviCVn87BImfiJ5THnqSg28P1XBrrQoL2+S94iJfrltAJ2GO5HsPrLuHbZmZplGrp9QnVGblYIB3xwwienHrrocgKv1WwVGJOuZ641+Q8urGteORg5P4lkoN53DQYagzfd0VeCpF2GF2I1z7ekdUJgj7XrwLpH8Q6rjVUU83Q3NApw9aEVodZkIu1JW5cctILUWYNA8Q+hoFimHY1dsfW++PKqOPUyXf4nFKeErMS356ffYGlaUGw58PYl9veBp4GvD0/gyX2zjiGD7azU2t4MRgCmc4RllJ406ewKmTGIbeGis54qNheIWvHgM3Yw0ywBzcFyqXdKVHqCw3Kvw2Ltosw5NJg5so1O5BuHAFAMhwuOAeMd1VwXgnnuvmSmLlHkwIWjczZ0o3p9nQ0No26JdQhMU3ms0LemPaYE5zWJzFrez21WqFBEf0UUFk/XcBcWIcmhUZxY8M0NUVDSxKvajQSVYY7VRCl7vv3T6rWuC+hfV1Wo7FaUXrTZiFUyJ7Uw1jRIR9mWIjSDw1pwsIMSSqK7vHOc8Ovf/tH0st16znppmCeg8hzg9beIyEjft6dCPwl0G8NTg8lInpofr/dBSLp2CWnlc47N7Vf7kFnhFQ62+XEAFd2UKltsoK2rC7X2ri3w80em9KS6GDBDSNd03o7IKXFJeVt0fcOSY9ZJAOjMRQz5FFqHYdPD+HqLXJ8IJDWP42L+J2eRk25+y1JeHwl1l3PjGiHRiEqyjw5nP3wB+7w+WpiB1xL59woi/rpN84+onF6arCS6sv2zPd+02AjOt2FfeN0JZzMoCVlxxCGenU7HUdxBd+0qqLoWEptnu5Ulyc31SrDqVRTbo3evwn9zI8ZQ6PdZ4Zuhahi2Vqj+a3Vw0Uk26pABQOdRDslLXoYHM9T0mGFZoHTjA7cHAj4BXocjYjaaAR7XpaQRG1jAhJPtgybKG83PXWSKJTmHSbY7//kF71z/qRXpLOuuqIa2NMnlQJLHuCimEMmlNLOn1XpuNh1jmlgJaTqWfhmANuLVxPqv6zQ2vMjzTGf9K41tSVR8PicQl903H2ERk4vSs0hHqrc8Hog1OmcuBe84bAJUyp/mU9jfazolULD8FhtcI6G9gfbnbd3vuUjsyit5qUNqLYe3fr81lG5denat0buh23+z3CfuzCnDqZJO2j7oST6dg3BNps7oJtpjN3w4ZUHD/HkSBJe1dHBAf1vGE4/DJphtPE3GdUQ86Ys1/+WpF+ODt+t0hYBf6hOik/y6C9X2fLorAVaG1N+vWXvB053gXBb9xVIkqEUX7aUcDekMeWe03u0lr0u8JhsZG+pSqlw2hpwmuts2q5+w6nTWrF4sIt15ubz0dDW97BPvEM+2+VF0dlVPeHquW/jhpM6lQmUc9tbLnSo1a7bqNshw/wkDRA0zjPZzX8zf0RjtHmo9s78XmDRNXW/Ek/4Pg0+OziYZr0Sn+9QolqKUuZ8nepcf0b1G4bfrcvtFxezd549iXpVlX1KTKQfxO+TwWrj536RFrPGSLfmhtnVnqjlnn9/fHFJbagKXaGp9VZryxJT5+w42R+muv3rKNdtEiJrlm0bjqOwCywrVD7TVzcvXola7i8PxwTSb8/ZeVHrjvHY7D10inViIdXivnmXvcbek1W94QZ667NeLf+IFA3BLPGo0IcsUFBhSoYgZ3nX9/xetybvmnO7+21dV+uibVDFXaiuCXWjs9RJ1XaPuuZR1CGKGkR9z2fQ8uEuTtTEibuubdMl7rmEFmnXVhn0Ttjh+sZGkgybF779ugXG/3PY8hBafsRL/4Xw0i241DvPLszv8PkAbQseGsNGbV8/hlEGWMY2lHErrHALqhAY+NMzuf3WuTW8331cpGPazlNamBVV5LeHaRIXxIMa95KSk1RzHaeiVtm8D3Fm3D4BfsQy0x4sJduNRpF9ulmjUZfQvI/RyeZtY6DWKzTzpmQ3nJd4Jen4StOw4nd9TxJFVaK15Zqv/C74PJXLhXSECgZ8LBO1mMlS0kbr76R5b+/3ajuGj31X84nhm8i4xJL25w4AUIs+Aa+0+Tyn7mgKAmZ0UZggKVSFUJlHv/w2wSiOUB4xrY2k0sQZklp62bRyhly8EkosOPjS2Jkhx5JykQWjZwS9Wl02PoSckKU2HnjmBfHdRVbia7qTYhDoKeVwgwW54jIgjDb1CK/lDYGWoHKYId/6FpmTdBR0GhpV6uyzbxk0ZQm1dh7GJ/AhlpGmOyOU5XvfHusONugUFnBPtOFQ/cEiWfiNVJ/paiFdJrro/Oojzqx02N/VXq1WN/blp8M5P0r3UzODd1hrK5026372QrqimfFeHhPpfnhKP7YX4qOduqeR68zuuC6uM7tfYFnvv0dHHmL3T85OuTJ8Cr/+9e/wBoVRUOiV99asMViu+7v3pDlvea+2rrDzd8cbV5DGMxHuKHL+bDX4sRCOT/BUGUgVQsrfyjprZqXM+jv0o9Fxe4e9b30zVBKu0IfbmIT5C6j97FKqz2M4UWt/p77bRug5zxssg7eu6DuC6K57dKvrPOKOlcVy6a/xB0QGc+n7PEY3C88tFiYsbngxldZ2kudQb11OJVSuF8dfPeUWBl8MYARp133WwVXPYXcYVV5rqZw9htyIuevpp1s3VnkTu/GovezaqiMNZDqT+EgMK+6eeqxlq8oc5lvGcIihHXzaIWoZ3OmidUsgb/1n3NpfHOJ9OTqtU7m7E0d3aCr7dv4ezVJm7RH7loje58H7SZqUMsOAzoSd6uTHszew/HZ8kKRR7f4Fwb3/5vTV65/fvyZhKJF6hR2OD8YHfGdKW1cJFXHa+SFNdCNwoPnoat7jVziPX+E8foXz+BXO41c4j1/hPH6F8/gVzuNXOI9f4fxrfIUTEG2KoP26FFJF3TXfEbjYan4maXIcf3hzmSYFdRCOL5LrayrAPhBoSI//3DCMdXGZJkthJMFuDFCFCxV5BBrfUnZ/8y60VJ/CLd/w7JS/hekVYfSsEg++fcb11ldDm8tN2mL1JJof8coLsHdOdHoKNzpA1GzwM04yKijvHBu3XM7evj9P0qS991zxR0aJEStC68TKS+t3Df+BCj27TkqhFg23HRNPc+NvwhTD3sRn7k2EP2hVO/UxbFr4ZdB/aVE7J1xf+74Ho+t+vH9164yg2HY0Gedys9n8L9Ea2Is=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var s=t(74848),i=t(28453),o=t(33617),a=t.n(o),l=t(17543),d=t.n(l),p=t(86013),c=t.n(p),m=t(63723),u=t.n(m),h=(t(18766),t(79329),t(9303));const f={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW19z3DaS/yp9fHE8RY3+xM7tqXyuVRxvolpfrLLlc21pVBMM2TOETQJcAJzRrGqq9mG/wT7d6360fJKrboAkOBpJljf3sqdUKtGQQHej/6Hxa/A6cWJhk+OL5AedNRUqZ5PLNMnRZkbWTmqVHCfnBcIrg8IhtKNgbnQFDqu6pMcnZ6cgylKvLKx1A07DAhUaeqVwBXlLG2Zr+NRYB7XRS5lLtehoTGUOUlmHIgc9h6YuteABgknMZYnfSAWuQJhrU9GYmbD43TPQBmZSCbN+CrhEswYnK2Q5FGJOwmReeNEJMobzwNYSNTBY04i8XENjMWduFjKhYIZhdu6X3Fg0IJVDMxcZgnBwMRr9gLNmAR9OR6PLbwrnanu8vy/qeqxrVFYuVClmdpzpaj+ngXU+f0pCN5bX3yv3PFLneKIm6k+6YSG8thBynIumdLAUZcNqIKXDSuYLJN0KEl2zjqQBJSocvLdNXWvjAK8yrB2QYMI1BlOwTlR1ClJJJ0VpU5CVWOB4og7HMBphJWQ5Gk3UL7/8MlHXEwUwSYj6JDmGScKvJ0nqnxsUuVblmt7NRWkxPA+iR1N+j1eiqkskxUySidoEBhN1RFyJwe1M/V8P4flJ45DLt8Tlk57BuXTlHaxoiKMhD+OXoR7ye0b8Ml3VQq1v5xYGPFCfXpNQLx2ULh/yfU58c+HuWCK9fRjHw8O9g+d7RwdHz4fMviNmDq/cTF/dzi8MeBjLag00b8jv31mpBWaf72TYjngIx4tJojkD7h1Nksue6R6p0w87Ho2gjdFCLBG0QorsShsEVwjFD3y0ukI4TkiWMtIMwWKJGeWV2boNbA7637G9jK5zvVJ32CyMeJgS/YoOh0r8D+JoRC41zBrn9B1cedRvwHI0OjM4l2UJH312IlW2j9qEJQwCluh3DtYfPZHKoiG9SeV0lNNhhnPSu3QgLdhCGMxhJV0BgrP2GN6qcs35tpvCqV0bKISFGk0lrZWUQDWIPKeh1dhLa9DWWln0YvpsTJQi29pCN2VOW0lJOwO9xStpHSX5dnqg9kZaRxvYVmbmNbVaIBsc3h9Nu4LJ8+KXQuUGVzDDQfI7enBK6EjCJDl4tn/4fP/o4OhZTPPbr47EnvbFJKkEJ1qYJHP0f2+FXmyJ/6JSgnboQltUoSaJ9c7msaTqli+FmlRe0zS0LT/GXYp+QCCEUbfoyYv/m0gfc7t1BRD+CSmf9/DbF8CvdzuN/O/v375bHfzxx4U+OTk5+fn9h+L1h8XJyUlFv8fjcVhVIP3dVyesWFutuX8TfbW8btfVRCVpomuqUaVWp3lynIQ6L+QGyhztcJknaVILIyp0aKhcvuaFJcdJVL4maSKpXK6FK5LtGlrPPmHmTrm2beu8JE0M/rmRBvPk2JkG08S6dUlkraQNPUkTvKpLnWNy7PNrYrMCK5EcXyduXfNIZ6RaJGlCVbFw8ZNQFpBIPx3OiuyoqGfJZnPp2aJ13+t8TaQyrRwqR3+Kui5lxkrZ/2RJ9OuIZy/uRUL1IynjMm1F8WskVRnSrJNoWVAqnh4q8c/RscGXXzdUeqLA7y2ihM44YGvM5HzdltY8lUtl+qVwVa67gr4/DZzOQVfSOczTgZ/8+tf/sYHEinamGfrzwWDLTjZpp4x+lcIYsSaXcFjFz29RktG7ddRr5CTLdOOUUI4Ycgl9p1J5QEzgk8a45iYq3onv4vpJI+0eNLgutLpn9OHRt/Tvt4c0PpSyD7V8e2giEp/0bPpV7pPjkuaHDfbrzXK/gsL2O+UltwVRNGWmdYlCxXM4lDdpWybdTT+UvTN9lWw2aRtMW8kqykLT994Vp+3aNw+axkzmuszRUFK8SzL2e1T5dNsX+yVv4wjSRpE6BAxC3MKqQFeg4ccroRww9b5opnSgIcTbGAibGB6LpaUThmlwknBg92Waph8DEaKxIFQOSsMT5je1DTvEk/3we6bz9ZN+pi9OvcySUkkQgQd36cMOssZ4MvACYtsGcstul8KHOnzVWKcrYDZhEme37jQPIbeP4ZVQIFVWNqFWnWtSOCVGuL5uXcCH12YD19dkSzRTcvnNJu0fEK/BA04E/onBDOVyMKt7hP3E7lk0Fa9qadZTKjT9g5AvYgHkQkm1mDYm0FGaBo8HbrglONfyQQeYd94lF2rHqrtMyvb9Yu3fUHawOxH5f6P3F/XLn+QOUV7s1y9f1C8/IhS6Rh9xXj1zqXIf7yssyzG8sM5otXi5pYIX++H5blMaXEpccbiyVXsq27rtCI2DTH/STRwp0kJmmkyKkujWRmfYHhl9sXDlwDqsLQhLx0pWy1wir8GAWBjkwynLIhpXaCP/wqVTy/CFgMLg/D+fbOn0yUtKt1CgwRf74mUYfTrnNTKSINQaeOFSK0uYAmOZ88ZwcsxKYeQ81Gkp1CUKi0BlnMgcC+812spxXgj12aYvZublOYoK3taoSIJf//YPGtFm8lP11uRoviCVn87BImfiJ5THnqSg28P1XBrrQoL2+S94iJfrltAJ2GO5HsPrLuHbZmZplGrp9QnVGblYIB3xwwienHrrocgKv1WwVGJOuZ641+Q8urGteORg5P4lkoN53DQYagzfd0VeCpF2GF2I1z7ekdUJgj7XrwLpH8Q6rjVUU83Q3NApw9aEVodZkIu1JW5cctILUWYNA8Q+hoFimHY1dsfW++PKqOPUyXf4nFKeErMS356ffYGlaUGw58PYl9veBp4GvD0/gyX2zjiGD7azU2t4MRgCmc4RllJ406ewKmTGIbeGis54qNheIWvHgM3Yw0ywBzcFyqXdKVHqCw3Kvw2Ltosw5NJg5so1O5BuHAFAMhwuOAeMd1VwXgnnuvmSmLlHkwIWjczZ0o3p9nQ0No26JdQhMU3ms0LemPaYE5zWJzFrez21WqFBEf0UUFk/XcBcWIcmhUZxY8M0NUVDSxKvajQSVYY7VRCl7vv3T6rWuC+hfV1Wo7FaUXrTZiFUyJ7Uw1jRIR9mWIjSDw1pwsIMSSqK7vHOc8Ovf/tH0st16znppmCeg8hzg9beIyEjft6dCPwl0G8NTg8lInpofr/dBSLp2CWnlc47N7Vf7kFnhFQ62+XEAFd2UKltsoK2rC7X2ri3w80em9KS6GDBDSNd03o7IKXFJeVt0fcOSY9ZJAOjMRQz5FFqHYdPD+HqLXJ8IJDWP42L+J2eRk25+y1JeHwl1l3PjGiHRiEqyjw5nP3wB+7w+WpiB1xL59woi/rpN84+onF6arCS6sv2zPd+02AjOt2FfeN0JZzMoCVlxxCGenU7HUdxBd+0qqLoWEptnu5Ulyc31SrDqVRTbo3evwn9zI8ZQ6PdZ4Zuhahi2Vqj+a3Vw0Uk26pABQOdRDslLXoYHM9T0mGFZoHTjA7cHAj4BXocjYjaaAR7XpaQRG1jAhJPtgybKG83PXWSKJTmHSbY7//kF71z/qRXpLOuuqIa2NMnlQJLHuCimEMmlNLOn1XpuNh1jmlgJaTqWfhmANuLVxPqv6zQ2vMjzTGf9K41tSVR8PicQl903H2ERk4vSs0hHqrc8Hog1OmcuBe84bAJUyp/mU9jfazolULD8FhtcI6G9gfbnbd3vuUjsyit5qUNqLYe3fr81lG5denat0buh23+z3CfuzCnDqZJO2j7oST6dg3BNps7oJtpjN3w4ZUHD/HkSBJe1dHBAf1vGE4/DJphtPE3GdUQ86Ys1/+WpF+ODt+t0hYBf6hOik/y6C9X2fLorAVaG1N+vWXvB053gXBb9xVIkqEUX7aUcDekMeWe03u0lr0u8JhsZG+pSqlw2hpwmuts2q5+w6nTWrF4sIt15ubz0dDW97BPvEM+2+VF0dlVPeHquW/jhpM6lQmUc9tbLnSo1a7bqNshw/wkDRA0zjPZzX8zf0RjtHmo9s78XmDRNXW/Ek/4Pg0+OziYZr0Sn+9QolqKUuZ8nepcf0b1G4bfrcvtFxezd549iXpVlX1KTKQfxO+TwWrj536RFrPGSLfmhtnVnqjlnn9/fHFJbagKXaGp9VZryxJT5+w42R+muv3rKNdtEiJrlm0bjqOwCywrVD7TVzcvXola7i8PxwTSb8/ZeVHrjvHY7D10inViIdXivnmXvcbek1W94QZ667NeLf+IFA3BLPGo0IcsUFBhSoYgZ3nX9/xetybvmnO7+21dV+uibVDFXaiuCXWjs9RJ1XaPuuZR1CGKGkR9z2fQ8uEuTtTEibuubdMl7rmEFmnXVhn0Ttjh+sZGkgybF779ugXG/3PY8hBafsRL/4Xw0i241DvPLszv8PkAbQseGsNGbV8/hlEGWMY2lHErrHALqhAY+NMzuf3WuTW8331cpGPazlNamBVV5LeHaRIXxIMa95KSk1RzHaeiVtm8D3Fm3D4BfsQy0x4sJduNRpF9ulmjUZfQvI/RyeZtY6DWKzTzpmQ3nJd4Jen4StOw4nd9TxJFVaK15Zqv/C74PJXLhXSECgZ8LBO1mMlS0kbr76R5b+/3ajuGj31X84nhm8i4xJL25w4AUIs+Aa+0+Tyn7mgKAmZ0UZggKVSFUJlHv/w2wSiOUB4xrY2k0sQZklp62bRyhly8EkosOPjS2Jkhx5JykQWjZwS9Wl02PoSckKU2HnjmBfHdRVbia7qTYhDoKeVwgwW54jIgjDb1CK/lDYGWoHKYId/6FpmTdBR0GhpV6uyzbxk0ZQm1dh7GJ/AhlpGmOyOU5XvfHusONugUFnBPtOFQ/cEiWfiNVJ/paiFdJrro/Oojzqx02N/VXq1WN/blp8M5P0r3UzODd1hrK5026372QrqimfFeHhPpfnhKP7YX4qOduqeR68zuuC6uM7tfYFnvv0dHHmL3T85OuTJ8Cr/+9e/wBoVRUOiV99asMViu+7v3pDlvea+2rrDzd8cbV5DGMxHuKHL+bDX4sRCOT/BUGUgVQsrfyjprZqXM+jv0o9Fxe4e9b30zVBKu0IfbmIT5C6j97FKqz2M4UWt/p77bRug5zxssg7eu6DuC6K57dKvrPOKOlcVy6a/xB0QGc+n7PEY3C88tFiYsbngxldZ2kudQb11OJVSuF8dfPeUWBl8MYARp133WwVXPYXcYVV5rqZw9htyIuevpp1s3VnkTu/GovezaqiMNZDqT+EgMK+6eeqxlq8oc5lvGcIihHXzaIWoZ3OmidUsgb/1n3NpfHOJ9OTqtU7m7E0d3aCr7dv4ezVJm7RH7loje58H7SZqUMsOAzoSd6uTHszew/HZ8kKRR7f4Fwb3/5vTV65/fvyZhKJF6hR2OD8YHfGdKW1cJFXHa+SFNdCNwoPnoat7jVziPX+E8foXz+BXO41c4j1/hPH6F8/gVzuNXOI9f4fxrfIUTEG2KoP26FFJF3TXfEbjYan4maXIcf3hzmSYFdRCOL5LrayrAPhBoSI//3DCMdXGZJkthJMFuDFCFCxV5BBrfUnZ/8y60VJ/CLd/w7JS/hekVYfSsEg++fcb11ldDm8tN2mL1JJof8coLsHdOdHoKNzpA1GzwM04yKijvHBu3XM7evj9P0qS991zxR0aJEStC68TKS+t3Df+BCj27TkqhFg23HRNPc+NvwhTD3sRn7k2EP2hVO/UxbFr4ZdB/aVE7J1xf+74Ho+t+vH9164yg2HY0Gedys9n8L9Ea2Is=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,x={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,s.jsx)(n.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",properties:{widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"},response:{type:"string",format:"string",example:"andrew bee"}}}}}}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.78cbdeaf.js b/assets/js/c195e1f1.78cbdeaf.js new file mode 100644 index 000000000..8d6013d54 --- /dev/null +++ b/assets/js/c195e1f1.78cbdeaf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11z2ziSfwXHF09UtGQ7ydydK5daT5KdcW02diXOpbYslwYkWyJiEuACoGStS1X7sP/gnu51f9r8kqtugCQoS7aVyb3ceWpqxgKB7kajvxu4jSyfmej4Mnqr0roEaU10FUcZmFSLygolo+PoIgf2RgO3wJpZbKpVySyUVYHDJ+enjBeFWhi2VDWzis1AgsZPEhYsa2CzZMm+1saySqu5yISctTAmImNCGgs8Y2rK6qpQnCZwAjEVBfwgJLM5sKnSJc5JuIEfXzClWSIk18tnDOagl8yKEogOCZAhMakjnreEDNmFR2sQGtNQ4YysWLLaQEbYDEu5ZAn41Znbcm1AMyEt6ClPgXHLLgeDt5DUM/b5dDC4+iG3tjLHoxGvqqGqQBoxkwVPzDBV5SjDiVU2fYZE14b23zH3ImDncCzH8i+qJiIct4BlMOV1YdmcFzWxAZnOFiKbAfKWI+mKeCQ0k7yE3ndTV5XSlsFNCpVlSBi3tYaYGcvLKmZCCit4YWImSj6D4VgeDtlgACUXxWAwlr/++utY3o4lY+MIoY+jYzaO6PM4it24Bp4pWSzx25QXBvy4Jz1Y8ge44WVVADJmHI3lyiMYyyPEigi2I3V/7YLzq4I+lueI5atK2IWwxT2ocIrFKbvhS0H18b1AfKkqKy6X27H5CTvy03GSVXPLCpv18b5EvBm392wRv+6G8fBw/+Dl/tHB0cs+sh8RmYUbm6ib7fj8hN1QlkuG6/r4/pWYmkN6fS/CZsYuGC/HkSILuH80jq46pPvITjfteDBgjY7mfA5MSUDNLpUGZnMuacBpq825JYNk0CIlwAwUkKJdSZaNYpPS/xudl1ZVphbynjPzM3ZjotvRYZ+J/44YNc+EYkltrboHK836DigPD0jH6zIBfY+W0/dd0B34IXQRdcEdmD7qweBcw1QUBfviDCOeYjPU2EqugUEBzmnR0eGIkAY0HpmQVgXuhCUwxSMXlgnDTM41ZGwhbM44OYwhO5PFkkx9u4S8itIs54ZVoEthjEDbrRjPMpxaDh21GkylpAFHpnMECCkQK5OrusjQixXolPAr3Ahj0b80yz2098JY9J1rToH21HABD+TwYUXepMcOF33kMtOwYAn07O7RztaoBcnG0cGL0eHL0dHB0YsQ5vNvNgId7MtxVHKy8Sg94P5e0/rwJP6MUQwGB7kyIH04FPKdjscgqxu8qOVCOk7j1CbyGbbeYQcd9LO28MmR/12oD7Ft3QHz/3hvQ+HD9g3Q581CI/7zp7OPi4M//TxTJycnJx8+fc7ffZ6dnJyU+Hs4HPpdedA/frOtDLnVHPd34VeDazuvxjKKI1VheCyUPM2i48iHmN42oOVopossiqOKa16CBY2R+i1tLDqOgsg5iiOBkXrFbR6th+8q+QqpPaWwugkxozjS8NdaaMiiY6triCNjlwWCNQJjiSiO4KYqVAbRsbO1kUlzKHl0fBvZZUUzrRZyFsVkbbkNR3xEgiT9cpjk6VFeJdFqdeXQgrE/qWyJoFIlLUiLf/KqKkRKTBl9NUj6bYCzI/cywtAVmXEVN6S4PSKrNHLWCjBEKMZtu1L8IchYXOR3h6Unkjm3xgvWHg4zFaRiumyielpKUTr+krAolm0u0SUip1OmSmEtZHFPTn77+38bD2KBnikBl5r0ooVoFbfM6HbJteZLFAkLZTi+hUlabeZRx5GTNFW1lVxaREjR+71MpQkhgK8KwnAfoTghvg/rVwXoPXBylSv5wOzDo+f47/NDnO+j6F1PvsnXEMRXlUy+SXwymON672C//VgeZpB3vxPachMcBUsSpQrgMlxDqryKm5Dpfvg+4k7UTbRaxY0yrRmrwApNPjlRnDR7X+20jJBMVZGBRqN4H2Uk9yCzybosdlteL2EIE2hqv1bh9ZYtcrA5aBpecGkZQe/idTQHinl9GzIsi/QzcmEwudE1jCNS7C5MU/ijR0Iwl3GZManYHuGbmJoEYm/kfycqW+51K11w6mgWaEo8CTS5NR+mZzWG454UINpGkRt0mxje5+Gb2lhVMkLjF5F1awsJzNv2IXvDJRMyLWofq04VMhwNI7u9bUTAqddqxW5v8SxBT1DkV6u4G0BcvQEyBG5EQwpi3lvVDkG3sB0LlsJNJfRygoGmG/D2IiRAzKSQs0mtPRypcPKwJ4ZrhFMs73kAWStdYiY37Lq1pHS+j+b+HWb7c0cg/2/4/qp6/YvYQMqrUfX6VfX6C7BcVeA0zrFnKmTm9H0BRTFkr4zVSs5er7Hg1ciPbz5KDXMBC1JXOtUOyjpvW0BDT9NfVB1qijAs1XUqeIFwK61SaFJGFyzcWGYsVIZxg2klsWUqgPagGZ9poOSUaOG1zZUWf6PQqUH4irNcw/Q/9tZ4uvcazS3LQcOrEX/tZ59OaY9UxOByyWjjQkmD5Qwqo05rTcYxLbgWUx+nxawqgBtgGMbx1BLxjqMNHRc5l9cmfpXo1xfAS3ZWgUQKfvvHP3FGY8lP5ZnOQD/ClJ9OmQGyxHtox/Zipprkeiq0sd5AO/vnJcTRtUV1fNmzWA7Zu9bgmzoxOEs28DqDarWYzQBTfD+DFsfu9ICnuXMVRBWfoq1H7BUKj6pNQx4KGIp/AShgrmTrD2rIfmqDvJgF3KHqQrj34QarjtXvC/XGg37Ll2Gs4Soqd3hKFXMslPtVLONLg9go5MQPvEhrqk07HWaow+jVSBwb6Q8joxZTS9/hSzR5kicFnF2cP+KkcUNs36mxC7fdGTgY7OzinM2hE8Yh+2zac2oOnvemsFRlwOaCu6OP2SIXKanckpWY44Gk8/JWOyzYDF3Jie2zuwRlwmykKHaBBtrfmkjbBJhlQkNqiyUJkKotFoCETy7IBgw3RXCOCReqfozOPMBJzma1yOika936dNAmDho12JzRdeqsQlbrJs3xQuuMmDEdnxqu4KQAfsxAGrecsyk3FnTMakk9FV1XqA0NSLipQAuQKWxkQWC6H/afGK1RS0S5uKwCbZRE86b0jEtvPbF9ssAknyWQ88JN9WbCsASQKtTu4ca84bd//DPq6NqaJ90lzGHgWabBmAcopIqfEyesO2PRb8ms6lOE8ED/Yb0BhdSRSE5KlbViah4vQedYqbSmtYm+XNmWSk2d5uiyWltrwrYS9ZlMjFvCxIJ6VarC/baFlKYuKbZp30dAPqYBDVSNQZ1BiZLLUH26Eq5aA0cJgTBuNAziN0oa9gMfPklsBZR82bbrELbvUYJEy5Ox87d/pOaiiyY2lGsxzw2sqFt+J/fhtVUTDaWQj/OZn5zToEO0qlX72qqSW5GyBpQZMj/VsduqUItL9kPDKtSOuVD62UZ2OXATJVOYCDmhruzDTugDDVMNDb1PAnYBIEPamkNzrtWVi5C2RQ6S9XgSeErcdF85XsbIwxL0DCYpJtykCPAIPg4GCG0wYPuOFm9ETa19JR7P0jtRcjcddKTIh+ZtTbDz/ygXnXD+ohbIsza6whjYwUeWMqLcl4tCDCmXUlmXq2K62DatcWLJhexQuGYAnRftxsd/aa6Uw4ecIzzxfXtqQiIv8RmqPm+xOw0NhJ4XilTcR7n+c4+o0yliz8nh0BHGGP4Snto4XVELCZrKY5WGKWj0D6bNtzd+pZSZF0bR1npQG4luZH4tVW5EunKtkYfLNv9rdZ/7ak5tmSZuS9u7gujaNVi2Wd1TupmEtRtKXmlyv54cUEK7Ojo4wP/11eltrxmGjr9OMYaY1kWx/Jcofnx1+H6WNhXwXXmSfxVHf7tJ50fnTaG11sW3n+zDhdNNRbi1qxJISZ+Kx23FX0updbFv1T7uZb9VPAIbnLeQhZAwaQ5wkql00ux+RabTGD7bWcTa46b8qH/WD6CPnEC+2CRFQe4q9yh67tq4PlPHMAFtbnPBBpNaZVtH3Uzp2yehGZbGaSWJ+XeTR9Ba6V25d+58gQFbV91OHOCHOPji4GCSdkx8uYGJcs4LkdFNrgt1DfI7qt/W7XabC9Fbhx5JvSmLziRGwk2i71Fvt+G426SBtNbCLqlhdrPPK7Hvvh9fXmEbqgSbK2y9VcoQxdg5O45GfVM3ug1s3SpCsHretOHWQqwFx6rAL3VCmziprWJ/Vum12ylpbKuEc6GtgzQ0blleJ3RB7FxzVIgPfH7N9QjD99Hh8GB4EK3i2zUghsssUTd3L5nxSozmh8PDDWs2Xkq7Zz7U+7suMZbPhJw9tO6qO6JPKEZOUnoH1ZnZSvwJUP28HISzfOMzB46RMJ48SufHrsn4rpGxthu4ucHXttEum45Y2PZqu153WlktVU27qu1WBS2poCPVNZl6PSZqGwVdo7DN23R5wiaP78m2fZxes4YkvOukRFG/W+L6vWvV/99XzO7Xsp8KtP+HCrRr9VknPJuKjIcve+U9L6Fhnaq5SBDWbXrFk/XaydY6xpYyhkfg0nUU+7VE2X/fnJ9iXrgxLfSrghRgu5pGYQTeC6qv0DgJOVWhKWqYTT6DLON6yvkFilS56iye3WAQnE+7ajBoDZqTMUylzmrNKrUAPa0LEsNpATcC82VcBiV965qgwMsCjCmWdL15RglcJmbCYhnSF+RSXvFEFAI9u7sE56S9Cw7MkH3p2qh7mm5dwxwKDAjaioOcdQZ4ofT1FNuxMeMswUvRWAMDmXOZunKbcxNUNuLSlWgrLTAWshqpFo42Ja1GES+55DNSvjgUZpZBgbbIMK0SrPUaVdROhSwXhdKu0k0bonuaxMR3eAlGA8NRtOEachTFuS9pmtiVlA05BNyCzFgCdMOdp1Zg7mkVq2Wh0mvXo6iLglXKur4BVjtCGnG51VwauuPuiuv+DFqG+UIrGJ/FfzaAJ/xeyGu8y4i3ly5bufoCiREWunvpi8Xijl9+1l/zs7AYxnyEShlhlV52q2fCNqFKCKT94SD93Fz+Dzx1ByNTqdlwNV6lZpRDUY0+gUUJMaOT81MKRZ+x3/7+X+w9cC1ZrhZOWtNaQ7Hs3hkg59zJO7a1kaS7J1/bHDmecn8pkuxnw8EvObdUMsDIQEivUu4a2HmdFCLt3gsMBsfNff2u1061Gf9cwF//xCYDZ5VbXQh5PWQncuneD7RuBMdpXW8b5LqCNxPBvf7gGtlFgB1KA8XcPVnwJSDIhGssaVXPHLaQGL+5/k1Y3NtJlrFq7TYslgE7ctxdV+qZ0E0EKlltukDbu1vab0eDzColpDXHLNN8ajv48doVWXJid4aa27UNO2IPpj0Sp4l+x+2oK+6sRZl9e0tFI0Roes9YeCW8OF02YslQWn+PWLubSuSXg/IAhrsbC/cWdGnOpp9Az0Xa5PRbNHpEk0dRHBUiBV8O8p7q5Ofz92z+fHjQy0seodyj96dv3n349A6JQUPqGNbkJ5RJlVwGmDY+GgquIPY4H9wFfHpx9PTi6OnF0dOLo6cXR08vjp5eHD29OHp6cfT04ujpxdHvfHHki+moQaOq4EIGnUTX/bhca/RGcXQcPjK6iqMcuyXHl9HtLcZ+n7FeicN/ramCdnkVR3OuBVb8XIvEXR7Jgnr1loj/h4++ffyMbXmvtJH+pkMgsT1ALHF1v2tYrr2QWl2t4qZNgKS5GW8cAfsXCKeDcKfbhX0Ot+IkxVj23rlhe+n87NNFFEfNHe+SHlRFmi+wUMgXjlrnsNxjHBy7jQouZzW1WCMHc+Vu/eT9tsg1tUX8H7irjfzo90vcNvC/uKmNC25vXcuFCvtuvvu0dYVnbDMbD+dqtVr9D8AVTyE=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var s=n(74848),r=n(28453),a=n(33617),o=n.n(a),l=n(17543),d=n.n(l),c=n(86013),p=n.n(c),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11z2ziSfwXHF09UtGQ7ydydK5daT5KdcW02diXOpbYslwYkWyJiEuACoGStS1X7sP/gnu51f9r8kqtugCQoS7aVyb3ceWpqxgKB7kajvxu4jSyfmej4Mnqr0roEaU10FUcZmFSLygolo+PoIgf2RgO3wJpZbKpVySyUVYHDJ+enjBeFWhi2VDWzis1AgsZPEhYsa2CzZMm+1saySqu5yISctTAmImNCGgs8Y2rK6qpQnCZwAjEVBfwgJLM5sKnSJc5JuIEfXzClWSIk18tnDOagl8yKEogOCZAhMakjnreEDNmFR2sQGtNQ4YysWLLaQEbYDEu5ZAn41Znbcm1AMyEt6ClPgXHLLgeDt5DUM/b5dDC4+iG3tjLHoxGvqqGqQBoxkwVPzDBV5SjDiVU2fYZE14b23zH3ImDncCzH8i+qJiIct4BlMOV1YdmcFzWxAZnOFiKbAfKWI+mKeCQ0k7yE3ndTV5XSlsFNCpVlSBi3tYaYGcvLKmZCCit4YWImSj6D4VgeDtlgACUXxWAwlr/++utY3o4lY+MIoY+jYzaO6PM4it24Bp4pWSzx25QXBvy4Jz1Y8ge44WVVADJmHI3lyiMYyyPEigi2I3V/7YLzq4I+lueI5atK2IWwxT2ocIrFKbvhS0H18b1AfKkqKy6X27H5CTvy03GSVXPLCpv18b5EvBm392wRv+6G8fBw/+Dl/tHB0cs+sh8RmYUbm6ib7fj8hN1QlkuG6/r4/pWYmkN6fS/CZsYuGC/HkSILuH80jq46pPvITjfteDBgjY7mfA5MSUDNLpUGZnMuacBpq825JYNk0CIlwAwUkKJdSZaNYpPS/xudl1ZVphbynjPzM3ZjotvRYZ+J/44YNc+EYkltrboHK836DigPD0jH6zIBfY+W0/dd0B34IXQRdcEdmD7qweBcw1QUBfviDCOeYjPU2EqugUEBzmnR0eGIkAY0HpmQVgXuhCUwxSMXlgnDTM41ZGwhbM44OYwhO5PFkkx9u4S8itIs54ZVoEthjEDbrRjPMpxaDh21GkylpAFHpnMECCkQK5OrusjQixXolPAr3Ahj0b80yz2098JY9J1rToH21HABD+TwYUXepMcOF33kMtOwYAn07O7RztaoBcnG0cGL0eHL0dHB0YsQ5vNvNgId7MtxVHKy8Sg94P5e0/rwJP6MUQwGB7kyIH04FPKdjscgqxu8qOVCOk7j1CbyGbbeYQcd9LO28MmR/12oD7Ft3QHz/3hvQ+HD9g3Q581CI/7zp7OPi4M//TxTJycnJx8+fc7ffZ6dnJyU+Hs4HPpdedA/frOtDLnVHPd34VeDazuvxjKKI1VheCyUPM2i48iHmN42oOVopossiqOKa16CBY2R+i1tLDqOgsg5iiOBkXrFbR6th+8q+QqpPaWwugkxozjS8NdaaMiiY6triCNjlwWCNQJjiSiO4KYqVAbRsbO1kUlzKHl0fBvZZUUzrRZyFsVkbbkNR3xEgiT9cpjk6VFeJdFqdeXQgrE/qWyJoFIlLUiLf/KqKkRKTBl9NUj6bYCzI/cywtAVmXEVN6S4PSKrNHLWCjBEKMZtu1L8IchYXOR3h6Unkjm3xgvWHg4zFaRiumyielpKUTr+krAolm0u0SUip1OmSmEtZHFPTn77+38bD2KBnikBl5r0ooVoFbfM6HbJteZLFAkLZTi+hUlabeZRx5GTNFW1lVxaREjR+71MpQkhgK8KwnAfoTghvg/rVwXoPXBylSv5wOzDo+f47/NDnO+j6F1PvsnXEMRXlUy+SXwymON672C//VgeZpB3vxPachMcBUsSpQrgMlxDqryKm5Dpfvg+4k7UTbRaxY0yrRmrwApNPjlRnDR7X+20jJBMVZGBRqN4H2Uk9yCzybosdlteL2EIE2hqv1bh9ZYtcrA5aBpecGkZQe/idTQHinl9GzIsi/QzcmEwudE1jCNS7C5MU/ijR0Iwl3GZManYHuGbmJoEYm/kfycqW+51K11w6mgWaEo8CTS5NR+mZzWG454UINpGkRt0mxje5+Gb2lhVMkLjF5F1awsJzNv2IXvDJRMyLWofq04VMhwNI7u9bUTAqddqxW5v8SxBT1DkV6u4G0BcvQEyBG5EQwpi3lvVDkG3sB0LlsJNJfRygoGmG/D2IiRAzKSQs0mtPRypcPKwJ4ZrhFMs73kAWStdYiY37Lq1pHS+j+b+HWb7c0cg/2/4/qp6/YvYQMqrUfX6VfX6C7BcVeA0zrFnKmTm9H0BRTFkr4zVSs5er7Hg1ciPbz5KDXMBC1JXOtUOyjpvW0BDT9NfVB1qijAs1XUqeIFwK61SaFJGFyzcWGYsVIZxg2klsWUqgPagGZ9poOSUaOG1zZUWf6PQqUH4irNcw/Q/9tZ4uvcazS3LQcOrEX/tZ59OaY9UxOByyWjjQkmD5Qwqo05rTcYxLbgWUx+nxawqgBtgGMbx1BLxjqMNHRc5l9cmfpXo1xfAS3ZWgUQKfvvHP3FGY8lP5ZnOQD/ClJ9OmQGyxHtox/Zipprkeiq0sd5AO/vnJcTRtUV1fNmzWA7Zu9bgmzoxOEs28DqDarWYzQBTfD+DFsfu9ICnuXMVRBWfoq1H7BUKj6pNQx4KGIp/AShgrmTrD2rIfmqDvJgF3KHqQrj34QarjtXvC/XGg37Ll2Gs4Soqd3hKFXMslPtVLONLg9go5MQPvEhrqk07HWaow+jVSBwb6Q8joxZTS9/hSzR5kicFnF2cP+KkcUNs36mxC7fdGTgY7OzinM2hE8Yh+2zac2oOnvemsFRlwOaCu6OP2SIXKanckpWY44Gk8/JWOyzYDF3Jie2zuwRlwmykKHaBBtrfmkjbBJhlQkNqiyUJkKotFoCETy7IBgw3RXCOCReqfozOPMBJzma1yOika936dNAmDho12JzRdeqsQlbrJs3xQuuMmDEdnxqu4KQAfsxAGrecsyk3FnTMakk9FV1XqA0NSLipQAuQKWxkQWC6H/afGK1RS0S5uKwCbZRE86b0jEtvPbF9ssAknyWQ88JN9WbCsASQKtTu4ca84bd//DPq6NqaJ90lzGHgWabBmAcopIqfEyesO2PRb8ms6lOE8ED/Yb0BhdSRSE5KlbViah4vQedYqbSmtYm+XNmWSk2d5uiyWltrwrYS9ZlMjFvCxIJ6VarC/baFlKYuKbZp30dAPqYBDVSNQZ1BiZLLUH26Eq5aA0cJgTBuNAziN0oa9gMfPklsBZR82bbrELbvUYJEy5Ox87d/pOaiiyY2lGsxzw2sqFt+J/fhtVUTDaWQj/OZn5zToEO0qlX72qqSW5GyBpQZMj/VsduqUItL9kPDKtSOuVD62UZ2OXATJVOYCDmhruzDTugDDVMNDb1PAnYBIEPamkNzrtWVi5C2RQ6S9XgSeErcdF85XsbIwxL0DCYpJtykCPAIPg4GCG0wYPuOFm9ETa19JR7P0jtRcjcddKTIh+ZtTbDz/ygXnXD+ohbIsza6whjYwUeWMqLcl4tCDCmXUlmXq2K62DatcWLJhexQuGYAnRftxsd/aa6Uw4ecIzzxfXtqQiIv8RmqPm+xOw0NhJ4XilTcR7n+c4+o0yliz8nh0BHGGP4Snto4XVELCZrKY5WGKWj0D6bNtzd+pZSZF0bR1npQG4luZH4tVW5EunKtkYfLNv9rdZ/7ak5tmSZuS9u7gujaNVi2Wd1TupmEtRtKXmlyv54cUEK7Ojo4wP/11eltrxmGjr9OMYaY1kWx/Jcofnx1+H6WNhXwXXmSfxVHf7tJ50fnTaG11sW3n+zDhdNNRbi1qxJISZ+Kx23FX0updbFv1T7uZb9VPAIbnLeQhZAwaQ5wkql00ux+RabTGD7bWcTa46b8qH/WD6CPnEC+2CRFQe4q9yh67tq4PlPHMAFtbnPBBpNaZVtH3Uzp2yehGZbGaSWJ+XeTR9Ba6V25d+58gQFbV91OHOCHOPji4GCSdkx8uYGJcs4LkdFNrgt1DfI7qt/W7XabC9Fbhx5JvSmLziRGwk2i71Fvt+G426SBtNbCLqlhdrPPK7Hvvh9fXmEbqgSbK2y9VcoQxdg5O45GfVM3ug1s3SpCsHretOHWQqwFx6rAL3VCmziprWJ/Vum12ylpbKuEc6GtgzQ0blleJ3RB7FxzVIgPfH7N9QjD99Hh8GB4EK3i2zUghsssUTd3L5nxSozmh8PDDWs2Xkq7Zz7U+7suMZbPhJw9tO6qO6JPKEZOUnoH1ZnZSvwJUP28HISzfOMzB46RMJ48SufHrsn4rpGxthu4ucHXttEum45Y2PZqu153WlktVU27qu1WBS2poCPVNZl6PSZqGwVdo7DN23R5wiaP78m2fZxes4YkvOukRFG/W+L6vWvV/99XzO7Xsp8KtP+HCrRr9VknPJuKjIcve+U9L6Fhnaq5SBDWbXrFk/XaydY6xpYyhkfg0nUU+7VE2X/fnJ9iXrgxLfSrghRgu5pGYQTeC6qv0DgJOVWhKWqYTT6DLON6yvkFilS56iye3WAQnE+7ajBoDZqTMUylzmrNKrUAPa0LEsNpATcC82VcBiV965qgwMsCjCmWdL15RglcJmbCYhnSF+RSXvFEFAI9u7sE56S9Cw7MkH3p2qh7mm5dwxwKDAjaioOcdQZ4ofT1FNuxMeMswUvRWAMDmXOZunKbcxNUNuLSlWgrLTAWshqpFo42Ja1GES+55DNSvjgUZpZBgbbIMK0SrPUaVdROhSwXhdKu0k0bonuaxMR3eAlGA8NRtOEachTFuS9pmtiVlA05BNyCzFgCdMOdp1Zg7mkVq2Wh0mvXo6iLglXKur4BVjtCGnG51VwauuPuiuv+DFqG+UIrGJ/FfzaAJ/xeyGu8y4i3ly5bufoCiREWunvpi8Xijl9+1l/zs7AYxnyEShlhlV52q2fCNqFKCKT94SD93Fz+Dzx1ByNTqdlwNV6lZpRDUY0+gUUJMaOT81MKRZ+x3/7+X+w9cC1ZrhZOWtNaQ7Hs3hkg59zJO7a1kaS7J1/bHDmecn8pkuxnw8EvObdUMsDIQEivUu4a2HmdFCLt3gsMBsfNff2u1061Gf9cwF//xCYDZ5VbXQh5PWQncuneD7RuBMdpXW8b5LqCNxPBvf7gGtlFgB1KA8XcPVnwJSDIhGssaVXPHLaQGL+5/k1Y3NtJlrFq7TYslgE7ctxdV+qZ0E0EKlltukDbu1vab0eDzColpDXHLNN8ajv48doVWXJid4aa27UNO2IPpj0Sp4l+x+2oK+6sRZl9e0tFI0Roes9YeCW8OF02YslQWn+PWLubSuSXg/IAhrsbC/cWdGnOpp9Az0Xa5PRbNHpEk0dRHBUiBV8O8p7q5Ofz92z+fHjQy0seodyj96dv3n349A6JQUPqGNbkJ5RJlVwGmDY+GgquIPY4H9wFfHpx9PTi6OnF0dOLo6cXR08vjp5eHD29OHp6cfT04ujpxdHvfHHki+moQaOq4EIGnUTX/bhca/RGcXQcPjK6iqMcuyXHl9HtLcZ+n7FeicN/ramCdnkVR3OuBVb8XIvEXR7Jgnr1loj/h4++ffyMbXmvtJH+pkMgsT1ALHF1v2tYrr2QWl2t4qZNgKS5GW8cAfsXCKeDcKfbhX0Ot+IkxVj23rlhe+n87NNFFEfNHe+SHlRFmi+wUMgXjlrnsNxjHBy7jQouZzW1WCMHc+Vu/eT9tsg1tUX8H7irjfzo90vcNvC/uKmNC25vXcuFCvtuvvu0dYVnbDMbD+dqtVr9D8AVTyE=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,f={},b=[];function y(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,s.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,s.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,s.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"7",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"8",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"9",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"10",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": ""\n}\n'})}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",properties:{widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"},response:{type:"string",format:"string",example:"andrew bee"}}}}}}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.55ff1e1b.js b/assets/js/c4fbe420.55ff1e1b.js new file mode 100644 index 000000000..f430f37bd --- /dev/null +++ b/assets/js/c4fbe420.55ff1e1b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>g,default:()=>j,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtyG7eSv4Kd2qrEPMOrJF+0L6vYikPHlrS2HMeWdBRwBiQhzQBjACOKVrHqPJw/2Kd9PZ+WL9nqBjAXXiTZlnOUFPMQi4Nbo9Hd6Au6rwJDRzrYPgoOWZol1DAdnIRBzHSkeGa4FMF2cDhmxDeTZ4oODRcjsnPQJ0zQQcI0yTVTmhhJIsWgU5RrI1P+CVqJ8TOHRDN1AWOpJoMkZ5niwmgylIqMmGCK4sSxjPKUQcOEmzHJFIvZkAsWE21UHplcMd0ibzMpiM6jiGk9zBO7MpeCyCGhxZohMWOGoCpmciU0oSQX/GPOSKMhB2csMv240SDfx0zzkaCGxQCcH37K4wchmYx5NCYRFWTAYKsx7NQBzCrgDii0SYFr6oxFfMihs5usRXbimAOMNEmmIaGk0chV0mgQrkmm5AWPWexXk8MhoJQiagkXhqkhjRjiisEsYoTL+MkJFTEZ0ogn3NTRSGKujeKDHFZuHYtjccizbfI2SySNyVTmihw8+7HsbiSBb0eNxjM2yEfkbb/ROPl+bEymt9ttmmUtmTEB2EroQLcimbZj6JjFQ8QVUwxmRXwxqnkyJTSOyYTHI2Y0HoggkcymJJJSxVxY0sjoiBGRpwOmdIi7SaVihAtCiWI0njaNbOaakRdv9vcADSk1LXKQ5Doslou5YpFJpnZ6QI/f1Xf2dB5uAg1xMQpJSs8BS9yQjzmPzmHbmgk8WkcyiKtG4x3AW2CHa0fjMSFmzDWZsMFYynPCLqB5wpOEGMVHI6YajWPx22+/HYurY0HIcYA9joNtchy4KY6D0DaZacZsy7P9p29f7e4dnh6+P9gt2j2lzvXpPyt6DHkyP8Pb1y+LZkHT+ea9nVflAkIa136QMKoZUeyCswmeAxy13avHQjGsIifs6KIFBjGl4esRfCHkyv5Th+ZN//ne7usqLLYHSylPal12X+30X9b6ZGMp6tMc/LS/V58nV5VZ+nvPLVJs+wz+OXHwuhPZcQd02H+1++Zw59UBdJ65cwRqeJNnmVRw/O8sQW/DMR+LH1giJ4QqhtQTyTSVgmRU0ZQZlI1jarBZsY85Vyy2wo0mieeM7WPRJI0G4Ga70SBvrZTiMRMG5IhC1rckhwNatj+QDvTvi5hHwEpWLEwzBpKw1hVYDLq+caLJdq0wHsguK36AoybUSoMsAcEDXRUDqWb4BatPfBmSKUz8jAEd2WnHUvFPUhiaIBFdMGV4RJMq0wOAKCoNVSiyMsmF8V/dCuS9Y27gfWRpJ5UAtBiQm3KBLZqRC5rkTDuoJiEZA1SvWaaYRgnt5gXEi5iMGR+NV65H47Ncm9rEJNde7noo3Fr+VBG9DNE2pIlmhA9ruEzpOausRmRm74MW+WFKYjakeWJCwkFeGZWzFtmThtAsS3iEdynQgL2ocsWaeMqOfFp18jmw9wncIDGHuwSkEzTiFG6Mhw7o0l5AsD2Uu2ZMBZFi7qAjmUi1SEL4uY5HEklhmDAtsnNBeYLA281qwkWU5DEjg4RG5yFqAiFRcPfBqUxZkshJaPkDu+CNjDhH/BDNEqBCKQB+Id3yXJd3boscAqMU/AeNHtW4CNdVrDqZP5SwMqDAsyRBORQi4kJyJgfEcJOwEBg8o2IaktgqGezSDORlSKIxi87xL0VjLskgN0YKu7FYySyWE+FwOZTCaP5pCUf6ls/HaC8kmyF5GJLHIel2QtLthaS7GZLuw5B0H4ek1wlJrxeS3mZIeg8tWL3HDte0QHAVgG7PYtn8ebALcvol18jZIGB1IbMnNZndbZFGo+Cm+eu6vJOLLsXtBjIT2rru9yX82Og9cj+n8PNh77H7OcGu3U33cww/e93qvdJDSAxNs2uggOY7hcArF5aI4Ju7o48DL8/gIwii0DeUV7eDBxpm1b1swF644IbTRK/eju9xj3ZUgrSwqU3YFJLr6h05neXebKcKD6o4ICZtE4rVSpNneISit7D7rZa7WVZv3i57b/ZeAefrtv4Qtg6i6RBE0+r9F9LrHiFhHqavw8SjFioAKJlX48F1uEdYqEP0dTh4DDiAS2k1AqD1Hu2+Ao412PCGt22dzWZ3q9nr9DZrGADL2nZI02YcN6fT6V1gD3QetzyoPF5DtZodeDCGSqZLzA+0DspeTifCv73K/goU9QErnCjgNaj7YLy/oKplGxnT6XfaTuWHFsoZ9C9Vs2kFTGwCONB3Eo0ljxzw0MerZAMwCFuAgyZish3H7Qom4WMcN9O0OfcRfjYR8ZWPadqK49Zcz4XTsR9TEschWfy89HsckzRNV3y232uf22m6uItWmjrYUPl6AkzidLbVfOI6/FGsUnJEfeFr2Qj8TlIkuDaac8v5aO6yGXPv5nFEReY6KDbKE6rYJdilet53coc85lms1OzRjnWeBOYVa/L9vtPeHzjyhy3UJ4AvN49b2BlMsuPcwUSxEbskGTWGKYGTXdCEx9Zt27SuzUuaZmACtP9+fBz/7T/b6IAAG98QOAkS8xEHL2L770c7zQ8nS3rkWcZUBD6shMFKOiTMRC1yNGZJVjoyJ5NJa7Kho7GUifVinmnFhvb/p3JwdorgZi2qswfLdmpJo2LwA+nM2/uamRrGqCZ+5BKTH2kMeajbwdvW2TvXXLeuxz26ceZAgkbrPbG+wCClqJAAKbPyb2nGTB0HJ8UYa+Sz+IaxJ7dg1jGPWUIHLFlsujWjFZ8TOpW542/v1Kpv1VF0BW/QkHJR+C1wO52KmzKll3ONx6WLco6/LUKq3OmvHM+e/gRIwrX33NTRWR3tXFvooBTMBjcGjPgBZFBQ6VdzQQHY7djASiJ3djcsAf0Idizcin61G1aoHUwVMTBHygVP87Twjw6LWT3KUqd7VPEFIyFu41eonu7CCvTyhhVc4GnFAseii34M7/+4RjN1Pe6RrJgD6Xo2/hIpUrun7+iCvZkB/baqDLjkWoau9kIumE+v5r4W2YfrDXyydhB42aKIZQY8cl/LmgXIt76h0GdV9cOtprxqr3tEfUvA+sYU6Prd9e3zRURa3f2fiFBrYN+aWK1TMqWjayx3bL5H5OngWXBCdNEZae+Laxxy2H79drqd2na26tt52PkC66q27NcbV53iY2lV7cJjCLKwENjleUK9qL8LSe+mBMp8KtMsN1VWQIsf2d3f3T6qZqOEfwtJMySNkLRD8n1IHrTIa4ZxuKiI2bmrnCsbmePwziCHkEmUq2RKBopG8DSCtUYtcnX1MafCcDOdzUiDXF3B45PZrAW8cS7kxIbtji645obAI4zS1IllpJc82pCRboNN1N5jk+YzF9pvO9AekO/lHKNea1g6FHyuJblq2Dc2ryBCdKDYEF5rlHF84j/544G4KEtY6mLHLoIP+iJGk7gwElDg34Y0GgM2lBBJgmclEI8c0zLSbxU2KxurT1PsexKpyJhqa8ii5Qzbg3czZsxSF9Pak4bZgLbOpNDMyvJsCdBlQLrRmAuI+W5lUIwLv3GQJt278970nnSq4qX7cKsmLbfq8qWzSr5c47wBKWJx4T3erGyqcL4q3tosZft5vveTArKttPFEZqlP5klMEn6Osc2Y6yyhUyALf1c6KOeD5k/HUuqyh4tbOz7T2/V4uFQQEn/QKsKDX+t27j7aqAn7x3fgS5vzLtcPo7PZ7m61r3UvzzlFP19eE3Kbk0O/7a1ODnuWR7d2A3+pG/huCH/jLr1g3Ue9mvK20fl6BrgjZ1eVcW5wc92FM+vOvEpVdrulP+kP8+t8PfVtfgsLd04MP+regRheYch+LSUu2Kt3RnvkrozVZQR4C2v1WhP1qwm0Cuw3J9Ktu7Fsu52arvakpqo96VWJcmvrVkRZXXSOso4D/ssP+68nnZ+fj+TOzs7O3pu34923o52dnRR+t1qtpU6NZaeNy4AO6953u3sZ7/gVq7RaLUBhTA3dxuHtTIz+y44PV49pudcg38jTunUXwc0lDtWvlwJF1z/molnmPf12fP61HBiEgcwwdUWKfhxsBzEkyPi0jCBEBwjT5gcZT4Ptq8C94oQ/3RtJGNk+05BqcxXoaMxSCn95Cw6Sc+B1fxD6R/VBGOCzHsjUAaILtl2CQBBCyDkDvyDTMAeO277yvWzuQxA6LTzYDizRB2HgAq/FJ8JEJOEpRRYPg5lf8Lqpii/lVBr/KHJUYB54IP6F0+DQ2Vxy0hfNVJ1hVqK1nIwqRafBfB6Ufxnuw/p2XPH0NZn6u4Eb8EQUz5WxWxAG3LC0usqKQ1Py8zEdMQk7wSd/nzsWj4Wmn70mjMMcjC8Z6F5lfcnQMzk4/SJyhMHO/bHkrG95OrZ1ceE6qezAW2cWe2W4WT7aDwk+nG3dRKm+P2KZjqprWqfZwpqHq5I5Km/I9RgtYJpljKoW5lR8cbIX5vvRJMox/6yQxrWdFaAWO+vOwuDy5s1ckkg2faYI+T5hQ2NfdpBIKsHUg+pzsXuzud7m5iwMpjdvb/qn3N4jOLzJzbt7hyk2ZfrRvwPWjcezMBjfDOtPRRLQvxHYzYez8o51uWhFDupAxtNTL7dmN3X0lxn0g4TGvthXMVMVRAykTBgVC5joD60/XZLvwND5LrTvqTB3gyvtLzKb46hYxCAPDJ9ZellFnK5jEzuIe08Pvvhd+IDamc4HGnoJP5+2Ew6Yz5uERF/bg9tEWfSfMxqNIUPTvfKiQ+/cyyBVUebagwdudLhdEgbObRtegSYuRnVjrIIddNZX996qng58gcsVk533Dw9ugUu0FJs2Xc/qB3aXdg6yf3gAGXF86NS/FnmrC0x41NJaFwLqGLng1GfNFLJ9at+gMOvulD5fs4wwtFwuWpMsAhRzvRSiEDJnbLpOkdy9MHGZcAtHJHMDEQuX4Uy0YZmu4RGhKBB5KPPbUOUNmKRklOOTXwMs69Pj8NVfmdHGhc0cRzMjzpVP4nNkAT0hjbzEk8cKdKrMHxImtB1OyZBqw1QI6eSAeZWDUVFMyS4zpjgE+5aiQDGLutNcLdXX6jiop4e9ff3SpVn7PXimHAAH2olZTPIMqQY5oUhb9Cc3v/UFRQm4g6nTVYrhouqBIUznAcmY0pCKr4hUIyr4J5eaDxoJGFkDNqaJ7epEBXjKAR7g8DowXtb+/s9/VeBaqekuAmZXoHEMb1JvgBAtSUvwoOkrloEElHWIYD6m/nv+EgDokGlOUxkXjKRvT+MH+IpVF3LRRQCLCKTOozEYFoW81aGXsdqplRpNU7RfMYSYwX7ZJdemknjnn8cvyofXDPAYVWBANQS4GmheTKsMXkZG5dx0mB7I60mbxTW4wAs0N/JUsZSL291TVWeckYUgyI1MqeER8VPpVj0V10Z8PF+nUPPBggbUeMGlerCCVWG6UykidsrFKbtg6hYK3l7xnC+mUyBuM2FMVGHzSLLXWZkuOYF6AzWcVG4nTAquEeNWCHSXMjVipxGYKUh47BZ4bDRgtkaDNC0sTqzqXDmPistkR/kBoqScHSByOadFskV551bLSbTIT3ICOAtJZisLgBlv5weUEoQ8tnU6qitEVEDSKTpzINMUJi6iaynlZU0GF+DG88Ld9K0VHlmHDswCmdewTnjdnrwILbJIKGRP+9UtR9jNgVuF0EQiS5lxKYfjOlB9TJwd4xWERwgeYLuOz2aXE8HU7//4P41xfPs8RLdgCytbMcJPEy1tVm51Vk/Rnuatf2qBpN2TgWXG7vUeDy9AyoooLB3A4y9894AaFd40snR61K3nb2Z+X2dLu3D82pL+E5ma3U7nr2xJb3T+PJb0ZudPZEk/BmCdz/5mabJKu10qO3wM4voBZ5JZ/2Yi1fU9wbc/C4uIyTIEl+zQm9n/SuPfC/EbHALWY1AGE5wx6zeDaOh1OvDPnBD0laV8vaOy2FYy/Y8gvH0k4/oz8LWNrkfWD+PeTzoTaTQGnK2wmsru15NYNULTZtMX48HziO/zF/23n/rdPd7XffF6K3raf9g/z3795emLJy02fdGNer9Mf+39Yt6/S3T/TPLopxfjD+IXPXi6lb//9YN6/2tfvX/32tB3WzsDMRaD5z/yaLp1Nuh1+MunLzof3nUng+c/dj788iT7gJP/2Plwft6J0r2nA7EDfbL3v/4P3z/b3Xj1affTq8Pdy1efkictuvfx7Oll9OTV+e7D5oe+ar7aH/x89tFkr7fijb1f+cPH7BV7Jw47L6MaNXCRcMFO/VGf4r5P4bAtJW0uO/Y3MmVWZZlgQSsloVqW092MmhI6AuULUKfukAqYUjfxy+dBdh0iNjud026BhK1FJPQF5nFh4bhDec7EH7vT6vLGLg+gXqZJKbQCbjthe1DbbPW73aRmUa64mQbbR1fBZZNmvGnbt49OZidgPpixhOBlJjVCTM042A7a87FMqN+HkbKjBbKZUPDd/ZQPEOqd3EjySkbndmvIrwVTXnBl7EwtbYeN8wFy5oGiIF726MU5VW1g3Ha31Wl1gll4NTeJpiKGR0AL3E0z3r7otrpLxiyVBtf0Z3nzc4doQ0dcjG4ad1KeyRugG0satZMpNeSM/8xARXYHX+0VBhywP2YUbGc4aiDH12XIedcTlQ8GL4vvlsQzH7H1AdtaDHb+4l8SVa0EVY98RBODlEWMMig3FBRxxCCoRAbhRyXWBz8L8+GoZJ8iUOa1+y6qxb3NTdQfH3VR0dp4jDrM5sPZiUV+xTOOaQlV96592lTzU7pPdb9dEMz5yWrOqnlf1Uq/0Qq3kVtyzj1SALLMKwHegKXOADeqYvgtQaXXdeqIhJdBgMiNDiJys4OIfNypqVlu++UMpbKEGlGhEKHWU1V6QLM5AcLlYiiR6t1x72dMvAGPM8gT5JoF5ZglkUyLAlONhh/y+z//VYxqNAqbnBYVMPdzRTI5YQoqh2LlzIRdcvC+YFXTFNs0ehEwy4CmCdMaAvzCsJEt+wmJ6ODmdo7UiGZ0ANU3wU2LmQH4LrhyU+gWeTdmmDAylfl3yqZPXLAEbofCf1Wt3DmR6nyYyAkUxCQDSCsBDyYTYyoi6yy1IgSdfmCMgyM6U1xDTT0FUHMLmxRG0ciQlAo6Qq9dSKrIilnCQbATJQcQS9Ayya233FCeSGVfceKG8JkNInH3MoMm1PCBaRUbA2FfOJe5Dm3IwkoHV9NzANGhDGDh4MkwkuQikVB+E6JMeZKQTBob+QFDogojDDeKCg3av4XFn0GBMOfNZtr5hN5qBif8kotzW/SrSY4KunrHBpobVi8JMM+cD+pjnnMDV9xrlknNjVTTcvSIG3+NVScpftiZnvuysRUpfvtMnTfMAIXo9s5BH/WSB+T3f/wvecmoEmQsJ5Zao1yxZFpWqMViqnjyFm2FWoHxEppDRVaDRCpGPoSni+qn1KADao9NwNNnWco+nTrIBwmPitLAutHYJk9tAeCi5m89hdnmw0AQi5LMjk64OG+RHTG1lW4Lfxp8x3G1bWAIakXF3bLO7mFldZZqllwwXXEoQv1cDA0qmY/salVg3Obq6UGwt504Xsi2AadyCY51g2FMjlp/GNSoXZKgU8u+qVfHYyLGOph6m6D6Vc4fzuUMYZhu4ZNPNypLINtpKmWYAZNux8VX6yqc00Dq8hZdkLCgrhVAphl35HTkyZLUa218PllbE1oYGqG+7W9QmvGlYReoAqr3h2+gvHTk7b8VHN3Gzu0gDBIeMWfPu/tr5/nBS3Kx0erUdNZbMHf7Zf/p7t6bXQAGBKlFmNddUa1OqaishGW0C0Kdv9oqzwTX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfvNXbX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfvi6xYV9++L0WN19W3/wgKXFffXlffXlffXlffXlffXlffXlffXlffXlffXlff/mu6gdfVt9fVt9fVt9fVt9fVt9fVt9fVt9fVt//K1bcryavtLKFcVApE2Dz2o7ma3CdhMIY89+2j4OoKCO+tSmYz+PwxxzTao5MwuKCKwwNKTJEPfYY1ZMueM8i0fWrfgzYPYfnQnjNmKM1VBoAUcTtiB7d+bd9qKv7B/pvDIAwGrm54KmMsGkInkF1LJzb7uJKCi9+ugoSKUY7pu4Gdc2ZLrI3rGeXnmFHu/qjkAEPmdQlhPdXcbgP+D5taOuDqymarz2ZFf9u0coRDrO8Nx3cym83+H0lGrrc=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const f={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyG7eSv4Kd2qrEPMOrJF+0L6vYikPHlrS2HMeWdBRwBiQhzQBjACOKVrHqPJw/2Kd9PZ+WL9nqBjAXXiTZlnOUFPMQi4Nbo9Hd6Au6rwJDRzrYPgoOWZol1DAdnIRBzHSkeGa4FMF2cDhmxDeTZ4oODRcjsnPQJ0zQQcI0yTVTmhhJIsWgU5RrI1P+CVqJ8TOHRDN1AWOpJoMkZ5niwmgylIqMmGCK4sSxjPKUQcOEmzHJFIvZkAsWE21UHplcMd0ibzMpiM6jiGk9zBO7MpeCyCGhxZohMWOGoCpmciU0oSQX/GPOSKMhB2csMv240SDfx0zzkaCGxQCcH37K4wchmYx5NCYRFWTAYKsx7NQBzCrgDii0SYFr6oxFfMihs5usRXbimAOMNEmmIaGk0chV0mgQrkmm5AWPWexXk8MhoJQiagkXhqkhjRjiisEsYoTL+MkJFTEZ0ogn3NTRSGKujeKDHFZuHYtjccizbfI2SySNyVTmihw8+7HsbiSBb0eNxjM2yEfkbb/ROPl+bEymt9ttmmUtmTEB2EroQLcimbZj6JjFQ8QVUwxmRXwxqnkyJTSOyYTHI2Y0HoggkcymJJJSxVxY0sjoiBGRpwOmdIi7SaVihAtCiWI0njaNbOaakRdv9vcADSk1LXKQ5Doslou5YpFJpnZ6QI/f1Xf2dB5uAg1xMQpJSs8BS9yQjzmPzmHbmgk8WkcyiKtG4x3AW2CHa0fjMSFmzDWZsMFYynPCLqB5wpOEGMVHI6YajWPx22+/HYurY0HIcYA9joNtchy4KY6D0DaZacZsy7P9p29f7e4dnh6+P9gt2j2lzvXpPyt6DHkyP8Pb1y+LZkHT+ea9nVflAkIa136QMKoZUeyCswmeAxy13avHQjGsIifs6KIFBjGl4esRfCHkyv5Th+ZN//ne7usqLLYHSylPal12X+30X9b6ZGMp6tMc/LS/V58nV5VZ+nvPLVJs+wz+OXHwuhPZcQd02H+1++Zw59UBdJ65cwRqeJNnmVRw/O8sQW/DMR+LH1giJ4QqhtQTyTSVgmRU0ZQZlI1jarBZsY85Vyy2wo0mieeM7WPRJI0G4Ga70SBvrZTiMRMG5IhC1rckhwNatj+QDvTvi5hHwEpWLEwzBpKw1hVYDLq+caLJdq0wHsguK36AoybUSoMsAcEDXRUDqWb4BatPfBmSKUz8jAEd2WnHUvFPUhiaIBFdMGV4RJMq0wOAKCoNVSiyMsmF8V/dCuS9Y27gfWRpJ5UAtBiQm3KBLZqRC5rkTDuoJiEZA1SvWaaYRgnt5gXEi5iMGR+NV65H47Ncm9rEJNde7noo3Fr+VBG9DNE2pIlmhA9ruEzpOausRmRm74MW+WFKYjakeWJCwkFeGZWzFtmThtAsS3iEdynQgL2ocsWaeMqOfFp18jmw9wncIDGHuwSkEzTiFG6Mhw7o0l5AsD2Uu2ZMBZFi7qAjmUi1SEL4uY5HEklhmDAtsnNBeYLA281qwkWU5DEjg4RG5yFqAiFRcPfBqUxZkshJaPkDu+CNjDhH/BDNEqBCKQB+Id3yXJd3boscAqMU/AeNHtW4CNdVrDqZP5SwMqDAsyRBORQi4kJyJgfEcJOwEBg8o2IaktgqGezSDORlSKIxi87xL0VjLskgN0YKu7FYySyWE+FwOZTCaP5pCUf6ls/HaC8kmyF5GJLHIel2QtLthaS7GZLuw5B0H4ek1wlJrxeS3mZIeg8tWL3HDte0QHAVgG7PYtn8ebALcvol18jZIGB1IbMnNZndbZFGo+Cm+eu6vJOLLsXtBjIT2rru9yX82Og9cj+n8PNh77H7OcGu3U33cww/e93qvdJDSAxNs2uggOY7hcArF5aI4Ju7o48DL8/gIwii0DeUV7eDBxpm1b1swF644IbTRK/eju9xj3ZUgrSwqU3YFJLr6h05neXebKcKD6o4ICZtE4rVSpNneISit7D7rZa7WVZv3i57b/ZeAefrtv4Qtg6i6RBE0+r9F9LrHiFhHqavw8SjFioAKJlX48F1uEdYqEP0dTh4DDiAS2k1AqD1Hu2+Ao412PCGt22dzWZ3q9nr9DZrGADL2nZI02YcN6fT6V1gD3QetzyoPF5DtZodeDCGSqZLzA+0DspeTifCv73K/goU9QErnCjgNaj7YLy/oKplGxnT6XfaTuWHFsoZ9C9Vs2kFTGwCONB3Eo0ljxzw0MerZAMwCFuAgyZish3H7Qom4WMcN9O0OfcRfjYR8ZWPadqK49Zcz4XTsR9TEschWfy89HsckzRNV3y232uf22m6uItWmjrYUPl6AkzidLbVfOI6/FGsUnJEfeFr2Qj8TlIkuDaac8v5aO6yGXPv5nFEReY6KDbKE6rYJdilet53coc85lms1OzRjnWeBOYVa/L9vtPeHzjyhy3UJ4AvN49b2BlMsuPcwUSxEbskGTWGKYGTXdCEx9Zt27SuzUuaZmACtP9+fBz/7T/b6IAAG98QOAkS8xEHL2L770c7zQ8nS3rkWcZUBD6shMFKOiTMRC1yNGZJVjoyJ5NJa7Kho7GUifVinmnFhvb/p3JwdorgZi2qswfLdmpJo2LwA+nM2/uamRrGqCZ+5BKTH2kMeajbwdvW2TvXXLeuxz26ceZAgkbrPbG+wCClqJAAKbPyb2nGTB0HJ8UYa+Sz+IaxJ7dg1jGPWUIHLFlsujWjFZ8TOpW542/v1Kpv1VF0BW/QkHJR+C1wO52KmzKll3ONx6WLco6/LUKq3OmvHM+e/gRIwrX33NTRWR3tXFvooBTMBjcGjPgBZFBQ6VdzQQHY7djASiJ3djcsAf0Idizcin61G1aoHUwVMTBHygVP87Twjw6LWT3KUqd7VPEFIyFu41eonu7CCvTyhhVc4GnFAseii34M7/+4RjN1Pe6RrJgD6Xo2/hIpUrun7+iCvZkB/baqDLjkWoau9kIumE+v5r4W2YfrDXyydhB42aKIZQY8cl/LmgXIt76h0GdV9cOtprxqr3tEfUvA+sYU6Prd9e3zRURa3f2fiFBrYN+aWK1TMqWjayx3bL5H5OngWXBCdNEZae+Laxxy2H79drqd2na26tt52PkC66q27NcbV53iY2lV7cJjCLKwENjleUK9qL8LSe+mBMp8KtMsN1VWQIsf2d3f3T6qZqOEfwtJMySNkLRD8n1IHrTIa4ZxuKiI2bmrnCsbmePwziCHkEmUq2RKBopG8DSCtUYtcnX1MafCcDOdzUiDXF3B45PZrAW8cS7kxIbtji645obAI4zS1IllpJc82pCRboNN1N5jk+YzF9pvO9AekO/lHKNea1g6FHyuJblq2Dc2ryBCdKDYEF5rlHF84j/544G4KEtY6mLHLoIP+iJGk7gwElDg34Y0GgM2lBBJgmclEI8c0zLSbxU2KxurT1PsexKpyJhqa8ii5Qzbg3czZsxSF9Pak4bZgLbOpNDMyvJsCdBlQLrRmAuI+W5lUIwLv3GQJt278970nnSq4qX7cKsmLbfq8qWzSr5c47wBKWJx4T3erGyqcL4q3tosZft5vveTArKttPFEZqlP5klMEn6Osc2Y6yyhUyALf1c6KOeD5k/HUuqyh4tbOz7T2/V4uFQQEn/QKsKDX+t27j7aqAn7x3fgS5vzLtcPo7PZ7m61r3UvzzlFP19eE3Kbk0O/7a1ODnuWR7d2A3+pG/huCH/jLr1g3Ue9mvK20fl6BrgjZ1eVcW5wc92FM+vOvEpVdrulP+kP8+t8PfVtfgsLd04MP+regRheYch+LSUu2Kt3RnvkrozVZQR4C2v1WhP1qwm0Cuw3J9Ktu7Fsu52arvakpqo96VWJcmvrVkRZXXSOso4D/ssP+68nnZ+fj+TOzs7O3pu34923o52dnRR+t1qtpU6NZaeNy4AO6953u3sZ7/gVq7RaLUBhTA3dxuHtTIz+y44PV49pudcg38jTunUXwc0lDtWvlwJF1z/molnmPf12fP61HBiEgcwwdUWKfhxsBzEkyPi0jCBEBwjT5gcZT4Ptq8C94oQ/3RtJGNk+05BqcxXoaMxSCn95Cw6Sc+B1fxD6R/VBGOCzHsjUAaILtl2CQBBCyDkDvyDTMAeO277yvWzuQxA6LTzYDizRB2HgAq/FJ8JEJOEpRRYPg5lf8Lqpii/lVBr/KHJUYB54IP6F0+DQ2Vxy0hfNVJ1hVqK1nIwqRafBfB6Ufxnuw/p2XPH0NZn6u4Eb8EQUz5WxWxAG3LC0usqKQ1Py8zEdMQk7wSd/nzsWj4Wmn70mjMMcjC8Z6F5lfcnQMzk4/SJyhMHO/bHkrG95OrZ1ceE6qezAW2cWe2W4WT7aDwk+nG3dRKm+P2KZjqprWqfZwpqHq5I5Km/I9RgtYJpljKoW5lR8cbIX5vvRJMox/6yQxrWdFaAWO+vOwuDy5s1ckkg2faYI+T5hQ2NfdpBIKsHUg+pzsXuzud7m5iwMpjdvb/qn3N4jOLzJzbt7hyk2ZfrRvwPWjcezMBjfDOtPRRLQvxHYzYez8o51uWhFDupAxtNTL7dmN3X0lxn0g4TGvthXMVMVRAykTBgVC5joD60/XZLvwND5LrTvqTB3gyvtLzKb46hYxCAPDJ9ZellFnK5jEzuIe08Pvvhd+IDamc4HGnoJP5+2Ew6Yz5uERF/bg9tEWfSfMxqNIUPTvfKiQ+/cyyBVUebagwdudLhdEgbObRtegSYuRnVjrIIddNZX996qng58gcsVk533Dw9ugUu0FJs2Xc/qB3aXdg6yf3gAGXF86NS/FnmrC0x41NJaFwLqGLng1GfNFLJ9at+gMOvulD5fs4wwtFwuWpMsAhRzvRSiEDJnbLpOkdy9MHGZcAtHJHMDEQuX4Uy0YZmu4RGhKBB5KPPbUOUNmKRklOOTXwMs69Pj8NVfmdHGhc0cRzMjzpVP4nNkAT0hjbzEk8cKdKrMHxImtB1OyZBqw1QI6eSAeZWDUVFMyS4zpjgE+5aiQDGLutNcLdXX6jiop4e9ff3SpVn7PXimHAAH2olZTPIMqQY5oUhb9Cc3v/UFRQm4g6nTVYrhouqBIUznAcmY0pCKr4hUIyr4J5eaDxoJGFkDNqaJ7epEBXjKAR7g8DowXtb+/s9/VeBaqekuAmZXoHEMb1JvgBAtSUvwoOkrloEElHWIYD6m/nv+EgDokGlOUxkXjKRvT+MH+IpVF3LRRQCLCKTOozEYFoW81aGXsdqplRpNU7RfMYSYwX7ZJdemknjnn8cvyofXDPAYVWBANQS4GmheTKsMXkZG5dx0mB7I60mbxTW4wAs0N/JUsZSL291TVWeckYUgyI1MqeER8VPpVj0V10Z8PF+nUPPBggbUeMGlerCCVWG6UykidsrFKbtg6hYK3l7xnC+mUyBuM2FMVGHzSLLXWZkuOYF6AzWcVG4nTAquEeNWCHSXMjVipxGYKUh47BZ4bDRgtkaDNC0sTqzqXDmPistkR/kBoqScHSByOadFskV551bLSbTIT3ICOAtJZisLgBlv5weUEoQ8tnU6qitEVEDSKTpzINMUJi6iaynlZU0GF+DG88Ld9K0VHlmHDswCmdewTnjdnrwILbJIKGRP+9UtR9jNgVuF0EQiS5lxKYfjOlB9TJwd4xWERwgeYLuOz2aXE8HU7//4P41xfPs8RLdgCytbMcJPEy1tVm51Vk/Rnuatf2qBpN2TgWXG7vUeDy9AyoooLB3A4y9894AaFd40snR61K3nb2Z+X2dLu3D82pL+E5ma3U7nr2xJb3T+PJb0ZudPZEk/BmCdz/5mabJKu10qO3wM4voBZ5JZ/2Yi1fU9wbc/C4uIyTIEl+zQm9n/SuPfC/EbHALWY1AGE5wx6zeDaOh1OvDPnBD0laV8vaOy2FYy/Y8gvH0k4/oz8LWNrkfWD+PeTzoTaTQGnK2wmsru15NYNULTZtMX48HziO/zF/23n/rdPd7XffF6K3raf9g/z3795emLJy02fdGNer9Mf+39Yt6/S3T/TPLopxfjD+IXPXi6lb//9YN6/2tfvX/32tB3WzsDMRaD5z/yaLp1Nuh1+MunLzof3nUng+c/dj788iT7gJP/2Plwft6J0r2nA7EDfbL3v/4P3z/b3Xj1affTq8Pdy1efkictuvfx7Oll9OTV+e7D5oe+ar7aH/x89tFkr7fijb1f+cPH7BV7Jw47L6MaNXCRcMFO/VGf4r5P4bAtJW0uO/Y3MmVWZZlgQSsloVqW092MmhI6AuULUKfukAqYUjfxy+dBdh0iNjud026BhK1FJPQF5nFh4bhDec7EH7vT6vLGLg+gXqZJKbQCbjthe1DbbPW73aRmUa64mQbbR1fBZZNmvGnbt49OZidgPpixhOBlJjVCTM042A7a87FMqN+HkbKjBbKZUPDd/ZQPEOqd3EjySkbndmvIrwVTXnBl7EwtbYeN8wFy5oGiIF726MU5VW1g3Ha31Wl1gll4NTeJpiKGR0AL3E0z3r7otrpLxiyVBtf0Z3nzc4doQ0dcjG4ad1KeyRugG0satZMpNeSM/8xARXYHX+0VBhywP2YUbGc4aiDH12XIedcTlQ8GL4vvlsQzH7H1AdtaDHb+4l8SVa0EVY98RBODlEWMMig3FBRxxCCoRAbhRyXWBz8L8+GoZJ8iUOa1+y6qxb3NTdQfH3VR0dp4jDrM5sPZiUV+xTOOaQlV96592lTzU7pPdb9dEMz5yWrOqnlf1Uq/0Qq3kVtyzj1SALLMKwHegKXOADeqYvgtQaXXdeqIhJdBgMiNDiJys4OIfNypqVlu++UMpbKEGlGhEKHWU1V6QLM5AcLlYiiR6t1x72dMvAGPM8gT5JoF5ZglkUyLAlONhh/y+z//VYxqNAqbnBYVMPdzRTI5YQoqh2LlzIRdcvC+YFXTFNs0ehEwy4CmCdMaAvzCsJEt+wmJ6ODmdo7UiGZ0ANU3wU2LmQH4LrhyU+gWeTdmmDAylfl3yqZPXLAEbofCf1Wt3DmR6nyYyAkUxCQDSCsBDyYTYyoi6yy1IgSdfmCMgyM6U1xDTT0FUHMLmxRG0ciQlAo6Qq9dSKrIilnCQbATJQcQS9Ayya233FCeSGVfceKG8JkNInH3MoMm1PCBaRUbA2FfOJe5Dm3IwkoHV9NzANGhDGDh4MkwkuQikVB+E6JMeZKQTBob+QFDogojDDeKCg3av4XFn0GBMOfNZtr5hN5qBif8kotzW/SrSY4KunrHBpobVi8JMM+cD+pjnnMDV9xrlknNjVTTcvSIG3+NVScpftiZnvuysRUpfvtMnTfMAIXo9s5BH/WSB+T3f/wvecmoEmQsJ5Zao1yxZFpWqMViqnjyFm2FWoHxEppDRVaDRCpGPoSni+qn1KADao9NwNNnWco+nTrIBwmPitLAutHYJk9tAeCi5m89hdnmw0AQi5LMjk64OG+RHTG1lW4Lfxp8x3G1bWAIakXF3bLO7mFldZZqllwwXXEoQv1cDA0qmY/salVg3Obq6UGwt504Xsi2AadyCY51g2FMjlp/GNSoXZKgU8u+qVfHYyLGOph6m6D6Vc4fzuUMYZhu4ZNPNypLINtpKmWYAZNux8VX6yqc00Dq8hZdkLCgrhVAphl35HTkyZLUa218PllbE1oYGqG+7W9QmvGlYReoAqr3h2+gvHTk7b8VHN3Gzu0gDBIeMWfPu/tr5/nBS3Kx0erUdNZbMHf7Zf/p7t6bXQAGBKlFmNddUa1OqaishGW0C0Kdv9oqzwTX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfvNXbX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfX1bfvi6xYV9++L0WN19W3/wgKXFffXlffXlffXlffXlffXlffXlffXlffXlffXlff/mu6gdfVt9fVt9fVt9fVt9fVt9fVt9fVt9fVt//K1bcryavtLKFcVApE2Dz2o7ma3CdhMIY89+2j4OoKCO+tSmYz+PwxxzTao5MwuKCKwwNKTJEPfYY1ZMueM8i0fWrfgzYPYfnQnjNmKM1VBoAUcTtiB7d+bd9qKv7B/pvDIAwGrm54KmMsGkInkF1LJzb7uJKCi9+ugoSKUY7pu4Gdc2ZLrI3rGeXnmFHu/qjkAEPmdQlhPdXcbgP+D5taOuDqymarz2ZFf9u0coRDrO8Nx3cym83+H0lGrrc=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,x={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": ""\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.fdb1ace5.js b/assets/js/c4fbe420.fdb1ace5.js deleted file mode 100644 index 9328cb789..000000000 --- a/assets/js/c4fbe420.fdb1ace5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtyG7eSv4Kd2qrEPEOKpCRftC+rOIpDx5a0lmzHlnQUcAbkQJoBJgBGFK1S1Xk4f7BP+3o+LV+y1Q1gLrxIsi0n9inmIRYHt0aju9EXdF8Fho51sHUUHLIsT6lhOjgJg5jpSPHccCmCreAwYcQ3kx8VHRkuxmR7f0CYoMOUaVJopjQxkkSKQaeo0EZm/AO0EuNnDolm6gLGUk2GacFyxYXRZCQVGTPBFMWJYxkVGYOGCTcJyRWL2YgLFhNtVBGZQjHdIa9zKYguoohpPSpSuzKXgsgRoeWaITEJQ1AVM4USmlBSCP57wUirJYdnLDKDuNUi38dM87GghsUAnB9+yuMHIZkkPEpIRAUZMthqDDt1ALMauEMKbVLgmjpnER9x6Owm65DtOOYAI03TaUgoabUKlbZahGuSK3nBYxb71eRoBCiliFrChWFqRCOGuGIwixjjMn5yQkVMRjTiKTdNNJKYa6P4sICVO8fiWBzyfIu8zlNJYzKVhSL7P/5UdTeSwLejVutHNizG5PWg1Tr5PjEm11trazTPOzJnArCV0qHuRDJbi6FjHo8QV0wxmBXxxajm6ZTQOCYTHo+Z0XgggkQyn5JIShVzYUkjp2NGRJENmdIh7iaTihEuCCWK0XjaNrJdaEaeH+ztAhoyajpkPy10WC4Xc8Uik07t9IAev6vv7Ok83AAa4mIckoyeA5a4Ib8XPDqHbWsm8GgdySCuWq23AG+JHa4djceEmIRrMmHDRMpzwi6gecLTlBjFx2OmWq1j8dtvvx2Lq2NByHGAPY6DLXIcuCmOg9A2mWnObMuPe09fv9zZPTw9fLe/U7Z7Sp3pM/ix7DHi6ewMr1+9KJsFzWabd7dfVgsIaVz7fsqoZkSxC84meA5w1HavHgvlsJqcsKPLFhjElIavR/CFkCv7TxOag8Gz3Z1XdVhsD5ZRnja67LzcHrxo9MkTKZrT7P+8t9ucp1C1WQa7zyxSbPs1/HPi4HUnsu0O6HDwcufgcPvlPnS+ducI1HBQ5LlUcPxvLUFvwTEfix9YKieEKobUE8ksk4LkVNGMGZSNCTXYrNjvBVcstsKNpqnnjK1j0SatFpDCVqtFBiLmEbCGZfNpzkCy2b4d2xVYBroeOFFju9YYCWSRFSfAIRNquTtPQZBAV8VAShl+wZoTX4ZkChP/yIAu7LSJVPyDFIamSBQXTBke0bTOxAAgij5DFYqgXHJh/Fe3AnnnmBV4GVnUSRkALQZkZVxgi2bkgqYF0w6qSUgSgOoVyxXTKHHdvIBIEZOE8XGydD0anxXaNCYmhfZy1EPh1vKnhOhliLYRTTUjfNTAZUbPWW01InMr3zvkhymJ2YgWqQkJB/ljVME6ZFcaQvM85RHejSDO7cVTKNbGU3bk4AABVgEg9u39ADdCzOFuAGkDjTiFG+OhAzqzFwpsD+WoSaggUswcdCRTqeZJCD838UgiKQwTpkO2LyhPEXi7WU24iNIiZmSY0ug8xJs9JAruMjiVKUtTOQktvWMXvGER54gfolkKVCgFwC+kW57r6g7tkEOQPyU/QaNHNS7CdR2rToaPJKwMKPAsRlCuhIi4kJzJITHcpCwEhs2pmIYktkoDuzRDeRmSKGHROf6laMwlGRbGSGE3FiuZx3IiHC5HUhjNPyzgSN/y8Rjth2QjJA9D8jgkvW5Iev2Q9DZC0nsYkt7jkPS7Ien3Q9LfCEn/oQWr/9jhmpYIrgPQ61ssm28HuyB3X3CNnA0CU5cyeNKQwb0OabVKbpq9fqs7tuxS3lYgM6Gt535fwo/1/iP3cwo/H/Yfu58T7NrbcD8T+Nnv1e+JPkJiaJbfAAU03ysEXlmwRATf3J17HHh5Bh9BEIW+obqKHTzQcF3fyzrshQtuOE318u34Hl/RjiqQ5ja1AZtCcl2+I6eDfDXbqcODKguISduEYrXW5BkeoejP7X6z426W5Zu3y341e6+B83lbfwhbB9F0CKJp+f5L6fUVIWEWps/DxKMOKgAomZfjwXX4irDQhOjzcPAYcACX0nIEQOtXtPsaONYAwxvetnU32r3Ndr/b32hgACxl2yHL2nHcnk6n94E90Hnc8qDyeA3VanbgkRgpmS0wP9A6qHo5nQj/9ir7S1DUh6x0ioAXoOlT8fZ/Xcs2MqbT77Sdyg8tlTPoX6lm0xqY2ARwoC8kSiSPHPDQx6tkQzDwOoCDNmJyLY7XapiEj3HczrL2zEf42UbE1z5mWSeOOzM9507HfsxIHIdk/vPC73FMsixb8tl+b3xey7L5XXSyzMGGytcTYBKnsy3nE9fhz2KViiOaC9/IRuBHkiLFtdGcW8xHM5dNwr3bxhEVmemg2LhIqWKXYJfqWV/IPfKYZ7FKs0c7Fk1A6wxEVJDv95z2/sCRP2yhOQF8uX3c3M5gkm3n3iWKjdklyakxTAmc7IKmPLZu2LZ1VV7SLAcTYO3vx8fx3/5zDR0QYOMbAidBYj7m4BVc+/vRdvv9yYIeRZ4zFYFPKmWwkg4JM1GHHCUszSvH5GQy6UzWdZRImVqv5JlWbGT/fyqHZ6cIbt6hOn+waKeWNGoGP5DOrL2vmWlgjGriRy4w+ZHGkId6Xbxtnb1zw3XrenxFN84MSNBovSfWtxdkFBUSIGVW/S1NwtRxcFKOsUY+i28Ze3IHZk14zFI6ZOl8050Zrfyc0qksHH97p1Zzq46ia3iDhoyL0m+B2+nW3I4ZvZxpPK5cjjP8bRFS505/5Xj29CdAUq6956aJzvpo59pCh6NgNlgxZMQPIMOSSj+bC0rA7sYGVhK5s7tlCehHsGPpVvSr3bJC42DqiIE5Mi54VmSlf3RUzupRljndo44vGAlxGL9C/XTnVqCXt6zgAklLFjgWPfRjeP/HDZqp6/EVyYoZkG5m40+RIo17+p4u2NsZ0G+rzoALrmXoai/kkvn0cu7rkD243sAnaweBly2KWG7AI/e5rFmCfOcbCn1WdT/ccsqr9/qKqG8BWF+YAl2/+759PolI67v/hgi1AfadidU6JTM6vsFyx+aviDwdPHNOiFZrX7ERBI6rkCLxn3xkB0I6LGWZC3u5YCJcdegI58JIMAt8mLrVGrKRBCc4RLghlJLQKuho7xp7rPUouQ1tS0USqq0Ojko/HBeE8E3CMueO35WG2ViczqXQzJJhvgDoKpbWas348n23yp/Phd84HGvv/gzP/pNu/aB7DzcbB73ZbRx0d9lB32B3AglYXHhnHauaaoJBlWH/hXfTLN/7SQHZO/AKpDQ/LDfJIo1Jys8xLBNznad0CmTh2dxBORvve5pIqaseLuT2vdvwVjOUJxVE8x50ysjG53rMeo/W66ex+fge3AAzjrHmYXQ31nqbazd6xmb8OR+vVBByl5NDl9OdTg57Vke38mB9qgfrfgh//T4N+N6jfuPeWe9+PgPck51eZ5xbLPT7sMPvzSCus9sdTeE/zST9fOrb+BLK+YwYftS7BzG8RAf/XEqcU7XvjfbIfenZiwjwDor2jdr1ZxNoHdgvTqSb96OU97oNXe1JQ1V70q8T5ebmnYiyvugMZR0H/M0Pe68m3V+ejeX29vb27sHrZOf1eHt7O4PfnU5noT226LRxGdBh3VNTdy/jHb9klU6nAyiMqaFbOHwtF+P/suPD5WM6LpD9hZxEm/cRl1ngC/p8KVB2/escP1+Ozz+XA4MwkDm+opdiEAdbQQxv9f0L8SBEI5Vp84OMp8HWVeAeoMGf7nkXjFw70/Dq/yrQUcIyCn95Cw7yBOChcRD6971BGOCLBEgaAKILttxb5SCEaFkOLg2mYQ4ct3Xle9ln2EHotPBgK7BEH4SBixmVnwgTkYQocB6Pgmu/4E1TlV+qqTT+UT6Xh3ngbesnToNDr2fyJD5ppvoM1xVaq8moUnQazKZk+EetPiJpx5Wv9tKpvxu4AadK+dISuwVhwA3L6qssOTQlPx7TEZOwE3yt9LFj8Vho9tFrwjh8Dv4pA92Dkk8ZeiaHp59EjjDYuT8WnPUdT8e2zi/cJJVteKbJYq8Mt6v3xiHBN3+d2yjV90cs03F9TRvlmFvzcNk79NrzV52gBUzznFHVwefgn5x3gqlHNI0KTIUppXFjZyWo5c5612FweftmLkkk2/6RO/k+ZSNjg9Ikkkow9aD+0uWr2Vx/Y+M6DKa3b2/6TW7vERze5PbdvcXsgCpz4q+Adf3xdRgkt8P6c5m/8BcCu/HwurpjXVpMmQ43lPH01Mut69s6+ssM+kFu1UDsqZipGiKGUqaMijlMDEY2PiDJd2DofBfapyD47Jwr7S8ym26lWMQghQVfiHlZRZyuY9+kE/cUGMIKO/ABtTNdDDX0En4+bSccMp/CBTmHtge3OXvoP2c0SiBZzD1QoSPv3Msha0oW2oMHbnS4XVIGzm2TMG6zPbgYN42xGnbQWV/fe6d+OvAFLlfMu9w73L8DLtFSbNsELqsf2F3aOcje4T4k8/CRU/865LUuMeFRSxtdCKhj5IJT/+C/lO1TGz5n1t0pfepYFWHouDSaNpkHKOZ6IUQhPPq3mQZlnuncxFXuHxyRLAxELFyyJdGG5bqBR4SiROShLO5ClbdgkpJxga8VDbCsz+zBB0tVMg4XNokVzYy4UD7/yJEF9ISM1gpPHivQqTZ/SJjQdjglI6oNUyFktgLmVQFGRTklu8yZ4kxEbCEKFLOoOy3UQn2tiYNmZsvrVy9cxqffg2fKIXCgnZjFpMiRapATyowrf3KzW59TlIA7mDpdphjOqx6YF+U8IDlTGrKCFZFqTAX/4LKEQSMBI2vIEprark5UgKcc4AEObwLjZe0f//xXDa6lmu48YHYFGsfwnO4WCNGStAQPmr5iOUhA2YQI5mPqv2cvAYAOmeY0k3HJSPruNL6PD/B0KRddBLCMQOoiSsCwKOWtDr2M1U6t1Giaov2KIcQc9ssuuTa1nCH/sndePrxigMeoBgOqIcDVQPNiWmfwKjIqZ6bDzCbezDcrr8E5XqCFkaeKZVzc7Z6qO+OMLAVBYWRGDY+In0p3mlmENuLj+TqD9HMLGlDjBZfqwRJWhelOpYjYKRen7IKpOyh4u+VLpJhOgbjNhDFRh80jyV5nVabXBFKfGzip3U6Yz9ggxs0Q6C5jasxOIzBTkPDYHfDYasFsrRZpW1icWNWFch4Vl1SL8gNESTU7QOTS5cp34tWdW89s75Cf5QRwFpLcJjmDGW/nB5QShDy2JQPqK0RUQL4cOnMgSQ4mLqNrGeVVergLcON54W4G1gqPrEMHZoGkUVgnvGlPXoSWD+ApJH761S1H2M2BW4XQVCJLmaSSw3ETqAHm/CV4BeERggfYruMTceVEMPXHP/5PYxwfMkwjKLQwGC1vxQg/TbW0CYX1WT1Fe5q3/qk5knZPBhYZuzd7PLwAqYozsGwI71bw3QNqVHjTyMrp0bSev5j5fZMt7cLxK0v6GzI1e93uv7Mlvd79dizpje43ZEk/BmCdz/52abJMu10oO3wM4uYBZ5JZ/2Yq1c09wbd/HZYRk0UIrtihf23/q4x/L8RvcQhYj0EVTHDGrN8MoqHf7cI/M0LQF7nxpVequj/p9D+C8O6RjJvPwJdZuRlZPyT9n3UusigBnC2xmqruN5NYPUKzxqbPk+GziO/x54PXHwa9XT7QA/FqM3o6eDg4z3998/T5kw6bPu9F/TfTX/tvzLu3qR6cSR79/Dx5L97o4dPN4t2v79W7Xwfq3dtXhr7d3B6KRAyf/cSj6ebZsN/lL54+775/25sMn/3Uff/mSf4eJ/+p+/78vBtlu0+HYhv65O9+/R++d7az/vLDzoeXhzuXLz+kTzp09/ezp5fRk5fnOw/b7weq/XJv+MvZ7yZ/tRmv7/7KHz5mL9lbcdh9ETWogYuUC3bqj/oU930Kh20paWPRsR/IjFmVZYK1dZSEwj1OdzNqSugYlC9AnbpHKmBK3cYvHwfZTYjY6HZPeyUSNueRMBCYgoI1rA7lORN/7k7ryxu7PIB6maWV0Aq47YTtQWOz9e92k5pFheJmGmwdXQWXbZrztm3fOjq5PgHzwSQSgpe51AgxNUmwFazNxjKhlBhGyo6uLA+WjKapiOFNzhyz0ZyvXfQ6veA6nB2zkDlv6M+K9scO0YaOuRjfNu6kQtEBHKM9qQaiKoU1578w0FjdOdR7hQEH8kkYBVMWMA/U8aqKAO/4M/ax2UXh1uosZwOoPn7aCInO3sMLgpy1GOeRDzBizLAMGQbVhoIyrBcEtUAd/KiF3uBnqc0fVdRcxq28st1DLbW/sYHq3KMe6j3rj1Gl2Hh4fWKRX3NU40vuurfVvjRquA3dp6YbLQhm3FYN39Gs62ipG2eJF8ctOeOtKAFZ5CQA43yhbe5G1eywBaj0qkcTkfBQBxC53kVEbnQRkY+7Da3Hbb+aodJdUEEp9RNUQuo6CCgaJ0C4XIwkUr077r2ciQNwAINQQq6Z01VZGsmsLFXTavkhf/zzX+WoVqs0kWlZG2+vUCSXE6agpiDW1EvZJQdnCNY7zLBNo1GPSQw0S5nWEG8Xho1tQUBIaQWvs/NrRjSnQ6jLB15TfKiPz3Rrglt3yNuEwcsXaPpO2QzfC5aCsC7dSfWafhOpzkepnECpPDKEMlbgUGQioSKyvksrQtAHB7Yx+IVzxTVU51IANbewSWEUjQzJqKBjdKKFpI6smKUc5CxRcgiufS3TwjqvDeWpVPZRJW4IX70gEncuc2hChRuYVrEECPvCebB1aCMIVjq4an9DCNbkAAsHx4KRpBCphMJ8EPQp0pTk0thADOj1dRhhuFFUaFDGLSz+DEqEOecy085F81ozOOEXXJzb8kFtclTS1Vs21NywZnLxLHM+aI55xs3PxRCKk0nNjVTTavSYm6QYopyvT1L+sDM98wUla1K8miOWkV6gPspIr0Ee9NoBM0Ahem17f4BqwgPyxz/+l7xgVAmSyIml1qhQLJ1WtSuxzCKevEVbectj+IIWUKvRIJGKsY+o6bIuIjXoD9plE3C8WZayL5n2i2HKo7JoqG61tshTWxq0rAbaTIa06SkQU6Ikt6NTLs47ZFtMbQ3M0r0F33FcYxsYEVpSi7OqwHlYW51lmqUXTNf8e1BZEyN1ShZju1odGLe5ZrYO7G07jueSX8DHW4FjvVIYIqPWPQXVKxfkyzSSYZp1tpiIsaKe3iKoDVXzhzMpPBg1m/vks3+q4qh2mlqBVsCk23H51XruZjSQprxFjyAsqBulUWnOHTkdebIkzaz9jydra9EKQyNUf/0NSnO+MAoC9QT13ugACs9G3hxbwtFr2HktCIOUR8yZ1+7+2n62/4JcrHe6QVjT6+7A3GsvBk93dg92ABgQpBZhvU6300UvoNQmo6K2EhbYLQl19mqrvdpb1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eUlq7q8q7q8f9LeV3V5V3V5V3V5V3V5V3V5V3V5V3V5V3V5V3V5/7z7dlWXd1WXd1WXd1WXd1WX9xsqd7qqy/tnUOCqLu+qLu+qLu+qLu+qLu+qLu+qLu9X6sFa1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eX9d67LW8ujW8tTykUtddxmuB7NVOs9CYMEMmC3joKrKyC81yq9vobPvxeY0Xd0EgYXVHF4+4XJs6FP9oTEvXMGSX9P7VO29iEsH9pzxmSJmZxhyFa1I7Zx6zf2rSfp7u8dHAZhMHQVhTMZYzkBOoFEPzqxiZC1bED8dhWkVIwLzCQM7JzXtvhS0kxuPcfkVvdHLR0RkkArCJtZr3Yb8H/Y1MIBV1c2cfb6uuxvm5aOcIj1veH4Tq6vr/8fWG1HbA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyG7eSv4Kd2qrEPEOKpCRftC+rOIpDx5a0lmzHlnQUcAbkQJoBJgBGFK1S1Xk4f7BP+3o+LV+y1Q1gLrxIsi0n9inmIRYHt0aju9EXdF8Fho51sHUUHLIsT6lhOjgJg5jpSPHccCmCreAwYcQ3kx8VHRkuxmR7f0CYoMOUaVJopjQxkkSKQaeo0EZm/AO0EuNnDolm6gLGUk2GacFyxYXRZCQVGTPBFMWJYxkVGYOGCTcJyRWL2YgLFhNtVBGZQjHdIa9zKYguoohpPSpSuzKXgsgRoeWaITEJQ1AVM4USmlBSCP57wUirJYdnLDKDuNUi38dM87GghsUAnB9+yuMHIZkkPEpIRAUZMthqDDt1ALMauEMKbVLgmjpnER9x6Owm65DtOOYAI03TaUgoabUKlbZahGuSK3nBYxb71eRoBCiliFrChWFqRCOGuGIwixjjMn5yQkVMRjTiKTdNNJKYa6P4sICVO8fiWBzyfIu8zlNJYzKVhSL7P/5UdTeSwLejVutHNizG5PWg1Tr5PjEm11trazTPOzJnArCV0qHuRDJbi6FjHo8QV0wxmBXxxajm6ZTQOCYTHo+Z0XgggkQyn5JIShVzYUkjp2NGRJENmdIh7iaTihEuCCWK0XjaNrJdaEaeH+ztAhoyajpkPy10WC4Xc8Uik07t9IAev6vv7Ok83AAa4mIckoyeA5a4Ib8XPDqHbWsm8GgdySCuWq23AG+JHa4djceEmIRrMmHDRMpzwi6gecLTlBjFx2OmWq1j8dtvvx2Lq2NByHGAPY6DLXIcuCmOg9A2mWnObMuPe09fv9zZPTw9fLe/U7Z7Sp3pM/ix7DHi6ewMr1+9KJsFzWabd7dfVgsIaVz7fsqoZkSxC84meA5w1HavHgvlsJqcsKPLFhjElIavR/CFkCv7TxOag8Gz3Z1XdVhsD5ZRnja67LzcHrxo9MkTKZrT7P+8t9ucp1C1WQa7zyxSbPs1/HPi4HUnsu0O6HDwcufgcPvlPnS+ducI1HBQ5LlUcPxvLUFvwTEfix9YKieEKobUE8ksk4LkVNGMGZSNCTXYrNjvBVcstsKNpqnnjK1j0SatFpDCVqtFBiLmEbCGZfNpzkCy2b4d2xVYBroeOFFju9YYCWSRFSfAIRNquTtPQZBAV8VAShl+wZoTX4ZkChP/yIAu7LSJVPyDFIamSBQXTBke0bTOxAAgij5DFYqgXHJh/Fe3AnnnmBV4GVnUSRkALQZkZVxgi2bkgqYF0w6qSUgSgOoVyxXTKHHdvIBIEZOE8XGydD0anxXaNCYmhfZy1EPh1vKnhOhliLYRTTUjfNTAZUbPWW01InMr3zvkhymJ2YgWqQkJB/ljVME6ZFcaQvM85RHejSDO7cVTKNbGU3bk4AABVgEg9u39ADdCzOFuAGkDjTiFG+OhAzqzFwpsD+WoSaggUswcdCRTqeZJCD838UgiKQwTpkO2LyhPEXi7WU24iNIiZmSY0ug8xJs9JAruMjiVKUtTOQktvWMXvGER54gfolkKVCgFwC+kW57r6g7tkEOQPyU/QaNHNS7CdR2rToaPJKwMKPAsRlCuhIi4kJzJITHcpCwEhs2pmIYktkoDuzRDeRmSKGHROf6laMwlGRbGSGE3FiuZx3IiHC5HUhjNPyzgSN/y8Rjth2QjJA9D8jgkvW5Iev2Q9DZC0nsYkt7jkPS7Ien3Q9LfCEn/oQWr/9jhmpYIrgPQ61ssm28HuyB3X3CNnA0CU5cyeNKQwb0OabVKbpq9fqs7tuxS3lYgM6Gt535fwo/1/iP3cwo/H/Yfu58T7NrbcD8T+Nnv1e+JPkJiaJbfAAU03ysEXlmwRATf3J17HHh5Bh9BEIW+obqKHTzQcF3fyzrshQtuOE318u34Hl/RjiqQ5ja1AZtCcl2+I6eDfDXbqcODKguISduEYrXW5BkeoejP7X6z426W5Zu3y341e6+B83lbfwhbB9F0CKJp+f5L6fUVIWEWps/DxKMOKgAomZfjwXX4irDQhOjzcPAYcACX0nIEQOtXtPsaONYAwxvetnU32r3Ndr/b32hgACxl2yHL2nHcnk6n94E90Hnc8qDyeA3VanbgkRgpmS0wP9A6qHo5nQj/9ir7S1DUh6x0ioAXoOlT8fZ/Xcs2MqbT77Sdyg8tlTPoX6lm0xqY2ARwoC8kSiSPHPDQx6tkQzDwOoCDNmJyLY7XapiEj3HczrL2zEf42UbE1z5mWSeOOzM9507HfsxIHIdk/vPC73FMsixb8tl+b3xey7L5XXSyzMGGytcTYBKnsy3nE9fhz2KViiOaC9/IRuBHkiLFtdGcW8xHM5dNwr3bxhEVmemg2LhIqWKXYJfqWV/IPfKYZ7FKs0c7Fk1A6wxEVJDv95z2/sCRP2yhOQF8uX3c3M5gkm3n3iWKjdklyakxTAmc7IKmPLZu2LZ1VV7SLAcTYO3vx8fx3/5zDR0QYOMbAidBYj7m4BVc+/vRdvv9yYIeRZ4zFYFPKmWwkg4JM1GHHCUszSvH5GQy6UzWdZRImVqv5JlWbGT/fyqHZ6cIbt6hOn+waKeWNGoGP5DOrL2vmWlgjGriRy4w+ZHGkId6Xbxtnb1zw3XrenxFN84MSNBovSfWtxdkFBUSIGVW/S1NwtRxcFKOsUY+i28Ze3IHZk14zFI6ZOl8050Zrfyc0qksHH97p1Zzq46ia3iDhoyL0m+B2+nW3I4ZvZxpPK5cjjP8bRFS505/5Xj29CdAUq6956aJzvpo59pCh6NgNlgxZMQPIMOSSj+bC0rA7sYGVhK5s7tlCehHsGPpVvSr3bJC42DqiIE5Mi54VmSlf3RUzupRljndo44vGAlxGL9C/XTnVqCXt6zgAklLFjgWPfRjeP/HDZqp6/EVyYoZkG5m40+RIo17+p4u2NsZ0G+rzoALrmXoai/kkvn0cu7rkD243sAnaweBly2KWG7AI/e5rFmCfOcbCn1WdT/ccsqr9/qKqG8BWF+YAl2/+759PolI67v/hgi1AfadidU6JTM6vsFyx+aviDwdPHNOiFZrX7ERBI6rkCLxn3xkB0I6LGWZC3u5YCJcdegI58JIMAt8mLrVGrKRBCc4RLghlJLQKuho7xp7rPUouQ1tS0USqq0Ojko/HBeE8E3CMueO35WG2ViczqXQzJJhvgDoKpbWas348n23yp/Phd84HGvv/gzP/pNu/aB7DzcbB73ZbRx0d9lB32B3AglYXHhnHauaaoJBlWH/hXfTLN/7SQHZO/AKpDQ/LDfJIo1Jys8xLBNznad0CmTh2dxBORvve5pIqaseLuT2vdvwVjOUJxVE8x50ysjG53rMeo/W66ex+fge3AAzjrHmYXQ31nqbazd6xmb8OR+vVBByl5NDl9OdTg57Vke38mB9qgfrfgh//T4N+N6jfuPeWe9+PgPck51eZ5xbLPT7sMPvzSCus9sdTeE/zST9fOrb+BLK+YwYftS7BzG8RAf/XEqcU7XvjfbIfenZiwjwDor2jdr1ZxNoHdgvTqSb96OU97oNXe1JQ1V70q8T5ebmnYiyvugMZR0H/M0Pe68m3V+ejeX29vb27sHrZOf1eHt7O4PfnU5noT226LRxGdBh3VNTdy/jHb9klU6nAyiMqaFbOHwtF+P/suPD5WM6LpD9hZxEm/cRl1ngC/p8KVB2/escP1+Ozz+XA4MwkDm+opdiEAdbQQxv9f0L8SBEI5Vp84OMp8HWVeAeoMGf7nkXjFw70/Dq/yrQUcIyCn95Cw7yBOChcRD6971BGOCLBEgaAKILttxb5SCEaFkOLg2mYQ4ct3Xle9ln2EHotPBgK7BEH4SBixmVnwgTkYQocB6Pgmu/4E1TlV+qqTT+UT6Xh3ngbesnToNDr2fyJD5ppvoM1xVaq8moUnQazKZk+EetPiJpx5Wv9tKpvxu4AadK+dISuwVhwA3L6qssOTQlPx7TEZOwE3yt9LFj8Vho9tFrwjh8Dv4pA92Dkk8ZeiaHp59EjjDYuT8WnPUdT8e2zi/cJJVteKbJYq8Mt6v3xiHBN3+d2yjV90cs03F9TRvlmFvzcNk79NrzV52gBUzznFHVwefgn5x3gqlHNI0KTIUppXFjZyWo5c5612FweftmLkkk2/6RO/k+ZSNjg9Ikkkow9aD+0uWr2Vx/Y+M6DKa3b2/6TW7vERze5PbdvcXsgCpz4q+Adf3xdRgkt8P6c5m/8BcCu/HwurpjXVpMmQ43lPH01Mut69s6+ssM+kFu1UDsqZipGiKGUqaMijlMDEY2PiDJd2DofBfapyD47Jwr7S8ym26lWMQghQVfiHlZRZyuY9+kE/cUGMIKO/ABtTNdDDX0En4+bSccMp/CBTmHtge3OXvoP2c0SiBZzD1QoSPv3Msha0oW2oMHbnS4XVIGzm2TMG6zPbgYN42xGnbQWV/fe6d+OvAFLlfMu9w73L8DLtFSbNsELqsf2F3aOcje4T4k8/CRU/865LUuMeFRSxtdCKhj5IJT/+C/lO1TGz5n1t0pfepYFWHouDSaNpkHKOZ6IUQhPPq3mQZlnuncxFXuHxyRLAxELFyyJdGG5bqBR4SiROShLO5ClbdgkpJxga8VDbCsz+zBB0tVMg4XNokVzYy4UD7/yJEF9ISM1gpPHivQqTZ/SJjQdjglI6oNUyFktgLmVQFGRTklu8yZ4kxEbCEKFLOoOy3UQn2tiYNmZsvrVy9cxqffg2fKIXCgnZjFpMiRapATyowrf3KzW59TlIA7mDpdphjOqx6YF+U8IDlTGrKCFZFqTAX/4LKEQSMBI2vIEprark5UgKcc4AEObwLjZe0f//xXDa6lmu48YHYFGsfwnO4WCNGStAQPmr5iOUhA2YQI5mPqv2cvAYAOmeY0k3HJSPruNL6PD/B0KRddBLCMQOoiSsCwKOWtDr2M1U6t1Giaov2KIcQc9ssuuTa1nCH/sndePrxigMeoBgOqIcDVQPNiWmfwKjIqZ6bDzCbezDcrr8E5XqCFkaeKZVzc7Z6qO+OMLAVBYWRGDY+In0p3mlmENuLj+TqD9HMLGlDjBZfqwRJWhelOpYjYKRen7IKpOyh4u+VLpJhOgbjNhDFRh80jyV5nVabXBFKfGzip3U6Yz9ggxs0Q6C5jasxOIzBTkPDYHfDYasFsrRZpW1icWNWFch4Vl1SL8gNESTU7QOTS5cp34tWdW89s75Cf5QRwFpLcJjmDGW/nB5QShDy2JQPqK0RUQL4cOnMgSQ4mLqNrGeVVergLcON54W4G1gqPrEMHZoGkUVgnvGlPXoSWD+ApJH761S1H2M2BW4XQVCJLmaSSw3ETqAHm/CV4BeERggfYruMTceVEMPXHP/5PYxwfMkwjKLQwGC1vxQg/TbW0CYX1WT1Fe5q3/qk5knZPBhYZuzd7PLwAqYozsGwI71bw3QNqVHjTyMrp0bSev5j5fZMt7cLxK0v6GzI1e93uv7Mlvd79dizpje43ZEk/BmCdz/52abJMu10oO3wM4uYBZ5JZ/2Yq1c09wbd/HZYRk0UIrtihf23/q4x/L8RvcQhYj0EVTHDGrN8MoqHf7cI/M0LQF7nxpVequj/p9D+C8O6RjJvPwJdZuRlZPyT9n3UusigBnC2xmqruN5NYPUKzxqbPk+GziO/x54PXHwa9XT7QA/FqM3o6eDg4z3998/T5kw6bPu9F/TfTX/tvzLu3qR6cSR79/Dx5L97o4dPN4t2v79W7Xwfq3dtXhr7d3B6KRAyf/cSj6ebZsN/lL54+775/25sMn/3Uff/mSf4eJ/+p+/78vBtlu0+HYhv65O9+/R++d7az/vLDzoeXhzuXLz+kTzp09/ezp5fRk5fnOw/b7weq/XJv+MvZ7yZ/tRmv7/7KHz5mL9lbcdh9ETWogYuUC3bqj/oU930Kh20paWPRsR/IjFmVZYK1dZSEwj1OdzNqSugYlC9AnbpHKmBK3cYvHwfZTYjY6HZPeyUSNueRMBCYgoI1rA7lORN/7k7ryxu7PIB6maWV0Aq47YTtQWOz9e92k5pFheJmGmwdXQWXbZrztm3fOjq5PgHzwSQSgpe51AgxNUmwFazNxjKhlBhGyo6uLA+WjKapiOFNzhyz0ZyvXfQ6veA6nB2zkDlv6M+K9scO0YaOuRjfNu6kQtEBHKM9qQaiKoU1578w0FjdOdR7hQEH8kkYBVMWMA/U8aqKAO/4M/ax2UXh1uosZwOoPn7aCInO3sMLgpy1GOeRDzBizLAMGQbVhoIyrBcEtUAd/KiF3uBnqc0fVdRcxq28st1DLbW/sYHq3KMe6j3rj1Gl2Hh4fWKRX3NU40vuurfVvjRquA3dp6YbLQhm3FYN39Gs62ipG2eJF8ctOeOtKAFZ5CQA43yhbe5G1eywBaj0qkcTkfBQBxC53kVEbnQRkY+7Da3Hbb+aodJdUEEp9RNUQuo6CCgaJ0C4XIwkUr077r2ciQNwAINQQq6Z01VZGsmsLFXTavkhf/zzX+WoVqs0kWlZG2+vUCSXE6agpiDW1EvZJQdnCNY7zLBNo1GPSQw0S5nWEG8Xho1tQUBIaQWvs/NrRjSnQ6jLB15TfKiPz3Rrglt3yNuEwcsXaPpO2QzfC5aCsC7dSfWafhOpzkepnECpPDKEMlbgUGQioSKyvksrQtAHB7Yx+IVzxTVU51IANbewSWEUjQzJqKBjdKKFpI6smKUc5CxRcgiufS3TwjqvDeWpVPZRJW4IX70gEncuc2hChRuYVrEECPvCebB1aCMIVjq4an9DCNbkAAsHx4KRpBCphMJ8EPQp0pTk0thADOj1dRhhuFFUaFDGLSz+DEqEOecy085F81ozOOEXXJzb8kFtclTS1Vs21NywZnLxLHM+aI55xs3PxRCKk0nNjVTTavSYm6QYopyvT1L+sDM98wUla1K8miOWkV6gPspIr0Ee9NoBM0Ahem17f4BqwgPyxz/+l7xgVAmSyIml1qhQLJ1WtSuxzCKevEVbectj+IIWUKvRIJGKsY+o6bIuIjXoD9plE3C8WZayL5n2i2HKo7JoqG61tshTWxq0rAbaTIa06SkQU6Ikt6NTLs47ZFtMbQ3M0r0F33FcYxsYEVpSi7OqwHlYW51lmqUXTNf8e1BZEyN1ShZju1odGLe5ZrYO7G07jueSX8DHW4FjvVIYIqPWPQXVKxfkyzSSYZp1tpiIsaKe3iKoDVXzhzMpPBg1m/vks3+q4qh2mlqBVsCk23H51XruZjSQprxFjyAsqBulUWnOHTkdebIkzaz9jydra9EKQyNUf/0NSnO+MAoC9QT13ugACs9G3hxbwtFr2HktCIOUR8yZ1+7+2n62/4JcrHe6QVjT6+7A3GsvBk93dg92ABgQpBZhvU6300UvoNQmo6K2EhbYLQl19mqrvdpb1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eUlq7q8q7q8f9LeV3V5V3V5V3V5V3V5V3V5V3V5V3V5V3V5V3V5/7z7dlWXd1WXd1WXd1WXd1WX9xsqd7qqy/tnUOCqLu+qLu+qLu+qLu+qLu+qLu+qLu9X6sFa1eVd1eVd1eVd1eVd1eVd1eVd1eVd1eX9d67LW8ujW8tTykUtddxmuB7NVOs9CYMEMmC3joKrKyC81yq9vobPvxeY0Xd0EgYXVHF4+4XJs6FP9oTEvXMGSX9P7VO29iEsH9pzxmSJmZxhyFa1I7Zx6zf2rSfp7u8dHAZhMHQVhTMZYzkBOoFEPzqxiZC1bED8dhWkVIwLzCQM7JzXtvhS0kxuPcfkVvdHLR0RkkArCJtZr3Yb8H/Y1MIBV1c2cfb6uuxvm5aOcIj1veH4Tq6vr/8fWG1HbA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,j={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},company:{type:"string",format:"string",example:""},job_title:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.037506c8.js b/assets/js/c7e3ab5f.037506c8.js new file mode 100644 index 000000000..d89ba85fd --- /dev/null +++ b/assets/js/c7e3ab5f.037506c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>I,contentTitle:()=>f,default:()=>j,frontMatter:()=>y,metadata:()=>n,toc:()=>C});const n=JSON.parse('{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1.1/deletecontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletecontact","permalink":"/docs/API-docs/v1.1/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV91uI7cVfpVT3iQrjCXZ66ToXNXdGBujzq4ROzBQr2FQM0czjDgkQ56RLAgCctE36FVv+2j7JMUhZ0aS7d1m0SJAb2zN4fn/48eNIFkFkd+JN9aQLCiI+0yUGAqvHClrRC5uaoTvUCMhdExwdnUBUmu7CrC2LZAFj41dIkgoOpa5tw0f+p4ys3Yxhot5lDAWtDUVejCIJUhw0pMqWi0H/q8CKDO3vpHsRwZUqxANN3KBARQByrBm22VyjmpUHjwW1pdjkQnr0EfZi1LkIjF1ukUmnPSyQULP0W+EkQ2KXHTnD6oUmVAcvZNUi6cpufJ2qUoEO/sZC7oowc6HwAeHRCY8/tIqj6XIybeYiUBrzWaCapxmBnx02pYo8rnUgRmKGhsp8o2gtYuc5JWpRCZSJvYp+Cijlly4+mRWn8hQiu32nq0GZ03AwHpOplP+d+h/X8fkaAmhLQoMYd5qvf6DyGIa0BALSue0KmIeJz8Hlt489zLlgbPqOeukku0+PS/Fs/P+L4/su/vevRbbrKtTeUafFzqZnrw+Op4eTf94c/xtfvqn/Jtvx9Pp9G8iE4+NZtmuoqUkZL2kSO++t8/YUsn2GTvKlplPX8ritW2QamUqWKEhWHlrqgycRhkQyK9BVlIZ0JLQ/w+zit5b//nsfJln272oldHK4EPfQg+n0+nD8ZCE00+3krEEc9ua8veN9AXznw/n9OFkCOeb5+FcmKXUqoyL5sYu0Py+4eybp2T+ea+qxBTPxUGw+/QUZMCi9YrWcck9HkmnjtJ5fnfPu4L7xO72Y1yMVItcTLp9NtnsduJWsEK/7Jfmk3FYyapC/307i+6ftWThB1ssUoyt1yIXNZEL+WSyVJ6SpnFIYnU7Gxe2mVx5yWvonVwupJ9Yh2ZyPJ6Op2KbbZ4oCdKUM/s4ZqagKqPlLEQd0qnJ8nh8/IKMdO6L+LE9+lKRQLJSpvpPcve74lxzA6UeOSjR0CnSqb/iWmR9B+xzdfdUjbJEH7uFr80o3PXFe4fmWlUmliUaf3qf3aIubIN8d1GNMBr1Ih///q9BajSC0hZtg4Zi/48/mA/mfevB2RX6eatBmhLmGh/VTGMUwyaeDSghoGw0hqDXoAxh5SUhlKpSJDVwnnhlFdLJmdKKx4bZbIIRe5MXxnBbI9Xo+egrz7ijxCVqnjaQLVkGDaYa/IWV9Ys545UMJMzaoAyGAGhqaQpm7CuRgfUgDaAh9M6rgBDIs9cq+WYNed43jTSyQtadwX6yStSK5wO8nbWBIFjdRpeBpNLWYwl9QIx8QkziOaMAj5DQUuM81tw2S4SqVSWGDApbIoS4JTgEU8IMA4FjX1SBgZW2RttiEQvIEwTO8tJSUjM62feRxclLExhTJF/6GgwJc94yIsDk4Gj0U0Cu8KUyi5CPRh/MEdwNfXWLs6AI77/uR2C1Wj1r/VeHMm8V8ab4EZ0Niqxf76QrRf022FcyfCRNb9Fg7J+9YdjpKG0Rnk8fUyc1aje5RuIOCZOzq4u451/Bx1//AZcovYHarlK3Fq1HvYaqN8WZS5VPaRvWNMxtbLyaM16k5mPwh4H6DN7Wkj7++s8A73AFynQjxaGMRlftTKsCbrBxfCeH0SiHNx7ZJPU0oFoSFNLADCHUkltpqSRj5yStlVmM4cysoQ3oYaWojs3A9Ch3EAbnZSh3gJkMWII1UaK3Od55xPQmoF5iYF183c4QsFQMH6n2tq2StX1nuuA8zpXWcKvKCinGdlaW4DryKpEjbt65g3MeCKpxDdIjBDQ0hqsnIvGkdc569kIl5+eWHyZcADSls8pQyKH0ck47/dmu0QtOc3xgPCOlFMohHVmnZihJmsQu4oE6/sBL+ckiP9y3Hufo2WAMe1cXp7p2uuvbErhb/5u2ZoDQv3oYgzRS6XSj/Pmpnogl0Dfh/fwa/VIV2N1qn5joSWSeiExoVaAJuIdRzt5eXcLy9Xh6cPX/huGeXF68OX93fc7O8CJNCeshgHA2UCPNnqXDp+nTq22zA2//tw/ZDgQQPtLEaaki6ItJ3XRo7U7sHrb53hv2PhO1DcQMmw2P+E9eb7dM/qVFz6DwPhNL6ZWcMVJgSKcC/y6HF+kns/n1j93j9hX81ufwi4H0EMcwvllK3fKXyMQC14cP8u39NuthDruaGM6KAh3tiT5D6Acw97vzy/Obc5EJXtaHCGsREVb3gw286Nkh9Eo+8F/GgS8KbDYJvW23A386+qREF2PPzWm63263/waKNzXa","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var a=o(74848),c=o(28453),i=o(33617),s=o.n(i),l=o(17543),r=o.n(l),p=o(86013),d=o.n(p),h=o(63723),m=o.n(h),u=(o(18766),o(79329),o(9303));const y={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV91uI7cVfpVT3iQrjCXZ66ToXNXdGBujzq4ROzBQr2FQM0czjDgkQ56RLAgCctE36FVv+2j7JMUhZ0aS7d1m0SJAb2zN4fn/48eNIFkFkd+JN9aQLCiI+0yUGAqvHClrRC5uaoTvUCMhdExwdnUBUmu7CrC2LZAFj41dIkgoOpa5tw0f+p4ys3Yxhot5lDAWtDUVejCIJUhw0pMqWi0H/q8CKDO3vpHsRwZUqxANN3KBARQByrBm22VyjmpUHjwW1pdjkQnr0EfZi1LkIjF1ukUmnPSyQULP0W+EkQ2KXHTnD6oUmVAcvZNUi6cpufJ2qUoEO/sZC7oowc6HwAeHRCY8/tIqj6XIybeYiUBrzWaCapxmBnx02pYo8rnUgRmKGhsp8o2gtYuc5JWpRCZSJvYp+Cijlly4+mRWn8hQiu32nq0GZ03AwHpOplP+d+h/X8fkaAmhLQoMYd5qvf6DyGIa0BALSue0KmIeJz8Hlt489zLlgbPqOeukku0+PS/Fs/P+L4/su/vevRbbrKtTeUafFzqZnrw+Op4eTf94c/xtfvqn/Jtvx9Pp9G8iE4+NZtmuoqUkZL2kSO++t8/YUsn2GTvKlplPX8ritW2QamUqWKEhWHlrqgycRhkQyK9BVlIZ0JLQ/w+zit5b//nsfJln272oldHK4EPfQg+n0+nD8ZCE00+3krEEc9ua8veN9AXznw/n9OFkCOeb5+FcmKXUqoyL5sYu0Py+4eybp2T+ea+qxBTPxUGw+/QUZMCi9YrWcck9HkmnjtJ5fnfPu4L7xO72Y1yMVItcTLp9NtnsduJWsEK/7Jfmk3FYyapC/307i+6ftWThB1ssUoyt1yIXNZEL+WSyVJ6SpnFIYnU7Gxe2mVx5yWvonVwupJ9Yh2ZyPJ6Op2KbbZ4oCdKUM/s4ZqagKqPlLEQd0qnJ8nh8/IKMdO6L+LE9+lKRQLJSpvpPcve74lxzA6UeOSjR0CnSqb/iWmR9B+xzdfdUjbJEH7uFr80o3PXFe4fmWlUmliUaf3qf3aIubIN8d1GNMBr1Ih///q9BajSC0hZtg4Zi/48/mA/mfevB2RX6eatBmhLmGh/VTGMUwyaeDSghoGw0hqDXoAxh5SUhlKpSJDVwnnhlFdLJmdKKx4bZbIIRe5MXxnBbI9Xo+egrz7ijxCVqnjaQLVkGDaYa/IWV9Ys545UMJMzaoAyGAGhqaQpm7CuRgfUgDaAh9M6rgBDIs9cq+WYNed43jTSyQtadwX6yStSK5wO8nbWBIFjdRpeBpNLWYwl9QIx8QkziOaMAj5DQUuM81tw2S4SqVSWGDApbIoS4JTgEU8IMA4FjX1SBgZW2RttiEQvIEwTO8tJSUjM62feRxclLExhTJF/6GgwJc94yIsDk4Gj0U0Cu8KUyi5CPRh/MEdwNfXWLs6AI77/uR2C1Wj1r/VeHMm8V8ab4EZ0Niqxf76QrRf022FcyfCRNb9Fg7J+9YdjpKG0Rnk8fUyc1aje5RuIOCZOzq4u451/Bx1//AZcovYHarlK3Fq1HvYaqN8WZS5VPaRvWNMxtbLyaM16k5mPwh4H6DN7Wkj7++s8A73AFynQjxaGMRlftTKsCbrBxfCeH0SiHNx7ZJPU0oFoSFNLADCHUkltpqSRj5yStlVmM4cysoQ3oYaWojs3A9Ch3EAbnZSh3gJkMWII1UaK3Od55xPQmoF5iYF183c4QsFQMH6n2tq2StX1nuuA8zpXWcKvKCinGdlaW4DryKpEjbt65g3MeCKpxDdIjBDQ0hqsnIvGkdc569kIl5+eWHyZcADSls8pQyKH0ck47/dmu0QtOc3xgPCOlFMohHVmnZihJmsQu4oE6/sBL+ckiP9y3Hufo2WAMe1cXp7p2uuvbErhb/5u2ZoDQv3oYgzRS6XSj/Pmpnogl0Dfh/fwa/VIV2N1qn5joSWSeiExoVaAJuIdRzt5eXcLy9Xh6cPX/huGeXF68OX93fc7O8CJNCeshgHA2UCPNnqXDp+nTq22zA2//tw/ZDgQQPtLEaaki6ItJ3XRo7U7sHrb53hv2PhO1DcQMmw2P+E9eb7dM/qVFz6DwPhNL6ZWcMVJgSKcC/y6HF+kns/n1j93j9hX81ufwi4H0EMcwvllK3fKXyMQC14cP8u39NuthDruaGM6KAh3tiT5D6Acw97vzy/Obc5EJXtaHCGsREVb3gw286Nkh9Eo+8F/GgS8KbDYJvW23A386+qREF2PPzWm63263/waKNzXa",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,I={},C=[];function A(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(s(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,a.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(r(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,a.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(A,{...e})}):A(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.cf9a081c.js b/assets/js/c7e3ab5f.cf9a081c.js deleted file mode 100644 index 555ade2bb..000000000 --- a/assets/js/c7e3ab5f.cf9a081c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>h,default:()=>g,frontMatter:()=>y,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1.1/deletecontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletecontact","permalink":"/docs/API-docs/v1.1/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV81uIzcSfpVaXpIR2pLscbJYneKdGBMjRsaIHRhYj2Gwm6VuRmySIaslC4KAHPYN9rTXfbR5kkWxfyTZnkkGuwiQi60u1u9XxariRpAso5jdiTfOkiwoivtMKIxF0J60s2ImbiqEb9EgIXRMcHZ1AdIYt4qwdg2Qg4C1WyJIKDqWeXA1H4aekju3GMPFPElYB8bZEgNYRAUSvAyki8bIgf+LCNrOXagl+5EBVTomw7VcYARNgDKu2bZqnaMKdYCAhQtqLDLhPIYke6HETLRMnW6RCS+DrJEwcPQbYWWNYia68wetRCY0R+8lVeIpJFfBLbVCcPnPWNCFAjcfAh8cEpkI+EujAyoxo9BgJiKtDZuJuvaGGfDRG6dQzObSRGYoKqylmG0ErX3ipKBtKTLRIrFPwUeZtMyEr07y6kRGJbbbe7YavbMRI+s5mU7536H/fR5bRxXEpigwxnljzPovIkswoCUWlN4bXSQcJz9Hlt4897LFgVENjDrp1nYPz0vx7Lz/+yP77r/zr8U26/KkzujTQifTk9dHx9Oj6V9vjr+enf5t9tXX4+l0+g+RicfasGyXUSUJWS9pMrvv7TO2NmX7jB1ly8ynL6F47WqkStsSVmgJVsHZMgNvUEYECmuQpdQWjCQM/0dUMQQXPo3O53m23YtaW6MtPvQl9HA6nT4cDyCcfryUrCOYu8aqPzbSF8x/OpzTh5MhnK+eh3Nhl9JolRrNjVug/WPD2TdPrfnntapbpnQuDoLdp7dBRiyaoGmdmtzjkfT6qD2f3d1zr+A6cbv+mBojVWImJl0/m2x2PXErWGFY9k2zCUbMREXk42wyidKq3D2OnUcbdWmNzOO4cPVEej1ZHo+PxTZ7KiO9/yx+bI4+VySSLLUtf0vufofVNeezTdkBYkPipNff41pkfUL2ubqxUaFUGFLyeIol4S5N7zzaa13alORk/Ol4uUVTuBp5lFCFMBr1Ih/++Z9BajQC5YqmRkupHMfv7Xv7rgng3QrDvDEgrYK5wUedG0xiWKezYWhHlLXBGM0atCUsgyQEpUtN0gDjxB2kkF7m2miuYmZz7VTfuwhxDLcVUoWBj74IvAYoXKLh4gfZkOMZbsvBX1i5sJjz+pCBhLyJ2mKMgLaStmDGPhMZuADSAlrC4IOOCJECe61b35ylwNe/llaWyLoz2AdLodFcrhBc3kSC6EyTXAaS2riACvqAeBGJCcRzHsoBoV1eah+w4rJZIpSNVhgzKJxCiOnScghWQY6RwLMvusDIShtrXLFICeS5Ct5xD9HS8LKw7yOLU5A28ohvfelzMADmg+MBja2Do9FPETnDl9ou4mw0em+P4G6oq1vMoya8/7K/AqvV6lnpvzqUeavpuyaHH9G7qMmF9U661FQ1ebou+0qGj1bTW7SY6mfvMux0KFfE57ePqZMKjZ9cI3GFxMnZ1UVqu6/gw6//gkuUwULlVm21Fk1As4ayN8XItZlvYRu6JsxdKryKES/a4uNdDCP1CN5Wkj78+u8IP+AKtO2uFIcyGl01udEF3GDteUTG0WgGbwKySeppQJUkKKSFHCFWkktpqSWvsq200XYxhjO7hiZigJWmKhUD05PcQRiMy5DuCLmMqMDZJNHbHO88Ynod0Swxsi6efjkCKs3bHFXBNWVrbd+ZLriAc20M3GpVIqXYzpQC35FXLTmtsTt3cM4XgipcgwwIES2N4eqJSDppvHeBvdCt83PH7wROAFrlnbYUZ6CCnNNOf7Yr9IJhTvv+M1ILoRzgyDo1Q0ram9hFPFDH77kpP2nkh/024BwDG0xh7/LidVdOd31ZAlfr/1LWPK/7RwivBLXUpp0o3zzVk0Y7hjq+m19jWOoCu6n2kRs9ScwTkQmjC7QR91aGs7dXl7B8PZ6KbG88/o7LPbm8eHP+w/U5O8ONtAXseDwdT5nkXaRa2j1Lhy/Fp6Nts9ul/rTvym4JIHykiTdSpx0sgbrplqc7sXtnzvaelPeZqFwkZths+Ir/FMx2y+RfGgy8o91nYimDljlvCncboXTk32p4IH4UzS9/7N6ar+D3vk5fDKRfcSzvN0tpGv4SmVjg+vB9vL3fZv2aw662DGdFgZ72RJ8tzAdb57fnl+c35yIT3KwPN6xF2rC6H2zgRc8OV6/WB/7Le+CLAptNu71ttwN/e/RRiS7Gnpthut9ut/8FkbgOLw==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var a=o(74848),i=o(28453),c=o(33617),r=o.n(c),l=o(17543),s=o.n(l),d=o(86013),p=o.n(d),m=o(63723),u=o.n(m),v=(o(18766),o(79329),o(9303));const y={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV81uIzcSfpVaXpIR2pLscbJYneKdGBMjRsaIHRhYj2Gwm6VuRmySIaslC4KAHPYN9rTXfbR5kkWxfyTZnkkGuwiQi60u1u9XxariRpAso5jdiTfOkiwoivtMKIxF0J60s2ImbiqEb9EgIXRMcHZ1AdIYt4qwdg2Qg4C1WyJIKDqWeXA1H4aekju3GMPFPElYB8bZEgNYRAUSvAyki8bIgf+LCNrOXagl+5EBVTomw7VcYARNgDKu2bZqnaMKdYCAhQtqLDLhPIYke6HETLRMnW6RCS+DrJEwcPQbYWWNYia68wetRCY0R+8lVeIpJFfBLbVCcPnPWNCFAjcfAh8cEpkI+EujAyoxo9BgJiKtDZuJuvaGGfDRG6dQzObSRGYoKqylmG0ErX3ipKBtKTLRIrFPwUeZtMyEr07y6kRGJbbbe7YavbMRI+s5mU7536H/fR5bRxXEpigwxnljzPovIkswoCUWlN4bXSQcJz9Hlt4897LFgVENjDrp1nYPz0vx7Lz/+yP77r/zr8U26/KkzujTQifTk9dHx9Oj6V9vjr+enf5t9tXX4+l0+g+RicfasGyXUSUJWS9pMrvv7TO2NmX7jB1ly8ynL6F47WqkStsSVmgJVsHZMgNvUEYECmuQpdQWjCQM/0dUMQQXPo3O53m23YtaW6MtPvQl9HA6nT4cDyCcfryUrCOYu8aqPzbSF8x/OpzTh5MhnK+eh3Nhl9JolRrNjVug/WPD2TdPrfnntapbpnQuDoLdp7dBRiyaoGmdmtzjkfT6qD2f3d1zr+A6cbv+mBojVWImJl0/m2x2PXErWGFY9k2zCUbMREXk42wyidKq3D2OnUcbdWmNzOO4cPVEej1ZHo+PxTZ7KiO9/yx+bI4+VySSLLUtf0vufofVNeezTdkBYkPipNff41pkfUL2ubqxUaFUGFLyeIol4S5N7zzaa13alORk/Ol4uUVTuBp5lFCFMBr1Ih/++Z9BajQC5YqmRkupHMfv7Xv7rgng3QrDvDEgrYK5wUedG0xiWKezYWhHlLXBGM0atCUsgyQEpUtN0gDjxB2kkF7m2miuYmZz7VTfuwhxDLcVUoWBj74IvAYoXKLh4gfZkOMZbsvBX1i5sJjz+pCBhLyJ2mKMgLaStmDGPhMZuADSAlrC4IOOCJECe61b35ylwNe/llaWyLoz2AdLodFcrhBc3kSC6EyTXAaS2riACvqAeBGJCcRzHsoBoV1eah+w4rJZIpSNVhgzKJxCiOnScghWQY6RwLMvusDIShtrXLFICeS5Ct5xD9HS8LKw7yOLU5A28ohvfelzMADmg+MBja2Do9FPETnDl9ou4mw0em+P4G6oq1vMoya8/7K/AqvV6lnpvzqUeavpuyaHH9G7qMmF9U661FQ1ebou+0qGj1bTW7SY6mfvMux0KFfE57ePqZMKjZ9cI3GFxMnZ1UVqu6/gw6//gkuUwULlVm21Fk1As4ayN8XItZlvYRu6JsxdKryKES/a4uNdDCP1CN5Wkj78+u8IP+AKtO2uFIcyGl01udEF3GDteUTG0WgGbwKySeppQJUkKKSFHCFWkktpqSWvsq200XYxhjO7hiZigJWmKhUD05PcQRiMy5DuCLmMqMDZJNHbHO88Ynod0Swxsi6efjkCKs3bHFXBNWVrbd+ZLriAc20M3GpVIqXYzpQC35FXLTmtsTt3cM4XgipcgwwIES2N4eqJSDppvHeBvdCt83PH7wROAFrlnbYUZ6CCnNNOf7Yr9IJhTvv+M1ILoRzgyDo1Q0ram9hFPFDH77kpP2nkh/024BwDG0xh7/LidVdOd31ZAlfr/1LWPK/7RwivBLXUpp0o3zzVk0Y7hjq+m19jWOoCu6n2kRs9ScwTkQmjC7QR91aGs7dXl7B8PZ6KbG88/o7LPbm8eHP+w/U5O8ONtAXseDwdT5nkXaRa2j1Lhy/Fp6Nts9ul/rTvym4JIHykiTdSpx0sgbrplqc7sXtnzvaelPeZqFwkZths+Ir/FMx2y+RfGgy8o91nYimDljlvCncboXTk32p4IH4UzS9/7N6ar+D3vk5fDKRfcSzvN0tpGv4SmVjg+vB9vL3fZv2aw662DGdFgZ72RJ8tzAdb57fnl+c35yIT3KwPN6xF2rC6H2zgRc8OV6/WB/7Le+CLAptNu71ttwN/e/RRiS7Gnpthut9ut/8FkbgOLw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,k={},f=[];function b(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(r(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,a.jsx)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(s(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/d0524430.5aa106b8.js b/assets/js/d0524430.5aa106b8.js deleted file mode 100644 index f362b59ea..000000000 --- a/assets/js/d0524430.5aa106b8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>N,default:()=>M,frontMatter:()=>u,metadata:()=>o,toc:()=>v});const o=JSON.parse('{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/v1.1/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/save-update-webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWc1uIzcSfpUKB9jdCG3JnjjAQqcojnYirH8EW4axsAwP1V1SM6bIDsmWLAgCctg32NNe82jzJEGR3a2W7NFkZgJjMNBFP2RVsX4+FsmqJXN8Yln7lt3gKNX6gd1FLEEbG5E5oRVrs0GKYPkMQRvIs4Q7hIIWOv0ecCn13MJC5+B0IOQwLwiuL09hnoo4BWEht5gQjTNiMkEDOEPlbHOohurVq1fQ9X/b9LfROGrCTOAck3ajMVQHcJOiAg5WTBQaP2WBQ6LjfIrKReBSYYNAmAspyzWaQ/X27duhWg4VwJB5giFrw5AF6UMWhRm3yDBM/HRxcn3WPR/cD/7T71bzevQLxq6XbNH0fqooxkJuS7i+PK2mFZ9uT593ztYLKO2K+b5EbhEMkorAVeKtDhaWBldstVAF7momuMrS6C2NACzD16Y2V703593Lui6BAqdcyA2S7lmnd7pBk6VabYrp/3xx3h2yQLKir7tCneDvHxfvFVmSdIoADXpn3atB56xfzccGuXuWYKhWRaAJO6+bUJBugqd0HmGxIPgE4BSce+S8FHL+TNh3xRhcanQ+ScGlCInhYwcOp5mkRNbp9/YQ+MIgUKPJTU1K7/xNcMonYoRSw3fNcITsyAxhHkaL6rj5BIQEIV89QGiwAMaHYPFhUHwgK6zqK/8Fp8RxE2I9zSTuPCdqaJCywIP9lJRRLvXVY+LLOTfQODEWMS/NPOleDnr/6p10Bt0NR1Wx+XxQfd+EBGMpdmaYkuIzc0wpZo+ol0JU6fGdt9iS6PPAxCKmMzScnNJLWJvRw+pv4flVvtQiZvDXHK37UScL1l5uvdv6Rs9EgpAbSa+usCqsmWOtHCpHjDzLJG0UoVXrF0vcS2bjFKecftEqwmBCr8RrI+mFSFBj7QJRLGKZIW2dQEsMuZH0VRBZZ4SasIiNtZlyVx/BR05bj7VZ6lxm263WQufmoHg9HuRG/lCQNGM9ZatVxJxwnqGguR+R7asVTRm0mVY26PD68PCpS67yOEZrx7mEyrsf44ndZhu0uXTPWb62s3w5h0gmYCuN5OKbDQOFIhjdl0bdvz48vP9nYenxs8bpKbpUqAnMfRIxWk0iyMJOdGYBfMKFArr3mm/+OqvRGG12G/1xmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXG90/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6KHvODj2Wxjk+EmnyI727tnCsKYIjRhouqSPFM/BsXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQqNRsrz77+8VV6NRXXU8jn2h8yI3kOk5GjqD6F40lvgoRtKXIgCnfm5dTUU+lWitXIBQDieGTvBETITj4TFCOTXmGR8JKQj+RKaJ20BtB9kmXUNdioam/m6oQpvgDCXtGuC501PuSFR1S51r8zCmum4EHEa5FQqtBVQpVzERlhGNqCjMFaByaDIjLIJ1hrQWQTetnOGxgylXfIKhVlt3VoJSEOzB6FFuHVgtc68yOC6kNqFi7A1SiEmoFncfM5oCGqXLu8GU4DdDmOQiQRtBrBMqWlOUyQSVwAitg4x0ETFaEporqeMHH0A6fiHTlHwEl6DHGzoSuzNcWbrABF3KGFQOy4ymcxyDgo3GtUWK8KlQD7Z4CdxWuLrBkRUO7/5RInQ+nz/ZQt9u8rwR7ud8BJeYaSucNos190S4NB/5bVcXUv0Jkt6gQo+f2qZay0h0bJ/uYhptpSiz1hU6Qohtdfo9n6+/hXe//Q9OkRsFqZ4HtMa5QbmASbkUeS5EPritSrcw1h54KXk8DuArLrOlB29S7t799n8L5zgHoYotRaY0Gv18JEUMg6KMZxuNNpyE+21Z2rPgUu4g5gpGCDblBKWZ4MAhC9xSqIcmdNSCGhMG5sKFEiGNe74NM/z7pQy3hRGnZoZWnqNcs7nWiManFuUMLcmiQ3OEgInYLkjWlSmMMzimB+CNSCbovG2dJIGsGJ6HYXJ4TR0c04ZwKS6AGwSLyjWhv8XiZ/Is04a0EEH5saYGDgUAVZJpQT2YokxayY/WQPfPCKHVM0PBhbxyR7RVbS12YmFxNdr0r52tA2Ez3xoco6EFvdnruGSigNNtCUsgtH4OrOlAoKzFY38P8U/IcDL9sC3H3wnQTO3F+ArNTMTlQ+Y9O7rliVssYlLEqCzW7hqdN/1TmH3XPGRR7fT6E5u7ddo76Z5fdUkZSqTBYUfNw+YhDdF1Y8pVbaWropV3vdHK2z7iluvL2L4BuC+e7BuA++7PvgG4h8C+AbhvAO4bgPsG4JeXNPYNwD2ivrIGYFEUdfjoWpnkwhehi95aqB/flm0w6smlVFlu37LlkooT10auVjT8a46GytJ3EZtxI/iIapy3d6uoLKVSwfkBF6zNTsKT72BACxO5zENVdqsWT7XgwNGJY8zcTtp68bt/cTVgERsV/cqpTojH8Dn1MvmctZnve/oCoO+o0diSSa4mOZ8QbZBJ1V+qHm2Wjh986bj4QVaVU2pR03CzphzMoE8y6lmG5TKUpVerij5MvZejcGxJTYG7W61WfwAQ6xsX","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"}}');var i=t(74848),s=t(28453),r=t(33617),a=t.n(r),d=t(17543),l=t.n(d),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),E=(t(18766),t(79329),t(9303));const u={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1uIzcSfpUKB9jdCG3JnjjAQqcojnYirH8EW4axsAwP1V1SM6bIDsmWLAgCctg32NNe82jzJEGR3a2W7NFkZgJjMNBFP2RVsX4+FsmqJXN8Yln7lt3gKNX6gd1FLEEbG5E5oRVrs0GKYPkMQRvIs4Q7hIIWOv0ecCn13MJC5+B0IOQwLwiuL09hnoo4BWEht5gQjTNiMkEDOEPlbHOohurVq1fQ9X/b9LfROGrCTOAck3ajMVQHcJOiAg5WTBQaP2WBQ6LjfIrKReBSYYNAmAspyzWaQ/X27duhWg4VwJB5giFrw5AF6UMWhRm3yDBM/HRxcn3WPR/cD/7T71bzevQLxq6XbNH0fqooxkJuS7i+PK2mFZ9uT593ztYLKO2K+b5EbhEMkorAVeKtDhaWBldstVAF7momuMrS6C2NACzD16Y2V703593Lui6BAqdcyA2S7lmnd7pBk6VabYrp/3xx3h2yQLKir7tCneDvHxfvFVmSdIoADXpn3atB56xfzccGuXuWYKhWRaAJO6+bUJBugqd0HmGxIPgE4BSce+S8FHL+TNh3xRhcanQ+ScGlCInhYwcOp5mkRNbp9/YQ+MIgUKPJTU1K7/xNcMonYoRSw3fNcITsyAxhHkaL6rj5BIQEIV89QGiwAMaHYPFhUHwgK6zqK/8Fp8RxE2I9zSTuPCdqaJCywIP9lJRRLvXVY+LLOTfQODEWMS/NPOleDnr/6p10Bt0NR1Wx+XxQfd+EBGMpdmaYkuIzc0wpZo+ol0JU6fGdt9iS6PPAxCKmMzScnNJLWJvRw+pv4flVvtQiZvDXHK37UScL1l5uvdv6Rs9EgpAbSa+usCqsmWOtHCpHjDzLJG0UoVXrF0vcS2bjFKecftEqwmBCr8RrI+mFSFBj7QJRLGKZIW2dQEsMuZH0VRBZZ4SasIiNtZlyVx/BR05bj7VZ6lxm263WQufmoHg9HuRG/lCQNGM9ZatVxJxwnqGguR+R7asVTRm0mVY26PD68PCpS67yOEZrx7mEyrsf44ndZhu0uXTPWb62s3w5h0gmYCuN5OKbDQOFIhjdl0bdvz48vP9nYenxs8bpKbpUqAnMfRIxWk0iyMJOdGYBfMKFArr3mm/+OqvRGG12G/1xmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXG90/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6KHvODj2Wxjk+EmnyI727tnCsKYIjRhouqSPFM/BsXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQqNRsrz77+8VV6NRXXU8jn2h8yI3kOk5GjqD6F40lvgoRtKXIgCnfm5dTUU+lWitXIBQDieGTvBETITj4TFCOTXmGR8JKQj+RKaJ20BtB9kmXUNdioam/m6oQpvgDCXtGuC501PuSFR1S51r8zCmum4EHEa5FQqtBVQpVzERlhGNqCjMFaByaDIjLIJ1hrQWQTetnOGxgylXfIKhVlt3VoJSEOzB6FFuHVgtc68yOC6kNqFi7A1SiEmoFncfM5oCGqXLu8GU4DdDmOQiQRtBrBMqWlOUyQSVwAitg4x0ETFaEporqeMHH0A6fiHTlHwEl6DHGzoSuzNcWbrABF3KGFQOy4ymcxyDgo3GtUWK8KlQD7Z4CdxWuLrBkRUO7/5RInQ+nz/ZQt9u8rwR7ud8BJeYaSucNos190S4NB/5bVcXUv0Jkt6gQo+f2qZay0h0bJ/uYhptpSiz1hU6Qohtdfo9n6+/hXe//Q9OkRsFqZ4HtMa5QbmASbkUeS5EPritSrcw1h54KXk8DuArLrOlB29S7t799n8L5zgHoYotRaY0Gv18JEUMg6KMZxuNNpyE+21Z2rPgUu4g5gpGCDblBKWZ4MAhC9xSqIcmdNSCGhMG5sKFEiGNe74NM/z7pQy3hRGnZoZWnqNcs7nWiManFuUMLcmiQ3OEgInYLkjWlSmMMzimB+CNSCbovG2dJIGsGJ6HYXJ4TR0c04ZwKS6AGwSLyjWhv8XiZ/Is04a0EEH5saYGDgUAVZJpQT2YokxayY/WQPfPCKHVM0PBhbxyR7RVbS12YmFxNdr0r52tA2Ez3xoco6EFvdnruGSigNNtCUsgtH4OrOlAoKzFY38P8U/IcDL9sC3H3wnQTO3F+ArNTMTlQ+Y9O7rliVssYlLEqCzW7hqdN/1TmH3XPGRR7fT6E5u7ddo76Z5fdUkZSqTBYUfNw+YhDdF1Y8pVbaWropV3vdHK2z7iluvL2L4BuC+e7BuA++7PvgG4h8C+AbhvAO4bgPsG4JeXNPYNwD2ivrIGYFEUdfjoWpnkwhehi95aqB/flm0w6smlVFlu37LlkooT10auVjT8a46GytJ3EZtxI/iIapy3d6uoLKVSwfkBF6zNTsKT72BACxO5zENVdqsWT7XgwNGJY8zcTtp68bt/cTVgERsV/cqpTojH8Dn1MvmctZnve/oCoO+o0diSSa4mOZ8QbZBJ1V+qHm2Wjh986bj4QVaVU2pR03CzphzMoE8y6lmG5TKUpVerij5MvZejcGxJTYG7W61WfwAQ6xsX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},N=void 0,g={},v=[{value:"Events:",id:"events",level:3}];function I(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(E.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,i.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(E.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function M(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/d0524430.6f5015ca.js b/assets/js/d0524430.6f5015ca.js new file mode 100644 index 000000000..92e53c943 --- /dev/null +++ b/assets/js/d0524430.6f5015ca.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>T,frontMatter:()=>I,metadata:()=>s,toc:()=>N});const s=JSON.parse('{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/v1.1/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/save-update-webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWdtuIzcS/ZUKB9jdCG3JnjjAQk9RHO1EWF8ES4axsAwP1V1SM6LIDsmWLAgC8rB/sE/7mk+bLwmK7G5d7NFkZgJjMNCLLmRVsS6HRbJqyRwfW9a8Y7c4TLWesPuIJWhjIzIntGJN1k8RLJ8haAN5lnCHUNBCq9sBLqWeW1joHJwOhBzmBcHN9TnMUxGnICzkFhOicUaMx2gAZ6icrQ/UQL169Qra/m+T/tZqJ3WYCZxj0qzVBuoIblNUwMGKsULjpyxwSHScT1G5CFwqbBAIcyFluUZ9oN6+fTtQy4ECGDBPMGBNGLAgfcCiMOMWGYaJn67Obi7al/2H/n+67WpeD3/B2HWSHZrOTxXFSMhdCTfX59W04tPd6cvWxXoBpV0x35XILYJBUhG4SrzVwcLS4IptI1SBu5oJrrI0ekcjAMvwta1Nr/Pmsn29qUugwCkXcoukfdHqnG/RZKlW22K6P19dtgcskKzo675QJ/j7x8V7RZYkrSJA/c5Fu9dvXXSr+dggd88SDNSqCDRh53UdCtJt8JTOIywWBJ8AnILzgJyXQs6fCfu+GINLjc7HKbgUITF85MDhNJOUyFrdzgECXxgENmhysyGlc/kmOOUTMUKp4bt6OEL2ZIYwD8NFddx8AkKCkK8eIDRYAONDsPgwKD6QFVabK/8Fp8RpHWI9zSTuPSc20CBlgQf7KSmjXOqrx8SXc26gcWIkYl6aeda+7nf+1Tlr9dtbjqpi8/mg+r4OCcZS7M0wJcVn5phSzAFRL4Wo0uN7b7El0eeBiUVMZ2g4OaWTsCajh9XfwvOrfKlFzOCvOVr3o04WrLncebd1jZ6JBCE3kl5dYVVYM8daOVSOGHmWSdooQqvGL5a4l8zGKU45/aJVhMGEXok3RtILkaDGmgWiWMQyQ9o6gZYYciPpqyCyzgg1ZhEbaTPlbnMEHzltPdZkqXOZbTYaC52bo+L1eJQb+UNBUo/1lK1WEXPCeYaC5mFItq9WNGXQZlrZoMPr4+OnLunlcYzWjnIJlXc/xhP7zTZoc+mes3xtZ/lyDpFMwFYaycU3WwYKRTB6KI16eH18/PDPwtLTZ43TU3SpUGOY+yRitBpHkIWd6MwC+JgLBXTvNd/8dVajMdrsN/rjNNvnhNPj44eTygknT51Q+ddI4NIgTxaAj8I6+7Im79Njv4EnD/PKwNOnBt5YNKC0g5HOVfKyRu2uvd+Q08qM75+a0VEzLkXiK0h9PUH1spZsLu/C8qTq49QnLjpZvEmeyM+zLVM3x4ORFuPcCLdgzbslezzimTgK8827+9V9xGgDaMrjmbZeY+5S1mSNeZWOLZoZGusF7GzsOaebwM/50Ovbyp2GCx1PglE+2Vb5cyaMC5LqNrCl+ZCSZ6NrOGWZSz6bcNPQGarGSf24fsxW0XJHiOUqGerHOhHRESz50HoZPBON2Un95BkenmUfRY/50ceyWMfHQo0/xHe/jkaPEBNAsRWTCho8E//GBYvKkG9SRUyQ91PkCRoPDwLi9frIbZdw2lV0/yFGckfaK1EA6ipD1aP7EYXXG7Fbg71FGesp+uppilCrlSzv/vt7xVWrVXcrv3F8ZfUqN5DpORo69OgiNpL4KIbS1z4Ap35uXb5FPpVorVyAUA7Hhq4MiRgLx8Prh5J4zDM+FFLQfiMyTdwGNrasrdO916VoaOrvhkrCCc5Q0jYFnjs95Y5EVdfiuTaTERWSI+AwzK1QaC2gSrmKibCMaERVaK4AlUOTGWERrDOktQi6aeUMjx1MueJjDMXhTWclKAXtMzB6mFsHVsvcqwyOC6lNKFF7gxRiEsrT7ceMpoBG6bVgMCX4zRDGuUjQRhDrhKrkFGUyQSUwROsgI11EjJaE5krqeOIDSDsRMk3ZTnAJerSlI7E7w5WlG1PQpYxB5bDMaLo4YFCwVruxSBE+F2pii6fHXYWrWxxa4fD+HyVC5/P5ky307TbPG+Eo41xjpq1w2izW3GPhyqyyKaT6EyS9QYUePxubai0j0bF9uotptJGizBo9dIQQ22h1O/6A+Bbe/fY/OEduFKR6HtAa5wblAsblUuS5EPngtiq/w0h74KXk8TiAr7g9lx68Tbl799v/LVziHIQqthSZUqt186EUMfSLuqGt1ZpwFi7UZS3Rgku5g5grGCLYlBOUZoIDhyxwS6EmdWipBXVCDMyFCzVJGvd8W2b4B1MZbgtDTt0TrTxHuWZ9rRGNTy3KGVqSRaf0EAETsVsB3VSmMM7giF6ctyIZo/O2tZIEsmJ4HobJ4Rvq4Ig2hEtxAdwgWFSuDt0dFj+TZ5k2pIUIyo80dYwoAKiSTAtq+hR12Up+tAa6f7cIrZ4ZCi7klTuinfJusRMLi6vRun9e7RwI2/nW4AgNLejNXsclEwWc7kpYAqH1c2BNBwJlLR77i49/s4aT6YddOf4SgmZqr0Y9NDMRly+n9+zohidusIhJEaOyuHG5ab3pnsPsu/rx1hXiT2zuxnnnrH3Za5MylEiDw8qrhL/fTLnaWKlX9A5vtnqHu0fccn37O3QcD9WaQ8fx0G46dBwPEDh0HA8dx0PH8dBx/PKSxqHjeEDUV9ZxLIqiDh9dI5Nc+Kp30cwLBeu7su9GTcCUStnNO7ZcUnHixsjVioZ/zdFQHfw+YjNuBB9SjfPufhWVpVSqcE9wwZrsLDz5jvq0MJHLPFRld4r/VAsOHK04xsztpd2stneven0WsWHRIJ3qhHgMn1PzlM9Zk/lGqy8A+hYejS2Z5Gqc8zHRBplU/aXq0XbpeOJLx8UPsqqcUosNDbdrysEM+iSjnmVYLkNZerWq6MPUezkKx5bUFLj71Wr1B2V0QsI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"}}');var i=t(74848),r=t(28453),o=t(33617),a=t.n(o),d=t(17543),l=t.n(d),c=t(86013),p=t.n(c),h=t(63723),E=t.n(h),M=(t(18766),t(79329),t(9303));const I={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWdtuIzcS/ZUKB9jdCG3JnjjAQk9RHO1EWF8ES4axsAwP1V1SM6LIDsmWLAgC8rB/sE/7mk+bLwmK7G5d7NFkZgJjMNCLLmRVsS6HRbJqyRwfW9a8Y7c4TLWesPuIJWhjIzIntGJN1k8RLJ8haAN5lnCHUNBCq9sBLqWeW1joHJwOhBzmBcHN9TnMUxGnICzkFhOicUaMx2gAZ6icrQ/UQL169Qra/m+T/tZqJ3WYCZxj0qzVBuoIblNUwMGKsULjpyxwSHScT1G5CFwqbBAIcyFluUZ9oN6+fTtQy4ECGDBPMGBNGLAgfcCiMOMWGYaJn67Obi7al/2H/n+67WpeD3/B2HWSHZrOTxXFSMhdCTfX59W04tPd6cvWxXoBpV0x35XILYJBUhG4SrzVwcLS4IptI1SBu5oJrrI0ekcjAMvwta1Nr/Pmsn29qUugwCkXcoukfdHqnG/RZKlW22K6P19dtgcskKzo675QJ/j7x8V7RZYkrSJA/c5Fu9dvXXSr+dggd88SDNSqCDRh53UdCtJt8JTOIywWBJ8AnILzgJyXQs6fCfu+GINLjc7HKbgUITF85MDhNJOUyFrdzgECXxgENmhysyGlc/kmOOUTMUKp4bt6OEL2ZIYwD8NFddx8AkKCkK8eIDRYAONDsPgwKD6QFVabK/8Fp8RpHWI9zSTuPSc20CBlgQf7KSmjXOqrx8SXc26gcWIkYl6aeda+7nf+1Tlr9dtbjqpi8/mg+r4OCcZS7M0wJcVn5phSzAFRL4Wo0uN7b7El0eeBiUVMZ2g4OaWTsCajh9XfwvOrfKlFzOCvOVr3o04WrLncebd1jZ6JBCE3kl5dYVVYM8daOVSOGHmWSdooQqvGL5a4l8zGKU45/aJVhMGEXok3RtILkaDGmgWiWMQyQ9o6gZYYciPpqyCyzgg1ZhEbaTPlbnMEHzltPdZkqXOZbTYaC52bo+L1eJQb+UNBUo/1lK1WEXPCeYaC5mFItq9WNGXQZlrZoMPr4+OnLunlcYzWjnIJlXc/xhP7zTZoc+mes3xtZ/lyDpFMwFYaycU3WwYKRTB6KI16eH18/PDPwtLTZ43TU3SpUGOY+yRitBpHkIWd6MwC+JgLBXTvNd/8dVajMdrsN/rjNNvnhNPj44eTygknT51Q+ddI4NIgTxaAj8I6+7Im79Njv4EnD/PKwNOnBt5YNKC0g5HOVfKyRu2uvd+Q08qM75+a0VEzLkXiK0h9PUH1spZsLu/C8qTq49QnLjpZvEmeyM+zLVM3x4ORFuPcCLdgzbslezzimTgK8827+9V9xGgDaMrjmbZeY+5S1mSNeZWOLZoZGusF7GzsOaebwM/50Ovbyp2GCx1PglE+2Vb5cyaMC5LqNrCl+ZCSZ6NrOGWZSz6bcNPQGarGSf24fsxW0XJHiOUqGerHOhHRESz50HoZPBON2Un95BkenmUfRY/50ceyWMfHQo0/xHe/jkaPEBNAsRWTCho8E//GBYvKkG9SRUyQ91PkCRoPDwLi9frIbZdw2lV0/yFGckfaK1EA6ipD1aP7EYXXG7Fbg71FGesp+uppilCrlSzv/vt7xVWrVXcrv3F8ZfUqN5DpORo69OgiNpL4KIbS1z4Ap35uXb5FPpVorVyAUA7Hhq4MiRgLx8Prh5J4zDM+FFLQfiMyTdwGNrasrdO916VoaOrvhkrCCc5Q0jYFnjs95Y5EVdfiuTaTERWSI+AwzK1QaC2gSrmKibCMaERVaK4AlUOTGWERrDOktQi6aeUMjx1MueJjDMXhTWclKAXtMzB6mFsHVsvcqwyOC6lNKFF7gxRiEsrT7ceMpoBG6bVgMCX4zRDGuUjQRhDrhKrkFGUyQSUwROsgI11EjJaE5krqeOIDSDsRMk3ZTnAJerSlI7E7w5WlG1PQpYxB5bDMaLo4YFCwVruxSBE+F2pii6fHXYWrWxxa4fD+HyVC5/P5ky307TbPG+Eo41xjpq1w2izW3GPhyqyyKaT6EyS9QYUePxubai0j0bF9uotptJGizBo9dIQQ22h1O/6A+Bbe/fY/OEduFKR6HtAa5wblAsblUuS5EPngtiq/w0h74KXk8TiAr7g9lx68Tbl799v/LVziHIQqthSZUqt186EUMfSLuqGt1ZpwFi7UZS3Rgku5g5grGCLYlBOUZoIDhyxwS6EmdWipBXVCDMyFCzVJGvd8W2b4B1MZbgtDTt0TrTxHuWZ9rRGNTy3KGVqSRaf0EAETsVsB3VSmMM7giF6ctyIZo/O2tZIEsmJ4HobJ4Rvq4Ig2hEtxAdwgWFSuDt0dFj+TZ5k2pIUIyo80dYwoAKiSTAtq+hR12Up+tAa6f7cIrZ4ZCi7klTuinfJusRMLi6vRun9e7RwI2/nW4AgNLejNXsclEwWc7kpYAqH1c2BNBwJlLR77i49/s4aT6YddOf4SgmZqr0Y9NDMRly+n9+zohidusIhJEaOyuHG5ab3pnsPsu/rx1hXiT2zuxnnnrH3Za5MylEiDw8qrhL/fTLnaWKlX9A5vtnqHu0fccn37O3QcD9WaQ8fx0G46dBwPEDh0HA8dx0PH8dBx/PKSxqHjeEDUV9ZxLIqiDh9dI5Nc+Kp30cwLBeu7su9GTcCUStnNO7ZcUnHixsjVioZ/zdFQHfw+YjNuBB9SjfPufhWVpVSqcE9wwZrsLDz5jvq0MJHLPFRld4r/VAsOHK04xsztpd2stneven0WsWHRIJ3qhHgMn1PzlM9Zk/lGqy8A+hYejS2Z5Gqc8zHRBplU/aXq0XbpeOJLx8UPsqqcUosNDbdrysEM+iSjnmVYLkNZerWq6MPUezkKx5bUFLj71Wr1B2V0QsI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,g={},N=[{value:"Events:",id:"events",level:3}];function S(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(M.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,i.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(M.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,i.jsx)(E(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function T(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(S,{...e})}):S(e)}}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.2025796d.js b/assets/js/d480dde9.2025796d.js new file mode 100644 index 000000000..a7836d32c --- /dev/null +++ b/assets/js/d480dde9.2025796d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3230],{94677:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>S,contentTitle:()=>u,default:()=>q,frontMatter:()=>W,metadata:()=>s,toc:()=>k});const s=JSON.parse('{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.1/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-webhook","permalink":"/docs/API-docs/v1.1/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uGzcQfpUJL22EtVZJ00N1qpEYqVE3MWoHPthCwN0d7TLikiyHK1kQBOTQN+ip1z5anqQYUqs/J2nTFr1I8vz/fDMcr0SQNYnxrbjBorF2JiaZqJBKr1xQ1oixuG4QXqDGgLCRgdPLc5Ba2wUsbQfBQpX4iw2/81pkwjr0ko2cV2IskkjvJRMeyVlDSGK8Ek9HI/46dHzVlSUSTTsNW1MiE6U1AU1geemcVmVk5O+IlVaCygZbyb/C0qEYC1u8wzKITDjPZoJKLj1Sp8OeHAWvTC0ygfeydZpJfb4p9gpoG5FePhLrdSaCClFSGa0Mvu2Tevt0NHr7nVivWebZ6NnD5N4QejA2wNR2pnr03+WF3lv/+bSOfX8uEQ6+T+Pbh2mcm7nUqoqIuLYzNP9vJvvuQ3LPod63mvWMbFNKUSjyxUGq+/SUJGHZeRWWYny7Evcn0qmTxB/fTtaTTLQYGruDM8csQyPGIl9skU3o5+gpmjhC9ELWNfofuiJGfNoFCz/ZcpbS4qkZiyYER+M8nysfkqUhJbWmK4albfNLLxmBr+R8Jn1uHZr8yXA0HIl1tjoyQtJUhb0fshCp2mhZULQhncrnT4ZPPqIjnfsieexOvlSFgqyVqf9Kb7LrxxVjJsHioCtbcEinfsSlyPqm70tlQnH1G5QV+ggQZaY2Km+g8NqhuVK1iW2Jzo+34A3q0rbIyy40CINBr/Lh1z+2WoMBVLbsWjQhQn54Z+7M686Dswv0vMikqWCq8V4VGqMatpFH/SYllK1GIr0EZQLWXgaEStUqSA1cJ2VqKKWThdKKJ4XFLGt72Bs2GsJNg6FBz6yvPIKECueoecBAdsG2MrCpPl5YWD+barugDCQUHSmDRICmkaZkwb4TGVgP0gCagN55RQgUPEetUmzWBC/LAK00ska2ncF+sSrUiucDvC06CkBWdzFkCFJp67GCPiGDWFEs4tm9YxYwtbSt89gwbOYIdacqpAxKWyFQXAycgqmgQArgOBZVIrHRzmhbzmIDeYLAWd5TSmqw04MYWT14aWhqfZti6XuwLZjzlh8DTAEOBm8IucMXysxoPBjcmRO43eLqBgtSASdf9yOwWCweQP/xoc5LFXhT/IzOkgrWL3fatQr9Ntg3sv0jWXqJBiN+9oZhZ6OyJT2cPqbmDWqXX2FghFB+enkeV/tj+PD+N7hA6Q00dpHQWnYe9RLq3hVXLnU+lW27mWFqI/AarniZwOfxlw4p9BW8aWT48P53gle4AGU2I8WpDAaXXaFVCdfYOi0D0mAwhuce2WXoaRAaGaCUBgoEaiRDaa4kSHBJWyszG8KpWULHT+BChSaCgelR7yANrsu23QSFJKzAmqjR+xzuImJ6S6jnSGyL39cCASvFl0NovO3q5G0/mE1yHqdKa7hRVY0h5nZaVeA25EUix0NrFw5OeSBCg0uQHoHQhCFcHqlETuec9RyFSsFPLd9u3AA0lbPKBBpD5eU07OxnO6CXXGZlzUdIqYRyW45sY2bbkjSJm4y31OEdL+WjRX64bz1O0bPDmPauL05t4HTbwxIYrf8G1nwT8NaSZTxZsJVKpxfl+2M78XxA39Lr6RX6uSpx86p9YqLzKJyLTGhVoiHcO0tOX15ewPyb4ejg6f8bw51fnD8/e3V1xsHwIk0F608A4SyFVpo9T4fX+/HTttrda//81t+8wgHvQ+60VPHQilmtNhfSrVjs/sNoLAUmrVY8VW+8Xq+Z/EuHnk+vSSbm0itZ8ON8O1ln/dvNJ9UMl1y9skTHN+Nc6i4dAEeX5sG59uLs4uz6TGSCN9Dh2TCLZ8PmBzvoWWa5Z/7wnkgx8CcfNx9VWK3SSbJeb+UT65Mamxx7aa7hZL1e/wmEwNKU","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"}}');var n=t(74848),a=t(28453),l=t(33617),i=t.n(l),r=t(17543),d=t.n(r),c=t(86013),p=t.n(c),h=t(63723),b=t.n(h),m=(t(18766),t(79329),t(9303));const W={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uGzcQfpUJL22EtVZJ00N1qpEYqVE3MWoHPthCwN0d7TLikiyHK1kQBOTQN+ip1z5anqQYUqs/J2nTFr1I8vz/fDMcr0SQNYnxrbjBorF2JiaZqJBKr1xQ1oixuG4QXqDGgLCRgdPLc5Ba2wUsbQfBQpX4iw2/81pkwjr0ko2cV2IskkjvJRMeyVlDSGK8Ek9HI/46dHzVlSUSTTsNW1MiE6U1AU1geemcVmVk5O+IlVaCygZbyb/C0qEYC1u8wzKITDjPZoJKLj1Sp8OeHAWvTC0ygfeydZpJfb4p9gpoG5FePhLrdSaCClFSGa0Mvu2Tevt0NHr7nVivWebZ6NnD5N4QejA2wNR2pnr03+WF3lv/+bSOfX8uEQ6+T+Pbh2mcm7nUqoqIuLYzNP9vJvvuQ3LPod63mvWMbFNKUSjyxUGq+/SUJGHZeRWWYny7Evcn0qmTxB/fTtaTTLQYGruDM8csQyPGIl9skU3o5+gpmjhC9ELWNfofuiJGfNoFCz/ZcpbS4qkZiyYER+M8nysfkqUhJbWmK4albfNLLxmBr+R8Jn1uHZr8yXA0HIl1tjoyQtJUhb0fshCp2mhZULQhncrnT4ZPPqIjnfsieexOvlSFgqyVqf9Kb7LrxxVjJsHioCtbcEinfsSlyPqm70tlQnH1G5QV+ggQZaY2Km+g8NqhuVK1iW2Jzo+34A3q0rbIyy40CINBr/Lh1z+2WoMBVLbsWjQhQn54Z+7M686Dswv0vMikqWCq8V4VGqMatpFH/SYllK1GIr0EZQLWXgaEStUqSA1cJ2VqKKWThdKKJ4XFLGt72Bs2GsJNg6FBz6yvPIKECueoecBAdsG2MrCpPl5YWD+barugDCQUHSmDRICmkaZkwb4TGVgP0gCagN55RQgUPEetUmzWBC/LAK00ska2ncF+sSrUiucDvC06CkBWdzFkCFJp67GCPiGDWFEs4tm9YxYwtbSt89gwbOYIdacqpAxKWyFQXAycgqmgQArgOBZVIrHRzmhbzmIDeYLAWd5TSmqw04MYWT14aWhqfZti6XuwLZjzlh8DTAEOBm8IucMXysxoPBjcmRO43eLqBgtSASdf9yOwWCweQP/xoc5LFXhT/IzOkgrWL3fatQr9Ntg3sv0jWXqJBiN+9oZhZ6OyJT2cPqbmDWqXX2FghFB+enkeV/tj+PD+N7hA6Q00dpHQWnYe9RLq3hVXLnU+lW27mWFqI/AarniZwOfxlw4p9BW8aWT48P53gle4AGU2I8WpDAaXXaFVCdfYOi0D0mAwhuce2WXoaRAaGaCUBgoEaiRDaa4kSHBJWyszG8KpWULHT+BChSaCgelR7yANrsu23QSFJKzAmqjR+xzuImJ6S6jnSGyL39cCASvFl0NovO3q5G0/mE1yHqdKa7hRVY0h5nZaVeA25EUix0NrFw5OeSBCg0uQHoHQhCFcHqlETuec9RyFSsFPLd9u3AA0lbPKBBpD5eU07OxnO6CXXGZlzUdIqYRyW45sY2bbkjSJm4y31OEdL+WjRX64bz1O0bPDmPauL05t4HTbwxIYrf8G1nwT8NaSZTxZsJVKpxfl+2M78XxA39Lr6RX6uSpx86p9YqLzKJyLTGhVoiHcO0tOX15ewPyb4ejg6f8bw51fnD8/e3V1xsHwIk0F608A4SyFVpo9T4fX+/HTttrda//81t+8wgHvQ+60VPHQilmtNhfSrVjs/sNoLAUmrVY8VW+8Xq+Z/EuHnk+vSSbm0itZ8ON8O1ln/dvNJ9UMl1y9skTHN+Nc6i4dAEeX5sG59uLs4uz6TGSCN9Dh2TCLZ8PmBzvoWWa5Z/7wnkgx8CcfNx9VWK3SSbJeb+UT65Mamxx7aa7hZL1e/wmEwNKU",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,S={},k=[];function y(e){const o={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,n.jsx)(i(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,n.jsx)(d(),{parameters:void 0}),"\n",(0,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function q(e={}){const{wrapper:o}={...(0,a.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.a2cfa06b.js b/assets/js/d480dde9.a2cfa06b.js deleted file mode 100644 index fe60841ae..000000000 --- a/assets/js/d480dde9.a2cfa06b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3230],{94677:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>m,contentTitle:()=>W,default:()=>I,frontMatter:()=>u,metadata:()=>l,toc:()=>E});const l=JSON.parse('{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.1/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-webhook","permalink":"/docs/API-docs/v1.1/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9VktvGzcQ/isTXtoIa0lJ00N1qpEYqVEjMWoHPthCwN0daRlxSYYzK1kQBOTQf9BTr/1p+SXFcLV6OUmbtuhFj+G855vHSrGekhrdqhvMK+9napypEqmIJrDxTo3UdYXwAi0ywoYHTi/PQVvrF7D0DbCHsn1fbN6baFWmfMCoRcl5qUaqZemsZCoiBe8ISY1W6ulwKF+Hhq+aokCiSWNhq0plqvCO0bHw6xCsKdLD4B2J0EpRUWGt5RcvA6qR8vk7LFhlKkRRw6Y1GZEay3t8xNG4qcoU3us6WCF18ba+l0Bbj+zykVqvM8WGE6dx1jh82wX19ulw+PYHtV4Lz7Phs4fBvSGM4DzDxDeufPTfxYUx+vjlsI5tfykQcb4L4/uHYZy7ubamTIi49jN0/28k++a5NS+u3tdW5Jyu25ASU3pXB6Hu09sgCYsmGl6q0e1K3Z/oYE7a99HteD3OVI1c+R2cxWfNlRqpwWKLbMI4x0hJhXTCSFXMgUaDAWlX5v6+7wM6MlNndU79wtcDHcxg/qT/RK2zYxkdwlfxY3PytSLEemrc9K/kxrv0XEkJ2yodJGlbKx3Mz7hUWVeDfa5MGYFOhbrEmOpl3MQn4U1lXgd0V2bqUl2T8eOhdIO28DXK7OEKodfrRD7++sdWqteD0hdNjY4TAvt37s69biIEv8Aoc0W7EiYW701uMYlhnd6oG2yEurZIZJdgHOM0akYozdSwtiB5Mm4KhQ46N9YIcIXNi3SEPexTH24q5AqjPH0TETSUOEcreAfdsK81i6rOX1j4OJtYv6AMNOQNGYdEgK7SrhDGrhIZ+AjaATrGGKIhBOIoXpvWN+846oKh1k5PUXRnsJ+sEq0RuEL0eUMM5G2TXAbWxvqIJXQBOcSSUhLP7oM8gVALX4eIlcBmjjBtTImUQeFLBEp9KiG4EnIkhiC+mAJJlDbO+mKWCigjFYKXsWG0BT858FHEOWpHEx/r1peuBtuEhehlNmPrYK/3hlAqfGHcjEa93p07gdstrm4wJ8M4/rZrgcVi8QD6jw9lXhr+qcnhFwyeDPu43ElPDVdNntplX8n2T6vpJTpM+Nlrhp2O0hf0sPuEOqjQhsEVsiCEBqeX52nSPoaPH36DC9TRQeUXLVqLJqJdwrQzJZlrK9+mbTsoYeIT8CrJeNGCL+L7Bom7DN5Umj9++J3gFS7AuE1LSSi93mWTW1PANdbBakbq9UbwPKKY5I4GXGmGQjvIEajSAqW50aAhtNLWuFkfTt0SGtlIC8NVAoPQk9xBGJKXbbkJck1YgndJorPZ33kk9JrQzpFEl6y7HAFLI4ucq+ibaWtt35lNcBEnxlq4MeUUOcV2WpYQNuRFS053z84dnEhDcIVL0BGB0HEfLo9E0ksTgo/ihWmdn3g5paQA6MrgjWMaQRn1hHf6sx3QC0mz8e4TpDaFepuObKNmW5K2EzcRb6n9OxnKR4P8cN5GnGAUgynsXV2C2cDptoMlCFr/DaxlRcvU0kW6ILDWxrYb5cdjPWmbY6zp9eQK49wUuNlqn+noQWIeqExZU6Aj3LsSTl9eXsD8u/5QZXvr8W809+Di/PnZq6szcUYGaZuwJ/1hfyik4Ilr7fYsHR7Tx6tttTuf/vnpvdnCjPc8CFabdPekqFabg+VWLXYHf+WJhbRaSVe9iXa9FvL7BqNcQuNMzXU0OpflfDteZ93ulgtnhkvJXlFgkBNurm3THgBHh9/B9fTi7OLs+kxlSibQ4dkwS2fD5ocY6J7cck/94T3R+iCfctx8UmC1ak+S9XrL3z59VmITY8ctORyv1+s/AXfSquk=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"}}');var s=o(74848),n=o(28453),i=o(33617),r=o.n(i),d=o(17543),a=o.n(d),c=o(86013),h=o.n(c),p=o(63723),b=o.n(p),k=(o(18766),o(79329),o(9303));const u={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VktvGzcQ/isTXtoIa0lJ00N1qpEYqVEjMWoHPthCwN0daRlxSYYzK1kQBOTQf9BTr/1p+SXFcLV6OUmbtuhFj+G855vHSrGekhrdqhvMK+9napypEqmIJrDxTo3UdYXwAi0ywoYHTi/PQVvrF7D0DbCHsn1fbN6baFWmfMCoRcl5qUaqZemsZCoiBe8ISY1W6ulwKF+Hhq+aokCiSWNhq0plqvCO0bHw6xCsKdLD4B2J0EpRUWGt5RcvA6qR8vk7LFhlKkRRw6Y1GZEay3t8xNG4qcoU3us6WCF18ba+l0Bbj+zykVqvM8WGE6dx1jh82wX19ulw+PYHtV4Lz7Phs4fBvSGM4DzDxDeufPTfxYUx+vjlsI5tfykQcb4L4/uHYZy7ubamTIi49jN0/28k++a5NS+u3tdW5Jyu25ASU3pXB6Hu09sgCYsmGl6q0e1K3Z/oYE7a99HteD3OVI1c+R2cxWfNlRqpwWKLbMI4x0hJhXTCSFXMgUaDAWlX5v6+7wM6MlNndU79wtcDHcxg/qT/RK2zYxkdwlfxY3PytSLEemrc9K/kxrv0XEkJ2yodJGlbKx3Mz7hUWVeDfa5MGYFOhbrEmOpl3MQn4U1lXgd0V2bqUl2T8eOhdIO28DXK7OEKodfrRD7++sdWqteD0hdNjY4TAvt37s69biIEv8Aoc0W7EiYW701uMYlhnd6oG2yEurZIZJdgHOM0akYozdSwtiB5Mm4KhQ46N9YIcIXNi3SEPexTH24q5AqjPH0TETSUOEcreAfdsK81i6rOX1j4OJtYv6AMNOQNGYdEgK7SrhDGrhIZ+AjaATrGGKIhBOIoXpvWN+846oKh1k5PUXRnsJ+sEq0RuEL0eUMM5G2TXAbWxvqIJXQBOcSSUhLP7oM8gVALX4eIlcBmjjBtTImUQeFLBEp9KiG4EnIkhiC+mAJJlDbO+mKWCigjFYKXsWG0BT858FHEOWpHEx/r1peuBtuEhehlNmPrYK/3hlAqfGHcjEa93p07gdstrm4wJ8M4/rZrgcVi8QD6jw9lXhr+qcnhFwyeDPu43ElPDVdNntplX8n2T6vpJTpM+Nlrhp2O0hf0sPuEOqjQhsEVsiCEBqeX52nSPoaPH36DC9TRQeUXLVqLJqJdwrQzJZlrK9+mbTsoYeIT8CrJeNGCL+L7Bom7DN5Umj9++J3gFS7AuE1LSSi93mWTW1PANdbBakbq9UbwPKKY5I4GXGmGQjvIEajSAqW50aAhtNLWuFkfTt0SGtlIC8NVAoPQk9xBGJKXbbkJck1YgndJorPZ33kk9JrQzpFEl6y7HAFLI4ucq+ibaWtt35lNcBEnxlq4MeUUOcV2WpYQNuRFS053z84dnEhDcIVL0BGB0HEfLo9E0ksTgo/ihWmdn3g5paQA6MrgjWMaQRn1hHf6sx3QC0mz8e4TpDaFepuObKNmW5K2EzcRb6n9OxnKR4P8cN5GnGAUgynsXV2C2cDptoMlCFr/DaxlRcvU0kW6ILDWxrYb5cdjPWmbY6zp9eQK49wUuNlqn+noQWIeqExZU6Aj3LsSTl9eXsD8u/5QZXvr8W809+Di/PnZq6szcUYGaZuwJ/1hfyik4Ilr7fYsHR7Tx6tttTuf/vnpvdnCjPc8CFabdPekqFabg+VWLXYHf+WJhbRaSVe9iXa9FvL7BqNcQuNMzXU0OpflfDteZ93ulgtnhkvJXlFgkBNurm3THgBHh9/B9fTi7OLs+kxlSibQ4dkwS2fD5ocY6J7cck/94T3R+iCfctx8UmC1ak+S9XrL3z59VmITY8ctORyv1+s/AXfSquk=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},W=void 0,m={},E=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.717af639.js b/assets/js/da66eb9c.717af639.js deleted file mode 100644 index b680eb21e..000000000 --- a/assets/js/da66eb9c.717af639.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>f,metadata:()=>a,toc:()=>b});const a=JSON.parse('{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/v1.1/update-document.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-document","permalink":"/docs/API-docs/v1.1/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWM2OG7kRfpUKL7GFHkm2xxtEp0y8hm3EsAXPDAxkPBCoZrWaO2ySS7KlEQQBe9g3yCnXPJqfJCiyu9X68djOLhIgl4GGXSxWfVVkfVUbFvjCs8kN+9HkdYU6eHabMYE+d9IGaTSbsKsS4doKHhBaKbiYvgGulFl5qD06D8FAZYQs1sC1gDqJhxJBYOBSeTAFcPAWc1nIHESjaAjvTBTkAUIpfVRstFq32oNplXEocAWWO15hQOczWJsacq61CZCXXC/SgYVUCEbnCDIkC1qjpYfcIQ8ohixjxqLj5OIbwSYsHdL6xzK2O4hNbjZM8wrZhLW6ZlKwjEmCx/JQskPM3vxIDu+dHn3UiCI6NcfGL9Lj8OdaOhRsElyNGfNhreg0LyurkGUM760yAtmk4MqTQF5ixdlkw8LaRsngpF6wjBXGVTzsVrbb26QfffirEWvas2/q1JmlFAhzVKaHbw/5gJVVPKCHRzyAQu4DGI092daBxyxjudGBIJxsGLdWyTyCPPrJ02mbY9PN/CfMI+KOQhIkevqaAP+6gwQOjzBNmI8/OsjZNmPahO9WMyUXERwuJa5iPnu50Ck/+7r3cPy+I7qs6OvY0h4l0FFGHuvb7SZJ1Hyu8P3VtCc6N0Yh10fZSFkFZ8kBExdhJZWCpAPeX01hiY4uZozVEK7jnY4yDnOUS7p+fRHIjUBYSg5YcakyWJUyLynh11DVPgDqJoca6LB35WMSwxkcGySkP2lRlp4DqRe75+ZIMQjpMA9qDSsZSlMH4EJI2s4V+IDWD/soRis6IK9M7X47khwWtRQoIJjaQWFctDI+VjZeM/JAah9cndNmD6Km6EY/SJR+W2dy9H6HU4sKCfX0Z4Dap+0cCu4DugxqLQl5V9uAolOJ9xadRJ3jSQgiuLP4fjeA+2/HYoquksG3nlJouBCACmM9AV/nJfD0nYfaoc9AahkkVz4DH3hlfQbGQcB7elcgGEuPJ95LH8j4lRQLDB7kl/LoA9IdyXs2FM5UMfqEjV73E6GzK5gDdVcUVOmbqlXwWgVYclWfxsxhSrdZ7dSp27qP1WUqfJi0X394C6sSHXZxR5fyaE7PTlKMVEbjTaODQ5slXbYfpsvRC8HrYGYOK6kFfktuX2KIoFBYg+lSug6m4kHm0KryQ2hEUwCC6WdoBY9a8OZY8qU07vEXACR1M6rUM6lnuES37lmp62qO7sjId3GZ8kPwtYc5hhWi7tvWhjGxiFSByLZViRr2MCEpv3N6z8rn223Gggx7r/WsV/5nc6qm2+02uuKt0T4Vrqfj8XGR7YhTU/TpVlDUilqp9R9+v6qZlr9WP7gXT1/76flrS3nSmHQRHt70dPz02dmT8dn4T1dPfpic/3ny/IfheDz+O8vYfaV2JZuRNtZHL/7fW5BaSY2zFrXZ0/F49qyB8vwUek1Btg1TWXIlBRQSlQA60/+OAKJzxv2HhOEB+x5yn1xunT9/IHWI5xam1uJ/7e4pix528Hx23rn4/NjFNzpBRuT/ytyh/m94uPOnf3xIx5Op+1ktk1D8zvac7a8nJz3mtZNhHTuH+zNu5Vn6Prm5JT5eYSgNdR22Tq1GKNmEjdrXZbTpvTNbRvrcsm1EYrlhZQjWT0Yjz7WYm/uhsaipICg+98PcVCNu5Wj5ZPiEbbPDPdza75LH+ux7t/jAF1IvvrbvdgfVJYUzRWwPsC5u3Mq/4ZplbTz6Uk0nViKnSkcRoCz5sOt6Xrax7sJ52Cq0ncK3kf/DqnSSzvfZPGN7jL1p4/rUs1k6ScWab/uUg1QelPhO7lRlfb4lmAoTMW2S971FfUnuUerHmBx69hFVbips2dJg0G75/Ou/ul2DQQdNaiA+6U/6fe3AmhW6olYRx0LhvaRKTNuwit98bOKJzSOvFHqv1kAEduGo8RRyIQOR94bq5NzyuVSS7jaJGdrtoPc8+CF8LDGU6OjTHx1RcoFLVPQkdFxGL3Y0amXcXUGjhgw4zGsvNXoPqEuucxJsEzRSVK5TY2Od9Ag+OLJaJtuMDo7nASqu+SJyzAz6YAlUkm4xODOnDskbVacegAYkxkVWnxyKU4II4ktq/B0CrRIRdFjSbVo2jYDPUiOWsplc0ALm6ANYskXmmCYoWpn8Lk1HaqXAGnpZJVfEo/o20vbguPb0/Cdb2hh0gDV8E5OBg8G1R4rwW6nv/GQw+KTP4KbLq4849zLg7aP2ZVitVkcvwuP9Pa9keF3P4QNa42Uwbr3bvZChrOfxFekr6f5Jml6hxpg/vTdip0OY3B8/SrQ6KlHZ0SUGyhA/upi+icXoMXz+5R/wFrnTUJpVyta8dqjWsGiPIuRS5BNsXS2JXSCvQ0mI5yn5mnlMi+DHkofPv/zTwztcUZeTrhS5MhhM67mSOVy1I5jBYAIv4hCrN5aJo6Wca2offMkplag152DTbiX13RAu9Dp2z7E9jslA63HfnhvxvWvD7WHOPYrYl5W7M4c7iyLp96iW6Ntp3BwBhSSaG0pn6kU6rW9M45zDgrqej6nDI98uhADbLLeNHzUYO3OwMKlxWgN3CD72btODLfFLba1xZEXTORamHSKgFtZIHfwEhONF2OnPdokeZ4Vx+HC0lCDkHRxZo6YLSbqJjcfd6vATVYWD+rb/3jos0NGB0e1dXKxs0ummTUugbP0taU0shl4tnkeSFQc5qdD+5VBPJDzoKv++uES3lDk2xf4LN3oUhUcsY0rmqH2/8l68mr6F5bPhmGU91vANl3v09s2Ll+8uX5Ix9JAmwJ4Mx8MxLVnjQ8V176SDofVhbdvsKOb/64y74U40WRlZxWVkrs3AIrHOG9YjNZP+ePs2Y6XxgUQ2G3oErp3abmn55zoSipvbjC25k8RhIjVtpgCiIyJfhPvRh3ZgDN83KT/pUMsQNdHDOLFJ7OgO1wcj++3tNmtpIlmcJF4ku86uSM9Ow1HXQTw37bjIc7ThQdk+zZ9eX7GMzZvxexUn+czxFY3++SoZm6aJkQDHtQ1TXC9qviDZpHKbhjrlPiu+i6y4+UFOnYRjny4nL+gv+XRyw2aTGPd228mnT1/c0eDaSlNsbrfb7b8BOQ9Ukg==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"}}');var i=n(74848),s=n(28453),o=n(33617),d=n.n(o),l=n(17543),r=n.n(l),c=n(86013),p=n.n(c),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const f={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWM2OG7kRfpUKL7GFHkm2xxtEp0y8hm3EsAXPDAxkPBCoZrWaO2ySS7KlEQQBe9g3yCnXPJqfJCiyu9X68djOLhIgl4GGXSxWfVVkfVUbFvjCs8kN+9HkdYU6eHabMYE+d9IGaTSbsKsS4doKHhBaKbiYvgGulFl5qD06D8FAZYQs1sC1gDqJhxJBYOBSeTAFcPAWc1nIHESjaAjvTBTkAUIpfVRstFq32oNplXEocAWWO15hQOczWJsacq61CZCXXC/SgYVUCEbnCDIkC1qjpYfcIQ8ohixjxqLj5OIbwSYsHdL6xzK2O4hNbjZM8wrZhLW6ZlKwjEmCx/JQskPM3vxIDu+dHn3UiCI6NcfGL9Lj8OdaOhRsElyNGfNhreg0LyurkGUM760yAtmk4MqTQF5ixdlkw8LaRsngpF6wjBXGVTzsVrbb26QfffirEWvas2/q1JmlFAhzVKaHbw/5gJVVPKCHRzyAQu4DGI092daBxyxjudGBIJxsGLdWyTyCPPrJ02mbY9PN/CfMI+KOQhIkevqaAP+6gwQOjzBNmI8/OsjZNmPahO9WMyUXERwuJa5iPnu50Ck/+7r3cPy+I7qs6OvY0h4l0FFGHuvb7SZJ1Hyu8P3VtCc6N0Yh10fZSFkFZ8kBExdhJZWCpAPeX01hiY4uZozVEK7jnY4yDnOUS7p+fRHIjUBYSg5YcakyWJUyLynh11DVPgDqJoca6LB35WMSwxkcGySkP2lRlp4DqRe75+ZIMQjpMA9qDSsZSlMH4EJI2s4V+IDWD/soRis6IK9M7X47khwWtRQoIJjaQWFctDI+VjZeM/JAah9cndNmD6Km6EY/SJR+W2dy9H6HU4sKCfX0Z4Dap+0cCu4DugxqLQl5V9uAolOJ9xadRJ3jSQgiuLP4fjeA+2/HYoquksG3nlJouBCACmM9AV/nJfD0nYfaoc9AahkkVz4DH3hlfQbGQcB7elcgGEuPJ95LH8j4lRQLDB7kl/LoA9IdyXs2FM5UMfqEjV73E6GzK5gDdVcUVOmbqlXwWgVYclWfxsxhSrdZ7dSp27qP1WUqfJi0X394C6sSHXZxR5fyaE7PTlKMVEbjTaODQ5slXbYfpsvRC8HrYGYOK6kFfktuX2KIoFBYg+lSug6m4kHm0KryQ2hEUwCC6WdoBY9a8OZY8qU07vEXACR1M6rUM6lnuES37lmp62qO7sjId3GZ8kPwtYc5hhWi7tvWhjGxiFSByLZViRr2MCEpv3N6z8rn223Gggx7r/WsV/5nc6qm2+02uuKt0T4Vrqfj8XGR7YhTU/TpVlDUilqp9R9+v6qZlr9WP7gXT1/76flrS3nSmHQRHt70dPz02dmT8dn4T1dPfpic/3ny/IfheDz+O8vYfaV2JZuRNtZHL/7fW5BaSY2zFrXZ0/F49qyB8vwUek1Btg1TWXIlBRQSlQA60/+OAKJzxv2HhOEB+x5yn1xunT9/IHWI5xam1uJ/7e4pix528Hx23rn4/NjFNzpBRuT/ytyh/m94uPOnf3xIx5Op+1ktk1D8zvac7a8nJz3mtZNhHTuH+zNu5Vn6Prm5JT5eYSgNdR22Tq1GKNmEjdrXZbTpvTNbRvrcsm1EYrlhZQjWT0Yjz7WYm/uhsaipICg+98PcVCNu5Wj5ZPiEbbPDPdza75LH+ux7t/jAF1IvvrbvdgfVJYUzRWwPsC5u3Mq/4ZplbTz6Uk0nViKnSkcRoCz5sOt6Xrax7sJ52Cq0ncK3kf/DqnSSzvfZPGN7jL1p4/rUs1k6ScWab/uUg1QelPhO7lRlfb4lmAoTMW2S971FfUnuUerHmBx69hFVbips2dJg0G75/Ou/ul2DQQdNaiA+6U/6fe3AmhW6olYRx0LhvaRKTNuwit98bOKJzSOvFHqv1kAEduGo8RRyIQOR94bq5NzyuVSS7jaJGdrtoPc8+CF8LDGU6OjTHx1RcoFLVPQkdFxGL3Y0amXcXUGjhgw4zGsvNXoPqEuucxJsEzRSVK5TY2Od9Ag+OLJaJtuMDo7nASqu+SJyzAz6YAlUkm4xODOnDskbVacegAYkxkVWnxyKU4II4ktq/B0CrRIRdFjSbVo2jYDPUiOWsplc0ALm6ANYskXmmCYoWpn8Lk1HaqXAGnpZJVfEo/o20vbguPb0/Cdb2hh0gDV8E5OBg8G1R4rwW6nv/GQw+KTP4KbLq4849zLg7aP2ZVitVkcvwuP9Pa9keF3P4QNa42Uwbr3bvZChrOfxFekr6f5Jml6hxpg/vTdip0OY3B8/SrQ6KlHZ0SUGyhA/upi+icXoMXz+5R/wFrnTUJpVyta8dqjWsGiPIuRS5BNsXS2JXSCvQ0mI5yn5mnlMi+DHkofPv/zTwztcUZeTrhS5MhhM67mSOVy1I5jBYAIv4hCrN5aJo6Wca2offMkplag152DTbiX13RAu9Dp2z7E9jslA63HfnhvxvWvD7WHOPYrYl5W7M4c7iyLp96iW6Ntp3BwBhSSaG0pn6kU6rW9M45zDgrqej6nDI98uhADbLLeNHzUYO3OwMKlxWgN3CD72btODLfFLba1xZEXTORamHSKgFtZIHfwEhONF2OnPdokeZ4Vx+HC0lCDkHRxZo6YLSbqJjcfd6vATVYWD+rb/3jos0NGB0e1dXKxs0ummTUugbP0taU0shl4tnkeSFQc5qdD+5VBPJDzoKv++uES3lDk2xf4LN3oUhUcsY0rmqH2/8l68mr6F5bPhmGU91vANl3v09s2Ll+8uX5Ix9JAmwJ4Mx8MxLVnjQ8V176SDofVhbdvsKOb/64y74U40WRlZxWVkrs3AIrHOG9YjNZP+ePs2Y6XxgUQ2G3oErp3abmn55zoSipvbjC25k8RhIjVtpgCiIyJfhPvRh3ZgDN83KT/pUMsQNdHDOLFJ7OgO1wcj++3tNmtpIlmcJF4ku86uSM9Ow1HXQTw37bjIc7ThQdk+zZ9eX7GMzZvxexUn+czxFY3++SoZm6aJkQDHtQ1TXC9qviDZpHKbhjrlPiu+i6y4+UFOnYRjny4nL+gv+XRyw2aTGPd228mnT1/c0eDaSlNsbrfb7b8BOQ9Ukg==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,g={},b=[];function P(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(p(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.b5f1e6c1.js b/assets/js/da66eb9c.b5f1e6c1.js new file mode 100644 index 000000000..6a6964b78 --- /dev/null +++ b/assets/js/da66eb9c.b5f1e6c1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>w,contentTitle:()=>v,default:()=>y,frontMatter:()=>f,metadata:()=>o,toc:()=>b});const o=JSON.parse('{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/v1.1/update-document.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-document","permalink":"/docs/API-docs/v1.1/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWd1uG7sRfpUpb5oIa0lJnFNUV3VzgiRomgixjQB1DIFazmp5zCV5SK5kQRBwLvoGveptHy1PUgy5u1r9xEl6DlqgN4bNnRnOfDOcP29Y4AvPJjfsR5PXFerg2W3GBPrcSRuk0WzCrkqEayt4QGip4GL6BrhSZuWh9ug8BAOVEbJYA9cC6kQeSgSBgUvlwRTAwVvMZSFzEI2gIbwzkZAHCKX0UbDRat1KD6YVxqHAFVjueIUBnc9gbWrIudYmQF5yvUgXFlIhGJ0jyJA0aJWWHnKHPKAYsowZi46TiW8Em7B0SWsfy9juIja52TDNK2QT1sqaScEyJgkey0PJDjF78yMZvHd7tFEjimjUHBu7SI7Dn2vpULBJcDVmzIe1otu8rKxCljG8t8oIZJOCK08EeYkVZ5MNC2sbKYOTesEyVhhX8bA72W5vk3z04c9GrIlnX9WpM0spEOaoTA/fHvIBK6t4QA+PeACF3AcwGnu0rQGPWcZyowNBONkwbq2SeQR59JOn2zbHqpv5T5hHxB25JEj09DUB/nUDCRweYZowH3/pIGfbjGkTvlvMlExEcLiUuIrx7OVCp/jsy97D8fuu6KKiL2NLPEqgo4g8lrfjJkrUfK7w/dW0Rzo3RiHXR9FIUQVnyQATD2EllYIkA95fTWGJjh5m9NUQruObjjQOc5RLen59EsiNQFhKDlhxqTJYlTIvKeDXUNU+AOomhhrosPfkYxDDGRwrJKQ/qVGW0oHUi126ORIMQjrMg1rDSobS1AG4EJLYuQIf0PphH8WoRQfklandr0eSw6KWAgUEUzsojItaxmRl4zMjC6T2wdU5MXsQNXk32kGk9Lt1Jkfvdzi1qBBRT34GqH1i51BwH9BlUGtJyLvaBhSdSLy36CTqHE9CEMGdxfzdAO6/HYspukoG31pKruFCACqM9QR8nZfA03ceaoc+A6llkFz5DHzglfUZGAcB7ymvQDCWkifeSx9I+ZUUCwwe5Jfi6APSG8l7OhTOVNH7hI1e9wOh0yuYA3FX5FTpm6pV8FoFWHJVn8bMYQq3We3Uqde6j9VlKnyYpF9/eAurEh12fkeX4mhOaScJRiqj8aXRxaGNki7aD8PlKEPwOpiZw0pqgd8S25cYIijk1mC6kK6DqXiQObSi/BAa0uSAYPoRWsGjFrw5lnwpjXv8BQBJ3Iwq9UzqGS7RrXta6rqaoztS8l08pvgQfO1hjmGFqPu6tW5MXUSqQKTbqkQNe5gQld8Zvafl8+02Y0GGvWw965X/2Zyq6Xa7jaZ4a7RPhevpeHxcZLvGqSn69CrIa0Wt1Pp3v13VTMdfqx/ci6ev/fT8taU4aVS6CA8zPR0/fXb2ZHw2/sPVkx8m53+cPP9hOB6P/8Yydl+pXclmJI310Yt/9w6kVlLjrEVt9nQ8nj1roDw/hV5TkG3TqSy5kgIKiUoA3el/QwDROeP+w4bhAf0eMp9Mbo0/fyB0qM8tTK3F/9rcUxo9bOD57Lwz8fmxiW90goya/ytzh/q/YeHOnv71IV1Pqu5HtUxE8TvbM7Z/noz0mNdOhnWcHO7PuJVn6fvk5pb68QpDaWjqsHUaNULJJmzUZpfRppdntozkuWU7iBzk7BVfLNC9rudR+4s6GPirye+SibE0sTIE6yej0VK6kCQNfWIr6/kwN9Vo6jglond8ecfdyFjUoyfD8XDMttnmQIjnWszN/ZCIqAIpPvdRBrdytHwyfHKCh1v7XfRYn30viw98IfXia3y3O99cUvykENnzUBco3Mq/4JplbQD0qZrRr0ROpZVcTmH5YTdmvWyDq4ufw9mkHU2+bdo4LIMn54f++MDY3ojQzI39Xrc5Otn7Nd/2exwSedBTdHSnSvnzLcFUmIhp81reW9SXZB5Fa/TJoWUfUeWmwrY9Gwxals9//1fHNRh00KSJ5ZP+pN/XDqxZoStqFXEsFN5LKv3EhlX85uPWgMYH5JVC79UaqGNeOJp0hVzIQNNC01vl3PK5VJKSCZEZ4nbQy0d+CB9LDCU6+vR7RzOAwCUqykFd86QXu75tZdxdQbuNDDjMay81eg+oS65zImwDNPbEXKdJyjrpEXxwpLVMuhkdHM8DVFzzRWxqM+iDJVBJShvgzJxGMm9UnYYO2sgYF8eIZFBcS0QQX9KmwSHQKXWeDkt6Tctm8vBZmvxSNJMJWsAcfQBLusgc08pGK5PfpXVMrRRYQ6lcckWNW19HYg+Oa0/1JunS+qADrGlwMSk4GFx7JA+/lfrOTwaDT/oMbrq4+ohzLwPePmozw2q1OsoIj/d5XslACfQDWuNlMG69417I0CbJvpDujyTpFWqM8dPLETsZwuT+OCnR6ahEZUeXGChC/Ohi+iZWv8fw+Zd/wFvkTkNpVila89qhWsOivYqQS55PsHXFK46dvA4lIZ6n4GsWQC2CH0sePv/yTw/vcEVjVXpSZMpgMK3nSuZw1e58BoMJvIhbs94eKO6ycq5pXvElp1CiXQAHm7iV1HdDuNDrOK7HeTwGA51Hvj0zYr5r3e1hzj2KOAiWuzuHO43ilOFRLdG36785AgpJfXUonakX6ba+Mo1xDgsasz6mkZJsuxACbHPcTpo00ezUwcKkSW0N3CH4OCxOD1jil9pa40iLZlQtTLu1QC2skTr4CQjHi7CTn+0CPS4n47bj6ChByDs4skZM55L0EhuLu9PhJ6oKB/VtP986LNDRhdHsnV+sbMLppg1LoGj9NWFNbRNlLZ7Hri5ujlKh/dOhnNhhoav8++IS3VLm2BT7L7zoUSQesYwpmaP2/cp78Wr6FpbPhuO9jugbHvfo7ZsXL99dviRlKJEmwNrOiFnjQ8V176aDLflhbdvsetr/16V60zvRKmdkFZexVW42JKnNvWG9pmbS36ffZqw0PhDJZkNJ4Nqp7ZaOf65jQ3Fzm7Eld5J6mNQLp7WD6BqRL8L96EO7oYbvW82fNKjtEDW1h3FFlLqjO1wf/I9ge7vN2jaRNE4UL5JeZ1ckZyfhaMyhPjdxXOQ52vAgbX+umF5fsYzNm31/Ff91wBxf0f8a+Copm9aXsQGOZxumuF7UfEG0SeQ2bZHK/a74LnbFzS9k1Ek49tvlZAX9JJtOMmw2qePebjv69OmLHA2uLTX55na73f4bPEx8PQ==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"}}');var i=n(74848),a=n(28453),s=n(33617),d=n.n(s),p=n(17543),r=n.n(p),l=n(86013),c=n.n(l),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const f={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWd1uG7sRfpUpb5oIa0lJnFNUV3VzgiRomgixjQB1DIFazmp5zCV5SK5kQRBwLvoGveptHy1PUgy5u1r9xEl6DlqgN4bNnRnOfDOcP29Y4AvPJjfsR5PXFerg2W3GBPrcSRuk0WzCrkqEayt4QGip4GL6BrhSZuWh9ug8BAOVEbJYA9cC6kQeSgSBgUvlwRTAwVvMZSFzEI2gIbwzkZAHCKX0UbDRat1KD6YVxqHAFVjueIUBnc9gbWrIudYmQF5yvUgXFlIhGJ0jyJA0aJWWHnKHPKAYsowZi46TiW8Em7B0SWsfy9juIja52TDNK2QT1sqaScEyJgkey0PJDjF78yMZvHd7tFEjimjUHBu7SI7Dn2vpULBJcDVmzIe1otu8rKxCljG8t8oIZJOCK08EeYkVZ5MNC2sbKYOTesEyVhhX8bA72W5vk3z04c9GrIlnX9WpM0spEOaoTA/fHvIBK6t4QA+PeACF3AcwGnu0rQGPWcZyowNBONkwbq2SeQR59JOn2zbHqpv5T5hHxB25JEj09DUB/nUDCRweYZowH3/pIGfbjGkTvlvMlExEcLiUuIrx7OVCp/jsy97D8fuu6KKiL2NLPEqgo4g8lrfjJkrUfK7w/dW0Rzo3RiHXR9FIUQVnyQATD2EllYIkA95fTWGJjh5m9NUQruObjjQOc5RLen59EsiNQFhKDlhxqTJYlTIvKeDXUNU+AOomhhrosPfkYxDDGRwrJKQ/qVGW0oHUi126ORIMQjrMg1rDSobS1AG4EJLYuQIf0PphH8WoRQfklandr0eSw6KWAgUEUzsojItaxmRl4zMjC6T2wdU5MXsQNXk32kGk9Lt1Jkfvdzi1qBBRT34GqH1i51BwH9BlUGtJyLvaBhSdSLy36CTqHE9CEMGdxfzdAO6/HYspukoG31pKruFCACqM9QR8nZfA03ceaoc+A6llkFz5DHzglfUZGAcB7ymvQDCWkifeSx9I+ZUUCwwe5Jfi6APSG8l7OhTOVNH7hI1e9wOh0yuYA3FX5FTpm6pV8FoFWHJVn8bMYQq3We3Uqde6j9VlKnyYpF9/eAurEh12fkeX4mhOaScJRiqj8aXRxaGNki7aD8PlKEPwOpiZw0pqgd8S25cYIijk1mC6kK6DqXiQObSi/BAa0uSAYPoRWsGjFrw5lnwpjXv8BQBJ3Iwq9UzqGS7RrXta6rqaoztS8l08pvgQfO1hjmGFqPu6tW5MXUSqQKTbqkQNe5gQld8Zvafl8+02Y0GGvWw965X/2Zyq6Xa7jaZ4a7RPhevpeHxcZLvGqSn69CrIa0Wt1Pp3v13VTMdfqx/ci6ev/fT8taU4aVS6CA8zPR0/fXb2ZHw2/sPVkx8m53+cPP9hOB6P/8Yydl+pXclmJI310Yt/9w6kVlLjrEVt9nQ8nj1roDw/hV5TkG3TqSy5kgIKiUoA3el/QwDROeP+w4bhAf0eMp9Mbo0/fyB0qM8tTK3F/9rcUxo9bOD57Lwz8fmxiW90goya/ytzh/q/YeHOnv71IV1Pqu5HtUxE8TvbM7Z/noz0mNdOhnWcHO7PuJVn6fvk5pb68QpDaWjqsHUaNULJJmzUZpfRppdntozkuWU7iBzk7BVfLNC9rudR+4s6GPirye+SibE0sTIE6yej0VK6kCQNfWIr6/kwN9Vo6jglond8ecfdyFjUoyfD8XDMttnmQIjnWszN/ZCIqAIpPvdRBrdytHwyfHKCh1v7XfRYn30viw98IfXia3y3O99cUvykENnzUBco3Mq/4JplbQD0qZrRr0ROpZVcTmH5YTdmvWyDq4ufw9mkHU2+bdo4LIMn54f++MDY3ojQzI39Xrc5Otn7Nd/2exwSedBTdHSnSvnzLcFUmIhp81reW9SXZB5Fa/TJoWUfUeWmwrY9Gwxals9//1fHNRh00KSJ5ZP+pN/XDqxZoStqFXEsFN5LKv3EhlX85uPWgMYH5JVC79UaqGNeOJp0hVzIQNNC01vl3PK5VJKSCZEZ4nbQy0d+CB9LDCU6+vR7RzOAwCUqykFd86QXu75tZdxdQbuNDDjMay81eg+oS65zImwDNPbEXKdJyjrpEXxwpLVMuhkdHM8DVFzzRWxqM+iDJVBJShvgzJxGMm9UnYYO2sgYF8eIZFBcS0QQX9KmwSHQKXWeDkt6Tctm8vBZmvxSNJMJWsAcfQBLusgc08pGK5PfpXVMrRRYQ6lcckWNW19HYg+Oa0/1JunS+qADrGlwMSk4GFx7JA+/lfrOTwaDT/oMbrq4+ohzLwPePmozw2q1OsoIj/d5XslACfQDWuNlMG69417I0CbJvpDujyTpFWqM8dPLETsZwuT+OCnR6ahEZUeXGChC/Ohi+iZWv8fw+Zd/wFvkTkNpVila89qhWsOivYqQS55PsHXFK46dvA4lIZ6n4GsWQC2CH0sePv/yTw/vcEVjVXpSZMpgMK3nSuZw1e58BoMJvIhbs94eKO6ycq5pXvElp1CiXQAHm7iV1HdDuNDrOK7HeTwGA51Hvj0zYr5r3e1hzj2KOAiWuzuHO43ilOFRLdG36785AgpJfXUonakX6ba+Mo1xDgsasz6mkZJsuxACbHPcTpo00ezUwcKkSW0N3CH4OCxOD1jil9pa40iLZlQtTLu1QC2skTr4CQjHi7CTn+0CPS4n47bj6ChByDs4skZM55L0EhuLu9PhJ6oKB/VtP986LNDRhdHsnV+sbMLppg1LoGj9NWFNbRNlLZ7Hri5ujlKh/dOhnNhhoav8++IS3VLm2BT7L7zoUSQesYwpmaP2/cp78Wr6FpbPhuO9jugbHvfo7ZsXL99dviRlKJEmwNrOiFnjQ8V176aDLflhbdvsetr/16V60zvRKmdkFZexVW42JKnNvWG9pmbS36ffZqw0PhDJZkNJ4Nqp7ZaOf65jQ3Fzm7Eld5J6mNQLp7WD6BqRL8L96EO7oYbvW82fNKjtEDW1h3FFlLqjO1wf/I9ge7vN2jaRNE4UL5JeZ1ckZyfhaMyhPjdxXOQ52vAgbX+umF5fsYzNm31/Ff91wBxf0f8a+Copm9aXsQGOZxumuF7UfEG0SeQ2bZHK/a74LnbFzS9k1Ek49tvlZAX9JJtOMmw2qePebjv69OmLHA2uLTX55na73f4bPEx8PQ==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,w={},b=[];function j(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.33f9e400.js b/assets/js/runtime~main.5763f3b8.js similarity index 88% rename from assets/js/runtime~main.33f9e400.js rename to assets/js/runtime~main.5763f3b8.js index fbdc8f603..badfd43c8 100644 --- a/assets/js/runtime~main.33f9e400.js +++ b/assets/js/runtime~main.5763f3b8.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",225:"0a7196e9",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9260:"96f83544",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9429:"fa501e35",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"04d03f97",89:"67599f09",108:"b9723cd9",157:"77f58424",225:"5354ae5c",285:"d15a44d4",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2b2a535c",849:"f83c3b52",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"e44b2367",1665:"6005cc6b",1679:"27742ef4",1688:"2582d322",1706:"33c9f705",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"4a1b8c9b",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"717af639",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"a2cfa06b",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"9fd48efe",3460:"827e01c6",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3724:"8970445f",3795:"fdb1ace5",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"804e9e11",4240:"98c04a72",4372:"b75be620",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"cf9a081c",4865:"4a732e7a",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"3f44a353",5373:"60be571e",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"4dd81245",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"9f2d8c5b",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"67affa68",6235:"5aa106b8",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"163938f2",7054:"cab4fa5c",7068:"33303148",7075:"8d0aa3f2",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"8aab2983",7910:"5b11649a",7960:"102fca2b",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"7015e218",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"7661f930",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"bc214206",8901:"e05f6301",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"1002d232",9099:"c4b4350f",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9260:"f79cb59e",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"4db3ade4",9426:"4597631d",9429:"5d7507de",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","0a7196e9":"225","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241","96f83544":"9260",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426",fa501e35:"9429","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",225:"0a7196e9",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9260:"96f83544",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9429:"fa501e35",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"5cd13f3b",89:"67599f09",108:"b9723cd9",157:"77f58424",225:"5354ae5c",285:"77dde85a",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2b2a535c",849:"f83c3b52",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"e69f4137",1665:"53514c64",1679:"a3f62faa",1688:"2582d322",1706:"781d6d29",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"403772ac",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"b5f1e6c1",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"2025796d",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"07e3d435",3460:"c87a9aec",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3724:"8970445f",3795:"55ff1e1b",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"1c2422fe",4240:"139b2f10",4372:"1bbc46c2",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"037506c8",4865:"3dea52d8",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"db88685e",5373:"ebd704b1",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"4dd81245",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"4abe84c3",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"78cbdeaf",6235:"6f5015ca",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"740e393e",7054:"cab4fa5c",7068:"33303148",7075:"7e5f8810",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"7c000e5d",7910:"5b11649a",7960:"57077b26",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"7015e218",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"cb327dba",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"d3620018",8901:"e05f6301",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"9876c768",9099:"5dc12157",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9260:"f79cb59e",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"3b3ff2a4",9426:"4597631d",9429:"5d7507de",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","0a7196e9":"225","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241","96f83544":"9260",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426",fa501e35:"9429","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index 33e14a79b..3d363b9bc 100644 --- a/blog/authors/index.html +++ b/blog/authors/index.html @@ -5,7 +5,7 @@ Authors | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 0f8a5c51a..ff75e80c5 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 5f02a5893..8112b2f89 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 a2ea2828e..8b912c628 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 b55135980..30bdde2a3 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 55cb2b2a8..51782ad9d 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 31d752803..a5b453a09 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 715aaa73f..a3225e91c 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 c674b3753..304295b08 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 b10bcdc41..97818c050 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 c158869a6..2597dc363 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/api-intro/index.html b/docs/API-docs/api-intro/index.html index 735b4b49d..0328cc1ae 100644 --- a/docs/API-docs/api-intro/index.html +++ b/docs/API-docs/api-intro/index.html @@ -5,7 +5,7 @@ OpenSign APIs | OpenSign™ - + diff --git a/docs/API-docs/v1.1/contactlist/index.html b/docs/API-docs/v1.1/contactlist/index.html index 603597ee4..12a806c71 100644 --- a/docs/API-docs/v1.1/contactlist/index.html +++ b/docs/API-docs/v1.1/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createcontact/index.html b/docs/API-docs/v1.1/createcontact/index.html index c98d92dd5..7901aa5c3 100644 --- a/docs/API-docs/v1.1/createcontact/index.html +++ b/docs/API-docs/v1.1/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createdocument/index.html b/docs/API-docs/v1.1/createdocument/index.html index be3e02a6d..8f4e205d1 100644 --- a/docs/API-docs/v1.1/createdocument/index.html +++ b/docs/API-docs/v1.1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -16,6 +16,7 @@

Supported Widgets:

Below are the common parameters that are required with all widgets:

    +
  • name: Unique identifier for this widget.
  • type: Indicates the type of widget.
  • page: Specifies the page number on which you want to place the respective widget.
  • 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.
    • @@ -120,6 +121,16 @@
  • image
    • {
      "type": "image",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
        "required": true,
        "name": "image"
      }
    }
    +
      +
    1. number
      2. +
    +
    {
      "type": "number",
      "page": 1,
      "x": 107,
      "y": 528,
      "w": 60,
      "h": 21,
      "options": {
        "name": "number",
        "required": true,
        "readonly": false,
        "default": 0,
        "hint": "Enter number",
        "formula": ""
        "color": "black",
        "fontsize": 12
      }
    }
    +
      +
    • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
      • +
    • default: Provide a default number (Optional).
      • +
    • hint: Provide a hint for the number (Optional).
      • +
    • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
      • +

    Prefill Widgets: Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.

    Note: Responses for prefill widgets are required.

    List of widgets supported in Prefill

    diff --git a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html index 0bc50d6a4..cdbc37d00 100644 --- a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + @@ -52,6 +52,10 @@
  • radio button
    • {
      "name": "radio",
      "readonly": false,
      "default": "option1"
    }
    +
      +
    1. number
      2. +
    +
    {
      "name": "number",
      "readonly": false,
      "default": 0,
      "formula": ""
    }

    Prefill Widgets: Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.

    response: Provide the value that should replace the existing response.

    List of widgets supported in Prefill

    diff --git a/docs/API-docs/v1.1/createfolder/index.html b/docs/API-docs/v1.1/createfolder/index.html index 9ba4cf33c..2d791d50a 100644 --- a/docs/API-docs/v1.1/createfolder/index.html +++ b/docs/API-docs/v1.1/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createtemplate/index.html b/docs/API-docs/v1.1/createtemplate/index.html index 5563a59fe..c2ce6dca4 100644 --- a/docs/API-docs/v1.1/createtemplate/index.html +++ b/docs/API-docs/v1.1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -16,6 +16,7 @@

    Supported Widgets:

    Below are the common parameters that are required with all widgets:

      +
    • name: Unique identifier for this widget.
    • type: Indicates the type of widget.
    • page: Specifies the page number on which you want to place the respective widget.
    • 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.
      • @@ -120,6 +121,16 @@
    • image
      • {
        "type": "image",
        "page": 1,
        "x": 327,
        "y": 628,
        "w": 114,
        "h": 21,
        "options": {
          "required": true,
          "name": "image"
        }
      }
      +
        +
      1. number
        2. +
      +
      {
        "type": "number",
        "page": 1,
        "x": 107,
        "y": 528,
        "w": 60,
        "h": 21,
        "options": {
          "name": "number",
          "required": true,
          "readonly": false,
          "default": 0,
          "hint": "Enter number",
          "formula": ""
          "color": "black",
          "fontsize": 12
        }
      }
      +
        +
      • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
        • +
      • default: Provide a default number (Optional).
        • +
      • hint: Provide a hint for the number (Optional).
        • +
      • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
        • +

      Prefill Widgets: Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.

      Note: Responses for prefill widgets are required.

      List of widgets supported in Prefill

      diff --git a/docs/API-docs/v1.1/delete-template/index.html b/docs/API-docs/v1.1/delete-template/index.html index 82fb6335a..1167b7215 100644 --- a/docs/API-docs/v1.1/delete-template/index.html +++ b/docs/API-docs/v1.1/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/delete-webhook/index.html b/docs/API-docs/v1.1/delete-webhook/index.html index 090248a5a..15feb5a8e 100644 --- a/docs/API-docs/v1.1/delete-webhook/index.html +++ b/docs/API-docs/v1.1/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletecontact/index.html b/docs/API-docs/v1.1/deletecontact/index.html index c3ea426dc..429c976c4 100644 --- a/docs/API-docs/v1.1/deletecontact/index.html +++ b/docs/API-docs/v1.1/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletedocument/index.html b/docs/API-docs/v1.1/deletedocument/index.html index ced267514..9aef6145d 100644 --- a/docs/API-docs/v1.1/deletedocument/index.html +++ b/docs/API-docs/v1.1/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletefolder/index.html b/docs/API-docs/v1.1/deletefolder/index.html index b44eef8b6..20a58e16c 100644 --- a/docs/API-docs/v1.1/deletefolder/index.html +++ b/docs/API-docs/v1.1/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/draftdocument/index.html b/docs/API-docs/v1.1/draftdocument/index.html index a1689ca35..42606127c 100644 --- a/docs/API-docs/v1.1/draftdocument/index.html +++ b/docs/API-docs/v1.1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + @@ -16,6 +16,7 @@

      Supported Widgets:

      Below are the common parameters that are required with all widgets:

        +
      • name: Unique identifier for this widget.
      • type: Indicates the type of widget.
      • page: Specifies the page number on which you want to place the respective widget.
      • 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.
        • @@ -120,6 +121,16 @@
      • image
        • {
          "type": "image",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
            "required": true,
            "name": "image"
          }
        }
        +
          +
        1. number
          2. +
        +
        {
          "type": "number",
          "page": 1,
          "x": 107,
          "y": 528,
          "w": 60,
          "h": 21,
          "options": {
            "name": "number",
            "required": true,
            "readonly": false,
            "default": 0,
            "hint": "Enter number",
            "formula": ""
            "color": "black",
            "fontsize": 12
          }
        }
        +
          +
        • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
          • +
        • default: Provide a default number (Optional).
          • +
        • hint: Provide a hint for the number (Optional).
          • +
        • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
          • +

        Prefill Widgets: Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.

        Note: Responses for prefill widgets are required.

        List of widgets supported in Prefill

        diff --git a/docs/API-docs/v1.1/drafttemplate/index.html b/docs/API-docs/v1.1/drafttemplate/index.html index 82c60c7c8..e10312a56 100644 --- a/docs/API-docs/v1.1/drafttemplate/index.html +++ b/docs/API-docs/v1.1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -18,6 +18,7 @@

        Supported Widgets:

        Below are the common parameters that are required with all widgets:

          +
        • name: Unique identifier for this widget.
        • type: Indicates the type of widget.
        • page: Specifies the page number on which you want to place the respective widget.
        • 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.
          • @@ -122,6 +123,16 @@
        • image
          • {
            "type": "image",
            "page": 1,
            "x": 327,
            "y": 628,
            "w": 114,
            "h": 21,
            "options": {
              "required": true,
              "name": "image"
            }
          }
          +
            +
          1. number
            2. +
          +
          {
            "type": "number",
            "page": 1,
            "x": 107,
            "y": 528,
            "w": 60,
            "h": 21,
            "options": {
              "name": "number",
              "required": true,
              "readonly": false,
              "default": 0,
              "hint": "Enter number",
              "formula": ""
              "color": "black",
              "fontsize": 12
            }
          }
          +
            +
          • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
            • +
          • default: Provide a default number (Optional).
            • +
          • hint: Provide a hint for the number (Optional).
            • +
          • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
            • +

          Prefill Widgets: Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.

          Note: Responses for prefill widgets are required.

          List of widgets supported in Prefill

          diff --git a/docs/API-docs/v1.1/folderlist/index.html b/docs/API-docs/v1.1/folderlist/index.html index 718d3491e..9dca4dae4 100644 --- a/docs/API-docs/v1.1/folderlist/index.html +++ b/docs/API-docs/v1.1/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-template/index.html b/docs/API-docs/v1.1/get-template/index.html index 8582215b6..edb30a03f 100644 --- a/docs/API-docs/v1.1/get-template/index.html +++ b/docs/API-docs/v1.1/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-user/index.html b/docs/API-docs/v1.1/get-user/index.html index 4c03a956e..d223a6de4 100644 --- a/docs/API-docs/v1.1/get-user/index.html +++ b/docs/API-docs/v1.1/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-webhook/index.html b/docs/API-docs/v1.1/get-webhook/index.html index f67115401..1f9903585 100644 --- a/docs/API-docs/v1.1/get-webhook/index.html +++ b/docs/API-docs/v1.1/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getcontact/index.html b/docs/API-docs/v1.1/getcontact/index.html index 7e8e84096..4297a2a91 100644 --- a/docs/API-docs/v1.1/getcontact/index.html +++ b/docs/API-docs/v1.1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getcredits/index.html b/docs/API-docs/v1.1/getcredits/index.html index 45e000f09..59d0d9738 100644 --- a/docs/API-docs/v1.1/getcredits/index.html +++ b/docs/API-docs/v1.1/getcredits/index.html @@ -5,7 +5,7 @@ Get your API credits | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocument/index.html b/docs/API-docs/v1.1/getdocument/index.html index 8b1b68b84..adf300b93 100644 --- a/docs/API-docs/v1.1/getdocument/index.html +++ b/docs/API-docs/v1.1/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocumentlist/index.html b/docs/API-docs/v1.1/getdocumentlist/index.html index 558732bec..7e0636e03 100644 --- a/docs/API-docs/v1.1/getdocumentlist/index.html +++ b/docs/API-docs/v1.1/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getfolder/index.html b/docs/API-docs/v1.1/getfolder/index.html index 9995125c3..58cca819a 100644 --- a/docs/API-docs/v1.1/getfolder/index.html +++ b/docs/API-docs/v1.1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/gettemplatelist/index.html b/docs/API-docs/v1.1/gettemplatelist/index.html index 6ff8a5abf..acedefeab 100644 --- a/docs/API-docs/v1.1/gettemplatelist/index.html +++ b/docs/API-docs/v1.1/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/index.html b/docs/API-docs/v1.1/index.html index 17420a1fa..cc790f24d 100644 --- a/docs/API-docs/v1.1/index.html +++ b/docs/API-docs/v1.1/index.html @@ -5,7 +5,7 @@ OpenSign API v1.1 | OpenSign™ - + diff --git a/docs/API-docs/v1.1/intro/index.html b/docs/API-docs/v1.1/intro/index.html index c6242419b..38dc371b3 100644 --- a/docs/API-docs/v1.1/intro/index.html +++ b/docs/API-docs/v1.1/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html index 5b38a7fed..cbb2a6749 100644 --- a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html +++ b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1.1 | OpenSign™ - + diff --git a/docs/API-docs/v1.1/publictemplate/index.html b/docs/API-docs/v1.1/publictemplate/index.html index f03deb003..b94de3cbd 100644 --- a/docs/API-docs/v1.1/publictemplate/index.html +++ b/docs/API-docs/v1.1/publictemplate/index.html @@ -5,7 +5,7 @@ Public Template | OpenSign™ - + @@ -16,6 +16,7 @@

          Supported Widgets:

          Below are the common parameters that are required with all widgets:

            +
          • name: Unique identifier for this widget.
          • type: Indicates the type of widget.
          • page: Specifies the page number on which you want to place the respective widget.
          • 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.
            • @@ -120,6 +121,16 @@
          • image
            • {
              "type": "image",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
                "required": true,
                "name": "image"
              }
            }
            +
              +
            1. number
              2. +
            +
            {
              "type": "number",
              "page": 1,
              "x": 107,
              "y": 528,
              "w": 60,
              "h": 21,
              "options": {
                "name": "number",
                "required": true,
                "readonly": false,
                "default": 0,
                "hint": "Enter number",
                "formula": ""
                "color": "black",
                "fontsize": 12
              }
            }
            +
              +
            • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
              • +
            • default: Provide a default number (Optional).
              • +
            • hint: Provide a hint for the number (Optional).
              • +
            • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
              • +

            Prefill Widgets: Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.

            Note: Responses for prefill widgets are required.

            List of widgets supported in Prefill

            diff --git a/docs/API-docs/v1.1/resendrequestmail/index.html b/docs/API-docs/v1.1/resendrequestmail/index.html index 491ce2fa1..39ea9f8ff 100644 --- a/docs/API-docs/v1.1/resendrequestmail/index.html +++ b/docs/API-docs/v1.1/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1.1/revokedocument/index.html b/docs/API-docs/v1.1/revokedocument/index.html index 0c1232b48..f79e021f5 100644 --- a/docs/API-docs/v1.1/revokedocument/index.html +++ b/docs/API-docs/v1.1/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/save-update-webhook/index.html b/docs/API-docs/v1.1/save-update-webhook/index.html index d284ae4e7..a5b6a0f63 100644 --- a/docs/API-docs/v1.1/save-update-webhook/index.html +++ b/docs/API-docs/v1.1/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/selfsign/index.html b/docs/API-docs/v1.1/selfsign/index.html index d74d0316f..504720f43 100644 --- a/docs/API-docs/v1.1/selfsign/index.html +++ b/docs/API-docs/v1.1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + @@ -16,6 +16,7 @@

            Supported Widgets:

            Below are the common parameters that are required with all widgets:

              +
            • name: Unique identifier for this widget.
            • type: Indicates the type of widget.
            • page: Specifies the page number on which you want to place the respective widget.
            • 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.
              • @@ -102,6 +103,16 @@
            • image
              • {
                "type": "image",
                "page": 1,
                "x": 327,
                "y": 628,
                "w": 114,
                "h": 21,
                "options": {
                  "required": true,
                  "name": "image"
                }
              }
              +
                +
              1. number
                2. +
              +
              {
                "type": "number",
                "page": 1,
                "x": 107,
                "y": 528,
                "w": 60,
                "h": 21,
                "options": {
                  "name": "number",
                  "required": true,
                  "readonly": false,
                  "default": 0,
                  "hint": "Enter number",
                  "formula": ""
                  "color": "black",
                  "fontsize": 12
                }
              }
              +
                +
              • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
                • +
              • default: Provide a default number (Optional).
                • +
              • hint: Provide a hint for the number (Optional).
                • +
              • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
                • +

              Request​

              diff --git a/docs/API-docs/v1.1/update-document/index.html b/docs/API-docs/v1.1/update-document/index.html index 885a6a9cb..30a2e3643 100644 --- a/docs/API-docs/v1.1/update-document/index.html +++ b/docs/API-docs/v1.1/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/update-template/index.html b/docs/API-docs/v1.1/update-template/index.html index 4894ba893..658b05bf7 100644 --- a/docs/API-docs/v1.1/update-template/index.html +++ b/docs/API-docs/v1.1/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/updatefolder/index.html b/docs/API-docs/v1.1/updatefolder/index.html index 452299092..d163a203d 100644 --- a/docs/API-docs/v1.1/updatefolder/index.html +++ b/docs/API-docs/v1.1/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/contactlist/index.html b/docs/API-docs/v1/contactlist/index.html index cd967f0bb..475a3ebe9 100644 --- a/docs/API-docs/v1/contactlist/index.html +++ b/docs/API-docs/v1/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1/createcontact/index.html b/docs/API-docs/v1/createcontact/index.html index 0dfcf3589..348f4564c 100644 --- a/docs/API-docs/v1/createcontact/index.html +++ b/docs/API-docs/v1/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/createdocument/index.html b/docs/API-docs/v1/createdocument/index.html index 8c24b37fc..cb6e6148d 100644 --- a/docs/API-docs/v1/createdocument/index.html +++ b/docs/API-docs/v1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/v1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1/createdocumentwithtemplateid/index.html index d0244c96a..53f9fc9d1 100644 --- a/docs/API-docs/v1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/v1/createfolder/index.html b/docs/API-docs/v1/createfolder/index.html index ed3f6e88f..67570ad60 100644 --- a/docs/API-docs/v1/createfolder/index.html +++ b/docs/API-docs/v1/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/createtemplate/index.html b/docs/API-docs/v1/createtemplate/index.html index 30d0637db..f191b5a24 100644 --- a/docs/API-docs/v1/createtemplate/index.html +++ b/docs/API-docs/v1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/v1/delete-template/index.html b/docs/API-docs/v1/delete-template/index.html index 2691b984e..3e6e92252 100644 --- a/docs/API-docs/v1/delete-template/index.html +++ b/docs/API-docs/v1/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1/delete-webhook/index.html b/docs/API-docs/v1/delete-webhook/index.html index aff25756d..923ede2c9 100644 --- a/docs/API-docs/v1/delete-webhook/index.html +++ b/docs/API-docs/v1/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/deletecontact/index.html b/docs/API-docs/v1/deletecontact/index.html index 07035a83f..0256c5e4f 100644 --- a/docs/API-docs/v1/deletecontact/index.html +++ b/docs/API-docs/v1/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/deletedocument/index.html b/docs/API-docs/v1/deletedocument/index.html index ae0a237b0..e93f63fe4 100644 --- a/docs/API-docs/v1/deletedocument/index.html +++ b/docs/API-docs/v1/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1/deletefolder/index.html b/docs/API-docs/v1/deletefolder/index.html index b14315023..ed03f67f3 100644 --- a/docs/API-docs/v1/deletefolder/index.html +++ b/docs/API-docs/v1/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/draftdocument/index.html b/docs/API-docs/v1/draftdocument/index.html index f9e17b220..d11fedf89 100644 --- a/docs/API-docs/v1/draftdocument/index.html +++ b/docs/API-docs/v1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/v1/drafttemplate/index.html b/docs/API-docs/v1/drafttemplate/index.html index f34544394..473dcdc64 100644 --- a/docs/API-docs/v1/drafttemplate/index.html +++ b/docs/API-docs/v1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/v1/folderlist/index.html b/docs/API-docs/v1/folderlist/index.html index 27be0621f..9c1267cad 100644 --- a/docs/API-docs/v1/folderlist/index.html +++ b/docs/API-docs/v1/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1/get-template/index.html b/docs/API-docs/v1/get-template/index.html index 4b45828fb..e054758fc 100644 --- a/docs/API-docs/v1/get-template/index.html +++ b/docs/API-docs/v1/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1/get-user/index.html b/docs/API-docs/v1/get-user/index.html index da2a95ee0..49bef67ac 100644 --- a/docs/API-docs/v1/get-user/index.html +++ b/docs/API-docs/v1/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1/get-webhook/index.html b/docs/API-docs/v1/get-webhook/index.html index e03820350..dd2e96baa 100644 --- a/docs/API-docs/v1/get-webhook/index.html +++ b/docs/API-docs/v1/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/getcontact/index.html b/docs/API-docs/v1/getcontact/index.html index d2ea9d02a..b8561ce8a 100644 --- a/docs/API-docs/v1/getcontact/index.html +++ b/docs/API-docs/v1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/getdocument/index.html b/docs/API-docs/v1/getdocument/index.html index c36e14539..103caaf34 100644 --- a/docs/API-docs/v1/getdocument/index.html +++ b/docs/API-docs/v1/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1/getdocumentlist/index.html b/docs/API-docs/v1/getdocumentlist/index.html index 742ff6992..72aacd791 100644 --- a/docs/API-docs/v1/getdocumentlist/index.html +++ b/docs/API-docs/v1/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1/getfolder/index.html b/docs/API-docs/v1/getfolder/index.html index ebe44e8d4..f945787cc 100644 --- a/docs/API-docs/v1/getfolder/index.html +++ b/docs/API-docs/v1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/gettemplatelist/index.html b/docs/API-docs/v1/gettemplatelist/index.html index 34c1d7745..ab4d505fa 100644 --- a/docs/API-docs/v1/gettemplatelist/index.html +++ b/docs/API-docs/v1/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1/index.html b/docs/API-docs/v1/index.html index 46fb84996..1a2a9bd50 100644 --- a/docs/API-docs/v1/index.html +++ b/docs/API-docs/v1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/v1/intro/index.html b/docs/API-docs/v1/intro/index.html index 2c3b232b3..41df4b01e 100644 --- a/docs/API-docs/v1/intro/index.html +++ b/docs/API-docs/v1/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1/opensign-api-v-1/index.html b/docs/API-docs/v1/opensign-api-v-1/index.html index 1f5f94489..4dd6f3f7d 100644 --- a/docs/API-docs/v1/opensign-api-v-1/index.html +++ b/docs/API-docs/v1/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/v1/resendrequestmail/index.html b/docs/API-docs/v1/resendrequestmail/index.html index 4f10b34f9..88d9900a6 100644 --- a/docs/API-docs/v1/resendrequestmail/index.html +++ b/docs/API-docs/v1/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1/revokedocument/index.html b/docs/API-docs/v1/revokedocument/index.html index 96be27d3d..6782a9179 100644 --- a/docs/API-docs/v1/revokedocument/index.html +++ b/docs/API-docs/v1/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1/save-update-webhook/index.html b/docs/API-docs/v1/save-update-webhook/index.html index b94bed787..9fa788e02 100644 --- a/docs/API-docs/v1/save-update-webhook/index.html +++ b/docs/API-docs/v1/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/selfsign/index.html b/docs/API-docs/v1/selfsign/index.html index f9d32c417..dd2c6df5a 100644 --- a/docs/API-docs/v1/selfsign/index.html +++ b/docs/API-docs/v1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/v1/update-document/index.html b/docs/API-docs/v1/update-document/index.html index 4dbf621e7..afca4b6ec 100644 --- a/docs/API-docs/v1/update-document/index.html +++ b/docs/API-docs/v1/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1/update-template/index.html b/docs/API-docs/v1/update-template/index.html index 484ab5452..d5f34ea7e 100644 --- a/docs/API-docs/v1/update-template/index.html +++ b/docs/API-docs/v1/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1/updatefolder/index.html b/docs/API-docs/v1/updatefolder/index.html index daef2e126..74d23fc1a 100644 --- a/docs/API-docs/v1/updatefolder/index.html +++ b/docs/API-docs/v1/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index e4279e76a..591b3c28f 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 fee450f08..eab710b37 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 7375f10d6..03ce3abea 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/documents/index.html b/docs/category/documents/index.html index 60e12a446..95cf6f504 100644 --- a/docs/category/documents/index.html +++ b/docs/category/documents/index.html @@ -5,7 +5,7 @@ Documents | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 8868f1df8..4485f6ad9 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 e77699cc9..ddaf613fd 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 855d2eab3..3d668a718 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index ec0bb21c9..5e60d5055 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 3fa2946e8..3302cabfa 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/category/user-menu/index.html b/docs/category/user-menu/index.html index a42f962b2..bdba27e6e 100644 --- a/docs/category/user-menu/index.html +++ b/docs/category/user-menu/index.html @@ -5,7 +5,7 @@ User Menu | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 5e4de647d..a4f97db7e 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 af4c18c34..dfa9aad6f 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 41efd8e5f..bc19fba88 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 607210b95..81a2da7f3 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 5f33dd3a3..7fbbcb2e6 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 3f1c392a3..befe35989 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/Max File Upload Size/index.html b/docs/help/FAQs/Max File Upload Size/index.html index e35a9931b..6a6fed818 100644 --- a/docs/help/FAQs/Max File Upload Size/index.html +++ b/docs/help/FAQs/Max File Upload Size/index.html @@ -5,7 +5,7 @@ Max File Upload Size | OpenSign™ - + diff --git a/docs/help/FAQs/User Deletion/index.html b/docs/help/FAQs/User Deletion/index.html index 38b3c5131..461b8bab2 100644 --- a/docs/help/FAQs/User Deletion/index.html +++ b/docs/help/FAQs/User Deletion/index.html @@ -5,7 +5,7 @@ User Deletion | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index 4fa980ada..69f59711d 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/edit-document-before-sending/index.html b/docs/help/New-Document/edit-document-before-sending/index.html index 9a8277bcc..3bca05c8f 100644 --- a/docs/help/New-Document/edit-document-before-sending/index.html +++ b/docs/help/New-Document/edit-document-before-sending/index.html @@ -5,7 +5,7 @@ Editing Your Document Before Sending | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index f61e3182e..56bc65650 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 717b039d0..85fb65395 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 d051e728d..e9a524e2c 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 b7209eb0d..09edc4258 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 c1f000eab..4f382235a 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 462c6b7b8..1b19cc675 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 18dc94d4e..5dbf1eee1 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 93e1a459c..f49ef5940 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 e1364620c..0324cb753 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 a5b6f9f77..0a5a2ab95 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 a0cf75885..1f87fccc6 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 37b8069ca..fffddda3a 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 cfd10eb4d..c384239f7 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 28bf1988f..04b2c5b1f 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 f332c21bc..d5907aa25 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/APIToken/index.html b/docs/help/Settings/APIToken/index.html index 68bdff01a..87fc75536 100644 --- a/docs/help/Settings/APIToken/index.html +++ b/docs/help/Settings/APIToken/index.html @@ -5,7 +5,7 @@ API Token | OpenSign™ - + diff --git a/docs/help/Settings/Custom-email-templates/index.html b/docs/help/Settings/Custom-email-templates/index.html index 6dbfa7b03..87f057310 100644 --- a/docs/help/Settings/Custom-email-templates/index.html +++ b/docs/help/Settings/Custom-email-templates/index.html @@ -5,7 +5,7 @@ Custom email templates | OpenSign™ - + diff --git a/docs/help/Settings/Preferences/index.html b/docs/help/Settings/Preferences/index.html index f2e1259e4..2821c8c23 100644 --- a/docs/help/Settings/Preferences/index.html +++ b/docs/help/Settings/Preferences/index.html @@ -5,7 +5,7 @@ Preferences | OpenSign™ - + diff --git a/docs/help/Settings/SecurityManagement/index.html b/docs/help/Settings/SecurityManagement/index.html index 057c66768..3cdd44766 100644 --- a/docs/help/Settings/SecurityManagement/index.html +++ b/docs/help/Settings/SecurityManagement/index.html @@ -5,7 +5,7 @@ Security | OpenSign™ - + diff --git a/docs/help/Settings/Teams/index.html b/docs/help/Settings/Teams/index.html index 181bb6fee..ed0467370 100644 --- a/docs/help/Settings/Teams/index.html +++ b/docs/help/Settings/Teams/index.html @@ -5,7 +5,7 @@ Manage Teams | OpenSign™ - + diff --git a/docs/help/Settings/Webhook/index.html b/docs/help/Settings/Webhook/index.html index eccfcf147..9a2f580b0 100644 --- a/docs/help/Settings/Webhook/index.html +++ b/docs/help/Settings/Webhook/index.html @@ -5,7 +5,7 @@ Webhook | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index e6dabff15..a09921c5a 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 7ec7c634a..15cce3554 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 17fbc3a5f..72b9dc76b 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 ada05eae1..89109ce12 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 920e75dda..ad760eb78 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/manage-templates/index.html b/docs/help/Templates/manage-templates/index.html index 4e64ea2f7..d5d197985 100644 --- a/docs/help/Templates/manage-templates/index.html +++ b/docs/help/Templates/manage-templates/index.html @@ -5,7 +5,7 @@ Manage Templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index fcbf5d6be..f2443d58c 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 b2afb0a50..2c594c094 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 c8d8ad2cf..2f4ae2c2f 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/User Menu/Profile/index.html b/docs/help/User Menu/Profile/index.html index 33de3eb1d..a8e0a77a1 100644 --- a/docs/help/User Menu/Profile/index.html +++ b/docs/help/User Menu/Profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index b0e48ab43..25ee3c261 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 6f330124a..0dcb6c658 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 8b4e15ad9..f7720155f 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 a7ca4b63e..da3a2e3c9 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 2a90bf745..0f3337271 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 3008459a2..bee97c9b0 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/azure-vm-setup/index.html b/docs/self-host/guides/azure-vm-setup/index.html index 74ca1e065..92159ca54 100644 --- a/docs/self-host/guides/azure-vm-setup/index.html +++ b/docs/self-host/guides/azure-vm-setup/index.html @@ -5,7 +5,7 @@ OpenSign Deployment Guide on Azure VM via command-line | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 5f6a1f045..1c1c3ec4a 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 88bf16a04..5700e70c6 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 6d61f2af5..c712afcde 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 be95667bc..77912a177 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 3c03da773..3de332369 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 1afa379cd..773445fd0 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +