diff --git a/404.html b/404.html index 5577d9a47..efe6abd91 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/02e5f5c4.c21db2c6.js b/assets/js/02e5f5c4.9d8345bc.js similarity index 56% rename from assets/js/02e5f5c4.c21db2c6.js rename to assets/js/02e5f5c4.9d8345bc.js index 7953763ac..ae6e60209 100644 --- a/assets/js/02e5f5c4.c21db2c6.js +++ b/assets/js/02e5f5c4.9d8345bc.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5373],{42232(e,t,o){o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>u,default:()=>g,frontMatter:()=>S,metadata:()=>a,toc:()=>W});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+72StQyogAHniS3RYiGV5CFgNcPWDgZz5Mdw01BoyPHRJ44AoaKF4tEB7IJpMbCnPlxYGnc3ZwKTAULReanJeyDdoC5Zsa9oBsYBaiAdyFknPYEPjoOWKTSjg8MyQIsaa2LfGQyxqkhJbntwpuh8AG9UFyMGfl6Nowr6fDRR5SOGz+4tHwFLS9NaRw2334Kg7mRFPoPSVAQ+9gOnoCsoyAewHIssybPTTitT3sX68WoHa/gFkqjAzA9iZPPgUHtegSmWvgQ7wKwzzBEoBTga/eiJC/xC6jufj0av9Qnc7trqhgovA83+2Y/Scrl8MEKfHto8l+HbroAfyBovg3GrvXUtQ9MVceyGTnY/kqfnpCm2z2Co9j4qU/qHU8zSSUPKTq4ocIf4yfnlRXy0P4X37/4DLwidhsYsU7OWnSO1grq/ipFLlU+w7d5cmJvYeA0jXqbm27LeHsGbBsP7d794eElLkHo7UZzKaHTZFUqWcE2t5Y3kR6O8p+Chl0FoMECJGgoC3yC30kIiINhkraS+G8O5XkHnycFShiY2A8uj3UEajMuu3B4K9FSB0dGiv3O8j4jlrSe1IM++tAkcBlWSCWVonOnqdNswmG1yjuZSKbiRVU0h5nZeVWC34mUSM+CDcGjOAxEaWgE6Ak86jOHyyCSedNYax1HIFPzc8JcKF4B0ZY3UwedQOZyHvf9s3+hxa0mjPyBKEOIOjmzrZleSNInbjHfS8Wt+3I8WwuFz62hOji+Mae/rYuW2nW77tgTu1j/S1pHAGh2wjGSEWpQqbaYvj/1EYkCu9a/mV+QWsqTtdvyNiZ5E5YnIhJIlaU8DwnH+/PIFLD4bT0U2WLP/x3BPXlx8/ezl1TMOhh/SBNjpeDqeRl5vfGhRD246+FQ9XmzrPRH7fd+120Ue6D5MrEIZ2VNMaL0lPreHX7uzTDTMi/JbsV7zVP3o1GbD4p87ckyqZplYoJNY8G6+nW2yngMwU7qjFeeUgj655ttZXXWJThwxSSYxyeK8LMmGj+oOqdvlq6trkYli+0XemoptHC75ax2XzCP4mz5urvhBzbK1UKjrDmvWTT6ZtvCzd8h57iLn2f7DWfVHejWI8JAMpTT4Lyf1QYP1OvGpzWann45+02ILbK/N1ZttNpv/AmRN808=","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 r=o(74848),n=o(28453),s=o(57742),l=o.n(s),i=o(78178),d=o.n(i),p=o(19624),c=o.n(p),f=o(96226),m=o.n(f),j=(o(77675),o(19365),o(51107)),y=o(21312);const S={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+72StQyogAHniS3RYiGV5CFgNcPWDgZz5Mdw01BoyPHRJ44AoaKF4tEB7IJpMbCnPlxYGnc3ZwKTAULReanJeyDdoC5Zsa9oBsYBaiAdyFknPYEPjoOWKTSjg8MyQIsaa2LfGQyxqkhJbntwpuh8AG9UFyMGfl6Nowr6fDRR5SOGz+4tHwFLS9NaRw2334Kg7mRFPoPSVAQ+9gOnoCsoyAewHIssybPTTitT3sX68WoHa/gFkqjAzA9iZPPgUHtegSmWvgQ7wKwzzBEoBTga/eiJC/xC6jufj0av9Qnc7trqhgovA83+2Y/Scrl8MEKfHto8l+HbroAfyBovg3GrvXUtQ9MVceyGTnY/kqfnpCm2z2Co9j4qU/qHU8zSSUPKTq4ocIf4yfnlRXy0P4X37/4DLwidhsYsU7OWnSO1grq/ipFLlU+w7d5cmJvYeA0jXqbm27LeHsGbBsP7d794eElLkHo7UZzKaHTZFUqWcE2t5Y3kR6O8p+Chl0FoMECJGgoC3yC30kIiINhkraS+G8O5XkHnycFShiY2A8uj3UEajMuu3B4K9FSB0dGiv3O8j4jlrSe1IM++tAkcBlWSCWVonOnqdNswmG1yjuZSKbiRVU0h5nZeVWC34mUSM+CDcGjOAxEaWgE6Ak86jOHyyCSedNYax1HIFPzc8JcKF4B0ZY3UwedQOZyHvf9s3+hxa0mjPyBKEOIOjmzrZleSNInbjHfS8Wt+3I8WwuFz62hOji+Mae/rYuW2nW77tgTu1j/S1pHAGh2wjGSEWpQqbaYvj/1EYkCu9a/mV+QWsqTtdvyNiZ5E5YnIhJIlaU8DwnH+/PIFLD4bT0U2WLP/x3BPXlx8/ezl1TMOhh/SBNjpeDqeRl5vfGhRD246+FQ9XmzrPRH7fd+120Ue6D5MrEIZ2VNMaL0lPreHX7uzTDTMi/JbsV7zVP3o1GbD4p87ckyqZplYoJNY8G6+nW2yngMwU7qjFeeUgj655ttZXXWJThwxSSYxyeK8LMmGj+oOqdvlq6trkYli+0XemoptHC75ax2XzCP4mz5urvhBzbK1UKjrDmvWTT6ZtvCzd8h57iLn2f7DWfVHejWI8JAMpTT4Lyf1QYP1OvGpzWann45+02ILbK/N1ZttNpv/AmRN808=",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,h={},W=[];function P(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(j.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,r.jsx)(l(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,r.jsx)(j.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,r.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,r.jsx)(d(),{parameters:void 0}),"\n",(0,r.jsx)(c(),{...o(56888)}),"\n",(0,r.jsx)(m(),{...o(87634)})]})}function g(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(P,{...e})}):P(e)}},56888(e){e.exports=JSON.parse('{"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":true}}')},87634(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5373],{42232(e,t,r){r.r(t),r.d(t,{assets:()=>g,contentTitle:()=>S,default:()=>k,frontMatter:()=>j,metadata:()=>a,toc:()=>y});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(57742),l=r.n(s),i=r(78178),d=r.n(i),p=r(19624),c=r.n(p),m=r(96226),f=r.n(m),u=(r(77675),r(19365),r(51107)),h=r(21312);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},S=void 0,g={},y=[];function I(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:(0,o.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(d(),{parameters:void 0}),"\n",(0,o.jsx)(c(),{...r(56888)}),"\n",(0,o.jsx)(f(),{...r(87634)})]})}function k(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(I,{...e})}):I(e)}},56888(e){e.exports=JSON.parse('{"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":true}}')},87634(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/03e06346.1f15063a.js b/assets/js/03e06346.287ef655.js similarity index 69% rename from assets/js/03e06346.1f15063a.js rename to assets/js/03e06346.287ef655.js index 1b9452591..d02352ebc 100644 --- a/assets/js/03e06346.1f15063a.js +++ b/assets/js/03e06346.287ef655.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3404],{74671(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>w,frontMatter:()=>y,metadata:()=>i,toc:()=>b});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":"eJztPWtz3DaSfwXHuirbsxxqZizZjrb2bpXYl/WtY7ts+VI5SavFkJghLBJgAFCjWdVU7Yf9B/fpvu5Pyy+56gbAx7z0jCNfMR9iDfFqdDcaje5G4zIwdKqD/aPgkOVFRg3TwUkYJEzHiheGSxHsB4cpI+/LccZj4muRg/evCc0yOdOk1ExpYiSJFYMi43siJqWGaKbOGaGajLOSFYoLo8lEKjJlgilquJiSRMZlzqBgxk1KCsUSNuGCJUQbVcamVExH5MeUCUKr7gnXRJdxzLSelFk2d8MnITGphU8xUyqhCSWl4D+XjPR6vvEpT3o9QkVCKOn1CpzcaamyXi8iMN32NxjK/s7mhOKQfJwxbJ/TORkzolOqWGLhp2KOSAkJE3ScwQxNynJAkZu0bar5VDTmPqaaJUQKhN8DGpE/yRk7h86anwk3mmUTElMhpAEAcpnwCWcJMamS5TQlJuWafPrw5veEG6hHpMgQ1BKGAQr4oS3muBQVVFxMo2NxLA55sU8+FZmkCZnLUpH3L/+jbmYkgW9Hvd5LNi6n5NPrXu/kcWpMofd3dmhRRLJgAvrL6FhHscx3EqhYJJMnIZmlTDHoFYFjVHNAbgI4TKbMaJywILEs5iSWUiVcAFOFpKBTRkSZj5nSoaWBVIxwYA7FaDLvG9kvNSP/+fHdW5hoTk1E3melDqvhEq5YbIBpoHvArJ/VI0uIZ7vAe1xMQ5LTMyAhN+TnksdnMG3NRAL/Ok5DXPV6H8uikMqwhPxop7Df60HJtyyTM0IVw/qxzHMpSEEVzZnBpQPLBIoV+7nkNRtlmcfF/rHok15P0Jzt93rkk2VnnjBhgOgKyYkEtw0iW9/MC6z/WiQ8diuSEfhK5KRdFZAKVT8WLIYubdUGqoExZymPU8ThjFr6FxmN7bQU0wWLDT9n7Y4vQjKHjl8yIT0EqVT8b1IYmiH5zpkyPKZZk8wAIFTVhiqUEYXkwvivbgTykyMnUBuJ6PgQQEsAuTkXWKIZOadZybSDahaSFKD6wArFNC4/1y+u34SkjE/TjePR5HOpTatjUmq30Cso3Fieqohehmib0EwzwictXOb0jDVGIxLlL80i8u2cJGxCy8yEhAOHGlWyiLyVhtCiyHhMQRoBD8BioyAv+0hlxz5Rm33eK3nOEwaCMeGTCVOwmKEQu3BtPHTAlwU2gOnhSjMpSpMlQscyk2qVhfBzG48klsIwYSJycE55hsDbyWrCRZyVCSPjjMZnIe4ZIVEg1YEqcwZbTmjXB1aBjcXiHPFDNMuAC6UA+IV0w8NW4aBKQMCDPPfrDwo9qnEQrptYdat8ImFkQIFfkoTllGchIi4kn+WYGG4yFsICL6iYhyShhoXEsAszlhchiVMWn+FfiiZcknFpjBR2YomSRSJnwuFyIoXR/G9rVqQvuTlGRyHZDcmzkLwIyXAQkuEoJMPdkAyfhWT4IiSjQUhGo5CMdkMyembBGr1wuKYVgpsADEcWy+brwm7KE3YKDU9hbqdUG6a4PgNxbZUM3La9JgEV/a4My4sl9Q7INUl5kjBBJkrmRLGYFxyliZUGVdchwEMUTEpoYvWVc261CIeDqlM5E4A3HJEr8q5g4iNoCjSOZQk0RgxbpCI6a5LDDi8FOWQ01zjzV8IwVSiuGYhqoSsMCFPzlt0A4VtTAFyHkqItgTZTcxN1GpSBHfQN1yhzYevT1W46a+2mw4j0epWcg29//etfj8XlsSDkOACxdxzsk+OgqnIchLYMdjMoG7rfF/Dj6ei5+zmHn89GL9zPGVYd7rqfKfwc+aZuccE3HBhrcGHs0E7AkgYIUGlxLBYO2mMxwmkYmhdbpgDFXwp8v03BR9hfQl8AS3AVng0ztjVWZvsUZssFN5xmevOEfY0HNOclkNZPu660MvNdmDkKs83TxuIHNOcmPFCCm6gtwk23UeS3A4RitAVFy31uEsLQCtWjFUzuRU6H2YxIO4UHg8cGOPeFxqUub47FZ4BF2E8PYT/djMpqy31A+FyG6b6Quq7fm2P2eYRaMKonm/HqKjwgrLYhui+crvZ6c4y+AIyCnrcZnVD6gHDZAAcKnNJsywa7/eFefzQY7bbwCeYJWyHP+0nSn8/nd6NFzsWphQMaNern9GJ9AVhNQHesKFGVOGNQ1axdukp1W2+JkKBxOkyA0unPn1brBWMWKs+rxgU8+9e13IkH//YH8h/gGD72J1SWOLW5Po9U9p/mGdrIhM4faduVb1odvaD+snJswcQigANtYXEqeeyAhzr+wDUGc08EOOgjUXeSZKdBVPiYJP087y99hJ995IHGxzyPkiRaqrnCKPZjTpIkJKuf135PEpLn+YbP9nvr806er84iynMHm8Oe570VOudc8LyEIxKY1ewJPUH75qFHb+5oyQXp9X766aef+j/80H/5stfzNHRDOC5uWDLsCPTinkZoMn2vt09eT0jzE1oTrB0HpUB1MkRTtq+QypnwByI8NiqSlGBQrAysaE0C8zF0xrhJmWqPAyZaz7JwfERLrzRpRD7h6RL+9qew6rSEJ6lvIrR149F4s+x0Fb6U+KylZHvgraJ1s2hqydYVtcgLpmK93qTYtMyoYhdg/tNcihWZeJs98Gb725JY9Lxcm1rQsOhMu8xbOsjjd+4Q/qSyLy7NBXo7IHGpDdokpuyCFNQYpgR2dk4znlh7fx8/sAuaF2Bb2fnL8XHyu3/dQcsuGE+NNSkkfMrBIL/zl6OD/n+frKlRFgVTMdWMZAxG0iFhJo7IUcqyovYJzGazaPZUx6mUmXUIfNaKTez/T+X48ymCW0RUF0/WzdQyQ8OSCsyybEjFxdnAGNXEt1xjS0XS4KoZDlCDc6aKLSqcq/GA9I4lkKDQmqWh+Ai2flRugXlZ/bcEmXMcnNTbPVpPWXJF25NrLE9YDRkds2y16OZLK6NzWboV7b0F7ak6jm7gzalClUEYpzMIG4X0YqnQli3WrFOLkOYy9bu9X56eAiTjutpIWuhstnY+A/T8CMbQmQReRNeAjCsuvfMqqAC73jLwBlKk3RVDQD2CFSt/jR/tihFahFnZyZ2u4B1Pk6pXjzK/kTfxBS3B61qrCVtGcLrC5hHAy7N5gGMxRDOkN19uOZ+4Gg9IViyBtH0Z30aKtHbm22ypt1qAflrNBbhme4WqdmOtFp/evPoi8s7a1H0jsLfHMStA07rz0qxAvvYOhVbjpgl9M+c1az0g7lsD1q/Mga7efe8+t2LS5uy/IkZtgX1tZrVG/5xOt9hvsPgBsaeDZ8UUNUQ7vt0vttifsXz7dIaD1nT22tN5NrjFeao17N2PU4Pq4xr78/JQcHIuM7oi7BMW85xmGCCCcI/usAJvc7RygAGHfyfzojTNJYVGGxQbXgfwYQ/Wcfu7kPRD0gvJTkgeh+RJRD4wDJSIq6AKpxJwZUMnOIRyleAFjUsFgVYKJh4SFk0jcnn5c0mF4Wa+WJAeubyEGLDFIoI1dibkzMZVHIFH2BCIi6qPTImM9Zo4KhnrHThb7bxls/5L5zrecaA9IY/l0oLfetB0KPiy5y0LVYNJYJS3lUJmz5wYyMN1kdE5oRPwQttgD2xmY4IiQPE+GZE//BsZjqLBICQD+zd57Cc4eoJrGD1IMcu2uSCx+KoVPGiu4PrnOoG0N7jWEm4Oe8sVDF2cYogAjnulOlYv7gdoGKkns2yKbejsgDMXZJrKMktgb7RBn6wKz6s09l7vvWITnmWN6DziP/k1DdFOLGO5iwhzcXlwWMFIBC6MhHXjQzV6vTGbSIhCgPBANPs1wkDt2HZjbkV4YLylVCSl2lpRENMAMcQ/QqzoUjyEB6+OieDCww6sPLw/e9/omzZzP9trMfdee3/ayNybOHiLGRCa6EIKXXn7WF3U4Drs039fPTgsc5LvFMiN4TB1VA8KMWScjJ+xpqzhQnsdzEG5HOX2XSqlrmu4QDMnd/V+O4BNKohhexJVgR93dWoNnz9tKREvvqBTq02lwe7OcG9nq1dryQFy86MgIdchKdrMr0VSrFnTtHP53MXlc/cV8fQ+za7D56PWaeHpts35gZhdmyvqCoPrfZhVb3VyXWffbK7Da1o2v5iF8e5suftr2FqWBPfz4W9ga7kri66YVO6NKcl92VPWceY1DCpbrSh35twmsL869+7dj/Fl6azzTUsb/GbU5Na9vbtxaxOaJZY7Dvh/ffvuw2zw5++n8uDg4ODtx0/pq0/Tg4ODHH5HUbTWILeODXAY0J/dNR+3xaO6sGGUKIrQGU8N3cfmO4WY/t62Dze3iVy03a/kJdj70l6Cu8uNquqX2bPWuQR+Pclw1zUbhIEs8EqkFK+TYD+wVw79lb8gRLIxbb6VyTzYvwzcpQ/40wXhQ9OdzxpubV4GOk5ZTuEvT2645znhGXRlQ1J0EAYY+AiXPoEdg/1Ajj+z2AQhhE4UYO1mGvrAdvuXvpa9HBeETtUP9gO7HIIwcOEE1SfCRCwhNqtIJsHCD7itq+pL3ZXGP6r7j9AP3Ce7ZTfYdLF0z/VWPTV7WNRorTujStF5sHyl1l8kKxo3BcCo4Qxw2dxvJ9yAOa263YTVgjDghuXNUTYQTcmbYzpmEmaC8do3bYtkofmNx4R2RSrFrRq6SNPbNP0sx6e3Ykdo7Iwya2h9TerY0tWB26xyAJdpWOIV6359qyS01y2iqzjV10cs02lzTGtMWxnzcNPdz8aVM2dyo0XBqIrwCuatbwPj7XGaxSXeba7EcWtmFajVzIaLMLi4ejIXJJZ9f7GUPM7YxNh4JRJLJZh60ow/fTCTG+3uLsJgfvX05l/l9J4D8WZXz+5HvJFb31b+LWB9+mIRBunVsP6pujP8GwK7+2xR77GBzYlQZT0Yy2R+6uXW4qqKfjODenDj/bV4pxKmGogYS5kxKlYwARGz9mj0CNTLR6GNEsTLgVxpv5GRGdjeFYsZXBv3kbIoq4jTdey9IX/BChxKr+ADqme6HGuoJXx/2nY4ZsQoPp0yMMW7GtjYXWZlNE7hCr+LXaz9SoVi51yW2oMH9nnYXTJmMLECOPuq6N3m+a2BnUZ0sJ171KQOfIHNFS+Yvjt8fw1c4uGyb2/3u0ufOEvbB3l3+B4u0POJU/8gOLjChEctbVUhoI6Rc079JdtKts9tZBWzNlVpM1Q0XReRu7reJ6sAJVyvhSi0iULArVqlClnpuM7IACSSpQFXCHe3TbVhhW7hEaGoEHkoy+tw5RWYpGRa4h0CA0vW36bHWNb6AjwXNiUJnjNcQHcz/rtQEtKD1HjyWIFKjf4hN4i2zSmZoEsshDQlgHlVwqmi6pJdFExxcD2vRYFiFnWQquRqbaJ9m/zThzcuD0cjTN2vId8xS0hZINfgSqiyHHjKLU99RVGC1cHU6SbFcFX1QIe6M5oUTGkp4Jgk1ZQK/jfLwqiRwClrzFKa2apOVIA5HuPsgV9bwHhZ+8s//tmAa6OmuwqYHYEmCThHr4AQj5KW4UHTV6wACSjbEEF/TP1xeRMA6HDRnNq0LnYh6evz+HuMzdaVXHSuxcq1qcs4hYNFJW91WF1idWqlxrNpdftdFjBfdsG1adzs9vdtVuXDB3cNo4YB1RBY1cDzYt5c4LXLVS51h3fQeTvHQ7UNrqwFWhp5qljOxfX2qab9zshKEJRG5tTwmPiudNTO3GHdSn5d53WgAXDjOZfqyVrwDM/ZofzO7Sgv6VxfrVRAG9QEXCuS0DliBNP4tFQEdlFwNa8uS6HHymPyCk16DwUJTPZUipidcnEKSYeuoX42IjYAsDEzM8ZEE3OehHazrbMFzDCfU5NiSzdrWjgECHOmpuw0hhMUrgl2DRL3etBVr0f6FhAn8XWpnLXH5eRB0QZSru4dwHHZM6qLZbU60EyF1MjSVGQMrkGAhcH2D/gkCLlLKNEcoc7fpBlkWoCOK+8iJIuoh7ARAchKOJvX1kAQW2MT9AI5ZGCccNucvHSvbsxRyAPjR/cZLmByYPEhNJO42k26LgEGAvUaU4CkuDsi/cCebcfxeXkwpcUvf/9fDSqWi6PSEUxhYykGXtBMS3u9qdmrX2x+OVrb2cpqE9LwyfxUitNayq1lmHbLrQy0JoijrWgJt0fg4F7fAk4H7gBE2z0W/tFtUbdM382DAULuacC30rB98oFNqUqyak+zZDSY/Yo2GckOtYkbMCvIBrajxtA4ZZg1JGEF5M+SgjyCLdhuwI/qTCNATzBVMHGKptPrmFjcpr1oUPMoAAsrmk2TILT25eBkEQbjOL5tj7Cf/9H9xo06xE+j1reVBHrjOCaPIRFcQmKqxtJmNXuy71R1msA6RDVsSWtvEdUiH8VJS//ijUNKRKr/HBJtkNA6Y9R2i6Tf4O3ZAFO05WMIOcaAJzzxoCYoa6Nk27r1q5nHttm6XLBOZ+n6ikxBw8Hg/7Ol6+ng67F07Q6+IkvXCwDWOdWuliabTp9rZYd3Em5v8Fky63/IpNpeE3agRVi5NNchuF4Oo4X9rzbOeSF+hcHOWvRqZ58zNvnJIBpGgwH8syQEfVZRl0K1lVf1X4Lw+p7GKyR6nX11O74Ozl+8zwuRxylK8ioV6/ZWTWZr7Mc7tj2w3r97CHjyh/YYOdO6vWGsGcAlwTXb0dWkEhcZF+zUk+B0yaVryby7jiYfZc6sUj2DTX6mJGhj7nRh1JzQKRwPoBt1jyRiSl3FzDeDbBs2dgeD02GFhL1VJLwWeLUXs/keyjMmvuxMm8MbOzyAepFntUQJuK2E5UFrss3vdpKaxaXiZh7sH10GF31a8L4t3z86WZwAF5pUoutfaoSYmjTYD3ZWIgEwqTIoxkeXAa6Livk1FQlEx61IW1rwnfNhNAwW4XKbtdJ5S31W9m/aRBs65WJ6VbuTGkcfgY6WVC1M1epkwf/MQJ90hGjWCgMO/JMyCoYgQD2wx4c6fuKVJ7KPbFgXrFATczn8wEcftAIKlnfJNSECjQiBI++eR4975XAP6gkFlVM8CBpubvjRcFzDz0rXPqrZufL6elV4iDrkaHcXla3nQ9RKnr7ADX/32eLEIr/h5sHIoKavwp2Pm0Z396lthA6CJaNvy/K6bHjdaATdYAN1Qy7Z+tzXdSa24d4m49beWpuS62q9/cAVNg+n6w+a7px5/TNj46i2hp5eO2lTE8LzgJpPB0jN3QFS88WgpRg5GtQ91OoN6jCVCuMmUKspoIucwOrhYiJx6Tmeq5KSgmjEpbuizrIslnmVE7TX801++cc/q1a9XnWMtc4rsEm8KxUp5IypSWkTjU4ydoGZUqEZy7FMo/ELL5/RHCwXEDIjDJuiFQsvj4HjyLkmYlrQMc84yH57iQeNo43tw+aXxwuBc1k+UvZ63HkGO0ZlEG6kqiczqc4mkP8eTCRjuDUI5hMmUipi632wYgyt6HB6rjOxaqMAaG5Bk8IoGhuSU0GnaAYPSRNXCcs4yHqi5Bicc1pmpXU/GcozqawVGOeDgWuIw1cXBRShSg6CQ7EUFte580Hp0PoArYRyWdTH4G4tABYO9jcjSSkyCQnPwW1bZnDfzlhXKmj+TRihuVFUaFDXneHZkaBCmHMPMe0sXZ80AwK/4eLMpnbtk6OKrX5kY80Na2eOWRYQT9ptvufmT+UYUnpLzY1U87r1lJu0HONe0+yk+mF7+t4n52/sJNe/iPnRWsz0zsH716irPCG//P1/yBtGlSCpnFlmjUvFsnn7HQBLeYu2StVAByQtIQe+QR4VU+8T9xj8MaUGzaZv2Qzs03ZF2WDEpfcaNOSx+m7t+ww+04W9uQZeYeoeOyAZF2cROXDPGdR2P/iO7W7xnMFhY3SWa5adM90wg7OEm9YjBqwFjJtc+yIfzO0gSUixdJkPvDQ1ONZuhU5uag1Y8CrAmvt/rUt27XzGTCR451Tvk0TRian7D1dfU1jzyV8M9OgIXTcVSexKLNrnDG0N3EtaUFvcouEcBtTtZyYK7tjpyLMlaadkujlb2zOvMDRGHdzv4rTga/2YkIVfv5t8ZOqcx/6YtmFF72DlnSAMMh4zdwB329fB9+/fkPOn0QD2z0q3vMbi3nnz+rtXbz++AmBAkFqEDaNBNMDTpdQmp6Ix0tLaWd7aGoG33dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMoXw6f3dMo3dMoN84i1T2NUhV0T6N0T6Mcd0+jdE+jHHdPozyMDKDd0yjd0yj3osN1T6N0T6N0T6N0T6N0T6N8RS9OdE+jfAkO7J5G6Z5GuWl+zhVTVPc0Svc0Svc0Svc0ynH3NEr3NEr3NEr3NEr3NMpx9zRK5/Lpnkbpnkbpnkbpnkbpnkbpnkbpnkbpnkbpnka5y9MojTQIO0VGOeZacSmBbJqUo+UHU07CIIU8KvtHweUlsOQnlS0W8PnnEtM/HJ2EwTlVHCL0MQVL6DOGQOKFMwbJNr6z10f6hzB+aAmNt12XMs9AyhPb4gDnvrVuM9XL+3cfDyFrhHvUJZcJZoyiM0jUQGc2m0YjmwN+uwwyKqYlZoIIbJ8Lm/82bWdIOcMMKe6PRjoJyCRSQ9hOnWKnAf+HSa1tcHlps68sFlV9W7SxhUOsrw30O1ksFv8Hm8onPA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const y={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:"eJztPWtz3DaSfwXHuirbsxxqZizZjrb2bpXYl/WtY7ts+VI5SavFkJghLBJgAFCjWdVU7Yf9B/fpvu5Pyy+56gbAx7z0jCNfMR9iDfFqdDcaje5G4zIwdKqD/aPgkOVFRg3TwUkYJEzHiheGSxHsB4cpI+/LccZj4muRg/evCc0yOdOk1ExpYiSJFYMi43siJqWGaKbOGaGajLOSFYoLo8lEKjJlgilquJiSRMZlzqBgxk1KCsUSNuGCJUQbVcamVExH5MeUCUKr7gnXRJdxzLSelFk2d8MnITGphU8xUyqhCSWl4D+XjPR6vvEpT3o9QkVCKOn1CpzcaamyXi8iMN32NxjK/s7mhOKQfJwxbJ/TORkzolOqWGLhp2KOSAkJE3ScwQxNynJAkZu0bar5VDTmPqaaJUQKhN8DGpE/yRk7h86anwk3mmUTElMhpAEAcpnwCWcJMamS5TQlJuWafPrw5veEG6hHpMgQ1BKGAQr4oS3muBQVVFxMo2NxLA55sU8+FZmkCZnLUpH3L/+jbmYkgW9Hvd5LNi6n5NPrXu/kcWpMofd3dmhRRLJgAvrL6FhHscx3EqhYJJMnIZmlTDHoFYFjVHNAbgI4TKbMaJywILEs5iSWUiVcAFOFpKBTRkSZj5nSoaWBVIxwYA7FaDLvG9kvNSP/+fHdW5hoTk1E3melDqvhEq5YbIBpoHvArJ/VI0uIZ7vAe1xMQ5LTMyAhN+TnksdnMG3NRAL/Ok5DXPV6H8uikMqwhPxop7Df60HJtyyTM0IVw/qxzHMpSEEVzZnBpQPLBIoV+7nkNRtlmcfF/rHok15P0Jzt93rkk2VnnjBhgOgKyYkEtw0iW9/MC6z/WiQ8diuSEfhK5KRdFZAKVT8WLIYubdUGqoExZymPU8ThjFr6FxmN7bQU0wWLDT9n7Y4vQjKHjl8yIT0EqVT8b1IYmiH5zpkyPKZZk8wAIFTVhiqUEYXkwvivbgTykyMnUBuJ6PgQQEsAuTkXWKIZOadZybSDahaSFKD6wArFNC4/1y+u34SkjE/TjePR5HOpTatjUmq30Cso3Fieqohehmib0EwzwictXOb0jDVGIxLlL80i8u2cJGxCy8yEhAOHGlWyiLyVhtCiyHhMQRoBD8BioyAv+0hlxz5Rm33eK3nOEwaCMeGTCVOwmKEQu3BtPHTAlwU2gOnhSjMpSpMlQscyk2qVhfBzG48klsIwYSJycE55hsDbyWrCRZyVCSPjjMZnIe4ZIVEg1YEqcwZbTmjXB1aBjcXiHPFDNMuAC6UA+IV0w8NW4aBKQMCDPPfrDwo9qnEQrptYdat8ImFkQIFfkoTllGchIi4kn+WYGG4yFsICL6iYhyShhoXEsAszlhchiVMWn+FfiiZcknFpjBR2YomSRSJnwuFyIoXR/G9rVqQvuTlGRyHZDcmzkLwIyXAQkuEoJMPdkAyfhWT4IiSjQUhGo5CMdkMyembBGr1wuKYVgpsADEcWy+brwm7KE3YKDU9hbqdUG6a4PgNxbZUM3La9JgEV/a4My4sl9Q7INUl5kjBBJkrmRLGYFxyliZUGVdchwEMUTEpoYvWVc261CIeDqlM5E4A3HJEr8q5g4iNoCjSOZQk0RgxbpCI6a5LDDi8FOWQ01zjzV8IwVSiuGYhqoSsMCFPzlt0A4VtTAFyHkqItgTZTcxN1GpSBHfQN1yhzYevT1W46a+2mw4j0epWcg29//etfj8XlsSDkOACxdxzsk+OgqnIchLYMdjMoG7rfF/Dj6ei5+zmHn89GL9zPGVYd7rqfKfwc+aZuccE3HBhrcGHs0E7AkgYIUGlxLBYO2mMxwmkYmhdbpgDFXwp8v03BR9hfQl8AS3AVng0ztjVWZvsUZssFN5xmevOEfY0HNOclkNZPu660MvNdmDkKs83TxuIHNOcmPFCCm6gtwk23UeS3A4RitAVFy31uEsLQCtWjFUzuRU6H2YxIO4UHg8cGOPeFxqUub47FZ4BF2E8PYT/djMpqy31A+FyG6b6Quq7fm2P2eYRaMKonm/HqKjwgrLYhui+crvZ6c4y+AIyCnrcZnVD6gHDZAAcKnNJsywa7/eFefzQY7bbwCeYJWyHP+0nSn8/nd6NFzsWphQMaNern9GJ9AVhNQHesKFGVOGNQ1axdukp1W2+JkKBxOkyA0unPn1brBWMWKs+rxgU8+9e13IkH//YH8h/gGD72J1SWOLW5Po9U9p/mGdrIhM4faduVb1odvaD+snJswcQigANtYXEqeeyAhzr+wDUGc08EOOgjUXeSZKdBVPiYJP087y99hJ995IHGxzyPkiRaqrnCKPZjTpIkJKuf135PEpLn+YbP9nvr806er84iynMHm8Oe570VOudc8LyEIxKY1ewJPUH75qFHb+5oyQXp9X766aef+j/80H/5stfzNHRDOC5uWDLsCPTinkZoMn2vt09eT0jzE1oTrB0HpUB1MkRTtq+QypnwByI8NiqSlGBQrAysaE0C8zF0xrhJmWqPAyZaz7JwfERLrzRpRD7h6RL+9qew6rSEJ6lvIrR149F4s+x0Fb6U+KylZHvgraJ1s2hqydYVtcgLpmK93qTYtMyoYhdg/tNcihWZeJs98Gb725JY9Lxcm1rQsOhMu8xbOsjjd+4Q/qSyLy7NBXo7IHGpDdokpuyCFNQYpgR2dk4znlh7fx8/sAuaF2Bb2fnL8XHyu3/dQcsuGE+NNSkkfMrBIL/zl6OD/n+frKlRFgVTMdWMZAxG0iFhJo7IUcqyovYJzGazaPZUx6mUmXUIfNaKTez/T+X48ymCW0RUF0/WzdQyQ8OSCsyybEjFxdnAGNXEt1xjS0XS4KoZDlCDc6aKLSqcq/GA9I4lkKDQmqWh+Ai2flRugXlZ/bcEmXMcnNTbPVpPWXJF25NrLE9YDRkds2y16OZLK6NzWboV7b0F7ak6jm7gzalClUEYpzMIG4X0YqnQli3WrFOLkOYy9bu9X56eAiTjutpIWuhstnY+A/T8CMbQmQReRNeAjCsuvfMqqAC73jLwBlKk3RVDQD2CFSt/jR/tihFahFnZyZ2u4B1Pk6pXjzK/kTfxBS3B61qrCVtGcLrC5hHAy7N5gGMxRDOkN19uOZ+4Gg9IViyBtH0Z30aKtHbm22ypt1qAflrNBbhme4WqdmOtFp/evPoi8s7a1H0jsLfHMStA07rz0qxAvvYOhVbjpgl9M+c1az0g7lsD1q/Mga7efe8+t2LS5uy/IkZtgX1tZrVG/5xOt9hvsPgBsaeDZ8UUNUQ7vt0vttifsXz7dIaD1nT22tN5NrjFeao17N2PU4Pq4xr78/JQcHIuM7oi7BMW85xmGCCCcI/usAJvc7RygAGHfyfzojTNJYVGGxQbXgfwYQ/Wcfu7kPRD0gvJTkgeh+RJRD4wDJSIq6AKpxJwZUMnOIRyleAFjUsFgVYKJh4SFk0jcnn5c0mF4Wa+WJAeubyEGLDFIoI1dibkzMZVHIFH2BCIi6qPTImM9Zo4KhnrHThb7bxls/5L5zrecaA9IY/l0oLfetB0KPiy5y0LVYNJYJS3lUJmz5wYyMN1kdE5oRPwQttgD2xmY4IiQPE+GZE//BsZjqLBICQD+zd57Cc4eoJrGD1IMcu2uSCx+KoVPGiu4PrnOoG0N7jWEm4Oe8sVDF2cYogAjnulOlYv7gdoGKkns2yKbejsgDMXZJrKMktgb7RBn6wKz6s09l7vvWITnmWN6DziP/k1DdFOLGO5iwhzcXlwWMFIBC6MhHXjQzV6vTGbSIhCgPBANPs1wkDt2HZjbkV4YLylVCSl2lpRENMAMcQ/QqzoUjyEB6+OieDCww6sPLw/e9/omzZzP9trMfdee3/ayNybOHiLGRCa6EIKXXn7WF3U4Drs039fPTgsc5LvFMiN4TB1VA8KMWScjJ+xpqzhQnsdzEG5HOX2XSqlrmu4QDMnd/V+O4BNKohhexJVgR93dWoNnz9tKREvvqBTq02lwe7OcG9nq1dryQFy86MgIdchKdrMr0VSrFnTtHP53MXlc/cV8fQ+za7D56PWaeHpts35gZhdmyvqCoPrfZhVb3VyXWffbK7Da1o2v5iF8e5suftr2FqWBPfz4W9ga7kri66YVO6NKcl92VPWceY1DCpbrSh35twmsL869+7dj/Fl6azzTUsb/GbU5Na9vbtxaxOaJZY7Dvh/ffvuw2zw5++n8uDg4ODtx0/pq0/Tg4ODHH5HUbTWILeODXAY0J/dNR+3xaO6sGGUKIrQGU8N3cfmO4WY/t62Dze3iVy03a/kJdj70l6Cu8uNquqX2bPWuQR+Pclw1zUbhIEs8EqkFK+TYD+wVw79lb8gRLIxbb6VyTzYvwzcpQ/40wXhQ9OdzxpubV4GOk5ZTuEvT2645znhGXRlQ1J0EAYY+AiXPoEdg/1Ajj+z2AQhhE4UYO1mGvrAdvuXvpa9HBeETtUP9gO7HIIwcOEE1SfCRCwhNqtIJsHCD7itq+pL3ZXGP6r7j9AP3Ce7ZTfYdLF0z/VWPTV7WNRorTujStF5sHyl1l8kKxo3BcCo4Qxw2dxvJ9yAOa263YTVgjDghuXNUTYQTcmbYzpmEmaC8do3bYtkofmNx4R2RSrFrRq6SNPbNP0sx6e3Ykdo7Iwya2h9TerY0tWB26xyAJdpWOIV6359qyS01y2iqzjV10cs02lzTGtMWxnzcNPdz8aVM2dyo0XBqIrwCuatbwPj7XGaxSXeba7EcWtmFajVzIaLMLi4ejIXJJZ9f7GUPM7YxNh4JRJLJZh60ow/fTCTG+3uLsJgfvX05l/l9J4D8WZXz+5HvJFb31b+LWB9+mIRBunVsP6pujP8GwK7+2xR77GBzYlQZT0Yy2R+6uXW4qqKfjODenDj/bV4pxKmGogYS5kxKlYwARGz9mj0CNTLR6GNEsTLgVxpv5GRGdjeFYsZXBv3kbIoq4jTdey9IX/BChxKr+ADqme6HGuoJXx/2nY4ZsQoPp0yMMW7GtjYXWZlNE7hCr+LXaz9SoVi51yW2oMH9nnYXTJmMLECOPuq6N3m+a2BnUZ0sJ171KQOfIHNFS+Yvjt8fw1c4uGyb2/3u0ufOEvbB3l3+B4u0POJU/8gOLjChEctbVUhoI6Rc079JdtKts9tZBWzNlVpM1Q0XReRu7reJ6sAJVyvhSi0iULArVqlClnpuM7IACSSpQFXCHe3TbVhhW7hEaGoEHkoy+tw5RWYpGRa4h0CA0vW36bHWNb6AjwXNiUJnjNcQHcz/rtQEtKD1HjyWIFKjf4hN4i2zSmZoEsshDQlgHlVwqmi6pJdFExxcD2vRYFiFnWQquRqbaJ9m/zThzcuD0cjTN2vId8xS0hZINfgSqiyHHjKLU99RVGC1cHU6SbFcFX1QIe6M5oUTGkp4Jgk1ZQK/jfLwqiRwClrzFKa2apOVIA5HuPsgV9bwHhZ+8s//tmAa6OmuwqYHYEmCThHr4AQj5KW4UHTV6wACSjbEEF/TP1xeRMA6HDRnNq0LnYh6evz+HuMzdaVXHSuxcq1qcs4hYNFJW91WF1idWqlxrNpdftdFjBfdsG1adzs9vdtVuXDB3cNo4YB1RBY1cDzYt5c4LXLVS51h3fQeTvHQ7UNrqwFWhp5qljOxfX2qab9zshKEJRG5tTwmPiudNTO3GHdSn5d53WgAXDjOZfqyVrwDM/ZofzO7Sgv6VxfrVRAG9QEXCuS0DliBNP4tFQEdlFwNa8uS6HHymPyCk16DwUJTPZUipidcnEKSYeuoX42IjYAsDEzM8ZEE3OehHazrbMFzDCfU5NiSzdrWjgECHOmpuw0hhMUrgl2DRL3etBVr0f6FhAn8XWpnLXH5eRB0QZSru4dwHHZM6qLZbU60EyF1MjSVGQMrkGAhcH2D/gkCLlLKNEcoc7fpBlkWoCOK+8iJIuoh7ARAchKOJvX1kAQW2MT9AI5ZGCccNucvHSvbsxRyAPjR/cZLmByYPEhNJO42k26LgEGAvUaU4CkuDsi/cCebcfxeXkwpcUvf/9fDSqWi6PSEUxhYykGXtBMS3u9qdmrX2x+OVrb2cpqE9LwyfxUitNayq1lmHbLrQy0JoijrWgJt0fg4F7fAk4H7gBE2z0W/tFtUbdM382DAULuacC30rB98oFNqUqyak+zZDSY/Yo2GckOtYkbMCvIBrajxtA4ZZg1JGEF5M+SgjyCLdhuwI/qTCNATzBVMHGKptPrmFjcpr1oUPMoAAsrmk2TILT25eBkEQbjOL5tj7Cf/9H9xo06xE+j1reVBHrjOCaPIRFcQmKqxtJmNXuy71R1msA6RDVsSWtvEdUiH8VJS//ijUNKRKr/HBJtkNA6Y9R2i6Tf4O3ZAFO05WMIOcaAJzzxoCYoa6Nk27r1q5nHttm6XLBOZ+n6ikxBw8Hg/7Ol6+ng67F07Q6+IkvXCwDWOdWuliabTp9rZYd3Em5v8Fky63/IpNpeE3agRVi5NNchuF4Oo4X9rzbOeSF+hcHOWvRqZ58zNvnJIBpGgwH8syQEfVZRl0K1lVf1X4Lw+p7GKyR6nX11O74Ozl+8zwuRxylK8ioV6/ZWTWZr7Mc7tj2w3r97CHjyh/YYOdO6vWGsGcAlwTXb0dWkEhcZF+zUk+B0yaVryby7jiYfZc6sUj2DTX6mJGhj7nRh1JzQKRwPoBt1jyRiSl3FzDeDbBs2dgeD02GFhL1VJLwWeLUXs/keyjMmvuxMm8MbOzyAepFntUQJuK2E5UFrss3vdpKaxaXiZh7sH10GF31a8L4t3z86WZwAF5pUoutfaoSYmjTYD3ZWIgEwqTIoxkeXAa6Livk1FQlEx61IW1rwnfNhNAwW4XKbtdJ5S31W9m/aRBs65WJ6VbuTGkcfgY6WVC1M1epkwf/MQJ90hGjWCgMO/JMyCoYgQD2wx4c6fuKVJ7KPbFgXrFATczn8wEcftAIKlnfJNSECjQiBI++eR4975XAP6gkFlVM8CBpubvjRcFzDz0rXPqrZufL6elV4iDrkaHcXla3nQ9RKnr7ADX/32eLEIr/h5sHIoKavwp2Pm0Z396lthA6CJaNvy/K6bHjdaATdYAN1Qy7Z+tzXdSa24d4m49beWpuS62q9/cAVNg+n6w+a7px5/TNj46i2hp5eO2lTE8LzgJpPB0jN3QFS88WgpRg5GtQ91OoN6jCVCuMmUKspoIucwOrhYiJx6Tmeq5KSgmjEpbuizrIslnmVE7TX801++cc/q1a9XnWMtc4rsEm8KxUp5IypSWkTjU4ydoGZUqEZy7FMo/ELL5/RHCwXEDIjDJuiFQsvj4HjyLkmYlrQMc84yH57iQeNo43tw+aXxwuBc1k+UvZ63HkGO0ZlEG6kqiczqc4mkP8eTCRjuDUI5hMmUipi632wYgyt6HB6rjOxaqMAaG5Bk8IoGhuSU0GnaAYPSRNXCcs4yHqi5Bicc1pmpXU/GcozqawVGOeDgWuIw1cXBRShSg6CQ7EUFte580Hp0PoArYRyWdTH4G4tABYO9jcjSSkyCQnPwW1bZnDfzlhXKmj+TRihuVFUaFDXneHZkaBCmHMPMe0sXZ80AwK/4eLMpnbtk6OKrX5kY80Na2eOWRYQT9ptvufmT+UYUnpLzY1U87r1lJu0HONe0+yk+mF7+t4n52/sJNe/iPnRWsz0zsH716irPCG//P1/yBtGlSCpnFlmjUvFsnn7HQBLeYu2StVAByQtIQe+QR4VU+8T9xj8MaUGzaZv2Qzs03ZF2WDEpfcaNOSx+m7t+ww+04W9uQZeYeoeOyAZF2cROXDPGdR2P/iO7W7xnMFhY3SWa5adM90wg7OEm9YjBqwFjJtc+yIfzO0gSUixdJkPvDQ1ONZuhU5uag1Y8CrAmvt/rUt27XzGTCR451Tvk0TRian7D1dfU1jzyV8M9OgIXTcVSexKLNrnDG0N3EtaUFvcouEcBtTtZyYK7tjpyLMlaadkujlb2zOvMDRGHdzv4rTga/2YkIVfv5t8ZOqcx/6YtmFF72DlnSAMMh4zdwB329fB9+/fkPOn0QD2z0q3vMbi3nnz+rtXbz++AmBAkFqEDaNBNMDTpdQmp6Ix0tLaWd7aGoG33dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMo3dMoXw6f3dMo3dMoN84i1T2NUhV0T6N0T6Mcd0+jdE+jHHdPozyMDKDd0yjd0yj3osN1T6N0T6N0T6N0T6N0T6N8RS9OdE+jfAkO7J5G6Z5GuWl+zhVTVPc0Svc0Svc0Svc0ynH3NEr3NEr3NEr3NEr3NMpx9zRK5/Lpnkbpnkbpnkbpnkbpnkbpnkbpnkbpnkbpnka5y9MojTQIO0VGOeZacSmBbJqUo+UHU07CIIU8KvtHweUlsOQnlS0W8PnnEtM/HJ2EwTlVHCL0MQVL6DOGQOKFMwbJNr6z10f6hzB+aAmNt12XMs9AyhPb4gDnvrVuM9XL+3cfDyFrhHvUJZcJZoyiM0jUQGc2m0YjmwN+uwwyKqYlZoIIbJ8Lm/82bWdIOcMMKe6PRjoJyCRSQ9hOnWKnAf+HSa1tcHlps68sFlV9W7SxhUOsrw30O1ksFv8Hm8onPA==",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={},b=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,s.jsx)(l(),{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:"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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options": {\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(71591)}),"\n",(0,s.jsx)(u(),{...t(94633)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},71591(e){e.exports=JSON.parse('{"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"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":true}}')},94633(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3404],{74671(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>g,default:()=>w,frontMatter:()=>y,metadata:()=>s,toc:()=>j});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":"eJztPWtz3DaSfwXHuirbsxxqZizZjrb2bpXYl/WtY7ts+VI5SavFkJghLBJgAFCjWdVU7Yf9B/fpvu5Pyy+56gbAx7z0jCNfMR9iDfFqdDcaje5G4zIwdKqD/aPgkOVFRg3TwUkYJEzHiheGSxHsB4cpI+/LccZj4muRg/evCc0yOdOk1ExpYiSJFYMi43siJqWGaKbOGaGajLOSFYoLo8lEKjJlgilquJiSRMZlzqBgxk1KCsUSNuGCJUQbVcamVExH5MeUCUKr7gnXRJdxzLSelFk2d8MnITGphU8xUyqhCSWl4D+XjPR6vvEpT3o9QkVCKOn1CpzcaamyXi8iMN32NxjK/s7mhOKQfJwxbJ/TORkzolOqWGLhp2KOSAkJE3ScwQxNynJAkZu0bar5VDTmPqaaJUQKhN8DGpE/yRk7h86anwk3mmUTElMhpAEAcpnwCWcJMamS5TQlJuWafPrw5veEG6hHpMgQ1BKGAQr4oS3muBQVVFxMo2NxLA55sU8+FZmkCZnLUpH3L/+jbmYkgW9Hvd5LNi6n5NPrXu/kcWpMofd3dmhRRLJgAvrL6FhHscx3EqhYJJMnIZmlTDHoFYFjVHNAbgI4TKbMaJywILEs5iSWUiVcAFOFpKBTRkSZj5nSoaWBVIxwYA7FaDLvG9kvNSP/+fHdW5hoTk1E3melDqvhEq5YbIBpoHvArJ/VI0uIZ7vAe1xMQ5LTMyAhN+TnksdnMG3NRAL/Ok5DXPV6H8uikMqwhPxop7Df60HJtyyTM0IVw/qxzHMpSEEVzZnBpQPLBIoV+7nkNRtlmcfF/rHok15P0Jzt93rkk2VnnjBhgOgKyYkEtw0iW9/MC6z/WiQ8diuSEfhK5KRdFZAKVT8WLIYubdUGqoExZymPU8ThjFr6FxmN7bQU0wWLDT9n7Y4vQjKHjl8yIT0EqVT8b1IYmiH5zpkyPKZZk8wAIFTVhiqUEYXkwvivbgTykyMnUBuJ6PgQQEsAuTkXWKIZOadZybSDahaSFKD6wArFNC4/1y+u34SkjE/TjePR5HOpTatjUmq30Cso3Fieqohehmib0EwzwictXOb0jDVGIxLlL80i8u2cJGxCy8yEhAOHGlWyiLyVhtCiyHhMQRoBD8BioyAv+0hlxz5Rm33eK3nOEwaCMeGTCVOwmKEQu3BtPHTAlwU2gOnhSjMpSpMlQscyk2qVhfBzG48klsIwYSJycE55hsDbyWrCRZyVCSPjjMZnIe4ZIVEg1YEqcwZbTmjXB1aBjcXiHPFDNMuAC6UA+IV0w8NW4aBKQMCDPPfrDwo9qnEQrptYdat8ImFkQIFfkoTllGchIi4kn+WYGG4yFsICL6iYhyShhoXEsAszlhchiVMWn+FfiiZcknFpjBR2YomSRSJnwuFyIoXR/G9rVqQvuTlGRyHZDcmzkLwIyXAQkuEoJMPdkAyfhWT4IiSjQUhGo5CMdkMyembBGr1wuKYVgpsADEcWy+brwm7KE3YKDU9hbqdUG6a4PgNxbZUM3La9JgEV/a4My4sl9Q7INUl5kjBBJkrmRLGYFxyliZUGVdchwEMUTEpoYvWVc261CIeDqlM5E4A3HJEr8q5g4iNoCjSOZQk0RgxbpCI6a5LDDi8FOWQ01zjzV8IwVSiuGYhqoSsMCFPzlt0A4VtTAFyHkqItgTZTcxN1GpSBHfQN1yhzYevT1W46a+2mw4j0epWcg29//etfj8XlsSDkOACxdxzsk+OgqnIchLYMdjMoG7rfF/Dj6ei5+zmHn89GL9zPGVYd7rqfKfwc+aZuccE3HBhrcGHs0E7AkgYIUGlxLBYO2mMxwmkYmhdbpgDFXwp8v03BR9hfQl8AS3AVng0ztjVWZvsUZssFN5xmevOEfY0HNOclkNZPu660MvNdmDkKs83TxuIHNOcmPFCCm6gtwk23UeS3A4RitAVFy31uEsLQCtWjFUzuRU6H2YxIO4UHg8cGOPeFxqUub47FZ4BF2E8PYT/djMpqy31A+FyG6b6Quq7fm2P2eYRaMKonm/HqKjwgrLYhui+crvZ6c4y+AIyCnrcZnVD6gHDZAAcKnNJsywa7/eFefzQY7bbwCeYJWyHP+0nSn8/nd6NFzsWphQMaNern9GJ9AVhNQHesKFGVOGNQ1axdukp1W2+JkKBxOkyA0unPn1brBWMWKs+rxgU8+9e13IkH//YH8h/gGD72J1SWOLW5Po9U9p/mGdrIhM4faduVb1odvaD+snJswcQigANtYXEqeeyAhzr+wDUGc08EOOgjUXeSZKdBVPiYJP087y99hJ995IHGxzyPkiRaqrnCKPZjTpIkJKuf135PEpLn+YbP9nvr806er84iynMHm8Oe570VOudc8LyEIxKY1ewJPUH75qFHb+5oyQXp9X766aef+j/80H/5stfzNHRDOC5uWDLsCPTinkZoMn2vt09eT0jzE1oTrB0HpUB1MkRTtq+QypnwByI8NiqSlGBQrAysaE0C8zF0xrhJmWqPAyZaz7JwfERLrzRpRD7h6RL+9qew6rSEJ6lvIrR149F4s+x0Fb6U+KylZHvgraJ1s2hqydYVtcgLpmK93qTYtMyoYhdg/tNcihWZeJs98Gb725JY9Lxcm1rQsOhMu8xbOsjjd+4Q/qSyLy7NBXo7IHGpDdokpuyCFNQYpgR2dk4znlh7fx8/sAuaF2Bb2fnL8XHyu3/dQcsuGE+NNSkkfMrBIL/zl6OD/n+frKlRFgVTMdWMZAxG0iFhJo7IUcqyovYJzGazaPZUx6mUmXUIfNaKTez/T+X48ymCW0RUF0/WzdQyQ8OSCsyybEjFxdnAGNXEt1xjS0XS4KoZDlCDc6aKLSqcq/GA9I4lkKDQmqWh+Ai2flRugXlZ/bcEmXMcnNTbPVpPWXJF25NrLE9YDRkds2y16OZLK6NzWboV7b0F7ak6jm7gzalClUEYpzMIG4X0YqnQli3WrFOLkOYy9bu9X56eAiTjutpIWuhstnY+A/T8CMbQmQReRNeAjCsuvfMqqAC73jLwBlKk3RVDQD2CFSt/jR/tihFahFnZyZ2u4B1Pk6pXjzK/kTfxBS3B61qrCVtGcLrC5hHAy7N5gGMxRDOkN19uOZ+4Gg9IViyBtH0Z30aKtHbm22ypt1qAflrNBbhme4WqdmOtFp/evPoi8s7a1H0jsLfHMStA07rz0qxAvvYOhVbjpgl9M+c1az0g7lsD1q/Mga7efe8+t2LS5uy/IkZtgX1tZrVG/5xOt9hvsPgBsaeDZ8UUNUQ7vt0vttifsXz7dIaD1nT22tN5NrjFeao17N2PU4Pq4xr78/JQcHIuM7oi7BMW85xmGCCCcI/usAJvc7RygAGHfyfzojTNJYVGGxQbXgfwYQ/Wcfu7kPRD0gvJTkgeh+RJRD4wDJSIq6AKpxJwZUMnOIRyleAFjUsFgVYKJh4SFk0jcnn5c0mF4Wa+WJAeubyEGLDFIoI1dibkzMZVHIFH2BCIi6qPTImM9Zo4KhnrHThb7bxls/5L5zrecaA9IY/l0oLfetB0KPiy5y0LVYNJYJS3lUJmz5wYyMN1kdE5oRPwQttgD2xmY4IiQPE+GZE//BsZjqLBICQD+zd57Cc4eoJrGD1IMcu2uSCx+KoVPGiu4PrnOoG0N7jWEm4Oe8sVDF2cYogAjnulOlYv7gdoGKkns2yKbejsgDMXZJrKMktgb7RBn6wKz6s09l7vvWITnmWN6DziP/k1DdFOLGO5iwhzcXlwWMFIBC6MhHXjQzV6vTGbSIhCgPBANPs1wkDt2HZjbkV4YLylVCSl2lpRENMAMcQ/QqzoUjyEB6+OieDCww6sPLw/e9/omzZzP9trMfdee3/ayNybOHiLGRCa6EIKXXn7WF3U4Drs039fPTgsc5LvFMiN4TB1VA8KMWScjJ+xpqzhQnsdzEG5HOX2XSqlrmu4QDMnd/V+O4BNKohhexJVgR93dWoNnz9tKREvvqBTq02lwe7OcG9nq1dryQFy86MgIdchKdrMr0VSrFnTtHP53MXlc/cV8fQ+za7D56PWaeHpts35gZhdmyvqCoPrfZhVb3VyXWffbK7Da1o2v5iF8e5suftr2FqWBPfz4W9ga7kri66YVO6NKcl92VPWceY1DCpbrSh35twmsL869+7dj/Fl6azzTUsb/GbU5Na9vbtxaxOaJZY7Dvh/ffvuw2zw5++n8uDg4ODtx0/pq0/Tg4ODHH5HUbTWILeODXAY0J/dNR+3xaO6sGGUKIrQGU8N3cfmO4WY/t62Dze3iVy03a/kJdj70l6Cu8uNquqX2bPWuQR+Pclw1zUbhIEs8EqkFK+TYD+wVw79lb8gRLIxbb6VyTzYvwzcpQ/40wXhQ9OdzxpubV4GOk5ZTuEvT2645znhGXRlQ1J0EAYY+AiXPoEdg/1Ajj+z2AQhhE4UYO1mGvrAdvuXvpa9HBeETtUP9gO7HIIwcOEE1SfCRCwhNqtIJsHCD7itq+pL3ZXGP6r7j9AP3Ce7ZTfYdLF0z/VWPTV7WNRorTujStF5sHyl1l8kKxo3BcCo4Qxw2dxvJ9yAOa263YTVgjDghuXNUTYQTcmbYzpmEmaC8do3bYtkofmNx4R2RSrFrRq6SNPbNP0sx6e3Ykdo7Iwya2h9TerY0tWB26xyAJdpWOIV6359qyS01y2iqzjV10cs02lzTGtMWxnzcNPdz8aVM2dyo0XBqIrwCuatbwPj7XGaxSXeba7EcWtmFajVzIaLMLi4ejIXJJZ9f7GUPM7YxNh4JRJLJZh60ow/fTCTG+3uLsJgfvX05l/l9J4D8WZXz+5HvJFb31b+LWB9+mIRBunVsP6pujP8GwK7+2xR77GBzYlQZT0Yy2R+6uXW4qqKfjODenDj/bV4pxKmGogYS5kxKlYwARGz9mj0CNTLR6GNEsTLgVxpv5GRGdjeFYsZXBv3kbIoq4jTdey9IX/BChxKr+ADqme6HGuoJXx/2nY4ZsQoPp0yMMW7GtjYXWZlNE7hCr+LXaz9SoVi51yW2oMH9nnYXTJmMLECOPuq6N3m+a2BnUZ0sJ171KQOfIHNFS+Yvjt8fw1c4uGyb2/3u0ufOEvbB3l3+B4u0POJU/8gOLjChEctbVUhoI6Rc079JdtKts9tZBWzNlVpM1Q0XReRu7reJ6sAJVyvhSi0iULArVqlClnpuM7IACSSpQFXCHe3TbVhhW7hEaGoEHkoy+tw5RWYpGRa4h0CA0vW36bHWNb6AjwXNiUJnjNcQHcz/rtQEtKD1HjyWIFKjf4hN4i2zSmZoEsshDQlgHlVwqmi6pJdFExxcD2vRYFiFnWQquRqbaJ9m/zThzcuD0cjTN2vId8xS0hZINfgSqiyHHjKLU99RVGC1cHU6SbFcFX1QIe6M5oUTGkp4Jgk1ZQK/jfLwqiRwClrzFKa2apOVIA5HuPsgV9bwHhZ+8s//tmAa6OmuwqYHYEmCThHr4AQj5KW4UHTV6wACSjbEEF/TP1xeRMA6HDRnNq0LnYh6evz+HuMzdaVXHSuxcq1qcs4hYNFJW91WF1idWqlxrNpdftdFjBfdsG1adzs9vdtVuXDB3cNo4YB1RBY1cDzYt5c4LXLVS51h3fQeTvHQ7UNrqwFWhp5qljOxfX2qab9zshKEJRG5tTwmPiudNTO3GHdSn5d53WgAXDjOZfqyVrwDM/ZofzO7Sgv6VxfrVRAG9QEXCuS0DliBNP4tFQEdlFwNa8uS6HHymPyCk16DwUJTPZUipidcnEKSYeuoX42IjYAsDEzM8ZEE3OehHazrbMFzDCfU5NiSzdrWjgECHOmpuw0hhMUrgl2DRL3etBVr0f6FhAn8XWpnLXH5eRB0QZSru4dwHHZM6qLZbU60EyF1MjSVGQMrkGAhcH2D/gkCLlLKNEcoc7fpBlkWoCOK+8iJIuoh7ARAchKOJvX1kAQW2MT9AI5ZGCccNucvHSvbsxRyAPjR/cZLmByYPEhNJO42k26LgEGAvUaU4CkuDsi/cCebcfxeXkwpcUvf/9fDSqWi6PSEUxhYykGXtBMS3u9qdmrX2x+OVrb2cpqE9LwyfxUitNayq1lmHbLrQy0JoijrWgJt0fg4F7fAk4H7gBE2z0W/tFtUbdM382DAULuacC30rB98oFNqUqyak+zZDSY/Yo2GckOtYkbMCvIBrajxtA4ZZg1JGEF5M+SgjyCLdhuwI/qTCNATzBVMHGKptPrmFjcpr1oUPMoAAsrmk2TILT25eBkEQbjOL5tj7Cf/9H9xo06xE+j1reVBHrjOCaPIRFcQmKqxtJmNXuy71R1msA6RDVsSWtvEdUiH8VJS//ijUNKRKr/HBJtkNA6Y9R2i6Tf4O3ZAFO05WMIOcaAJzzxoCYoa6Nk27r1q5nHttm6XLBOZ+n6ikxBw8Hg/7Ol6+ng67F07Q6+IkvXCwDWOdWuliabTp9rZYd3Em5v8Fky63/IpNpeE3agRVi5NNchuF4Oo4X9rzbOeSF+hcHOWvRqZ58zNvnJIBpGgwH8syQEfVZRl0K1lVf1X4Lw+p7GKyR6nX11O74Ozl+8zwuRxylK8ioV6/ZWTWZr7Mc7tj2w3r97CHjyh/YYOdO6vWGsGcAlwTXb0dWkEhcZF+zUk+B0yaVryby7jiYfZc6sUj2DTX6mJGhj7nRh1JzQKRwPoBt1jyRiSl3FzDeDbBs2dgeD02GFhL1VJLwWeLUXs/keyjMmvuxMm8MbOzyAepFntUQJuK2E5UFrss3vdpKaxaXiZh7sH10GF31a8L4t3z86WZwAF5pUoutfaoSYmjTYD3ZWIgEwqTIoxkeXAa6Livk1FQlEx61IW1rwnfNhNAwW4XKbtdJ5S31W9m/aRBs65WJ6VbuTGkcfgY6WVC1M1epkwf/MQJ90hGjWCgMO/JMyCoYgQD2wx4c6fuKVJ7KPbFgXrFATczn8wEcftAIKlnfJNSECjQiBI++eR4975XAP6gkFlVM8CBpubvjRcFzDz0rXPqrZufL6elV4iDrkaHcXla3nQ9RKnr7ADX/32eLEIr/h5sHIoKavwp2Pm0Z396lthA6CJaNvy/K6bHjdaATdYAN1Qy7Z+tzXdSa24d4m49beWpuS62q9/cAVNg+n6w+a7px5/TNj46i2hp5eO2lTE8LzgJpPB0jN3QFS88WgpRg5GtQ91OoN6jCVCuMmUKspoIucwOrhYiJx6Tmeq5KSgmjEpbuizrIslnmVE7TX801++cc/q1a9XnWMtc4rsEm8KxUp5IypSWkTjU4ydoGZUqEZy7FMo/ELL5/RHCwXEDIjDJuiFQsvj4HjyLkmYlrQMc84yH57iQeNo43tw+aXxwuBc1k+UvZ63DnLYMuoLMKNXPVkJtXZBBLgg41kDNcGwX7CREpFbN0PVo6hGR2Oz3UqVm0UQM0tbFIYRWNDciroFO3gIWkiK2EZB2FPlByDd07LrLT+J0N5JpU1A+OEMHINkfjqooAi1MlBciiWwuo6d04oHVonoBVRLo36GPytBcDCwQBnJClFJiHjOfhtywwu3BnrSwXVvwkjNDeKCg36urM8OxpUCHP+IaadqeuTZkDhN1yc2dyufXJU8dWPbKy5Ye3UMcsS4km7zffc/KkcQ05vqbmRal63nnKTlmPcbJqdVD9sT9/77PyNreT6NzE/WpOZ3jl4/xqVlSfkl7//D3nDqBIklTPLrXGpWDZvPwRgKW/RVuka6IGkJSTBN8ikYuqd4h6DP6bUoN30LZuBgdouKRuNuPRgg4ZEVt+tfaDBp7qwV9fALUzdawck4+IsIgfuPYPa8Affsd0t3jM4bIzOcs2yc6YbdnCWcNN6xYC1gHGTa9/kg7kdJAkplm7zgZumBscartDLTa0FC54FWHMBsHXLrp3QmIkEL53qfZIoOjF1/+HqcwprPvmbgR4doeumIoldiUX7oKGthXtJDWrLW7Scw4C6/c5EwR07HXm2JO2cTDdna3voFYbGqIT7bZwWfK0jE9Lw63eTj0yd89if0zas6B2svBOEQcZj5k7gbv86+P79G3L+NBrABlopl9dY3DtvXn/36u3HVwAMCFKLsGE0iAZ4vJTa5FQ0RlpaO8t7WyPytnsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsb5cvhs3sbpXsb5cZppLq3UaqC7m2U7m2U4+5tlO5tlOPubZSHkQK0exulexvlXnS47m2U7m2U7m2U7m2U7m2Ur+jJie5tlC/Bgd3bKN3bKDdN0LliiureRuneRuneRuneRjnu3kbp3kbp3kbp3kbp3kY57t5G6Vw+3dso3dso3dso3dso3dso3dso3dso3dso3dsod3kbpZEHYafIKMdkKy4nkM2TcrT8YspJGKSQSGX/KLi8BJb8pLLFAj7/XGL+h6OTMDinikOEPuZgCX3KEMi8cMYg28Z39vpI/xDGDy2h8bbrUuoZyHliWxzg3LfWbeZ6ef/u4yGkjXCvuuQywZRRdAaZGujMptNopHPAb5dBRsW0xFQQge1zYRPgpu0UKWeYIsX90cgnAalEagjbuVPsNOD/MKm1DS4vbfqVxaKqb4s2tnCI9bWBfieLxeL/ACu5J6E=","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(57742),o=t.n(l),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const y={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:"eJztPWtz3DaSfwXHuirbsxxqZizZjrb2bpXYl/WtY7ts+VI5SavFkJghLBJgAFCjWdVU7Yf9B/fpvu5Pyy+56gbAx7z0jCNfMR9iDfFqdDcaje5G4zIwdKqD/aPgkOVFRg3TwUkYJEzHiheGSxHsB4cpI+/LccZj4muRg/evCc0yOdOk1ExpYiSJFYMi43siJqWGaKbOGaGajLOSFYoLo8lEKjJlgilquJiSRMZlzqBgxk1KCsUSNuGCJUQbVcamVExH5MeUCUKr7gnXRJdxzLSelFk2d8MnITGphU8xUyqhCSWl4D+XjPR6vvEpT3o9QkVCKOn1CpzcaamyXi8iMN32NxjK/s7mhOKQfJwxbJ/TORkzolOqWGLhp2KOSAkJE3ScwQxNynJAkZu0bar5VDTmPqaaJUQKhN8DGpE/yRk7h86anwk3mmUTElMhpAEAcpnwCWcJMamS5TQlJuWafPrw5veEG6hHpMgQ1BKGAQr4oS3muBQVVFxMo2NxLA55sU8+FZmkCZnLUpH3L/+jbmYkgW9Hvd5LNi6n5NPrXu/kcWpMofd3dmhRRLJgAvrL6FhHscx3EqhYJJMnIZmlTDHoFYFjVHNAbgI4TKbMaJywILEs5iSWUiVcAFOFpKBTRkSZj5nSoaWBVIxwYA7FaDLvG9kvNSP/+fHdW5hoTk1E3melDqvhEq5YbIBpoHvArJ/VI0uIZ7vAe1xMQ5LTMyAhN+TnksdnMG3NRAL/Ok5DXPV6H8uikMqwhPxop7Df60HJtyyTM0IVw/qxzHMpSEEVzZnBpQPLBIoV+7nkNRtlmcfF/rHok15P0Jzt93rkk2VnnjBhgOgKyYkEtw0iW9/MC6z/WiQ8diuSEfhK5KRdFZAKVT8WLIYubdUGqoExZymPU8ThjFr6FxmN7bQU0wWLDT9n7Y4vQjKHjl8yIT0EqVT8b1IYmiH5zpkyPKZZk8wAIFTVhiqUEYXkwvivbgTykyMnUBuJ6PgQQEsAuTkXWKIZOadZybSDahaSFKD6wArFNC4/1y+u34SkjE/TjePR5HOpTatjUmq30Cso3Fieqohehmib0EwzwictXOb0jDVGIxLlL80i8u2cJGxCy8yEhAOHGlWyiLyVhtCiyHhMQRoBD8BioyAv+0hlxz5Rm33eK3nOEwaCMeGTCVOwmKEQu3BtPHTAlwU2gOnhSjMpSpMlQscyk2qVhfBzG48klsIwYSJycE55hsDbyWrCRZyVCSPjjMZnIe4ZIVEg1YEqcwZbTmjXB1aBjcXiHPFDNMuAC6UA+IV0w8NW4aBKQMCDPPfrDwo9qnEQrptYdat8ImFkQIFfkoTllGchIi4kn+WYGG4yFsICL6iYhyShhoXEsAszlhchiVMWn+FfiiZcknFpjBR2YomSRSJnwuFyIoXR/G9rVqQvuTlGRyHZDcmzkLwIyXAQkuEoJMPdkAyfhWT4IiSjQUhGo5CMdkMyembBGr1wuKYVgpsADEcWy+brwm7KE3YKDU9hbqdUG6a4PgNxbZUM3La9JgEV/a4My4sl9Q7INUl5kjBBJkrmRLGYFxyliZUGVdchwEMUTEpoYvWVc261CIeDqlM5E4A3HJEr8q5g4iNoCjSOZQk0RgxbpCI6a5LDDi8FOWQ01zjzV8IwVSiuGYhqoSsMCFPzlt0A4VtTAFyHkqItgTZTcxN1GpSBHfQN1yhzYevT1W46a+2mw4j0epWcg29//etfj8XlsSDkOACxdxzsk+OgqnIchLYMdjMoG7rfF/Dj6ei5+zmHn89GL9zPGVYd7rqfKfwc+aZuccE3HBhrcGHs0E7AkgYIUGlxLBYO2mMxwmkYmhdbpgDFXwp8v03BR9hfQl8AS3AVng0ztjVWZvsUZssFN5xmevOEfY0HNOclkNZPu660MvNdmDkKs83TxuIHNOcmPFCCm6gtwk23UeS3A4RitAVFy31uEsLQCtWjFUzuRU6H2YxIO4UHg8cGOPeFxqUub47FZ4BF2E8PYT/djMpqy31A+FyG6b6Quq7fm2P2eYRaMKonm/HqKjwgrLYhui+crvZ6c4y+AIyCnrcZnVD6gHDZAAcKnNJsywa7/eFefzQY7bbwCeYJWyHP+0nSn8/nd6NFzsWphQMaNern9GJ9AVhNQHesKFGVOGNQ1axdukp1W2+JkKBxOkyA0unPn1brBWMWKs+rxgU8+9e13IkH//YH8h/gGD72J1SWOLW5Po9U9p/mGdrIhM4faduVb1odvaD+snJswcQigANtYXEqeeyAhzr+wDUGc08EOOgjUXeSZKdBVPiYJP087y99hJ995IHGxzyPkiRaqrnCKPZjTpIkJKuf135PEpLn+YbP9nvr806er84iynMHm8Oe570VOudc8LyEIxKY1ewJPUH75qFHb+5oyQXp9X766aef+j/80H/5stfzNHRDOC5uWDLsCPTinkZoMn2vt09eT0jzE1oTrB0HpUB1MkRTtq+QypnwByI8NiqSlGBQrAysaE0C8zF0xrhJmWqPAyZaz7JwfERLrzRpRD7h6RL+9qew6rSEJ6lvIrR149F4s+x0Fb6U+KylZHvgraJ1s2hqydYVtcgLpmK93qTYtMyoYhdg/tNcihWZeJs98Gb725JY9Lxcm1rQsOhMu8xbOsjjd+4Q/qSyLy7NBXo7IHGpDdokpuyCFNQYpgR2dk4znlh7fx8/sAuaF2Bb2fnL8XHyu3/dQcsuGE+NNSkkfMrBIL/zl6OD/n+frKlRFgVTMdWMZAxG0iFhJo7IUcqyovYJzGazaPZUx6mUmXUIfNaKTez/T+X48ymCW0RUF0/WzdQyQ8OSCsyybEjFxdnAGNXEt1xjS0XS4KoZDlCDc6aKLSqcq/GA9I4lkKDQmqWh+Ai2flRugXlZ/bcEmXMcnNTbPVpPWXJF25NrLE9YDRkds2y16OZLK6NzWboV7b0F7ak6jm7gzalClUEYpzMIG4X0YqnQli3WrFOLkOYy9bu9X56eAiTjutpIWuhstnY+A/T8CMbQmQReRNeAjCsuvfMqqAC73jLwBlKk3RVDQD2CFSt/jR/tihFahFnZyZ2u4B1Pk6pXjzK/kTfxBS3B61qrCVtGcLrC5hHAy7N5gGMxRDOkN19uOZ+4Gg9IViyBtH0Z30aKtHbm22ypt1qAflrNBbhme4WqdmOtFp/evPoi8s7a1H0jsLfHMStA07rz0qxAvvYOhVbjpgl9M+c1az0g7lsD1q/Mga7efe8+t2LS5uy/IkZtgX1tZrVG/5xOt9hvsPgBsaeDZ8UUNUQ7vt0vttifsXz7dIaD1nT22tN5NrjFeao17N2PU4Pq4xr78/JQcHIuM7oi7BMW85xmGCCCcI/usAJvc7RygAGHfyfzojTNJYVGGxQbXgfwYQ/Wcfu7kPRD0gvJTkgeh+RJRD4wDJSIq6AKpxJwZUMnOIRyleAFjUsFgVYKJh4SFk0jcnn5c0mF4Wa+WJAeubyEGLDFIoI1dibkzMZVHIFH2BCIi6qPTImM9Zo4KhnrHThb7bxls/5L5zrecaA9IY/l0oLfetB0KPiy5y0LVYNJYJS3lUJmz5wYyMN1kdE5oRPwQttgD2xmY4IiQPE+GZE//BsZjqLBICQD+zd57Cc4eoJrGD1IMcu2uSCx+KoVPGiu4PrnOoG0N7jWEm4Oe8sVDF2cYogAjnulOlYv7gdoGKkns2yKbejsgDMXZJrKMktgb7RBn6wKz6s09l7vvWITnmWN6DziP/k1DdFOLGO5iwhzcXlwWMFIBC6MhHXjQzV6vTGbSIhCgPBANPs1wkDt2HZjbkV4YLylVCSl2lpRENMAMcQ/QqzoUjyEB6+OieDCww6sPLw/e9/omzZzP9trMfdee3/ayNybOHiLGRCa6EIKXXn7WF3U4Drs039fPTgsc5LvFMiN4TB1VA8KMWScjJ+xpqzhQnsdzEG5HOX2XSqlrmu4QDMnd/V+O4BNKohhexJVgR93dWoNnz9tKREvvqBTq02lwe7OcG9nq1dryQFy86MgIdchKdrMr0VSrFnTtHP53MXlc/cV8fQ+za7D56PWaeHpts35gZhdmyvqCoPrfZhVb3VyXWffbK7Da1o2v5iF8e5suftr2FqWBPfz4W9ga7kri66YVO6NKcl92VPWceY1DCpbrSh35twmsL869+7dj/Fl6azzTUsb/GbU5Na9vbtxaxOaJZY7Dvh/ffvuw2zw5++n8uDg4ODtx0/pq0/Tg4ODHH5HUbTWILeODXAY0J/dNR+3xaO6sGGUKIrQGU8N3cfmO4WY/t62Dze3iVy03a/kJdj70l6Cu8uNquqX2bPWuQR+Pclw1zUbhIEs8EqkFK+TYD+wVw79lb8gRLIxbb6VyTzYvwzcpQ/40wXhQ9OdzxpubV4GOk5ZTuEvT2645znhGXRlQ1J0EAYY+AiXPoEdg/1Ajj+z2AQhhE4UYO1mGvrAdvuXvpa9HBeETtUP9gO7HIIwcOEE1SfCRCwhNqtIJsHCD7itq+pL3ZXGP6r7j9AP3Ce7ZTfYdLF0z/VWPTV7WNRorTujStF5sHyl1l8kKxo3BcCo4Qxw2dxvJ9yAOa263YTVgjDghuXNUTYQTcmbYzpmEmaC8do3bYtkofmNx4R2RSrFrRq6SNPbNP0sx6e3Ykdo7Iwya2h9TerY0tWB26xyAJdpWOIV6359qyS01y2iqzjV10cs02lzTGtMWxnzcNPdz8aVM2dyo0XBqIrwCuatbwPj7XGaxSXeba7EcWtmFajVzIaLMLi4ejIXJJZ9f7GUPM7YxNh4JRJLJZh60ow/fTCTG+3uLsJgfvX05l/l9J4D8WZXz+5HvJFb31b+LWB9+mIRBunVsP6pujP8GwK7+2xR77GBzYlQZT0Yy2R+6uXW4qqKfjODenDj/bV4pxKmGogYS5kxKlYwARGz9mj0CNTLR6GNEsTLgVxpv5GRGdjeFYsZXBv3kbIoq4jTdey9IX/BChxKr+ADqme6HGuoJXx/2nY4ZsQoPp0yMMW7GtjYXWZlNE7hCr+LXaz9SoVi51yW2oMH9nnYXTJmMLECOPuq6N3m+a2BnUZ0sJ171KQOfIHNFS+Yvjt8fw1c4uGyb2/3u0ufOEvbB3l3+B4u0POJU/8gOLjChEctbVUhoI6Rc079JdtKts9tZBWzNlVpM1Q0XReRu7reJ6sAJVyvhSi0iULArVqlClnpuM7IACSSpQFXCHe3TbVhhW7hEaGoEHkoy+tw5RWYpGRa4h0CA0vW36bHWNb6AjwXNiUJnjNcQHcz/rtQEtKD1HjyWIFKjf4hN4i2zSmZoEsshDQlgHlVwqmi6pJdFExxcD2vRYFiFnWQquRqbaJ9m/zThzcuD0cjTN2vId8xS0hZINfgSqiyHHjKLU99RVGC1cHU6SbFcFX1QIe6M5oUTGkp4Jgk1ZQK/jfLwqiRwClrzFKa2apOVIA5HuPsgV9bwHhZ+8s//tmAa6OmuwqYHYEmCThHr4AQj5KW4UHTV6wACSjbEEF/TP1xeRMA6HDRnNq0LnYh6evz+HuMzdaVXHSuxcq1qcs4hYNFJW91WF1idWqlxrNpdftdFjBfdsG1adzs9vdtVuXDB3cNo4YB1RBY1cDzYt5c4LXLVS51h3fQeTvHQ7UNrqwFWhp5qljOxfX2qab9zshKEJRG5tTwmPiudNTO3GHdSn5d53WgAXDjOZfqyVrwDM/ZofzO7Sgv6VxfrVRAG9QEXCuS0DliBNP4tFQEdlFwNa8uS6HHymPyCk16DwUJTPZUipidcnEKSYeuoX42IjYAsDEzM8ZEE3OehHazrbMFzDCfU5NiSzdrWjgECHOmpuw0hhMUrgl2DRL3etBVr0f6FhAn8XWpnLXH5eRB0QZSru4dwHHZM6qLZbU60EyF1MjSVGQMrkGAhcH2D/gkCLlLKNEcoc7fpBlkWoCOK+8iJIuoh7ARAchKOJvX1kAQW2MT9AI5ZGCccNucvHSvbsxRyAPjR/cZLmByYPEhNJO42k26LgEGAvUaU4CkuDsi/cCebcfxeXkwpcUvf/9fDSqWi6PSEUxhYykGXtBMS3u9qdmrX2x+OVrb2cpqE9LwyfxUitNayq1lmHbLrQy0JoijrWgJt0fg4F7fAk4H7gBE2z0W/tFtUbdM382DAULuacC30rB98oFNqUqyak+zZDSY/Yo2GckOtYkbMCvIBrajxtA4ZZg1JGEF5M+SgjyCLdhuwI/qTCNATzBVMHGKptPrmFjcpr1oUPMoAAsrmk2TILT25eBkEQbjOL5tj7Cf/9H9xo06xE+j1reVBHrjOCaPIRFcQmKqxtJmNXuy71R1msA6RDVsSWtvEdUiH8VJS//ijUNKRKr/HBJtkNA6Y9R2i6Tf4O3ZAFO05WMIOcaAJzzxoCYoa6Nk27r1q5nHttm6XLBOZ+n6ikxBw8Hg/7Ol6+ng67F07Q6+IkvXCwDWOdWuliabTp9rZYd3Em5v8Fky63/IpNpeE3agRVi5NNchuF4Oo4X9rzbOeSF+hcHOWvRqZ58zNvnJIBpGgwH8syQEfVZRl0K1lVf1X4Lw+p7GKyR6nX11O74Ozl+8zwuRxylK8ioV6/ZWTWZr7Mc7tj2w3r97CHjyh/YYOdO6vWGsGcAlwTXb0dWkEhcZF+zUk+B0yaVryby7jiYfZc6sUj2DTX6mJGhj7nRh1JzQKRwPoBt1jyRiSl3FzDeDbBs2dgeD02GFhL1VJLwWeLUXs/keyjMmvuxMm8MbOzyAepFntUQJuK2E5UFrss3vdpKaxaXiZh7sH10GF31a8L4t3z86WZwAF5pUoutfaoSYmjTYD3ZWIgEwqTIoxkeXAa6Livk1FQlEx61IW1rwnfNhNAwW4XKbtdJ5S31W9m/aRBs65WJ6VbuTGkcfgY6WVC1M1epkwf/MQJ90hGjWCgMO/JMyCoYgQD2wx4c6fuKVJ7KPbFgXrFATczn8wEcftAIKlnfJNSECjQiBI++eR4975XAP6gkFlVM8CBpubvjRcFzDz0rXPqrZufL6elV4iDrkaHcXla3nQ9RKnr7ADX/32eLEIr/h5sHIoKavwp2Pm0Z396lthA6CJaNvy/K6bHjdaATdYAN1Qy7Z+tzXdSa24d4m49beWpuS62q9/cAVNg+n6w+a7px5/TNj46i2hp5eO2lTE8LzgJpPB0jN3QFS88WgpRg5GtQ91OoN6jCVCuMmUKspoIucwOrhYiJx6Tmeq5KSgmjEpbuizrIslnmVE7TX801++cc/q1a9XnWMtc4rsEm8KxUp5IypSWkTjU4ydoGZUqEZy7FMo/ELL5/RHCwXEDIjDJuiFQsvj4HjyLkmYlrQMc84yH57iQeNo43tw+aXxwuBc1k+UvZ63DnLYMuoLMKNXPVkJtXZBBLgg41kDNcGwX7CREpFbN0PVo6hGR2Oz3UqVm0UQM0tbFIYRWNDciroFO3gIWkiK2EZB2FPlByDd07LrLT+J0N5JpU1A+OEMHINkfjqooAi1MlBciiWwuo6d04oHVonoBVRLo36GPytBcDCwQBnJClFJiHjOfhtywwu3BnrSwXVvwkjNDeKCg36urM8OxpUCHP+IaadqeuTZkDhN1yc2dyufXJU8dWPbKy5Ye3UMcsS4km7zffc/KkcQ05vqbmRal63nnKTlmPcbJqdVD9sT9/77PyNreT6NzE/WpOZ3jl4/xqVlSfkl7//D3nDqBIklTPLrXGpWDZvPwRgKW/RVuka6IGkJSTBN8ikYuqd4h6DP6bUoN30LZuBgdouKRuNuPRgg4ZEVt+tfaDBp7qwV9fALUzdawck4+IsIgfuPYPa8Affsd0t3jM4bIzOcs2yc6YbdnCWcNN6xYC1gHGTa9/kg7kdJAkplm7zgZumBscartDLTa0FC54FWHMBsHXLrp3QmIkEL53qfZIoOjF1/+HqcwprPvmbgR4doeumIoldiUX7oKGthXtJDWrLW7Scw4C6/c5EwR07HXm2JO2cTDdna3voFYbGqIT7bZwWfK0jE9Lw63eTj0yd89if0zas6B2svBOEQcZj5k7gbv86+P79G3L+NBrABlopl9dY3DtvXn/36u3HVwAMCFKLsGE0iAZ4vJTa5FQ0RlpaO8t7WyPytnsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsb5cvhs3sbpXsb5cZppLq3UaqC7m2U7m2U4+5tlO5tlOPubZSHkQK0exulexvlXnS47m2U7m2U7m2U7m2U7m2Ur+jJie5tlC/Bgd3bKN3bKDdN0LliiureRuneRuneRuneRjnu3kbp3kbp3kbp3kbp3kY57t5G6Vw+3dso3dso3dso3dso3dso3dso3dso3dso3dsod3kbpZEHYafIKMdkKy4nkM2TcrT8YspJGKSQSGX/KLi8BJb8pLLFAj7/XGL+h6OTMDinikOEPuZgCX3KEMi8cMYg28Z39vpI/xDGDy2h8bbrUuoZyHliWxzg3LfWbeZ6ef/u4yGkjXCvuuQywZRRdAaZGujMptNopHPAb5dBRsW0xFQQge1zYRPgpu0UKWeYIsX90cgnAalEagjbuVPsNOD/MKm1DS4vbfqVxaKqb4s2tnCI9bWBfieLxeL/ACu5J6E=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,b={},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:"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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options": {\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(71591)}),"\n",(0,i.jsx)(u(),{...t(94633)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},71591(e){e.exports=JSON.parse('{"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"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":true}}')},94633(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/138cee78.73c2d6cf.js b/assets/js/138cee78.09d89b2c.js similarity index 63% rename from assets/js/138cee78.73c2d6cf.js rename to assets/js/138cee78.09d89b2c.js index 2794b1da9..60471a3dc 100644 --- a/assets/js/138cee78.73c2d6cf.js +++ b/assets/js/138cee78.09d89b2c.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1679],{14988(e,t,a){a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>x,default:()=>Z,frontMatter:()=>b,metadata:()=>n,toc:()=>j});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//eyc1Gu2QaWyF8Qf9Qb9vHFizJDdvFKAuYK5oJTNFUYzqeLZDyZ6w7jCy1IFKxyC0kKUMqCIi5jmWo8VMKskdxGymxceDJvRjuKkoVBSh8x8dAUJBC8V9B9gEU2NgTb25sDTucc5wPQGErPFSk/dAukKdM2NfDQkYB6iBdCBnnfQEPjg2WramGR0cj58aNZbEuhMYxqogJbllwJms8QG8UU20GHjrGEcF9P5oosLHGL5ZWT4CpnKOHVWc3gVB2ciCfAK5KQh8LBB2QReQkQ9g2RaZk2eljVYmf4z5Y7gG1vD4kqjAzA9sZPHgUHvGBK0tfQp2AbPOMO6j1sDR6AdPnOB3Uj/6dDT6oE/gdldWN5R5GejuT30bLpfLJ+331aHMWxn+1mTwPVnjZTBuvZcuZaiaLLbsUMnuj1bTW9IUy2fQkHsdhcn90wnA1ElFyk6uKHCF+Mn55UWc+F/Bx5/+Ce8InYbKLNtizRtHag1lfxVHrs18G7bdwI6vOGxCxRHP2+LrnmZ9BG8qDB9/+peH72gJUncdxa6MRpdNpmQO11Rb3tN+NEr7F2foafsHZEbgK+RSWkgEBNtKK6kfx3Cu19B4crCUoYrFwPQod+AGx2X/0IQMPRVgdJTo7xzvLWJ67UktyLMubQKbQYXkR0KonGnK9rahMZ1zjuZSKbiRRUkh+nZeFGA78rIlc8AH5tCcGyJUtAZ0BJ50GMPlkUg8aSw/m6ngmMbaN/wu5wSQLqyROvgUCofzwbs62Rd6XHnS6GdIbQhxF46kU7NLSduJncc76vgDj+WjZXI4bh3NyfGF0e19Xqzsyum2L0vgav0tZd2+LdqFzmikWzpo5bfHeiKqIFf79/MrcguZU7dZP9HRk8g8EYlQMifth2vu/O3lO1icjaciGazoX9Hck3cXr998d/WGjeFB2gZsNp6Op/GlZXyoUQ9uOvwyc7zZNnsY91/+jtPBiUCrMLEKZQRxMTSbDn/dHn3duUtExfgsvRWbDTfoD05tt0z+sSHH4O4uEQt0EjNe87d326SHIgzYHmnd4WXS4eSar2d21bSo5gjRMpZqJc7znGz4LO8QQl6+v7oWici6L1C1KVjG4ZK/TuFSpCJ+xIpLMH4/YtpGKNRlg2WERFEnoyeeoIfQ6zFCr+4He9Uf6fXAwkNM1rrB/7NTzwpsNi2s2253/O3RJyW6wPbcnL677Xb7H5GrDpQ=","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),s=a(28453),c=a(57742),r=a.n(c),i=a(78178),p=a.n(i),l=a(19624),d=a.n(l),g=a(96226),m=a.n(g),u=(a(77675),a(19365),a(51107)),f=a(21312);const b={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//eyc1Gu2QaWyF8Qf9Qb9vHFizJDdvFKAuYK5oJTNFUYzqeLZDyZ6w7jCy1IFKxyC0kKUMqCIi5jmWo8VMKskdxGymxceDJvRjuKkoVBSh8x8dAUJBC8V9B9gEU2NgTb25sDTucc5wPQGErPFSk/dAukKdM2NfDQkYB6iBdCBnnfQEPjg2WramGR0cj58aNZbEuhMYxqogJbllwJms8QG8UU20GHjrGEcF9P5oosLHGL5ZWT4CpnKOHVWc3gVB2ciCfAK5KQh8LBB2QReQkQ9g2RaZk2eljVYmf4z5Y7gG1vD4kqjAzA9sZPHgUHvGBK0tfQp2AbPOMO6j1sDR6AdPnOB3Uj/6dDT6oE/gdldWN5R5GejuT30bLpfLJ+331aHMWxn+1mTwPVnjZTBuvZcuZaiaLLbsUMnuj1bTW9IUy2fQkHsdhcn90wnA1ElFyk6uKHCF+Mn55UWc+F/Bx5/+Ce8InYbKLNtizRtHag1lfxVHrs18G7bdwI6vOGxCxRHP2+LrnmZ9BG8qDB9/+peH72gJUncdxa6MRpdNpmQO11Rb3tN+NEr7F2foafsHZEbgK+RSWkgEBNtKK6kfx3Cu19B4crCUoYrFwPQod+AGx2X/0IQMPRVgdJTo7xzvLWJ67UktyLMubQKbQYXkR0KonGnK9rahMZ1zjuZSKbiRRUkh+nZeFGA78rIlc8AH5tCcGyJUtAZ0BJ50GMPlkUg8aSw/m6ngmMbaN/wu5wSQLqyROvgUCofzwbs62Rd6XHnS6GdIbQhxF46kU7NLSduJncc76vgDj+WjZXI4bh3NyfGF0e19Xqzsyum2L0vgav0tZd2+LdqFzmikWzpo5bfHeiKqIFf79/MrcguZU7dZP9HRk8g8EYlQMifth2vu/O3lO1icjaciGazoX9Hck3cXr998d/WGjeFB2gZsNp6Op/GlZXyoUQ9uOvwyc7zZNnsY91/+jtPBiUCrMLEKZQRxMTSbDn/dHn3duUtExfgsvRWbDTfoD05tt0z+sSHH4O4uEQt0EjNe87d326SHIgzYHmnd4WXS4eSar2d21bSo5gjRMpZqJc7znGz4LO8QQl6+v7oWici6L1C1KVjG4ZK/TuFSpCJ+xIpLMH4/YtpGKNRlg2WERFEnoyeeoIfQ6zFCr+4He9Uf6fXAwkNM1rrB/7NTzwpsNi2s2253/O3RJyW6wPbcnL677Xb7H5GrDpQ=",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={},j=[];function N(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(r(),{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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(p(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{...a(62464)}),"\n",(0,o.jsx)(m(),{...a(36906)})]})}function Z(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(N,{...e})}):N(e)}},62464(e){e.exports=JSON.parse('{"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":true}}')},36906(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1679],{14988(e,t,a){a.r(t),a.d(t,{assets:()=>b,contentTitle:()=>y,default:()=>J,frontMatter:()=>g,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 r=a(74848),o=a(28453),s=a(57742),i=a.n(s),c=a(78178),p=a.n(c),l=a(19624),d=a.n(l),m=a(96226),u=a.n(m),x=(a(77675),a(19365),a(51107)),f=a(21312);const g={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},y=void 0,b={},P=[];function X(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,r.jsx)(i(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,r.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,r.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,r.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,r.jsx)(p(),{parameters:void 0}),"\n",(0,r.jsx)(d(),{...a(62464)}),"\n",(0,r.jsx)(u(),{...a(36906)})]})}function J(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(X,{...e})}):X(e)}},62464(e){e.exports=JSON.parse('{"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":true}}')},36906(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/18b84479.7a9128dc.js b/assets/js/18b84479.7a9128dc.js new file mode 100644 index 000000000..dd4119354 --- /dev/null +++ b/assets/js/18b84479.7a9128dc.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1706],{23342(e,t,n){n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>f,default:()=>k,frontMatter:()=>P,metadata:()=>s,toc:()=>M});const s=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 d=n(74848),o=n(28453),i=n(57742),c=n.n(i),a=n(78178),r=n.n(a),l=n(19624),u=n.n(l),p=n(96226),m=n.n(p),h=(n(77675),n(19365),n(51107)),j=n(21312);const P={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnejDEx1sgYsQMD62kYlFiSGFMkQ1LdbjQE5JA3yCnXfbR5kkVRP622PZMMdjcXu1Ws36+KVcUdC7z0LL1jb0ze1KiDZ6uECfS5kzZIo1nKbiqEN6gwIIieC86uLoArZTYetqaBYMBhbdYI3mIuC5nvWQtnamJyI8nPWcKMRcfJwoVgKRNR/8DAEma54zUGdOTdjmleI7H1DPdSsIRJ8s7yULGnLl85s5YCwWQ/Yh4uBJhi71Aw0JljCXP4UyMdCpYG12DCfNgqMuRlbRUx4KNVRiBLC648MeQV1pylOxa2NnIGJ3XJElYYV/MwpeAjj1pSZquTrDrhXrC2XZFVb4326EnPyXJJ/w4DGNLReyrAN3mO3heNUtu/sITlRgdCKt0xbq2SecRy8aMn8d1zNzskCFhHyAfZGR8Aeimgvfv/eCTn7bf2NWuTIVdn4dNCJ8uT10fHy6Pl326Ov0pP/55++dV8uVz+iyXssVYkOySVByS9QQa1/26fsXU5mzL2lJaYT1+C8drUGCqpS9gQmBtndJmAVcg9QnBb4CWXGhQP6P6HqKJzxn0anc/zrJ1ELbWSGu+HGro/XS7vj0cQTj9RS9oEKEyjxZ8b6kv2Px3Q6f3rMaAvnwd0oddcSRGb0I15QP3nxjM1Hzrzz6tVdkzxnB0EO6V3QXrMGyfDNna6xyNu5VF3nt6tqF1QpZh9l4zdMVQsZYuhpy12k87YMlLp1kPvbJxiKatCsD5dLDzXIjOPc2NRe1lqxTM/z0294FYu1sfzY9YmT2W4tZ/Fj83R54r4wEupy9+TW+3RuqaMdkk7wGxMHbfyn7hlyZCSKVc/PCrkAl1Mn9SFicJ9ot5Z1Ney1DHN0fjTIXOLKjc10jwJFcJsNoh8+OXfo9RsNg6eWJDz9/q9ftc4sGaDrmgUcC2gUPgoM4VRDOt4Nk5Wj7xW6L3agtQBS8dpEstSBq6AcKIuknPLM6kk1TGxmW7kTq6Cn8NthaFCR0d/dQgcBK5RUfkDb4KpeSBV46DcGPdQ0IxPgEPWeKnRe0BdcZ0T45CJBIwDrgF1QGed9Ag+OPJadr4ZHRzPA9Rc8xJJdwJTsAQqSeUKzmSND+CNaqLLELhUxqGAISCNKHwE8Zwms0Mgam5q67CislkjlI0U6BPIjUDw8dpSCFpAhj6AJV9kjp6UNlqZ/CEmkGYrWENdRHJFK8PURxIPjmtPc77fZ/ocjIBZZ2hIY+fgbPaDR8rwpdQPPp3N3usjuBvr6hYzLwOuvhiuwGazeVb6rw5l3srwbZPB92iNl8G47V66lKFqsnhdpkrGj07TW9QY62dyGfY6hMn989tH1EWFyi6uMVCF+MXZ1UVsvK/gw8+/wiVyp6Eym65a88ah2kI5mCLkusx3sI19EwoTC68ixPOu+GghQx8GBG8rHj78/JuH73ADUvdXikKZza6aTMkcbrC2NCb9bJbCNw7JZBhoECoeIOcaMgRfcSqlteTAwXbSSuqHOZzpLTQeHWxkqGIxED3KHYRBuOzXWMi4RwFGR4nB5nzvEdFrj2qNnnTR/MsQUEja6ELlTFN21qbO9ME5LKRScCtFiSHGdiYE2J686chxl927gwVdiFDhFrhD8KjDHK6eiMSTxlrjyAvZOV8YWuYpAaiFNVIHn4JwvAh7/cm+0HOCWRr9AqmDkI9wJL2aMSXdTewjHqnz99SUnzTyw37rsMD4iIhh7/NiZV9Od0NZAlXrf1PWNLGpa/E8LhRYc6m6ifL1Uz1xuKOr/bviGt1a5thPtY/c6EVkXrCEKZmj9jhZGs7eXl3C+vV8yZLJePwDl3txefHN+XfX5+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},f=void 0,x={},M=[];function I(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,d.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,d.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,d.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,d.jsx)(j.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,d.jsx)(r(),{...n(58788)}),"\n",(0,d.jsx)(u(),{...n(77902)}),"\n",(0,d.jsx)(m(),{...n(61668)})]})}function k(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(I,{...e})}):I(e)}},58788(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},77902(e){e.exports={title:"Body"}},61668(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/18b84479.8e5b964f.js b/assets/js/18b84479.8e5b964f.js deleted file mode 100644 index bbc54890b..000000000 --- a/assets/js/18b84479.8e5b964f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1706],{23342(e,t,o){o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>b,default:()=>N,frontMatter:()=>j,metadata:()=>n,toc:()=>f});const n=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/dQgcBK4VVT/wJpiaB9I0zsmNcQ8FjfgEOGSNlxq9B9QV1zkxDolIwDjgGlAHdNZJj+CDI6dl55rRwfE8QM01L5F0JzDFSqCSVK3gTNb4AN6oJnoMgUtlHAoY4tGIwkcMz2kwOwSi5qa2DiuqmjVC2UiBPoHcCAQfby2FoAVk6ANY8kXm6Elpo5XJH2L+aLSCNdREJFe0MUx9JPHguPY05vt1pk/BCJh1hmY0dg7OZj94pARfSv3g09nsvT6Cu7GsbjHzMuDqi+EGbDabZ5X/6lDmrQzfNhl8j9Z4GYzb7qVLGaomi7dlqmT86DS9RY2xfCZ3Ya9DmNw/v3xEXVSo7OIaA1WIX5xdXcS++wo+/PwrXCJ3Giqz6Yo1bxyqLZSDKUKuy3wH29g2oTCx8CpCPO+Kj/Yx9GFA8Lbi4cPPv3n4DjcgdX+jKJTZ7KrJlMzhBmtLU9LPZil845BMhoEGoeIBcq4hQ/AVp1JaSw4cbCetpH6Yw5neQuPRwUaGKhYD0aPcQRiEy36LhYx7FGB0lBhszvceEb32qNboSReNvwwBhaSFLlTONGVnbepMH5zDQioFt1KUGGJsZ0KA7cmbjhxX2b07WNCFCBVugTsEjzrM4eqJSDxprDWOvJCd84WhXZ4SgFpYI3XwKQjHi7DXn+wLPSeYpdEvkDoI+QhH0qsZU9LdxD7ikTp/Tz35SR8/bLcOC4xviBj2Pi9W9uV0N5QlULX+N2VNA5u6Fs/jPoE1l6obKF8/1RNnO7ravyuu0a1ljv1Q+8iNXkTmBUuYkjlqj5Od4ezt1SWsX8+XLJlMxz9wuReXF9+cf3d9Ts5QI+0AO54v50siWeNDzfXEUv+ce7N/bx1gvdtvU/+n118/ogM+hoVVXMYdKca865ebOzZ5DabTh98qYZXxgVh2O7qDPzjVtkT+qUFHW9QqYWvuJM9okt/tmJCefovxFffRaL/4vn8QvoI//IZ8MZZhB9G0gKy5auiLJewBt0/ese2qTYZFhJztOM7yHG2YyD5bag82wzfnl+c35yxh1E8Pd6CHuAP1P8jAi64dLkedD/SXNrUXBXa7br9q25G/O/qoRB/jwE04rdq2/Q8twc84","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 d=o(74848),s=o(28453),i=o(57742),c=o.n(i),l=o(78178),a=o.n(l),r=o(19624),u=o.n(r),p=o(96226),m=o.n(p),D=(o(77675),o(19365),o(51107)),h=o(21312);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/dQgcBK4VVT/wJpiaB9I0zsmNcQ8FjfgEOGSNlxq9B9QV1zkxDolIwDjgGlAHdNZJj+CDI6dl55rRwfE8QM01L5F0JzDFSqCSVK3gTNb4AN6oJnoMgUtlHAoY4tGIwkcMz2kwOwSi5qa2DiuqmjVC2UiBPoHcCAQfby2FoAVk6ANY8kXm6Elpo5XJH2L+aLSCNdREJFe0MUx9JPHguPY05vt1pk/BCJh1hmY0dg7OZj94pARfSv3g09nsvT6Cu7GsbjHzMuDqi+EGbDabZ5X/6lDmrQzfNhl8j9Z4GYzb7qVLGaomi7dlqmT86DS9RY2xfCZ3Ya9DmNw/v3xEXVSo7OIaA1WIX5xdXcS++wo+/PwrXCJ3Giqz6Yo1bxyqLZSDKUKuy3wH29g2oTCx8CpCPO+Kj/Yx9GFA8Lbi4cPPv3n4DjcgdX+jKJTZ7KrJlMzhBmtLU9LPZil845BMhoEGoeIBcq4hQ/AVp1JaSw4cbCetpH6Yw5neQuPRwUaGKhYD0aPcQRiEy36LhYx7FGB0lBhszvceEb32qNboSReNvwwBhaSFLlTONGVnbepMH5zDQioFt1KUGGJsZ0KA7cmbjhxX2b07WNCFCBVugTsEjzrM4eqJSDxprDWOvJCd84WhXZ4SgFpYI3XwKQjHi7DXn+wLPSeYpdEvkDoI+QhH0qsZU9LdxD7ikTp/Tz35SR8/bLcOC4xviBj2Pi9W9uV0N5QlULX+N2VNA5u6Fs/jPoE1l6obKF8/1RNnO7ravyuu0a1ljv1Q+8iNXkTmBUuYkjlqj5Od4ezt1SWsX8+XLJlMxz9wuReXF9+cf3d9Ts5QI+0AO54v50siWeNDzfXEUv+ce7N/bx1gvdtvU/+n118/ogM+hoVVXMYdKca865ebOzZ5DabTh98qYZXxgVh2O7qDPzjVtkT+qUFHW9QqYWvuJM9okt/tmJCefovxFffRaL/4vn8QvoI//IZ8MZZhB9G0gKy5auiLJewBt0/ese2qTYZFhJztOM7yHG2YyD5bag82wzfnl+c35yxh1E8Pd6CHuAP1P8jAi64dLkedD/SXNrUXBXa7br9q25G/O/qoRB/jwE04rdq2/Q8twc84",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={},f=[];function C(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(D.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,d.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,d.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,d.jsx)(D.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,d.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,d.jsx)(a(),{...o(58788)}),"\n",(0,d.jsx)(u(),{...o(77902)}),"\n",(0,d.jsx)(m(),{...o(61668)})]})}function N(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(C,{...e})}):C(e)}},58788(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},77902(e){e.exports={title:"Body"}},61668(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.b6511a1f.js b/assets/js/19e5ad2a.456209b0.js similarity index 64% rename from assets/js/19e5ad2a.b6511a1f.js rename to assets/js/19e5ad2a.456209b0.js index 6e74a5753..be1593820 100644 --- a/assets/js/19e5ad2a.b6511a1f.js +++ b/assets/js/19e5ad2a.456209b0.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1651],{72908(e,t,i){i.r(t),i.d(t,{assets:()=>f,contentTitle:()=>I,default:()=>S,frontMatter:()=>b,metadata:()=>n,toc:()=>v});const n=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+7xlVFbjW3O8gG7K1JNbUuwsb61dLbTchAQlZE5TBEABNJU3OjH0hErAepAE0hN55FRACeXZata5ZQ55xXi2NLJF1JzDOVYFacbeCt1kTCILVTfQY+Na0Hgvo4zGIRYg5/MAoxiO0SG4M/8pGFRgSyG2BEOKccgimgAwDgWNfVI6BlTZG23wV67dstAZn+dpQUjN+HPvI4uSlCbzTWl/6EgwJc94y/MHWwcnkh4Bc4EtlViGdTD6ZE7gb2uoWs6AI7//QT8Bms3nW+d8cy5wr+nOTwV/R2aDI+u1BulRUNVmclrGS4aPVdI4GY/uMZuGgo7B5eD58TJ1VqN3sGok7JMzOri7iTfsNfPnpH3CJ0huo7KZt1rzxqLdQ9qY4c23l27QNFyUsbWy8ijOet83H2BUD9Rm8rSR9+emfAb7HDeP2dqI4lMnkqsm0yuEGa8drJEwmKbyPaAKopwFVkiCXBjKEUElupbWSIMG10lqZ1RTOzBaagB42iqrYDEyPckdhcF6GcgfIZMACrIkSvc3pwSOm1wH1GgPrMpbYDSwUcUdX3jZla23sTBecx6XSGm5VUSLF2M6KAlxH3rRkTvjIHVzyQFCFW5AeIaChKVw9EYknjXPWsxeqdX5ptbYbLgCawlllKKRQeLmkg/7k0OgRtClrXiC1KZRDOpJOzVCSdhK7iAfq9BPfyU/u8ePr1uMSPRuMYR/q4lTXTnd9WwJ36//S1i02bvEZo4AWtPNC+e6pnrjN0dfh4/Ia/Vrl2C21r0z0LDLPRCK0ytEEHKGEs/OrS1i/mc5FMtqO/8Fwzy4v3n/4/voDO8MXaZuwxXQ+nceXgg1USzOydI40vL47xHCU7N0BQP0fvtS7/U74SDOnpYqQKiZs18Ghu6P3+30iKhuIybsdD+0PXu/3TG6fzAySChXY9uHRvMLt6Im/lrphmxG5fIW3e4sfWO/5wyvmjeAt6fEGG2xlzvIc3djAM7R6BPnOP9yIRPCdeYxzVhHndP+w9v7IbEe6jwFQ6wD/5pheFNjtWgy13w/87dFXJboAe24uzf1+v/83EYVNPg==","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=i(74848),o=i(28453),a=i(57742),r=i.n(a),l=i(78178),c=i.n(l),p=i(19624),d=i.n(p),m=i(96226),h=i.n(m),u=(i(77675),i(19365),i(51107)),g=i(21312);const b={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"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+7xlVFbjW3O8gG7K1JNbUuwsb61dLbTchAQlZE5TBEABNJU3OjH0hErAepAE0hN55FRACeXZata5ZQ55xXi2NLJF1JzDOVYFacbeCt1kTCILVTfQY+Na0Hgvo4zGIRYg5/MAoxiO0SG4M/8pGFRgSyG2BEOKccgimgAwDgWNfVI6BlTZG23wV67dstAZn+dpQUjN+HPvI4uSlCbzTWl/6EgwJc94y/MHWwcnkh4Bc4EtlViGdTD6ZE7gb2uoWs6AI7//QT8Bms3nW+d8cy5wr+nOTwV/R2aDI+u1BulRUNVmclrGS4aPVdI4GY/uMZuGgo7B5eD58TJ1VqN3sGok7JMzOri7iTfsNfPnpH3CJ0huo7KZt1rzxqLdQ9qY4c23l27QNFyUsbWy8ijOet83H2BUD9Rm8rSR9+emfAb7HDeP2dqI4lMnkqsm0yuEGa8drJEwmKbyPaAKopwFVkiCXBjKEUElupbWSIMG10lqZ1RTOzBaagB42iqrYDEyPckdhcF6GcgfIZMACrIkSvc3pwSOm1wH1GgPrMpbYDSwUcUdX3jZla23sTBecx6XSGm5VUSLF2M6KAlxH3rRkTvjIHVzyQFCFW5AeIaChKVw9EYknjXPWsxeqdX5ptbYbLgCawlllKKRQeLmkg/7k0OgRtClrXiC1KZRDOpJOzVCSdhK7iAfq9BPfyU/u8ePr1uMSPRuMYR/q4lTXTnd9WwJ36//S1i02bvEZo4AWtPNC+e6pnrjN0dfh4/Ia/Vrl2C21r0z0LDLPRCK0ytEEHKGEs/OrS1i/mc5FMtqO/8Fwzy4v3n/4/voDO8MXaZuwxXQ+nceXgg1USzOydI40vL47xHCU7N0BQP0fvtS7/U74SDOnpYqQKiZs18Ghu6P3+30iKhuIybsdD+0PXu/3TG6fzAySChXY9uHRvMLt6Im/lrphmxG5fIW3e4sfWO/5wyvmjeAt6fEGG2xlzvIc3djAM7R6BPnOP9yIRPCdeYxzVhHndP+w9v7IbEe6jwFQ6wD/5pheFNjtWgy13w/87dFXJboAe24uzf1+v/83EYVNPg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},I=void 0,f={},v=[];function y(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(c(),{...i(85366)}),"\n",(0,s.jsx)(d(),{...i(72212)}),"\n",(0,s.jsx)(h(),{...i(22638)})]})}function S(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}},85366(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},72212(e){e.exports={title:"Body"}},22638(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1651],{72908(e,t,o){o.r(t),o.d(t,{assets:()=>V,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>T});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(57742),r=o.n(n),l=o(78178),p=o.n(l),c=o(19624),d=o.n(c),m=o(96226),h=o.n(m),b=(o(77675),o(19365),o(51107)),u=o(21312);const g={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},x=void 0,V={},T=[];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:(0,s.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...o(85366)}),"\n",(0,s.jsx)(d(),{...o(72212)}),"\n",(0,s.jsx)(h(),{...o(22638)})]})}function j(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(P,{...e})}):P(e)}},85366(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},72212(e){e.exports={title:"Body"}},22638(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/1c57a399.7e9acdf0.js b/assets/js/1c57a399.7e9acdf0.js new file mode 100644 index 000000000..22f07c03c --- /dev/null +++ b/assets/js/1c57a399.7e9acdf0.js @@ -0,0 +1 @@ +(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8901],{10417(e,t,n){"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>f,frontMatter:()=>d,metadata:()=>o,toc:()=>h});const o=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","source":"@site/docs/API-docs/v1.1/opensign-api-v-1-1.info.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/opensign-api-v-1-1","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"}}');var i=n(74848),s=n(28453),a=(n(43905),n(51107)),r=n(23397),l=n.n(r),c=n(19365);n(69016);const d={id:"opensign-api-v-1-1",title:"OpenSign API v1.1",description:"Welcome to the **OpenSign\u2122 API v1.1** documentation.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,u={},h=[];function m(e){const t={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,i.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.1"}),"\n",(0,i.jsxs)(t.p,{children:["Welcome to the ",(0,i.jsx)(t.strong,{children:"OpenSign\u2122 API v1.1"})," documentation."]}),"\n",(0,i.jsx)(t.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,i.jsx)(t.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Useful Links:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"What\u2019s New in v1.1"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Public Templates"}),": Create templates that can be shared via a public link. Any user with the link can generate and sign documents based on the template. Templates themselves cannot be edited through the public link."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets"}),": Add prefill widgets to documents before they are sent. Prefill widgets are supported in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates."]}),"\n"]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,i.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,i.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,i.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,i.jsx)("div",{children:(0,i.jsx)("table",{children:(0,i.jsxs)("tbody",{children:[(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"apiKey"})})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Header parameter name:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,i.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Contact"})}),(0,i.jsx)("span",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Terms of Service"})}),(0,i.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"License"})}),(0,i.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,i.jsx)(t.p,{children:"AGPL v3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(m,{...e})}):m(e)}},69016(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=o(n(96540)),s=o(n(4213));t.default=function({url:e,proxy:t}){return i.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},i.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),i.default.createElement("ul",{className:"export-dropdown dropdown__menu"},i.default.createElement("li",null,i.default.createElement("a",{onClick:t=>{t.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),s.default.saveAs(e,t||"openapi.txt")})(`${e}`)},className:"dropdown__link",href:`${e}`},"OpenAPI Spec"))))}},43905(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e){const{colorMode:t}=(0,s.useColorMode)(),{logo:n,darkLogo:o}=e,l=()=>"dark"===t?o?.altText??n?.altText:n?.altText,c=(0,a.default)(n?.url),d=(0,a.default)(o?.url);if(n&&o)return i.default.createElement(r.default,{alt:l(),sources:{light:c,dark:d},className:"openapi__logo"});if(n||o)return i.default.createElement(r.default,{alt:l(),sources:{light:c??d,dark:c??d},className:"openapi__logo"});return};const i=o(n(96540)),s=n(83262),a=o(n(86025)),r=o(n(15626))},4213(e,t){var n,o,i;o=[],void 0===(i="function"==typeof(n=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(console.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function n(e,t,n){var o=new XMLHttpRequest;o.open("GET",e),o.responseType="blob",o.onload=function(){r(o.response,t,n)},o.onerror=function(){console.error("could not download file")},o.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function i(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(n){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var s="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof globalThis&&globalThis.global===globalThis?globalThis:void 0,a=s.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),r=s.saveAs||("object"!=typeof window||window!==s?function(){}:"download"in HTMLAnchorElement.prototype&&!a?function(e,t,a){var r=s.URL||s.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?i(l):o(l.href)?n(e,t,a):i(l,l.target="_blank")):(l.href=r.createObjectURL(e),setTimeout(function(){r.revokeObjectURL(l.href)},4e4),setTimeout(function(){i(l)},0))}:"msSaveOrOpenBlob"in navigator?function(e,s,a){if(s=s||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,a),s);else if(o(e))n(e,s,a);else{var r=document.createElement("a");r.href=e,r.target="_blank",setTimeout(function(){i(r)})}}:function(e,t,o,i){if((i=i||open("","_blank"))&&(i.document.title=i.document.body.innerText="downloading..."),"string"==typeof e)return n(e,t,o);var r="application/octet-stream"===e.type,l=/constructor/i.test(s.HTMLElement)||s.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||r&&l||a)&&"undefined"!=typeof FileReader){var d=new FileReader;d.onloadend=function(){var e=d.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),i?i.location.href=e:location=e,i=null},d.readAsDataURL(e)}else{var p=s.URL||s.webkitURL,u=p.createObjectURL(e);i?i.location=u:location.href=u,i=null,setTimeout(function(){p.revokeObjectURL(u)},4e4)}});s.saveAs=r.saveAs=r,e.exports=r})?n.apply(t,o):n)||(e.exports=i)}}]); \ No newline at end of file diff --git a/assets/js/1c57a399.ca710393.js b/assets/js/1c57a399.ca710393.js deleted file mode 100644 index 57d42575f..000000000 --- a/assets/js/1c57a399.ca710393.js +++ /dev/null @@ -1 +0,0 @@ -(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8901],{10417(e,t,n){"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>f,frontMatter:()=>d,metadata:()=>o,toc:()=>h});const o=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","source":"@site/docs/API-docs/v1.1/opensign-api-v-1-1.info.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/opensign-api-v-1-1","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"}}');var i=n(74848),s=n(28453),a=(n(43905),n(51107)),r=n(23397),l=n.n(r),c=n(19365);n(69016);const d={id:"opensign-api-v-1-1",title:"OpenSign API v1.1",description:"Welcome to the **OpenSign\u2122 API v1.1** documentation.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,u={},h=[];function m(e){const t={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,i.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.1"}),"\n",(0,i.jsxs)(t.p,{children:["Welcome to the ",(0,i.jsx)(t.strong,{children:"OpenSign\u2122 API v1.1"})," documentation."]}),"\n",(0,i.jsx)(t.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a devloper automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,i.jsx)(t.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Useful Links:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"What\u2019s New in v1.1"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Public Templates"}),": Create templates that can be shared via a public link. Any user with the link can generate and sign documents based on the template. Templates themselves cannot be edited through the public link."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets"}),": Add prefill widgets to documents before they are sent. Prefill widgets are supported in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates."]}),"\n"]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,i.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,i.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,i.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,i.jsx)("div",{children:(0,i.jsx)("table",{children:(0,i.jsxs)("tbody",{children:[(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"apiKey"})})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Header parameter name:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,i.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Contact"})}),(0,i.jsx)("span",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Terms of Service"})}),(0,i.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"License"})}),(0,i.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,i.jsx)(t.p,{children:"AGPL v3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(m,{...e})}):m(e)}},69016(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=o(n(96540)),s=o(n(4213));t.default=function({url:e,proxy:t}){return i.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},i.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),i.default.createElement("ul",{className:"export-dropdown dropdown__menu"},i.default.createElement("li",null,i.default.createElement("a",{onClick:t=>{t.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),s.default.saveAs(e,t||"openapi.txt")})(`${e}`)},className:"dropdown__link",href:`${e}`},"OpenAPI Spec"))))}},43905(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e){const{colorMode:t}=(0,s.useColorMode)(),{logo:n,darkLogo:o}=e,l=()=>"dark"===t?o?.altText??n?.altText:n?.altText,c=(0,a.default)(n?.url),d=(0,a.default)(o?.url);if(n&&o)return i.default.createElement(r.default,{alt:l(),sources:{light:c,dark:d},className:"openapi__logo"});if(n||o)return i.default.createElement(r.default,{alt:l(),sources:{light:c??d,dark:c??d},className:"openapi__logo"});return};const i=o(n(96540)),s=n(83262),a=o(n(86025)),r=o(n(15626))},4213(e,t){var n,o,i;o=[],void 0===(i="function"==typeof(n=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(console.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function n(e,t,n){var o=new XMLHttpRequest;o.open("GET",e),o.responseType="blob",o.onload=function(){r(o.response,t,n)},o.onerror=function(){console.error("could not download file")},o.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function i(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(n){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var s="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof globalThis&&globalThis.global===globalThis?globalThis:void 0,a=s.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),r=s.saveAs||("object"!=typeof window||window!==s?function(){}:"download"in HTMLAnchorElement.prototype&&!a?function(e,t,a){var r=s.URL||s.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?i(l):o(l.href)?n(e,t,a):i(l,l.target="_blank")):(l.href=r.createObjectURL(e),setTimeout(function(){r.revokeObjectURL(l.href)},4e4),setTimeout(function(){i(l)},0))}:"msSaveOrOpenBlob"in navigator?function(e,s,a){if(s=s||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,a),s);else if(o(e))n(e,s,a);else{var r=document.createElement("a");r.href=e,r.target="_blank",setTimeout(function(){i(r)})}}:function(e,t,o,i){if((i=i||open("","_blank"))&&(i.document.title=i.document.body.innerText="downloading..."),"string"==typeof e)return n(e,t,o);var r="application/octet-stream"===e.type,l=/constructor/i.test(s.HTMLElement)||s.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||r&&l||a)&&"undefined"!=typeof FileReader){var d=new FileReader;d.onloadend=function(){var e=d.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),i?i.location.href=e:location=e,i=null},d.readAsDataURL(e)}else{var p=s.URL||s.webkitURL,u=p.createObjectURL(e);i?i.location=u:location.href=u,i=null,setTimeout(function(){p.revokeObjectURL(u)},4e4)}});s.saveAs=r.saveAs=r,e.exports=r})?n.apply(t,o):n)||(e.exports=i)}}]); \ No newline at end of file diff --git a/assets/js/23f866da.8435fee8.js b/assets/js/23f866da.323d81b9.js similarity index 93% rename from assets/js/23f866da.8435fee8.js rename to assets/js/23f866da.323d81b9.js index b8c894b87..6ab7d9839 100644 --- a/assets/js/23f866da.8435fee8.js +++ b/assets/js/23f866da.323d81b9.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[285],{97831(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>w,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":"eJztXF9zGzeS/yp9U1dlmzukRFp2fCqva71xduO7xHHFcqVyklcLzjRJWDPABMCI4qpYlYf9Bvd0VXcv+9HySa66AQxn+EeynGTXd8c8OOLgX6PRaHT/uoHrxImpTY5Pkxc6q0tUzibv0iRHmxlZOalVcpyczBAsFhMrpwqev34JU1RohEMLAt5++xW4mXCASowLtDAxiNYtCgSqL9UU9AQE5KH/AXyva8iEAlFYDVJlRZ0jaB5MFFAZ7Oc4kQpzmMt8is6mMJ/JbAZu5vtEw+0xlw60AbyqhMqhrrQCYUEh5pgP4GQmLVRGX8qcCY3U4FWFRqLKqLNSFsKA09z3Tz/+1xua4ve6NjTfn378b5gUeg5Scfk3FSquIKpqcKbO1ImsjuFtVWiRw0LXBl6/+EMzUeqVvp32ei9wXE/h7cte7939mXOVPT44oD50hYrIKsTYDjJdHuRUsconD2jKaJB69XMVVhYLEHmLKW6GCjJdLSDT2uRS0YqkUIkpgqrLMRqbAnGm1AZpDgIMinzRd7pfW4R/ffPNK5hoUwo3gNdFbdNmuFwazFyx8N3T3OOs7lkYC4uPj8A6I9U0hVJcEFulgx9qmV3QtC2qPDL1+euXzKte701dVdo4zOE7P4XjXo9Kfo/EY2GQ62e6LLWCShhRokNjvXRRscEfamlYLtwMRFFEXhyfqT70ekqUeNzrwVslf6gRZI7KyYlEQ7MER/LgGwx8fbeouP5LlcuMxZkIoK8ksp2qxFSq+qbCjLr0VVusBq2ClBIP58Kvf1WIzE/LoK0wc/ISux1fpbCgjl+g0pGCmTbyL1o5UfDyXaJxMhNFe5mJQN4OThhH7K+0VC5+DSM0O41WmxcxyCGRlhNzS6m4xCJciqJGG6iapzAjqr7FyqAlrRD7JcarHGYop7Od44n8fW1dp2OoLZHZpiKMFVeV2YvMtokoLIKcdHhZigtsjdZojAH8fgE5TkRduBQkSagzNQ7glXa0UwuZkWJiGaDNJlxtsM+rHMRn0BWf1yudkcvJBA1tZirkLkKbSB3JpVcyND3eaW4mFGi1ttCZLrTZFCH+3OUjZFo51pTPL4UsmHg/Wduoy3EhsosUxkWNKRjM/UZfYFHoeer3B1chheh5zvwhNU5SqBXRr3QYXlqwgapGccb9R4WNcqZBpG1zNezyiaaRiQVxSwKWQhYpMy6F93oMTroCU9rglVCLFHLhMAWHV26sr1LIZphdjPVV4NdEK2flX7bsulhyd66NUjhK4XEKT1IYHqYwHKUwPEph+DiF4ZMURocpjEYpjI5SGD32PB09CfwUDRPbBAxHnpPu0+PgTOZ4ToXnRP+5sA6NtBekduE7Ojv8iZ2nXu3hlSMl1hyy+eokkxZmMs9RwcToEgxmspKsFfyubrpOYVw7MES4sjCpi2IBl9LK1jybTvWcDnJ/tErTOlyzTNe0jsxFzzhm2WpZVbEgUk9QlJY5+oVyaCojLZLKVbbhgHIr+fEHGX1rb+QPWS3V1SS7VyyuQApG5FITN5xWKeRGV7meq3ASfiUt6046wmxzKs47p+JwAL1eo6/o25///OczdX2mAM4SUl9nyTGcJU2VsyT1ZXQqUdkw/L6iHw9Hn4WfC/r5ePQk/Jxz1eFR+Dmjn6PYNGygs+SYx+UKUjk/ctCT0KKAKi3P1DIQe6ZGPAsnyuqGGVDxr0s9NOTH04Y+0jGRxgLaZZv07Jixr7Ex24c0W6mkk6Kwuycca3xCc14jafu0V5U2Zn5EM2d9tXvaXPwJzblND5XwWeiL+OxsFUWNz1SMbmDRep+7dDC1Yitng5OPBsEU2c1IP4VPho8tcn4pNq51eXcuPiYu0pF5QkfmblY2p+onxM91mn4ppm7r9+6c/WzAxixbILv5Gip8QlztUvRL8XSz17tz9AlxlEy53eyk0k+Ily1yqCDYxb7s8Kg/fNQfHY6OOvwklMFXKMt+nvcXi8XPW4tSqnNPBzVq1S/F1faCAAA1hbwaN6ytr7e2XGRWhvmSZRmdRW/aCofeQt5EAthRX9UKrgv/Hb3nr8lnHkd3EvMIOzWORQPWtB1ep3OxuGd9V7Fp40NR/XUL2JPJRUQHA1fZTMssEE91ouc0JmxmQDzo89Id5PlBa+noY573y7K/9pF+9nmlWx/LcpDng7WaG+LgP5aQ5ylsft76Pc+hLMsdn/33zueDstycxaAsA22Be1HCNta5lEqWNflBhIF5d5oqkisR2FuGtZQKer3vv//++/7XX/dfvOj14hqGIYKstmAHP4K4+oVGaAt9r3cMLyfQ/sSuvwddeK837h+5NU2FmZ6r6PUEADavCf2LVT30U4oFd4bSzdB0x9FmJbLkI5JLNdZuNoC37ELS39HValwidpf+hdRj8HF3a8hQ4e+lJFe6sDvwjQqU0FfyXTeVT0eDbhg/UTFV260jg9O6EAavCKuzUqsNzfcxJ93dTrE1tRhleYWZMAoYcFiMkAXc/yZ42g8aMHBtLtTbc8hq6xh4mOIVVMI5NIo7uxSFzAXvjz5/wCtRVgSSHPzp7Cz/zT8fMAxLSKfzuEEup5LQ84M/nT7v//u7LTXqqkKTCYtQII1kU0CXDeB0hkW1AvDn8/lg/tBmM60Lj96/twYn/t9zPX5/zuRWA2GrB9tm6oWhBXuSsKyjnrw5WxwTFmLLLcAnLw3vmuEh22kBj7jBUAs1PiHrYo0kKvQYMhWf0gHPJiwJL67+1qRzzpJ3q+OeoU7Mb2n77gO2J+2GQoyx2Cy6+9YqxELXYUdHaL871SDRLb4Fg6dBb3k6h2mrUFytFfqy5ZZ96hnS3qbxtI/bM64AFNI2B0mHne3WAeDnMA0F30hsxwixAYwbKf3Zu6Ah7MO2QURBee1uGYLqAVdsgisNnnrzCJ2F2TjJg60Qo0STptfIsniQt/lFLWuLZmUm3DBCsBV2j0Ahmd0DnKkhY42yFNMbXBAu/oS0RJueHXCVr7Hhbw0ZlPTsugFk4fKbJzw87Ez4UXfCjw8/wpzoDHsjK1o2w2FL55iyLsSGBZBjJktRcDyShx79DA22Ba9Zp/pj7IdAO8n357qsauflO1gO5Jmwjo+CHgNxPgTxmxT6KfRSOEjhfgoPBvAtcugua8J8Qe6l8cE8qSDXNeH5WW2KBYwN8SYFHEwHcH39Qy2Uk26xXEIPrq8p3WG5HJCmuFB67iN9pxTbcECR+pVdkOvMbons68wekAFx8Arn/ZhscRBIewD39ZpmvNGaCizYUKedZaamrxql4O0ejvxKWxViAWJC4Q4fHeRmPog8IA4cwwh++wyGo8HhYQqH/m+4H8cfPeCNxHh3hsVNYDcX37aNDtvbaPVzm954dPhB+6g97Eca5dTFOceieNztxvpWDfQJGueryazDAa1zg3jmjww703WR06lh0NVGYZPPEU6NJE10RUlAUquXeXKcxAShJGVeo3W/1/kiOb5OQmCW/gxBNGp08N5SctF1YrMZloL+imtE6UgTWWCSJt7btEmaMHJJuUkkWslxosfvMXNJSl5RRWYUWuqD2x1fx1o+SSVJAwKVHCc+eyVJk+ApNJ8AVaYJdqnySbKMA97UVfNl1ZXlP5ogJ/VDeR0f2c0rarpcS8f6qJ5etHrguZV4oknLFujwhVjYVr9eIJL1LDBqQ0KQhVaQi4Ull722XjoyUWR1Qc4+XlXSLBqkixGmhiUtepuRGnqHj5Zx0VsU7Vhro+++QBlqYgDHae7a9r3GMeLvwgdS67y+orwzFe81whh5bauZVnduPxw9HI6GD4cj6iFg0HftIx5R1MV7PT7/KHnP8ZLah2Os1VoYIxZJmkiHpb19KX3p5thdEXxOAXfMo8fRX4WeUx+THdy2G2J95ryY4u1if7Irz6uVehK0pagqFGbA6VYfnfnX3UmNATS4Zd8s0+Tq9slcQab7MYkM7hc4cR7ugEwbheZBG77+ZCY3Ojpapsni9ukt/ldO7zNavPnts/uOs+9WmYn/CFofPlmmyex2Wr9s8gP/gcQePV6uzvEkMygcOiwr6uR8rPPFedRby3bFaMnEE8tXDYfSkkYscjRk9Gzqq5WqoZqUB3u+ftSMtS5QqC2KppOGJEjXWYYoCAAJBtt8huwDNcgF924byCXAJd5qCtGCDgIrLVnnpsazZEDBgJWHxaDHeiZUrMuZUErDPR7v3Nasxu8dhN/EoXvtnF1Ki1zFrSIJXBniElA2blEQ3WRBDKD5j63LhpNEQDyx48C3HxWfe8SYBwyNuhmgEKzUAXwuVJMh2M3rguvrRghYOpZLuL6mVUVzTuf+cpmuPtBYnQ98tPsvBjOUl51WzSdcNWy+tZp6Y4qjKP5DOO/bBIRIS21CP2RzLpeDjkCuEQ4zxtCYB5g3ckYZeJuzbkwmXukP5v4Gs4MEUCf/b/j+tHr2pdxCytOD6tnT6tl3lO9dod97nj0TqXK/8+dYFAN4ap3RavpsjQVPD8L37Utp8FLinDcur+qql3XeNh0NAk10AaK1eNJCZupMioJDJUZnGJPw2YGkzFHrsLIEy0rnA3+crsuWv5gaRE75JFpE7Ti/nZ3AOOBTATODk9/eW+PpvWecEkoAy9MD8SzUfumR25m4RBBqATxxBrC18Qj0pDasJrNCGDkJHmcKVYEU1iGHVGQeUfYcjXSczIS6sOnTsXlGyaVNUupPf/0b1eBtwEmzJ7o2H6DTGWju+7UNmays83wnIGBac6TfEZ+ieuKI0yqnXCrrTO2x3xh2bUdpeT2sHYSs+T7hOz5NdYbt/lNAZX1zARMGDVKolaTUWVNXJDmbV2Q6oswDLMm/9/dDaI1u1wXd5G26LuSvtrSCyfEciB1juM0TXM3m4kBMHV6f+taDN+yT2wmkQ5IRwQD7V2isViRL2kyFCqLqDX9tyXGbicJX9ftVUp4ER8Mp/3yrk/XTX//Womun97lJmB9B5DnBR7dQyMgN4TOWIX+DVbEAp7sUUX9ofrduaxF1JZopnmfklfGewQ+Q8F6PZLzXg77Pow7ibWt/EcLFOz28jrSkq96Jb0H/N7kuEVzIO1epBvClnuMlCWzYwqRoff+aEF6mPCSyt0fIhOJEA9rnZJ1Qx02OCyWpr4bwmdks4jyboGQovOvH4zsoNE5605yiKDdJPILvnoXRY2Y9TY6QKhCF5vxx17rdlneJesnXC2asCjhZg0JQfpx4r4dT6X/68T/pvltEvW1j3m0tZQuNb+BxxkW712itxYs4g649FrWA0k5OFudanTcnhd0qMN2WNwpQa4+zua6DbghnJ9BNON4QPHjQ66RPFElHuOQXUk9sR2dsrO/uwYghv9CABOAdw7c4FSYvmg3sl9Hx7TnRFiQ/1C5p4ONzh9gJ50Q2Q76tkGNF9++0gnsrB6RlndN6EvyB6pyx5w+BbYKGWrZW8zSh20cM9+ZJ6rHr5N0yTcZZ9rE9kvLq4Gspfxp1vm3cTx1nGdwfF5LYI8xY+1uRD47hLetCkdM+5DOnK0zdRfXMZ3XSOWzI+olaiVl3m6vovckVmB0cGLoBqJX1m2R0eEj/687jRUcc6TyuMzrf+B7NPyXphyPpN4Nt/vN2B/Ym9Gz2Xo7+cpVdjl7Tsu04/G/sIDj7tSnoEipxrt/sFz6EWryVqpAKzyPbzkeHh+dD4u0yTY62se+NLtHryTkxcU4mbXNgOLMAMSWNT66n+QW5icZoczMWcDfKbmLCUYcJjzaZ8FJxAglf0z7RF6j+vjNtD+/88ETqVcmy4u2xRPpKXJ50Jtv+7idpMauNdIvk+PQ6ueqLSvZ9+fHpu+U7slncTFP8qdKWKRZulhwnB61wlEVzSTEk6oGFtpFDK1RO+R0bwJOo5MHlcDBMlul6m61A1Q31se7ftYl1YirV9LZ271bceUMr6Bepw6OVFq7kvyGp4bAE7VppIklyZihyArgoHGC1+nYVxPsiLm8Mr22LmLWU4loMLIbAOlGtdR2+JU61PUw1fNQOEPkQEEd1mqDOtjhNM/EYeWkCL61YSiuUsoqOdIIjHO9ohTtOV3uhiSzEwMKQEfnR0RFD158NGeN9+ITh06PHy3cdJDFJumghh6jXMa+fB+F0EZw9LPF/CJboohLBzO566VHAGq+445que6Y7vcStTmIYcLtDEArb1uZ2yzEYjh9qBC5JbU0067iwOZsrxHT6sI7cCKFgkemyucHb67U42bTq9Rrd5aWBLPlvagOVnqOZ1P5a8KTAK77XTM2w5LIVXI+iJHu/WADhK1P2/TgDRxQNepGJSoxlIel4pWo6yOXqhLYDuqgdAf97xqcAXRZ0KJPE6lIwONLYqnNtLujFEnr4A8aUGUVOB6qZUJkHKPx5kZJIkm+zujdtnSGipSdNK2dIFkuhxJR3SdqWOsixIKVhwegx5S9aXdRe1p2QhTY+I4DnQ5JvmYdfXFVUxGEg0rQGZyRelwGmsnSznW7X8iqHt0vGhBpXRIskr9VpqFWh6ZkRQozrgpKWyLYhLaAnHRqpuTNCWTJJQxJCWIKGYQFBQhv8w7cWaYG/kurCX8Tuw2kjVt/h2EqH3RTw9S3yoNvmj9J9WY/pIQ1tpdNmsWo9lW5Wj/lQb3fS/PA9/TG8tQOtI/vDk83eeD/THjx//ZLNwQfw04//AV+hMApmeu6FNasNFovmWR//aAyvvGdbY80xRkmqkjieeeELGj5y8LuZcAw2vEJ+OMfvKJ+E9LoeFzKDkxgAogspn7Ov0woKdVJWZ4JE6VIKEFD51oVUFwN4rhYMda30PX3ndp1p8BkTl9u/XZPHZw7imIMVRfS9tFhcom2BR/TSEEn0zOh66kdrExMmZ3BC7mV43Ibm9jzPGXORq6dqOAFvRQ5O/IshuPAhMwa7Xq814ZLmmYCAlK2iJahyTtyzx5AbMXGr/tM1hINPm41P8XmLyI40dNMsid+JYcbNVw8LrZmbXXXLcBMNyNNerUslgzidRrGE7t2Ku4u1T4ThA5RdlXCOiUpuhTrp7Rv7zeQNmkuZRdd0x44+4MoHSZoUMkNlseXKPP/j66/g8uHgMElbRvwHbO6Dr15+/sWrN18QMaRIPcOGg8PBIYMz2rpSqNZIb7CYwBtvka7lgzXu3f6lrv1LXfuXuvYvde1f6tq/1LV/qWv/Utf+pa79S137l7r2L3XtX+rav9S1f6lr/1LX/qWu/Utd+5e69i917V/q2r/UtX+pa/9S1/6lrv1LXfuXuvYvde1f6tq/1PXraYn9S137l7r2L3XtX+rasY/2L3X96i91hRx1IuSgKoRUrfs7/sLE6er9rndpMqO7FMenyfU1ZZC8pZRn+vxDjYYuYrxLk0thJEXY+BpGGu8OUD78BVJ2+ec+xNs/oZFTbxVyOtba7RO6/OBbPM8yrNyNddvXPV5/8+aEcofDcwSlzqmNEXNKKxZzn/AcBI8vCgh+YaUQalpzen7i+6TrDpTQ2L0rccF3JcIfrSx/uhuworB7icJPg/6lSW1tcH3t72FwNr6v74t2tgiMjbVp5d4tl8v/AUQ3M9Q=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),u=t.n(h),m=(t(77675),t(19365),t(51107)),x=t(21312);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:"eJztXF9zGzeS/yp9U1dlmzukRFp2fCqva71xduO7xHHFcqVyklcLzjRJWDPABMCI4qpYlYf9Bvd0VXcv+9HySa66AQxn+EeynGTXd8c8OOLgX6PRaHT/uoHrxImpTY5Pkxc6q0tUzibv0iRHmxlZOalVcpyczBAsFhMrpwqev34JU1RohEMLAt5++xW4mXCASowLtDAxiNYtCgSqL9UU9AQE5KH/AXyva8iEAlFYDVJlRZ0jaB5MFFAZ7Oc4kQpzmMt8is6mMJ/JbAZu5vtEw+0xlw60AbyqhMqhrrQCYUEh5pgP4GQmLVRGX8qcCY3U4FWFRqLKqLNSFsKA09z3Tz/+1xua4ve6NjTfn378b5gUeg5Scfk3FSquIKpqcKbO1ImsjuFtVWiRw0LXBl6/+EMzUeqVvp32ei9wXE/h7cte7939mXOVPT44oD50hYrIKsTYDjJdHuRUsconD2jKaJB69XMVVhYLEHmLKW6GCjJdLSDT2uRS0YqkUIkpgqrLMRqbAnGm1AZpDgIMinzRd7pfW4R/ffPNK5hoUwo3gNdFbdNmuFwazFyx8N3T3OOs7lkYC4uPj8A6I9U0hVJcEFulgx9qmV3QtC2qPDL1+euXzKte701dVdo4zOE7P4XjXo9Kfo/EY2GQ62e6LLWCShhRokNjvXRRscEfamlYLtwMRFFEXhyfqT70ekqUeNzrwVslf6gRZI7KyYlEQ7MER/LgGwx8fbeouP5LlcuMxZkIoK8ksp2qxFSq+qbCjLr0VVusBq2ClBIP58Kvf1WIzE/LoK0wc/ISux1fpbCgjl+g0pGCmTbyL1o5UfDyXaJxMhNFe5mJQN4OThhH7K+0VC5+DSM0O41WmxcxyCGRlhNzS6m4xCJciqJGG6iapzAjqr7FyqAlrRD7JcarHGYop7Od44n8fW1dp2OoLZHZpiKMFVeV2YvMtokoLIKcdHhZigtsjdZojAH8fgE5TkRduBQkSagzNQ7glXa0UwuZkWJiGaDNJlxtsM+rHMRn0BWf1yudkcvJBA1tZirkLkKbSB3JpVcyND3eaW4mFGi1ttCZLrTZFCH+3OUjZFo51pTPL4UsmHg/Wduoy3EhsosUxkWNKRjM/UZfYFHoeer3B1chheh5zvwhNU5SqBXRr3QYXlqwgapGccb9R4WNcqZBpG1zNezyiaaRiQVxSwKWQhYpMy6F93oMTroCU9rglVCLFHLhMAWHV26sr1LIZphdjPVV4NdEK2flX7bsulhyd66NUjhK4XEKT1IYHqYwHKUwPEph+DiF4ZMURocpjEYpjI5SGD32PB09CfwUDRPbBAxHnpPu0+PgTOZ4ToXnRP+5sA6NtBekduE7Ojv8iZ2nXu3hlSMl1hyy+eokkxZmMs9RwcToEgxmspKsFfyubrpOYVw7MES4sjCpi2IBl9LK1jybTvWcDnJ/tErTOlyzTNe0jsxFzzhm2WpZVbEgUk9QlJY5+oVyaCojLZLKVbbhgHIr+fEHGX1rb+QPWS3V1SS7VyyuQApG5FITN5xWKeRGV7meq3ASfiUt6046wmxzKs47p+JwAL1eo6/o25///OczdX2mAM4SUl9nyTGcJU2VsyT1ZXQqUdkw/L6iHw9Hn4WfC/r5ePQk/Jxz1eFR+Dmjn6PYNGygs+SYx+UKUjk/ctCT0KKAKi3P1DIQe6ZGPAsnyuqGGVDxr0s9NOTH04Y+0jGRxgLaZZv07Jixr7Ex24c0W6mkk6Kwuycca3xCc14jafu0V5U2Zn5EM2d9tXvaXPwJzblND5XwWeiL+OxsFUWNz1SMbmDRep+7dDC1Yitng5OPBsEU2c1IP4VPho8tcn4pNq51eXcuPiYu0pF5QkfmblY2p+onxM91mn4ppm7r9+6c/WzAxixbILv5Gip8QlztUvRL8XSz17tz9AlxlEy53eyk0k+Ily1yqCDYxb7s8Kg/fNQfHY6OOvwklMFXKMt+nvcXi8XPW4tSqnNPBzVq1S/F1faCAAA1hbwaN6ytr7e2XGRWhvmSZRmdRW/aCofeQt5EAthRX9UKrgv/Hb3nr8lnHkd3EvMIOzWORQPWtB1ep3OxuGd9V7Fp40NR/XUL2JPJRUQHA1fZTMssEE91ouc0JmxmQDzo89Id5PlBa+noY573y7K/9pF+9nmlWx/LcpDng7WaG+LgP5aQ5ylsft76Pc+hLMsdn/33zueDstycxaAsA22Be1HCNta5lEqWNflBhIF5d5oqkisR2FuGtZQKer3vv//++/7XX/dfvOj14hqGIYKstmAHP4K4+oVGaAt9r3cMLyfQ/sSuvwddeK837h+5NU2FmZ6r6PUEADavCf2LVT30U4oFd4bSzdB0x9FmJbLkI5JLNdZuNoC37ELS39HValwidpf+hdRj8HF3a8hQ4e+lJFe6sDvwjQqU0FfyXTeVT0eDbhg/UTFV260jg9O6EAavCKuzUqsNzfcxJ93dTrE1tRhleYWZMAoYcFiMkAXc/yZ42g8aMHBtLtTbc8hq6xh4mOIVVMI5NIo7uxSFzAXvjz5/wCtRVgSSHPzp7Cz/zT8fMAxLSKfzuEEup5LQ84M/nT7v//u7LTXqqkKTCYtQII1kU0CXDeB0hkW1AvDn8/lg/tBmM60Lj96/twYn/t9zPX5/zuRWA2GrB9tm6oWhBXuSsKyjnrw5WxwTFmLLLcAnLw3vmuEh22kBj7jBUAs1PiHrYo0kKvQYMhWf0gHPJiwJL67+1qRzzpJ3q+OeoU7Mb2n77gO2J+2GQoyx2Cy6+9YqxELXYUdHaL871SDRLb4Fg6dBb3k6h2mrUFytFfqy5ZZ96hnS3qbxtI/bM64AFNI2B0mHne3WAeDnMA0F30hsxwixAYwbKf3Zu6Ah7MO2QURBee1uGYLqAVdsgisNnnrzCJ2F2TjJg60Qo0STptfIsniQt/lFLWuLZmUm3DBCsBV2j0Ahmd0DnKkhY42yFNMbXBAu/oS0RJueHXCVr7Hhbw0ZlPTsugFk4fKbJzw87Ez4UXfCjw8/wpzoDHsjK1o2w2FL55iyLsSGBZBjJktRcDyShx79DA22Ba9Zp/pj7IdAO8n357qsauflO1gO5Jmwjo+CHgNxPgTxmxT6KfRSOEjhfgoPBvAtcugua8J8Qe6l8cE8qSDXNeH5WW2KBYwN8SYFHEwHcH39Qy2Uk26xXEIPrq8p3WG5HJCmuFB67iN9pxTbcECR+pVdkOvMbons68wekAFx8Arn/ZhscRBIewD39ZpmvNGaCizYUKedZaamrxql4O0ejvxKWxViAWJC4Q4fHeRmPog8IA4cwwh++wyGo8HhYQqH/m+4H8cfPeCNxHh3hsVNYDcX37aNDtvbaPVzm954dPhB+6g97Eca5dTFOceieNztxvpWDfQJGueryazDAa1zg3jmjww703WR06lh0NVGYZPPEU6NJE10RUlAUquXeXKcxAShJGVeo3W/1/kiOb5OQmCW/gxBNGp08N5SctF1YrMZloL+imtE6UgTWWCSJt7btEmaMHJJuUkkWslxosfvMXNJSl5RRWYUWuqD2x1fx1o+SSVJAwKVHCc+eyVJk+ApNJ8AVaYJdqnySbKMA97UVfNl1ZXlP5ogJ/VDeR0f2c0rarpcS8f6qJ5etHrguZV4oknLFujwhVjYVr9eIJL1LDBqQ0KQhVaQi4Ull722XjoyUWR1Qc4+XlXSLBqkixGmhiUtepuRGnqHj5Zx0VsU7Vhro+++QBlqYgDHae7a9r3GMeLvwgdS67y+orwzFe81whh5bauZVnduPxw9HI6GD4cj6iFg0HftIx5R1MV7PT7/KHnP8ZLah2Os1VoYIxZJmkiHpb19KX3p5thdEXxOAXfMo8fRX4WeUx+THdy2G2J95ryY4u1if7Irz6uVehK0pagqFGbA6VYfnfnX3UmNATS4Zd8s0+Tq9slcQab7MYkM7hc4cR7ugEwbheZBG77+ZCY3Ojpapsni9ukt/ldO7zNavPnts/uOs+9WmYn/CFofPlmmyex2Wr9s8gP/gcQePV6uzvEkMygcOiwr6uR8rPPFedRby3bFaMnEE8tXDYfSkkYscjRk9Gzqq5WqoZqUB3u+ftSMtS5QqC2KppOGJEjXWYYoCAAJBtt8huwDNcgF924byCXAJd5qCtGCDgIrLVnnpsazZEDBgJWHxaDHeiZUrMuZUErDPR7v3Nasxu8dhN/EoXvtnF1Ki1zFrSIJXBniElA2blEQ3WRBDKD5j63LhpNEQDyx48C3HxWfe8SYBwyNuhmgEKzUAXwuVJMh2M3rguvrRghYOpZLuL6mVUVzTuf+cpmuPtBYnQ98tPsvBjOUl51WzSdcNWy+tZp6Y4qjKP5DOO/bBIRIS21CP2RzLpeDjkCuEQ4zxtCYB5g3ckYZeJuzbkwmXukP5v4Gs4MEUCf/b/j+tHr2pdxCytOD6tnT6tl3lO9dod97nj0TqXK/8+dYFAN4ap3RavpsjQVPD8L37Utp8FLinDcur+qql3XeNh0NAk10AaK1eNJCZupMioJDJUZnGJPw2YGkzFHrsLIEy0rnA3+crsuWv5gaRE75JFpE7Ti/nZ3AOOBTATODk9/eW+PpvWecEkoAy9MD8SzUfumR25m4RBBqATxxBrC18Qj0pDasJrNCGDkJHmcKVYEU1iGHVGQeUfYcjXSczIS6sOnTsXlGyaVNUupPf/0b1eBtwEmzJ7o2H6DTGWju+7UNmays83wnIGBac6TfEZ+ieuKI0yqnXCrrTO2x3xh2bUdpeT2sHYSs+T7hOz5NdYbt/lNAZX1zARMGDVKolaTUWVNXJDmbV2Q6oswDLMm/9/dDaI1u1wXd5G26LuSvtrSCyfEciB1juM0TXM3m4kBMHV6f+taDN+yT2wmkQ5IRwQD7V2isViRL2kyFCqLqDX9tyXGbicJX9ftVUp4ER8Mp/3yrk/XTX//Womun97lJmB9B5DnBR7dQyMgN4TOWIX+DVbEAp7sUUX9ofrduaxF1JZopnmfklfGewQ+Q8F6PZLzXg77Pow7ibWt/EcLFOz28jrSkq96Jb0H/N7kuEVzIO1epBvClnuMlCWzYwqRoff+aEF6mPCSyt0fIhOJEA9rnZJ1Qx02OCyWpr4bwmdks4jyboGQovOvH4zsoNE5605yiKDdJPILvnoXRY2Y9TY6QKhCF5vxx17rdlneJesnXC2asCjhZg0JQfpx4r4dT6X/68T/pvltEvW1j3m0tZQuNb+BxxkW712itxYs4g649FrWA0k5OFudanTcnhd0qMN2WNwpQa4+zua6DbghnJ9BNON4QPHjQ66RPFElHuOQXUk9sR2dsrO/uwYghv9CABOAdw7c4FSYvmg3sl9Hx7TnRFiQ/1C5p4ONzh9gJ50Q2Q76tkGNF9++0gnsrB6RlndN6EvyB6pyx5w+BbYKGWrZW8zSh20cM9+ZJ6rHr5N0yTcZZ9rE9kvLq4Gspfxp1vm3cTx1nGdwfF5LYI8xY+1uRD47hLetCkdM+5DOnK0zdRfXMZ3XSOWzI+olaiVl3m6vovckVmB0cGLoBqJX1m2R0eEj/687jRUcc6TyuMzrf+B7NPyXphyPpN4Nt/vN2B/Ym9Gz2Xo7+cpVdjl7Tsu04/G/sIDj7tSnoEipxrt/sFz6EWryVqpAKzyPbzkeHh+dD4u0yTY62se+NLtHryTkxcU4mbXNgOLMAMSWNT66n+QW5icZoczMWcDfKbmLCUYcJjzaZ8FJxAglf0z7RF6j+vjNtD+/88ETqVcmy4u2xRPpKXJ50Jtv+7idpMauNdIvk+PQ6ueqLSvZ9+fHpu+U7slncTFP8qdKWKRZulhwnB61wlEVzSTEk6oGFtpFDK1RO+R0bwJOo5MHlcDBMlul6m61A1Q31se7ftYl1YirV9LZ271bceUMr6Bepw6OVFq7kvyGp4bAE7VppIklyZihyArgoHGC1+nYVxPsiLm8Mr22LmLWU4loMLIbAOlGtdR2+JU61PUw1fNQOEPkQEEd1mqDOtjhNM/EYeWkCL61YSiuUsoqOdIIjHO9ohTtOV3uhiSzEwMKQEfnR0RFD158NGeN9+ITh06PHy3cdJDFJumghh6jXMa+fB+F0EZw9LPF/CJboohLBzO566VHAGq+445que6Y7vcStTmIYcLtDEArb1uZ2yzEYjh9qBC5JbU0067iwOZsrxHT6sI7cCKFgkemyucHb67U42bTq9Rrd5aWBLPlvagOVnqOZ1P5a8KTAK77XTM2w5LIVXI+iJHu/WADhK1P2/TgDRxQNepGJSoxlIel4pWo6yOXqhLYDuqgdAf97xqcAXRZ0KJPE6lIwONLYqnNtLujFEnr4A8aUGUVOB6qZUJkHKPx5kZJIkm+zujdtnSGipSdNK2dIFkuhxJR3SdqWOsixIKVhwegx5S9aXdRe1p2QhTY+I4DnQ5JvmYdfXFVUxGEg0rQGZyRelwGmsnSznW7X8iqHt0vGhBpXRIskr9VpqFWh6ZkRQozrgpKWyLYhLaAnHRqpuTNCWTJJQxJCWIKGYQFBQhv8w7cWaYG/kurCX8Tuw2kjVt/h2EqH3RTw9S3yoNvmj9J9WY/pIQ1tpdNmsWo9lW5Wj/lQb3fS/PA9/TG8tQOtI/vDk83eeD/THjx//ZLNwQfw04//AV+hMApmeu6FNasNFovmWR//aAyvvGdbY80xRkmqkjieeeELGj5y8LuZcAw2vEJ+OMfvKJ+E9LoeFzKDkxgAogspn7Ov0woKdVJWZ4JE6VIKEFD51oVUFwN4rhYMda30PX3ndp1p8BkTl9u/XZPHZw7imIMVRfS9tFhcom2BR/TSEEn0zOh66kdrExMmZ3BC7mV43Ibm9jzPGXORq6dqOAFvRQ5O/IshuPAhMwa7Xq814ZLmmYCAlK2iJahyTtyzx5AbMXGr/tM1hINPm41P8XmLyI40dNMsid+JYcbNVw8LrZmbXXXLcBMNyNNerUslgzidRrGE7t2Ku4u1T4ThA5RdlXCOiUpuhTrp7Rv7zeQNmkuZRdd0x44+4MoHSZoUMkNlseXKPP/j66/g8uHgMElbRvwHbO6Dr15+/sWrN18QMaRIPcOGg8PBIYMz2rpSqNZIb7CYwBtvka7lgzXu3f6lrv1LXfuXuvYvde1f6tq/1LV/qWv/Utf+pa79S137l7r2L3XtX+rav9S1f6lr/1LX/qWu/Utd+5e69i917V/q2r/UtX+pa/9S1/6lrv1LXfuXuvYvde1f6tq/1PXraYn9S137l7r2L3XtX+rasY/2L3X96i91hRx1IuSgKoRUrfs7/sLE6er9rndpMqO7FMenyfU1ZZC8pZRn+vxDjYYuYrxLk0thJEXY+BpGGu8OUD78BVJ2+ec+xNs/oZFTbxVyOtba7RO6/OBbPM8yrNyNddvXPV5/8+aEcofDcwSlzqmNEXNKKxZzn/AcBI8vCgh+YaUQalpzen7i+6TrDpTQ2L0rccF3JcIfrSx/uhuworB7icJPg/6lSW1tcH3t72FwNr6v74t2tgiMjbVp5d4tl8v/AUQ3M9Q=",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,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,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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options":{\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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 "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\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:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(27471)}),"\n",(0,s.jsx)(u(),{...t(16737)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},27471(e){e.exports=JSON.parse('{"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":true},"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":false},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"selfsigndocument_body"}}},"required":true}}')},16737(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[285],{97831(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>w,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":"eJztXF9zGzeS/yp9U1dlmzukRFp2fCqva71xduO7xHHFcqVyklcLzjRJWDPABMCI4qpYlYf9Bvd0VXcv+9HySa66AQxn+EeynGTXd8c8OOLgX6PRaHT/uoHrxImpTY5Pkxc6q0tUzibv0iRHmxlZOalVcpyczBAsFhMrpwqev34JU1RohEMLAt5++xW4mXCASowLtDAxiNYtCgSqL9UU9AQE5KH/AXyva8iEAlFYDVJlRZ0jaB5MFFAZ7Oc4kQpzmMt8is6mMJ/JbAZu5vtEw+0xlw60AbyqhMqhrrQCYUEh5pgP4GQmLVRGX8qcCY3U4FWFRqLKqLNSFsKA09z3Tz/+1xua4ve6NjTfn378b5gUeg5Scfk3FSquIKpqcKbO1ImsjuFtVWiRw0LXBl6/+EMzUeqVvp32ei9wXE/h7cte7939mXOVPT44oD50hYrIKsTYDjJdHuRUsconD2jKaJB69XMVVhYLEHmLKW6GCjJdLSDT2uRS0YqkUIkpgqrLMRqbAnGm1AZpDgIMinzRd7pfW4R/ffPNK5hoUwo3gNdFbdNmuFwazFyx8N3T3OOs7lkYC4uPj8A6I9U0hVJcEFulgx9qmV3QtC2qPDL1+euXzKte701dVdo4zOE7P4XjXo9Kfo/EY2GQ62e6LLWCShhRokNjvXRRscEfamlYLtwMRFFEXhyfqT70ekqUeNzrwVslf6gRZI7KyYlEQ7MER/LgGwx8fbeouP5LlcuMxZkIoK8ksp2qxFSq+qbCjLr0VVusBq2ClBIP58Kvf1WIzE/LoK0wc/ISux1fpbCgjl+g0pGCmTbyL1o5UfDyXaJxMhNFe5mJQN4OThhH7K+0VC5+DSM0O41WmxcxyCGRlhNzS6m4xCJciqJGG6iapzAjqr7FyqAlrRD7JcarHGYop7Od44n8fW1dp2OoLZHZpiKMFVeV2YvMtokoLIKcdHhZigtsjdZojAH8fgE5TkRduBQkSagzNQ7glXa0UwuZkWJiGaDNJlxtsM+rHMRn0BWf1yudkcvJBA1tZirkLkKbSB3JpVcyND3eaW4mFGi1ttCZLrTZFCH+3OUjZFo51pTPL4UsmHg/Wduoy3EhsosUxkWNKRjM/UZfYFHoeer3B1chheh5zvwhNU5SqBXRr3QYXlqwgapGccb9R4WNcqZBpG1zNezyiaaRiQVxSwKWQhYpMy6F93oMTroCU9rglVCLFHLhMAWHV26sr1LIZphdjPVV4NdEK2flX7bsulhyd66NUjhK4XEKT1IYHqYwHKUwPEph+DiF4ZMURocpjEYpjI5SGD32PB09CfwUDRPbBAxHnpPu0+PgTOZ4ToXnRP+5sA6NtBekduE7Ojv8iZ2nXu3hlSMl1hyy+eokkxZmMs9RwcToEgxmspKsFfyubrpOYVw7MES4sjCpi2IBl9LK1jybTvWcDnJ/tErTOlyzTNe0jsxFzzhm2WpZVbEgUk9QlJY5+oVyaCojLZLKVbbhgHIr+fEHGX1rb+QPWS3V1SS7VyyuQApG5FITN5xWKeRGV7meq3ASfiUt6046wmxzKs47p+JwAL1eo6/o25///OczdX2mAM4SUl9nyTGcJU2VsyT1ZXQqUdkw/L6iHw9Hn4WfC/r5ePQk/Jxz1eFR+Dmjn6PYNGygs+SYx+UKUjk/ctCT0KKAKi3P1DIQe6ZGPAsnyuqGGVDxr0s9NOTH04Y+0jGRxgLaZZv07Jixr7Ex24c0W6mkk6Kwuycca3xCc14jafu0V5U2Zn5EM2d9tXvaXPwJzblND5XwWeiL+OxsFUWNz1SMbmDRep+7dDC1Yitng5OPBsEU2c1IP4VPho8tcn4pNq51eXcuPiYu0pF5QkfmblY2p+onxM91mn4ppm7r9+6c/WzAxixbILv5Gip8QlztUvRL8XSz17tz9AlxlEy53eyk0k+Ily1yqCDYxb7s8Kg/fNQfHY6OOvwklMFXKMt+nvcXi8XPW4tSqnNPBzVq1S/F1faCAAA1hbwaN6ytr7e2XGRWhvmSZRmdRW/aCofeQt5EAthRX9UKrgv/Hb3nr8lnHkd3EvMIOzWORQPWtB1ep3OxuGd9V7Fp40NR/XUL2JPJRUQHA1fZTMssEE91ouc0JmxmQDzo89Id5PlBa+noY573y7K/9pF+9nmlWx/LcpDng7WaG+LgP5aQ5ylsft76Pc+hLMsdn/33zueDstycxaAsA22Be1HCNta5lEqWNflBhIF5d5oqkisR2FuGtZQKer3vv//++/7XX/dfvOj14hqGIYKstmAHP4K4+oVGaAt9r3cMLyfQ/sSuvwddeK837h+5NU2FmZ6r6PUEADavCf2LVT30U4oFd4bSzdB0x9FmJbLkI5JLNdZuNoC37ELS39HValwidpf+hdRj8HF3a8hQ4e+lJFe6sDvwjQqU0FfyXTeVT0eDbhg/UTFV260jg9O6EAavCKuzUqsNzfcxJ93dTrE1tRhleYWZMAoYcFiMkAXc/yZ42g8aMHBtLtTbc8hq6xh4mOIVVMI5NIo7uxSFzAXvjz5/wCtRVgSSHPzp7Cz/zT8fMAxLSKfzuEEup5LQ84M/nT7v//u7LTXqqkKTCYtQII1kU0CXDeB0hkW1AvDn8/lg/tBmM60Lj96/twYn/t9zPX5/zuRWA2GrB9tm6oWhBXuSsKyjnrw5WxwTFmLLLcAnLw3vmuEh22kBj7jBUAs1PiHrYo0kKvQYMhWf0gHPJiwJL67+1qRzzpJ3q+OeoU7Mb2n77gO2J+2GQoyx2Cy6+9YqxELXYUdHaL871SDRLb4Fg6dBb3k6h2mrUFytFfqy5ZZ96hnS3qbxtI/bM64AFNI2B0mHne3WAeDnMA0F30hsxwixAYwbKf3Zu6Ah7MO2QURBee1uGYLqAVdsgisNnnrzCJ2F2TjJg60Qo0STptfIsniQt/lFLWuLZmUm3DBCsBV2j0Ahmd0DnKkhY42yFNMbXBAu/oS0RJueHXCVr7Hhbw0ZlPTsugFk4fKbJzw87Ez4UXfCjw8/wpzoDHsjK1o2w2FL55iyLsSGBZBjJktRcDyShx79DA22Ba9Zp/pj7IdAO8n357qsauflO1gO5Jmwjo+CHgNxPgTxmxT6KfRSOEjhfgoPBvAtcugua8J8Qe6l8cE8qSDXNeH5WW2KBYwN8SYFHEwHcH39Qy2Uk26xXEIPrq8p3WG5HJCmuFB67iN9pxTbcECR+pVdkOvMbons68wekAFx8Arn/ZhscRBIewD39ZpmvNGaCizYUKedZaamrxql4O0ejvxKWxViAWJC4Q4fHeRmPog8IA4cwwh++wyGo8HhYQqH/m+4H8cfPeCNxHh3hsVNYDcX37aNDtvbaPVzm954dPhB+6g97Eca5dTFOceieNztxvpWDfQJGueryazDAa1zg3jmjww703WR06lh0NVGYZPPEU6NJE10RUlAUquXeXKcxAShJGVeo3W/1/kiOb5OQmCW/gxBNGp08N5SctF1YrMZloL+imtE6UgTWWCSJt7btEmaMHJJuUkkWslxosfvMXNJSl5RRWYUWuqD2x1fx1o+SSVJAwKVHCc+eyVJk+ApNJ8AVaYJdqnySbKMA97UVfNl1ZXlP5ogJ/VDeR0f2c0rarpcS8f6qJ5etHrguZV4oknLFujwhVjYVr9eIJL1LDBqQ0KQhVaQi4Ull722XjoyUWR1Qc4+XlXSLBqkixGmhiUtepuRGnqHj5Zx0VsU7Vhro+++QBlqYgDHae7a9r3GMeLvwgdS67y+orwzFe81whh5bauZVnduPxw9HI6GD4cj6iFg0HftIx5R1MV7PT7/KHnP8ZLah2Os1VoYIxZJmkiHpb19KX3p5thdEXxOAXfMo8fRX4WeUx+THdy2G2J95ryY4u1if7Irz6uVehK0pagqFGbA6VYfnfnX3UmNATS4Zd8s0+Tq9slcQab7MYkM7hc4cR7ugEwbheZBG77+ZCY3Ojpapsni9ukt/ldO7zNavPnts/uOs+9WmYn/CFofPlmmyex2Wr9s8gP/gcQePV6uzvEkMygcOiwr6uR8rPPFedRby3bFaMnEE8tXDYfSkkYscjRk9Gzqq5WqoZqUB3u+ftSMtS5QqC2KppOGJEjXWYYoCAAJBtt8huwDNcgF924byCXAJd5qCtGCDgIrLVnnpsazZEDBgJWHxaDHeiZUrMuZUErDPR7v3Nasxu8dhN/EoXvtnF1Ki1zFrSIJXBniElA2blEQ3WRBDKD5j63LhpNEQDyx48C3HxWfe8SYBwyNuhmgEKzUAXwuVJMh2M3rguvrRghYOpZLuL6mVUVzTuf+cpmuPtBYnQ98tPsvBjOUl51WzSdcNWy+tZp6Y4qjKP5DOO/bBIRIS21CP2RzLpeDjkCuEQ4zxtCYB5g3ckYZeJuzbkwmXukP5v4Gs4MEUCf/b/j+tHr2pdxCytOD6tnT6tl3lO9dod97nj0TqXK/8+dYFAN4ap3RavpsjQVPD8L37Utp8FLinDcur+qql3XeNh0NAk10AaK1eNJCZupMioJDJUZnGJPw2YGkzFHrsLIEy0rnA3+crsuWv5gaRE75JFpE7Ti/nZ3AOOBTATODk9/eW+PpvWecEkoAy9MD8SzUfumR25m4RBBqATxxBrC18Qj0pDasJrNCGDkJHmcKVYEU1iGHVGQeUfYcjXSczIS6sOnTsXlGyaVNUupPf/0b1eBtwEmzJ7o2H6DTGWju+7UNmays83wnIGBac6TfEZ+ieuKI0yqnXCrrTO2x3xh2bUdpeT2sHYSs+T7hOz5NdYbt/lNAZX1zARMGDVKolaTUWVNXJDmbV2Q6oswDLMm/9/dDaI1u1wXd5G26LuSvtrSCyfEciB1juM0TXM3m4kBMHV6f+taDN+yT2wmkQ5IRwQD7V2isViRL2kyFCqLqDX9tyXGbicJX9ftVUp4ER8Mp/3yrk/XTX//Womun97lJmB9B5DnBR7dQyMgN4TOWIX+DVbEAp7sUUX9ofrduaxF1JZopnmfklfGewQ+Q8F6PZLzXg77Pow7ibWt/EcLFOz28jrSkq96Jb0H/N7kuEVzIO1epBvClnuMlCWzYwqRoff+aEF6mPCSyt0fIhOJEA9rnZJ1Qx02OCyWpr4bwmdks4jyboGQovOvH4zsoNE5605yiKDdJPILvnoXRY2Y9TY6QKhCF5vxx17rdlneJesnXC2asCjhZg0JQfpx4r4dT6X/68T/pvltEvW1j3m0tZQuNb+BxxkW712itxYs4g649FrWA0k5OFudanTcnhd0qMN2WNwpQa4+zua6DbghnJ9BNON4QPHjQ66RPFElHuOQXUk9sR2dsrO/uwYghv9CABOAdw7c4FSYvmg3sl9Hx7TnRFiQ/1C5p4ONzh9gJ50Q2Q76tkGNF9++0gnsrB6RlndN6EvyB6pyx5w+BbYKGWrZW8zSh20cM9+ZJ6rHr5N0yTcZZ9rE9kvLq4Gspfxp1vm3cTx1nGdwfF5LYI8xY+1uRD47hLetCkdM+5DOnK0zdRfXMZ3XSOWzI+olaiVl3m6vovckVmB0cGLoBqJX1m2R0eEj/687jRUcc6TyuMzrf+B7NPyXphyPpN4Nt/vN2B/Ym9Gz2Xo7+cpVdjl7Tsu04/G/sIDj7tSnoEipxrt/sFz6EWryVqpAKzyPbzkeHh+dD4u0yTY62se+NLtHryTkxcU4mbXNgOLMAMSWNT66n+QW5icZoczMWcDfKbmLCUYcJjzaZ8FJxAglf0z7RF6j+vjNtD+/88ETqVcmy4u2xRPpKXJ50Jtv+7idpMauNdIvk+PQ6ueqLSvZ9+fHpu+U7slncTFP8qdKWKRZulhwnB61wlEVzSTEk6oGFtpFDK1RO+R0bwJOo5MHlcDBMlul6m61A1Q31se7ftYl1YirV9LZ271bceUMr6Bepw6OVFq7kvyGp4bAE7VppIklyZihyArgoHGC1+nYVxPsiLm8Mr22LmLWU4loMLIbAOlGtdR2+JU61PUw1fNQOEPkQEEd1mqDOtjhNM/EYeWkCL61YSiuUsoqOdIIjHO9ohTtOV3uhiSzEwMKQEfnR0RFD158NGeN9+ITh06PHy3cdJDFJumghh6jXMa+fB+F0EZw9LPF/CJboohLBzO566VHAGq+445que6Y7vcStTmIYcLtDEArb1uZ2yzEYjh9qBC5JbU0067iwOZsrxHT6sI7cCKFgkemyucHb67U42bTq9Rrd5aWBLPlvagOVnqOZ1P5a8KTAK77XTM2w5LIVXI+iJHu/WADhK1P2/TgDRxQNepGJSoxlIel4pWo6yOXqhLYDuqgdAf97xqcAXWJBpzKJrC4FoyONsTrX5oKeLKGXP2BMqVHkdaCaCZV5hMIfGCnJJDk3q4vT1hmiWnratHKGhLEUSkx5m6RtsYMcC9IaFoweUwKj1UXthd0JWWjjUwJ4QiT6lpn4xVVFRRwHIlVrcEbydRlwKktX2+l6LS9zeLxkTLBxRbRIcludhloVmt4ZIci4LihriYwbUgN60qGRmjsjlCWbNGQhhDVoGBYgJLTBQXxrkVb4K6ku/E3sPpw2cvUdjq102M0BX98jD7pt/ijdl/WYXtLQVjptFqvWU+lm9ZhP9XYnzQ/f0x/DYzvQOrM/PNvsjXc07cHz1y/ZHnwAP/34H/AVCqNgpudeWrPaYLFo3vXxr8bwynu2NeYcg5SkK4njmRe+oOIjB7+bCcdowyvkl3P8lvJZSK/rcSEzOIkRILqR8jk7O62oUCdndSZIlC6lAAGVb11IdTGA52rBWNdK4dN3bteZBh8ycbn94zV5fOcgjjlYUUTfS4vFJdoWekRPDZFEz4yup360NjFhcgYn5F+G121obs/znEEXuXqrhjPwVuTgxD8ZggsfM2O06/VaEy5p3gkIUNkqXIIq58w9ewy5ERO36j9dgzj4uNn4FN+3iOxIQzfNkvidGGbcfPW40Jq92dW3jDfRgDzt1bpUMojTaRRL6F6uuLtY+0wYPkHZVwkHmajkVqyTHr+x30zeoLmUWfRNd+zoA658kKRJITNUFlu+zPM/vv4KLh8ODpO0ZcV/wOY++Orl51+8evMFEUOK1DNsODgcHDI6o60rhWqN9AaLCbzxJulaQljj3+2f6to/1bV/qmv/VNf+qa79U137p7r2T3Xtn+raP9W1f6pr/1TX/qmu/VNd+6e69k917Z/q2j/VtX+qa/9U1/6prv1TXfunuvZPde2f6to/1bV/qmv/VNf+qa79U12/npbYP9W1f6pr/1TX/qmuHfto/1TXr/5UV0hSJ0IOqkJI1brA429MnK4e8HqXJjO6THF8mlxfUwbJW8p5ps8/1GjoJsa7NLkURlKEje9hpPHyACXEXyCll3/uQ7z9Exo59VYhp2OtXT+h2w++xfMsw8rdWLd93+P1N29OKHk4vEdQ6pzaGDGnvGIx9xnPQfD4poDgJ1YKoaY15+cnvk+670AJjd3LEhd8WSL80Urzp8sBKwq7tyj8NOhfmtTWBtfX/iIGp+P7+r5oZ4vA2FibVu7dcrn8H0i5NDk=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),u=t.n(h),m=(t(77675),t(19365),t(51107)),x=t(21312);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:"eJztXF9zGzeS/yp9U1dlmzukRFp2fCqva71xduO7xHHFcqVyklcLzjRJWDPABMCI4qpYlYf9Bvd0VXcv+9HySa66AQxn+EeynGTXd8c8OOLgX6PRaHT/uoHrxImpTY5Pkxc6q0tUzibv0iRHmxlZOalVcpyczBAsFhMrpwqev34JU1RohEMLAt5++xW4mXCASowLtDAxiNYtCgSqL9UU9AQE5KH/AXyva8iEAlFYDVJlRZ0jaB5MFFAZ7Oc4kQpzmMt8is6mMJ/JbAZu5vtEw+0xlw60AbyqhMqhrrQCYUEh5pgP4GQmLVRGX8qcCY3U4FWFRqLKqLNSFsKA09z3Tz/+1xua4ve6NjTfn378b5gUeg5Scfk3FSquIKpqcKbO1ImsjuFtVWiRw0LXBl6/+EMzUeqVvp32ei9wXE/h7cte7939mXOVPT44oD50hYrIKsTYDjJdHuRUsconD2jKaJB69XMVVhYLEHmLKW6GCjJdLSDT2uRS0YqkUIkpgqrLMRqbAnGm1AZpDgIMinzRd7pfW4R/ffPNK5hoUwo3gNdFbdNmuFwazFyx8N3T3OOs7lkYC4uPj8A6I9U0hVJcEFulgx9qmV3QtC2qPDL1+euXzKte701dVdo4zOE7P4XjXo9Kfo/EY2GQ62e6LLWCShhRokNjvXRRscEfamlYLtwMRFFEXhyfqT70ekqUeNzrwVslf6gRZI7KyYlEQ7MER/LgGwx8fbeouP5LlcuMxZkIoK8ksp2qxFSq+qbCjLr0VVusBq2ClBIP58Kvf1WIzE/LoK0wc/ISux1fpbCgjl+g0pGCmTbyL1o5UfDyXaJxMhNFe5mJQN4OThhH7K+0VC5+DSM0O41WmxcxyCGRlhNzS6m4xCJciqJGG6iapzAjqr7FyqAlrRD7JcarHGYop7Od44n8fW1dp2OoLZHZpiKMFVeV2YvMtokoLIKcdHhZigtsjdZojAH8fgE5TkRduBQkSagzNQ7glXa0UwuZkWJiGaDNJlxtsM+rHMRn0BWf1yudkcvJBA1tZirkLkKbSB3JpVcyND3eaW4mFGi1ttCZLrTZFCH+3OUjZFo51pTPL4UsmHg/Wduoy3EhsosUxkWNKRjM/UZfYFHoeer3B1chheh5zvwhNU5SqBXRr3QYXlqwgapGccb9R4WNcqZBpG1zNezyiaaRiQVxSwKWQhYpMy6F93oMTroCU9rglVCLFHLhMAWHV26sr1LIZphdjPVV4NdEK2flX7bsulhyd66NUjhK4XEKT1IYHqYwHKUwPEph+DiF4ZMURocpjEYpjI5SGD32PB09CfwUDRPbBAxHnpPu0+PgTOZ4ToXnRP+5sA6NtBekduE7Ojv8iZ2nXu3hlSMl1hyy+eokkxZmMs9RwcToEgxmspKsFfyubrpOYVw7MES4sjCpi2IBl9LK1jybTvWcDnJ/tErTOlyzTNe0jsxFzzhm2WpZVbEgUk9QlJY5+oVyaCojLZLKVbbhgHIr+fEHGX1rb+QPWS3V1SS7VyyuQApG5FITN5xWKeRGV7meq3ASfiUt6046wmxzKs47p+JwAL1eo6/o25///OczdX2mAM4SUl9nyTGcJU2VsyT1ZXQqUdkw/L6iHw9Hn4WfC/r5ePQk/Jxz1eFR+Dmjn6PYNGygs+SYx+UKUjk/ctCT0KKAKi3P1DIQe6ZGPAsnyuqGGVDxr0s9NOTH04Y+0jGRxgLaZZv07Jixr7Ex24c0W6mkk6Kwuycca3xCc14jafu0V5U2Zn5EM2d9tXvaXPwJzblND5XwWeiL+OxsFUWNz1SMbmDRep+7dDC1Yitng5OPBsEU2c1IP4VPho8tcn4pNq51eXcuPiYu0pF5QkfmblY2p+onxM91mn4ppm7r9+6c/WzAxixbILv5Gip8QlztUvRL8XSz17tz9AlxlEy53eyk0k+Ily1yqCDYxb7s8Kg/fNQfHY6OOvwklMFXKMt+nvcXi8XPW4tSqnNPBzVq1S/F1faCAAA1hbwaN6ytr7e2XGRWhvmSZRmdRW/aCofeQt5EAthRX9UKrgv/Hb3nr8lnHkd3EvMIOzWORQPWtB1ep3OxuGd9V7Fp40NR/XUL2JPJRUQHA1fZTMssEE91ouc0JmxmQDzo89Id5PlBa+noY573y7K/9pF+9nmlWx/LcpDng7WaG+LgP5aQ5ylsft76Pc+hLMsdn/33zueDstycxaAsA22Be1HCNta5lEqWNflBhIF5d5oqkisR2FuGtZQKer3vv//++/7XX/dfvOj14hqGIYKstmAHP4K4+oVGaAt9r3cMLyfQ/sSuvwddeK837h+5NU2FmZ6r6PUEADavCf2LVT30U4oFd4bSzdB0x9FmJbLkI5JLNdZuNoC37ELS39HValwidpf+hdRj8HF3a8hQ4e+lJFe6sDvwjQqU0FfyXTeVT0eDbhg/UTFV260jg9O6EAavCKuzUqsNzfcxJ93dTrE1tRhleYWZMAoYcFiMkAXc/yZ42g8aMHBtLtTbc8hq6xh4mOIVVMI5NIo7uxSFzAXvjz5/wCtRVgSSHPzp7Cz/zT8fMAxLSKfzuEEup5LQ84M/nT7v//u7LTXqqkKTCYtQII1kU0CXDeB0hkW1AvDn8/lg/tBmM60Lj96/twYn/t9zPX5/zuRWA2GrB9tm6oWhBXuSsKyjnrw5WxwTFmLLLcAnLw3vmuEh22kBj7jBUAs1PiHrYo0kKvQYMhWf0gHPJiwJL67+1qRzzpJ3q+OeoU7Mb2n77gO2J+2GQoyx2Cy6+9YqxELXYUdHaL871SDRLb4Fg6dBb3k6h2mrUFytFfqy5ZZ96hnS3qbxtI/bM64AFNI2B0mHne3WAeDnMA0F30hsxwixAYwbKf3Zu6Ah7MO2QURBee1uGYLqAVdsgisNnnrzCJ2F2TjJg60Qo0STptfIsniQt/lFLWuLZmUm3DBCsBV2j0Ahmd0DnKkhY42yFNMbXBAu/oS0RJueHXCVr7Hhbw0ZlPTsugFk4fKbJzw87Ez4UXfCjw8/wpzoDHsjK1o2w2FL55iyLsSGBZBjJktRcDyShx79DA22Ba9Zp/pj7IdAO8n357qsauflO1gO5Jmwjo+CHgNxPgTxmxT6KfRSOEjhfgoPBvAtcugua8J8Qe6l8cE8qSDXNeH5WW2KBYwN8SYFHEwHcH39Qy2Uk26xXEIPrq8p3WG5HJCmuFB67iN9pxTbcECR+pVdkOvMbons68wekAFx8Arn/ZhscRBIewD39ZpmvNGaCizYUKedZaamrxql4O0ejvxKWxViAWJC4Q4fHeRmPog8IA4cwwh++wyGo8HhYQqH/m+4H8cfPeCNxHh3hsVNYDcX37aNDtvbaPVzm954dPhB+6g97Eca5dTFOceieNztxvpWDfQJGueryazDAa1zg3jmjww703WR06lh0NVGYZPPEU6NJE10RUlAUquXeXKcxAShJGVeo3W/1/kiOb5OQmCW/gxBNGp08N5SctF1YrMZloL+imtE6UgTWWCSJt7btEmaMHJJuUkkWslxosfvMXNJSl5RRWYUWuqD2x1fx1o+SSVJAwKVHCc+eyVJk+ApNJ8AVaYJdqnySbKMA97UVfNl1ZXlP5ogJ/VDeR0f2c0rarpcS8f6qJ5etHrguZV4oknLFujwhVjYVr9eIJL1LDBqQ0KQhVaQi4Ull722XjoyUWR1Qc4+XlXSLBqkixGmhiUtepuRGnqHj5Zx0VsU7Vhro+++QBlqYgDHae7a9r3GMeLvwgdS67y+orwzFe81whh5bauZVnduPxw9HI6GD4cj6iFg0HftIx5R1MV7PT7/KHnP8ZLah2Os1VoYIxZJmkiHpb19KX3p5thdEXxOAXfMo8fRX4WeUx+THdy2G2J95ryY4u1if7Irz6uVehK0pagqFGbA6VYfnfnX3UmNATS4Zd8s0+Tq9slcQab7MYkM7hc4cR7ugEwbheZBG77+ZCY3Ojpapsni9ukt/ldO7zNavPnts/uOs+9WmYn/CFofPlmmyex2Wr9s8gP/gcQePV6uzvEkMygcOiwr6uR8rPPFedRby3bFaMnEE8tXDYfSkkYscjRk9Gzqq5WqoZqUB3u+ftSMtS5QqC2KppOGJEjXWYYoCAAJBtt8huwDNcgF924byCXAJd5qCtGCDgIrLVnnpsazZEDBgJWHxaDHeiZUrMuZUErDPR7v3Nasxu8dhN/EoXvtnF1Ki1zFrSIJXBniElA2blEQ3WRBDKD5j63LhpNEQDyx48C3HxWfe8SYBwyNuhmgEKzUAXwuVJMh2M3rguvrRghYOpZLuL6mVUVzTuf+cpmuPtBYnQ98tPsvBjOUl51WzSdcNWy+tZp6Y4qjKP5DOO/bBIRIS21CP2RzLpeDjkCuEQ4zxtCYB5g3ckYZeJuzbkwmXukP5v4Gs4MEUCf/b/j+tHr2pdxCytOD6tnT6tl3lO9dod97nj0TqXK/8+dYFAN4ap3RavpsjQVPD8L37Utp8FLinDcur+qql3XeNh0NAk10AaK1eNJCZupMioJDJUZnGJPw2YGkzFHrsLIEy0rnA3+crsuWv5gaRE75JFpE7Ti/nZ3AOOBTATODk9/eW+PpvWecEkoAy9MD8SzUfumR25m4RBBqATxxBrC18Qj0pDasJrNCGDkJHmcKVYEU1iGHVGQeUfYcjXSczIS6sOnTsXlGyaVNUupPf/0b1eBtwEmzJ7o2H6DTGWju+7UNmays83wnIGBac6TfEZ+ieuKI0yqnXCrrTO2x3xh2bUdpeT2sHYSs+T7hOz5NdYbt/lNAZX1zARMGDVKolaTUWVNXJDmbV2Q6oswDLMm/9/dDaI1u1wXd5G26LuSvtrSCyfEciB1juM0TXM3m4kBMHV6f+taDN+yT2wmkQ5IRwQD7V2isViRL2kyFCqLqDX9tyXGbicJX9ftVUp4ER8Mp/3yrk/XTX//Womun97lJmB9B5DnBR7dQyMgN4TOWIX+DVbEAp7sUUX9ofrduaxF1JZopnmfklfGewQ+Q8F6PZLzXg77Pow7ibWt/EcLFOz28jrSkq96Jb0H/N7kuEVzIO1epBvClnuMlCWzYwqRoff+aEF6mPCSyt0fIhOJEA9rnZJ1Qx02OCyWpr4bwmdks4jyboGQovOvH4zsoNE5605yiKDdJPILvnoXRY2Y9TY6QKhCF5vxx17rdlneJesnXC2asCjhZg0JQfpx4r4dT6X/68T/pvltEvW1j3m0tZQuNb+BxxkW712itxYs4g649FrWA0k5OFudanTcnhd0qMN2WNwpQa4+zua6DbghnJ9BNON4QPHjQ66RPFElHuOQXUk9sR2dsrO/uwYghv9CABOAdw7c4FSYvmg3sl9Hx7TnRFiQ/1C5p4ONzh9gJ50Q2Q76tkGNF9++0gnsrB6RlndN6EvyB6pyx5w+BbYKGWrZW8zSh20cM9+ZJ6rHr5N0yTcZZ9rE9kvLq4Gspfxp1vm3cTx1nGdwfF5LYI8xY+1uRD47hLetCkdM+5DOnK0zdRfXMZ3XSOWzI+olaiVl3m6vovckVmB0cGLoBqJX1m2R0eEj/687jRUcc6TyuMzrf+B7NPyXphyPpN4Nt/vN2B/Ym9Gz2Xo7+cpVdjl7Tsu04/G/sIDj7tSnoEipxrt/sFz6EWryVqpAKzyPbzkeHh+dD4u0yTY62se+NLtHryTkxcU4mbXNgOLMAMSWNT66n+QW5icZoczMWcDfKbmLCUYcJjzaZ8FJxAglf0z7RF6j+vjNtD+/88ETqVcmy4u2xRPpKXJ50Jtv+7idpMauNdIvk+PQ6ueqLSvZ9+fHpu+U7slncTFP8qdKWKRZulhwnB61wlEVzSTEk6oGFtpFDK1RO+R0bwJOo5MHlcDBMlul6m61A1Q31se7ftYl1YirV9LZ271bceUMr6Bepw6OVFq7kvyGp4bAE7VppIklyZihyArgoHGC1+nYVxPsiLm8Mr22LmLWU4loMLIbAOlGtdR2+JU61PUw1fNQOEPkQEEd1mqDOtjhNM/EYeWkCL61YSiuUsoqOdIIjHO9ohTtOV3uhiSzEwMKQEfnR0RFD158NGeN9+ITh06PHy3cdJDFJumghh6jXMa+fB+F0EZw9LPF/CJboohLBzO566VHAGq+445que6Y7vcStTmIYcLtDEArb1uZ2yzEYjh9qBC5JbU0067iwOZsrxHT6sI7cCKFgkemyucHb67U42bTq9Rrd5aWBLPlvagOVnqOZ1P5a8KTAK77XTM2w5LIVXI+iJHu/WADhK1P2/TgDRxQNepGJSoxlIel4pWo6yOXqhLYDuqgdAf97xqcAXWJBpzKJrC4FoyONsTrX5oKeLKGXP2BMqVHkdaCaCZV5hMIfGCnJJDk3q4vT1hmiWnratHKGhLEUSkx5m6RtsYMcC9IaFoweUwKj1UXthd0JWWjjUwJ4QiT6lpn4xVVFRRwHIlVrcEbydRlwKktX2+l6LS9zeLxkTLBxRbRIcludhloVmt4ZIci4LihriYwbUgN60qGRmjsjlCWbNGQhhDVoGBYgJLTBQXxrkVb4K6ku/E3sPpw2cvUdjq102M0BX98jD7pt/ijdl/WYXtLQVjptFqvWU+lm9ZhP9XYnzQ/f0x/DYzvQOrM/PNvsjXc07cHz1y/ZHnwAP/34H/AVCqNgpudeWrPaYLFo3vXxr8bwynu2NeYcg5SkK4njmRe+oOIjB7+bCcdowyvkl3P8lvJZSK/rcSEzOIkRILqR8jk7O62oUCdndSZIlC6lAAGVb11IdTGA52rBWNdK4dN3bteZBh8ycbn94zV5fOcgjjlYUUTfS4vFJdoWekRPDZFEz4yup360NjFhcgYn5F+G121obs/znEEXuXqrhjPwVuTgxD8ZggsfM2O06/VaEy5p3gkIUNkqXIIq58w9ewy5ERO36j9dgzj4uNn4FN+3iOxIQzfNkvidGGbcfPW40Jq92dW3jDfRgDzt1bpUMojTaRRL6F6uuLtY+0wYPkHZVwkHmajkVqyTHr+x30zeoLmUWfRNd+zoA658kKRJITNUFlu+zPM/vv4KLh8ODpO0ZcV/wOY++Orl51+8evMFEUOK1DNsODgcHDI6o60rhWqN9AaLCbzxJulaQljj3+2f6to/1bV/qmv/VNf+qa79U137p7r2T3Xtn+raP9W1f6pr/1TX/qmu/VNd+6e69k917Z/q2j/VtX+qa/9U1/6prv1TXfunuvZPde2f6to/1bV/qmv/VNf+qa79U12/npbYP9W1f6pr/1TX/qmuHfto/1TXr/5UV0hSJ0IOqkJI1brA429MnK4e8HqXJjO6THF8mlxfUwbJW8p5ps8/1GjoJsa7NLkURlKEje9hpPHyACXEXyCll3/uQ7z9Exo59VYhp2OtXT+h2w++xfMsw8rdWLd93+P1N29OKHk4vEdQ6pzaGDGnvGIx9xnPQfD4poDgJ1YKoaY15+cnvk+670AJjd3LEhd8WSL80Urzp8sBKwq7tyj8NOhfmtTWBtfX/iIGp+P7+r5oZ4vA2FibVu7dcrn8H0i5NDk=",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,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,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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options":{\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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 "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\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:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(27471)}),"\n",(0,s.jsx)(u(),{...t(16737)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},27471(e){e.exports=JSON.parse('{"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":true},"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":false},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"selfsigndocument_body"}}},"required":true}}')},16737(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/34593b53.a8f0af8c.js b/assets/js/34593b53.a8f0af8c.js deleted file mode 100644 index b56d84ce3..000000000 --- a/assets/js/34593b53.a8f0af8c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9099],{28598(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>f,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdlyHDeSv4Kt2AhJPdXVB0lJ5moUQ0taWzu2xJCodXhJDQddhe6GWAWUARSbbUZHzMP8wT7t63yav2QjE0BdffAQbVMz7QeLjcKRSGQmEnkAl4GhEx3sHwcvZVxkTBgdfAyDhOlY8dxwKYL94GjKyAvFqGHE1yIHh68JTVM506TQTGliJJkwwRTUEmxGEt8fGc1JruQ5T7iYkIQaSmbcTMmIavZ4lzARy4QlZMxTFp2IE3HE833yIU8lTchcFoocvvzPsjcYBsqOO52XbFRMyIfXnc7Hh1Njcr3f69E8j2TOhOYTkdKRjmKZ9RKomCfjRyGZTZli0CuJqSCMap7OCU0SMuPJhBkdEjNlgsQyn5NYSpVwQQ3TIcnphBFRZCOmdEioSEgmFSNcEEoUo8m8a2S30Iz81/u3b8hYqoyaiBymhQ7L4RKuWGzSue3eTFk5qwfaY0MbxcUkJBk9A2xxQ34qeHwG09ZMJPAvNDw4fI246nTeF3kulWEJ+cFOYb/TgS9fs1TOCFUM68cyy6QgOVU0YwaXa0oNflbsp4IrlthFoWnqcbF/Irqk0xE0Y/udDvkg+E8FIzxhwvAxZwpmScyUa9cgsvXNPMf6r0XCY0AeAgClRI6bVQGpUPV9zmLo0latoZpIQWZTHk8RhzNq1z9PaWynpZjOWWz4OWt2fBGSOXT8kgnpIZhKxX+WwtAUl++cKcNjmtaXGQCEqtpQZQD9ueTC+FI3AvnRLSesNi6io0MALQHkZlzgF83IOU0Lph1Us5BMAap3LFdMI2u4fgHxIiFTxifTtePR5FOhTaNjUmgAsw6FG8uvKqKXIdrGNNWM8HEDlxk9Y7XRiESep2lEvp6ThI1pkZqQcKBQowoWkTfSEJrnKY/pKGVIA8Bs1BSKdXGVHflETfI5RAnANKEk4eMxU8DM8BG7cG08dECXlchATjNTKogUrYWOZSrVMglhcROPJJbCMGEicnBOeYrA28lqwkWcFgkjo5TGZyEZpQULiWKJZfQ5AzEXOqEFVQjVDueIH6JZClQoBcAvpBuea6IdVElEjoBRSv6Djx7VOAjXdaw6Lh9LGBlQ4FmSsIzyNETEheSTHBHDTcpCYPCcinkI8pWFxLALM5IXIYmnLD7DvxRNuCSjwhgp7MQSJfNEzoTD5VgKo/nPKzjSf7k5Roch2Q3J45A8DcmgH5LBMCSD3ZAMHodk8DQkw35IhsOQDHdDMnxswRo+dbimJYLrAAyGFsvmy8LulCfsFBqewtxOqTZMcX0G4pr8AHsOEwBcElpxyS4MCD+URnwiWFLtgFyTKU8SJshYyYwoFvOcozSx0qDsOgR4iIJJCU3GRZrOyTnXvIaDslM5E4A3HJEr8jZn4j2fCELjWBawxohhi1REZ7XkIp0DqEeMZhpn/koYpnLFNQNRLXSJAWEq2rIbIJTVBcB1VlI0JdD61Vy3OrWVgR30O65R5sLWp8vddNbYTQcR6XRKOQdlf/3rX0/E5Ykg5CQAsXcS7JOToKxyEoT2G+xm8G3gfl/Aj53hE/dzDj8fD5+6nzOsOth1P6fwc+ibOuY6CfZxXKzAhbEjO/lKahBApcWJWDhgT8QQZ2Folm+YAXz+daEnJfh+l4JC2F5C/wE4cBmeNTO2NZZmuwOz5YIbTlO9fsK+xj2acwuk1dOuKi3NfBdmjrJs/bTx8z2acx0e+IJ7qP2Ee27tk98NEIrhBhS1+1wng6EVakdLmNyLnAqzHpF2CvcGjzVw7gqNrS5vjsXHgEXYTo9gO12PynLHvUf4bMN0V0hd1e/NMfskQiUYtZP1eHUV7hFWmxDdFU6Xe705Rp8CRkHNW49O+HqPcFkDBz44ndl+6+92B3vdYX+428AnWCdshSzrJkl3Pp9/3lpkXJxaOKBRrX5GL1Z/AKMJqI7lSpRfQIPhYlI2a35dXnVbr7WQoHA6TIDO6Y+fVukFExXqzsu2BTz6V7XcgQf/9ufx7+EUPvIHVJY4rbk6jpTmn/oR2siEzh9o25VvWp68oH5bN7Zg4ieAA01h8VTy2AEPdfx5awTWnghw0MVF7SVJr7aoUJgk3SzrtgrhZxdpoFaYZVGSRK2aS4RiCzOSJCFZLl5ZniQky7I1xba8UdzLsuVZRFnmYHPY87S3tM4ZFzwr4IQEVjV7QIeKcMhw6M3cWnJBOp0ff/zxx+7333dfvux0/Bq6IRwV1wwZdgR6cUcj1Im+09knr8ekXoTGBGvGQSlQHgydSdVWmMqZ8OchPDUqkhRgT/RVrTEpo3PsjHEzZao5jlQVycLpEQ5bI2mmEfmAh0v42x/CysMSHqS+AsHpTsbrZaer8FuJz0pKNgfeKFrXi6aGbF1Si7xgylfrTYpNipQqdgHWP82lWJKJt9kDb7a/tcSip+XK0oJ2RWfZZd7QQR6+dWfwR6V5sTUX6O2AxIU2aJKYsAuSU2OYEtjZOU15QpE/uljALmiWg2ml95eTk+QP/95Dwy7YTo21KCR8wsEe3/vL8UH3fz6uqFHkOVMx1YykDEbSIWEmjsjxlKV55RKYzWbRbEfHUylT6w/4pBUb2/+fytGnUwQ3j6jOH62aqSWGmiEViKVtR0XmrGGMauJbrjCl4tIg1wz6qME5S8UGFc7VuEd6Rwsk+Git0vD5GLZ+VG6BeFn1twSZcxJ8rLZ7NJ6y5Iq2H6/BnsANKR2xdPnTzVkrpXNZOI72zoLmVB1F1/DmVKHSHozT6Ye1j/Si9dF+W6zgU4uQOpv63d6zp18BknJdbiQNdNZbO5cBOn4EY+hLGjHiG4CbzkuBz+WCErDrsYG3j+LaXTEE1CNYsXTX+NGuGKGxMEs7udMVvN9pXPbqUeY38jq+oCV4Pys1YcMITldYPwI4edYPcCIGaIX01ssN5xNX4x7JihZIm9n4NlKksTPfZku9FQP6adUZcMX2ClXtxloyn17PfRF5a03qvhGY2+OY5aBpfTZrliBfe4dCq3Hdgr6e8uq17hH1rQDrV6ZAV++ud59bEWl99l8QoTbAvjaxWqN/Ricb7Df4+R6RZx2e1SYOV2PJWDVAS7/dUTZYqPH75gkP+o0J7zUn/Lh/ixNXY9jPP3D1N+BnaSg4WxcpXdoOEhbzjKYYQYJwDz+DR29z+HKAAQ+8kFlemDrToVkHBYvXEnxchPXs/iEk3ZB0QtILycOQPIrIO4aRFHEZdeGUBq5sbAUXJJEFuEnjQqVzMlIw8ZCwaBKRy8ufCioMN/PFgnTI5SXEbi0WEXDhmZAzG3hxDC5jQyBwqjpUJTLWKwKtZKx7cPrqvWGzrg8V6znQHpGHsiUSNh5FHQp+2xOZhapGJDDKm1Jls6dSjPThOk/pnNAxuKltNAg2s0FDEaB4nwzJH5+TwTDq90PSt3+Th36Cw0fIw+hjilm6yUmJn6/i4H6dg6ufq0TWXv9aLFwf9pYcDF2cYgwBjnulwlYx9z00nVSTaRtra1o94Mzun3oqizSB3VMxUyjByvi9UqfvdA4VG/M0rYXvEV/keRrCoVjKMhcy5gL34DiDoQpcGAl842M5Op0RG0sIU4D4QTQM0irAz45tt+5GCEgMEZ5SkSnV1s6CmAaIIUDSTFnWCpjw4FVBE1x42IGUB3dnERx+1STux3sN4t5r7k9riXsdBW8wFEITnUuhS38gqz7VqA779OXLR4s2JflOYbkxXqYK+0EhhoST8jNWlzVcaK+lOSjbYXAvplLqqoaLRHNyV+83I9ykgiC3R1EZGvK5bq/Bk52GEvH0N3R7NVepv9sb7PU2+r1aLpKbHxYJuc6SolX9WkuKNas13TqFPscp9PkcsXOXhtnBk2HjPLGzaXO+J4bZOkddYZK9C8Prrc62qyygdT68pu3zN7NBfj5Z7v4a1piW4H4y+B2sMZ9LoktGlzsjSnJXFpdVlHkNk8tGO8tnU24d2F+devfuxjzTOut81dAGvxrWqXVv7/OotW2cqZHcScD/++u372b9P38zkQcHBwdv3n+YvvowOTg4yOB3FEUrTXaryACHAf3Z5QG5LR7VhTWjRFGE7npq6D427+Vi8h+2fbi+TXQigjCQOWRqcSleJ8F+gKo/8yeBIETEMG2+lsk82L8MXKQ//Okir6Fp75OG9LDLQMdTllH4yyMUEsogoSsIAxuIoIMwwHA3yC6DtQ72Azn6xGIYLVcAjuFMQx/Ybv/S17IZUUHo1LdgP7BTDMLAOZHLojKXLE/GwcIPuKmrsqTqSuMf5bEI+oEkolt28waaLloJdbfq6WWtB5xbxo4k2JBSZthLOte1fu1pNGjn8UEbkAKxa0USOtcgTQptt8SYpnGRgorJLnKu5mUQFOqZNfoo4S1HKuEd7C2qRa9AokrReRAG3LCsXr6GCJS8+crFTAJmMOr3pm0/STZi7E+uAKxZuPA0uzEUnyQjI4aLnk+luHH7wXBnMBzsDIbQg4tovGkf3jIHXXySo9NbMULCzqG9O+Xffint1+Wxm7R5AOkbLPGaWrdKZAhthH90FZv4+oh5OmFX88PRumzDWpKTs+HQPGdURZj0d+v80yaLlTt/dAVDLcLg4urJXJBYdn0qI3mYsrGxITIklkow9age8nhvJjfc3V2Ewfzq6c2/yOk9gcWbXT27HzAHtMqP/T1g3Xm6CIPp1bB+W2ap/o7A7j5eVBt8S385Hclkfurl1uKqin6vgnpjmSZMgU60LK8qUQMSBrKxT9tbzUjKlFGxQtA0ktpc3jwo5uCocOad2ZSh66fU17H36jDg3BoWWhdh2oja4xr0aFWwkyCCANLqaIGqfjuvztfFvDohyQMc71QXKMYf9NxvwNGDeuY42J6rWGcPAlYmhmV5iqnUMzBgj9DSnUSk/A+VzxKTAIDfsf3AV28VL2yUIQ7oGjXzkIlTXyPygooyF7WZJUguL0syQOpYLMjlJawqU6ew7y8WYVUAYzUKcGu3JYrFjJ83WpVFrGpYltWaWi0LI29tgdvv6wC46NxCuX5AGV0sogZBtgBHE77DAUtKOoN8zuVZlyoTrvS1sb+EbEcB0Mm/DN6f5c+/5StAedbLnz/Ln/8Atw7kzPKeRc+Yi8Ry/oylaUSeaaOkmDxvoeBZz5WvXkrFzjmbIePiqla9tHFbdhQ5mH4EQV0tHtckVkXMaYrhtUrGzHuK0K0Fp3ttWK7Bf8qNDRbHxHA8EtCJYuiXQlhoYfCWBTwd+gGfUTJVbPzHBy2cPniOCcbgV37Wo89d7dfWXjGl54xQMSc4cTSuSGUtd+NCoZiMU6r42B1FQ5KnDEKB4aRKY+v5tRj1cBxNqTjT4bOReg6pymWK8y9//wfU8DL9tXirEqauIdQhRN9aWh6AHHsQ2rBkJHeutPEh+CgJHYWUofmrWMdldIJ/+lUp+nUx0lBL+P4q0WoUn0wYePZcDWzskucZjad200CoKjd1DsQjC+3BAwLzB8LExQ6U6QJ1c1ANO7V0BDv3aJVUx4T2t0eH18Al2qq6llFckjnO0vZB3h4dwoUd5XJDNkKJCY9a2qhCwBJAzjn1Sf2lZj+3oZzMumicXKx7QiN3VUaXLAOUcL0SotBu6iDhyutwljquboCBJZKFAc8qd9ntyGUNPCIUJSKPZHEdqrwCk5RMCkxaMsC+ftfE4Pnqwg0utFGFDWP1GST1hBMUE1pXePJYgUq1/kPChLbNKRmjhz0kheCAeVWA+bLskl3kTHGIZFmJAsUs6kB0XL1FNW+v+PDuO3fvTy0vxvOQ75glpMiRapATyltV/Mq1p75SH3Ti+2oAQXfD+Bxng82Z0lKAiJNqQoWToPY8CobWEZvS1FZ1ogK8e5jYA/S68uz/y9//UYNrrVFkGTA7Ak0SiLW4AkK0WVuCh+hlxXKQgLIJEfTH1J/aRwCADpnmNJNJyUj6+jR+iMkgupSLLlKhjJTQRTyFbauUtzoss+adUUGjebq8bUPmMF92wbWp3SThE/yW5cM7l/dVwYCHUOBqoHkxrzN4FcEhW93h8YA375QpD0FLvEALI08Vy7i43j5VdwcYWQqCwsiMGh4T35WOmjcFWS+15+usilsCajznUj1aw6rQ3akUMTvl4pSdM3WN430txApskiNmZoyJOmweSXY7q+7/mMHlKQ2ctJLlGlCCcTJjasJOY7BQIdWxayCx04GuOh3StYA4maoL5Rw37pYtFB4gR6reARynC5e5otWGW7/cLCLfyhkgrFRnQOm0/QM+CULuroipjxBTgYl6oPPASQ06LsMB4PqXaggbwoOLhbNxCldsPTrQC9wKBeOEm+bk5WeZBEvhZic/ur+zBiYH5nxCU4n85NTK1pU2CNRrvNRnivsPrh84oOw4/qYtvKTml7/9nwYlxgU+6vKou/IrnlZpqqXNWKz36snZE3zUPJt6ehbS8PH8VIrTSo6sJJhmy40EtCLqqqnKCCeFcXCv0QClA3UAou0uBv/opjBpr+/6wQAhdzQgeDn2yTs2oSpJy13DLqPB++xonZDsUOuoAY8Sa8iOGkPjKcN7gBKWw414UpAHlTGmZqmA9QRTMBOn6J+8jgnbbYuL2moeB+DGRJ9YEoTWXxx8XITBKI5v2yPsmA1fQ4hFw0bZ0jWMozgmD0cpB/RQNZL2nsJH+04ZpgnwISo6Lb24sagW+ShOGhoOrx0DIjTUAPJsNN8qI38TNn9Jnc999Vun1brxssVsBNkDGJmIZwnUsbxBa8lr8Ku5HTb5EFxU3daD8AWZ2Af9/j+zB2Gn/+V4EHb7X5AH4SkA64JCrpYm6851K2WHD/DY3OCTZNbFm0q1uSbsPOicsKFJqxBcscNwYf+rnB5eiF/hCLGekiqCw5lx/GQQDcN+H/5pLufLhnoBh/oihkMy3jj4b0F4/fCRzWtgi1c7ZzZJ9eknPvz5Ij4fHgYuNKFpRbjhxnKr+AJo044uWGPL2DgVxxCFSuHCYZhLt9TEsNvaGnORcsFO/QKeJjI+9bNf4DlI6+Yudy0YyuVG62Jzra8YPrCEubuKit7LjFn1fwb9zsBqXZ6DjJoTOoGDDPC4ukOiYkpdxX43g2wTCnb7/dNBiYS9ZSS8FnivAN6ufSTPmPhtZ1of3tjhAdSLLK1kYMBtJfweNCZbL7eT1CwuFDfzYP/4Mrjo0px37ff944+Lj0CCZiohAi2XGiGmZhrsB72lgDTN1DkGFB1fWr4pWUFTkUDg7dL+QHPeOx9Eg2ARttus3E821GdF96ZNtKETLiZXtftY4eg9rKNdqgamKjmV8z8zEFRuIeq1woAD/UwZBaMQoB7I410VxvfKL7IPsFsVM1ctZjsKzgfBNeLa2vv6iki11YFqg71aiNixj/bCAK4yfmtVSFY5dR9kVcZY1cKmalFTVSBUIw4KQ5tqkU3HFU+UQUT+BDBA1Xm4u4s65pMBKmM7T1HP2X28QCquogaCoBkZgEGlbf/257lrm97arQvyn8gF2fJAOuKp3GjOsFT3B7mipn/EU2Hpj2g4Bdo+gbX2+TXmeTdkywxdArLK+ru30ujqmqw2sLmPdevNakuMM8Rc36hSs2mskABejW/yPwScA//v9JH/d/vI/0/7jROEw3XVQ3UOQGW/1PXdBCp9HpT2jyC0uRhLlPhOUJX3cMOOjDvG0rmPpbHMymuwO50aUZWtOp1SklvGAKPd20KRXM6YGhf2bu1xyi7wcnBoxjL8VkUpMZqBaS+FnDXDJmjmxXRo8F0671hMczriKQeVw6alWhattBYdwW3nPs7pgbIJ3+cpKCqlTwLutPNK5kyqszGES4ENcQR58GBfZGJKRWwdYHb3REcOmJmqy8e1UQA0t6BJYRSwZUYFnaDACOsMSBKWgvzURMkR+Ie1TAvL9obyVCobIY3zwSQNxOGrixw+4dkVdh3FpsBE584NqkPrhrYbo3s4ZAQe/xxg4WCgNpIUIpXwxgdEDhQpZJAb682HI3IdRmhuFBUa9HMXlO2WoESY81Ay7UzBHzSDBf6OizN7m3mXHJdk9QMbaW5Y87a0tiB41GzzDTffFiN4xUJqbqSaV60n3EyLEao49U7KH7anb/wzMTUF5vpXC7y3JmXdOzh8jSryI/LL3/6XfMeoEmQqZ5ZY40KxdF69SIMvtuDKW7SVGi76wGHXAIzHlvjcZucx+MOUGvQrvGEzcOBYjrK5HIfFKOUxOfJxb3B3o3sqp4qFa9zuZHOxITCBkty2Trk4i8iBmKMrtdr6oBzbNaaB223tdR0KwfvurQA/ZlRBhM47zdJzpmt+IpZwG+6hZDGxo9WBcZNrpqbD3A6ShOSt9HRwFFbgWAMvxllQa+mFh3BWZLQ30sabQWJMJHiLgt4niaJjU/UftpwZuPEuFflUd4+O0HVTLonlRDfjstR6gFrKd1PcomcJBmw+eERz7sjp2JMlaV5DeHOytsYh1CVqZgc4Bax0pcPDM/rt+D1T5zz2toI1HN3Dyr0gDFIeM2epctvXwTeH35HznagfhLUjzTWYu/fd6xev3rx/BcCAILUIG0T9qI8GdalNRkVtpNaTUu2trZZ2tH2BavsC1fYFqu0LVNsXqLYvUN0Qo9sXqLYvUG1foLrzCw63L1BtX6DavkC1dKXc9gWq7QtU2xeoti9QbV+g2r5AtX2B6l/lssHtC1TbF6jWic/tC1TbF6i2L1Dd64tOty9QbV+g2r5AtX2BavsC1fYFqu0LVJt3n1sR6fYFqptfcbx9gWr7AtX2BartC1TbF6i2L1BtX6DavkC1fYFq+wLV9gWqL8gptH2BavsC1fYFqu0LVNsXqLYvUN2pceaf5AWqWr51L08pF7Urcew1IMftd6k+hsEU7gnZPw4uL2GYD5DFD8U/FZhnfvwxDM6p4hCWjVeMhP5GDMjwPmNwYcILmzPQPYLxQ8v0mFbXulkFrvSwLQ6Q0jfWrV9lcvj2/RGkp7vb9DOZ4B1OdAYZ4XRm0/NraeNYdhmkVEwKTDkPbJ8Le9frtHkDyBneAOL+qOWtw30XFYTNq0HsNOD/MKmVDS4v7e0ieMGErW8/rW3hEOtrw/p9XCwW/w+14wmO","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdlyHDeSv4Kt2AhJPdXVB0lJ5moUQ0taWzu2xJCodXhJDQddhe6GWAWUARSbbUZHzMP8wT7t63yav2QjE0BdffAQbVMz7QeLjcKRSGQmEnkAl4GhEx3sHwcvZVxkTBgdfAyDhOlY8dxwKYL94GjKyAvFqGHE1yIHh68JTVM506TQTGliJJkwwRTUEmxGEt8fGc1JruQ5T7iYkIQaSmbcTMmIavZ4lzARy4QlZMxTFp2IE3HE833yIU8lTchcFoocvvzPsjcYBsqOO52XbFRMyIfXnc7Hh1Njcr3f69E8j2TOhOYTkdKRjmKZ9RKomCfjRyGZTZli0CuJqSCMap7OCU0SMuPJhBkdEjNlgsQyn5NYSpVwQQ3TIcnphBFRZCOmdEioSEgmFSNcEEoUo8m8a2S30Iz81/u3b8hYqoyaiBymhQ7L4RKuWGzSue3eTFk5qwfaY0MbxcUkJBk9A2xxQ34qeHwG09ZMJPAvNDw4fI246nTeF3kulWEJ+cFOYb/TgS9fs1TOCFUM68cyy6QgOVU0YwaXa0oNflbsp4IrlthFoWnqcbF/Irqk0xE0Y/udDvkg+E8FIzxhwvAxZwpmScyUa9cgsvXNPMf6r0XCY0AeAgClRI6bVQGpUPV9zmLo0latoZpIQWZTHk8RhzNq1z9PaWynpZjOWWz4OWt2fBGSOXT8kgnpIZhKxX+WwtAUl++cKcNjmtaXGQCEqtpQZQD9ueTC+FI3AvnRLSesNi6io0MALQHkZlzgF83IOU0Lph1Us5BMAap3LFdMI2u4fgHxIiFTxifTtePR5FOhTaNjUmgAsw6FG8uvKqKXIdrGNNWM8HEDlxk9Y7XRiESep2lEvp6ThI1pkZqQcKBQowoWkTfSEJrnKY/pKGVIA8Bs1BSKdXGVHflETfI5RAnANKEk4eMxU8DM8BG7cG08dECXlchATjNTKogUrYWOZSrVMglhcROPJJbCMGEicnBOeYrA28lqwkWcFgkjo5TGZyEZpQULiWKJZfQ5AzEXOqEFVQjVDueIH6JZClQoBcAvpBuea6IdVElEjoBRSv6Djx7VOAjXdaw6Lh9LGBlQ4FmSsIzyNETEheSTHBHDTcpCYPCcinkI8pWFxLALM5IXIYmnLD7DvxRNuCSjwhgp7MQSJfNEzoTD5VgKo/nPKzjSf7k5Roch2Q3J45A8DcmgH5LBMCSD3ZAMHodk8DQkw35IhsOQDHdDMnxswRo+dbimJYLrAAyGFsvmy8LulCfsFBqewtxOqTZMcX0G4pr8AHsOEwBcElpxyS4MCD+URnwiWFLtgFyTKU8SJshYyYwoFvOcozSx0qDsOgR4iIJJCU3GRZrOyTnXvIaDslM5E4A3HJEr8jZn4j2fCELjWBawxohhi1REZ7XkIp0DqEeMZhpn/koYpnLFNQNRLXSJAWEq2rIbIJTVBcB1VlI0JdD61Vy3OrWVgR30O65R5sLWp8vddNbYTQcR6XRKOQdlf/3rX0/E5Ykg5CQAsXcS7JOToKxyEoT2G+xm8G3gfl/Aj53hE/dzDj8fD5+6nzOsOth1P6fwc+ibOuY6CfZxXKzAhbEjO/lKahBApcWJWDhgT8QQZ2Folm+YAXz+daEnJfh+l4JC2F5C/wE4cBmeNTO2NZZmuwOz5YIbTlO9fsK+xj2acwuk1dOuKi3NfBdmjrJs/bTx8z2acx0e+IJ7qP2Ee27tk98NEIrhBhS1+1wng6EVakdLmNyLnAqzHpF2CvcGjzVw7gqNrS5vjsXHgEXYTo9gO12PynLHvUf4bMN0V0hd1e/NMfskQiUYtZP1eHUV7hFWmxDdFU6Xe705Rp8CRkHNW49O+HqPcFkDBz44ndl+6+92B3vdYX+428AnWCdshSzrJkl3Pp9/3lpkXJxaOKBRrX5GL1Z/AKMJqI7lSpRfQIPhYlI2a35dXnVbr7WQoHA6TIDO6Y+fVukFExXqzsu2BTz6V7XcgQf/9ufx7+EUPvIHVJY4rbk6jpTmn/oR2siEzh9o25VvWp68oH5bN7Zg4ieAA01h8VTy2AEPdfx5awTWnghw0MVF7SVJr7aoUJgk3SzrtgrhZxdpoFaYZVGSRK2aS4RiCzOSJCFZLl5ZniQky7I1xba8UdzLsuVZRFnmYHPY87S3tM4ZFzwr4IQEVjV7QIeKcMhw6M3cWnJBOp0ff/zxx+7333dfvux0/Bq6IRwV1wwZdgR6cUcj1Im+09knr8ekXoTGBGvGQSlQHgydSdVWmMqZ8OchPDUqkhRgT/RVrTEpo3PsjHEzZao5jlQVycLpEQ5bI2mmEfmAh0v42x/CysMSHqS+AsHpTsbrZaer8FuJz0pKNgfeKFrXi6aGbF1Si7xgylfrTYpNipQqdgHWP82lWJKJt9kDb7a/tcSip+XK0oJ2RWfZZd7QQR6+dWfwR6V5sTUX6O2AxIU2aJKYsAuSU2OYEtjZOU15QpE/uljALmiWg2ml95eTk+QP/95Dwy7YTo21KCR8wsEe3/vL8UH3fz6uqFHkOVMx1YykDEbSIWEmjsjxlKV55RKYzWbRbEfHUylT6w/4pBUb2/+fytGnUwQ3j6jOH62aqSWGmiEViKVtR0XmrGGMauJbrjCl4tIg1wz6qME5S8UGFc7VuEd6Rwsk+Git0vD5GLZ+VG6BeFn1twSZcxJ8rLZ7NJ6y5Iq2H6/BnsANKR2xdPnTzVkrpXNZOI72zoLmVB1F1/DmVKHSHozT6Ye1j/Si9dF+W6zgU4uQOpv63d6zp18BknJdbiQNdNZbO5cBOn4EY+hLGjHiG4CbzkuBz+WCErDrsYG3j+LaXTEE1CNYsXTX+NGuGKGxMEs7udMVvN9pXPbqUeY38jq+oCV4Pys1YcMITldYPwI4edYPcCIGaIX01ssN5xNX4x7JihZIm9n4NlKksTPfZku9FQP6adUZcMX2ClXtxloyn17PfRF5a03qvhGY2+OY5aBpfTZrliBfe4dCq3Hdgr6e8uq17hH1rQDrV6ZAV++ud59bEWl99l8QoTbAvjaxWqN/Ricb7Df4+R6RZx2e1SYOV2PJWDVAS7/dUTZYqPH75gkP+o0J7zUn/Lh/ixNXY9jPP3D1N+BnaSg4WxcpXdoOEhbzjKYYQYJwDz+DR29z+HKAAQ+8kFlemDrToVkHBYvXEnxchPXs/iEk3ZB0QtILycOQPIrIO4aRFHEZdeGUBq5sbAUXJJEFuEnjQqVzMlIw8ZCwaBKRy8ufCioMN/PFgnTI5SXEbi0WEXDhmZAzG3hxDC5jQyBwqjpUJTLWKwKtZKx7cPrqvWGzrg8V6znQHpGHsiUSNh5FHQp+2xOZhapGJDDKm1Jls6dSjPThOk/pnNAxuKltNAg2s0FDEaB4nwzJH5+TwTDq90PSt3+Th36Cw0fIw+hjilm6yUmJn6/i4H6dg6ufq0TWXv9aLFwf9pYcDF2cYgwBjnulwlYx9z00nVSTaRtra1o94Mzun3oqizSB3VMxUyjByvi9UqfvdA4VG/M0rYXvEV/keRrCoVjKMhcy5gL34DiDoQpcGAl842M5Op0RG0sIU4D4QTQM0irAz45tt+5GCEgMEZ5SkSnV1s6CmAaIIUDSTFnWCpjw4FVBE1x42IGUB3dnERx+1STux3sN4t5r7k9riXsdBW8wFEITnUuhS38gqz7VqA779OXLR4s2JflOYbkxXqYK+0EhhoST8jNWlzVcaK+lOSjbYXAvplLqqoaLRHNyV+83I9ykgiC3R1EZGvK5bq/Bk52GEvH0N3R7NVepv9sb7PU2+r1aLpKbHxYJuc6SolX9WkuKNas13TqFPscp9PkcsXOXhtnBk2HjPLGzaXO+J4bZOkddYZK9C8Prrc62qyygdT68pu3zN7NBfj5Z7v4a1piW4H4y+B2sMZ9LoktGlzsjSnJXFpdVlHkNk8tGO8tnU24d2F+devfuxjzTOut81dAGvxrWqXVv7/OotW2cqZHcScD/++u372b9P38zkQcHBwdv3n+YvvowOTg4yOB3FEUrTXaryACHAf3Z5QG5LR7VhTWjRFGE7npq6D427+Vi8h+2fbi+TXQigjCQOWRqcSleJ8F+gKo/8yeBIETEMG2+lsk82L8MXKQ//Okir6Fp75OG9LDLQMdTllH4yyMUEsogoSsIAxuIoIMwwHA3yC6DtQ72Azn6xGIYLVcAjuFMQx/Ybv/S17IZUUHo1LdgP7BTDMLAOZHLojKXLE/GwcIPuKmrsqTqSuMf5bEI+oEkolt28waaLloJdbfq6WWtB5xbxo4k2JBSZthLOte1fu1pNGjn8UEbkAKxa0USOtcgTQptt8SYpnGRgorJLnKu5mUQFOqZNfoo4S1HKuEd7C2qRa9AokrReRAG3LCsXr6GCJS8+crFTAJmMOr3pm0/STZi7E+uAKxZuPA0uzEUnyQjI4aLnk+luHH7wXBnMBzsDIbQg4tovGkf3jIHXXySo9NbMULCzqG9O+Xffint1+Wxm7R5AOkbLPGaWrdKZAhthH90FZv4+oh5OmFX88PRumzDWpKTs+HQPGdURZj0d+v80yaLlTt/dAVDLcLg4urJXJBYdn0qI3mYsrGxITIklkow9age8nhvJjfc3V2Ewfzq6c2/yOk9gcWbXT27HzAHtMqP/T1g3Xm6CIPp1bB+W2ap/o7A7j5eVBt8S385Hclkfurl1uKqin6vgnpjmSZMgU60LK8qUQMSBrKxT9tbzUjKlFGxQtA0ktpc3jwo5uCocOad2ZSh66fU17H36jDg3BoWWhdh2oja4xr0aFWwkyCCANLqaIGqfjuvztfFvDohyQMc71QXKMYf9NxvwNGDeuY42J6rWGcPAlYmhmV5iqnUMzBgj9DSnUSk/A+VzxKTAIDfsf3AV28VL2yUIQ7oGjXzkIlTXyPygooyF7WZJUguL0syQOpYLMjlJawqU6ew7y8WYVUAYzUKcGu3JYrFjJ83WpVFrGpYltWaWi0LI29tgdvv6wC46NxCuX5AGV0sogZBtgBHE77DAUtKOoN8zuVZlyoTrvS1sb+EbEcB0Mm/DN6f5c+/5StAedbLnz/Ln/8Atw7kzPKeRc+Yi8Ry/oylaUSeaaOkmDxvoeBZz5WvXkrFzjmbIePiqla9tHFbdhQ5mH4EQV0tHtckVkXMaYrhtUrGzHuK0K0Fp3ttWK7Bf8qNDRbHxHA8EtCJYuiXQlhoYfCWBTwd+gGfUTJVbPzHBy2cPniOCcbgV37Wo89d7dfWXjGl54xQMSc4cTSuSGUtd+NCoZiMU6r42B1FQ5KnDEKB4aRKY+v5tRj1cBxNqTjT4bOReg6pymWK8y9//wfU8DL9tXirEqauIdQhRN9aWh6AHHsQ2rBkJHeutPEh+CgJHYWUofmrWMdldIJ/+lUp+nUx0lBL+P4q0WoUn0wYePZcDWzskucZjad200CoKjd1DsQjC+3BAwLzB8LExQ6U6QJ1c1ANO7V0BDv3aJVUx4T2t0eH18Al2qq6llFckjnO0vZB3h4dwoUd5XJDNkKJCY9a2qhCwBJAzjn1Sf2lZj+3oZzMumicXKx7QiN3VUaXLAOUcL0SotBu6iDhyutwljquboCBJZKFAc8qd9ntyGUNPCIUJSKPZHEdqrwCk5RMCkxaMsC+ftfE4Pnqwg0utFGFDWP1GST1hBMUE1pXePJYgUq1/kPChLbNKRmjhz0kheCAeVWA+bLskl3kTHGIZFmJAsUs6kB0XL1FNW+v+PDuO3fvTy0vxvOQ75glpMiRapATyltV/Mq1p75SH3Ti+2oAQXfD+Bxng82Z0lKAiJNqQoWToPY8CobWEZvS1FZ1ogK8e5jYA/S68uz/y9//UYNrrVFkGTA7Ak0SiLW4AkK0WVuCh+hlxXKQgLIJEfTH1J/aRwCADpnmNJNJyUj6+jR+iMkgupSLLlKhjJTQRTyFbauUtzoss+adUUGjebq8bUPmMF92wbWp3SThE/yW5cM7l/dVwYCHUOBqoHkxrzN4FcEhW93h8YA375QpD0FLvEALI08Vy7i43j5VdwcYWQqCwsiMGh4T35WOmjcFWS+15+usilsCajznUj1aw6rQ3akUMTvl4pSdM3WN430txApskiNmZoyJOmweSXY7q+7/mMHlKQ2ctJLlGlCCcTJjasJOY7BQIdWxayCx04GuOh3StYA4maoL5Rw37pYtFB4gR6reARynC5e5otWGW7/cLCLfyhkgrFRnQOm0/QM+CULuroipjxBTgYl6oPPASQ06LsMB4PqXaggbwoOLhbNxCldsPTrQC9wKBeOEm+bk5WeZBEvhZic/ur+zBiYH5nxCU4n85NTK1pU2CNRrvNRnivsPrh84oOw4/qYtvKTml7/9nwYlxgU+6vKou/IrnlZpqqXNWKz36snZE3zUPJt6ehbS8PH8VIrTSo6sJJhmy40EtCLqqqnKCCeFcXCv0QClA3UAou0uBv/opjBpr+/6wQAhdzQgeDn2yTs2oSpJy13DLqPB++xonZDsUOuoAY8Sa8iOGkPjKcN7gBKWw414UpAHlTGmZqmA9QRTMBOn6J+8jgnbbYuL2moeB+DGRJ9YEoTWXxx8XITBKI5v2yPsmA1fQ4hFw0bZ0jWMozgmD0cpB/RQNZL2nsJH+04ZpgnwISo6Lb24sagW+ShOGhoOrx0DIjTUAPJsNN8qI38TNn9Jnc999Vun1brxssVsBNkDGJmIZwnUsbxBa8lr8Ku5HTb5EFxU3daD8AWZ2Af9/j+zB2Gn/+V4EHb7X5AH4SkA64JCrpYm6851K2WHD/DY3OCTZNbFm0q1uSbsPOicsKFJqxBcscNwYf+rnB5eiF/hCLGekiqCw5lx/GQQDcN+H/5pLufLhnoBh/oihkMy3jj4b0F4/fCRzWtgi1c7ZzZJ9eknPvz5Ij4fHgYuNKFpRbjhxnKr+AJo044uWGPL2DgVxxCFSuHCYZhLt9TEsNvaGnORcsFO/QKeJjI+9bNf4DlI6+Yudy0YyuVG62Jzra8YPrCEubuKit7LjFn1fwb9zsBqXZ6DjJoTOoGDDPC4ukOiYkpdxX43g2wTCnb7/dNBiYS9ZSS8FnivAN6ufSTPmPhtZ1of3tjhAdSLLK1kYMBtJfweNCZbL7eT1CwuFDfzYP/4Mrjo0px37ff944+Lj0CCZiohAi2XGiGmZhrsB72lgDTN1DkGFB1fWr4pWUFTkUDg7dL+QHPeOx9Eg2ARttus3E821GdF96ZNtKETLiZXtftY4eg9rKNdqgamKjmV8z8zEFRuIeq1woAD/UwZBaMQoB7I410VxvfKL7IPsFsVM1ctZjsKzgfBNeLa2vv6iki11YFqg71aiNixj/bCAK4yfmtVSFY5dR9kVcZY1cKmalFTVSBUIw4KQ5tqkU3HFU+UQUT+BDBA1Xm4u4s65pMBKmM7T1HP2X28QCquogaCoBkZgEGlbf/257lrm97arQvyn8gF2fJAOuKp3GjOsFT3B7mipn/EU2Hpj2g4Bdo+gbX2+TXmeTdkywxdArLK+ru30ujqmqw2sLmPdevNakuMM8Rc36hSs2mskABejW/yPwScA//v9JH/d/vI/0/7jROEw3XVQ3UOQGW/1PXdBCp9HpT2jyC0uRhLlPhOUJX3cMOOjDvG0rmPpbHMymuwO50aUZWtOp1SklvGAKPd20KRXM6YGhf2bu1xyi7wcnBoxjL8VkUpMZqBaS+FnDXDJmjmxXRo8F0671hMczriKQeVw6alWhattBYdwW3nPs7pgbIJ3+cpKCqlTwLutPNK5kyqszGES4ENcQR58GBfZGJKRWwdYHb3REcOmJmqy8e1UQA0t6BJYRSwZUYFnaDACOsMSBKWgvzURMkR+Ie1TAvL9obyVCobIY3zwSQNxOGrixw+4dkVdh3FpsBE584NqkPrhrYbo3s4ZAQe/xxg4WCgNpIUIpXwxgdEDhQpZJAb682HI3IdRmhuFBUa9HMXlO2WoESY81Ay7UzBHzSDBf6OizN7m3mXHJdk9QMbaW5Y87a0tiB41GzzDTffFiN4xUJqbqSaV60n3EyLEao49U7KH7anb/wzMTUF5vpXC7y3JmXdOzh8jSryI/LL3/6XfMeoEmQqZ5ZY40KxdF69SIMvtuDKW7SVGi76wGHXAIzHlvjcZucx+MOUGvQrvGEzcOBYjrK5HIfFKOUxOfJxb3B3o3sqp4qFa9zuZHOxITCBkty2Trk4i8iBmKMrtdr6oBzbNaaB223tdR0KwfvurQA/ZlRBhM47zdJzpmt+IpZwG+6hZDGxo9WBcZNrpqbD3A6ShOSt9HRwFFbgWAMvxllQa+mFh3BWZLQ30sabQWJMJHiLgt4niaJjU/UftpwZuPEuFflUd4+O0HVTLonlRDfjstR6gFrKd1PcomcJBmw+eERz7sjp2JMlaV5DeHOytsYh1CVqZgc4Bax0pcPDM/rt+D1T5zz2toI1HN3Dyr0gDFIeM2epctvXwTeH35HznagfhLUjzTWYu/fd6xev3rx/BcCAILUIG0T9qI8GdalNRkVtpNaTUu2trZZ2tH2BavsC1fYFqu0LVNsXqLYvUN0Qo9sXqLYvUG1foLrzCw63L1BtX6DavkC1dKXc9gWq7QtU2xeoti9QbV+g2r5AtX2B6l/lssHtC1TbF6jWic/tC1TbF6i2L1Dd64tOty9QbV+g2r5AtX2BavsC1fYFqu0LVJt3n1sR6fYFqptfcbx9gWr7AtX2BartC1TbF6i2L1BtX6DavkC1fYFq+wLV9gWqL8gptH2BavsC1fYFqu0LVNsXqLYvUN2pceaf5AWqWr51L08pF7Urcew1IMftd6k+hsEU7gnZPw4uL2GYD5DFD8U/FZhnfvwxDM6p4hCWjVeMhP5GDMjwPmNwYcILmzPQPYLxQ8v0mFbXulkFrvSwLQ6Q0jfWrV9lcvj2/RGkp7vb9DOZ4B1OdAYZ4XRm0/NraeNYdhmkVEwKTDkPbJ8Le9frtHkDyBneAOL+qOWtw30XFYTNq0HsNOD/MKmVDS4v7e0ieMGErW8/rW3hEOtrw/p9XCwW/w+14wmO",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,j={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options":{\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(52821)}),"\n",(0,s.jsx)(u(),{...t(64795)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},52821(e){e.exports=JSON.parse('{"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":true},"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"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":true}}')},64795(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/34593b53.e208adbc.js b/assets/js/34593b53.e208adbc.js new file mode 100644 index 000000000..0203266d6 --- /dev/null +++ b/assets/js/34593b53.e208adbc.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9099],{28598(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>j,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdlyHDeSv4Kt2AhJPdXVB0lJ5moUQ0taWzu2xJCodXhJDQddhe6GWAWUARSbbUZHzMP8wT7t63yav2QjE0BdffAQbVMz7QeLjcKRSGQmEnkAl4GhEx3sHwcvZVxkTBgdfAyDhOlY8dxwKYL94GjKyAvFqGHE1yIHh68JTVM506TQTGliJJkwwRTUEmxGEt8fGc1JruQ5T7iYkIQaSmbcTMmIavZ4lzARy4QlZMxTFp2IE3HE833yIU8lTchcFoocvvzPsjcYBsqOO52XbFRMyIfXnc7Hh1Njcr3f69E8j2TOhOYTkdKRjmKZ9RKomCfjRyGZTZli0CuJqSCMap7OCU0SMuPJhBkdEjNlgsQyn5NYSpVwQQ3TIcnphBFRZCOmdEioSEgmFSNcEEoUo8m8a2S30Iz81/u3b8hYqoyaiBymhQ7L4RKuWGzSue3eTFk5qwfaY0MbxcUkJBk9A2xxQ34qeHwG09ZMJPAvNDw4fI246nTeF3kulWEJ+cFOYb/TgS9fs1TOCFUM68cyy6QgOVU0YwaXa0oNflbsp4IrlthFoWnqcbF/Irqk0xE0Y/udDvkg+E8FIzxhwvAxZwpmScyUa9cgsvXNPMf6r0XCY0AeAgClRI6bVQGpUPV9zmLo0latoZpIQWZTHk8RhzNq1z9PaWynpZjOWWz4OWt2fBGSOXT8kgnpIZhKxX+WwtAUl++cKcNjmtaXGQCEqtpQZQD9ueTC+FI3AvnRLSesNi6io0MALQHkZlzgF83IOU0Lph1Us5BMAap3LFdMI2u4fgHxIiFTxifTtePR5FOhTaNjUmgAsw6FG8uvKqKXIdrGNNWM8HEDlxk9Y7XRiESep2lEvp6ThI1pkZqQcKBQowoWkTfSEJrnKY/pKGVIA8Bs1BSKdXGVHflETfI5RAnANKEk4eMxU8DM8BG7cG08dECXlchATjNTKogUrYWOZSrVMglhcROPJJbCMGEicnBOeYrA28lqwkWcFgkjo5TGZyEZpQULiWKJZfQ5AzEXOqEFVQjVDueIH6JZClQoBcAvpBuea6IdVElEjoBRSv6Djx7VOAjXdaw6Lh9LGBlQ4FmSsIzyNETEheSTHBHDTcpCYPCcinkI8pWFxLALM5IXIYmnLD7DvxRNuCSjwhgp7MQSJfNEzoTD5VgKo/nPKzjSf7k5Roch2Q3J45A8DcmgH5LBMCSD3ZAMHodk8DQkw35IhsOQDHdDMnxswRo+dbimJYLrAAyGFsvmy8LulCfsFBqewtxOqTZMcX0G4pr8AHsOEwBcElpxyS4MCD+URnwiWFLtgFyTKU8SJshYyYwoFvOcozSx0qDsOgR4iIJJCU3GRZrOyTnXvIaDslM5E4A3HJEr8jZn4j2fCELjWBawxohhi1REZ7XkIp0DqEeMZhpn/koYpnLFNQNRLXSJAWEq2rIbIJTVBcB1VlI0JdD61Vy3OrWVgR30O65R5sLWp8vddNbYTQcR6XRKOQdlf/3rX0/E5Ykg5CQAsXcS7JOToKxyEoT2G+xm8G3gfl/Aj53hE/dzDj8fD5+6nzOsOth1P6fwc+ibOuY6CfZxXKzAhbEjO/lKahBApcWJWDhgT8QQZ2Folm+YAXz+daEnJfh+l4JC2F5C/wE4cBmeNTO2NZZmuwOz5YIbTlO9fsK+xj2acwuk1dOuKi3NfBdmjrJs/bTx8z2acx0e+IJ7qP2Ee27tk98NEIrhBhS1+1wng6EVakdLmNyLnAqzHpF2CvcGjzVw7gqNrS5vjsXHgEXYTo9gO12PynLHvUf4bMN0V0hd1e/NMfskQiUYtZP1eHUV7hFWmxDdFU6Xe705Rp8CRkHNW49O+HqPcFkDBz44ndl+6+92B3vdYX+428AnWCdshSzrJkl3Pp9/3lpkXJxaOKBRrX5GL1Z/AKMJqI7lSpRfQIPhYlI2a35dXnVbr7WQoHA6TIDO6Y+fVukFExXqzsu2BTz6V7XcgQf/9ufx7+EUPvIHVJY4rbk6jpTmn/oR2siEzh9o25VvWp68oH5bN7Zg4ieAA01h8VTy2AEPdfx5awTWnghw0MVF7SVJr7aoUJgk3SzrtgrhZxdpoFaYZVGSRK2aS4RiCzOSJCFZLl5ZniQky7I1xba8UdzLsuVZRFnmYHPY87S3tM4ZFzwr4IQEVjV7QIeKcMhw6M3cWnJBOp0ff/zxx+7333dfvux0/Bq6IRwV1wwZdgR6cUcj1Im+09knr8ekXoTGBGvGQSlQHgydSdVWmMqZ8OchPDUqkhRgT/RVrTEpo3PsjHEzZao5jlQVycLpEQ5bI2mmEfmAh0v42x/CysMSHqS+AsHpTsbrZaer8FuJz0pKNgfeKFrXi6aGbF1Si7xgylfrTYpNipQqdgHWP82lWJKJt9kDb7a/tcSip+XK0oJ2RWfZZd7QQR6+dWfwR6V5sTUX6O2AxIU2aJKYsAuSU2OYEtjZOU15QpE/uljALmiWg2ml95eTk+QP/95Dwy7YTo21KCR8wsEe3/vL8UH3fz6uqFHkOVMx1YykDEbSIWEmjsjxlKV55RKYzWbRbEfHUylT6w/4pBUb2/+fytGnUwQ3j6jOH62aqSWGmiEViKVtR0XmrGGMauJbrjCl4tIg1wz6qME5S8UGFc7VuEd6Rwsk+Git0vD5GLZ+VG6BeFn1twSZcxJ8rLZ7NJ6y5Iq2H6/BnsANKR2xdPnTzVkrpXNZOI72zoLmVB1F1/DmVKHSHozT6Ye1j/Si9dF+W6zgU4uQOpv63d6zp18BknJdbiQNdNZbO5cBOn4EY+hLGjHiG4CbzkuBz+WCErDrsYG3j+LaXTEE1CNYsXTX+NGuGKGxMEs7udMVvN9pXPbqUeY38jq+oCV4Pys1YcMITldYPwI4edYPcCIGaIX01ssN5xNX4x7JihZIm9n4NlKksTPfZku9FQP6adUZcMX2ClXtxloyn17PfRF5a03qvhGY2+OY5aBpfTZrliBfe4dCq3Hdgr6e8uq17hH1rQDrV6ZAV++ud59bEWl99l8QoTbAvjaxWqN/Ricb7Df4+R6RZx2e1SYOV2PJWDVAS7/dUTZYqPH75gkP+o0J7zUn/Lh/ixNXY9jPP3D1N+BnaSg4WxcpXdoOEhbzjKYYQYJwDz+DR29z+HKAAQ+8kFlemDrToVkHBYvXEnxchPXs/iEk3ZB0QtILycOQPIrIO4aRFHEZdeGUBq5sbAUXJJEFuEnjQqVzMlIw8ZCwaBKRy8ufCioMN/PFgnTI5SXEbi0WEXDhmZAzG3hxDC5jQyBwqjpUJTLWKwKtZKx7cPrqvWGzrg8V6znQHpGHsiUSNh5FHQp+2xOZhapGJDDKm1Jls6dSjPThOk/pnNAxuKltNAg2s0FDEaB4nwzJH5+TwTDq90PSt3+Th36Cw0fIw+hjilm6yUmJn6/i4H6dg6ufq0TWXv9aLFwf9pYcDF2cYgwBjnulwlYx9z00nVSTaRtra1o94Mzun3oqizSB3VMxUyjByvi9UqfvdA4VG/M0rYXvEV/keRrCoVjKMhcy5gL34DiDoQpcGAl842M5Op0RG0sIU4D4QTQM0irAz45tt+5GCEgMEZ5SkSnV1s6CmAaIIUDSTFnWCpjw4FVBE1x42IGUB3dnERx+1STux3sN4t5r7k9riXsdBW8wFEITnUuhS38gqz7VqA779OXLR4s2JflOYbkxXqYK+0EhhoST8jNWlzVcaK+lOSjbYXAvplLqqoaLRHNyV+83I9ykgiC3R1EZGvK5bq/Bk52GEvH0N3R7NVepv9sb7PU2+r1aLpKbHxYJuc6SolX9WkuKNas13TqFPscp9PkcsXOXhtnBk2HjPLGzaXO+J4bZOkddYZK9C8Prrc62qyygdT68pu3zN7NBfj5Z7v4a1piW4H4y+B2sMZ9LoktGlzsjSnJXFpdVlHkNk8tGO8tnU24d2F+devfuxjzTOut81dAGvxrWqXVv7/OotW2cqZHcScD/++u372b9P38zkQcHBwdv3n+YvvowOTg4yOB3FEUrTXaryACHAf3Z5QG5LR7VhTWjRFGE7npq6D427+Vi8h+2fbi+TXQigjCQOWRqcSleJ8F+gKo/8yeBIETEMG2+lsk82L8MXKQ//Okir6Fp75OG9LDLQMdTllH4yyMUEsogoSsIAxuIoIMwwHA3yC6DtQ72Azn6xGIYLVcAjuFMQx/Ybv/S17IZUUHo1LdgP7BTDMLAOZHLojKXLE/GwcIPuKmrsqTqSuMf5bEI+oEkolt28waaLloJdbfq6WWtB5xbxo4k2JBSZthLOte1fu1pNGjn8UEbkAKxa0USOtcgTQptt8SYpnGRgorJLnKu5mUQFOqZNfoo4S1HKuEd7C2qRa9AokrReRAG3LCsXr6GCJS8+crFTAJmMOr3pm0/STZi7E+uAKxZuPA0uzEUnyQjI4aLnk+luHH7wXBnMBzsDIbQg4tovGkf3jIHXXySo9NbMULCzqG9O+Xffint1+Wxm7R5AOkbLPGaWrdKZAhthH90FZv4+oh5OmFX88PRumzDWpKTs+HQPGdURZj0d+v80yaLlTt/dAVDLcLg4urJXJBYdn0qI3mYsrGxITIklkow9age8nhvJjfc3V2Ewfzq6c2/yOk9gcWbXT27HzAHtMqP/T1g3Xm6CIPp1bB+W2ap/o7A7j5eVBt8S385Hclkfurl1uKqin6vgnpjmSZMgU60LK8qUQMSBrKxT9tbzUjKlFGxQtA0ktpc3jwo5uCocOad2ZSh66fU17H36jDg3BoWWhdh2oja4xr0aFWwkyCCANLqaIGqfjuvztfFvDohyQMc71QXKMYf9NxvwNGDeuY42J6rWGcPAlYmhmV5iqnUMzBgj9DSnUSk/A+VzxKTAIDfsf3AV28VL2yUIQ7oGjXzkIlTXyPygooyF7WZJUguL0syQOpYLMjlJawqU6ew7y8WYVUAYzUKcGu3JYrFjJ83WpVFrGpYltWaWi0LI29tgdvv6wC46NxCuX5AGV0sogZBtgBHE77DAUtKOoN8zuVZlyoTrvS1sb+EbEcB0Mm/DN6f5c+/5StAedbLnz/Ln/8Atw7kzPKeRc+Yi8Ry/oylaUSeaaOkmDxvoeBZz5WvXkrFzjmbIePiqla9tHFbdhQ5mH4EQV0tHtckVkXMaYrhtUrGzHuK0K0Fp3ttWK7Bf8qNDRbHxHA8EtCJYuiXQlhoYfCWBTwd+gGfUTJVbPzHBy2cPniOCcbgV37Wo89d7dfWXjGl54xQMSc4cTSuSGUtd+NCoZiMU6r42B1FQ5KnDEKB4aRKY+v5tRj1cBxNqTjT4bOReg6pymWK8y9//wfU8DL9tXirEqauIdQhRN9aWh6AHHsQ2rBkJHeutPEh+CgJHYWUofmrWMdldIJ/+lUp+nUx0lBL+P4q0WoUn0wYePZcDWzskucZjad200CoKjd1DsQjC+3BAwLzB8LExQ6U6QJ1c1ANO7V0BDv3aJVUx4T2t0eH18Al2qq6llFckjnO0vZB3h4dwoUd5XJDNkKJCY9a2qhCwBJAzjn1Sf2lZj+3oZzMumicXKx7QiN3VUaXLAOUcL0SotBu6iDhyutwljquboCBJZKFAc8qd9ntyGUNPCIUJSKPZHEdqrwCk5RMCkxaMsC+ftfE4Pnqwg0utFGFDWP1GST1hBMUE1pXePJYgUq1/kPChLbNKRmjhz0kheCAeVWA+bLskl3kTHGIZFmJAsUs6kB0XL1FNW+v+PDuO3fvTy0vxvOQ75glpMiRapATyltV/Mq1p75SH3Ti+2oAQXfD+Bxng82Z0lKAiJNqQoWToPY8CobWEZvS1FZ1ogK8e5jYA/S68uz/y9//UYNrrVFkGTA7Ak0SiLW4AkK0WVuCh+hlxXKQgLIJEfTH1J/aRwCADpnmNJNJyUj6+jR+iMkgupSLLlKhjJTQRTyFbauUtzoss+adUUGjebq8bUPmMF92wbWp3SThE/yW5cM7l/dVwYCHUOBqoHkxrzN4FcEhW93h8YA375QpD0FLvEALI08Vy7i43j5VdwcYWQqCwsiMGh4T35WOmjcFWS+15+usilsCajznUj1aw6rQ3akUMTvl4pSdM3WN430txApskiNmZoyJOmweSXY7q+7/mMHlKQ2ctJLlGlCCcTJjasJOY7BQIdWxayCx04GuOh3StYA4maoL5Rw37pYtFB4gR6reARynC5e5otWGW7/cLCLfyhkgrFRnQOm0/QM+CULuroipjxBTgYl6oPPASQ06LsMB4PqXaggbwoOLhbNxCldsPTrQC9wKBeOEm+bk5WeZBEvhZic/ur+zBiYH5nxCU4n85NTK1pU2CNRrvNRnivsPrh84oOw4/qYtvKTml7/9nwYlxgU+6vKou/IrnlZpqqXNWKz36snZE3zUPJt6ehbS8PH8VIrTSo6sJJhmy40EtCLqqqnKCCeFcXCv0QClA3UAou0uBv/opjBpr+/6wQAhdzQgeDn2yTs2oSpJy13DLqPB++xonZDsUOuoAY8Sa8iOGkPjKcN7gBKWw414UpAHlTGmZqmA9QRTMBOn6J+8jgnbbYuL2moeB+DGRJ9YEoTWXxx8XITBKI5v2yPsmA1fQ4hFw0bZ0jWMozgmD0cpB/RQNZL2nsJH+04ZpgnwISo6Lb24sagW+ShOGhoOrx0DIjTUAPJsNN8qI38TNn9Jnc999Vun1brxssVsBNkDGJmIZwnUsbxBa8lr8Ku5HTb5EFxU3daD8AWZ2Af9/j+zB2Gn/+V4EHb7X5AH4SkA64JCrpYm6851K2WHD/DY3OCTZNbFm0q1uSbsPOicsKFJqxBcscNwYf+rnB5eiF/hCLGekiqCw5lx/GQQDcN+H/5pLufLhnoBh/oihkMy3jj4b0F4/fCRzWtgi1c7ZzZJ9eknPvz5Ij4fHgYuNKFpRbjhxnKr+AJo044uWGPL2DgVxxCFSuHCYZhLt9TEsNvaGnORcsFO/QKeJjI+9bNf4DlI6+Yudy0YyuVG62Jzra8YPrCEubuKit7LjFn1fwb9zsBqXZ6DjJoTOoGDDPC4ukOiYkpdxX43g2wTCnb7/dNBiYS9ZSS8FnivAN6ufSTPmPhtZ1of3tjhAdSLLK1kYMBtJfweNCZbL7eT1CwuFDfzYP/4Mrjo0px37ff944+Lj0CCZiohAi2XGiGmZhrsB72lgDTN1DkGFB1fWr4pWUFTkUDg7dL+QHPeOx9Eg2ARttus3E821GdF96ZNtKETLiZXtftY4eg9rKNdqgamKjmV8z8zEFRuIeq1woAD/UwZBaMQoB7I410VxvfKL7IPsFsVM1ctZjsKzgfBNeLa2vv6iki11YFqg71aiNixj/bCAK4yfmtVSFY5dR9kVcZY1cKmalFTVSBUIw4KQ5tqkU3HFU+UQUT+BDBA1Xm4u4s65pMBKmM7T1HP2X28QCquogaCoBkZgEGlbf/257lrm97arQvyn8gF2fJAOuKp3GjOsFT3B7mipn/EU2Hpj2g4Bdo+gbX2+TXmeTdkywxdArLK+ru30ujqmqw2sLmPdevNakuMM8Rc36hSs2mskABejW/yPwScA//v9JH/d/vI/0/7jROEw3XVQ3UOQGW/1PXdBCp9HpT2jyC0uRhLlPhOUJX3cMOOjDvG0rmPpbHMymuwO50aUZWtOp1SklvGAKPd20KRXM6YGhf2bu1xyi7wcnBoxjL8VkUpMZqBaS+FnDXDJmjmxXRo8F0671hMczriKQeVw6alWhattBYdwW3nPs7pgbIJ3+csBU2ldErApXZey5xJdTaGeCkwIo4gER4MjExMqYitB8xun+jJATtTdfu4Ngqg5hY2KYwCvsyooBOUGGGdA0nCUhCgmig5Agexlmlh+d5QnkplQ6RxQpilgUh8dZHDJzy8wraj2BS46Nz5QXVo/dB2Z3Qvh4zA5Z8DLBws1EaSQqQSHvmA0IEihRRyY935cEauwwjNjaJCg4LuorLdGpQIcy5Kpp0t+INmsMLfcXFmrzPvkuOSrn5gI80Na16X1pYEj5ptvuHm22IEz1hIzY1U86r1hJtpMUIdp95J+cP29I1/J6amwVz/boH31qaseweHr1FHfkR++dv/ku8YVYJM5cxSa1wols6rJ2nwyRZceYu2UsVFJzhsG4Dx2BKf2+08Bn+YUoOOhTdsBh4cy1I2meOwGKU8Jkc+8A0ub3Rv5VTBcI3rnWwyNkQmUJLb1ikXZxE5EHP0pVZ7H5Rju8Y0cL+tPa9DIXrfPRbgx4wqiNB7p1l6znTNUcQSbuM9lCwmdrQ6MG5yzdx0mNtBkpC8lZ8OnsIKHGvhxUALak298BLOipT2Rt54M0qMiQSvUdD7JFF0bKr+w5Y3A3fepSKf6+7REbpuyiWxnOhmXJZaF1BL+27KW3QtwYDNF49ozh05HXuyJM17CG9O1tY6hMpEze4Ax4CVvnR4eUa/Hb9n6pzH3liwhqN7WLkXhEHKY+ZMVW7/Ovjm8DtyvhP1g7B2prkGc/e+e/3i1Zv3rwAYEKQWYYOoH/XRoi61yaiojdR6U6q9t9XyjrZPUG2foNo+QbV9gmr7BNX2CaobYnT7BNX2CartE1R3fsPh9gmq7RNU2yeolu6U2z5BtX2CavsE1fYJqu0TVNsnqLZPUP2r3Da4fYJq+wTVOvG5fYJq+wTV9gmqe33T6fYJqu0TVNsnqLZPUG2foNo+QbV9gmrz7nMrIt0+QXXzO463T1Btn6DaPkG1fYJq+wTV9gmq7RNU2yeotk9QbZ+g2j5B9QU5hbZPUG2foNo+QbV9gmr7BNX2Cao7Nc78kzxBVUu47uUp5aJ2J469B+S4/TDVxzCYwkUh+8fB5SUM8wHS+KH4pwITzY8/hsE5VRzCsvGOkdBfiQEp3mcMbkx4YXMGukcwfmiZHtPqWlerwJ0etsUBUvrGuvW7TA7fvj+C/HR3nX4mE7zEic4gJZzObH5+LW8cyy6DlIpJgTnnge1zYS97nTavADnDK0DcH7XEdbjwooKweTeInQb8Hya1ssHlpb1eBG+YsPXtp7UtHGJ9bVi/j4vF4v8B8ngJ8w==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var s=t(74848),o=t(28453),r=t(57742),l=t.n(r),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdlyHDeSv4Kt2AhJPdXVB0lJ5moUQ0taWzu2xJCodXhJDQddhe6GWAWUARSbbUZHzMP8wT7t63yav2QjE0BdffAQbVMz7QeLjcKRSGQmEnkAl4GhEx3sHwcvZVxkTBgdfAyDhOlY8dxwKYL94GjKyAvFqGHE1yIHh68JTVM506TQTGliJJkwwRTUEmxGEt8fGc1JruQ5T7iYkIQaSmbcTMmIavZ4lzARy4QlZMxTFp2IE3HE833yIU8lTchcFoocvvzPsjcYBsqOO52XbFRMyIfXnc7Hh1Njcr3f69E8j2TOhOYTkdKRjmKZ9RKomCfjRyGZTZli0CuJqSCMap7OCU0SMuPJhBkdEjNlgsQyn5NYSpVwQQ3TIcnphBFRZCOmdEioSEgmFSNcEEoUo8m8a2S30Iz81/u3b8hYqoyaiBymhQ7L4RKuWGzSue3eTFk5qwfaY0MbxcUkJBk9A2xxQ34qeHwG09ZMJPAvNDw4fI246nTeF3kulWEJ+cFOYb/TgS9fs1TOCFUM68cyy6QgOVU0YwaXa0oNflbsp4IrlthFoWnqcbF/Irqk0xE0Y/udDvkg+E8FIzxhwvAxZwpmScyUa9cgsvXNPMf6r0XCY0AeAgClRI6bVQGpUPV9zmLo0latoZpIQWZTHk8RhzNq1z9PaWynpZjOWWz4OWt2fBGSOXT8kgnpIZhKxX+WwtAUl++cKcNjmtaXGQCEqtpQZQD9ueTC+FI3AvnRLSesNi6io0MALQHkZlzgF83IOU0Lph1Us5BMAap3LFdMI2u4fgHxIiFTxifTtePR5FOhTaNjUmgAsw6FG8uvKqKXIdrGNNWM8HEDlxk9Y7XRiESep2lEvp6ThI1pkZqQcKBQowoWkTfSEJrnKY/pKGVIA8Bs1BSKdXGVHflETfI5RAnANKEk4eMxU8DM8BG7cG08dECXlchATjNTKogUrYWOZSrVMglhcROPJJbCMGEicnBOeYrA28lqwkWcFgkjo5TGZyEZpQULiWKJZfQ5AzEXOqEFVQjVDueIH6JZClQoBcAvpBuea6IdVElEjoBRSv6Djx7VOAjXdaw6Lh9LGBlQ4FmSsIzyNETEheSTHBHDTcpCYPCcinkI8pWFxLALM5IXIYmnLD7DvxRNuCSjwhgp7MQSJfNEzoTD5VgKo/nPKzjSf7k5Roch2Q3J45A8DcmgH5LBMCSD3ZAMHodk8DQkw35IhsOQDHdDMnxswRo+dbimJYLrAAyGFsvmy8LulCfsFBqewtxOqTZMcX0G4pr8AHsOEwBcElpxyS4MCD+URnwiWFLtgFyTKU8SJshYyYwoFvOcozSx0qDsOgR4iIJJCU3GRZrOyTnXvIaDslM5E4A3HJEr8jZn4j2fCELjWBawxohhi1REZ7XkIp0DqEeMZhpn/koYpnLFNQNRLXSJAWEq2rIbIJTVBcB1VlI0JdD61Vy3OrWVgR30O65R5sLWp8vddNbYTQcR6XRKOQdlf/3rX0/E5Ykg5CQAsXcS7JOToKxyEoT2G+xm8G3gfl/Aj53hE/dzDj8fD5+6nzOsOth1P6fwc+ibOuY6CfZxXKzAhbEjO/lKahBApcWJWDhgT8QQZ2Folm+YAXz+daEnJfh+l4JC2F5C/wE4cBmeNTO2NZZmuwOz5YIbTlO9fsK+xj2acwuk1dOuKi3NfBdmjrJs/bTx8z2acx0e+IJ7qP2Ee27tk98NEIrhBhS1+1wng6EVakdLmNyLnAqzHpF2CvcGjzVw7gqNrS5vjsXHgEXYTo9gO12PynLHvUf4bMN0V0hd1e/NMfskQiUYtZP1eHUV7hFWmxDdFU6Xe705Rp8CRkHNW49O+HqPcFkDBz44ndl+6+92B3vdYX+428AnWCdshSzrJkl3Pp9/3lpkXJxaOKBRrX5GL1Z/AKMJqI7lSpRfQIPhYlI2a35dXnVbr7WQoHA6TIDO6Y+fVukFExXqzsu2BTz6V7XcgQf/9ufx7+EUPvIHVJY4rbk6jpTmn/oR2siEzh9o25VvWp68oH5bN7Zg4ieAA01h8VTy2AEPdfx5awTWnghw0MVF7SVJr7aoUJgk3SzrtgrhZxdpoFaYZVGSRK2aS4RiCzOSJCFZLl5ZniQky7I1xba8UdzLsuVZRFnmYHPY87S3tM4ZFzwr4IQEVjV7QIeKcMhw6M3cWnJBOp0ff/zxx+7333dfvux0/Bq6IRwV1wwZdgR6cUcj1Im+09knr8ekXoTGBGvGQSlQHgydSdVWmMqZ8OchPDUqkhRgT/RVrTEpo3PsjHEzZao5jlQVycLpEQ5bI2mmEfmAh0v42x/CysMSHqS+AsHpTsbrZaer8FuJz0pKNgfeKFrXi6aGbF1Si7xgylfrTYpNipQqdgHWP82lWJKJt9kDb7a/tcSip+XK0oJ2RWfZZd7QQR6+dWfwR6V5sTUX6O2AxIU2aJKYsAuSU2OYEtjZOU15QpE/uljALmiWg2ml95eTk+QP/95Dwy7YTo21KCR8wsEe3/vL8UH3fz6uqFHkOVMx1YykDEbSIWEmjsjxlKV55RKYzWbRbEfHUylT6w/4pBUb2/+fytGnUwQ3j6jOH62aqSWGmiEViKVtR0XmrGGMauJbrjCl4tIg1wz6qME5S8UGFc7VuEd6Rwsk+Git0vD5GLZ+VG6BeFn1twSZcxJ8rLZ7NJ6y5Iq2H6/BnsANKR2xdPnTzVkrpXNZOI72zoLmVB1F1/DmVKHSHozT6Ye1j/Si9dF+W6zgU4uQOpv63d6zp18BknJdbiQNdNZbO5cBOn4EY+hLGjHiG4CbzkuBz+WCErDrsYG3j+LaXTEE1CNYsXTX+NGuGKGxMEs7udMVvN9pXPbqUeY38jq+oCV4Pys1YcMITldYPwI4edYPcCIGaIX01ssN5xNX4x7JihZIm9n4NlKksTPfZku9FQP6adUZcMX2ClXtxloyn17PfRF5a03qvhGY2+OY5aBpfTZrliBfe4dCq3Hdgr6e8uq17hH1rQDrV6ZAV++ud59bEWl99l8QoTbAvjaxWqN/Ricb7Df4+R6RZx2e1SYOV2PJWDVAS7/dUTZYqPH75gkP+o0J7zUn/Lh/ixNXY9jPP3D1N+BnaSg4WxcpXdoOEhbzjKYYQYJwDz+DR29z+HKAAQ+8kFlemDrToVkHBYvXEnxchPXs/iEk3ZB0QtILycOQPIrIO4aRFHEZdeGUBq5sbAUXJJEFuEnjQqVzMlIw8ZCwaBKRy8ufCioMN/PFgnTI5SXEbi0WEXDhmZAzG3hxDC5jQyBwqjpUJTLWKwKtZKx7cPrqvWGzrg8V6znQHpGHsiUSNh5FHQp+2xOZhapGJDDKm1Jls6dSjPThOk/pnNAxuKltNAg2s0FDEaB4nwzJH5+TwTDq90PSt3+Th36Cw0fIw+hjilm6yUmJn6/i4H6dg6ufq0TWXv9aLFwf9pYcDF2cYgwBjnulwlYx9z00nVSTaRtra1o94Mzun3oqizSB3VMxUyjByvi9UqfvdA4VG/M0rYXvEV/keRrCoVjKMhcy5gL34DiDoQpcGAl842M5Op0RG0sIU4D4QTQM0irAz45tt+5GCEgMEZ5SkSnV1s6CmAaIIUDSTFnWCpjw4FVBE1x42IGUB3dnERx+1STux3sN4t5r7k9riXsdBW8wFEITnUuhS38gqz7VqA779OXLR4s2JflOYbkxXqYK+0EhhoST8jNWlzVcaK+lOSjbYXAvplLqqoaLRHNyV+83I9ykgiC3R1EZGvK5bq/Bk52GEvH0N3R7NVepv9sb7PU2+r1aLpKbHxYJuc6SolX9WkuKNas13TqFPscp9PkcsXOXhtnBk2HjPLGzaXO+J4bZOkddYZK9C8Prrc62qyygdT68pu3zN7NBfj5Z7v4a1piW4H4y+B2sMZ9LoktGlzsjSnJXFpdVlHkNk8tGO8tnU24d2F+devfuxjzTOut81dAGvxrWqXVv7/OotW2cqZHcScD/++u372b9P38zkQcHBwdv3n+YvvowOTg4yOB3FEUrTXaryACHAf3Z5QG5LR7VhTWjRFGE7npq6D427+Vi8h+2fbi+TXQigjCQOWRqcSleJ8F+gKo/8yeBIETEMG2+lsk82L8MXKQ//Okir6Fp75OG9LDLQMdTllH4yyMUEsogoSsIAxuIoIMwwHA3yC6DtQ72Azn6xGIYLVcAjuFMQx/Ybv/S17IZUUHo1LdgP7BTDMLAOZHLojKXLE/GwcIPuKmrsqTqSuMf5bEI+oEkolt28waaLloJdbfq6WWtB5xbxo4k2JBSZthLOte1fu1pNGjn8UEbkAKxa0USOtcgTQptt8SYpnGRgorJLnKu5mUQFOqZNfoo4S1HKuEd7C2qRa9AokrReRAG3LCsXr6GCJS8+crFTAJmMOr3pm0/STZi7E+uAKxZuPA0uzEUnyQjI4aLnk+luHH7wXBnMBzsDIbQg4tovGkf3jIHXXySo9NbMULCzqG9O+Xffint1+Wxm7R5AOkbLPGaWrdKZAhthH90FZv4+oh5OmFX88PRumzDWpKTs+HQPGdURZj0d+v80yaLlTt/dAVDLcLg4urJXJBYdn0qI3mYsrGxITIklkow9age8nhvJjfc3V2Ewfzq6c2/yOk9gcWbXT27HzAHtMqP/T1g3Xm6CIPp1bB+W2ap/o7A7j5eVBt8S385Hclkfurl1uKqin6vgnpjmSZMgU60LK8qUQMSBrKxT9tbzUjKlFGxQtA0ktpc3jwo5uCocOad2ZSh66fU17H36jDg3BoWWhdh2oja4xr0aFWwkyCCANLqaIGqfjuvztfFvDohyQMc71QXKMYf9NxvwNGDeuY42J6rWGcPAlYmhmV5iqnUMzBgj9DSnUSk/A+VzxKTAIDfsf3AV28VL2yUIQ7oGjXzkIlTXyPygooyF7WZJUguL0syQOpYLMjlJawqU6ew7y8WYVUAYzUKcGu3JYrFjJ83WpVFrGpYltWaWi0LI29tgdvv6wC46NxCuX5AGV0sogZBtgBHE77DAUtKOoN8zuVZlyoTrvS1sb+EbEcB0Mm/DN6f5c+/5StAedbLnz/Ln/8Atw7kzPKeRc+Yi8Ry/oylaUSeaaOkmDxvoeBZz5WvXkrFzjmbIePiqla9tHFbdhQ5mH4EQV0tHtckVkXMaYrhtUrGzHuK0K0Fp3ttWK7Bf8qNDRbHxHA8EtCJYuiXQlhoYfCWBTwd+gGfUTJVbPzHBy2cPniOCcbgV37Wo89d7dfWXjGl54xQMSc4cTSuSGUtd+NCoZiMU6r42B1FQ5KnDEKB4aRKY+v5tRj1cBxNqTjT4bOReg6pymWK8y9//wfU8DL9tXirEqauIdQhRN9aWh6AHHsQ2rBkJHeutPEh+CgJHYWUofmrWMdldIJ/+lUp+nUx0lBL+P4q0WoUn0wYePZcDWzskucZjad200CoKjd1DsQjC+3BAwLzB8LExQ6U6QJ1c1ANO7V0BDv3aJVUx4T2t0eH18Al2qq6llFckjnO0vZB3h4dwoUd5XJDNkKJCY9a2qhCwBJAzjn1Sf2lZj+3oZzMumicXKx7QiN3VUaXLAOUcL0SotBu6iDhyutwljquboCBJZKFAc8qd9ntyGUNPCIUJSKPZHEdqrwCk5RMCkxaMsC+ftfE4Pnqwg0utFGFDWP1GST1hBMUE1pXePJYgUq1/kPChLbNKRmjhz0kheCAeVWA+bLskl3kTHGIZFmJAsUs6kB0XL1FNW+v+PDuO3fvTy0vxvOQ75glpMiRapATyltV/Mq1p75SH3Ti+2oAQXfD+Bxng82Z0lKAiJNqQoWToPY8CobWEZvS1FZ1ogK8e5jYA/S68uz/y9//UYNrrVFkGTA7Ak0SiLW4AkK0WVuCh+hlxXKQgLIJEfTH1J/aRwCADpnmNJNJyUj6+jR+iMkgupSLLlKhjJTQRTyFbauUtzoss+adUUGjebq8bUPmMF92wbWp3SThE/yW5cM7l/dVwYCHUOBqoHkxrzN4FcEhW93h8YA375QpD0FLvEALI08Vy7i43j5VdwcYWQqCwsiMGh4T35WOmjcFWS+15+usilsCajznUj1aw6rQ3akUMTvl4pSdM3WN430txApskiNmZoyJOmweSXY7q+7/mMHlKQ2ctJLlGlCCcTJjasJOY7BQIdWxayCx04GuOh3StYA4maoL5Rw37pYtFB4gR6reARynC5e5otWGW7/cLCLfyhkgrFRnQOm0/QM+CULuroipjxBTgYl6oPPASQ06LsMB4PqXaggbwoOLhbNxCldsPTrQC9wKBeOEm+bk5WeZBEvhZic/ur+zBiYH5nxCU4n85NTK1pU2CNRrvNRnivsPrh84oOw4/qYtvKTml7/9nwYlxgU+6vKou/IrnlZpqqXNWKz36snZE3zUPJt6ehbS8PH8VIrTSo6sJJhmy40EtCLqqqnKCCeFcXCv0QClA3UAou0uBv/opjBpr+/6wQAhdzQgeDn2yTs2oSpJy13DLqPB++xonZDsUOuoAY8Sa8iOGkPjKcN7gBKWw414UpAHlTGmZqmA9QRTMBOn6J+8jgnbbYuL2moeB+DGRJ9YEoTWXxx8XITBKI5v2yPsmA1fQ4hFw0bZ0jWMozgmD0cpB/RQNZL2nsJH+04ZpgnwISo6Lb24sagW+ShOGhoOrx0DIjTUAPJsNN8qI38TNn9Jnc999Vun1brxssVsBNkDGJmIZwnUsbxBa8lr8Ku5HTb5EFxU3daD8AWZ2Af9/j+zB2Gn/+V4EHb7X5AH4SkA64JCrpYm6851K2WHD/DY3OCTZNbFm0q1uSbsPOicsKFJqxBcscNwYf+rnB5eiF/hCLGekiqCw5lx/GQQDcN+H/5pLufLhnoBh/oihkMy3jj4b0F4/fCRzWtgi1c7ZzZJ9eknPvz5Ij4fHgYuNKFpRbjhxnKr+AJo044uWGPL2DgVxxCFSuHCYZhLt9TEsNvaGnORcsFO/QKeJjI+9bNf4DlI6+Yudy0YyuVG62Jzra8YPrCEubuKit7LjFn1fwb9zsBqXZ6DjJoTOoGDDPC4ukOiYkpdxX43g2wTCnb7/dNBiYS9ZSS8FnivAN6ufSTPmPhtZ1of3tjhAdSLLK1kYMBtJfweNCZbL7eT1CwuFDfzYP/4Mrjo0px37ff944+Lj0CCZiohAi2XGiGmZhrsB72lgDTN1DkGFB1fWr4pWUFTkUDg7dL+QHPeOx9Eg2ARttus3E821GdF96ZNtKETLiZXtftY4eg9rKNdqgamKjmV8z8zEFRuIeq1woAD/UwZBaMQoB7I410VxvfKL7IPsFsVM1ctZjsKzgfBNeLa2vv6iki11YFqg71aiNixj/bCAK4yfmtVSFY5dR9kVcZY1cKmalFTVSBUIw4KQ5tqkU3HFU+UQUT+BDBA1Xm4u4s65pMBKmM7T1HP2X28QCquogaCoBkZgEGlbf/257lrm97arQvyn8gF2fJAOuKp3GjOsFT3B7mipn/EU2Hpj2g4Bdo+gbX2+TXmeTdkywxdArLK+ru30ujqmqw2sLmPdevNakuMM8Rc36hSs2mskABejW/yPwScA//v9JH/d/vI/0/7jROEw3XVQ3UOQGW/1PXdBCp9HpT2jyC0uRhLlPhOUJX3cMOOjDvG0rmPpbHMymuwO50aUZWtOp1SklvGAKPd20KRXM6YGhf2bu1xyi7wcnBoxjL8VkUpMZqBaS+FnDXDJmjmxXRo8F0671hMczriKQeVw6alWhattBYdwW3nPs7pgbIJ3+csBU2ldErApXZey5xJdTaGeCkwIo4gER4MjExMqYitB8xun+jJATtTdfu4Ngqg5hY2KYwCvsyooBOUGGGdA0nCUhCgmig5Agexlmlh+d5QnkplQ6RxQpilgUh8dZHDJzy8wraj2BS46Nz5QXVo/dB2Z3Qvh4zA5Z8DLBws1EaSQqQSHvmA0IEihRRyY935cEauwwjNjaJCg4LuorLdGpQIcy5Kpp0t+INmsMLfcXFmrzPvkuOSrn5gI80Na16X1pYEj5ptvuHm22IEz1hIzY1U86r1hJtpMUIdp95J+cP29I1/J6amwVz/boH31qaseweHr1FHfkR++dv/ku8YVYJM5cxSa1wols6rJ2nwyRZceYu2UsVFJzhsG4Dx2BKf2+08Bn+YUoOOhTdsBh4cy1I2meOwGKU8Jkc+8A0ub3Rv5VTBcI3rnWwyNkQmUJLb1ikXZxE5EHP0pVZ7H5Rju8Y0cL+tPa9DIXrfPRbgx4wqiNB7p1l6znTNUcQSbuM9lCwmdrQ6MG5yzdx0mNtBkpC8lZ8OnsIKHGvhxUALak298BLOipT2Rt54M0qMiQSvUdD7JFF0bKr+w5Y3A3fepSKf6+7REbpuyiWxnOhmXJZaF1BL+27KW3QtwYDNF49ozh05HXuyJM17CG9O1tY6hMpEze4Ax4CVvnR4eUa/Hb9n6pzH3liwhqN7WLkXhEHKY+ZMVW7/Ovjm8DtyvhP1g7B2prkGc/e+e/3i1Zv3rwAYEKQWYYOoH/XRoi61yaiojdR6U6q9t9XyjrZPUG2foNo+QbV9gmr7BNX2CaobYnT7BNX2CartE1R3fsPh9gmq7RNU2yeolu6U2z5BtX2CavsE1fYJqu0TVNsnqLZPUP2r3Da4fYJq+wTVOvG5fYJq+wTV9gmqe33T6fYJqu0TVNsnqLZPUG2foNo+QbV9gmrz7nMrIt0+QXXzO463T1Btn6DaPkG1fYJq+wTV9gmq7RNU2yeotk9QbZ+g2j5B9QU5hbZPUG2foNo+QbV9gmr7BNX2Cao7Nc78kzxBVUu47uUp5aJ2J469B+S4/TDVxzCYwkUh+8fB5SUM8wHS+KH4pwITzY8/hsE5VRzCsvGOkdBfiQEp3mcMbkx4YXMGukcwfmiZHtPqWlerwJ0etsUBUvrGuvW7TA7fvj+C/HR3nX4mE7zEic4gJZzObH5+LW8cyy6DlIpJgTnnge1zYS97nTavADnDK0DcH7XEdbjwooKweTeInQb8Hya1ssHlpb1eBG+YsPXtp7UtHGJ9bVi/j4vF4v8B8ngJ8w==",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,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options":{\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(52821)}),"\n",(0,s.jsx)(u(),{...t(64795)})]})}function w(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},52821(e){e.exports=JSON.parse('{"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":true},"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"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":true}}')},64795(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.7c540bbe.js b/assets/js/4227e71a.e04ea00d.js similarity index 69% rename from assets/js/4227e71a.7c540bbe.js rename to assets/js/4227e71a.e04ea00d.js index a7aeda432..e73da6b70 100644 --- a/assets/js/4227e71a.7c540bbe.js +++ b/assets/js/4227e71a.e04ea00d.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5342],{64875(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>b,default:()=>k,frontMatter:()=>g,metadata:()=>r,toc:()=>y});const r=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":"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqPRQN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRiW77Bdd+mq25dV4vPdaZ30L2TsurTPlBXOMQoUrlXzsGtDnahxmcXSC1l5T5oGHMhyNSn5VB5vceLiPuvmuo8PGio86C59jaqc5POtgTKiOLZPC8OzbDoqsnZjVm2r25+Tdn1H+NM1zvab7ijl094pmvKpDvo9A46Ww91nTjuPPRQ50yPkJXE5GMF8b2jfmOb2t/mK55JEF9XwC3h+2ME6Surf/BHhG9LFn3U+xPCt69VxkqU9mjiJyvJ2a+P0Ja2yVcNt/qqX5f3wcHXybtOzZLQzin/+9/ef5x2f3wzUcfHx8c/nXxKXn+aHB8fp/jdbrdXAjsaUJWBdgfCtzEd0gnY8vKJBjRjmqVgQeP9140jgw5peU814jENKMf7r4zZhC5fir39Hre0EprYhFkiAWKD12EhkDHYKAEco2ScDh3b1NiZwJkMTzOBhMB1JlQMdOhVT02UQMro8MYpCiGt5nJCg8Jh+hY5ofP5RVAJySBCv9vF/5qkmjyKwJhxLkglDxrQSEkL0iI8yzLBI9fR+WIQ6WaVChV+gcii4DQOY7mf0jejfLfT61vgmjmuh/S690MoU9P/MKHzgLok87ohFgjG/ahEjlhS2VuQKgU50PmSFu+EWceYBzQDOXKr0tTwmdZshvZiITWr485rA59RvO10doHW4VY1vZgH1ICMQY+8HW6jTGUgMeFIF0ju8mc7FkKA/rZEFiw07UilhRj5eDZSclTdfdaZCJUSwGR9NGep84CmoCcwitAaxmhAcDe0sRIx6Keyrdsl6ulx2Ug6X1jjwhkUBCPp/DY7TazNzLDTKZFzA7qUtJrKBt/b7M7dgquSqsDlmOFOVrdBmlrdRnoE6m4C+6KAhODIuoPpfVEQAnxbNJSyyBIlb5lmcHDY7+2/POohfHFseDj/vvd+llSE+o5eNqmj++NyHb1qqdB784Be3xOnPxjMAzq7J9YRTjW9J9L+y3lAk3siDQ7Rjv0Gf7vMN5nSHWXuHO198b1LdW5G2hP+67211kexbDjtrnVw1WAbfd58rVvx71TMqDDtUfF6hm6HXkB5//9WvtdNd7qGDIw9UKDoVCA+ttsXXr/b39/rdfe6R6e9w+Hg1fDgsN3tdv9JA3qdioVi3aGvtn9X33kWP8k8IFko4FTld2NfQ8w1RHaU67U+a5tZ4XTu1dMoVbHf7pbWwJYdj+VWjTSkXN6qqRLF8hRO1XcKWy18z2ZmnR03Qz3EwQA0KrBIzGaGcENyA7HrYCLK3fYC1xnXM4KCxEh2pnJdvbe6ZX0cOEkiLyMlIxhxOYIr0Gt9VoXVnQc0jKKHBk24izZ2kMA19RttGEZlPsu0zjU1ZfUPlZOISVLeRRaLkEwTHiWuB9IQYhLCWGkguNLwTZpVxO/EK77uuW5Qq6/5ELLI9xIlC45tUsqAmETlIiYsy4DpNhoPQfM4a7W+hzCfkE9vW62Lb8pAh2VZezms7MQImMXjF02rw0nc+bn9wJ2zycw1idSe0jGXOPg3AsaW5FkGmkRKS9AvyFirtGDw+TDX7W7a4pvszf4v2dvvbopFmtx95rFN0Pd4yv8UWgfdTSFQk9YfgE8S+ycT+7L7GKHXWt9RZhFuDeS3RmULSDzcFhGY2RCB1eMt/2+xvZdOHNuagUAVDVVR0JpIqRZHzQM6WJcUOVEp2AQd+hSkJVOt5CQgmQBmgFg9I2zCuCQ4nP7L42VLQOvbRHc/yupS41JwCaNSl6NBtzvqVUIYrArhtJYdIWOVy/hpWV03/3aGBqPDiqGDVYbeSvcGxL1QP1WXIJ+Wn/r01k+/asHcA7l+2mC23u6ZNBDlmtuZy1Be77GM7/n+4dkFJv/QUlSR2nQpTZvQIa1SD52bWjpzTnE8fVUmPF0IXGUrDJNxqK5XfRbLeOeq18Yj+DLOWh+3BR7yvfuiGMsmXE5uw7tYiOoE1ek11hDYIijL+I+AUVmhjzpUkfFNgLl0zxy/x8ohF1p6n4HEg5jTsZt8ZVsDESkfhqNjb7VKlN//9d8Kq9Wqgm1nja6K4X2uSaamoDFVy2RMxgKueSh8xQWkrq+quTDAUgHGiBnh0sJEu2Qln3DLBCkeJJKIZSzkgqMRI5jygX5tHZg2+ZwA3ldg1181EEZiuBJo+gSPLWmzFoNMlb4cY/FHQBgJc8MlGENAJkxGCFgqIiBKE4yi8XVBprkBrNpAorknTUmrWWRJyiSbAI4dkLqsYhAcrZVoFebGEqNE7igm6N2V9icax4/LvDsZvsZkuvZbM56CNCRoNVdAJjmPwQQkUjEQn0xGFiRG+MaSDGnhEbgEfi6Fii6d/sa5ECRT6EE4ExgB1GlEdKuZNLhtF4eoQgWVwDKtMP9elap8MoAKfsflpa9N2SNnlVl9htBwC4tAYjqdrlj+iybOG25/yEPyETJluFV6tsCecJvkoVst9UGqDz/SG5DgzKe2FhZjxCoya2IZFZlOAiLrnIBFCzGd4w9vndN9QX7/7d/kHTAtSaKm3lijXIOYkUk5FUrOa96LrfKZrgSI5TZBiUfe+PAOBYwtJfg5Yfb33/5jyE8wJVwWKwpZabU+5KHg0aLKqNUaku9c1qO6OjD+ugaPeCEQkzA0pSvOCCOZxxZcXrbJsZxhmKd99REaA7Y7vAYbKJdarVLI8LCtpMNYV/dkE0gNiCswOBbufSEQiLlFi060yid+tjoxBXPFE4rP5ROKITmOY5I1X1agwGvk+POrTWBGmD/I2vbyYwzfk2eZ0kgF98SPFeY7UAEg40xhgdaQxJqN7WL8YGHovm5LyTVNXoSsEkdQDFOpxK/EguOqte1u8Zb8eNPdahiDy1w4thd6yXhhTmelWRK01q8xax/7SssiF0wUmW/cUNZeq1jQqXk/PgF9xaPyZmDDiu444A4NqOARFIF4sUEdv/nwjlztt7uY86h2xzss7s67t9+9/unkNRKDjtQLrNfutrsuX6CMTZmszVSv8lve124WcdSuInBXEbirCNxVBO4qAh8mpF1F4K4icFcRuPX16K4icFcRSJ7NQ/ZdReCuInBXEbirCNxVBO4qAncVgbuKwPNdReDDNLWrCNxVBO4qAncVgbuKwF1F4J9TEVg8AkGH3ckE4+4JTvEa3D+fOavekdGADuv1gBcBTZSxCHJzg7e8n7SYz7H5l9w9fz67COgV0xzfpLs3NjE3+Duuavs2Xql987GQxgty99LCtcyUz1wkvnFxlomP1wN6CbOl+sY5vpcu3rogtR7iOIogszXclUdTjZdHb16fUve+PWm+sbl0b2yKHzj6Wrqaj288AfgXXwKtRbi58e935vMK3ndtxCgYLKFRSBfz+fx/kMUSow==","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 s=t(74848),i=t(28453),a=t(57742),l=t.n(a),o=t(78178),p=t.n(o),d=t(19624),c=t.n(d),m=t(96226),h=t.n(m),x=(t(77675),t(19365),t(51107)),u=t(21312);const g={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:"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqPRQN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRiW77Bdd+mq25dV4vPdaZ30L2TsurTPlBXOMQoUrlXzsGtDnahxmcXSC1l5T5oGHMhyNSn5VB5vceLiPuvmuo8PGio86C59jaqc5POtgTKiOLZPC8OzbDoqsnZjVm2r25+Tdn1H+NM1zvab7ijl094pmvKpDvo9A46Ww91nTjuPPRQ50yPkJXE5GMF8b2jfmOb2t/mK55JEF9XwC3h+2ME6Surf/BHhG9LFn3U+xPCt69VxkqU9mjiJyvJ2a+P0Ja2yVcNt/qqX5f3wcHXybtOzZLQzin/+9/ef5x2f3wzUcfHx8c/nXxKXn+aHB8fp/jdbrdXAjsaUJWBdgfCtzEd0gnY8vKJBjRjmqVgQeP9140jgw5peU814jENKMf7r4zZhC5fir39Hre0EprYhFkiAWKD12EhkDHYKAEco2ScDh3b1NiZwJkMTzOBhMB1JlQMdOhVT02UQMro8MYpCiGt5nJCg8Jh+hY5ofP5RVAJySBCv9vF/5qkmjyKwJhxLkglDxrQSEkL0iI8yzLBI9fR+WIQ6WaVChV+gcii4DQOY7mf0jejfLfT61vgmjmuh/S690MoU9P/MKHzgLok87ohFgjG/ahEjlhS2VuQKgU50PmSFu+EWceYBzQDOXKr0tTwmdZshvZiITWr485rA59RvO10doHW4VY1vZgH1ICMQY+8HW6jTGUgMeFIF0ju8mc7FkKA/rZEFiw07UilhRj5eDZSclTdfdaZCJUSwGR9NGep84CmoCcwitAaxmhAcDe0sRIx6Keyrdsl6ulx2Ug6X1jjwhkUBCPp/DY7TazNzLDTKZFzA7qUtJrKBt/b7M7dgquSqsDlmOFOVrdBmlrdRnoE6m4C+6KAhODIuoPpfVEQAnxbNJSyyBIlb5lmcHDY7+2/POohfHFseDj/vvd+llSE+o5eNqmj++NyHb1qqdB784Be3xOnPxjMAzq7J9YRTjW9J9L+y3lAk3siDQ7Rjv0Gf7vMN5nSHWXuHO198b1LdW5G2hP+67211kexbDjtrnVw1WAbfd58rVvx71TMqDDtUfF6hm6HXkB5//9WvtdNd7qGDIw9UKDoVCA+ttsXXr/b39/rdfe6R6e9w+Hg1fDgsN3tdv9JA3qdioVi3aGvtn9X33kWP8k8IFko4FTld2NfQ8w1RHaU67U+a5tZ4XTu1dMoVbHf7pbWwJYdj+VWjTSkXN6qqRLF8hRO1XcKWy18z2ZmnR03Qz3EwQA0KrBIzGaGcENyA7HrYCLK3fYC1xnXM4KCxEh2pnJdvbe6ZX0cOEkiLyMlIxhxOYIr0Gt9VoXVnQc0jKKHBk24izZ2kMA19RttGEZlPsu0zjU1ZfUPlZOISVLeRRaLkEwTHiWuB9IQYhLCWGkguNLwTZpVxO/EK77uuW5Qq6/5ELLI9xIlC45tUsqAmETlIiYsy4DpNhoPQfM4a7W+hzCfkE9vW62Lb8pAh2VZezms7MQImMXjF02rw0nc+bn9wJ2zycw1idSe0jGXOPg3AsaW5FkGmkRKS9AvyFirtGDw+TDX7W7a4pvszf4v2dvvbopFmtx95rFN0Pd4yv8UWgfdTSFQk9YfgE8S+ycT+7L7GKHXWt9RZhFuDeS3RmULSDzcFhGY2RCB1eMt/2+xvZdOHNuagUAVDVVR0JpIqRZHzQM6WJcUOVEp2AQd+hSkJVOt5CQgmQBmgFg9I2zCuCQ4nP7L42VLQOvbRHc/yupS41JwCaNSl6NBtzvqVUIYrArhtJYdIWOVy/hpWV03/3aGBqPDiqGDVYbeSvcGxL1QP1WXIJ+Wn/r01k+/asHcA7l+2mC23u6ZNBDlmtuZy1Be77GM7/n+4dkFJv/QUlSR2nQpTZvQIa1SD52bWjpzTnE8fVUmPF0IXGUrDJNxqK5XfRbLeOeq18Yj+DLOWh+3BR7yvfuiGMsmXE5uw7tYiOoE1ek11hDYIijL+I+AUVmhjzpUkfFNgLl0zxy/x8ohF1p6n4HEg5jTsZt8ZVsDESkfhqNjb7VKlN//9d8Kq9Wqgm1nja6K4X2uSaamoDFVy2RMxgKueSh8xQWkrq+quTDAUgHGiBnh0sJEu2Qln3DLBCkeJJKIZSzkgqMRI5jygX5tHZg2+ZwA3ldg1181EEZiuBJo+gSPLWmzFoNMlb4cY/FHQBgJc8MlGENAJkxGCFgqIiBKE4yi8XVBprkBrNpAorknTUmrWWRJyiSbAI4dkLqsYhAcrZVoFebGEqNE7igm6N2V9icax4/LvDsZvsZkuvZbM56CNCRoNVdAJjmPwQQkUjEQn0xGFiRG+MaSDGnhEbgEfi6Fii6d/sa5ECRT6EE4ExgB1GlEdKuZNLhtF4eoQgWVwDKtMP9elap8MoAKfsflpa9N2SNnlVl9htBwC4tAYjqdrlj+iybOG25/yEPyETJluFV6tsCecJvkoVst9UGqDz/SG5DgzKe2FhZjxCoya2IZFZlOAiLrnIBFCzGd4w9vndN9QX7/7d/kHTAtSaKm3lijXIOYkUk5FUrOa96LrfKZrgSI5TZBiUfe+PAOBYwtJfg5Yfb33/5jyE8wJVwWKwpZabU+5KHg0aLKqNUaku9c1qO6OjD+ugaPeCEQkzA0pSvOCCOZxxZcXrbJsZxhmKd99REaA7Y7vAYbKJdarVLI8LCtpMNYV/dkE0gNiCswOBbufSEQiLlFi060yid+tjoxBXPFE4rP5ROKITmOY5I1X1agwGvk+POrTWBGmD/I2vbyYwzfk2eZ0kgF98SPFeY7UAEg40xhgdaQxJqN7WL8YGHovm5LyTVNXoSsEkdQDFOpxK/EguOqte1u8Zb8eNPdahiDy1w4thd6yXhhTmelWRK01q8xax/7SssiF0wUmW/cUNZeq1jQqXk/PgF9xaPyZmDDiu444A4NqOARFIF4sUEdv/nwjlztt7uY86h2xzss7s67t9+9/unkNRKDjtQLrNfutrsuX6CMTZmszVSv8lve124WcdSuInBXEbirCNxVBO4qAh8mpF1F4K4icFcRuPX16K4icFcRSJ7NQ/ZdReCuInBXEbirCNxVBO4qAncVgbuKwPNdReDDNLWrCNxVBO4qAncVgbuKwF1F4J9TEVg8AkGH3ckE4+4JTvEa3D+fOavekdGADuv1gBcBTZSxCHJzg7e8n7SYz7H5l9w9fz67COgV0xzfpLs3NjE3+Duuavs2Xql987GQxgty99LCtcyUz1wkvnFxlomP1wN6CbOl+sY5vpcu3rogtR7iOIogszXclUdTjZdHb16fUve+PWm+sbl0b2yKHzj6Wrqaj288AfgXXwKtRbi58e935vMK3ndtxCgYLKFRSBfz+fx/kMUSow==",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,j={},y=[];function f(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.jsx)(n.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Responses of Signer 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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false\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 "hide_text_with_asterisks": false\n }\n}\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.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.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.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 "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Responses of Prefill widgets"})}),"\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 "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\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 "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\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.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 "required": true,\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.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 "required": true,\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.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 "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...t(86803)}),"\n",(0,s.jsx)(c(),{...t(34673)}),"\n",(0,s.jsx)(h(),{...t(54903)})]})}function k(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},86803(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}]}')},34673(e){e.exports={title:"Body"}},54903(e){e.exports=JSON.parse('{"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"},"description":{"type":"string","example":"template description"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"sender_name":{"type":"string","example":"opensign"},"sender_email":{"type":"string","example":"mailer@opensignlabs.com"},"notify_on_signatures":{"type":"boolean","example":false},"merge_certificate":{"type":"boolean","example":false},"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"},"color":{"type":"string","format":"string","example":"black"},"fontSize":{"type":"number","format":"number","example":12},"hide_text_with_asterisks":{"type":"boolean","format":"boolean","example":false}}}},"title":"template_Signers_widgets_details"}}},"title":"template_Signers_details"}},"sendInOrder":{"type":"boolean","example":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","example":0},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"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"}},"xml":{"name":"template_details"},"title":"template_details"}}}},"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5342],{64875(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>j,default:()=>k,frontMatter:()=>g,metadata:()=>r,toc:()=>y});const r=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":"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqPRQN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRiW77Bdd+mq25dV4vPdaZ30L2TsurTPlBXOMQoUrlXzsGtDnahxmcXSC1l5T5oGHMhyNSn5VB5vceLiPuvmuo8PGio86C59jaqc5POtgTKiOLZPC8OzbDoqsnZjVm2r25+Tdn1H+NM1zvab7ijl094pmvKpDvo9A46Ww91nTjuPPRQ50yPkJXE5GMF8b2jfmOb2t/mK55JEF9XwC3h+2ME6Surf/BHhG9LFn3U+xPCt69VxkqU9mjiJyvJ2a+P0Ja2yVcNt/qqX5f3wcHXybtOzZLQzin/+9/ef5x2f3wzUcfHx8c/nXxKXn+aHB8fp/jdbrdXAjsaUJWBdgfCtzEd0gnY8vKJBjRjmqVgQeP9140jgw5peU814jENKMf7r4zZhC5fir39Hre0EprYhFkiAWKD12EhkDHYKAEco2ScDh3b1NiZwJkMTzOBhMB1JlQMdOhVT02UQMro8MYpCiGt5nJCg8Jh+hY5ofP5RVAJySBCv9vF/5qkmjyKwJhxLkglDxrQSEkL0iI8yzLBI9fR+WIQ6WaVChV+gcii4DQOY7mf0jejfLfT61vgmjmuh/S690MoU9P/MKHzgLok87ohFgjG/ahEjlhS2VuQKgU50PmSFu+EWceYBzQDOXKr0tTwmdZshvZiITWr485rA59RvO10doHW4VY1vZgH1ICMQY+8HW6jTGUgMeFIF0ju8mc7FkKA/rZEFiw07UilhRj5eDZSclTdfdaZCJUSwGR9NGep84CmoCcwitAaxmhAcDe0sRIx6Keyrdsl6ulx2Ug6X1jjwhkUBCPp/DY7TazNzLDTKZFzA7qUtJrKBt/b7M7dgquSqsDlmOFOVrdBmlrdRnoE6m4C+6KAhODIuoPpfVEQAnxbNJSyyBIlb5lmcHDY7+2/POohfHFseDj/vvd+llSE+o5eNqmj++NyHb1qqdB784Be3xOnPxjMAzq7J9YRTjW9J9L+y3lAk3siDQ7Rjv0Gf7vMN5nSHWXuHO198b1LdW5G2hP+67211kexbDjtrnVw1WAbfd58rVvx71TMqDDtUfF6hm6HXkB5//9WvtdNd7qGDIw9UKDoVCA+ttsXXr/b39/rdfe6R6e9w+Hg1fDgsN3tdv9JA3qdioVi3aGvtn9X33kWP8k8IFko4FTld2NfQ8w1RHaU67U+a5tZ4XTu1dMoVbHf7pbWwJYdj+VWjTSkXN6qqRLF8hRO1XcKWy18z2ZmnR03Qz3EwQA0KrBIzGaGcENyA7HrYCLK3fYC1xnXM4KCxEh2pnJdvbe6ZX0cOEkiLyMlIxhxOYIr0Gt9VoXVnQc0jKKHBk24izZ2kMA19RttGEZlPsu0zjU1ZfUPlZOISVLeRRaLkEwTHiWuB9IQYhLCWGkguNLwTZpVxO/EK77uuW5Qq6/5ELLI9xIlC45tUsqAmETlIiYsy4DpNhoPQfM4a7W+hzCfkE9vW62Lb8pAh2VZezms7MQImMXjF02rw0nc+bn9wJ2zycw1idSe0jGXOPg3AsaW5FkGmkRKS9AvyFirtGDw+TDX7W7a4pvszf4v2dvvbopFmtx95rFN0Pd4yv8UWgfdTSFQk9YfgE8S+ycT+7L7GKHXWt9RZhFuDeS3RmULSDzcFhGY2RCB1eMt/2+xvZdOHNuagUAVDVVR0JpIqRZHzQM6WJcUOVEp2AQd+hSkJVOt5CQgmQBmgFg9I2zCuCQ4nP7L42VLQOvbRHc/yupS41JwCaNSl6NBtzvqVUIYrArhtJYdIWOVy/hpWV03/3aGBqPDiqGDVYbeSvcGxL1QP1WXIJ+Wn/r01k+/asHcA7l+2mC23u6ZNBDlmtuZy1Be77GM7/n+4dkFJv/QUlSR2nQpTZvQIa1SD52bWjpzTnE8fVUmPF0IXGUrDJNxqK5XfRbLeOeq18Yj+DLOWh+3BR7yvfuiGMsmXE5uw7tYiOoE1ek11hDYIijL+I+AUVmhjzpUkfFNgLl0zxy/x8ohF1p6n4HEg5jTsZt8ZVsDESkfhqNjb7VKlN//9d8Kq9Wqgm1nja6K4X2uSaamoDFVy2RMxgKueSh8xQWkrq+quTDAUgHGiBnh0sJEu2Qln3DLBCkeJJKIZSzkgqMRI5jygX5tHZg2+ZwA3ldg1181EEZiuAKBtk/w3JI2izHIVOnLMVZ/BISRMDdcgjEEZMJkhIClJgKiNMEwGp8XZJobwLINpJp72pS0mkWWpEyyCeDYAakLKwbB0VyJVmFuLDFK5I5kgu5daX+kcQy51LsT4mvMpmu/N+MxSEOCZnMFZJLzGExAIhUD8dlkZEFiiG8syZAWHoHL4OdSqOjSKXCcC0EyhS6EM4EhQJ1GRLeaSYP7dnGKKnRQCSzTChPwVa3KJwOo4XdcXvrilD1yVtnVZwgNt7CIJKbT6Yrpv2jivOH2hzwkHyFThlulZwvsCbdJHrrlUh+k+vAjvQEJzn5qi2ExRqwisyaYUZHpJCCyzglYtBDTOf7w1nndF+T33/5N3gHTkiRq6q01yjWIGZmUU6HkvOa92Cqn6WqAWG4TlHjkjQ8vUcDYUoKfE2Z//+0/hvwEU8JlsaSQlVbrQx4KHi3KjFqtIfnOpT2quwPj72vwjBcCMQlDU7rijDCSeWzB5WWbHMsZxnnalx+hMWC7w2uwgXKpFSuFDE/bSjqMdYVPNoHUgLgCg2Ph5hcCgZhbtOhEq3ziZ6sTUzBXvKH4XL6hGJLjOCZZ82kFCrxGjj/A2gRmhPmTrG0vv8bwPXmWKY1UcE/8WGHCAxUAMs4UVmgNSazZ2C7GDxaG7gu3lFzT5EXIKnEExTCVSvxKLDiuWtvuGm/JkTf9rYYxuNSFY3uhl4wX5nRWmiVBa/0as/bBr7QsctFEkfrGHWXtvYoFnZr34xPQVzwqrwY2rOiOA+7QgAoeQRGJFzvU8ZsP78jVfruLSY9qe7zD4u68e/vd659OXiMx6Ei9wHrtbrvrEgbK2JTJ2kz1Mr/lje1mEUjtSgJ3JYG7ksBdSeCuJPBhQtqVBO5KAnclgVufj+5KAnclgeTZvGTflQTuSgJ3JYG7ksBdSeCuJHBXErgrCTzflQQ+TFO7ksBdSeCuJHBXErgrCdyVBP45JYHFKxB02J1MMO7e4BTPwf37mbPqIRkN6LBeEHgR0EQZiyA3N3jL+0mL+Rybf8nd++ezi4BeMc3xUbp7ZBNzg7/jqrhv45XaNx8Labwgd68tXMtM+c5F4iMXZ5n4ej2glzBbKnCc44Pp4rELUushjqMIMlvDXXk11Xh69Ob1KXUP3JPmI5tL98im+IGjr6Wr+frGE4B/8SnQWoSbG/+AZz6v4H3XRoyCwRIahXQxn8//B3BEEwg=","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=t(74848),s=t(28453),l=t(57742),a=t.n(l),o=t(78178),p=t.n(o),d=t(19624),c=t.n(d),m=t(96226),h=t.n(m),x=(t(77675),t(19365),t(51107)),u=t(21312);const g={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:"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqPRQN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRiW77Bdd+mq25dV4vPdaZ30L2TsurTPlBXOMQoUrlXzsGtDnahxmcXSC1l5T5oGHMhyNSn5VB5vceLiPuvmuo8PGio86C59jaqc5POtgTKiOLZPC8OzbDoqsnZjVm2r25+Tdn1H+NM1zvab7ijl094pmvKpDvo9A46Ww91nTjuPPRQ50yPkJXE5GMF8b2jfmOb2t/mK55JEF9XwC3h+2ME6Surf/BHhG9LFn3U+xPCt69VxkqU9mjiJyvJ2a+P0Ja2yVcNt/qqX5f3wcHXybtOzZLQzin/+9/ef5x2f3wzUcfHx8c/nXxKXn+aHB8fp/jdbrdXAjsaUJWBdgfCtzEd0gnY8vKJBjRjmqVgQeP9140jgw5peU814jENKMf7r4zZhC5fir39Hre0EprYhFkiAWKD12EhkDHYKAEco2ScDh3b1NiZwJkMTzOBhMB1JlQMdOhVT02UQMro8MYpCiGt5nJCg8Jh+hY5ofP5RVAJySBCv9vF/5qkmjyKwJhxLkglDxrQSEkL0iI8yzLBI9fR+WIQ6WaVChV+gcii4DQOY7mf0jejfLfT61vgmjmuh/S690MoU9P/MKHzgLok87ohFgjG/ahEjlhS2VuQKgU50PmSFu+EWceYBzQDOXKr0tTwmdZshvZiITWr485rA59RvO10doHW4VY1vZgH1ICMQY+8HW6jTGUgMeFIF0ju8mc7FkKA/rZEFiw07UilhRj5eDZSclTdfdaZCJUSwGR9NGep84CmoCcwitAaxmhAcDe0sRIx6Keyrdsl6ulx2Ug6X1jjwhkUBCPp/DY7TazNzLDTKZFzA7qUtJrKBt/b7M7dgquSqsDlmOFOVrdBmlrdRnoE6m4C+6KAhODIuoPpfVEQAnxbNJSyyBIlb5lmcHDY7+2/POohfHFseDj/vvd+llSE+o5eNqmj++NyHb1qqdB784Be3xOnPxjMAzq7J9YRTjW9J9L+y3lAk3siDQ7Rjv0Gf7vMN5nSHWXuHO198b1LdW5G2hP+67211kexbDjtrnVw1WAbfd58rVvx71TMqDDtUfF6hm6HXkB5//9WvtdNd7qGDIw9UKDoVCA+ttsXXr/b39/rdfe6R6e9w+Hg1fDgsN3tdv9JA3qdioVi3aGvtn9X33kWP8k8IFko4FTld2NfQ8w1RHaU67U+a5tZ4XTu1dMoVbHf7pbWwJYdj+VWjTSkXN6qqRLF8hRO1XcKWy18z2ZmnR03Qz3EwQA0KrBIzGaGcENyA7HrYCLK3fYC1xnXM4KCxEh2pnJdvbe6ZX0cOEkiLyMlIxhxOYIr0Gt9VoXVnQc0jKKHBk24izZ2kMA19RttGEZlPsu0zjU1ZfUPlZOISVLeRRaLkEwTHiWuB9IQYhLCWGkguNLwTZpVxO/EK77uuW5Qq6/5ELLI9xIlC45tUsqAmETlIiYsy4DpNhoPQfM4a7W+hzCfkE9vW62Lb8pAh2VZezms7MQImMXjF02rw0nc+bn9wJ2zycw1idSe0jGXOPg3AsaW5FkGmkRKS9AvyFirtGDw+TDX7W7a4pvszf4v2dvvbopFmtx95rFN0Pd4yv8UWgfdTSFQk9YfgE8S+ycT+7L7GKHXWt9RZhFuDeS3RmULSDzcFhGY2RCB1eMt/2+xvZdOHNuagUAVDVVR0JpIqRZHzQM6WJcUOVEp2AQd+hSkJVOt5CQgmQBmgFg9I2zCuCQ4nP7L42VLQOvbRHc/yupS41JwCaNSl6NBtzvqVUIYrArhtJYdIWOVy/hpWV03/3aGBqPDiqGDVYbeSvcGxL1QP1WXIJ+Wn/r01k+/asHcA7l+2mC23u6ZNBDlmtuZy1Be77GM7/n+4dkFJv/QUlSR2nQpTZvQIa1SD52bWjpzTnE8fVUmPF0IXGUrDJNxqK5XfRbLeOeq18Yj+DLOWh+3BR7yvfuiGMsmXE5uw7tYiOoE1ek11hDYIijL+I+AUVmhjzpUkfFNgLl0zxy/x8ohF1p6n4HEg5jTsZt8ZVsDESkfhqNjb7VKlN//9d8Kq9Wqgm1nja6K4X2uSaamoDFVy2RMxgKueSh8xQWkrq+quTDAUgHGiBnh0sJEu2Qln3DLBCkeJJKIZSzkgqMRI5jygX5tHZg2+ZwA3ldg1181EEZiuAKBtk/w3JI2izHIVOnLMVZ/BISRMDdcgjEEZMJkhIClJgKiNMEwGp8XZJobwLINpJp72pS0mkWWpEyyCeDYAakLKwbB0VyJVmFuLDFK5I5kgu5daX+kcQy51LsT4mvMpmu/N+MxSEOCZnMFZJLzGExAIhUD8dlkZEFiiG8syZAWHoHL4OdSqOjSKXCcC0EyhS6EM4EhQJ1GRLeaSYP7dnGKKnRQCSzTChPwVa3KJwOo4XdcXvrilD1yVtnVZwgNt7CIJKbT6Yrpv2jivOH2hzwkHyFThlulZwvsCbdJHrrlUh+k+vAjvQEJzn5qi2ExRqwisyaYUZHpJCCyzglYtBDTOf7w1nndF+T33/5N3gHTkiRq6q01yjWIGZmUU6HkvOa92Cqn6WqAWG4TlHjkjQ8vUcDYUoKfE2Z//+0/hvwEU8JlsaSQlVbrQx4KHi3KjFqtIfnOpT2quwPj72vwjBcCMQlDU7rijDCSeWzB5WWbHMsZxnnalx+hMWC7w2uwgXKpFSuFDE/bSjqMdYVPNoHUgLgCg2Ph5hcCgZhbtOhEq3ziZ6sTUzBXvKH4XL6hGJLjOCZZ82kFCrxGjj/A2gRmhPmTrG0vv8bwPXmWKY1UcE/8WGHCAxUAMs4UVmgNSazZ2C7GDxaG7gu3lFzT5EXIKnEExTCVSvxKLDiuWtvuGm/JkTf9rYYxuNSFY3uhl4wX5nRWmiVBa/0as/bBr7QsctFEkfrGHWXtvYoFnZr34xPQVzwqrwY2rOiOA+7QgAoeQRGJFzvU8ZsP78jVfruLSY9qe7zD4u68e/vd659OXiMx6Ei9wHrtbrvrEgbK2JTJ2kz1Mr/lje1mEUjtSgJ3JYG7ksBdSeCuJPBhQtqVBO5KAnclgVufj+5KAnclgeTZvGTflQTuSgJ3JYG7ksBdSeCuJHBXErgrCTzflQQ+TFO7ksBdSeCuJHBXErgrCdyVBP45JYHFKxB02J1MMO7e4BTPwf37mbPqIRkN6LBeEHgR0EQZiyA3N3jL+0mL+Rybf8nd++ezi4BeMc3xUbp7ZBNzg7/jqrhv45XaNx8Labwgd68tXMtM+c5F4iMXZ5n4ej2glzBbKnCc44Pp4rELUushjqMIMlvDXXk11Xh69Ob1KXUP3JPmI5tL98im+IGjr6Wr+frGE4B/8SnQWoSbG/+AZz6v4H3XRoyCwRIahXQxn8//B3BEEwg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,b={},y=[];function f(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,i.jsx)(n.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)(n.p,{children:(0,i.jsx)(n.strong,{children:"Responses of Signer 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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false\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 "hide_text_with_asterisks": false\n }\n}\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.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.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.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 "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Responses of Prefill widgets"})}),"\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 "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\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 "required": true,\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.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 "required": true,\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.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 "required": true,\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.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 "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...t(86803)}),"\n",(0,i.jsx)(c(),{...t(34673)}),"\n",(0,i.jsx)(h(),{...t(54903)})]})}function k(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},86803(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}]}')},34673(e){e.exports={title:"Body"}},54903(e){e.exports=JSON.parse('{"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"},"description":{"type":"string","example":"template description"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"sender_name":{"type":"string","example":"opensign"},"sender_email":{"type":"string","example":"mailer@opensignlabs.com"},"notify_on_signatures":{"type":"boolean","example":false},"merge_certificate":{"type":"boolean","example":false},"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"},"color":{"type":"string","format":"string","example":"black"},"fontSize":{"type":"number","format":"number","example":12},"hide_text_with_asterisks":{"type":"boolean","format":"boolean","example":false}}}},"title":"template_Signers_widgets_details"}}},"title":"template_Signers_details"}},"sendInOrder":{"type":"boolean","example":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","example":0},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"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"}},"xml":{"name":"template_details"},"title":"template_details"}}}},"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/4d139b56.8d450b23.js b/assets/js/4d139b56.cdb488f7.js similarity index 68% rename from assets/js/4d139b56.8d450b23.js rename to assets/js/4d139b56.cdb488f7.js index 7475c4580..bbac61b7b 100644 --- a/assets/js/4d139b56.8d450b23.js +++ b/assets/js/4d139b56.cdb488f7.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7075],{71236(e,t,n){n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>x,default:()=>S,frontMatter:()=>g,metadata:()=>r,toc:()=>j});const r=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/DbYuhRUdbv6GxCjWuFbU78BhMx2lij3BhY9zTSpmNL4BDFb3U6D2gbrkWJDgUogDjgGtAHdBZJz1RH0egZYZmdHBcBOi45g2S7QKmuapRSepWcKaKPoA3KibEQFzOOKxHyqYRa59yeP5saQtoVZjOOmypa9YITSTuVIAwNYJPx5RC0DVU6ANYwiIFJh4UtTLiKdVvFYlOGLo1JFfED6YYST04rj2NlIxlKMGYMOsMDV30/cx/75EK/FbqJ6Ie9/oE7sa2usXKy4APvx1OwGaz+ajzPz/WuZDhz7GCv6A1XgbjtgftRoY2Vum0TI2MP7KlC9SY2mdyFg42aiP8x4ePVhctKrsYON3i7OoyXbSfw4cf/glvkTsNrdnkZhXREQtsBleUuVz5nLbxnkwMicfQUsZFbj6H30f0YcjgbcvDhx/+5eFb3IDU/YmiUGazq1gpKeAGO6t4QD+blUQnyWUY1iC0PIDgGioE33JqpbXkwMFmbSX10xzOdKKVLhNoagZaT3pHYVBexnJ7qHimopkQ9j7nB0S03nlUa/Rki6ZdhUBXNHV060xssrcpmD44hyupFNzKusGQYjura7D98iYvU8IncHBFByK0uE1MmMjqHK5eqKSdaK1xhEJm8CujlNlQAVDX1kgdfAm146twsF8cGl1QmqXRryzlFPIxHUVvZixJPol9xOPqPFHeF/f48XXrcIWOHKawD3Wxsm+nu6Etgbr157Q1TWi6tbhIBIJeUyoPlD++tJOGObrOv1tdo1tLgf1Q+5ETvUjCC1YwJQVqjxOScHZx9RbWX8yXrJhMx//icC/eXn59/u31OYGhizQn7HS+nC9pyRofOq4nnuj1PB7GA2s4SvjuwKF+fXH/+uL+P3hx97wx4HNYWMVlYurpIO56ln03fYc/FKw1PtDqbkez4L1T+z0tfx/REX1/KNiaO0ngEnkvBsJJtPwJt3TmhUBLNH7NVcys9cVr5YjyX5zfsILR0Dwmuk+J6PZfyPqwpbcT28cMOAOgT6LjryrsdplE7/ejfN76UY0+wEGacviw3+//A/y+BHk=","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=n(74848),i=n(28453),c=n(57742),o=n.n(c),d=n(78178),a=n.n(d),p=n(19624),l=n.n(p),u=n(96226),h=n.n(u),m=(n(77675),n(19365),n(51107));n(21312);const g={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/DbYuhRUdbv6GxCjWuFbU78BhMx2lij3BhY9zTSpmNL4BDFb3U6D2gbrkWJDgUogDjgGtAHdBZJz1RH0egZYZmdHBcBOi45g2S7QKmuapRSepWcKaKPoA3KibEQFzOOKxHyqYRa59yeP5saQtoVZjOOmypa9YITSTuVIAwNYJPx5RC0DVU6ANYwiIFJh4UtTLiKdVvFYlOGLo1JFfED6YYST04rj2NlIxlKMGYMOsMDV30/cx/75EK/FbqJ6Ie9/oE7sa2usXKy4APvx1OwGaz+ajzPz/WuZDhz7GCv6A1XgbjtgftRoY2Vum0TI2MP7KlC9SY2mdyFg42aiP8x4ePVhctKrsYON3i7OoyXbSfw4cf/glvkTsNrdnkZhXREQtsBleUuVz5nLbxnkwMicfQUsZFbj6H30f0YcjgbcvDhx/+5eFb3IDU/YmiUGazq1gpKeAGO6t4QD+blUQnyWUY1iC0PIDgGioE33JqpbXkwMFmbSX10xzOdKKVLhNoagZaT3pHYVBexnJ7qHimopkQ9j7nB0S03nlUa/Rki6ZdhUBXNHV060xssrcpmD44hyupFNzKusGQYjura7D98iYvU8IncHBFByK0uE1MmMjqHK5eqKSdaK1xhEJm8CujlNlQAVDX1kgdfAm146twsF8cGl1QmqXRryzlFPIxHUVvZixJPol9xOPqPFHeF/f48XXrcIWOHKawD3Wxsm+nu6Etgbr157Q1TWi6tbhIBIJeUyoPlD++tJOGObrOv1tdo1tLgf1Q+5ETvUjCC1YwJQVqjxOScHZx9RbWX8yXrJhMx//icC/eXn59/u31OYGhizQn7HS+nC9pyRofOq4nnuj1PB7GA2s4SvjuwKF+fXH/+uL+P3hx97wx4HNYWMVlYurpIO56ln03fYc/FKw1PtDqbkez4L1T+z0tfx/REX1/KNiaO0ngEnkvBsJJtPwJt3TmhUBLNH7NVcys9cVr5YjyX5zfsILR0Dwmuk+J6PZfyPqwpbcT28cMOAOgT6LjryrsdplE7/ejfN76UY0+wEGacviw3+//A/y+BHk=",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,b={},j=[];function P(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)(l(),{...n(35398)}),"\n",(0,s.jsx)(h(),{...n(40588)})]})}function S(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(P,{...e})}):P(e)}},35398(e){e.exports={title:"Body"}},40588(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7075],{71236(e,t,r){r.r(t),r.d(t,{assets:()=>C,contentTitle:()=>S,default:()=>f,frontMatter:()=>g,metadata:()=>n,toc:()=>T});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(57742),o=r.n(d),c=r(78178),a=r.n(c),p=r(19624),u=r.n(p),l=r(96226),h=r.n(l),m=(r(77675),r(19365),r(51107));r(21312);const g={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},S=void 0,C={},T=[];function b(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(),{...r(35398)}),"\n",(0,s.jsx)(h(),{...r(40588)})]})}function f(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},35398(e){e.exports={title:"Body"}},40588(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.da1a989a.js b/assets/js/5144c8d4.48a68cda.js similarity index 60% rename from assets/js/5144c8d4.da1a989a.js rename to assets/js/5144c8d4.48a68cda.js index 7e8409c6d..24b97388c 100644 --- a/assets/js/5144c8d4.da1a989a.js +++ b/assets/js/5144c8d4.48a68cda.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7904],{41145(e,t,n){n.r(t),n.d(t,{assets:()=>N,contentTitle:()=>x,default:()=>h,frontMatter:()=>g,metadata:()=>a,toc:()=>S});const a=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/NCHixqpRs9H33oECSVONGMdZEu2kcSaOnNhav3NWNtpyEBC3gZlMARAU0tTMGOXiAysB2kADaF3XgWEQJ6NVsk0a8jLgqCRRlbIujNYj1WJWjFawdu8DQTB6jZaDDzjrccSOn8MYhliDI9uHR8BU3kueKwZNROEqlUlhgwKWyKEWKPsgikhx0Dg2BZVYGClrdG2uIn5G7dag7PcMpTUYMcbNrI4eWkCD5pkS5eCVcCct7xOYDKw13sTkBP8UpmbMOr1rswOXK5gdYF5UITX33UVMJ1O7yH/0abMsaKf2xx+RWeDIutnd9KVorrNY7WsK1m9JE3HaDDCZ60W7nSUtgj3i4+pgxq1G5whMULC4PD0JHbZR/Dxwx/wEqU3UNtpAmvRetQzqLqrOHIp8ylsqyYJYxuBV3PEiwQ+j+9bDNRF8KKW9PHDnwFe4RSUWVYUu9Lrnba5VgWcY+O0JAy93giex+kO1NGAaklQSAM5QqglQ2miJEhwSVorc9OHQzMDbpwwVVRHMDA9ym24wXFZpTtALgOWYE2U6O7s31nE9CagnmBgXTzqcgQsFTGia2/bKt22bszSOY9jpTVcqLJCir4dliW4JXmayBzwNXNwzAVBNc5AeoSAhvpwuiUST1rnrGcrVDJ+bLW2U04AmtJZZSiMoPRyTHf6szugxyVKWfMJUgqhXIUjW6pZpSRV4tLjFbV/xT15q49vtluPY/R8YUgfBV1enFrC6bKDJTBavwTWadc0JIu4PSx3aB4oz7b1xEmOvgmvx2foJ6rA5VD7TEUPIvNAZEKrAk3AtQ3h8Pj0JUz2+0ORrU3H/1Dcg5cnz49enR2xMdxIU8B2+8P+MC7uNlAjzdpNx90n1dbn1PaMm98tUV/8mbacyoS3NHBaqrgERTfnywXmUnQLzHUmahuISfM5l9kbrxcLJr9v0fNadJ2JifSKLYhLUdbNct54bnDG4SwKdLweTaRu00KwtQVurFLHR+ciE9yPNneIm7hDLB9Ye3dkZmu6N5eLZAD/8qbzSYH5PO0ni8WKPx19VmLpYMfNAbxeLBZ/AxW4We8=","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=n(74848),s=n(28453),r=n(57742),o=n.n(r),c=n(78178),p=n.n(c),l=n(19624),d=n.n(l),b=n(96226),u=n.n(b),m=(n(77675),n(19365),n(51107));n(21312);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/NCHixqpRs9H33oECSVONGMdZEu2kcSaOnNhav3NWNtpyEBC3gZlMARAU0tTMGOXiAysB2kADaF3XgWEQJ6NVsk0a8jLgqCRRlbIujNYj1WJWjFawdu8DQTB6jZaDDzjrccSOn8MYhliDI9uHR8BU3kueKwZNROEqlUlhgwKWyKEWKPsgikhx0Dg2BZVYGClrdG2uIn5G7dag7PcMpTUYMcbNrI4eWkCD5pkS5eCVcCct7xOYDKw13sTkBP8UpmbMOr1rswOXK5gdYF5UITX33UVMJ1O7yH/0abMsaKf2xx+RWeDIutnd9KVorrNY7WsK1m9JE3HaDDCZ60W7nSUtgj3i4+pgxq1G5whMULC4PD0JHbZR/Dxwx/wEqU3UNtpAmvRetQzqLqrOHIp8ylsqyYJYxuBV3PEiwQ+j+9bDNRF8KKW9PHDnwFe4RSUWVYUu9Lrnba5VgWcY+O0JAy93giex+kO1NGAaklQSAM5QqglQ2miJEhwSVorc9OHQzMDbpwwVVRHMDA9ym24wXFZpTtALgOWYE2U6O7s31nE9CagnmBgXTzqcgQsFTGia2/bKt22bszSOY9jpTVcqLJCir4dliW4JXmayBzwNXNwzAVBNc5AeoSAhvpwuiUST1rnrGcrVDJ+bLW2U04AmtJZZSiMoPRyTHf6szugxyVKWfMJUgqhXIUjW6pZpSRV4tLjFbV/xT15q49vtluPY/R8YUgfBV1enFrC6bKDJTBavwTWadc0JIu4PSx3aB4oz7b1xEmOvgmvx2foJ6rA5VD7TEUPIvNAZEKrAk3AtQ3h8Pj0JUz2+0ORrU3H/1Dcg5cnz49enR2xMdxIU8B2+8P+MC7uNlAjzdpNx90n1dbn1PaMm98tUV/8mbacyoS3NHBaqrgERTfnywXmUnQLzHUmahuISfM5l9kbrxcLJr9v0fNadJ2JifSKLYhLUdbNct54bnDG4SwKdLweTaRu00KwtQVurFLHR+ciE9yPNneIm7hDLB9Ye3dkZmu6N5eLZAD/8qbzSYH5PO0ni8WKPx19VmLpYMfNAbxeLBZ/AxW4We8=",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,N={},S=[];function A(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,i.jsx)(o(),{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)(p(),{parameters:void 0}),"\n",(0,i.jsx)(d(),{...n(776)}),"\n",(0,i.jsx)(u(),{...n(46709)})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(A,{...e})}):A(e)}},776(e){e.exports={title:"Body"}},46709(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7904],{41145(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(57742),r=s.n(o),p=s(78178),c=s.n(p),d=s(19624),l=s.n(d),m=s(96226),b=s.n(m),u=(s(77675),s(19365),s(51107));s(21312);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(),{...s(776)}),"\n",(0,i.jsx)(b(),{...s(46709)})]})}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)}},776(e){e.exports={title:"Body"}},46709(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.08a333f9.js b/assets/js/58abd73c.08a333f9.js deleted file mode 100644 index d5469c67f..000000000 --- a/assets/js/58abd73c.08a333f9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8564],{64502(e,t,r){r.r(t),r.d(t,{assets:()=>w,contentTitle:()=>x,default:()=>A,frontMatter:()=>u,metadata:()=>s,toc:()=>I});const s=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+8DxRlTjXTHeQLdlGEnvq4MLC+tlU20XIQELeBmUwBEBTS1OwYleIjIcwaQANoXdeBYRAnkGrBM0a8rIgaKSRFbLvDPq5KlErZit4m7eBIFjdRsRAUmnrsYQuHoNYhpjD1zxAeASWFrZxHmtmzRyhalWJIYPClgghHlMOwZSQYyBwjEUVGNhpa7QtZrF+01ZrcJZvDSU1j3V9jGxOXprAPSxh6UqwS5jzlicPTAAHgx8CcoGvlJmFyWDwzpzA/Y5Wd5gHRfjw1+4ELBaLJ8z/8tDmQtE/2xy+R2eDIutXe+tKUd3m8bT0new+kqcLNBjp0zsLex+lLcLTw8fSUY3ajW6QmCFhdH59GS/aL+HjT7/AFUpvoLaLRNai9ahXUHVbceZS5VPadvckTG0kXs0ZLxL5eGzEQF0G72pJH3/6NcAbXIAy2xPFoQwG122uVQG32DjuImEwmMA3cWQA6mRAtSQopIEcIdSSqTRXEiS4ZK2VmQ3h3KygDd2TgsnA8mh3EAbnZVfuALkMWII10aLbc7hHxPImoJ5jYF/GEsPAUhEzuva2rdJufTDb4DxOldZwp8oKKcZ2XpbgtuJFEnPCe3BwygeCalyB9AgBDQ3h+pFJXGmds55RqAR+arW2Cy4AmtJZZShMoPRySnv/2Z7ocTJT1hwRpRTKXTqyrZtdSdJJ3Ea8kw7f8Z386B4/vG49TtHzhjHsfV2c2tLpvqMlMFv/F1rH6dMakkUcILCRSqeG8vfHfmIzR9+Et9Mb9HNV4LapfeJEj6LySGRCqwJNwN6QcH5xfQXzF8OxyHrd8TMO9+jq8pvXb25eMxi+SFPCTofj4TiO5jZQI01vpwuk7hW9HRgOcr3ej0//7zf6tlcTLmnktFRxOorBr7eTzX3/5f6QidoGYul6zefvB683GxanhyfPO6UKMte9p+cnYzv6hj+KaIarY/8fmEvdphd5dmTfZNQ90D9Hd/uS3qs+8IdXrBvHv6wbWTjQZHNeFOj6GzyZdw+GxovXtyITfO0ejkqzOCpt/2Dv3ZJZ9XwfzlAJAP/kmI4arNdpDNtsdvpp6ZMW2wA7bc7/w2az+Q/RsGCL","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 i=r(74848),l=r(28453),o=r(57742),a=r.n(o),d=r(78178),n=r.n(d),p=r(19624),m=r.n(p),c=r(96226),f=r.n(c),h=(r(77675),r(19365),r(51107)),j=r(21312);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+8DxRlTjXTHeQLdlGEnvq4MLC+tlU20XIQELeBmUwBEBTS1OwYleIjIcwaQANoXdeBYRAnkGrBM0a8rIgaKSRFbLvDPq5KlErZit4m7eBIFjdRsRAUmnrsYQuHoNYhpjD1zxAeASWFrZxHmtmzRyhalWJIYPClgghHlMOwZSQYyBwjEUVGNhpa7QtZrF+01ZrcJZvDSU1j3V9jGxOXprAPSxh6UqwS5jzlicPTAAHgx8CcoGvlJmFyWDwzpzA/Y5Wd5gHRfjw1+4ELBaLJ8z/8tDmQtE/2xy+R2eDIutXe+tKUd3m8bT0new+kqcLNBjp0zsLex+lLcLTw8fSUY3ajW6QmCFhdH59GS/aL+HjT7/AFUpvoLaLRNai9ahXUHVbceZS5VPadvckTG0kXs0ZLxL5eGzEQF0G72pJH3/6NcAbXIAy2xPFoQwG122uVQG32DjuImEwmMA3cWQA6mRAtSQopIEcIdSSqTRXEiS4ZK2VmQ3h3KygDd2TgsnA8mh3EAbnZVfuALkMWII10aLbc7hHxPImoJ5jYF/GEsPAUhEzuva2rdJufTDb4DxOldZwp8oKKcZ2XpbgtuJFEnPCe3BwygeCalyB9AgBDQ3h+pFJXGmds55RqAR+arW2Cy4AmtJZZShMoPRySnv/2Z7ocTJT1hwRpRTKXTqyrZtdSdJJ3Ea8kw7f8Z386B4/vG49TtHzhjHsfV2c2tLpvqMlMFv/F1rH6dMakkUcILCRSqeG8vfHfmIzR9+Et9Mb9HNV4LapfeJEj6LySGRCqwJNwN6QcH5xfQXzF8OxyHrd8TMO9+jq8pvXb25eMxi+SFPCTofj4TiO5jZQI01vpwuk7hW9HRgOcr3ej0//7zf6tlcTLmnktFRxOorBr7eTzX3/5f6QidoGYul6zefvB683GxanhyfPO6UKMte9p+cnYzv6hj+KaIarY/8fmEvdphd5dmTfZNQ90D9Hd/uS3qs+8IdXrBvHv6wbWTjQZHNeFOj6GzyZdw+GxovXtyITfO0ejkqzOCpt/2Dv3ZJZ9XwfzlAJAP/kmI4arNdpDNtsdvpp6ZMW2wA7bc7/w2az+Q/RsGCL",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,w={},I=[];function y(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(j.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(n(),{...r(961)}),"\n",(0,i.jsx)(m(),{...r(34780)}),"\n",(0,i.jsx)(f(),{...r(87590)})]})}function A(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}},961(e){e.exports=JSON.parse('{"parameters":[{"name":"parentFolderId","in":"query","description":"objectId of folder","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"string","example":""}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},34780(e){e.exports={title:"Body"}},87590(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.338d50e6.js b/assets/js/58abd73c.338d50e6.js new file mode 100644 index 000000000..2be4202b6 --- /dev/null +++ b/assets/js/58abd73c.338d50e6.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8564],{64502(e,t,r){r.r(t),r.d(t,{assets:()=>x,contentTitle:()=>I,default:()=>P,frontMatter:()=>w,metadata:()=>s,toc:()=>j});const s=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 i=r(74848),o=r(28453),l=r(57742),n=r.n(l),d=r(78178),a=r.n(d),p=r(19624),m=r.n(p),c=r(96226),f=r.n(c),h=(r(77675),r(19365),r(51107)),u=r(21312);const w={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},I=void 0,x={},j=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,i.jsx)(n(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(a(),{...r(961)}),"\n",(0,i.jsx)(m(),{...r(34780)}),"\n",(0,i.jsx)(f(),{...r(87590)})]})}function P(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},961(e){e.exports=JSON.parse('{"parameters":[{"name":"parentFolderId","in":"query","description":"objectId of folder","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"string","example":""}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},34780(e){e.exports={title:"Body"}},87590(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5a144266.a3f67927.js b/assets/js/5a144266.31c1c944.js similarity index 72% rename from assets/js/5a144266.a3f67927.js rename to assets/js/5a144266.31c1c944.js index 0262dd47a..1b51378c6 100644 --- a/assets/js/5a144266.a3f67927.js +++ b/assets/js/5a144266.31c1c944.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4232],{98162(e,t,a){a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>w,frontMatter:()=>f,metadata:()=>i,toc:()=>b});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+hwtTX1jqbnKcCkp4YHOhWK3tYGVtvdz6soi4JCUTih0DlDlXKUk2G5EBNpSt4XKozVWOATnLRktatO08panHgqu+AJp7QiGscpQCspWsDopnQenZRksBs+F1BYzaP1RiJkLMfxIfYhFoNFUF8ZiTlmzRFiU1P9FkOoMoWbT5ILKIEHnwZAtIsXQ9JVK6vQ+7N+8lBKMpnNDcEkt49BGgnvLlaOjubal3YIuYMZqamCwNnA0+tkhbfCFUPduOhp9Vgdw26XVDSZOeLz7a1sBq9XqUeZ/u4s5E/7HMoF/oNFOeG03PXohfF4moVqGi3Qf9UpnqDCkz6AW+jUynbrHxUejkxylmVyhpwxxk9PL83DUfgtff/sXXCC3CnK9qpM1LS3KDSxaVRS5eufrsHUnJcx1SLycIp7WyUfdJzrfRvAm5/7rb/928BOuQKimosiV0eiyTKRIu6cENxpN4YdAKwZdu8+5h5QrSBBczimVloIDB1OjpVD3YzhVm/AOACvh85AMNB5wO25QXPrWHxLuMAOtAqLVOe4tovHCoVyio7WU9mQGZsJTRudWl4ta29CYxjmLcyEl3NQMjHw7zTIwzXBDzCjgA3NwTgXhc9wAtwgOlR/D5QNImCmN0ZasELXxc02EgjYAVWa0UN5NIbN87vv1oz7R62cQrZ4YqkPIu3BEzTKDpxeKZONx/5Tzmc7kB+f47nFrcY6WFAa3+30xokmn2zYtgbL196Q13dF0avE0UIim/6IL5fuH64TrHG3hPs2v6LEpbfvTZyp6EoQnLGJSpKgcDmjC6dnlBSzfjWMWDW7HVxT35OL8h48/XX0kY+ggrQN2OI7HcWirtPMFVwNNO29wDWXYifa2p1D/p492DUmgTmhiJBeBmDV0vCZVt2yHVN1FLNfO0/h2S6X/s5VVRcP10xlRrUw48rZ/PLvHzeCpb8ll2VD4Z2WbN7le9I4+rCDZwAGjlrWQwhpzmqZohgoekd4d5nj28ZqFViDfZUv3gS01P2j1dkptBmvv0qjaAPpLPj0J2G5rJlZVnXw99SyicbCVpr25q6rqv7mcy6U=","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),s=a(28453),n=a(57742),p=a.n(n),o=a(78178),r=a.n(o),m=a(19624),d=a.n(m),c=a(96226),u=a.n(c),g=(a(77675),a(19365),a(51107)),x=a(21312);const f={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+hwtTX1jqbnKcCkp4YHOhWK3tYGVtvdz6soi4JCUTih0DlDlXKUk2G5EBNpSt4XKozVWOATnLRktatO08panHgqu+AJp7QiGscpQCspWsDopnQenZRksBs+F1BYzaP1RiJkLMfxIfYhFoNFUF8ZiTlmzRFiU1P9FkOoMoWbT5ILKIEHnwZAtIsXQ9JVK6vQ+7N+8lBKMpnNDcEkt49BGgnvLlaOjubal3YIuYMZqamCwNnA0+tkhbfCFUPduOhp9Vgdw26XVDSZOeLz7a1sBq9XqUeZ/u4s5E/7HMoF/oNFOeG03PXohfF4moVqGi3Qf9UpnqDCkz6AW+jUynbrHxUejkxylmVyhpwxxk9PL83DUfgtff/sXXCC3CnK9qpM1LS3KDSxaVRS5eufrsHUnJcx1SLycIp7WyUfdJzrfRvAm5/7rb/928BOuQKimosiV0eiyTKRIu6cENxpN4YdAKwZdu8+5h5QrSBBczimVloIDB1OjpVD3YzhVm/AOACvh85AMNB5wO25QXPrWHxLuMAOtAqLVOe4tovHCoVyio7WU9mQGZsJTRudWl4ta29CYxjmLcyEl3NQMjHw7zTIwzXBDzCjgA3NwTgXhc9wAtwgOlR/D5QNImCmN0ZasELXxc02EgjYAVWa0UN5NIbN87vv1oz7R62cQrZ4YqkPIu3BEzTKDpxeKZONx/5Tzmc7kB+f47nFrcY6WFAa3+30xokmn2zYtgbL196Q13dF0avE0UIim/6IL5fuH64TrHG3hPs2v6LEpbfvTZyp6EoQnLGJSpKgcDmjC6dnlBSzfjWMWDW7HVxT35OL8h48/XX0kY+ggrQN2OI7HcWirtPMFVwNNO29wDWXYifa2p1D/p492DUmgTmhiJBeBmDV0vCZVt2yHVN1FLNfO0/h2S6X/s5VVRcP10xlRrUw48rZ/PLvHzeCpb8ll2VD4Z2WbN7le9I4+rCDZwAGjlrWQwhpzmqZohgoekd4d5nj28ZqFViDfZUv3gS01P2j1dkptBmvv0qjaAPpLPj0J2G5rJlZVnXw99SyicbCVpr25q6rqv7mcy6U=",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={},b=[];function v(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,l.jsx)(p(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,l.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(r(),{...a(68824)}),"\n",(0,l.jsx)(d(),{...a(98874)}),"\n",(0,l.jsx)(u(),{...a(16976)})]})}function w(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}},68824(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},98874(e){e.exports={title:"Body"}},16976(e){e.exports=JSON.parse('{"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":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4232],{98162(e,t,a){a.r(t),a.d(t,{assets:()=>w,contentTitle:()=>x,default:()=>v,frontMatter:()=>f,metadata:()=>i,toc:()=>b});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),s=a(28453),o=a(57742),p=a.n(o),n=a(78178),m=a.n(n),r=a(19624),d=a.n(r),c=a(96226),g=a.n(c),u=(a(77675),a(19365),a(51107)),h=a(21312);const f={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},x=void 0,w={},b=[];function y(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:"Get Template list"}),"\n",(0,l.jsx)(p(),{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:(0,l.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(m(),{...a(68824)}),"\n",(0,l.jsx)(d(),{...a(98874)}),"\n",(0,l.jsx)(g(),{...a(16976)})]})}function v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}},68824(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},98874(e){e.exports={title:"Body"}},16976(e){e.exports=JSON.parse('{"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":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.2dd0ae0e.js b/assets/js/5ce6d213.2c09e8ba.js similarity index 79% rename from assets/js/5ce6d213.2dd0ae0e.js rename to assets/js/5ce6d213.2c09e8ba.js index 628df408a..218287406 100644 --- a/assets/js/5ce6d213.2dd0ae0e.js +++ b/assets/js/5ce6d213.2c09e8ba.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3460],{32779(e,t,i){i.r(t),i.d(t,{assets:()=>y,contentTitle:()=>g,default:()=>x,frontMatter:()=>b,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":"eJzFWc2OG7kRfpUKL7aFHkn+XUSnnXgd21jDFjwzMJLxQGA3S2rusEkuyZZGGAjYQ94gp1zzaH6SoMjuVuvHY3vXSS67HnZVsf75VemWBb7wbHLJzrGyigf07CpjAn3hpA3SaDZh5yXChRU8ILRUcDp9Dah5rtDD2tQQDFRGyPkauBZQJ+pQIggMXCoPZg4cvMVCzmUBoZEzZBkzFh2nq14LNmGJtb2HZcxyxysM6EjNW6Z5hWzCWgEzKVjGJKlpeSjZvu6vf6KbSZGWA0LJA2hE4UnrHBttSY7DX2vpULBJcDVmzIe1otu8rKwiZfDGKiOQTeZceSIoSqw4m9yysLaRMjipFyxjc+MqHrYnm81Vko8+/MWINfHsqjp1ZikFQo7KrKAzm5Rs/dnGCO7zAAq5D2A09mhbAx6wjBVGB9SBLuLWKllEJ49+8XTb7aHqJv8Fi0AedxSSINHT1+TwLxtIzuHRTRPm4z86fdkmY9qEbxYzJRMRHC4lrmJiebnQEErpQZiirsi8zV7Iv+2KLiv6MjbEowQ6yshDeVtuokxV8O582iPNjVHI9UE2UlbBSTLAxENYSaWaSoJ351NYoqMKibEawoVH5xONwwLlEoHvkEBhBMJScsCKS5XBqpRFSQm/hqr2AVA3OdS4DjvPDSEmMZzAoUJC+qMaZcCVMiupF1BH1Y4JBiEdFkGtYSVDaeoAXAhJ7FyBD2j9sO/FqEXnyHNTuz/uSQ6LWgoUEEztYG5c1BKdz8DGMiMLpPbB1QUxexA1RTfaQaT0b+tMgd5v/dR6hYh68jNA7RM7hzn3AV0GtZbkeVfbgKITiTcWnURd4FEXROfOYiNtHO6/3hdTdJUMvrWUQsOFAFRIQfHg66IEnr7zUDv0GUgtg+TKZ+ADr6zPwDgIeEN9BYKx1DzxRvpAyq+kWGDwID+XR++RaqTo6TB3porRJ9/odT8ROr2C2RN3TkGVvnk+5rxWAZZc1cd9NpfqaGPZ9dHfTA0VXzfRTyHMucdnTwA11ZCA6U9/BRJGCjm0iheJrLPfaOx3k8R+0A8cpvSf1U59Wa+z9CJisvbi/RtYleiwy0N0Ka9zaoNJMNL7Giufbg1t1nbVt5++BxryOpiZw0pqgV9Ta2cYYpAozYLpSqwOpuJBFtCK8kNoSFNCBNOvmArut8HMseRLadyDowFN4mZGFziTeoZLdOuelrqucnQHSr6Nx5Svgq895BhWiLqvW5tWRqs1NC8i6bYqUcOOT4jKb43e0fJpesvkfD0zeratpaN+3LVtX+XBgKQPBnAC5/0AFg55MG6v7evU4SFe3nZ/0p0cRNgqZQv9z+8W1Ef9UQ8GUYUvXKZN+F4XvjUBJ/AeF9wJhd4nGJYcSzmbAe8y2LRX0XuxTX2x1ZLe/h51QfAk6oTAQ+BFiYKCJtCiFtS77nnUYhal3tvio+HH+Lhb1LPCKOP6UePO8TVhyYCVPyzcTS+alyxXNUa8SKgxV7y4ZlebjOVF8Xsl0nP6Y/P3sDAVy+LRo52zA2ieFwXcz5Uk93CXx65g1w8mDXDgghpbbCh7GGInqMn5VHC7nUT61ukoous2GQsy7ACnWQ+Jz3ICtpvNJlaxt0b7VBiPxuNDvNvNEg3+pgeKGta8Vmr9p+8HYNPxl6Ac9+LRKz998spSYBqVTsPdTI/Gjx6fPByfjH84f/hs8uTPk6fPhuPx+O8sYzeV2qJnJhoU3Hov/d07kFpJjbPWa7NH4/HscePKJ8e812Dj9j1bciUFzCUqAXSn/44OROeM+53Y/Q797jKfTG6Nf3JH6lDDmptai/+3ucc0utvAJ7MfOhOfHpr4WieX0aB9bq5R/y8s3NrTvz6k60nV3ayWiSh+ZzvG9s+TkR6L2smwjkP8zQm38iR9n1xe0WhcYSgNLQBsHRWmYX7CRm13Gd32+syGkTy3bHcCEWmxMgTrJ6OR51rk5mZoLGp6RxTPPXXPEbdytHw4fMg22T4Pt/ab6LE++VYWH/hC6sWX+K62rjqjcKaI7Ths+8BY+TPSC9PEo0/VLEVK5ATyKAKUJe+3C4gXbay7cO5P7e3Q/nVz+MFUcmyy7g/WjO0Mzw1E6k+BzdHRqaj5ltA/Y/u4m072cG7DcRxePv0cqmu4+pDh+PPfvP5f+5JvKEBzE6PZlM07i/qMHEtFF7Nh36cfUBWmwnZkGgxalk//+HfHNRh0QUlbBIJj72oH1qzQzWsVIzhXeCMJ/sZNXhW/das8j7wi0KbWQFPswsU4yoUMNME380XBLc+lktRViMwQt4NeY/JD+FBiKNHRp3uOgIfApaJe1M0PerEFHCvjrufKrDyhw7z2UhNyRF1yXRBhWxlxTCWASiO2ddIj+OBIaZlUMzo4XgSouOaLOGdm0PeVQCWpfYAzOW1JvFF12gPQttK4ONkne+KmMPrwBS3/HAKdEi5yWFIZL5tlgM/SMiaVEZmgBeToA1jSRRYYZ91aK1Ncx/gR0gFrqKVLrggh93Uk9uC49vTuJF3aEHQOa2Y89A3Iv/BIAX4j9bWfDAYf9Qlcdmn1AXMvA17db1vSarU6aEUPdnleyvCqzuE9WuNlMG695V7IUNZ5bF99Id0fSdJL1BjTp9ectjKEKfxhN6TTUYnKjs7SsOBHp9PX8RV8AJ9++ye8Qe40lGaVkrWoHao1LNqryHMp8slt3SMWN0G8DiV5vEjJ1+xkWw9+KHn49Nu/PLzFFW06UkWRKYPBtM6VLLoluB8MJvCc5qf+ajaulwuuaWT3JadUovUcB5u4ldTXQzjV67hB2448dB75dsyIjbYNt48rizjf9Dfaw61GcdD2qJboSRaBkRwBhSR8HUpn6kW6ra9MY5zDOc0IH9KWh2w7FQJsc9wuf2io36qDc5OWFWvgDsHH/c10jyV+qa01jrRotkdz0y4SUQtrpA5+AsLxedjKz/bG1LiAPDhKLuSdO7JGTBeSVImNxd0pDTTZ/sO6224dztHRhdHsbVysbNLpsk1LoGz9I2lN8Im6Fi8iuosTWXrhf9yXE5EWusq/m5+hW8oCG5TxmYoeReIRy5iSBWrff/JPX07fwPLxcEyPVAdXvqK4R29eP3/x9uwFKUONNDns4XA8HMcJ2/hQcd27ae8HpP2n7XaLbf/bvzc14Im2nCOruIzQtVnWJdh5yXoYaNL/qekqY6XxgUhub6kYL5zabOj41zriiMurjC25k6RpxKbNBkwc3wH1zb7/vv3xBr7tV6ujBrUQURM+jNvTBIqucb3389mGsEiDE0njRPE86XVyTnK2Eg7GDgK6ieO0KNCGO2n7OH96cU7gqfkprIq/qjHHV4Sr+Copmzb7EQHHs1umuF7UfEG0SeQmLTTLXVh8HWFx8w8y6qg7dvFysoL+SzYdZbi9TZB7s+no06fPcjR+bakpNlebzeY/iKFnfg==","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),s=i(28453),o=i(57742),p=i.n(o),r=i(78178),d=i.n(r),l=i(19624),c=i.n(l),m=i(96226),u=i.n(m),h=(i(77675),i(19365),i(51107)),f=i(21312);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:"eJzFWc2OG7kRfpUKL7aFHkn+XUSnnXgd21jDFjwzMJLxQGA3S2rusEkuyZZGGAjYQ94gp1zzaH6SoMjuVuvHY3vXSS67HnZVsf75VemWBb7wbHLJzrGyigf07CpjAn3hpA3SaDZh5yXChRU8ILRUcDp9Dah5rtDD2tQQDFRGyPkauBZQJ+pQIggMXCoPZg4cvMVCzmUBoZEzZBkzFh2nq14LNmGJtb2HZcxyxysM6EjNW6Z5hWzCWgEzKVjGJKlpeSjZvu6vf6KbSZGWA0LJA2hE4UnrHBttSY7DX2vpULBJcDVmzIe1otu8rKwiZfDGKiOQTeZceSIoSqw4m9yysLaRMjipFyxjc+MqHrYnm81Vko8+/MWINfHsqjp1ZikFQo7KrKAzm5Rs/dnGCO7zAAq5D2A09mhbAx6wjBVGB9SBLuLWKllEJ49+8XTb7aHqJv8Fi0AedxSSINHT1+TwLxtIzuHRTRPm4z86fdkmY9qEbxYzJRMRHC4lrmJiebnQEErpQZiirsi8zV7Iv+2KLiv6MjbEowQ6yshDeVtuokxV8O582iPNjVHI9UE2UlbBSTLAxENYSaWaSoJ351NYoqMKibEawoVH5xONwwLlEoHvkEBhBMJScsCKS5XBqpRFSQm/hqr2AVA3OdS4DjvPDSEmMZzAoUJC+qMaZcCVMiupF1BH1Y4JBiEdFkGtYSVDaeoAXAhJ7FyBD2j9sO/FqEXnyHNTuz/uSQ6LWgoUEEztYG5c1BKdz8DGMiMLpPbB1QUxexA1RTfaQaT0b+tMgd5v/dR6hYh68jNA7RM7hzn3AV0GtZbkeVfbgKITiTcWnURd4FEXROfOYiNtHO6/3hdTdJUMvrWUQsOFAFRIQfHg66IEnr7zUDv0GUgtg+TKZ+ADr6zPwDgIeEN9BYKx1DzxRvpAyq+kWGDwID+XR++RaqTo6TB3porRJ9/odT8ROr2C2RN3TkGVvnk+5rxWAZZc1cd9NpfqaGPZ9dHfTA0VXzfRTyHMucdnTwA11ZCA6U9/BRJGCjm0iheJrLPfaOx3k8R+0A8cpvSf1U59Wa+z9CJisvbi/RtYleiwy0N0Ka9zaoNJMNL7Giufbg1t1nbVt5++BxryOpiZw0pqgV9Ta2cYYpAozYLpSqwOpuJBFtCK8kNoSFNCBNOvmArut8HMseRLadyDowFN4mZGFziTeoZLdOuelrqucnQHSr6Nx5Svgq895BhWiLqvW5tWRqs1NC8i6bYqUcOOT4jKb43e0fJpesvkfD0zeratpaN+3LVtX+XBgKQPBnAC5/0AFg55MG6v7evU4SFe3nZ/0p0cRNgqZQv9z+8W1Ef9UQ8GUYUvXKZN+F4XvjUBJ/AeF9wJhd4nGJYcSzmbAe8y2LRX0XuxTX2x1ZLe/h51QfAk6oTAQ+BFiYKCJtCiFtS77nnUYhal3tvio+HH+Lhb1LPCKOP6UePO8TVhyYCVPyzcTS+alyxXNUa8SKgxV7y4ZlebjOVF8Xsl0nP6Y/P3sDAVy+LRo52zA2ieFwXcz5Uk93CXx65g1w8mDXDgghpbbCh7GGInqMn5VHC7nUT61ukoous2GQsy7ACnWQ+Jz3ICtpvNJlaxt0b7VBiPxuNDvNvNEg3+pgeKGta8Vmr9p+8HYNPxl6Ac9+LRKz998spSYBqVTsPdTI/Gjx6fPByfjH84f/hs8uTPk6fPhuPx+O8sYzeV2qJnJhoU3Hov/d07kFpJjbPWa7NH4/HscePKJ8e812Dj9j1bciUFzCUqAXSn/44OROeM+53Y/Q797jKfTG6Nf3JH6lDDmptai/+3ucc0utvAJ7MfOhOfHpr4WieX0aB9bq5R/y8s3NrTvz6k60nV3ayWiSh+ZzvG9s+TkR6L2smwjkP8zQm38iR9n1xe0WhcYSgNLQBsHRWmYX7CRm13Gd32+syGkTy3bHcCEWmxMgTrJ6OR51rk5mZoLGp6RxTPPXXPEbdytHw4fMg22T4Pt/ab6LE++VYWH/hC6sWX+K62rjqjcKaI7Ths+8BY+TPSC9PEo0/VLEVK5ATyKAKUJe+3C4gXbay7cO5P7e3Q/nVz+MFUcmyy7g/WjO0Mzw1E6k+BzdHRqaj5ltA/Y/u4m072cG7DcRxePv0cqmu4+pDh+PPfvP5f+5JvKEBzE6PZlM07i/qMHEtFF7Nh36cfUBWmwnZkGgxalk//+HfHNRh0QUlbBIJj72oH1qzQzWsVIzhXeCMJ/sZNXhW/das8j7wi0KbWQFPswsU4yoUMNME380XBLc+lktRViMwQt4NeY/JD+FBiKNHRp3uOgIfApaJe1M0PerEFHCvjrufKrDyhw7z2UhNyRF1yXRBhWxlxTCWASiO2ddIj+OBIaZlUMzo4XgSouOaLOGdm0PeVQCWpfYAzOW1JvFF12gPQttK4ONkne+KmMPrwBS3/HAKdEi5yWFIZL5tlgM/SMiaVEZmgBeToA1jSRRYYZ91aK1Ncx/gR0gFrqKVLrggh93Uk9uC49vTuJF3aEHQOa2Y89A3Iv/BIAX4j9bWfDAYf9Qlcdmn1AXMvA17db1vSarU6aEUPdnleyvCqzuE9WuNlMG695V7IUNZ5bF99Id0fSdJL1BjTp9ectjKEKfxhN6TTUYnKjs7SsOBHp9PX8RV8AJ9++ye8Qe40lGaVkrWoHao1LNqryHMp8slt3SMWN0G8DiV5vEjJ1+xkWw9+KHn49Nu/PLzFFW06UkWRKYPBtM6VLLoluB8MJvCc5qf+ajaulwuuaWT3JadUovUcB5u4ldTXQzjV67hB2448dB75dsyIjbYNt48rizjf9Dfaw61GcdD2qJboSRaBkRwBhSR8HUpn6kW6ra9MY5zDOc0IH9KWh2w7FQJsc9wuf2io36qDc5OWFWvgDsHH/c10jyV+qa01jrRotkdz0y4SUQtrpA5+AsLxedjKz/bG1LiAPDhKLuSdO7JGTBeSVImNxd0pDTTZ/sO6224dztHRhdHsbVysbNLpsk1LoGz9I2lN8Im6Fi8iuosTWXrhf9yXE5EWusq/m5+hW8oCG5TxmYoeReIRy5iSBWrff/JPX07fwPLxcEyPVAdXvqK4R29eP3/x9uwFKUONNDns4XA8HMcJ2/hQcd27ae8HpP2n7XaLbf/bvzc14Im2nCOruIzQtVnWJdh5yXoYaNL/qekqY6XxgUhub6kYL5zabOj41zriiMurjC25k6RpxKbNBkwc3wH1zb7/vv3xBr7tV6ujBrUQURM+jNvTBIqucb3389mGsEiDE0njRPE86XVyTnK2Eg7GDgK6ieO0KNCGO2n7OH96cU7gqfkprIq/qjHHV4Sr+Copmzb7EQHHs1umuF7UfEG0SeQmLTTLXVh8HWFx8w8y6qg7dvFysoL+SzYdZbi9TZB7s+no06fPcjR+bakpNlebzeY/iKFnfg==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},v=[];function T(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(d(),{...i(49772)}),"\n",(0,n.jsx)(c(),{...i(7110)}),"\n",(0,n.jsx)(u(),{...i(78316)})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(T,{...e})}):T(e)}},49772(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},7110(e){e.exports=JSON.parse('{"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":false},"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":false},"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":false},"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":false},"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},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"template_template_id_body"}}}}}')},78316(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3460],{32779(e,t,i){i.r(t),i.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>x,frontMatter:()=>f,metadata:()=>a,toc:()=>T});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":"eJzFWc2OG7kRfpUKL7aFHkn+XUSnnXgd21jDFjwzMJLxQGA3S2rusEkuyZZGGAjYQ94gp1zzaH6SoMjuVuvHY3vXSS67HnZVsf75VemWBb7wbHLJzrGyigf07CpjAn3hpA3SaDZh5yXChRU8ILRUcDp9Dah5rtDD2tQQDFRGyPkauBZQJ+pQIggMXCoPZg4cvMVCzmUBoZEzZBkzFh2nq14LNmGJtb2HZcxyxysM6EjNW6Z5hWzCWgEzKVjGJKlpeSjZvu6vf6KbSZGWA0LJA2hE4UnrHBttSY7DX2vpULBJcDVmzIe1otu8rKwiZfDGKiOQTeZceSIoSqw4m9yysLaRMjipFyxjc+MqHrYnm81Vko8+/MWINfHsqjp1ZikFQo7KrKAzm5Rs/dnGCO7zAAq5D2A09mhbAx6wjBVGB9SBLuLWKllEJ49+8XTb7aHqJv8Fi0AedxSSINHT1+TwLxtIzuHRTRPm4z86fdkmY9qEbxYzJRMRHC4lrmJiebnQEErpQZiirsi8zV7Iv+2KLiv6MjbEowQ6yshDeVtuokxV8O582iPNjVHI9UE2UlbBSTLAxENYSaWaSoJ351NYoqMKibEawoVH5xONwwLlEoHvkEBhBMJScsCKS5XBqpRFSQm/hqr2AVA3OdS4DjvPDSEmMZzAoUJC+qMaZcCVMiupF1BH1Y4JBiEdFkGtYSVDaeoAXAhJ7FyBD2j9sO/FqEXnyHNTuz/uSQ6LWgoUEEztYG5c1BKdz8DGMiMLpPbB1QUxexA1RTfaQaT0b+tMgd5v/dR6hYh68jNA7RM7hzn3AV0GtZbkeVfbgKITiTcWnURd4FEXROfOYiNtHO6/3hdTdJUMvrWUQsOFAFRIQfHg66IEnr7zUDv0GUgtg+TKZ+ADr6zPwDgIeEN9BYKx1DzxRvpAyq+kWGDwID+XR++RaqTo6TB3porRJ9/odT8ROr2C2RN3TkGVvnk+5rxWAZZc1cd9NpfqaGPZ9dHfTA0VXzfRTyHMucdnTwA11ZCA6U9/BRJGCjm0iheJrLPfaOx3k8R+0A8cpvSf1U59Wa+z9CJisvbi/RtYleiwy0N0Ka9zaoNJMNL7Giufbg1t1nbVt5++BxryOpiZw0pqgV9Ta2cYYpAozYLpSqwOpuJBFtCK8kNoSFNCBNOvmArut8HMseRLadyDowFN4mZGFziTeoZLdOuelrqucnQHSr6Nx5Svgq895BhWiLqvW5tWRqs1NC8i6bYqUcOOT4jKb43e0fJpesvkfD0zeratpaN+3LVtX+XBgKQPBnAC5/0AFg55MG6v7evU4SFe3nZ/0p0cRNgqZQv9z+8W1Ef9UQ8GUYUvXKZN+F4XvjUBJ/AeF9wJhd4nGJYcSzmbAe8y2LRX0XuxTX2x1ZLe/h51QfAk6oTAQ+BFiYKCJtCiFtS77nnUYhal3tvio+HH+Lhb1LPCKOP6UePO8TVhyYCVPyzcTS+alyxXNUa8SKgxV7y4ZlebjOVF8Xsl0nP6Y/P3sDAVy+LRo52zA2ieFwXcz5Uk93CXx65g1w8mDXDgghpbbCh7GGInqMn5VHC7nUT61ukoous2GQsy7ACnWQ+Jz3ICtpvNJlaxt0b7VBiPxuNDvNvNEg3+pgeKGta8Vmr9p+8HYNPxl6Ac9+LRKz998spSYBqVTsPdTI/Gjx6fPByfjH84f/hs8uTPk6fPhuPx+O8sYzeV2qJnJhoU3Hov/d07kFpJjbPWa7NH4/HscePKJ8e812Dj9j1bciUFzCUqAXSn/44OROeM+53Y/Q797jKfTG6Nf3JH6lDDmptai/+3ucc0utvAJ7MfOhOfHpr4WieX0aB9bq5R/y8s3NrTvz6k60nV3ayWiSh+ZzvG9s+TkR6L2smwjkP8zQm38iR9n1xe0WhcYSgNLQBsHRWmYX7CRm13Gd32+syGkTy3bHcCEWmxMgTrJ6OR51rk5mZoLGp6RxTPPXXPEbdytHw4fMg22T4Pt/ab6LE++VYWH/hC6sWX+K62rjqjcKaI7Ths+8BY+TPSC9PEo0/VLEVK5ATyKAKUJe+3C4gXbay7cO5P7e3Q/nVz+MFUcmyy7g/WjO0Mzw1E6k+BzdHRqaj5ltA/Y/u4m072cG7DcRxePv0cqmu4+pDh+PPfvP5f+5JvKEBzE6PZlM07i/qMHEtFF7Nh36cfUBWmwnZkGgxalk//+HfHNRh0QUlbBIJj72oH1qzQzWsVIzhXeCMJ/sZNXhW/das8j7wi0KbWQFPswsU4yoUMNME380XBLc+lktRViMwQt4NeY/JD+FBiKNHRp3uOgIfAJSpqRt0AoRdbxLEy7nquzMoTPMxrLzVBR9Ql1wURtqUR51RCqDRjWyc9gg+OtJZJN6OD40WAimu+iINmBn1nCVSS+gc4k9OaxBtVp0UArSuNi6N9MiiuCqMTX9D2zyHQKQEjhyXV8bLZBvgsbWNSHZEJWkCOPoAlXWSBcdittTLFdQwgQR2whnq65Iogcl9HYg+Oa08PT9KljUHnsGbIQ9+g/AuPFOE3Ul/7yWDwUZ/AZZdXHzD3MuDV/bYnrVarg170YJfnpQyv6hzeozVeBuPWW+6FDGWdx/7VF9L9kSS9RI0xf3rdaStDmMIftkM6HZWo7OgsTQt+dDp9HZ/BB/Dpt3/CG+ROQ2lWKVuL2qFaw6K9ijyXIp/c1r1icRXE61CSx4uUfM1StvXgh5KHT7/9y8NbXNGqI5UUmTIYTOtcyaLbgvvBYALPaYDq72bjfrngmmZ2X3JKJdrPcbCJW0l9PYRTvY4rtO3MQ+eRb8eM2GnbcPu4s4gDTn+lPdxqFCdtj2qJnmQRGskRUEgC2KF0pl6k2/rKNMY5nNOQ8CGteci2UyHANsft9oem+q06ODdpW7EG7hB8XOBM91jil9pa40iLZn00N+0mEbWwRurgJyAcn4et/GxvTo0byIOj5ELeuSNrxHQhSZXYWNyd0kST7b+su/3W4RwdXRjN3sbFyiadLtu0BMrWP5LWhJ+oa/Eiwrs4kqUn/sd9ORFqoav8u/kZuqUssIEZn6noUSQesYwpWaD2/Tf/9OX0DSwfD8f0SnV45SuKe/Tm9fMXb89ekDLUSJPDHg7Hw3EcsY0PFde9m/Z+Qdp/22634Pa//YNTg55ozTmyisuIXZttXcKdl6wHgib935quMlYaH4jk9paK8cKpzYaOf60jkLi8ytiSO0maRnDarMDE8SVQ3+z779tfb+DbfrY6alCLETUBxLg+TajoGtd7v59tCIw0QJE0ThTPk14n5yRnK+Fg7iCkmzhOiwJtuJO2D/SnF+eEnprfwqr4sxpzfEXAiq+Ssmm1HyFwPLtliutFzRdEm0Ru0kaz3MXF1xEXN/8go466YxcwJyvov2TTUYbb24S5N5uOPn36LEfj15aaYnO12Wz+A0uOZ+M=","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),s=i(28453),o=i(57742),p=i.n(o),r=i(78178),d=i.n(r),l=i(19624),c=i.n(l),m=i(96226),u=i.n(m),h=(i(77675),i(19365),i(51107)),g=i(21312);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:"eJzFWc2OG7kRfpUKL7aFHkn+XUSnnXgd21jDFjwzMJLxQGA3S2rusEkuyZZGGAjYQ94gp1zzaH6SoMjuVuvHY3vXSS67HnZVsf75VemWBb7wbHLJzrGyigf07CpjAn3hpA3SaDZh5yXChRU8ILRUcDp9Dah5rtDD2tQQDFRGyPkauBZQJ+pQIggMXCoPZg4cvMVCzmUBoZEzZBkzFh2nq14LNmGJtb2HZcxyxysM6EjNW6Z5hWzCWgEzKVjGJKlpeSjZvu6vf6KbSZGWA0LJA2hE4UnrHBttSY7DX2vpULBJcDVmzIe1otu8rKwiZfDGKiOQTeZceSIoSqw4m9yysLaRMjipFyxjc+MqHrYnm81Vko8+/MWINfHsqjp1ZikFQo7KrKAzm5Rs/dnGCO7zAAq5D2A09mhbAx6wjBVGB9SBLuLWKllEJ49+8XTb7aHqJv8Fi0AedxSSINHT1+TwLxtIzuHRTRPm4z86fdkmY9qEbxYzJRMRHC4lrmJiebnQEErpQZiirsi8zV7Iv+2KLiv6MjbEowQ6yshDeVtuokxV8O582iPNjVHI9UE2UlbBSTLAxENYSaWaSoJ351NYoqMKibEawoVH5xONwwLlEoHvkEBhBMJScsCKS5XBqpRFSQm/hqr2AVA3OdS4DjvPDSEmMZzAoUJC+qMaZcCVMiupF1BH1Y4JBiEdFkGtYSVDaeoAXAhJ7FyBD2j9sO/FqEXnyHNTuz/uSQ6LWgoUEEztYG5c1BKdz8DGMiMLpPbB1QUxexA1RTfaQaT0b+tMgd5v/dR6hYh68jNA7RM7hzn3AV0GtZbkeVfbgKITiTcWnURd4FEXROfOYiNtHO6/3hdTdJUMvrWUQsOFAFRIQfHg66IEnr7zUDv0GUgtg+TKZ+ADr6zPwDgIeEN9BYKx1DzxRvpAyq+kWGDwID+XR++RaqTo6TB3porRJ9/odT8ROr2C2RN3TkGVvnk+5rxWAZZc1cd9NpfqaGPZ9dHfTA0VXzfRTyHMucdnTwA11ZCA6U9/BRJGCjm0iheJrLPfaOx3k8R+0A8cpvSf1U59Wa+z9CJisvbi/RtYleiwy0N0Ka9zaoNJMNL7Giufbg1t1nbVt5++BxryOpiZw0pqgV9Ta2cYYpAozYLpSqwOpuJBFtCK8kNoSFNCBNOvmArut8HMseRLadyDowFN4mZGFziTeoZLdOuelrqucnQHSr6Nx5Svgq895BhWiLqvW5tWRqs1NC8i6bYqUcOOT4jKb43e0fJpesvkfD0zeratpaN+3LVtX+XBgKQPBnAC5/0AFg55MG6v7evU4SFe3nZ/0p0cRNgqZQv9z+8W1Ef9UQ8GUYUvXKZN+F4XvjUBJ/AeF9wJhd4nGJYcSzmbAe8y2LRX0XuxTX2x1ZLe/h51QfAk6oTAQ+BFiYKCJtCiFtS77nnUYhal3tvio+HH+Lhb1LPCKOP6UePO8TVhyYCVPyzcTS+alyxXNUa8SKgxV7y4ZlebjOVF8Xsl0nP6Y/P3sDAVy+LRo52zA2ieFwXcz5Uk93CXx65g1w8mDXDgghpbbCh7GGInqMn5VHC7nUT61ukoous2GQsy7ACnWQ+Jz3ICtpvNJlaxt0b7VBiPxuNDvNvNEg3+pgeKGta8Vmr9p+8HYNPxl6Ac9+LRKz998spSYBqVTsPdTI/Gjx6fPByfjH84f/hs8uTPk6fPhuPx+O8sYzeV2qJnJhoU3Hov/d07kFpJjbPWa7NH4/HscePKJ8e812Dj9j1bciUFzCUqAXSn/44OROeM+53Y/Q797jKfTG6Nf3JH6lDDmptai/+3ucc0utvAJ7MfOhOfHpr4WieX0aB9bq5R/y8s3NrTvz6k60nV3ayWiSh+ZzvG9s+TkR6L2smwjkP8zQm38iR9n1xe0WhcYSgNLQBsHRWmYX7CRm13Gd32+syGkTy3bHcCEWmxMgTrJ6OR51rk5mZoLGp6RxTPPXXPEbdytHw4fMg22T4Pt/ab6LE++VYWH/hC6sWX+K62rjqjcKaI7Ths+8BY+TPSC9PEo0/VLEVK5ATyKAKUJe+3C4gXbay7cO5P7e3Q/nVz+MFUcmyy7g/WjO0Mzw1E6k+BzdHRqaj5ltA/Y/u4m072cG7DcRxePv0cqmu4+pDh+PPfvP5f+5JvKEBzE6PZlM07i/qMHEtFF7Nh36cfUBWmwnZkGgxalk//+HfHNRh0QUlbBIJj72oH1qzQzWsVIzhXeCMJ/sZNXhW/das8j7wi0KbWQFPswsU4yoUMNME380XBLc+lktRViMwQt4NeY/JD+FBiKNHRp3uOgIfAJSpqRt0AoRdbxLEy7nquzMoTPMxrLzVBR9Ql1wURtqUR51RCqDRjWyc9gg+OtJZJN6OD40WAimu+iINmBn1nCVSS+gc4k9OaxBtVp0UArSuNi6N9MiiuCqMTX9D2zyHQKQEjhyXV8bLZBvgsbWNSHZEJWkCOPoAlXWSBcdittTLFdQwgQR2whnq65Iogcl9HYg+Oa08PT9KljUHnsGbIQ9+g/AuPFOE3Ul/7yWDwUZ/AZZdXHzD3MuDV/bYnrVarg170YJfnpQyv6hzeozVeBuPWW+6FDGWdx/7VF9L9kSS9RI0xf3rdaStDmMIftkM6HZWo7OgsTQt+dDp9HZ/BB/Dpt3/CG+ROQ2lWKVuL2qFaw6K9ijyXIp/c1r1icRXE61CSx4uUfM1StvXgh5KHT7/9y8NbXNGqI5UUmTIYTOtcyaLbgvvBYALPaYDq72bjfrngmmZ2X3JKJdrPcbCJW0l9PYRTvY4rtO3MQ+eRb8eM2GnbcPu4s4gDTn+lPdxqFCdtj2qJnmQRGskRUEgC2KF0pl6k2/rKNMY5nNOQ8CGteci2UyHANsft9oem+q06ODdpW7EG7hB8XOBM91jil9pa40iLZn00N+0mEbWwRurgJyAcn4et/GxvTo0byIOj5ELeuSNrxHQhSZXYWNyd0kST7b+su/3W4RwdXRjN3sbFyiadLtu0BMrWP5LWhJ+oa/Eiwrs4kqUn/sd9ORFqoav8u/kZuqUssIEZn6noUSQesYwpWaD2/Tf/9OX0DSwfD8f0SnV45SuKe/Tm9fMXb89ekDLUSJPDHg7Hw3EcsY0PFde9m/Z+Qdp/22634Pa//YNTg55ozTmyisuIXZttXcKdl6wHgib935quMlYaH4jk9paK8cKpzYaOf60jkLi8ytiSO0maRnDarMDE8SVQ3+z779tfb+DbfrY6alCLETUBxLg+TajoGtd7v59tCIw0QJE0ThTPk14n5yRnK+Fg7iCkmzhOiwJtuJO2D/SnF+eEnprfwqr4sxpzfEXAiq+Ssmm1HyFwPLtliutFzRdEm0Ru0kaz3MXF1xEXN/8go466YxcwJyvov2TTUYbb24S5N5uOPn36LEfj15aaYnO12Wz+A0uOZ+M=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,y={},T=[];function R(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(d(),{...i(49772)}),"\n",(0,n.jsx)(c(),{...i(7110)}),"\n",(0,n.jsx)(u(),{...i(78316)})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(R,{...e})}):R(e)}},49772(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},7110(e){e.exports=JSON.parse('{"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":false},"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":false},"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":false},"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":false},"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},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"template_template_id_body"}}}}}')},78316(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.bf61376f.js b/assets/js/62b755e6.51187a34.js similarity index 77% rename from assets/js/62b755e6.bf61376f.js rename to assets/js/62b755e6.51187a34.js index 6b877a25a..02ba2204f 100644 --- a/assets/js/62b755e6.bf61376f.js +++ b/assets/js/62b755e6.51187a34.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9350],{19899(e,t,n){n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>v,frontMatter:()=>j,metadata:()=>s,toc:()=>f});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+i2YBc4nX1Pt7Nsz9noW1Lkm4RZ5LtNYPPhwuDHcIqVgIx6VvAIRaQMILHgspCMREponbQO8e2CF8yNBlaGjr74amPykuJUG/zcRq0T0BK22u5lKvbAQc4tIKRcMaVBlXCRE2BxGBNsAVoHJoCiOoLXGGjBbBNK2c4YmDnCu+QJIdQT9WKUpBaAWj49I6sFqW3mJwXEhNA5PGH4WYhvnLK+qBDQKtUstvMCPULBEWpUjRRpDoFCF0WuSCSiFG66AgW0SCfj5RKqmTK39+NAGCQlMGEVzSK9C3kdid4crSUx5saY6gDVhhNDXP9YBoMHhvkQ74tVBXYXKzBx9bWH3A2AqHl0+bG7Bare4g/9kmz4lw/ypjoHxqhdNm3XEvhMvK2N+WvpD2R5B0ggo9fHp3oZOR6sTevXy0OspQFqNzdIQQOzo+O/VJ9xl8+fU3eI3cKMj0KoA1KQ3KNSwaVRS5cPIhbG3OhLn2wMso4kkAH00+0Lomgh8y7r78+ruFN7iiqV+4UeTKYHBWxlIkcFGXJXYwmMJLX7K0pUo9G0u4ghjBZpygtBQcOBSBWwp1NYRjtfZjsjD1IzDQuufbcGOj2+5PSrNO57CzyJcsFuUSLcmi9y9GwFRQVeUyo8tF0NY3pnbO4FxICR9CxU6+HacpFPVyXcj78qgzB+d0IVyGaz9ctKjcEM5usfidsqAXGVOKqce+pgKUDgBVWmhBo8Z6cNvKjzqg+8pQaLVlqR6ctuGIajHtkYSbWHvcroYB5a08vpluDc7RkELvdncuhajh9LGBJRBa/wis6bWmrMUTX0zU/To9KD/eluMfdjS5fTs/R7MUSTMtuudGjzzxiEVMigSVxV7BcHxy9hqWh8Mxi3qv4yMu9+j16ctXb85fkTGUSEPA9ofj4di34dq6nKuephPsZvnhE4Av8sOQ/vZDd9MVVn99Tvjrc0L7OaEus2j2MCokF77IrRvgUKB+ZLe+MEybjwmXEcu0dURyc0MQeW9kVdFymIFT3Vo3ft0U/ArXvZn9ksuy7p/vpa2H6x3pJf0wgmi367gX+U/f1Sf3DB7ztWNrcJrCVK37RjXGNrGpLmnGFCpTsjHsHicJFn2/77Q4G33CyasL5tv0bLMivvIVcf0HSd9q02apHAygfynUWxlubkK1XVUtfdi6l6N2sKGmAF1WVfV/b3r+5Q==","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(57742),p=n.n(a),o=n(78178),l=n.n(o),c=n(19624),m=n.n(c),d=n(96226),u=n.n(d),h=(n(77675),n(19365),n(51107)),x=n(21312);const j={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+i2YBc4nX1Pt7Nsz9noW1Lkm4RZ5LtNYPPhwuDHcIqVgIx6VvAIRaQMILHgspCMREponbQO8e2CF8yNBlaGjr74amPykuJUG/zcRq0T0BK22u5lKvbAQc4tIKRcMaVBlXCRE2BxGBNsAVoHJoCiOoLXGGjBbBNK2c4YmDnCu+QJIdQT9WKUpBaAWj49I6sFqW3mJwXEhNA5PGH4WYhvnLK+qBDQKtUstvMCPULBEWpUjRRpDoFCF0WuSCSiFG66AgW0SCfj5RKqmTK39+NAGCQlMGEVzSK9C3kdid4crSUx5saY6gDVhhNDXP9YBoMHhvkQ74tVBXYXKzBx9bWH3A2AqHl0+bG7Bare4g/9kmz4lw/ypjoHxqhdNm3XEvhMvK2N+WvpD2R5B0ggo9fHp3oZOR6sTevXy0OspQFqNzdIQQOzo+O/VJ9xl8+fU3eI3cKMj0KoA1KQ3KNSwaVRS5cPIhbG3OhLn2wMso4kkAH00+0Lomgh8y7r78+ruFN7iiqV+4UeTKYHBWxlIkcFGXJXYwmMJLX7K0pUo9G0u4ghjBZpygtBQcOBSBWwp1NYRjtfZjsjD1IzDQuufbcGOj2+5PSrNO57CzyJcsFuUSLcmi9y9GwFRQVeUyo8tF0NY3pnbO4FxICR9CxU6+HacpFPVyXcj78qgzB+d0IVyGaz9ctKjcEM5usfidsqAXGVOKqce+pgKUDgBVWmhBo8Z6cNvKjzqg+8pQaLVlqR6ctuGIajHtkYSbWHvcroYB5a08vpluDc7RkELvdncuhajh9LGBJRBa/wis6bWmrMUTX0zU/To9KD/eluMfdjS5fTs/R7MUSTMtuudGjzzxiEVMigSVxV7BcHxy9hqWh8Mxi3qv4yMu9+j16ctXb85fkTGUSEPA9ofj4di34dq6nKuephPsZvnhE4Av8sOQ/vZDd9MVVn99Tvjrc0L7OaEus2j2MCokF77IrRvgUKB+ZLe+MEybjwmXEcu0dURyc0MQeW9kVdFymIFT3Vo3ft0U/ArXvZn9ksuy7p/vpa2H6x3pJf0wgmi367gX+U/f1Sf3DB7ztWNrcJrCVK37RjXGNrGpLmnGFCpTsjHsHicJFn2/77Q4G33CyasL5tv0bLMivvIVcf0HSd9q02apHAygfynUWxlubkK1XVUtfdi6l6N2sKGmAF1WVfV/b3r+5Q==",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={},f=[{value:"Document Types:",id:"document-types",level:3}];function b(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)(p(),{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:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(l(),{...n(17331)}),"\n",(0,i.jsx)(m(),{...n(81553)}),"\n",(0,i.jsx)(u(),{...n(72791)})]})}function v(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},17331(e){e.exports=JSON.parse('{"parameters":[{"name":"doctype","in":"path","description":"The type of documents to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["draft","inprogress","completed","expired","declined"]}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},81553(e){e.exports={title:"Body"}},72791(e){e.exports=JSON.parse('{"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":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"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":false},"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9350],{19899(e,t,n){n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>y,default:()=>D,frontMatter:()=>b,metadata:()=>s,toc:()=>g});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(57742),l=n.n(a),o=n(78178),p=n.n(o),c=n(19624),m=n.n(c),d=n(96226),u=n.n(d),h=(n(77675),n(19365),n(51107)),x=n(21312);const b={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},y=void 0,j={},g=[{value:"Document Types:",id:"document-types",level:3}];function f(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...n(17331)}),"\n",(0,i.jsx)(m(),{...n(81553)}),"\n",(0,i.jsx)(u(),{...n(72791)})]})}function D(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},17331(e){e.exports=JSON.parse('{"parameters":[{"name":"doctype","in":"path","description":"The type of documents to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["draft","inprogress","completed","expired","declined"]}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},81553(e){e.exports={title:"Body"}},72791(e){e.exports=JSON.parse('{"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":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"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":false},"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/64218a31.a0a09b08.js b/assets/js/64218a31.2dc08ef1.js similarity index 61% rename from assets/js/64218a31.a0a09b08.js rename to assets/js/64218a31.2dc08ef1.js index 76bbb6301..bf80092a1 100644 --- a/assets/js/64218a31.a0a09b08.js +++ b/assets/js/64218a31.2dc08ef1.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3979],{90207(e,t,a){a.r(t),a.d(t,{assets:()=>w,contentTitle:()=>u,default:()=>I,frontMatter:()=>f,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/v1.1/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","source":"@site/docs/API-docs/v1.1/getformdata.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getformdata","permalink":"/docs/API-docs/v1.1/getformdata","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar_label":"Get Formdata","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWM1u3MgRfpVKX3Y9oGck2XvhabUbraLEsAVLhg7yQGiSNWRbze7e7uKMBgMCe9g3yCnXPJqfJKgmOcMZyXaEJAtEB4mqrv+fro/cCJJlEOmt+LPNmxoNBTFPRIEh98qRskak4rpCOEeCX6yvC0kSTi8vAI3MNAZY2wbIgkfyCpcIK1WUSBD5FkprLCBbQ1ClQR9gVdnuuQCqEIre6PSj+WjeWsIUrisVogEVwBq9BrmUSrMtWFgP1yjrANIUcGYIvfMqIDgtTZh+NCIR1qGX7PdFIVJRIi16p0UinPSyRkLPAW+EkTWKVAw+3KlCJEJxwE5SJQ6zYLNPmNNFAXYBQ7JEIjz+2iiPhUjJN5iIQGvNaoOqnUaRCHxw2hYo0oXUgRnyCmsp0o2gtYuc5JUpRSLYVUljCj7IqCUV8qeTPD+pXFaJtp2z2eCsCRhY0cnREf/Z9zc0eY4hLBoN26SIROTWEHueboR0Tqs8Hsw+BRbaPPauC5uz51kNqc7kkI3nxvHLubo/eZVVH/4q2kSQIqY+T0WID9w7rCJw6QpJz1ZzfDw7Pp6dHJ38ENWQpCY8V0du+YGwYBXMeBdbbadFei/X3FaEdfh2VruWfOzDzuInm0GGyPawlkp/kztD/LEjTHNbs1w3oeF/7WVX23bXql8XydGKln8S8VDrnZlRWncNMyY+LcFn7wfDB4L7Z1HB66cm6MrWSJUyJazQEKy8NWUCTqMMCOTXIEupDGhJ6P/03xst9N76ryfreZ61o/iV0crg3VCTu9dHR3fH2yS8fpyE4aoDYwkWtjHFHxvqU/a/HtDru1fbgH54HNCFWUqtirhjru09mj82nrF56sw/7mDVMcVzsRfsmN4FGTBvvKJ13GkPL6VTL7vz9HbOm4I7xfbLMC5BqkQqZsMgzDajBdgK1ueXw4psvBapqIhcSGezIE2R2YepdWh4iWuZBb5UZtKp2fJ4eiza5FBGOvcsfmxePlckkCyVKb8lN9+l6orL2VVsL2G7C9GpvyHfiH09xlw9RqhQFuhj7ZRZ2CjcV+mdQ3OlShNrHI0fYokb1LmtkYETw6DJZBD5/Ps/t1KTyRYfxW6MIOld48HZFXre6wyDFhofFKOjCMrqeLZFZQFlrTEEvQZlCEsvCaFQpSKpIw7jKySXTmZKK25iZrMs7WE0B2EKNxVShZ6PvvMIEgpcam59kA3ZWhJrGtyFlfX3C21XIQEJWROUwRAATSVNzoxDIRKwHqQB3GG5QJ6dVp1r1pCXOUEtjSyRdScwzlWBWnG3grdZEwiC1U30GEgqbT3jzD4eg1iEmMMzRmQegam8wT1W3DVLhLJRBYYEclsgdDiDQzAFZBgIHPuicgystDHa5vexfotGa3CWbxAlNQPEsY8sTl6awCPX+TKUYJsw5y2DNewcnEw+BOQCv1HmPqSTyUfzEm63bXWDWVCE8++HCVitVo86/8W+zLmivzQZvEdngyLr1zvpUlHVZHFaxkq2/3SaztFgbJ/RLOx0FDYPj4ePqbMKtZtdIXGHhNnp5UW8dF/A59/+Dm9QegOVXXXNmjce9RrKwRRnrqt8l7btnRlfBWRDFWc875qPgTgGGjJ4U0n6/Ns/ArzFFSjTTxSHMplcNplWOVxj7XhFhskkhZ89skkaaECVJMilgQwhVJJbaakkSHCdtFbmfgqnZg1NQA8rRVVsBqZHub0wOC/bcgfIZMACrIkSg83pziOm1wH1EgPr4t2XIWChKL45eduUnbWxM31wHvm9C246mMexnRYFuJ7coz9O+MgdXPBAUIVrkB6BQfUULg9E4knjnPXsheqcX1it7YoLgKZwVhkKKRReLminP9k1es5pVtY8QepSKLfpSHo125J0k9hHvKV2730H9/j+detxgZ4NxrB3dXGqb6fboS2Bu/U/aWve1nxryTyCiR6j80L58VBPXOzo6/BucYV+qXLsl9oXJnoWmWciEVrl2APqfkGdnl++geWr6ZFIRtvx3xju2ZuLn8/eXp2xM3yRdgk7nh5Nj5jkbKBampGl8YeAw7222eGo/6uPBv3WJ3ygmdNSRcwV07jp8dKtGH1HSMefDOaJqGwgZtlseKw/eN22TP61Qc+obJ6IpfSKvYmgqlCBn4vtF4Ev5vD79/3HhRfwha8PT3o+gBjDCGYpdcP/iUTc4/rge0c7b5MBybBrHcdpnqOjkewjSLyHK8/PrkUi+DbeR1D3EUH1D6z9Sb/2oVXnAP9mnPekwGbTobO23fJ3R1+U6AMcuDlJ87Zt/wW4xqol","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 Signer IPs","permalink":"/docs/API-docs/v1.1/getsignerips"},"next":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.1/getsigninglinks"}}');var r=a(74848),s=a(28453),o=a(57742),i=a.n(o),p=a(78178),d=a.n(p),l=a(19624),c=a.n(l),m=a(96226),g=a.n(m),b=(a(77675),a(19365),a(51107)),h=a(21312);const f={id:"getformdata",title:"Get Formdata",description:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.",sidebar_label:"Get Formdata",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWM1u3MgRfpVKX3Y9oGck2XvhabUbraLEsAVLhg7yQGiSNWRbze7e7uKMBgMCe9g3yCnXPJqfJKgmOcMZyXaEJAtEB4mqrv+fro/cCJJlEOmt+LPNmxoNBTFPRIEh98qRskak4rpCOEeCX6yvC0kSTi8vAI3MNAZY2wbIgkfyCpcIK1WUSBD5FkprLCBbQ1ClQR9gVdnuuQCqEIre6PSj+WjeWsIUrisVogEVwBq9BrmUSrMtWFgP1yjrANIUcGYIvfMqIDgtTZh+NCIR1qGX7PdFIVJRIi16p0UinPSyRkLPAW+EkTWKVAw+3KlCJEJxwE5SJQ6zYLNPmNNFAXYBQ7JEIjz+2iiPhUjJN5iIQGvNaoOqnUaRCHxw2hYo0oXUgRnyCmsp0o2gtYuc5JUpRSLYVUljCj7IqCUV8qeTPD+pXFaJtp2z2eCsCRhY0cnREf/Z9zc0eY4hLBoN26SIROTWEHueboR0Tqs8Hsw+BRbaPPauC5uz51kNqc7kkI3nxvHLubo/eZVVH/4q2kSQIqY+T0WID9w7rCJw6QpJz1ZzfDw7Pp6dHJ38ENWQpCY8V0du+YGwYBXMeBdbbadFei/X3FaEdfh2VruWfOzDzuInm0GGyPawlkp/kztD/LEjTHNbs1w3oeF/7WVX23bXql8XydGKln8S8VDrnZlRWncNMyY+LcFn7wfDB4L7Z1HB66cm6MrWSJUyJazQEKy8NWUCTqMMCOTXIEupDGhJ6P/03xst9N76ryfreZ61o/iV0crg3VCTu9dHR3fH2yS8fpyE4aoDYwkWtjHFHxvqU/a/HtDru1fbgH54HNCFWUqtirhjru09mj82nrF56sw/7mDVMcVzsRfsmN4FGTBvvKJ13GkPL6VTL7vz9HbOm4I7xfbLMC5BqkQqZsMgzDajBdgK1ueXw4psvBapqIhcSGezIE2R2YepdWh4iWuZBb5UZtKp2fJ4eiza5FBGOvcsfmxePlckkCyVKb8lN9+l6orL2VVsL2G7C9GpvyHfiH09xlw9RqhQFuhj7ZRZ2CjcV+mdQ3OlShNrHI0fYokb1LmtkYETw6DJZBD5/Ps/t1KTyRYfxW6MIOld48HZFXre6wyDFhofFKOjCMrqeLZFZQFlrTEEvQZlCEsvCaFQpSKpIw7jKySXTmZKK25iZrMs7WE0B2EKNxVShZ6PvvMIEgpcam59kA3ZWhJrGtyFlfX3C21XIQEJWROUwRAATSVNzoxDIRKwHqQB3GG5QJ6dVp1r1pCXOUEtjSyRdScwzlWBWnG3grdZEwiC1U30GEgqbT3jzD4eg1iEmMMzRmQegam8wT1W3DVLhLJRBYYEclsgdDiDQzAFZBgIHPuicgystDHa5vexfotGa3CWbxAlNQPEsY8sTl6awCPX+TKUYJsw5y2DNewcnEw+BOQCv1HmPqSTyUfzEm63bXWDWVCE8++HCVitVo86/8W+zLmivzQZvEdngyLr1zvpUlHVZHFaxkq2/3SaztFgbJ/RLOx0FDYPj4ePqbMKtZtdIXGHhNnp5UW8dF/A59/+Dm9QegOVXXXNmjce9RrKwRRnrqt8l7btnRlfBWRDFWc875qPgTgGGjJ4U0n6/Ns/ArzFFSjTTxSHMplcNplWOVxj7XhFhskkhZ89skkaaECVJMilgQwhVJJbaakkSHCdtFbmfgqnZg1NQA8rRVVsBqZHub0wOC/bcgfIZMACrIkSg83pziOm1wH1EgPr4t2XIWChKL45eduUnbWxM31wHvm9C246mMexnRYFuJ7coz9O+MgdXPBAUIVrkB6BQfUULg9E4knjnPXsheqcX1it7YoLgKZwVhkKKRReLminP9k1es5pVtY8QepSKLfpSHo125J0k9hHvKV2730H9/j+detxgZ4NxrB3dXGqb6fboS2Bu/U/aWve1nxryTyCiR6j80L58VBPXOzo6/BucYV+qXLsl9oXJnoWmWciEVrl2APqfkGdnl++geWr6ZFIRtvx3xju2ZuLn8/eXp2xM3yRdgk7nh5Nj5jkbKBampGl8YeAw7222eGo/6uPBv3WJ3ygmdNSRcwV07jp8dKtGH1HSMefDOaJqGwgZtlseKw/eN22TP61Qc+obJ6IpfSKvYmgqlCBn4vtF4Ev5vD79/3HhRfwha8PT3o+gBjDCGYpdcP/iUTc4/rge0c7b5MBybBrHcdpnqOjkewjSLyHK8/PrkUi+DbeR1D3EUH1D6z9Sb/2oVXnAP9mnPekwGbTobO23fJ3R1+U6AMcuDlJ87Zt/wW4xqol",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,w={},y=[];function C(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Formdata"}),"\n",(0,r.jsx)(i(),{method:"get",path:"/formdata/{document_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document."}),"\n",(0,r.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,r.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,r.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,r.jsx)(d(),{...a(48632)}),"\n",(0,r.jsx)(c(),{...a(21690)}),"\n",(0,r.jsx)(g(),{...a(68816)})]})}function I(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(C,{...e})}):C(e)}},48632(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},21690(e){e.exports={title:"Body"}},68816(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"title":{"type":"string","format":"string","example":"sample doc"},"sent_date":{"type":"string","format":"string","example":"11/11/2025"},"status":{"type":"string","format":"string","example":"completed"},"form_data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job bee"},"email":{"type":"string","example":"jobbee@exampl.com"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job title"},"response":{"type":"string","example":"ceo"}}}}},"xml":{"name":"form_data"},"title":"form_data"}}},"xml":{"name":"formdataResponse"},"title":"formdataResponse"}}}},"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3979],{90207(e,t,a){a.r(t),a.d(t,{assets:()=>I,contentTitle:()=>j,default:()=>y,frontMatter:()=>u,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","source":"@site/docs/API-docs/v1.1/getformdata.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getformdata","permalink":"/docs/API-docs/v1.1/getformdata","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar_label":"Get Formdata","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWM1u3MgRfpVKX3Y9oGck2XvhabUbraLEsAVLhg7yQGiSNWRbze7e7uKMBgMCe9g3yCnXPJqfJKgmOcMZyXaEJAtEB4mqrv+fro/cCJJlEOmt+LPNmxoNBTFPRIEh98qRskak4rpCOEeCX6yvC0kSTi8vAI3MNAZY2wbIgkfyCpcIK1WUSBD5FkprLCBbQ1ClQR9gVdnuuQCqEIre6PSj+WjeWsIUrisVogEVwBq9BrmUSrMtWFgP1yjrANIUcGYIvfMqIDgtTZh+NCIR1qGX7PdFIVJRIi16p0UinPSyRkLPAW+EkTWKVAw+3KlCJEJxwE5SJQ6zYLNPmNNFAXYBQ7JEIjz+2iiPhUjJN5iIQGvNaoOqnUaRCHxw2hYo0oXUgRnyCmsp0o2gtYuc5JUpRSLYVUljCj7IqCUV8qeTPD+pXFaJtp2z2eCsCRhY0cnREf/Z9zc0eY4hLBoN26SIROTWEHueboR0Tqs8Hsw+BRbaPPauC5uz51kNqc7kkI3nxvHLubo/eZVVH/4q2kSQIqY+T0WID9w7rCJw6QpJz1ZzfDw7Pp6dHJ38ENWQpCY8V0du+YGwYBXMeBdbbadFei/X3FaEdfh2VruWfOzDzuInm0GGyPawlkp/kztD/LEjTHNbs1w3oeF/7WVX23bXql8XydGKln8S8VDrnZlRWncNMyY+LcFn7wfDB4L7Z1HB66cm6MrWSJUyJazQEKy8NWUCTqMMCOTXIEupDGhJ6P/03xst9N76ryfreZ61o/iV0crg3VCTu9dHR3fH2yS8fpyE4aoDYwkWtjHFHxvqU/a/HtDru1fbgH54HNCFWUqtirhjru09mj82nrF56sw/7mDVMcVzsRfsmN4FGTBvvKJ13GkPL6VTL7vz9HbOm4I7xfbLMC5BqkQqZsMgzDajBdgK1ueXw4psvBapqIhcSGezIE2R2YepdWh4iWuZBb5UZtKp2fJ4eiza5FBGOvcsfmxePlckkCyVKb8lN9+l6orL2VVsL2G7C9GpvyHfiH09xlw9RqhQFuhj7ZRZ2CjcV+mdQ3OlShNrHI0fYokb1LmtkYETw6DJZBD5/Ps/t1KTyRYfxW6MIOld48HZFXre6wyDFhofFKOjCMrqeLZFZQFlrTEEvQZlCEsvCaFQpSKpIw7jKySXTmZKK25iZrMs7WE0B2EKNxVShZ6PvvMIEgpcoubeB9mQrSWxqsFfWFl/v9B2FRKQkDVBGQwB0FTS5Mw4VCIB60EawB2YC+TZa9X5Zg15mRPU0sgSWXcC42QVqBW3K3ibNYEgWN1El4Gk0tYz0OwDMohFiEk8Y0jmEZjKK9xjxW2zRCgbVWBIILcFQgc0OARTQIaBwLEvKsfAShujbX4fC7hotAZn+QpRUjNCHPvI4uSlCTxznS9DDbYJc94yWsPOwcnkQ0Cu8Btl7kM6mXw0L+F221c3mAVFOP9+GIHVavWo9V/sy5wr+kuTwXt0Niiyfr2TLhVVTRbHZaxk+0+n6RwNxv4ZDcNOR2Hz8Hj6mDqrULvZFRJ3SJidXl7EW/cFfP7t7/AGpTdQ2VXXrXnjUa+hHExx5rrKd2nbXprxXUA2VHHG8675GIljoCGDN5Wkz7/9I8BbXIEy/UhxKJPJZZNplcM11o53ZJhMUvjZI5ukgQZUSYJcGsgQQiW5lZZKggTXSWtl7qdwatbQBPSwUlTFZmB6lNsLg/OyLXeATAYswJooMdic7jxieh1QLzGwLl5+GQIWiuKrk7dN2VkbO9MH55FfvOCmw3kc22lRgOvJPfzjhI/cwQUPBFW4BukRGFVP4fJAJJ40zlnPXqjO+YXV2q64AGgKZ5WhkELh5YJ2+pNdo+ecZmXNE6QuhXKbjqRXsy1JN4l9xFtq9+J3cJHv37ceF+jZYAx7Vxen+na6HdoSuFv/k7bmdc23lswjmuhBOm+UHw/1xM2Ovg7vFlfolyrHfqt9YaJnkXkmEqFVjj2i7jfU6fnlG1i+mh6JZLQe/43hnr25+Pns7dUZO8MXaZew4+nR9IhJzgaqpRlZGn8JOFxsmx2Q+r/6atCvfcIHmjktVQRdMY2bHjDditGHhHT8zWCeiMoGYpbNhsf6g9dty+RfG/QMy+aJWEqv2JuIqgoV+LnYfhL4Yg6/f99/XXgBX/j88KTnA4oxDGGWUjf8n0jEPa4PPni08zYZoAy71nGc5jk6Gsk+wsR7wPL87Fokgm/jfQh1HyFU/8Dan/RrH1t1DvBvBnpPCmw2HTxr2y1/d/RFiT7AgZuTNG/b9l+41KqK","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 Signer IPs","permalink":"/docs/API-docs/v1.1/getsignerips"},"next":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.1/getsigninglinks"}}');var s=a(74848),o=a(28453),r=a(57742),i=a.n(r),l=a(78178),p=a.n(l),d=a(19624),c=a.n(d),m=a(96226),g=a.n(m),h=(a(77675),a(19365),a(51107)),f=a(21312);const u={id:"getformdata",title:"Get Formdata",description:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.",sidebar_label:"Get Formdata",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWM1u3MgRfpVKX3Y9oGck2XvhabUbraLEsAVLhg7yQGiSNWRbze7e7uKMBgMCe9g3yCnXPJqfJKgmOcMZyXaEJAtEB4mqrv+fro/cCJJlEOmt+LPNmxoNBTFPRIEh98qRskak4rpCOEeCX6yvC0kSTi8vAI3MNAZY2wbIgkfyCpcIK1WUSBD5FkprLCBbQ1ClQR9gVdnuuQCqEIre6PSj+WjeWsIUrisVogEVwBq9BrmUSrMtWFgP1yjrANIUcGYIvfMqIDgtTZh+NCIR1qGX7PdFIVJRIi16p0UinPSyRkLPAW+EkTWKVAw+3KlCJEJxwE5SJQ6zYLNPmNNFAXYBQ7JEIjz+2iiPhUjJN5iIQGvNaoOqnUaRCHxw2hYo0oXUgRnyCmsp0o2gtYuc5JUpRSLYVUljCj7IqCUV8qeTPD+pXFaJtp2z2eCsCRhY0cnREf/Z9zc0eY4hLBoN26SIROTWEHueboR0Tqs8Hsw+BRbaPPauC5uz51kNqc7kkI3nxvHLubo/eZVVH/4q2kSQIqY+T0WID9w7rCJw6QpJz1ZzfDw7Pp6dHJ38ENWQpCY8V0du+YGwYBXMeBdbbadFei/X3FaEdfh2VruWfOzDzuInm0GGyPawlkp/kztD/LEjTHNbs1w3oeF/7WVX23bXql8XydGKln8S8VDrnZlRWncNMyY+LcFn7wfDB4L7Z1HB66cm6MrWSJUyJazQEKy8NWUCTqMMCOTXIEupDGhJ6P/03xst9N76ryfreZ61o/iV0crg3VCTu9dHR3fH2yS8fpyE4aoDYwkWtjHFHxvqU/a/HtDru1fbgH54HNCFWUqtirhjru09mj82nrF56sw/7mDVMcVzsRfsmN4FGTBvvKJ13GkPL6VTL7vz9HbOm4I7xfbLMC5BqkQqZsMgzDajBdgK1ueXw4psvBapqIhcSGezIE2R2YepdWh4iWuZBb5UZtKp2fJ4eiza5FBGOvcsfmxePlckkCyVKb8lN9+l6orL2VVsL2G7C9GpvyHfiH09xlw9RqhQFuhj7ZRZ2CjcV+mdQ3OlShNrHI0fYokb1LmtkYETw6DJZBD5/Ps/t1KTyRYfxW6MIOld48HZFXre6wyDFhofFKOjCMrqeLZFZQFlrTEEvQZlCEsvCaFQpSKpIw7jKySXTmZKK25iZrMs7WE0B2EKNxVShZ6PvvMIEgpcoubeB9mQrSWxqsFfWFl/v9B2FRKQkDVBGQwB0FTS5Mw4VCIB60EawB2YC+TZa9X5Zg15mRPU0sgSWXcC42QVqBW3K3ibNYEgWN1El4Gk0tYz0OwDMohFiEk8Y0jmEZjKK9xjxW2zRCgbVWBIILcFQgc0OARTQIaBwLEvKsfAShujbX4fC7hotAZn+QpRUjNCHPvI4uSlCTxznS9DDbYJc94yWsPOwcnkQ0Cu8Btl7kM6mXw0L+F221c3mAVFOP9+GIHVavWo9V/sy5wr+kuTwXt0Niiyfr2TLhVVTRbHZaxk+0+n6RwNxv4ZDcNOR2Hz8Hj6mDqrULvZFRJ3SJidXl7EW/cFfP7t7/AGpTdQ2VXXrXnjUa+hHExx5rrKd2nbXprxXUA2VHHG8675GIljoCGDN5Wkz7/9I8BbXIEy/UhxKJPJZZNplcM11o53ZJhMUvjZI5ukgQZUSYJcGsgQQiW5lZZKggTXSWtl7qdwatbQBPSwUlTFZmB6lNsLg/OyLXeATAYswJooMdic7jxieh1QLzGwLl5+GQIWiuKrk7dN2VkbO9MH55FfvOCmw3kc22lRgOvJPfzjhI/cwQUPBFW4BukRGFVP4fJAJJ40zlnPXqjO+YXV2q64AGgKZ5WhkELh5YJ2+pNdo+ecZmXNE6QuhXKbjqRXsy1JN4l9xFtq9+J3cJHv37ceF+jZYAx7Vxen+na6HdoSuFv/k7bmdc23lswjmuhBOm+UHw/1xM2Ovg7vFlfolyrHfqt9YaJnkXkmEqFVjj2i7jfU6fnlG1i+mh6JZLQe/43hnr25+Pns7dUZO8MXaZew4+nR9IhJzgaqpRlZGn8JOFxsmx2Q+r/6atCvfcIHmjktVQRdMY2bHjDditGHhHT8zWCeiMoGYpbNhsf6g9dty+RfG/QMy+aJWEqv2JuIqgoV+LnYfhL4Yg6/f99/XXgBX/j88KTnA4oxDGGWUjf8n0jEPa4PPni08zYZoAy71nGc5jk6Gsk+wsR7wPL87Fokgm/jfQh1HyFU/8Dan/RrH1t1DvBvBnpPCmw2HTxr2y1/d/RFiT7AgZuTNG/b9l+41KqK",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,I={},b=[];function F(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 Formdata"}),"\n",(0,s.jsx)(i(),{method:"get",path:"/formdata/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document."}),"\n",(0,s.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...a(48632)}),"\n",(0,s.jsx)(c(),{...a(21690)}),"\n",(0,s.jsx)(g(),{...a(68816)})]})}function y(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(F,{...e})}):F(e)}},48632(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},21690(e){e.exports={title:"Body"}},68816(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"title":{"type":"string","format":"string","example":"sample doc"},"sent_date":{"type":"string","format":"string","example":"11/11/2025"},"status":{"type":"string","format":"string","example":"completed"},"form_data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job bee"},"email":{"type":"string","example":"jobbee@exampl.com"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job title"},"response":{"type":"string","example":"ceo"}}}}},"xml":{"name":"form_data"},"title":"form_data"}}},"xml":{"name":"formdataResponse"},"title":"formdataResponse"}}}},"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.aabfabae.js b/assets/js/6d2e526e.f7d7ed8f.js similarity index 63% rename from assets/js/6d2e526e.aabfabae.js rename to assets/js/6d2e526e.f7d7ed8f.js index c0f81dae4..04e236939 100644 --- a/assets/js/6d2e526e.aabfabae.js +++ b/assets/js/6d2e526e.f7d7ed8f.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5752],{16027(e,t,o){o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>g,default:()=>W,frontMatter:()=>y,metadata:()=>n,toc:()=>f});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+3CBwKXEl6IsBbrxvuSdPY6Nfa3pc0oyTAIWudUOgcoKq5yolxiFcC2gJXgMqjNVY4BOctGS2iaVp5y3MPDVe8QtKdwBSrAqWgpAars9Z5cFq2wWLwXEhtsYDBH4VYuIDha5osLAJRc90YizUl1wqhakWBLoFcFwguRJtcUAVk6DwYskXk6Ehpq6TO70P8qP+C0VRpBJc08kxtJHFvuXI0p/TzWB+CETBjNTVyjAbOZj84pAC/FerepbPZB3UEN2NaXWPmhMfbL4aHsl6vHz2QF/syb4T/rs3gPRrthNd2s5OuhK/bLDyqqZLxI2p6gwpD+kyezE5HoXP3+I0SdVGjNItL9JQhbnF2cR6K8wv4+POv8Ba5VVDrdUzWvLUoN1ANVxFyMfIRtrG2QqlD4tWEeB6Trx/tBgSva+4//vybg+9xDUL1L4pcmc0u2kyKHK6wMdRK3WyWwiuLdKUfaOBr7iHnCjIEV3NKpZXgwMFEaSnU/RzO1AZahxbWwtchGYge5PbcIFx2Yzhk3GEBWgWJ4c75ziKiNw7lCh3poh6ZIWAhPGV0bXVbxdumxvTOWSyFlHAtigp98O2sKMD05HUkE+ATc7CkB+Fr3AC3CA6Vn8PFgUg4aY3RlqwQ0fhS0zJCAUBVGC2UdykUlpd+pz/ZJXpOMAutniBFCPkIR9KrGUMSX2Lv8Uidf6DSfVDu98utxRLDEhTc3sXFiD6dboa0BMrW/yWtqR9Q1eJ5GDqw4ULGvvP1oZ4wAKBt3LvyEu1K5Nj3vk+86EVgXrCESZGjcjgZLM7eXLyF1cv5kiWTJvoHHvfi7fmr199fviZjqJBGwI7ny/mSSDRbNFxNbur30W93C+Me1pOd6v+0vvad3OODXxjJRRikgs/bfga6YZN1Np1urrcJq2laSm/Ydktv8Acru47IP7VoadS6TdiKW8Ez6uQ3W1YIR7+LcQ39pLdfvO832hfwh5fgJ30ZRhVFc8qKyzasjwm7x83BIt7ddskwr5CxkeNVNOnoivTsNDyaf2ngihJneY7GP8s7HTgv3l1esYRl/RLdhC2dWb6mtZ6vo7U6QBTXY6JtmeSqanlFvFEnjVhUxPfns/swn/U/yKsn8dgf3KIb9JecelJgu42zX9eN/PHokxI9sAM3Bee267r/AprAPDA=","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),r=o(57742),i=o.n(r),d=o(78178),a=o.n(d),p=o(19624),u=o.n(p),l=o(96226),v=o.n(l),m=(o(77675),o(19365),o(51107)),h=o(21312);const y={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"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+3CBwKXEl6IsBbrxvuSdPY6Nfa3pc0oyTAIWudUOgcoKq5yolxiFcC2gJXgMqjNVY4BOctGS2iaVp5y3MPDVe8QtKdwBSrAqWgpAars9Z5cFq2wWLwXEhtsYDBH4VYuIDha5osLAJRc90YizUl1wqhakWBLoFcFwguRJtcUAVk6DwYskXk6Ehpq6TO70P8qP+C0VRpBJc08kxtJHFvuXI0p/TzWB+CETBjNTVyjAbOZj84pAC/FerepbPZB3UEN2NaXWPmhMfbL4aHsl6vHz2QF/syb4T/rs3gPRrthNd2s5OuhK/bLDyqqZLxI2p6gwpD+kyezE5HoXP3+I0SdVGjNItL9JQhbnF2cR6K8wv4+POv8Ba5VVDrdUzWvLUoN1ANVxFyMfIRtrG2QqlD4tWEeB6Trx/tBgSva+4//vybg+9xDUL1L4pcmc0u2kyKHK6wMdRK3WyWwiuLdKUfaOBr7iHnCjIEV3NKpZXgwMFEaSnU/RzO1AZahxbWwtchGYge5PbcIFx2Yzhk3GEBWgWJ4c75ziKiNw7lCh3poh6ZIWAhPGV0bXVbxdumxvTOWSyFlHAtigp98O2sKMD05HUkE+ATc7CkB+Fr3AC3CA6Vn8PFgUg4aY3RlqwQ0fhS0zJCAUBVGC2UdykUlpd+pz/ZJXpOMAutniBFCPkIR9KrGUMSX2Lv8Uidf6DSfVDu98utxRLDEhTc3sXFiD6dboa0BMrW/yWtqR9Q1eJ5GDqw4ULGvvP1oZ4wAKBt3LvyEu1K5Nj3vk+86EVgXrCESZGjcjgZLM7eXLyF1cv5kiWTJvoHHvfi7fmr199fviZjqJBGwI7ny/mSSDRbNFxNbur30W93C+Me1pOd6v+0vvad3OODXxjJRRikgs/bfga6YZN1Np1urrcJq2laSm/Ydktv8Acru47IP7VoadS6TdiKW8Ez6uQ3W1YIR7+LcQ39pLdfvO832hfwh5fgJ30ZRhVFc8qKyzasjwm7x83BIt7ddskwr5CxkeNVNOnoivTsNDyaf2ngihJneY7GP8s7HTgv3l1esYRl/RLdhC2dWb6mtZ6vo7U6QBTXY6JtmeSqanlFvFEnjVhUxPfns/swn/U/yKsn8dgf3KIb9JecelJgu42zX9eN/PHokxI9sAM3Bee267r/AprAPDA=",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,k={},f=[];function x(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,c.jsx)(i(),{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)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,c.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,c.jsx)(a(),{...o(87513)}),"\n",(0,c.jsx)(u(),{...o(9379)}),"\n",(0,c.jsx)(v(),{...o(19461)})]})}function W(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(x,{...e})}):x(e)}},87513(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to revoke","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},9379(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","example":""}},"title":"revokedocument"}}}}}')},19461(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5752],{16027(e,t,o){o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>k,default:()=>w,frontMatter:()=>y,metadata:()=>n,toc:()=>f});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(57742),r=o.n(i),d=o(78178),a=o.n(d),l=o(19624),u=o.n(l),p=o(96226),m=o.n(p),h=(o(77675),o(19365),o(51107)),v=o(21312);const y={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"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},k=void 0,g={},f=[];function x(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:(0,c.jsx)(v.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,c.jsx)(a(),{...o(87513)}),"\n",(0,c.jsx)(u(),{...o(9379)}),"\n",(0,c.jsx)(m(),{...o(19461)})]})}function w(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(x,{...e})}):x(e)}},87513(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to revoke","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},9379(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","example":""}},"title":"revokedocument"}}}}}')},19461(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.70b02a21.js b/assets/js/7357a3c5.1ede26e4.js similarity index 61% rename from assets/js/7357a3c5.70b02a21.js rename to assets/js/7357a3c5.1ede26e4.js index 0e45b08d6..dbbc9b86b 100644 --- a/assets/js/7357a3c5.70b02a21.js +++ b/assets/js/7357a3c5.1ede26e4.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1665],{98268(e,t,o){o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>x,default:()=>P,frontMatter:()=>m,metadata:()=>a,toc:()=>w});const a=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/9wgSclxppj3IhmwtiTX1cGFt/X3Bw1ACEtImKIMhAJpKmowP9oFIwHqQBtAQeudVQAjkGbRqoVlDXmYEtTSyRNadwNhXOWrFbAVv0yYQBKubiBh45rIec+jtMYh5iD58wxOOR+DVzNbOY8WsWSGUjcoxJJDZHCHEdGUTTA4pBgLHWFSGgZU2RtvsPsavaLQGZ7l6KKl53BpjZHHy0gQucC2WPgSDw5y3PPxgC3Ay+TkgB/itMvdhMZl8MEdwO9DqBtOgCJff9BmwXq+fMP/Vocy5oh+aFH5CZ4Mi6zd76VJR1aQxW8ZKho9W0zkajPQZ5cJeR26z8DT5eHVWoXazKyRmSJidXV7EgvsKPv36D3iL0huo7Lola9Z41Bso+6vYc23kW7cN9RIKG4lXscezlnw82GKg3oM3laRPv/4zwDtcgzJdRrEpk8llk2qVwTXWjptlmEwW8H2ceoD6NaBKEmTSQIoQKslUWikJElwrrZW5n8KZ2UAT0MNaURXJwOtR7sAM9ssQ7gCpDJiDNVGiv3O6R8TrdUC9wsC6uO+lCJgrYkZX3jZle9sYTGecx0JpDTcqL5GibWd5Dq5bXrfL7PARHCw4IajCDUiPENDQFC4ficSdxjnrGYVqwReWXz0cADS5s8pQWEDuZUF7/cme6HG4VNY8s9S6UA7uSDo1Q0jaTOwsHlanH7gmP6rjh+XWY4GeL4xm7+PiVEen256WwGz9f2gdB2hrSGZxkMBaKt02lD8/1hObOvo6vC+u0K9Uhl1T+0xGz+LhmUiEVhmagKNh4ez88i2svp3ORTLqjv9Fcs/eXnz/5t3VGwbDhbR12PF0Pp3H14UNVEszumn/5n3c1bb7Ceq3fR13TZnwgWZOSxXHoWjlthtlbsXwvl3s38bLRFQ2EG9vt5xxP3u92/HyLw16HpaWiVhJr2TKfft2K3IV+Hc+PH4/a+A3P3Xv6Ffw7DP7Wcz9dGF4tFhJ3fCXSMQ9bg4e9bvlLukHDIbV7p9lGToaST6ZUg9GvfM31yIRXCQPB5v7ONh0P1j7s6gOJ54WAP/l8etZge22HZp2u+F8u/VZic7A/jS7aLnb7f4Neb0Z4g==","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=o(74848),i=o(28453),n=o(57742),r=o.n(n),l=o(78178),d=o.n(l),p=o(19624),c=o.n(p),u=o(96226),g=o.n(u),h=(o(77675),o(19365),o(51107)),f=o(21312);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/9wgSclxppj3IhmwtiTX1cGFt/X3Bw1ACEtImKIMhAJpKmowP9oFIwHqQBtAQeudVQAjkGbRqoVlDXmYEtTSyRNadwNhXOWrFbAVv0yYQBKubiBh45rIec+jtMYh5iD58wxOOR+DVzNbOY8WsWSGUjcoxJJDZHCHEdGUTTA4pBgLHWFSGgZU2RtvsPsavaLQGZ7l6KKl53BpjZHHy0gQucC2WPgSDw5y3PPxgC3Ay+TkgB/itMvdhMZl8MEdwO9DqBtOgCJff9BmwXq+fMP/Vocy5oh+aFH5CZ4Mi6zd76VJR1aQxW8ZKho9W0zkajPQZ5cJeR26z8DT5eHVWoXazKyRmSJidXV7EgvsKPv36D3iL0huo7Lola9Z41Bso+6vYc23kW7cN9RIKG4lXscezlnw82GKg3oM3laRPv/4zwDtcgzJdRrEpk8llk2qVwTXWjptlmEwW8H2ceoD6NaBKEmTSQIoQKslUWikJElwrrZW5n8KZ2UAT0MNaURXJwOtR7sAM9ssQ7gCpDJiDNVGiv3O6R8TrdUC9wsC6uO+lCJgrYkZX3jZle9sYTGecx0JpDTcqL5GibWd5Dq5bXrfL7PARHCw4IajCDUiPENDQFC4ficSdxjnrGYVqwReWXz0cADS5s8pQWEDuZUF7/cme6HG4VNY8s9S6UA7uSDo1Q0jaTOwsHlanH7gmP6rjh+XWY4GeL4xm7+PiVEen256WwGz9f2gdB2hrSGZxkMBaKt02lD8/1hObOvo6vC+u0K9Uhl1T+0xGz+LhmUiEVhmagKNh4ez88i2svp3ORTLqjv9Fcs/eXnz/5t3VGwbDhbR12PF0Pp3H14UNVEszumn/5n3c1bb7Ceq3fR13TZnwgWZOSxXHoWjlthtlbsXwvl3s38bLRFQ2EG9vt5xxP3u92/HyLw16HpaWiVhJr2TKfft2K3IV+Hc+PH4/a+A3P3Xv6Ffw7DP7Wcz9dGF4tFhJ3fCXSMQ9bg4e9bvlLukHDIbV7p9lGToaST6ZUg9GvfM31yIRXCQPB5v7ONh0P1j7s6gOJ54WAP/l8etZge22HZp2u+F8u/VZic7A/jS7aLnb7f4Neb0Z4g==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,k={},w=[];function G(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,s.jsx)(r(),{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)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...o(12898)}),"\n",(0,s.jsx)(c(),{...o(48680)}),"\n",(0,s.jsx)(g(),{...o(7938)})]})}function P(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(G,{...e})}):G(e)}},12898(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},48680(e){e.exports={title:"Body"}},7938(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1665],{98268(e,t,n){n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>j,default:()=>C,frontMatter:()=>g,metadata:()=>o,toc:()=>y});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),a=n(28453),i=n(57742),r=n.n(i),l=n(78178),d=n.n(l),p=n(19624),c=n.n(p),f=n(96226),h=n.n(f),u=(n(77675),n(19365),n(51107)),m=n(21312);const g={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},j=void 0,x={},y=[];function k(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,s.jsx)(r(),{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:(0,s.jsx)(m.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...n(12898)}),"\n",(0,s.jsx)(c(),{...n(48680)}),"\n",(0,s.jsx)(h(),{...n(7938)})]})}function C(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(k,{...e})}):k(e)}},12898(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},48680(e){e.exports={title:"Body"}},7938(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/767ebc75.3737fe1e.js b/assets/js/767ebc75.c1c27f9c.js similarity index 59% rename from assets/js/767ebc75.3737fe1e.js rename to assets/js/767ebc75.c1c27f9c.js index b49924ebb..eeeb9ec2f 100644 --- a/assets/js/767ebc75.3737fe1e.js +++ b/assets/js/767ebc75.c1c27f9c.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7797],{5049(e,t,n){n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>I,default:()=>k,frontMatter:()=>u,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","source":"@site/docs/API-docs/v1.1/getsignerips.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getsignerips","permalink":"/docs/API-docs/v1.1/getsignerips","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar_label":"Get Signer IPs","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV0tvHDcS/iu1vCQetGckW3lsn6LNKooSwxYsGTrIA4HdXTNNi00yLPaMBoMGcsg/yGmv+9P8SxbFfkyPJDvrJAhykXqKrPfr41YEuSSRXot/27yu0AQS80QUSLlXLihrRCouS4RTDHChlgY9nJ0THJ+fARqZaSTY2BqCBY/BK1xhPLcLoHibYF3a9ruAUCIUnZ7pW/PWvLQBU7gsVStREVijNyBXUmkWDgvr4RJlRSBNAScmoHdeEYLT0tD0rRGJsA69ZFPPCpGKJYZWs3IkEuGklxUG9OzkVhhZoUhFb8SNKkQiFDvpZCjFfc9t9g7zcFawP32ARCI8/lQrj4VIg68xERQ2msWSqpxGkQi8c9oWKNKF1MQX8hIrKdKtCBsXbwavzFIkYmF9JcOYgncySkmF/NezPH9WuqwUTTNnteSsISQW9OzggP/t20t1niPRotYwREUkIrcmsOXpVkjntMrjwewdMdP2oXWt2xw9z2KCalX20fhUP747VbfPnmflmx9Ek4g2Ozecnp0c6b3ccCoCVvTblmAllX7MjJ3SdxYzxG86wjS3FStX7kYWhUeij3Mf/vP59PDrL6dH08OvvxJNk4i7KirsCqh14szR6y4nLDyooHeH0cPmd7HuHUYRR49l+8JWGEpllrBGE2DtrVkm4DRKQgh+A3IplQEtA/p//HllgN5b//HwfZplzSgAymhl8KYv9Zujg4ObwyEIRw+D0LclGBtgYWtT/LWuPqb/4w4d3TwfHPrioUNnZiW1KuJAvLS3aP5af8bqQ6v+YQ2r9lI8F3vOjumtk4R57VXYxPl791Q69bQ9T6/nPNW4Umw3uePADqVIxWwY4rPtaFo3ggX6VT/Pa69FKsoQHKWzGUlTZPZuah0a5tcyI+78mXRqtjqcHoomuc8jnfuk+1g//VQWCnKpzPK3+Oa7WF1wPtuU7UVsNy+d+hF5YHYJGd/qFlqJskAfk6fMwkbmLk2vHBpe5jHJUfn9xXeFOrcV8l7npT2Z9Czvf/nvwDWZDNs8lmNc6a9qD86u0fMS4qW90HineJdHzFDFswE0EMpKI5HegDIBl14GhEItVZA6ogaeIbl0MlNacRXzNcvcHkaNQFO4KjGU6PnoM48gocCV5toHWQdbycCSenNhbf3tQts1JSAhq0kZJAI0pTQ5X+wTkYD1IA3gDnlQ8Gy0ak2zJniZB6ikkUtk2QmMY1WgVlyt4G1WUwCyuo4WQ5BKW8+oqPPHIBYUY3jC8MEjMDW3lfNYctWsEJa1KpASyG2BQLFn2QVTQIYUwLEtKkdiobXRNr+N+VvUWoOzPEKU1IxmxjYye/DSEC/x1pY+BUPAnLeMLLA1cDJ5Q8gJfqHMLaWTyVvzFK6HsrrCjFTA+ed9B6zX6weV/2Sf51SF7+sMXqOzpIL1mx33UoWyzmK3jIUMP1pJp2gwls+oF3YyCpvTw+Zj6qxE7WYXGLhCaHZ8fhan7hN4//Ov8AKlN1DadVusee1Rb2DZq+LItZlvwzYMzQhcZR1KjnjeFh+jRqTQR/CqlOH9z/8heIlrUKbrKHZlMjmvM61yuMTK8Y6kySSFbz2yytDTIJQyQC4NZAhUSi6llZIgwbXcWpnbKRybDdSEHtYqlLEYmB759tzguAzpJsgkYQHWRI5e53RnEdMrQr1CYlm8/DIELFSION/betlqGxvTOedxobSGK1UwWGffjosCXEdet2QO+MgcXHBDhBI3ID0C8QsCzu+xxJPaOevZCtUav7Ba2zUnAE3hrDKBUii8XISd/GRX6DmHWVnzCKkNoRzCkXRihpS0ndh5PFDbV8q9Ob4/bj0u0LPC6PYuL0515XTdlyVwtf6RsuZ1zVNL5mGEpHmhfHNfTtzs6Ct6tbhAv1I5dkvtAx09i5dnIhFa5cjgdYcYjk/PX8Dq+fRAJKPt+H809+zF2bcnLy9O2BgepG3ADqcH0wMmOUuhkmakaf+len+zbXdQ6u/+ru1WfcC7MHNaqoi0Yuy2HUq6FuOnbjp+1c4TUVoKfGe75WZ+43XTMPmnGj2DsXkiVtIrNidCqUIRfxfDo/WDcfv8dff+fQIfeCA/anoPXQzjlpXUNf8SibjFzb0neTNvkh6/sGntjeM8RxdGvA+Q8B6cPD25FIngGbyPm24jbuo+WPqjdu0DqtYA/svo7lGG7bbFZE0z3G+PPsjROdjf5iDNm6b5H+RJLuM=","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":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.1/getformdata"}}');var i=n(74848),o=n(28453),r=n(57742),a=n.n(r),l=n(78178),p=n.n(l),c=n(19624),d=n.n(c),g=n(96226),m=n.n(g),P=(n(77675),n(19365),n(51107)),h=n(21312);const u={id:"getsignerips",title:"Get Signer IPs",description:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.",sidebar_label:"Get Signer IPs",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV0tvHDcS/iu1vCQetGckW3lsn6LNKooSwxYsGTrIA4HdXTNNi00yLPaMBoMGcsg/yGmv+9P8SxbFfkyPJDvrJAhykXqKrPfr41YEuSSRXot/27yu0AQS80QUSLlXLihrRCouS4RTDHChlgY9nJ0THJ+fARqZaSTY2BqCBY/BK1xhPLcLoHibYF3a9ruAUCIUnZ7pW/PWvLQBU7gsVStREVijNyBXUmkWDgvr4RJlRSBNAScmoHdeEYLT0tD0rRGJsA69ZFPPCpGKJYZWs3IkEuGklxUG9OzkVhhZoUhFb8SNKkQiFDvpZCjFfc9t9g7zcFawP32ARCI8/lQrj4VIg68xERQ2msWSqpxGkQi8c9oWKNKF1MQX8hIrKdKtCBsXbwavzFIkYmF9JcOYgncySkmF/NezPH9WuqwUTTNnteSsISQW9OzggP/t20t1niPRotYwREUkIrcmsOXpVkjntMrjwewdMdP2oXWt2xw9z2KCalX20fhUP747VbfPnmflmx9Ek4g2Ozecnp0c6b3ccCoCVvTblmAllX7MjJ3SdxYzxG86wjS3FStX7kYWhUeij3Mf/vP59PDrL6dH08OvvxJNk4i7KirsCqh14szR6y4nLDyooHeH0cPmd7HuHUYRR49l+8JWGEpllrBGE2DtrVkm4DRKQgh+A3IplQEtA/p//HllgN5b//HwfZplzSgAymhl8KYv9Zujg4ObwyEIRw+D0LclGBtgYWtT/LWuPqb/4w4d3TwfHPrioUNnZiW1KuJAvLS3aP5af8bqQ6v+YQ2r9lI8F3vOjumtk4R57VXYxPl791Q69bQ9T6/nPNW4Umw3uePADqVIxWwY4rPtaFo3ggX6VT/Pa69FKsoQHKWzGUlTZPZuah0a5tcyI+78mXRqtjqcHoomuc8jnfuk+1g//VQWCnKpzPK3+Oa7WF1wPtuU7UVsNy+d+hF5YHYJGd/qFlqJskAfk6fMwkbmLk2vHBpe5jHJUfn9xXeFOrcV8l7npT2Z9Czvf/nvwDWZDNs8lmNc6a9qD86u0fMS4qW90HineJdHzFDFswE0EMpKI5HegDIBl14GhEItVZA6ogaeIbl0MlNacRXzNcvcHkaNQFO4KjGU6PnoM48gocCV5toHWQdbycCSenNhbf3tQts1JSAhq0kZJAI0pTQ5X+wTkYD1IA3gDnlQ8Gy0ak2zJniZB6ikkUtk2QmMY1WgVlyt4G1WUwCyuo4WQ5BKW8+oqPPHIBYUY3jC8MEjMDW3lfNYctWsEJa1KpASyG2BQLFn2QVTQIYUwLEtKkdiobXRNr+N+VvUWoOzPEKU1IxmxjYye/DSEC/x1pY+BUPAnLeMLLA1cDJ5Q8gJfqHMLaWTyVvzFK6HsrrCjFTA+ed9B6zX6weV/2Sf51SF7+sMXqOzpIL1mx33UoWyzmK3jIUMP1pJp2gwls+oF3YyCpvTw+Zj6qxE7WYXGLhCaHZ8fhan7hN4//Ov8AKlN1DadVusee1Rb2DZq+LItZlvwzYMzQhcZR1KjnjeFh+jRqTQR/CqlOH9z/8heIlrUKbrKHZlMjmvM61yuMTK8Y6kySSFbz2yytDTIJQyQC4NZAhUSi6llZIgwbXcWpnbKRybDdSEHtYqlLEYmB759tzguAzpJsgkYQHWRI5e53RnEdMrQr1CYlm8/DIELFSION/betlqGxvTOedxobSGK1UwWGffjosCXEdet2QO+MgcXHBDhBI3ID0C8QsCzu+xxJPaOevZCtUav7Ba2zUnAE3hrDKBUii8XISd/GRX6DmHWVnzCKkNoRzCkXRihpS0ndh5PFDbV8q9Ob4/bj0u0LPC6PYuL0515XTdlyVwtf6RsuZ1zVNL5mGEpHmhfHNfTtzs6Ct6tbhAv1I5dkvtAx09i5dnIhFa5cjgdYcYjk/PX8Dq+fRAJKPt+H809+zF2bcnLy9O2BgepG3ADqcH0wMmOUuhkmakaf+len+zbXdQ6u/+ru1WfcC7MHNaqoi0Yuy2HUq6FuOnbjp+1c4TUVoKfGe75WZ+43XTMPmnGj2DsXkiVtIrNidCqUIRfxfDo/WDcfv8dff+fQIfeCA/anoPXQzjlpXUNf8SibjFzb0neTNvkh6/sGntjeM8RxdGvA+Q8B6cPD25FIngGbyPm24jbuo+WPqjdu0DqtYA/svo7lGG7bbFZE0z3G+PPsjROdjf5iDNm6b5H+RJLuM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},I=void 0,b={},f=[];function j(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(P.default,{as:"h1",className:"openapi__heading",children:"Get Signer IPs"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/signerips/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document."}),"\n",(0,i.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,i.jsx)(P.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...n(54558)}),"\n",(0,i.jsx)(d(),{...n(70540)}),"\n",(0,i.jsx)(m(),{...n(52086)})]})}function k(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}},54558(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},70540(e){e.exports={title:"Body"}},52086(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"signer_ips":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"ip_address":{"type":"string","example":"193.186.4.187"}},"xml":{"name":"signerIpsResponse"},"title":"signer_ips"}}},"xml":{"name":"signerIpsResponse"},"title":"signerIpsResponse"}}}},"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7797],{5049(e,t,s){s.r(t),s.d(t,{assets:()=>b,contentTitle:()=>u,default:()=>S,frontMatter:()=>P,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/v1.1/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","source":"@site/docs/API-docs/v1.1/getsignerips.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getsignerips","permalink":"/docs/API-docs/v1.1/getsignerips","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar_label":"Get Signer IPs","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV0tvHDcS/iu1vCQetGckW3lsn6LNKooSwxYsGTrIA4HdXTNNi00yLPaMBoMGcsg/yGmv+9P8SxbFfkyPJDvrJAhykXqKrPfr41YEuSSRXot/27yu0AQS80QUSLlXLihrRCouS4RTDHChlgY9nJ0THJ+fARqZaSTY2BqCBY/BK1xhPLcLoHibYF3a9ruAUCIUnZ7pW/PWvLQBU7gsVStREVijNyBXUmkWDgvr4RJlRSBNAScmoHdeEYLT0tD0rRGJsA69ZFPPCpGKJYZWs3IkEuGklxUG9OzkVhhZoUhFb8SNKkQiFDvpZCjFfc9t9g7zcFawP32ARCI8/lQrj4VIg68xERQ2msWSqpxGkQi8c9oWKNKF1MQX8hIrKdKtCBsXbwavzFIkYmF9JcOYgncySkmF/NezPH9WuqwUTTNnteSsISQW9OzggP/t20t1niPRotYwREUkIrcmsOXpVkjntMrjwewdMdP2oXWt2xw9z2KCalX20fhUP747VbfPnmflmx9Ek4g2Ozecnp0c6b3ccCoCVvTblmAllX7MjJ3SdxYzxG86wjS3FStX7kYWhUeij3Mf/vP59PDrL6dH08OvvxJNk4i7KirsCqh14szR6y4nLDyooHeH0cPmd7HuHUYRR49l+8JWGEpllrBGE2DtrVkm4DRKQgh+A3IplQEtA/p//HllgN5b//HwfZplzSgAymhl8KYv9Zujg4ObwyEIRw+D0LclGBtgYWtT/LWuPqb/4w4d3TwfHPrioUNnZiW1KuJAvLS3aP5af8bqQ6v+YQ2r9lI8F3vOjumtk4R57VXYxPl791Q69bQ9T6/nPNW4Umw3uePADqVIxWwY4rPtaFo3ggX6VT/Pa69FKsoQHKWzGUlTZPZuah0a5tcyI+78mXRqtjqcHoomuc8jnfuk+1g//VQWCnKpzPK3+Oa7WF1wPtuU7UVsNy+d+hF5YHYJGd/qFlqJskAfk6fMwkbmLk2vHBpe5jHJUfn9xXeFOrcV8l7npT2Z9Czvf/nvwDWZDNs8lmNc6a9qD86u0fMS4qW90HineJdHzFDFswE0EMpKI5HegDIBl14GhEItVZA6ogaeIbl0MlNacRXzNcvcHkaNQFO4KjGU6PnoM48gocAVai5+kHWwlQwsqrcX1tbfLrRdUwISspqUQSJAU0qT88U+EwlYD9IA7qAHBc9Wq9Y2a4KXeYBKGrlElp3AOFgFasXlCt5mNQUgq+toMgSptPUMizqHDGJBMYgnjB88AlNzWzmPJZfNCmFZqwIpgdwWCBSbll0wBWRIARzbonIkFlobbfPbmMBFrTU4yzNESc1wZmwjswcvDfEWb23pczAEzHnL0AJbAyeTN4Sc4RfK3FI6mbw1T+F6qKsrzEgFnH/et8B6vX5Q+k/2eU5V+L7O4DU6SypYv9lxL1Uo6yy2y1jI8KOVdIoGY/2MmmEno7A5Pew+ps5K1G52gYErhGbH52dx7D6B9z//Ci9QegOlXbfVmtce9QaWvSqOXJv5NmzD1IzIVdah5IjnbfExbEQKfQSvShne//wfgpe4BmW6lmJXJpPzOtMqh0usHC9JmkxS+NYjqww9DUIpA+TSQIZApeRSWikJElzLrZW5ncKx2UBN6GGtQhmLgemRb88NjsuQboJMEhZgTeTodU53FjG9ItQrJJbF2y9DwEKFCPS9rZettrExnXMeF0pruFIFo3X27bgowHXkdUvmgI/MwQU3RChxA9IjED8h4PweSzypnbOerVCt8QurtV1zAtAUzioTKIXCy0XYyU92hZ5zmJU1j5DaEMohHEknZkhJ24mdxwO1fabcG+T789bjAj0rjG7v8uJUV07XfVkCV+sfKWve1zy1ZB5GUJo3yjf35cTVjr6iV4sL9CuVY7fVPtDRs3h5JhKhVY6MXneQ4fj0/AWsnk8PRDJaj/9Hc89enH178vLihI3hQdoG7HB6MD1gkrMUKmlGmvafqvdX23aHpf7uD9tu1we8CzOnpYpQK8Zu28GkazF+66bjZ+08EaWlwHe2W27mN143DZN/qtEzGpsnYiW9YnMilioU8XcxvFo/GLfPX3cP4CfwgRfyo6b32MUwcFlJXfMvkYhb3Nx7kzfzJukBDJvW3jjOc3RhxPsACu/hydOTS5EInsH7wOk2Aqfug6U/atc+omoN4L8M7x5l2G5bUNY0w/326IMcnYP9bQ7SvGma/wFpmS9I","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":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.1/getformdata"}}');var i=s(74848),o=s(28453),r=s(57742),a=s.n(r),l=s(78178),p=s.n(l),c=s(19624),m=s.n(c),d=s(96226),g=s.n(d),h=(s(77675),s(19365),s(51107)),I=s(21312);const P={id:"getsignerips",title:"Get Signer IPs",description:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.",sidebar_label:"Get Signer IPs",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV0tvHDcS/iu1vCQetGckW3lsn6LNKooSwxYsGTrIA4HdXTNNi00yLPaMBoMGcsg/yGmv+9P8SxbFfkyPJDvrJAhykXqKrPfr41YEuSSRXot/27yu0AQS80QUSLlXLihrRCouS4RTDHChlgY9nJ0THJ+fARqZaSTY2BqCBY/BK1xhPLcLoHibYF3a9ruAUCIUnZ7pW/PWvLQBU7gsVStREVijNyBXUmkWDgvr4RJlRSBNAScmoHdeEYLT0tD0rRGJsA69ZFPPCpGKJYZWs3IkEuGklxUG9OzkVhhZoUhFb8SNKkQiFDvpZCjFfc9t9g7zcFawP32ARCI8/lQrj4VIg68xERQ2msWSqpxGkQi8c9oWKNKF1MQX8hIrKdKtCBsXbwavzFIkYmF9JcOYgncySkmF/NezPH9WuqwUTTNnteSsISQW9OzggP/t20t1niPRotYwREUkIrcmsOXpVkjntMrjwewdMdP2oXWt2xw9z2KCalX20fhUP747VbfPnmflmx9Ek4g2Ozecnp0c6b3ccCoCVvTblmAllX7MjJ3SdxYzxG86wjS3FStX7kYWhUeij3Mf/vP59PDrL6dH08OvvxJNk4i7KirsCqh14szR6y4nLDyooHeH0cPmd7HuHUYRR49l+8JWGEpllrBGE2DtrVkm4DRKQgh+A3IplQEtA/p//HllgN5b//HwfZplzSgAymhl8KYv9Zujg4ObwyEIRw+D0LclGBtgYWtT/LWuPqb/4w4d3TwfHPrioUNnZiW1KuJAvLS3aP5af8bqQ6v+YQ2r9lI8F3vOjumtk4R57VXYxPl791Q69bQ9T6/nPNW4Umw3uePADqVIxWwY4rPtaFo3ggX6VT/Pa69FKsoQHKWzGUlTZPZuah0a5tcyI+78mXRqtjqcHoomuc8jnfuk+1g//VQWCnKpzPK3+Oa7WF1wPtuU7UVsNy+d+hF5YHYJGd/qFlqJskAfk6fMwkbmLk2vHBpe5jHJUfn9xXeFOrcV8l7npT2Z9Czvf/nvwDWZDNs8lmNc6a9qD86u0fMS4qW90HineJdHzFDFswE0EMpKI5HegDIBl14GhEItVZA6ogaeIbl0MlNacRXzNcvcHkaNQFO4KjGU6PnoM48gocAVai5+kHWwlQwsqrcX1tbfLrRdUwISspqUQSJAU0qT88U+EwlYD9IA7qAHBc9Wq9Y2a4KXeYBKGrlElp3AOFgFasXlCt5mNQUgq+toMgSptPUMizqHDGJBMYgnjB88AlNzWzmPJZfNCmFZqwIpgdwWCBSbll0wBWRIARzbonIkFlobbfPbmMBFrTU4yzNESc1wZmwjswcvDfEWb23pczAEzHnL0AJbAyeTN4Sc4RfK3FI6mbw1T+F6qKsrzEgFnH/et8B6vX5Q+k/2eU5V+L7O4DU6SypYv9lxL1Uo6yy2y1jI8KOVdIoGY/2MmmEno7A5Pew+ps5K1G52gYErhGbH52dx7D6B9z//Ci9QegOlXbfVmtce9QaWvSqOXJv5NmzD1IzIVdah5IjnbfExbEQKfQSvShne//wfgpe4BmW6lmJXJpPzOtMqh0usHC9JmkxS+NYjqww9DUIpA+TSQIZApeRSWikJElzLrZW5ncKx2UBN6GGtQhmLgemRb88NjsuQboJMEhZgTeTodU53FjG9ItQrJJbF2y9DwEKFCPS9rZettrExnXMeF0pruFIFo3X27bgowHXkdUvmgI/MwQU3RChxA9IjED8h4PweSzypnbOerVCt8QurtV1zAtAUzioTKIXCy0XYyU92hZ5zmJU1j5DaEMohHEknZkhJ24mdxwO1fabcG+T789bjAj0rjG7v8uJUV07XfVkCV+sfKWve1zy1ZB5GUJo3yjf35cTVjr6iV4sL9CuVY7fVPtDRs3h5JhKhVY6MXneQ4fj0/AWsnk8PRDJaj/9Hc89enH178vLihI3hQdoG7HB6MD1gkrMUKmlGmvafqvdX23aHpf7uD9tu1we8CzOnpYpQK8Zu28GkazF+66bjZ+08EaWlwHe2W27mN143DZN/qtEzGpsnYiW9YnMilioU8XcxvFo/GLfPX3cP4CfwgRfyo6b32MUwcFlJXfMvkYhb3Nx7kzfzJukBDJvW3jjOc3RhxPsACu/hydOTS5EInsH7wOk2Aqfug6U/atc+omoN4L8M7x5l2G5bUNY0w/326IMcnYP9bQ7SvGma/wFpmS9I",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,b={},f=[];function w(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Signer IPs"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/signerips/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document."}),"\n",(0,i.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(I.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...s(54558)}),"\n",(0,i.jsx)(m(),{...s(70540)}),"\n",(0,i.jsx)(g(),{...s(52086)})]})}function S(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(w,{...e})}):w(e)}},54558(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},70540(e){e.exports={title:"Body"}},52086(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"signer_ips":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"ip_address":{"type":"string","example":"193.186.4.187"}},"xml":{"name":"signerIpsResponse"},"title":"signer_ips"}}},"xml":{"name":"signerIpsResponse"},"title":"signerIpsResponse"}}}},"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.7775a8c7.js b/assets/js/7ad5624c.f6a38190.js similarity index 56% rename from assets/js/7ad5624c.7775a8c7.js rename to assets/js/7ad5624c.f6a38190.js index a56016635..614677cc6 100644 --- a/assets/js/7ad5624c.7775a8c7.js +++ b/assets/js/7ad5624c.f6a38190.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[33],{14397(e,t,o){o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>U,default:()=>Q,frontMatter:()=>f,metadata:()=>n,toc:()=>y});const n=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+qExjFMM6nu0WoICy1hiCXoMyhKWXhFCoUpHUwH7i9pFLJzOlFacws1mW9jCogjCG6wqpQs9HX3kECQUuNSc+yIZsLYk19XBhZf39gjexBCRkTVAGQwA0lTQ5M/aBSMB6kAbQEHrnVUAI5Bm0aqFZQ55Lv5ZGlsi6Exj6qkCtOFvB26wJBMHqJiIGbvbWYwG9PQaxCNGHb3m18ghM5fHrseKsWSKUjSowJJDbAiHEgmUTTAEZBgLHWFSOgZU2Rtv8PsZv0WgNznL/UFLzojfEyOLkpQk8ilssfQh2DnPe8taFLcDR6JeAHOB3ytyHdDT6aI7gZpdW15gFRTj/uq+A1Wr1JPNfHcqcKfqxyeADOhsUWb/eS5eKqiaL1TJUsvvSajpDgzF9BrWw11HYPDwtPqZOKtRuconEGRImpxfnseW+gk+//xPeofQGKrtqkzVvPOo1lP1V7Lk28q3bdh0TFjYmXsUez9vk440aA/UevK4kffr9XwF+xhUo01UUmzIaXTSZVjlcYe14PIbRKIU3cQkC6mlAlSTIpYEMIVSSU2mpJEhwrbRW5n4Mp2YNTUAPK0VVTAamR7kDM9gvu3AHyGTAAqyJEv2d4z0iptcB9RID6+LJlyFgoYgzuvK2KdvbhmA64zwulNZwrYoSKdp2WhTgOvKqJbPDB3BwwQVBFa5BeoSAhsZw8UgknjTOWc8oVAt+YfnJxQFAUzirDIUUCi8XtNef7BM97prKmmdIrQvlzh1Jp2YXkrYSO4t31PFH7smP+vhhu/W4QM8XRrP3cXGqS6ebPi2Bs/WvpHW70rdrJa8D7VuDB8oPj/XEsY6+Du8Xl+iXKsduqH2moieReSISoVWOJuBgXTg9u3gHy9fjqUgG0/F/KO7Ju/M3b3++fMtguJG2DpuNp+NpfODYQLU0g5sGL+7HY22zX6L+7sd5N5cJH2jitFRxJ4qGbrp95kbsH9fp4Gk+T0RlAzHDZsNl94vX2y2Tf2vQ8840T8RSeiUzHt43G1GowJ+L3dP7s0Z+/aF7xb+C51/5z8LudwzDC8ZS6oa/iUTc4/rwvwrb+Tbp9wwG1jKc5jk6Gog+WVcPdr6zt1ciEdwrD/eb+7jfdB9Y+7OwDhefFgD/5i3sWYHNpt2dttsdf3v0WYnOwJ6bfTTfbrf/AUQGRoE=","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 s=o(74848),a=o(28453),i=o(57742),r=o.n(i),c=o(78178),p=o.n(c),l=o(19624),d=o.n(l),m=o(96226),g=o.n(m),b=(o(77675),o(19365),o(51107)),h=o(21312);const f={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+qExjFMM6nu0WoICy1hiCXoMyhKWXhFCoUpHUwH7i9pFLJzOlFacws1mW9jCogjCG6wqpQs9HX3kECQUuNSc+yIZsLYk19XBhZf39gjexBCRkTVAGQwA0lTQ5M/aBSMB6kAbQEHrnVUAI5Bm0aqFZQ55Lv5ZGlsi6Exj6qkCtOFvB26wJBMHqJiIGbvbWYwG9PQaxCNGHb3m18ghM5fHrseKsWSKUjSowJJDbAiHEgmUTTAEZBgLHWFSOgZU2Rtv8PsZv0WgNznL/UFLzojfEyOLkpQk8ilssfQh2DnPe8taFLcDR6JeAHOB3ytyHdDT6aI7gZpdW15gFRTj/uq+A1Wr1JPNfHcqcKfqxyeADOhsUWb/eS5eKqiaL1TJUsvvSajpDgzF9BrWw11HYPDwtPqZOKtRuconEGRImpxfnseW+gk+//xPeofQGKrtqkzVvPOo1lP1V7Lk28q3bdh0TFjYmXsUez9vk440aA/UevK4kffr9XwF+xhUo01UUmzIaXTSZVjlcYe14PIbRKIU3cQkC6mlAlSTIpYEMIVSSU2mpJEhwrbRW5n4Mp2YNTUAPK0VVTAamR7kDM9gvu3AHyGTAAqyJEv2d4z0iptcB9RID6+LJlyFgoYgzuvK2KdvbhmA64zwulNZwrYoSKdp2WhTgOvKqJbPDB3BwwQVBFa5BeoSAhsZw8UgknjTOWc8oVAt+YfnJxQFAUzirDIUUCi8XtNef7BM97prKmmdIrQvlzh1Jp2YXkrYSO4t31PFH7smP+vhhu/W4QM8XRrP3cXGqS6ebPi2Bs/WvpHW70rdrJa8D7VuDB8oPj/XEsY6+Du8Xl+iXKsduqH2moieReSISoVWOJuBgXTg9u3gHy9fjqUgG0/F/KO7Ju/M3b3++fMtguJG2DpuNp+NpfODYQLU0g5sGL+7HY22zX6L+7sd5N5cJH2jitFRxJ4qGbrp95kbsH9fp4Gk+T0RlAzHDZsNl94vX2y2Tf2vQ8840T8RSeiUzHt43G1GowJ+L3dP7s0Z+/aF7xb+C51/5z8LudwzDC8ZS6oa/iUTc4/rwvwrb+Tbp9wwG1jKc5jk6Gog+WVcPdr6zt1ciEdwrD/eb+7jfdB9Y+7OwDhefFgD/5i3sWYHNpt2dttsdf3v0WYnOwJ6bfTTfbrf/AUQGRoE=",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,v={},y=[];function x(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"}),"\n",(0,s.jsx)(r(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,s.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...o(31290)}),"\n",(0,s.jsx)(d(),{...o(34704)}),"\n",(0,s.jsx)(g(),{...o(52026)})]})}function Q(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},31290(e){e.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"objectId of contact","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},34704(e){e.exports={title:"Body"}},52026(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[33],{14397(e,t,n){n.r(t),n.d(t,{assets:()=>C,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>o,toc:()=>v});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(57742),p=n.n(i),r=n(78178),c=n.n(r),l=n(19624),d=n.n(l),m=n(96226),b=n.n(m),h=(n(77675),n(19365),n(51107)),y=n(21312);const x={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},g=void 0,C={},v=[];function Q(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"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)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(c(),{...n(31290)}),"\n",(0,a.jsx)(d(),{...n(34704)}),"\n",(0,a.jsx)(b(),{...n(52026)})]})}function j(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(Q,{...e})}):Q(e)}},31290(e){e.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"objectId of contact","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},34704(e){e.exports={title:"Body"}},52026(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.8f6972fe.js b/assets/js/7ef59f7a.8f6972fe.js deleted file mode 100644 index 5a46f5367..000000000 --- a/assets/js/7ef59f7a.8f6972fe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4865],{62634(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>w,frontMatter:()=>h,metadata:()=>a,toc:()=>f});const a=JSON.parse('{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.1/getdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocument","permalink":"/docs/API-docs/v1.1/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Wc1uGzkSfpVaXnYitCX5J8msTmPMZj2eDSbG2IGBdQSB3V2tZswmOSRbsiA0MId9gz3tdR8tT7Io9o9atmJbmUwuiUVWFeufX7HXzPO5Y5Mb9nedlAUq79g0Yim6xArjhVZswq5yhDP00JLA6cU5oOKxRAcrXYLXYNFbgQuEFD0X0gGPdemBgzOYiEwkkDbcQxYxbdBykn6esgmbo283WcQMt7xAj5bUWjPFC2QT1hLMRMoiJkgtw33O7uuq44+Y+PMUdNbpyyJm8bdSWEzZxNsSI+b8SpJYJwojkUUM74zUKbJJxqUjgiTHgrPJmvmVCZTeCjVnEcu0Lbjvr+AdD1ImzPx0GOfJUW5iVlVTOtYZrRw6EnQ0HtN/2/q6MknQuayU0DmFRSzRypPmkzXjxkiRhI3RR0dM64fa1WaT9yyJ8aI+0nnuS7evFUIdGKvnFp1jVdS5dF8x/zgTt0fHcf7+Z5KSCVrcT0LuvXGT0ahZKa0cJrogaQnZmJFbvlhoT0RPsBd+fz1d+IMynEQovb9SRiJ3CE7MVVcowWtapmifDvTXiVFda/tJqDWEwFptHLgp2MYESqSl2rLlWfI/aoQYkfjJO6EtdBK4tXxF/cBj4Z72ktW7Y7s5LUH9mCN2qoUFF/JJ6hjxh2ahzTWTa/XEMScvXx0dHn//+pDolyKdo/8D9te7+/nf452P9V3Ql8/77KosYrR99m6lYz+sIna3J8/RyUkVsdWeXK/pqOWeTMffVxHL92Q6eUW5HBr4M3z+JTXV+bzqV5THwkjucXZZ18GszYdHqUJROlTpuXpnt3tJrLVErvpH0+1I7dUi95ie+sez82h8dHxwOD4Yv746fDU5+dvk5avheDz+F4vYXSE31rOU+nS/OTS/S5N+k3NqsHKly+eZbzEVFhM/K+3Own4sdnQcl1IvZ4VO6/vlXqLsODeADmIsU+Fn3m43lD2r/Iv70ULgEndeIV8xFKGJ/7mH7LiFlsLnNRia9X0cSNuCEU9o1SME4UAruQK+4EJSbsEyRwU+x+76JpqmjiCzugAOrYRhSJLS65nFQqgnq7JNj5p6plWCM6FmuEC7s012jGPq2qhmiZb6WRdnY3bVk3HDYlliwNAEvWPJk1s2rSIWJ8mXSiwd2q3si8LS0dbalKJzL94PwskeDXbTQU92Ie9LXaDPhZrDkqK1tFrNI2iAmLcr4HMuFFC87F++HiRHa/VOELRJtP0066e7UFIonLVjx+xkPJ4ddk44eeiEbqRT2kOmS5V+W1N3nf+4QSez486glw8NOlcLLkUaRtQrfYvq29rTP97Xxz/MYlEThX22ZWx/vTbSYVJa4VdhFr474EYc1PuTmylNmJQpuhmiw/DsczZho7YURuve4FwxkmcX7WgdbrduHnJcpbG+G2qDipq05LGjOhxxI0aLwyFB0Ps83Ji96LE82JfFeT4Xav4U33TjqksKZx2xLYdtWpUR/0TqVU08+lTN20KOPAwtFf3OdGBuovTOoCJsFWIcDr//BnGNMtEF0rMIXQiDQcvy6d//67gGg+6mCNk4/KA+qHelBaOXaOk9gKsUMol3gq6X8ORShL3uzcUhLyQ6J1cglMe55R4hFXPhuQyjJLWQhBseCykoiYlME7eFXh24IVzn6HO0tPVXi8AhxYWk1Ae6pQruSVJ3sS21vc2kXroIOMSlEwqdA1Q5VwkRtoGIQFvgClB5tMYKGnC9JaVFrZpW3vLEQ8EVnyPJjqDvqxSloGwFq+PSeXBalkFjoDcmbTGF1h6FmLrgwzf0kmMRaDXRhbGYU9YsEOalSNFFkOgUoZ7ZyQSVQozOgyFdRIKOhJZK6uQ2xC8rpQSjqYMILulhqa8jsXvLlSNQWOvShqBzmLGaHnmwVnAweO+QAvxWqFs3GQw+qAO46dLqGmMnPE6/aytguVw+yPwX2zxnwv9UxvArGu2E13a14Z4Ln5dxqJa+kO5HLekMFYb06dXCRkaqE/ew+Gh1lKM0o0v0lCFudHpxHpruC/j0+3/gLXKrINfLOlmT0qJcwbw9ijxXR752W9czIdMh8XLyeFInHz3gofOtB69z7j/9/l8Hv+AShGoqikwZDC7KWIoErhqw5QaDCfwYgFgHwBz4nHtIuIIYweWcUmkhOHAwNbcU6nYIp2oFBEyAIEVIBloPfFtmbL3bOIi5wxR0jQc70LfRiNYLh3KBjmTR3RcjYCoIK/rc6nJen9ZXpjHOYiakhOt69iPbTtMUTLPcjITk8J46mFFB+BxXwC2Co1dYuLjHEnZKY7QlLUStfKZplKEAoEqNFsq7CaSWZ34jP9okesC7QqsdS7ULNxg4asR0IakrsbG4Wx1+oJ58r49vt1uLGVo6MJi9iYsRTTrdtGkJlK1/JK3D06NWnie+N2nRhfLDfTnhYkdbuHfZJdqFSNq3x89U9CgQj1jEpEhQOewBhtOzi7ewOB6OCSd3t+Mzinv09vzHN79cvgnTHVpXO+xwOB6Ow4OOdr7gqndS/5n//r223uCoP+GTQHM309PHyEguAjJq5u8a1dyw3leCSf+DwDRiuXaeSNZrKr73VlYVLf9WhhHpZhqxBbeC9AvQJxWO/k679/7PWvrdr82ngxfwmW8LOzVvoYYinLHgNEFNGIvYLa7ufc2oaJZq8AapVlOcJgka3+N9AFy30N/ZmysWRsp8G+fcBpzT/EHSd+q1DYBqBehfQmM7GdbrGkNVVUdfb32WozGwpSYnTauq+j//5iuT","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 i=n(74848),o=n(28453),r=n(57742),s=n.n(r),p=n(78178),m=n.n(p),l=n(19624),d=n.n(l),c=n(96226),u=n.n(c),x=(n(77675),n(19365),n(51107)),g=n(21312);const h={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:"eJy9Wc1uGzkSfpVaXnYitCX5J8msTmPMZj2eDSbG2IGBdQSB3V2tZswmOSRbsiA0MId9gz3tdR8tT7Io9o9atmJbmUwuiUVWFeufX7HXzPO5Y5Mb9nedlAUq79g0Yim6xArjhVZswq5yhDP00JLA6cU5oOKxRAcrXYLXYNFbgQuEFD0X0gGPdemBgzOYiEwkkDbcQxYxbdBykn6esgmbo283WcQMt7xAj5bUWjPFC2QT1hLMRMoiJkgtw33O7uuq44+Y+PMUdNbpyyJm8bdSWEzZxNsSI+b8SpJYJwojkUUM74zUKbJJxqUjgiTHgrPJmvmVCZTeCjVnEcu0Lbjvr+AdD1ImzPx0GOfJUW5iVlVTOtYZrRw6EnQ0HtN/2/q6MknQuayU0DmFRSzRypPmkzXjxkiRhI3RR0dM64fa1WaT9yyJ8aI+0nnuS7evFUIdGKvnFp1jVdS5dF8x/zgTt0fHcf7+Z5KSCVrcT0LuvXGT0ahZKa0cJrogaQnZmJFbvlhoT0RPsBd+fz1d+IMynEQovb9SRiJ3CE7MVVcowWtapmifDvTXiVFda/tJqDWEwFptHLgp2MYESqSl2rLlWfI/aoQYkfjJO6EtdBK4tXxF/cBj4Z72ktW7Y7s5LUH9mCN2qoUFF/JJ6hjxh2ahzTWTa/XEMScvXx0dHn//+pDolyKdo/8D9te7+/nf452P9V3Ql8/77KosYrR99m6lYz+sIna3J8/RyUkVsdWeXK/pqOWeTMffVxHL92Q6eUW5HBr4M3z+JTXV+bzqV5THwkjucXZZ18GszYdHqUJROlTpuXpnt3tJrLVErvpH0+1I7dUi95ie+sez82h8dHxwOD4Yv746fDU5+dvk5avheDz+F4vYXSE31rOU+nS/OTS/S5N+k3NqsHKly+eZbzEVFhM/K+3Own4sdnQcl1IvZ4VO6/vlXqLsODeADmIsU+Fn3m43lD2r/Iv70ULgEndeIV8xFKGJ/7mH7LiFlsLnNRia9X0cSNuCEU9o1SME4UAruQK+4EJSbsEyRwU+x+76JpqmjiCzugAOrYRhSJLS65nFQqgnq7JNj5p6plWCM6FmuEC7s012jGPq2qhmiZb6WRdnY3bVk3HDYlliwNAEvWPJk1s2rSIWJ8mXSiwd2q3si8LS0dbalKJzL94PwskeDXbTQU92Ie9LXaDPhZrDkqK1tFrNI2iAmLcr4HMuFFC87F++HiRHa/VOELRJtP0066e7UFIonLVjx+xkPJ4ddk44eeiEbqRT2kOmS5V+W1N3nf+4QSez486glw8NOlcLLkUaRtQrfYvq29rTP97Xxz/MYlEThX22ZWx/vTbSYVJa4VdhFr474EYc1PuTmylNmJQpuhmiw/DsczZho7YURuve4FwxkmcX7WgdbrduHnJcpbG+G2qDipq05LGjOhxxI0aLwyFB0Ps83Ji96LE82JfFeT4Xav4U33TjqksKZx2xLYdtWpUR/0TqVU08+lTN20KOPAwtFf3OdGBuovTOoCJsFWIcDr//BnGNMtEF0rMIXQiDQcvy6d//67gGg+6mCNk4/KA+qHelBaOXaOk9gKsUMol3gq6X8ORShL3uzcUhLyQ6J1cglMe55R4hFXPhuQyjJLWQhBseCykoiYlME7eFXh24IVzn6HO0tPVXi8AhxYWk1Ae6pQruSVJ3sS21vc2kXroIOMSlEwqdA1Q5VwkRtoGIQFvgClB5tMYKGnC9JaVFrZpW3vLEQ8EVnyPJjqDvqxSloGwFq+PSeXBalkFjoDcmbTGF1h6FmLrgwzf0kmMRaDXRhbGYU9YsEOalSNFFkOgUoZ7ZyQSVQozOgyFdRIKOhJZK6uQ2xC8rpQSjqYMILulhqa8jsXvLlSNQWOvShqBzmLGaHnmwVnAweO+QAvxWqFs3GQw+qAO46dLqGmMnPE6/aytguVw+yPwX2zxnwv9UxvArGu2E13a14Z4Ln5dxqJa+kO5HLekMFYb06dXCRkaqE/ew+Gh1lKM0o0v0lCFudHpxHpruC/j0+3/gLXKrINfLOlmT0qJcwbw9ijxXR752W9czIdMh8XLyeFInHz3gofOtB69z7j/9/l8Hv+AShGoqikwZDC7KWIoErhqw5QaDCfwYgFgHwBz4nHtIuIIYweWcUmkhOHAwNbcU6nYIp2oFBEyAIEVIBloPfFtmbL3bOIi5wxR0jQc70LfRiNYLh3KBjmTR3RcjYCoIK/rc6nJen9ZXpjHOYiakhOt69iPbTtMUTLPcjITk8J46mFFB+BxXwC2Co1dYuLjHEnZKY7QlLUStfKZplKEAoEqNFsq7CaSWZ34jP9okesC7QqsdS7ULNxg4asR0IakrsbG4Wx1+oJ58r49vt1uLGVo6MJi9iYsRTTrdtGkJlK1/JK3D06NWnie+N2nRhfLDfTnhYkdbuHfZJdqFSNq3x89U9CgQj1jEpEhQOewBhtOzi7ewOB6OCSd3t+Mzinv09vzHN79cvgnTHVpXO+xwOB6Ow4OOdr7gqndS/5n//r223uCoP+GTQHM309PHyEguAjJq5u8a1dyw3leCSf+DwDRiuXaeSNZrKr73VlYVLf9WhhHpZhqxBbeC9AvQJxWO/k679/7PWvrdr82ngxfwmW8LOzVvoYYinLHgNEFNGIvYLa7ufc2oaJZq8AapVlOcJgka3+N9AFy30N/ZmysWRsp8G+fcBpzT/EHSd+q1DYBqBehfQmM7GdbrGkNVVUdfb32WozGwpSYnTauq+j//5iuT",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={},f=[];function J(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,i.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(m(),{...n(42959)}),"\n",(0,i.jsx)(d(),{...n(58309)}),"\n",(0,i.jsx)(u(),{...n(85547)})]})}function w(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(J,{...e})}):J(e)}},42959(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},58309(e){e.exports={title:"Body"}},85547(e){e.exports=JSON.parse('{"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":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"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":false},"remind_once_in_every":{"type":"number","example":0},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]}},"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.d44ee1ec.js b/assets/js/7ef59f7a.d44ee1ec.js new file mode 100644 index 000000000..1a5047b86 --- /dev/null +++ b/assets/js/7ef59f7a.d44ee1ec.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4865],{62634(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>L,frontMatter:()=>x,metadata:()=>i,toc:()=>T});const i=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":"eJy9Wc1uGzkSfpVaXnYitCX5J8msTmPMZj2eDSbG2IGBdQSB3V2tZswmOSRbsiA0MId9gz3tdR8tT7Io9o9atmJbmUwuiUVWFeufX7HXzPO5Y5Mb9nedlAUq79g0Yim6xArjhVZswq5yhDP00JLA6cU5oOKxRAcrXYLXYNFbgQuEFD0X0gGPdemBgzOYiEwkkDbcQxYxbdBykn6esgmbo283WcQMt7xAj5bUWjPFC2QT1hLMRMoiJkgtw33O7uuq44+Y+PMUdNbpyyJm8bdSWEzZxNsSI+b8SpJYJwojkUUM74zUKbJJxqUjgiTHgrPJmvmVCZTeCjVnEcu0Lbjvr+AdD1ImzPx0GOfJUW5iVlVTOtYZrRw6EnQ0HtN/2/q6MknQuayU0DmFRSzRypPmkzXjxkiRhI3RR0dM64fa1WaT9yyJ8aI+0nnuS7evFUIdGKvnFp1jVdS5dF8x/zgTt0fHcf7+Z5KSCVrcT0LuvXGT0ahZKa0cJrogaQnZmJFbvlhoT0RPsBd+fz1d+IMynEQovb9SRiJ3CE7MVVcowWtapmifDvTXiVFda/tJqDWEwFptHLgp2MYESqSl2rLlWfI/aoQYkfjJO6EtdBK4tXxF/cBj4Z72ktW7Y7s5LUH9mCN2qoUFF/JJ6hjxh2ahzTWTa/XEMScvXx0dHn//+pDolyKdo/8D9te7+/nf452P9V3Ql8/77KosYrR99m6lYz+sIna3J8/RyUkVsdWeXK/pqOWeTMffVxHL92Q6eUW5HBr4M3z+JTXV+bzqV5THwkjucXZZ18GszYdHqUJROlTpuXpnt3tJrLVErvpH0+1I7dUi95ie+sez82h8dHxwOD4Yv746fDU5+dvk5avheDz+F4vYXSE31rOU+nS/OTS/S5N+k3NqsHKly+eZbzEVFhM/K+3Own4sdnQcl1IvZ4VO6/vlXqLsODeADmIsU+Fn3m43lD2r/Iv70ULgEndeIV8xFKGJ/7mH7LiFlsLnNRia9X0cSNuCEU9o1SME4UAruQK+4EJSbsEyRwU+x+76JpqmjiCzugAOrYRhSJLS65nFQqgnq7JNj5p6plWCM6FmuEC7s012jGPq2qhmiZb6WRdnY3bVk3HDYlliwNAEvWPJk1s2rSIWJ8mXSiwd2q3si8LS0dbalKJzL94PwskeDXbTQU92Ie9LXaDPhZrDkqK1tFrNI2iAmLcr4HMuFFC87F++HiRHa/VOELRJtP0066e7UFIonLVjx+xkPJ4ddk44eeiEbqRT2kOmS5V+W1N3nf+4QSez486glw8NOlcLLkUaRtQrfYvq29rTP97Xxz/MYlEThX22ZWx/vTbSYVJa4VdhFr474EYc1PuTmylNmJQpuhmiw/DsczZho7YURuve4FwxkmcX7WgdbrduHnJcpbG+G2qDipq05LGjOhxxI0aLwyFB0Ps83Ji96LE82JfFeT4Xav4U33TjqksKZx2xLYdtWpUR/0TqVU08+lTN20KOPAwtFf3OdGBuovTOoCJsFWIcDr//BnGNMtEF0rMIXQiDQcvy6d//67gGg+6mCNk4/KA+qHelBaOXaOk9gKsUMol3gq6X8ORShL3uzcUhLyQ6J1cglMe55R4hFXPhuQyjJLWQhBseCykoiYlME7eFXh24IVzn6HO0tPVXi8AhxQVKyn2ga6rgnkR1N9tS29tM6qWLgENcOqHQOUCVc5UQYRuJCLQFrgCVR2usoAnXW9Ja1Lpp5S1PPBRc8TmS7Aj6zkpRCkpXsDounQenZRlUBnpk0hZTaA1SiKkLTnxDTzkWgVYTXRiLOaXNAmFeihRdBIlOEeqhnUxQKcToPBjSRSToSGippE5uQwCzUkowmlqI4JJelvo6Eru3XDlChbUubQw6hxmr6ZUHawUHg/cOKcJvhbp1k8HggzqAmy6vrjF2wuP0u7YElsvlg9R/sc1zJvxPZQy/otFOeG1XG+658HkZh3LpC+l+1JLOUGHIn14xbGSkOnEPq49WRzlKM7pETxniRqcX56HrvoBPv/8H3iK3CnK9rLM1KS3KFczbo8hzdeRrt3VNEzIdEi8njyd18tELHjrfevA65/7T7/918AsuQaimpMiUweCijKVI4KpBW24wmMCPAYl1CMyBz7mHhCuIEVzOKZUWggMHU3NLoW6HcKpWQMgECFOEZKD1wLdlxtbDjYOYO0xB14CwQ30bjWi9cCgX6EgWXX4xAqaCwKLPrS7n9Wl9ZRrjLGZCSriuhz+y7TRNwTTLzUxIDu+pgxkVhM9xBdwiOHqGhYt7LGGnNEZb0kLUymeaZhkKAKrUaKG8m0BqeeY38qNNogfAK7TasVS7cAOCo0ZMF5K6EhuLu9XhB2rK9xr5dr+1mKGlA4PZm7gY0aTTTZuWQNn6R9I6vD1q5Xnie6MW3Sg/3JcTbna0hXuXXaJdiKR9fPxMRY8C8YhFTIoElcMeYjg9u3gLi+PhmIBydz0+o7hHb89/fPPL5Zsw3qF1tcMOh+PhOLzoaOcLrnon9d/5719s6w2Q+hO+CTSXM719jIzkIkCjZgCvYc0N630mmPS/CEwjlmvniWS9puJ7b2VV0fJvZZiRbqYRW3ArSL+AfVLh6O+0e/D/rKXf/dp8O3gBn/m4sFPzFmsoAhoLTiPUhLGI3eLq3ueMioapBnCQajXFaZKg8T3eB8h1C/6dvbliYabMt4HObQA6zR8kfade2wioVoD+JTi2k2G9rkFUVXX09dZnORoDW2py0rSqqv8DffIr+A==","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),r=n(28453),o=n(57742),s=n.n(o),p=n(78178),m=n.n(p),l=n(19624),d=n.n(l),c=n(96226),u=n.n(c),g=(n(77675),n(19365),n(51107)),h=n(21312);const x={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:"eJy9Wc1uGzkSfpVaXnYitCX5J8msTmPMZj2eDSbG2IGBdQSB3V2tZswmOSRbsiA0MId9gz3tdR8tT7Io9o9atmJbmUwuiUVWFeufX7HXzPO5Y5Mb9nedlAUq79g0Yim6xArjhVZswq5yhDP00JLA6cU5oOKxRAcrXYLXYNFbgQuEFD0X0gGPdemBgzOYiEwkkDbcQxYxbdBykn6esgmbo283WcQMt7xAj5bUWjPFC2QT1hLMRMoiJkgtw33O7uuq44+Y+PMUdNbpyyJm8bdSWEzZxNsSI+b8SpJYJwojkUUM74zUKbJJxqUjgiTHgrPJmvmVCZTeCjVnEcu0Lbjvr+AdD1ImzPx0GOfJUW5iVlVTOtYZrRw6EnQ0HtN/2/q6MknQuayU0DmFRSzRypPmkzXjxkiRhI3RR0dM64fa1WaT9yyJ8aI+0nnuS7evFUIdGKvnFp1jVdS5dF8x/zgTt0fHcf7+Z5KSCVrcT0LuvXGT0ahZKa0cJrogaQnZmJFbvlhoT0RPsBd+fz1d+IMynEQovb9SRiJ3CE7MVVcowWtapmifDvTXiVFda/tJqDWEwFptHLgp2MYESqSl2rLlWfI/aoQYkfjJO6EtdBK4tXxF/cBj4Z72ktW7Y7s5LUH9mCN2qoUFF/JJ6hjxh2ahzTWTa/XEMScvXx0dHn//+pDolyKdo/8D9te7+/nf452P9V3Ql8/77KosYrR99m6lYz+sIna3J8/RyUkVsdWeXK/pqOWeTMffVxHL92Q6eUW5HBr4M3z+JTXV+bzqV5THwkjucXZZ18GszYdHqUJROlTpuXpnt3tJrLVErvpH0+1I7dUi95ie+sez82h8dHxwOD4Yv746fDU5+dvk5avheDz+F4vYXSE31rOU+nS/OTS/S5N+k3NqsHKly+eZbzEVFhM/K+3Own4sdnQcl1IvZ4VO6/vlXqLsODeADmIsU+Fn3m43lD2r/Iv70ULgEndeIV8xFKGJ/7mH7LiFlsLnNRia9X0cSNuCEU9o1SME4UAruQK+4EJSbsEyRwU+x+76JpqmjiCzugAOrYRhSJLS65nFQqgnq7JNj5p6plWCM6FmuEC7s012jGPq2qhmiZb6WRdnY3bVk3HDYlliwNAEvWPJk1s2rSIWJ8mXSiwd2q3si8LS0dbalKJzL94PwskeDXbTQU92Ie9LXaDPhZrDkqK1tFrNI2iAmLcr4HMuFFC87F++HiRHa/VOELRJtP0066e7UFIonLVjx+xkPJ4ddk44eeiEbqRT2kOmS5V+W1N3nf+4QSez486glw8NOlcLLkUaRtQrfYvq29rTP97Xxz/MYlEThX22ZWx/vTbSYVJa4VdhFr474EYc1PuTmylNmJQpuhmiw/DsczZho7YURuve4FwxkmcX7WgdbrduHnJcpbG+G2qDipq05LGjOhxxI0aLwyFB0Ps83Ji96LE82JfFeT4Xav4U33TjqksKZx2xLYdtWpUR/0TqVU08+lTN20KOPAwtFf3OdGBuovTOoCJsFWIcDr//BnGNMtEF0rMIXQiDQcvy6d//67gGg+6mCNk4/KA+qHelBaOXaOk9gKsUMol3gq6X8ORShL3uzcUhLyQ6J1cglMe55R4hFXPhuQyjJLWQhBseCykoiYlME7eFXh24IVzn6HO0tPVXi8AhxQVKyn2ga6rgnkR1N9tS29tM6qWLgENcOqHQOUCVc5UQYRuJCLQFrgCVR2usoAnXW9Ja1Lpp5S1PPBRc8TmS7Aj6zkpRCkpXsDounQenZRlUBnpk0hZTaA1SiKkLTnxDTzkWgVYTXRiLOaXNAmFeihRdBIlOEeqhnUxQKcToPBjSRSToSGippE5uQwCzUkowmlqI4JJelvo6Eru3XDlChbUubQw6hxmr6ZUHawUHg/cOKcJvhbp1k8HggzqAmy6vrjF2wuP0u7YElsvlg9R/sc1zJvxPZQy/otFOeG1XG+658HkZh3LpC+l+1JLOUGHIn14xbGSkOnEPq49WRzlKM7pETxniRqcX56HrvoBPv/8H3iK3CnK9rLM1KS3KFczbo8hzdeRrt3VNEzIdEi8njyd18tELHjrfevA65/7T7/918AsuQaimpMiUweCijKVI4KpBW24wmMCPAYl1CMyBz7mHhCuIEVzOKZUWggMHU3NLoW6HcKpWQMgECFOEZKD1wLdlxtbDjYOYO0xB14CwQ30bjWi9cCgX6EgWXX4xAqaCwKLPrS7n9Wl9ZRrjLGZCSriuhz+y7TRNwTTLzUxIDu+pgxkVhM9xBdwiOHqGhYt7LGGnNEZb0kLUymeaZhkKAKrUaKG8m0BqeeY38qNNogfAK7TasVS7cAOCo0ZMF5K6EhuLu9XhB2rK9xr5dr+1mKGlA4PZm7gY0aTTTZuWQNn6R9I6vD1q5Xnie6MW3Sg/3JcTbna0hXuXXaJdiKR9fPxMRY8C8YhFTIoElcMeYjg9u3gLi+PhmIBydz0+o7hHb89/fPPL5Zsw3qF1tcMOh+PhOLzoaOcLrnon9d/5719s6w2Q+hO+CTSXM719jIzkIkCjZgCvYc0N630mmPS/CEwjlmvniWS9puJ7b2VV0fJvZZiRbqYRW3ArSL+AfVLh6O+0e/D/rKXf/dp8O3gBn/m4sFPzFmsoAhoLTiPUhLGI3eLq3ueMioapBnCQajXFaZKg8T3eB8h1C/6dvbliYabMt4HObQA6zR8kfade2wioVoD+JTi2k2G9rkFUVXX09dZnORoDW2py0rSqqv8DffIr+A==",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={},T=[];function J(e){const t={p:"p",...(0,r.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)(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)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(m(),{...n(42959)}),"\n",(0,a.jsx)(d(),{...n(58309)}),"\n",(0,a.jsx)(u(),{...n(85547)})]})}function L(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(J,{...e})}):J(e)}},42959(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},58309(e){e.exports={title:"Body"}},85547(e){e.exports=JSON.parse('{"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":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"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":false},"remind_once_in_every":{"type":"number","example":0},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]}},"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.9cbda560.js b/assets/js/851f8f65.e97dbd53.js similarity index 71% rename from assets/js/851f8f65.9cbda560.js rename to assets/js/851f8f65.e97dbd53.js index 18f32d4cf..a565b13e4 100644 --- a/assets/js/851f8f65.9cbda560.js +++ b/assets/js/851f8f65.e97dbd53.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9070],{11184(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>x,metadata:()=>s,toc:()=>j});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":"eJztPdlyHDeSv4Kt2AhJPdXVh0hJ5moUQ0saWzseiSFR6/CSmh50FbobYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6oOHaA/tbT9YbBSORCIzkcgDuAwMnerg4CR4JeMiY8Lo4FMYJEzHiueGSxEcBMczRl4pOjHEVyKHR28ITVM516TQTGliJJkywRQ1jAg2J4nvjowXJFfynCdcTElCDSVzbmaEkjHV7MkeYSKWCUvIhKcsOhWn4pjnB+RjnkqakIUsFDl69ceyPxgIyk46nVdsXEzJxzedzqeHM2NyfdDr0TyPZM6E5lOR0rGOYpn1EqiYJ5NHIZnPmGLQK4mpIIxqni4ITRIy58mUGR0SM2OCxDJfkFhKlXBBDdMhyemUEVFkY6Z0SKhISCYVI1wQShSjyaJrZLfQjPznh3dvyUSqjJqIHKWFDsvhEq5YbNKF7d7MWDmrB9pjQxvFxTQkGT0DfHFDfix4fAbT1kwk8C80PDx6g7jqdD4UeS6VYQn53k7hoNOBL1+zVM4JVQzrxzLLpCA5VTRjBhdsRg1+VuzHgiuWuGVJU4+Lg1PRJZ2OoBk76HTIR8F/LBjhCROGTzhTMEtiZly7BpGtbxY51n8jEh4D8hAAKCVy0qwKSIWqH3IWQ5e2ag3VRAoyn/F4hjicU7v+eUpjOy3FdM5iw89Zs+OLkCyg41dMSA/BTCr+NykMTXH5zpkyPKZpfZkBQKiqDVUG0J9LLowvdSOQH9xywmrjIjo6BNASQG7GBX7RjJzTtGDaQTUPyQyges9yxTQyh+sXEC8SMmN8Ots4Hk0+F9o0OiaFBjDrULix/KoiehmibUJTzQifNHCZ0TNWG41IZHqaRuTrBUnYhBapCQkHCjWqYBF5Kw2heZ7ymI5ThjQAzEZNoVgXV9mRT9QknyOUAUwTShI+mTAFzAwfsQvXxkMHdFkJDeQ0M6OCSNFa6FimUq2SEBY38UhiKQwTJiKH55SnCLydrCZcxGmRMDJOaXwWknFasJAollhGXzAQdKHlD6xCqHY4R/wQzVKgQikAfiHd8FwT7aBKInIMjFLyH3z0qMZBuK5j1XH5RMLIgALPkoRllKchIi4kn+WYGG5SFgKD51QsQpCwLCSGXZixvAhJPGPxGf6laMIlGRfGSGEnliiZJ3IuHC4nUhjN/7aGI/2Xm2N0GJK9kDwJybOQDPohGQxDMtgLyeBJSAbPQjLsh2Q4DMlwLyTDJxas4bPQbxEewXUABkOLZfPrwu6MJ2wEDUcwtxHVhimuz0Bck+9hz2ECgEtCKy7ZhQHhh9KITwVLqh2QazLjScIEmSiZEcVinnOUJlYalF2HAA9RMCmhyaRI0wU555rXcFB2KucC8IYjckXe5Ux84FNBaBzLAtYYMWyRiuisllykCwD1mNFM48xfC8NUrrhmIKqFLjEgTEVbdgOEsroAuM5KiqYE2ryam1antjKwg37HNcpc2Pp0uZvOG7vpICKdTinnoOyvf/3rqbg8FYScBiD2ToMDchqUVU6D0H6D3Qy+DdzvC/jxePjU/VzAzyfDZ+7nHKsO9tzPGfwc+qaOuU6DAxwXK3Bh7MhOvpIaBFBpeSqWDthTMcRZGJrlW2YAn39e6EkJvt+loBC2l9B/AA5chWfDjG2Nldk+htlywQ2nqd48YV/jHs25BdL6aVeVVma+BzNHWbZ52vj5Hs25Dg98wT3UfsI9t/bJ7wYIxXALitp9bpLB0Aq1oxVM7kdOhdmMSDuFe4PHGjh3hcZWlzfH4hPAImynx7CdbkZluePeI3y2YborpK7r9+aYfRqhEozayWa8ugr3CKtNiO4Kp6u93hyjzwCjoOZtRid8vUe4rIEDH5zObL/197qD/e6wP9xr4BOsE7ZClnWTpLtYLL5sLTIuRhYOaFSrn9GL9R/AaAKqY7kS5RfQYLiYls2aX1dX3dZrLSQonA4ToHP646dVesFIhbrzqm0Bj/5VLXfgwb/9efzPcAof+wMqS5zWXB1HSvNP/QhtZEIXD7TtyjctT15Qv60bWzDxE8CBprB4JnnsgIc6/rw1BmtPBDjo4qL2kqRXW1QoTJJulnVbhfCzizRQK8yyKEmiVs0VQrGFGUmSkKwWry1PEpJl2YZiW94o7mXZ6iyiLHOwOex52ltZ54wLnhVwQgKrmj2gQ0U4ZDj0Zm4tuSCdzg8//PBD989/7r561en4NXRDOCquGTLsCPTijkaoE32nc0DeTEi9CI0J1oyDUqA8GDqjqq0wk3Phz0N4alQkKcCe6KtaY1JGF9gZ42bGVHMcqSqShdMjHLbG0swi8hEPl/C3P4SVhyU8SH0FgtOdjDfLTlfhlxKflZRsDrxVtG4WTQ3ZuqIWecGUr9ebFJsWKVXsAqx/mkuxIhNvswfebH9riUVPy5WlBe2KzrLLvKGDPHznzuCPSvNiay7Q2yGJC23QJDFlFySnxjAlsLNzmvKEIn90sYBd0CwH00rvL6enye/+vYeGXbCdGmtRSPiUgz2+95eTw+5/f1pTo8hzpmKqGUkZjKRDwkwckZMZS/PKJTCfz6P5Yx3PpEytP+CzVmxi/z+S488jBDePqM4frZupJYaaIRWIpW1HReasYYxq4luuMaXi0iDXDPqowTlLxRYVztW4R3pHCyT4aK3S8PkEtn5UboF4WfW3BJlzGnyqtns0nrLkirafrsGewA0pHbN09dPNWSulC1k4jvbOguZUHUXX8OZUodIejNPph7WP9KL10X5bruFTi5A6m/rd3rOnXwGScl1uJA101ls7lwE6fgRj6EsaM+IbgKPOS4Ev5YISsOuxgbeP4tpdMQTUI1ixdNf40a4YobEwKzu50xW832lS9upR5jfyOr6gJfg/KzVhywhOV9g8Ajh5Ng9wKgZohfTWyy3nE1fjHsmKFkjb2fg2UqSxM99mS70VA/pp1RlwzfYKVe3GWjKf3sx9EXlnTeq+EZjb45jloGl9MWuWIF97h0KrsbWgf40W9M2UV7ez3yPqWwPWz0yBrt5d7z63ItL67H9FhNoA+9rEao3+GZ1usd/g53tEnnV41ps4XI0VY9UALf12R9liocbv2yc86DcmvN+c8JP+LU5cjWG//MDV34KflaHgbF2kdGU7SFjMM5piBAnCPfwCHr3N4csBBjzwUmZ5YepMh2YdFCxeS/BxEdaz+7uQdEPSCUkvJA9D8igi7xlGUsRl1IVTGriysRVckEQW4CaNC5UuyFjBxEPComlELi9/LKgw3CyWS9Ihl5cQvbVcRsCFZ0LObeDFCbiMDYHAqepQlchYrwm0krHuwemr95bNuz5YrOdAe0QeypZI2HoUdSj4ZU9kFqoakcAob0uVzZ5KMdKH6zylC0In4Ka20SDYzAYNRYDiAzIkv39BBsOo3w9J3/5NHvoJDh8hD6OPKWbpNiclfr6Kg/t1Dq5+rhNZ+/1rsXB92FtyMHQxwhgCHPdKha1i7ntoOqkm0zbW1rR6wJndP/VMFmkCu6diplCClfF7pU7f6RwpNuFpWgvfI77I8zSEQ7GUZS5kzAXuwXEGQxW4MBL4xsdydDpjNpEQpgDxg2gYpFWAnx3bbt2NEJBYMWqkIjOqrZ0FMQ0QQ4CkmbGsFTDhwauCJrjwsAMpD+7OIjj8qkncT/YbxL3f3J82EvcmCt5iKIQmOpdCl/5AVn2qUR326ctXjxZtSvKdwnJjvEwV9oNCDAkn5WesLmu40F5Lc1C2w+BezqTUVQ0Xiebkrj5oRrhJBUFuj6IyNORL3V6Dp48bSsSzX9Dt1Vyl/l5vsN/b6vdquUhuflgk5DpLilb1ay0p1qzWdOcU+hKn0JdzxOO7NMwOng4b54nH2zbne2KYrXPUFSbZuzC83upsu84CWufDa9o+fzEb5JeT5V5ljRnfmTWmJbifDv4F1pgvJdEVo8udESW5K4vLOsq8hsllq53liym3DuzPTr37d2OeaZ11vmpog18N69S6v/9l1No2ztRI7jTg//X1u/fz/p++mcrDw8PDtx8+zl5/nB4eHmbwO4qitSa7dWSAw4D+7PKA3BaP6sKGUaIoQnc9NfQAm/dyMf0P2z7c3CY6FUEYyBxytbgUb5LgIEggu8sfBIIQ8cK0+Vomi+DgMnCB/vCnC7yGlr3PGtLDLgMdz1hG4S+PT0gog3yuIAwwxg1yymCBg4NAjj+zGMbIFcBgONPQEmsfXPpaNg0qCJ3OFhwEdl5BGDjPcVlUJpDlySRY+gG3dVWWVF1p/KM8C0E/kDl0y27eQtNlK43uVj29qvWAc8vYsQTDUcoMe0UXutavPYIG7ew9aAOsH7tWJKELDSKk0HYfjGkaFynolewi52pRRj6hclmjihLecqQS3sH+MgxsyEkdJKoUXQRhwA3L6uUbiEDJm69czCRgBkN9b9r2s2Rjxv7gCsCEhQtPsxtD8VkyMma46PlMihu3HwwfD4aDx4Mh9ODCGG/ahzfHQRef5Xh0K0ZI2Dm0d0f72y+l/bo6dpM2DyFngyVePetW2QuhDeuPrmITXx8xT6fsan443pRiWMtscoYbmueMqggz/W6ddNpksXK7j65gqGUYXFw9mQsSy67PXyQPUzYxNi6GxFIJph7V4xzvzeSGe3vLMFhcPb3Fr3J6T2Hx5lfP7ntM/KySYv8VsD5+tgyD2dWwflumpv4Lgd17sqw2+ADtlczvT6OxTBYjL7eWV1X0exXUm8g0YQoUoVV5VYkakDCQgj1qbzVjKVNGxRpB08hkc+nyoI2Dd8LZdOYzhv6eUknH3qsTgPNlWGhdWGkjVI9rUJ5VwU6DCKJGq/ME6vftZDpfF5PphCQPcLyRLlCMP+i534CjB/V0cTA4VwHOHgSsTAzL8hTzp+dgtR6jeTuJSPkfapwlJgEAv2P7ga/eKl7a0EIc0DVqJh8Tp7RG5CUVZQJqMzWQXF6WZIDUsVySy0tYVaZGsO8vl2FVAGM1CnBrtyWKxYyfN1qVRaxqWJbVmlotC8NtbYHb7+sAuJDcQrl+QBldLqMGQbYAR7u9wwFLSjqDJM7VWZcqE670tbG/gmxHAdDJ/xu8P89ffMvXgPK8l794nr/4Hq4ayJnlPYueCReJ5fw5S9OIPNdGSTF90ULB854rX7+Uip1zNkfGxVWtemnjtuwocjD9AIK6WjyuSayKmNMUY2qVjJl3D6EvC4702rBcg9OUGxshjtngeCSgU8XQGYWw0MLg1Qp4JvQDPqdkptjk9w9aOH3wArOKwZn8vEdfuNpvrJFiRs8ZoWJBcOJoUZHKmusmhUIxGadU8Yk7gIYkTxnE/8L5lMbW3Wsx6uE4nlFxpsPnY/UC8pPLvOaf/vFPqOFl+hvxTiVMXUOoQ1y+Na88ADn2ILSxyEjuXGnj4+5REjoKKePx17GOS+MEp/TrUvTrYqyhlvD9VaLVKD6dMnDnuRrY2GXMMxrP7KaBUFW+6RyIRxbagwcE5g+EiQsYKHME6jagGnZqOQh27tE6qY5Z7O+Oj66BSzRQdS2juMxynKXtg7w7PoJbOsrlhhSEEhMetbRRhYAlgJxz6jP5S81+YeM3mfXLOLlYd39G7n6MLlkFKOF6LUSh3dRBwpW34Kx0XF37AkskCwPuVO5S2pHLGnhEKEpEHsviOlR5BSYpmRaYqWSAff2uiRHz1S0bXGijChu76tNG6lkmKCa0rvDksQKVav2HhAltm1MyQbd6SArBAfOqAJtl2SW7yJniEL6yFgWKWdSB6Lh6i2peWfHx/Xfusp9aMoznId8xS0iRI9UgJ5RXqfiVa099rT7oxPfVAILuhkE5zvCaM6WlABEn1ZQKJ0HteRSsq2M2o6mt6kQFuPQwmwfode3Z/6d//LMG10ajyCpgdgSaJBBgcQWEaKi2BA8hy4rlIAFlEyLoj6k/tI8AAB0yzSiTSclI+vo0foQZILqUiy48oQyP0EU8g22rlLc6LFPlnVFBo026vGJD5jBfdsG1qV0f4bP6VuXDe5fsVcGAh1DgaqB5sagzeBW2IVvd4fGANy+SKQ9BK7xACyNHimVcXG+fqvsAjCwFQWFkRg2Pie9KR83rgaxr2vN1VgUrATWec6kebWBV6G4kRcxGXIzYOVPXON7X4qrAJjlmZs6YqMPmkWS3s+rSjzncmNLASStDrgElGCczpqZsFIOFCqmOXQOJnQ501emQrgXEyVRdKOetcVdrofAAOVL1DuA4XbhMEK023PqNZhH5Vs4BYaU6A0qn7R/wSRBydy9MfYSYCszOA50HTmrQcRkDAHe+VEPYuB1cLJyNU7hi68aBXuAqKBgn3DYnLz/LzFcK1zn50f1FNTA5MOcTmkrkJ6dWtu6xQaDe4E0+M9x/cP3A62TH8ddr4c00P/39fzUoMS7aUZdH3bVf8bRKUy1tmmK9V0/OnuCj5tnU07OQhk8WIylGlRxZSzDNllsJaE2oVVOVEU4K4+BeowFKB+oARNtdDP7RTWHSXt/NgwFC7mhA8HIckPdsSlWSlruGXUaDl9jROiHZoTZRAx4lNpAdNYbGM4aX/yQsh2vwpCAPKmNMzVIB6wmmYCZG6JS8jgnbbYvL2mqeBOC7RE9YEoTWSRx8WobBOI5v2yPsmA1fQ4hFw0bZyuWL4zgmD8cpB/RQNZb2csJHB04ZpgnwISo6Lb24sagW+ShOGhoOrx0DPOpsAN86E38TMn8vnU939Run1bnxfsVsDAkDGIyIJwnUsLw5a8Vn8LM5HbZ5EFwg3c5/8CsysA/6/d+y/+Bx/9fjP9jr/4r8B88AWBcHcrU02XSqWys7fEzH9gafJbMO3lSq7TVh30HXhI1GWofgih2GS/tf5fLwQrxe1gjysHZfbFMFbTgbjp8LYmHY78M/zdV81dAt4ERfxHBCxjsG/y0Irx8xsn0JSmj5WufMNrk++8yHf7uIz4dHgMcNFoStHThCLFQKd/vC9tUt9R88ydZwy0XKBRshikeJjEeK6dGw3x8NArswe+vQ+EFmzCq/c0DmHGy25SnAqAWhU1DjgcbVHWKVKXUV+d0MsjWY8DQ02msgYX8VCW8EptLjldLH8oyJX3am9eGNHR5AvcjSSgYE3FbC70FjsvVyO0nN4kJxswgOTi6Diy7Nedd+Pzj5tPwEB1EzkxB0lUuNEFMzCw6CXjsGSzN1jtE0J5eWfEuK1FQkEGq6Ih5pznvng2gQLMN2m7XidEt9VnRv2kQbOuVielW7TxWKPsAy2pVqIKrS/3L+JwYKoFuHeq0w4EA+M0bBIgKYB+p4X0WuvfZr7KPL1gWMVWvZDgHzEWCNoK72trYmTGt9lNZgvxYfdeJDnTB6qQxeWhePVE7dRxiVAUa1mKFayFAVBdQIAsK4nlpYz0nFEmUEjVeAB6g5Dvf2UMV6OkBd5PEz3Ob3niyRiCuXeRA03eIYRtl27n6Zr7Lpqtz5335D/reW+80RT+VDclaVujPEFTWdA54KS2N8wyLeNohvNE5vsE27IVs22BKQdabP/bUWR9dkvXXJfaybLtabIZwV4voWhdqRfo0E8Fpsk/8hxBr4/3Ef+X+vj/z/rN9QoB2uqx4qNRh13VLVdROo1FnQWT+B0OZiIlHiO0FV3jwNGzLuGCvHHpbGMisvfu50akRVtup0SkluGQMsVu8KRXI5Z2pS2NukJym7wOuwoRnL8FsVosNoBnatFLK0DJuijRMTgMFx51xDMc3pmKccNA6biGlZtFJadAT3e/sgnwfKpjifp6CnlAZ5uMXN69Rzqc4mECsEBrQxZH6DcY2JGRWx9f7Y3RO9GGBlqa7b1kYB0NyCJoVRwJYZFXSKAiOsMyBJWAryUxMlx+Ac1TItLNsbylOpbHgwzgfTEhCHry9y+IRHN9h1FJsBE507H6AOrQ/WbozuqYwxuLtzgIWDddZIUohUwqsW4DYvUsiZNtaVDSfEOozQ3CgqNKjqLiLZLUGJMOeeY9rZQT9qBgv8HRdn9v7uLjkpyep7NtbcsOb9YG1B8KjZ5htuvi3G8G6D1NxItahaT7mZFWNUceqdlD9sT9/4p1FqCsz1k+k/WHuq7h0evUEN+RH56e//Q75jVAkyk3NLrHGhWLqoXmHBN0pw5S3aSgUXHcCwawDGY0t8brPzGPx+Rg0a1d+yOXgvLEfZ7IWjYpzymBz7oC+4rfAlHgNrgWCN+4xs9jF45SnJbeuUi7OIHIoF+hGrrQ/KsV1jGrjd1l6UoRC57m7H92NGFUToudIsPWe65iRhCbexDkoWUztaHRg3uWYyNsztMElI3krIBi9ZBY61b2KQAbWGTnj6ZU0OdyNRuhkhxUSC9wboA4IHgar/sGXJx413pcgnd3t0hK6bckksJ7oZl6XW/dFSvpviFt0qMGDzkR+ac0dOJ54sSfPivZuTtbWNoC6Bpze3W9Ocr/Ujw1Mr+t3kA1PnPPZH9g0c3cPKvSAMUh4zZ6hx29fhN0ffkfPHUT8Ia0eaazB377s3L1+//fAagAFBahE2iPpRH+3JUpuMitpIzVeU2jtbLdFm9+bS7s2l3ZtLuzeXdm8u7d5c2r25tHtzaffm0u7NpV/uQsLdm0ub7mHcvbm0e3NpFY+7N5d2by6t3Au1e3Np9+bS7s2l3ZtLv8nr9XZvLu3eXNokPndvLu3eXNq9uXSvr/bcvbm0e3Np9+bS7s2l3ZtLuzeXdm8ubd99bkWkuzeXbn6p7+7Npd2bS7s3l3ZvLu3eXNq9ubR7c2n35tLuzaXdm0u7N5d+RU6h3ZtLuzeXdm8u7d5c2r25tHtz6U6NM7+RN5dq+da9PKVc1G6msbeAnLReYvoUBjO4JeTgJLi8hFE+QhI/FP9YYJr5yacwOKeKQ1Q2XjAS+gsxIMH7jMF9CS9tykD3GIYPLc9jVl3rXhW40cO2OERC31q3fpHJ0bsPx5Cd7m6Sz2SCNxjROSSE07nNzq9ljWPZZZBSMS0w4zywfS7tPaez5gUgZ3gBiPujlrYO111UEDZvBrHTgP/DpNY2uLy0l4vg/RK2vv20sYVDrK8Ny/dpuVz+H+C5qfs=","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(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),g=t(21312);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:"eJztPdlyHDeSv4Kt2AhJPdXVh0hJ5moUQ0saWzseiSFR6/CSmh50FbobYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6oOHaA/tbT9YbBSORCIzkcgDuAwMnerg4CR4JeMiY8Lo4FMYJEzHiueGSxEcBMczRl4pOjHEVyKHR28ITVM516TQTGliJJkywRQ1jAg2J4nvjowXJFfynCdcTElCDSVzbmaEkjHV7MkeYSKWCUvIhKcsOhWn4pjnB+RjnkqakIUsFDl69ceyPxgIyk46nVdsXEzJxzedzqeHM2NyfdDr0TyPZM6E5lOR0rGOYpn1EqiYJ5NHIZnPmGLQK4mpIIxqni4ITRIy58mUGR0SM2OCxDJfkFhKlXBBDdMhyemUEVFkY6Z0SKhISCYVI1wQShSjyaJrZLfQjPznh3dvyUSqjJqIHKWFDsvhEq5YbNKF7d7MWDmrB9pjQxvFxTQkGT0DfHFDfix4fAbT1kwk8C80PDx6g7jqdD4UeS6VYQn53k7hoNOBL1+zVM4JVQzrxzLLpCA5VTRjBhdsRg1+VuzHgiuWuGVJU4+Lg1PRJZ2OoBk76HTIR8F/LBjhCROGTzhTMEtiZly7BpGtbxY51n8jEh4D8hAAKCVy0qwKSIWqH3IWQ5e2ag3VRAoyn/F4hjicU7v+eUpjOy3FdM5iw89Zs+OLkCyg41dMSA/BTCr+NykMTXH5zpkyPKZpfZkBQKiqDVUG0J9LLowvdSOQH9xywmrjIjo6BNASQG7GBX7RjJzTtGDaQTUPyQyges9yxTQyh+sXEC8SMmN8Ots4Hk0+F9o0OiaFBjDrULix/KoiehmibUJTzQifNHCZ0TNWG41IZHqaRuTrBUnYhBapCQkHCjWqYBF5Kw2heZ7ymI5ThjQAzEZNoVgXV9mRT9QknyOUAUwTShI+mTAFzAwfsQvXxkMHdFkJDeQ0M6OCSNFa6FimUq2SEBY38UhiKQwTJiKH55SnCLydrCZcxGmRMDJOaXwWknFasJAollhGXzAQdKHlD6xCqHY4R/wQzVKgQikAfiHd8FwT7aBKInIMjFLyH3z0qMZBuK5j1XH5RMLIgALPkoRllKchIi4kn+WYGG5SFgKD51QsQpCwLCSGXZixvAhJPGPxGf6laMIlGRfGSGEnliiZJ3IuHC4nUhjN/7aGI/2Xm2N0GJK9kDwJybOQDPohGQxDMtgLyeBJSAbPQjLsh2Q4DMlwLyTDJxas4bPQbxEewXUABkOLZfPrwu6MJ2wEDUcwtxHVhimuz0Bck+9hz2ECgEtCKy7ZhQHhh9KITwVLqh2QazLjScIEmSiZEcVinnOUJlYalF2HAA9RMCmhyaRI0wU555rXcFB2KucC8IYjckXe5Ux84FNBaBzLAtYYMWyRiuisllykCwD1mNFM48xfC8NUrrhmIKqFLjEgTEVbdgOEsroAuM5KiqYE2ryam1antjKwg37HNcpc2Pp0uZvOG7vpICKdTinnoOyvf/3rqbg8FYScBiD2ToMDchqUVU6D0H6D3Qy+DdzvC/jxePjU/VzAzyfDZ+7nHKsO9tzPGfwc+qaOuU6DAxwXK3Bh7MhOvpIaBFBpeSqWDthTMcRZGJrlW2YAn39e6EkJvt+loBC2l9B/AA5chWfDjG2Nldk+htlywQ2nqd48YV/jHs25BdL6aVeVVma+BzNHWbZ52vj5Hs25Dg98wT3UfsI9t/bJ7wYIxXALitp9bpLB0Aq1oxVM7kdOhdmMSDuFe4PHGjh3hcZWlzfH4hPAImynx7CdbkZluePeI3y2YborpK7r9+aYfRqhEozayWa8ugr3CKtNiO4Kp6u93hyjzwCjoOZtRid8vUe4rIEDH5zObL/197qD/e6wP9xr4BOsE7ZClnWTpLtYLL5sLTIuRhYOaFSrn9GL9R/AaAKqY7kS5RfQYLiYls2aX1dX3dZrLSQonA4ToHP646dVesFIhbrzqm0Bj/5VLXfgwb/9efzPcAof+wMqS5zWXB1HSvNP/QhtZEIXD7TtyjctT15Qv60bWzDxE8CBprB4JnnsgIc6/rw1BmtPBDjo4qL2kqRXW1QoTJJulnVbhfCzizRQK8yyKEmiVs0VQrGFGUmSkKwWry1PEpJl2YZiW94o7mXZ6iyiLHOwOex52ltZ54wLnhVwQgKrmj2gQ0U4ZDj0Zm4tuSCdzg8//PBD989/7r561en4NXRDOCquGTLsCPTijkaoE32nc0DeTEi9CI0J1oyDUqA8GDqjqq0wk3Phz0N4alQkKcCe6KtaY1JGF9gZ42bGVHMcqSqShdMjHLbG0swi8hEPl/C3P4SVhyU8SH0FgtOdjDfLTlfhlxKflZRsDrxVtG4WTQ3ZuqIWecGUr9ebFJsWKVXsAqx/mkuxIhNvswfebH9riUVPy5WlBe2KzrLLvKGDPHznzuCPSvNiay7Q2yGJC23QJDFlFySnxjAlsLNzmvKEIn90sYBd0CwH00rvL6enye/+vYeGXbCdGmtRSPiUgz2+95eTw+5/f1pTo8hzpmKqGUkZjKRDwkwckZMZS/PKJTCfz6P5Yx3PpEytP+CzVmxi/z+S488jBDePqM4frZupJYaaIRWIpW1HReasYYxq4luuMaXi0iDXDPqowTlLxRYVztW4R3pHCyT4aK3S8PkEtn5UboF4WfW3BJlzGnyqtns0nrLkirafrsGewA0pHbN09dPNWSulC1k4jvbOguZUHUXX8OZUodIejNPph7WP9KL10X5bruFTi5A6m/rd3rOnXwGScl1uJA101ls7lwE6fgRj6EsaM+IbgKPOS4Ev5YISsOuxgbeP4tpdMQTUI1ixdNf40a4YobEwKzu50xW832lS9upR5jfyOr6gJfg/KzVhywhOV9g8Ajh5Ng9wKgZohfTWyy3nE1fjHsmKFkjb2fg2UqSxM99mS70VA/pp1RlwzfYKVe3GWjKf3sx9EXlnTeq+EZjb45jloGl9MWuWIF97h0KrsbWgf40W9M2UV7ez3yPqWwPWz0yBrt5d7z63ItL67H9FhNoA+9rEao3+GZ1usd/g53tEnnV41ps4XI0VY9UALf12R9liocbv2yc86DcmvN+c8JP+LU5cjWG//MDV34KflaHgbF2kdGU7SFjMM5piBAnCPfwCHr3N4csBBjzwUmZ5YepMh2YdFCxeS/BxEdaz+7uQdEPSCUkvJA9D8igi7xlGUsRl1IVTGriysRVckEQW4CaNC5UuyFjBxEPComlELi9/LKgw3CyWS9Ihl5cQvbVcRsCFZ0LObeDFCbiMDYHAqepQlchYrwm0krHuwemr95bNuz5YrOdAe0QeypZI2HoUdSj4ZU9kFqoakcAob0uVzZ5KMdKH6zylC0In4Ka20SDYzAYNRYDiAzIkv39BBsOo3w9J3/5NHvoJDh8hD6OPKWbpNiclfr6Kg/t1Dq5+rhNZ+/1rsXB92FtyMHQxwhgCHPdKha1i7ntoOqkm0zbW1rR6wJndP/VMFmkCu6diplCClfF7pU7f6RwpNuFpWgvfI77I8zSEQ7GUZS5kzAXuwXEGQxW4MBL4xsdydDpjNpEQpgDxg2gYpFWAnx3bbt2NEJBYMWqkIjOqrZ0FMQ0QQ4CkmbGsFTDhwauCJrjwsAMpD+7OIjj8qkncT/YbxL3f3J82EvcmCt5iKIQmOpdCl/5AVn2qUR326ctXjxZtSvKdwnJjvEwV9oNCDAkn5WesLmu40F5Lc1C2w+BezqTUVQ0Xiebkrj5oRrhJBUFuj6IyNORL3V6Dp48bSsSzX9Dt1Vyl/l5vsN/b6vdquUhuflgk5DpLilb1ay0p1qzWdOcU+hKn0JdzxOO7NMwOng4b54nH2zbne2KYrXPUFSbZuzC83upsu84CWufDa9o+fzEb5JeT5V5ljRnfmTWmJbifDv4F1pgvJdEVo8udESW5K4vLOsq8hsllq53liym3DuzPTr37d2OeaZ11vmpog18N69S6v/9l1No2ztRI7jTg//X1u/fz/p++mcrDw8PDtx8+zl5/nB4eHmbwO4qitSa7dWSAw4D+7PKA3BaP6sKGUaIoQnc9NfQAm/dyMf0P2z7c3CY6FUEYyBxytbgUb5LgIEggu8sfBIIQ8cK0+Vomi+DgMnCB/vCnC7yGlr3PGtLDLgMdz1hG4S+PT0gog3yuIAwwxg1yymCBg4NAjj+zGMbIFcBgONPQEmsfXPpaNg0qCJ3OFhwEdl5BGDjPcVlUJpDlySRY+gG3dVWWVF1p/KM8C0E/kDl0y27eQtNlK43uVj29qvWAc8vYsQTDUcoMe0UXutavPYIG7ew9aAOsH7tWJKELDSKk0HYfjGkaFynolewi52pRRj6hclmjihLecqQS3sH+MgxsyEkdJKoUXQRhwA3L6uUbiEDJm69czCRgBkN9b9r2s2Rjxv7gCsCEhQtPsxtD8VkyMma46PlMihu3HwwfD4aDx4Mh9ODCGG/ahzfHQRef5Xh0K0ZI2Dm0d0f72y+l/bo6dpM2DyFngyVePetW2QuhDeuPrmITXx8xT6fsan443pRiWMtscoYbmueMqggz/W6ddNpksXK7j65gqGUYXFw9mQsSy67PXyQPUzYxNi6GxFIJph7V4xzvzeSGe3vLMFhcPb3Fr3J6T2Hx5lfP7ntM/KySYv8VsD5+tgyD2dWwflumpv4Lgd17sqw2+ADtlczvT6OxTBYjL7eWV1X0exXUm8g0YQoUoVV5VYkakDCQgj1qbzVjKVNGxRpB08hkc+nyoI2Dd8LZdOYzhv6eUknH3qsTgPNlWGhdWGkjVI9rUJ5VwU6DCKJGq/ME6vftZDpfF5PphCQPcLyRLlCMP+i534CjB/V0cTA4VwHOHgSsTAzL8hTzp+dgtR6jeTuJSPkfapwlJgEAv2P7ga/eKl7a0EIc0DVqJh8Tp7RG5CUVZQJqMzWQXF6WZIDUsVySy0tYVaZGsO8vl2FVAGM1CnBrtyWKxYyfN1qVRaxqWJbVmlotC8NtbYHb7+sAuJDcQrl+QBldLqMGQbYAR7u9wwFLSjqDJM7VWZcqE670tbG/gmxHAdDJ/xu8P89ffMvXgPK8l794nr/4Hq4ayJnlPYueCReJ5fw5S9OIPNdGSTF90ULB854rX7+Uip1zNkfGxVWtemnjtuwocjD9AIK6WjyuSayKmNMUY2qVjJl3D6EvC4702rBcg9OUGxshjtngeCSgU8XQGYWw0MLg1Qp4JvQDPqdkptjk9w9aOH3wArOKwZn8vEdfuNpvrJFiRs8ZoWJBcOJoUZHKmusmhUIxGadU8Yk7gIYkTxnE/8L5lMbW3Wsx6uE4nlFxpsPnY/UC8pPLvOaf/vFPqOFl+hvxTiVMXUOoQ1y+Na88ADn2ILSxyEjuXGnj4+5REjoKKePx17GOS+MEp/TrUvTrYqyhlvD9VaLVKD6dMnDnuRrY2GXMMxrP7KaBUFW+6RyIRxbagwcE5g+EiQsYKHME6jagGnZqOQh27tE6qY5Z7O+Oj66BSzRQdS2juMxynKXtg7w7PoJbOsrlhhSEEhMetbRRhYAlgJxz6jP5S81+YeM3mfXLOLlYd39G7n6MLlkFKOF6LUSh3dRBwpW34Kx0XF37AkskCwPuVO5S2pHLGnhEKEpEHsviOlR5BSYpmRaYqWSAff2uiRHz1S0bXGijChu76tNG6lkmKCa0rvDksQKVav2HhAltm1MyQbd6SArBAfOqAJtl2SW7yJniEL6yFgWKWdSB6Lh6i2peWfHx/Xfusp9aMoznId8xS0iRI9UgJ5RXqfiVa099rT7oxPfVAILuhkE5zvCaM6WlABEn1ZQKJ0HteRSsq2M2o6mt6kQFuPQwmwfode3Z/6d//LMG10ajyCpgdgSaJBBgcQWEaKi2BA8hy4rlIAFlEyLoj6k/tI8AAB0yzSiTSclI+vo0foQZILqUiy48oQyP0EU8g22rlLc6LFPlnVFBo026vGJD5jBfdsG1qV0f4bP6VuXDe5fsVcGAh1DgaqB5sagzeBW2IVvd4fGANy+SKQ9BK7xACyNHimVcXG+fqvsAjCwFQWFkRg2Pie9KR83rgaxr2vN1VgUrATWec6kebWBV6G4kRcxGXIzYOVPXON7X4qrAJjlmZs6YqMPmkWS3s+rSjzncmNLASStDrgElGCczpqZsFIOFCqmOXQOJnQ501emQrgXEyVRdKOetcVdrofAAOVL1DuA4XbhMEK023PqNZhH5Vs4BYaU6A0qn7R/wSRBydy9MfYSYCszOA50HTmrQcRkDAHe+VEPYuB1cLJyNU7hi68aBXuAqKBgn3DYnLz/LzFcK1zn50f1FNTA5MOcTmkrkJ6dWtu6xQaDe4E0+M9x/cP3A62TH8ddr4c00P/39fzUoMS7aUZdH3bVf8bRKUy1tmmK9V0/OnuCj5tnU07OQhk8WIylGlRxZSzDNllsJaE2oVVOVEU4K4+BeowFKB+oARNtdDP7RTWHSXt/NgwFC7mhA8HIckPdsSlWSlruGXUaDl9jROiHZoTZRAx4lNpAdNYbGM4aX/yQsh2vwpCAPKmNMzVIB6wmmYCZG6JS8jgnbbYvL2mqeBOC7RE9YEoTWSRx8WobBOI5v2yPsmA1fQ4hFw0bZyuWL4zgmD8cpB/RQNZb2csJHB04ZpgnwISo6Lb24sagW+ShOGhoOrx0DPOpsAN86E38TMn8vnU939Run1bnxfsVsDAkDGIyIJwnUsLw5a8Vn8LM5HbZ5EFwg3c5/8CsysA/6/d+y/+Bx/9fjP9jr/4r8B88AWBcHcrU02XSqWys7fEzH9gafJbMO3lSq7TVh30HXhI1GWofgih2GS/tf5fLwQrxe1gjysHZfbFMFbTgbjp8LYmHY78M/zdV81dAt4ERfxHBCxjsG/y0Irx8xsn0JSmj5WufMNrk++8yHf7uIz4dHgMcNFoStHThCLFQKd/vC9tUt9R88ydZwy0XKBRshikeJjEeK6dGw3x8NArswe+vQ+EFmzCq/c0DmHGy25SnAqAWhU1DjgcbVHWKVKXUV+d0MsjWY8DQ02msgYX8VCW8EptLjldLH8oyJX3am9eGNHR5AvcjSSgYE3FbC70FjsvVyO0nN4kJxswgOTi6Diy7Nedd+Pzj5tPwEB1EzkxB0lUuNEFMzCw6CXjsGSzN1jtE0J5eWfEuK1FQkEGq6Ih5pznvng2gQLMN2m7XidEt9VnRv2kQbOuVielW7TxWKPsAy2pVqIKrS/3L+JwYKoFuHeq0w4EA+M0bBIgKYB+p4X0WuvfZr7KPL1gWMVWvZDgHzEWCNoK72trYmTGt9lNZgvxYfdeJDnTB6qQxeWhePVE7dRxiVAUa1mKFayFAVBdQIAsK4nlpYz0nFEmUEjVeAB6g5Dvf2UMV6OkBd5PEz3Ob3niyRiCuXeRA03eIYRtl27n6Zr7Lpqtz5335D/reW+80RT+VDclaVujPEFTWdA54KS2N8wyLeNohvNE5vsE27IVs22BKQdabP/bUWR9dkvXXJfaybLtabIZwV4voWhdqRfo0E8Fpsk/8hxBr4/3Ef+X+vj/z/rN9QoB2uqx4qNRh13VLVdROo1FnQWT+B0OZiIlHiO0FV3jwNGzLuGCvHHpbGMisvfu50akRVtup0SkluGQMsVu8KRXI5Z2pS2NukJym7wOuwoRnL8FsVosNoBnatFLK0DJuijRMTgMFx51xDMc3pmKccNA6biGlZtFJadAT3e/sgnwfKpjifp6CnlAZ5uMXN69Rzqc4mECsEBrQxZH6DcY2JGRWx9f7Y3RO9GGBlqa7b1kYB0NyCJoVRwJYZFXSKAiOsMyBJWAryUxMlx+Ac1TItLNsbylOpbHgwzgfTEhCHry9y+IRHN9h1FJsBE507H6AOrQ/WbozuqYwxuLtzgIWDddZIUohUwqsW4DYvUsiZNtaVDSfEOozQ3CgqNKjqLiLZLUGJMOeeY9rZQT9qBgv8HRdn9v7uLjkpyep7NtbcsOb9YG1B8KjZ5htuvi3G8G6D1NxItahaT7mZFWNUceqdlD9sT9/4p1FqCsz1k+k/WHuq7h0evUEN+RH56e//Q75jVAkyk3NLrHGhWLqoXmHBN0pw5S3aSgUXHcCwawDGY0t8brPzGPx+Rg0a1d+yOXgvLEfZ7IWjYpzymBz7oC+4rfAlHgNrgWCN+4xs9jF45SnJbeuUi7OIHIoF+hGrrQ/KsV1jGrjd1l6UoRC57m7H92NGFUToudIsPWe65iRhCbexDkoWUztaHRg3uWYyNsztMElI3krIBi9ZBY61b2KQAbWGTnj6ZU0OdyNRuhkhxUSC9wboA4IHgar/sGXJx413pcgnd3t0hK6bckksJ7oZl6XW/dFSvpviFt0qMGDzkR+ac0dOJ54sSfPivZuTtbWNoC6Bpze3W9Ocr/Ujw1Mr+t3kA1PnPPZH9g0c3cPKvSAMUh4zZ6hx29fhN0ffkfPHUT8Ia0eaazB377s3L1+//fAagAFBahE2iPpRH+3JUpuMitpIzVeU2jtbLdFm9+bS7s2l3ZtLuzeXdm8u7d5c2r25tHtzaffm0u7NpV/uQsLdm0ub7mHcvbm0e3NpFY+7N5d2by6t3Au1e3Np9+bS7s2l3ZtLv8nr9XZvLu3eXNokPndvLu3eXNq9uXSvr/bcvbm0e3Np9+bS7s2l3ZtLuzeXdm8ubd99bkWkuzeXbn6p7+7Npd2bS7s3l3ZvLu3eXNq9ubR7c2n35tLuzaXdm0u7N5d+RU6h3ZtLuzeXdm8u7d5c2r25tHtz6U6NM7+RN5dq+da9PKVc1G6msbeAnLReYvoUBjO4JeTgJLi8hFE+QhI/FP9YYJr5yacwOKeKQ1Q2XjAS+gsxIMH7jMF9CS9tykD3GIYPLc9jVl3rXhW40cO2OERC31q3fpHJ0bsPx5Cd7m6Sz2SCNxjROSSE07nNzq9ljWPZZZBSMS0w4zywfS7tPaez5gUgZ3gBiPujlrYO111UEDZvBrHTgP/DpNY2uLy0l4vg/RK2vv20sYVDrK8Ny/dpuVz+H+C5qfs=",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,f={},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:"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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options":{\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(57958)}),"\n",(0,i.jsx)(u(),{...t(17964)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},57958(e){e.exports=JSON.parse('{"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":true},"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"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":true}}')},17964(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9070],{11184(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdlyHDeSv4Kt2AhJPdXVh0hJ5moUQ0saWzseiSFR6/CSmh50FbobYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6oOHaA/tbT9YbBSORCIzkcgDuAwMnerg4CR4JeMiY8Lo4FMYJEzHiueGSxEcBMczRl4pOjHEVyKHR28ITVM516TQTGliJJkywRQ1jAg2J4nvjowXJFfynCdcTElCDSVzbmaEkjHV7MkeYSKWCUvIhKcsOhWn4pjnB+RjnkqakIUsFDl69ceyPxgIyk46nVdsXEzJxzedzqeHM2NyfdDr0TyPZM6E5lOR0rGOYpn1EqiYJ5NHIZnPmGLQK4mpIIxqni4ITRIy58mUGR0SM2OCxDJfkFhKlXBBDdMhyemUEVFkY6Z0SKhISCYVI1wQShSjyaJrZLfQjPznh3dvyUSqjJqIHKWFDsvhEq5YbNKF7d7MWDmrB9pjQxvFxTQkGT0DfHFDfix4fAbT1kwk8C80PDx6g7jqdD4UeS6VYQn53k7hoNOBL1+zVM4JVQzrxzLLpCA5VTRjBhdsRg1+VuzHgiuWuGVJU4+Lg1PRJZ2OoBk76HTIR8F/LBjhCROGTzhTMEtiZly7BpGtbxY51n8jEh4D8hAAKCVy0qwKSIWqH3IWQ5e2ag3VRAoyn/F4hjicU7v+eUpjOy3FdM5iw89Zs+OLkCyg41dMSA/BTCr+NykMTXH5zpkyPKZpfZkBQKiqDVUG0J9LLowvdSOQH9xywmrjIjo6BNASQG7GBX7RjJzTtGDaQTUPyQyges9yxTQyh+sXEC8SMmN8Ots4Hk0+F9o0OiaFBjDrULix/KoiehmibUJTzQifNHCZ0TNWG41IZHqaRuTrBUnYhBapCQkHCjWqYBF5Kw2heZ7ymI5ThjQAzEZNoVgXV9mRT9QknyOUAUwTShI+mTAFzAwfsQvXxkMHdFkJDeQ0M6OCSNFa6FimUq2SEBY38UhiKQwTJiKH55SnCLydrCZcxGmRMDJOaXwWknFasJAollhGXzAQdKHlD6xCqHY4R/wQzVKgQikAfiHd8FwT7aBKInIMjFLyH3z0qMZBuK5j1XH5RMLIgALPkoRllKchIi4kn+WYGG5SFgKD51QsQpCwLCSGXZixvAhJPGPxGf6laMIlGRfGSGEnliiZJ3IuHC4nUhjN/7aGI/2Xm2N0GJK9kDwJybOQDPohGQxDMtgLyeBJSAbPQjLsh2Q4DMlwLyTDJxas4bPQbxEewXUABkOLZfPrwu6MJ2wEDUcwtxHVhimuz0Bck+9hz2ECgEtCKy7ZhQHhh9KITwVLqh2QazLjScIEmSiZEcVinnOUJlYalF2HAA9RMCmhyaRI0wU555rXcFB2KucC8IYjckXe5Ux84FNBaBzLAtYYMWyRiuisllykCwD1mNFM48xfC8NUrrhmIKqFLjEgTEVbdgOEsroAuM5KiqYE2ryam1antjKwg37HNcpc2Pp0uZvOG7vpICKdTinnoOyvf/3rqbg8FYScBiD2ToMDchqUVU6D0H6D3Qy+DdzvC/jxePjU/VzAzyfDZ+7nHKsO9tzPGfwc+qaOuU6DAxwXK3Bh7MhOvpIaBFBpeSqWDthTMcRZGJrlW2YAn39e6EkJvt+loBC2l9B/AA5chWfDjG2Nldk+htlywQ2nqd48YV/jHs25BdL6aVeVVma+BzNHWbZ52vj5Hs25Dg98wT3UfsI9t/bJ7wYIxXALitp9bpLB0Aq1oxVM7kdOhdmMSDuFe4PHGjh3hcZWlzfH4hPAImynx7CdbkZluePeI3y2YborpK7r9+aYfRqhEozayWa8ugr3CKtNiO4Kp6u93hyjzwCjoOZtRid8vUe4rIEDH5zObL/197qD/e6wP9xr4BOsE7ZClnWTpLtYLL5sLTIuRhYOaFSrn9GL9R/AaAKqY7kS5RfQYLiYls2aX1dX3dZrLSQonA4ToHP646dVesFIhbrzqm0Bj/5VLXfgwb/9efzPcAof+wMqS5zWXB1HSvNP/QhtZEIXD7TtyjctT15Qv60bWzDxE8CBprB4JnnsgIc6/rw1BmtPBDjo4qL2kqRXW1QoTJJulnVbhfCzizRQK8yyKEmiVs0VQrGFGUmSkKwWry1PEpJl2YZiW94o7mXZ6iyiLHOwOex52ltZ54wLnhVwQgKrmj2gQ0U4ZDj0Zm4tuSCdzg8//PBD989/7r561en4NXRDOCquGTLsCPTijkaoE32nc0DeTEi9CI0J1oyDUqA8GDqjqq0wk3Phz0N4alQkKcCe6KtaY1JGF9gZ42bGVHMcqSqShdMjHLbG0swi8hEPl/C3P4SVhyU8SH0FgtOdjDfLTlfhlxKflZRsDrxVtG4WTQ3ZuqIWecGUr9ebFJsWKVXsAqx/mkuxIhNvswfebH9riUVPy5WlBe2KzrLLvKGDPHznzuCPSvNiay7Q2yGJC23QJDFlFySnxjAlsLNzmvKEIn90sYBd0CwH00rvL6enye/+vYeGXbCdGmtRSPiUgz2+95eTw+5/f1pTo8hzpmKqGUkZjKRDwkwckZMZS/PKJTCfz6P5Yx3PpEytP+CzVmxi/z+S488jBDePqM4frZupJYaaIRWIpW1HReasYYxq4luuMaXi0iDXDPqowTlLxRYVztW4R3pHCyT4aK3S8PkEtn5UboF4WfW3BJlzGnyqtns0nrLkirafrsGewA0pHbN09dPNWSulC1k4jvbOguZUHUXX8OZUodIejNPph7WP9KL10X5bruFTi5A6m/rd3rOnXwGScl1uJA101ls7lwE6fgRj6EsaM+IbgKPOS4Ev5YISsOuxgbeP4tpdMQTUI1ixdNf40a4YobEwKzu50xW832lS9upR5jfyOr6gJfg/KzVhywhOV9g8Ajh5Ng9wKgZohfTWyy3nE1fjHsmKFkjb2fg2UqSxM99mS70VA/pp1RlwzfYKVe3GWjKf3sx9EXlnTeq+EZjb45jloGl9MWuWIF97h0KrsbWgf40W9M2UV7ez3yPqWwPWz0yBrt5d7z63ItL67H9FhNoA+9rEao3+GZ1usd/g53tEnnV41ps4XI0VY9UALf12R9liocbv2yc86DcmvN+c8JP+LU5cjWG//MDV34KflaHgbF2kdGU7SFjMM5piBAnCPfwCHr3N4csBBjzwUmZ5YepMh2YdFCxeS/BxEdaz+7uQdEPSCUkvJA9D8igi7xlGUsRl1IVTGriysRVckEQW4CaNC5UuyFjBxEPComlELi9/LKgw3CyWS9Ihl5cQvbVcRsCFZ0LObeDFCbiMDYHAqepQlchYrwm0krHuwemr95bNuz5YrOdAe0QeypZI2HoUdSj4ZU9kFqoakcAob0uVzZ5KMdKH6zylC0In4Ka20SDYzAYNRYDiAzIkv39BBsOo3w9J3/5NHvoJDh8hD6OPKWbpNiclfr6Kg/t1Dq5+rhNZ+/1rsXB92FtyMHQxwhgCHPdKha1i7ntoOqkm0zbW1rR6wJndP/VMFmkCu6diplCClfF7pU7f6RwpNuFpWgvfI77I8zSEQ7GUZS5kzAXuwXEGQxW4MBL4xsdydDpjNpEQpgDxg2gYpFWAnx3bbt2NEJBYMWqkIjOqrZ0FMQ0QQ4CkmbGsFTDhwauCJrjwsAMpD+7OIjj8qkncT/YbxL3f3J82EvcmCt5iKIQmOpdCl/5AVn2qUR326ctXjxZtSvKdwnJjvEwV9oNCDAkn5WesLmu40F5Lc1C2w+BezqTUVQ0Xiebkrj5oRrhJBUFuj6IyNORL3V6Dp48bSsSzX9Dt1Vyl/l5vsN/b6vdquUhuflgk5DpLilb1ay0p1qzWdOcU+hKn0JdzxOO7NMwOng4b54nH2zbne2KYrXPUFSbZuzC83upsu84CWufDa9o+fzEb5JeT5V5ljRnfmTWmJbifDv4F1pgvJdEVo8udESW5K4vLOsq8hsllq53liym3DuzPTr37d2OeaZ11vmpog18N69S6v/9l1No2ztRI7jTg//X1u/fz/p++mcrDw8PDtx8+zl5/nB4eHmbwO4qitSa7dWSAw4D+7PKA3BaP6sKGUaIoQnc9NfQAm/dyMf0P2z7c3CY6FUEYyBxytbgUb5LgIEggu8sfBIIQ8cK0+Vomi+DgMnCB/vCnC7yGlr3PGtLDLgMdz1hG4S+PT0gog3yuIAwwxg1yymCBg4NAjj+zGMbIFcBgONPQEmsfXPpaNg0qCJ3OFhwEdl5BGDjPcVlUJpDlySRY+gG3dVWWVF1p/KM8C0E/kDl0y27eQtNlK43uVj29qvWAc8vYsQTDUcoMe0UXutavPYIG7ew9aAOsH7tWJKELDSKk0HYfjGkaFynolewi52pRRj6hclmjihLecqQS3sH+MgxsyEkdJKoUXQRhwA3L6uUbiEDJm69czCRgBkN9b9r2s2Rjxv7gCsCEhQtPsxtD8VkyMma46PlMihu3HwwfD4aDx4Mh9ODCGG/ahzfHQRef5Xh0K0ZI2Dm0d0f72y+l/bo6dpM2DyFngyVePetW2QuhDeuPrmITXx8xT6fsan443pRiWMtscoYbmueMqggz/W6ddNpksXK7j65gqGUYXFw9mQsSy67PXyQPUzYxNi6GxFIJph7V4xzvzeSGe3vLMFhcPb3Fr3J6T2Hx5lfP7ntM/KySYv8VsD5+tgyD2dWwflumpv4Lgd17sqw2+ADtlczvT6OxTBYjL7eWV1X0exXUm8g0YQoUoVV5VYkakDCQgj1qbzVjKVNGxRpB08hkc+nyoI2Dd8LZdOYzhv6eUknH3qsTgPNlWGhdWGkjVI9rUJ5VwU6DCKJGq/ME6vftZDpfF5PphCQPcLyRLlCMP+i534CjB/V0cTA4VwHOHgSsTAzL8hTzp+dgtR6jeTuJSPkfapwlJgEAv2P7ga/eKl7a0EIc0DVqJh8Tp7RG5CUVZQJqMzWQXF6WZIDUsVySy0tYVaZGsO8vl2FVAGM1CnBrtyWKxYyfN1qVRaxqWJbVmlotC8NtbYHb7+sAuJDcQrl+QBldLqMGQbYAR7u9wwFLSjqDJM7VWZcqE670tbG/gmxHAdDJ/xu8P89ffMvXgPK8l794nr/4Hq4ayJnlPYueCReJ5fw5S9OIPNdGSTF90ULB854rX7+Uip1zNkfGxVWtemnjtuwocjD9AIK6WjyuSayKmNMUY2qVjJl3D6EvC4702rBcg9OUGxshjtngeCSgU8XQGYWw0MLg1Qp4JvQDPqdkptjk9w9aOH3wArOKwZn8vEdfuNpvrJFiRs8ZoWJBcOJoUZHKmusmhUIxGadU8Yk7gIYkTxnE/8L5lMbW3Wsx6uE4nlFxpsPnY/UC8pPLvOaf/vFPqOFl+hvxTiVMXUOoQ1y+Na88ADn2ILSxyEjuXGnj4+5REjoKKePx17GOS+MEp/TrUvTrYqyhlvD9VaLVKD6dMnDnuRrY2GXMMxrP7KaBUFW+6RyIRxbagwcE5g+EiQsYKHME6jagGnZqOQh27tE6qY5Z7O+Oj66BSzRQdS2juMxynKXtg7w7PoJbOsrlhhSEEhMetbRRhYAlgJxz6jP5S81+YeM3mfXLOLlYd39G7n6MLlkFKOF6LUSh3dRBwpW34Kx0XF37AkskCwPuVO5S2pHLGnhEKEpEHsviOlR5BSYpmRaYqWSAff2uiRHz1S0bXGijChu76tNG6lkmKCa0rvDksQKVav2HhAltm1MyQbd6SArBAfOqAJtl2SW7yJniEL6yFgWKWdSB6Lh6i2peWfHx/Xfusp9aMoznId8xS0iRI9UgJ5RXqfiVa099rT7oxPfVAILuhkE5zvCaM6WlABEn1ZQKJ0HteRSsq2M2o6mt6kQFuPQwmwfode3Z/6d//LMG10ajyCpgdgSaJBBgcQWEaKi2BA8hy4rlIAFlEyLoj6k/tI8AAB0yzSiTSclI+vo0foQZILqUiy48oQyP0EU8g22rlLc6LFPlnVFBo026vGJD5jBfdsG1qV0f4bP6VuXDe5fsVcGAh1DgaqB5sagzeBW2IVvd4fGANy+SKQ9BK7xACyNHimVcXG+fqvsAjCwFQWFkRg2Pie9KR83rgaxr2vN1VgUrATWec6kebWBV6G4kRcxGXIzYOVPXON7X4qrAJjlmZs6YqMPmkWS3s+rSjzncmNLASStDrgElGCczpqZsFIOFCqmOXQOJnQ501emQrgXEyVRdKOetcVdrofAAOVL1DuA4XbhMEK023PqNZhH5Vs4BYaU6A0qn7R/wSRBydy9MfYSYCszOA50HTmrQcRkDAHe+VEPYuB1cLJyNU7hi68aBXuAqKBgn3DYnLz/LzFcK1zn50f1FNTA5MOcTmkrkJ6dWtu6xQaDe4E0+M9x/cP3A62TH8ddr4c00P/39fzUoMS7aUZdH3bVf8bRKUy1tmmK9V0/OnuCj5tnU07OQhk8WIylGlRxZSzDNllsJaE2oVVOVEU4K4+BeowFKB+oARNtdDP7RTWHSXt/NgwFC7mhA8HIckPdsSlWSlruGXUaDl9jROiHZoTZRAx4lNpAdNYbGM4aX/yQsh2vwpCAPKmNMzVIB6wmmYCZG6JS8jgnbbYvL2mqeBOC7RE9YEoTWSRx8WobBOI5v2yPsmA1fQ4hFw0bZyuWL4zgmD8cpB/RQNZb2csJHB04ZpgnwISo6Lb24sagW+ShOGhoOrx0DPOpsAN86E38TMn8vnU939Run1bnxfsVsDAkDGIyIJwnUsLw5a8Vn8LM5HbZ5EFwg3c5/8CsysA/6/d+y/+Bx/9fjP9jr/4r8B88AWBcHcrU02XSqWys7fEzH9gafJbMO3lSq7TVh30HXhI1GWofgih2GS/tf5fLwQrxe1gjysHZfbFMFbTgbjp8LYmHY78M/zdV81dAt4ERfxHBCxjsG/y0Irx8xsn0JSmj5WufMNrk++8yHf7uIz4dHgMcNFoStHThCLFQKd/vC9tUt9R88ydZwy0XKBRshikeJjEeK6dGw3x8NArswe+vQ+EFmzCq/c0DmHGy25SnAqAWhU1DjgcbVHWKVKXUV+d0MsjWY8DQ02msgYX8VCW8EptLjldLH8oyJX3am9eGNHR5AvcjSSgYE3FbC70FjsvVyO0nN4kJxswgOTi6Diy7Nedd+Pzj5tPwEB1EzkxB0lUuNEFMzCw6CXjsGSzN1jtE0J5eWfEuK1FQkEGq6Ih5pznvng2gQLMN2m7XidEt9VnRv2kQbOuVielW7TxWKPsAy2pVqIKrS/3L+JwYKoFuHeq0w4EA+M0bBIgKYB+p4X0WuvfZr7KPL1gWMVWvZDgHzEWCNoK72trYmTGt9lNZgvxYfdeJDnTB6qQxeWhePVE7dRxiVAUa1mKFayFAVBdQIAsK4nlpYz0nFEmUEjVeAB6g5Dvf2UMV6OkBd5PEz3Ob3niyRiCuXeRA03eIYRtl27n6Zr7Lpqtz5335D/reW+80RT+VDclaVujPEFTWdA54KS2N8wyLeNohvNE5vsE27IVs22BKQdabP/bUWR9dkvXXJfaybLtabIZwV4voWhdqRfo0E8Fpsk/8hxBr4/3Ef+X+vj/z/rN9QoB2uqx4qNRh13VLVdROo1FnQWT+B0OZiIlHiO0FV3jwNGzLuGCvHHpbGMisvfu50akRVtup0SkluGQMsVu8KRXI5Z2pS2NukJym7wOuwoRnL8FsVosNoBnatFLK0DJuijRMTgMFx51xDMc3pmKccNA6biGlZtFJadAT3e/sgnwfKpjifsxQUldIiD9e4eaV6LtXZBIKFwII2htRvsK4xMaMitu4fu32iGwPMLNV929oogJpb2KQwCvgyo4JOUWKEdQ4kCUtBgGqi5Bi8o1qmheV7Q3kqlY0PxglhXgIi8fVFDp/w7AbbjmIz4KJz5wTUoXXC2p3RvZUxBn93DrBwMM8aSQqRSnjWAvzmRQpJ08b6suGIWIcRmhtFhQZd3YUkuzUoEeb8c0w7Q+hHzWCFv+PizF7g3SUnJV19z8aaG9a8IKwtCR4123zDzbfFGB5ukJobqRZV6yk3s2KMOk69k/KH7ekb/zZKTYO5fjb9B2tQ1b3DozeoIj8iP/39f8h3jCpBZnJuqTUuFEsX1TMs+EgJrrxFW6nhogcYtg3AeGyJz+12HoPfz6hBq/pbNgf3hWUpm75wVIxTHpNjH/UF1xW+xHNgLRKscaGRTT8GtzwluW2dcnEWkUOxQEditfdBObZrTAP329qTMhRC1931+H7MqIIIXVeapedM17wkLOE22EHJYmpHqwPjJtfMxoa5HSYJyVsZ2eAmq8CxBk6MMqDW0glvv6xJ4m5kSjdDpJhI8OIAfUDwJFD1H7ZM+bjzrhT57G6PjtB1Uy6J5UQ347LU+j9a2ndT3qJfBQZsvvJDc+7I6cSTJWnevHdzsrbGEVQm8Pjmtmua87WOZHhrRb+bfGDqnMf+zL6Bo3tYuReEQcpj5iw1bv86/OboO3L+OOoHYe1Mcw3m7n335uXrtx9eAzAgSC3CBlE/6qNBWWqTUVEbqfmMUntrq2Xa7B5d2j26tHt0affo0u7Rpd2jS7tHl3aPLu0eXdo9uvTL3Ui4e3Rp00WMu0eXdo8ureJx9+jS7tGllYuhdo8u7R5d2j26tHt06Td5v97u0aXdo0ubxOfu0aXdo0u7R5fu9d2eu0eXdo8u7R5d2j26tHt0affo0u7Rpe27z62IdPfo0s1v9d09urR7dGn36NLu0aXdo0u7R5d2jy7tHl3aPbq0e3Rp9+jSr8gptHt0affo0u7Rpd2jS7tHl3aPLt2pceY38uhSLeG6l6eUi9rVNPYakJPWU0yfwmAG14QcnASXlzDKR8jih+IfC8wzP/kUBudUcYjKxhtGQn8jBmR4nzG4MOGlTRnoHsPwoeV5zKprXawCV3rYFodI6Fvr1m8yOXr34RjS091V8plM8AojOoeMcDq36fm1tHEsuwxSKqYFppwHts+lveh01rwB5AxvAHF/1PLW4b6LCsLm1SB2GvB/mNTaBpeX9nYRvGDC1refNrZwiPW1Yfk+LZfL/wO+Lapg","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={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:"eJztPdlyHDeSv4Kt2AhJPdXVh0hJ5moUQ0saWzseiSFR6/CSmh50FbobYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6oOHaA/tbT9YbBSORCIzkcgDuAwMnerg4CR4JeMiY8Lo4FMYJEzHiueGSxEcBMczRl4pOjHEVyKHR28ITVM516TQTGliJJkywRQ1jAg2J4nvjowXJFfynCdcTElCDSVzbmaEkjHV7MkeYSKWCUvIhKcsOhWn4pjnB+RjnkqakIUsFDl69ceyPxgIyk46nVdsXEzJxzedzqeHM2NyfdDr0TyPZM6E5lOR0rGOYpn1EqiYJ5NHIZnPmGLQK4mpIIxqni4ITRIy58mUGR0SM2OCxDJfkFhKlXBBDdMhyemUEVFkY6Z0SKhISCYVI1wQShSjyaJrZLfQjPznh3dvyUSqjJqIHKWFDsvhEq5YbNKF7d7MWDmrB9pjQxvFxTQkGT0DfHFDfix4fAbT1kwk8C80PDx6g7jqdD4UeS6VYQn53k7hoNOBL1+zVM4JVQzrxzLLpCA5VTRjBhdsRg1+VuzHgiuWuGVJU4+Lg1PRJZ2OoBk76HTIR8F/LBjhCROGTzhTMEtiZly7BpGtbxY51n8jEh4D8hAAKCVy0qwKSIWqH3IWQ5e2ag3VRAoyn/F4hjicU7v+eUpjOy3FdM5iw89Zs+OLkCyg41dMSA/BTCr+NykMTXH5zpkyPKZpfZkBQKiqDVUG0J9LLowvdSOQH9xywmrjIjo6BNASQG7GBX7RjJzTtGDaQTUPyQyges9yxTQyh+sXEC8SMmN8Ots4Hk0+F9o0OiaFBjDrULix/KoiehmibUJTzQifNHCZ0TNWG41IZHqaRuTrBUnYhBapCQkHCjWqYBF5Kw2heZ7ymI5ThjQAzEZNoVgXV9mRT9QknyOUAUwTShI+mTAFzAwfsQvXxkMHdFkJDeQ0M6OCSNFa6FimUq2SEBY38UhiKQwTJiKH55SnCLydrCZcxGmRMDJOaXwWknFasJAollhGXzAQdKHlD6xCqHY4R/wQzVKgQikAfiHd8FwT7aBKInIMjFLyH3z0qMZBuK5j1XH5RMLIgALPkoRllKchIi4kn+WYGG5SFgKD51QsQpCwLCSGXZixvAhJPGPxGf6laMIlGRfGSGEnliiZJ3IuHC4nUhjN/7aGI/2Xm2N0GJK9kDwJybOQDPohGQxDMtgLyeBJSAbPQjLsh2Q4DMlwLyTDJxas4bPQbxEewXUABkOLZfPrwu6MJ2wEDUcwtxHVhimuz0Bck+9hz2ECgEtCKy7ZhQHhh9KITwVLqh2QazLjScIEmSiZEcVinnOUJlYalF2HAA9RMCmhyaRI0wU555rXcFB2KucC8IYjckXe5Ux84FNBaBzLAtYYMWyRiuisllykCwD1mNFM48xfC8NUrrhmIKqFLjEgTEVbdgOEsroAuM5KiqYE2ryam1antjKwg37HNcpc2Pp0uZvOG7vpICKdTinnoOyvf/3rqbg8FYScBiD2ToMDchqUVU6D0H6D3Qy+DdzvC/jxePjU/VzAzyfDZ+7nHKsO9tzPGfwc+qaOuU6DAxwXK3Bh7MhOvpIaBFBpeSqWDthTMcRZGJrlW2YAn39e6EkJvt+loBC2l9B/AA5chWfDjG2Nldk+htlywQ2nqd48YV/jHs25BdL6aVeVVma+BzNHWbZ52vj5Hs25Dg98wT3UfsI9t/bJ7wYIxXALitp9bpLB0Aq1oxVM7kdOhdmMSDuFe4PHGjh3hcZWlzfH4hPAImynx7CdbkZluePeI3y2YborpK7r9+aYfRqhEozayWa8ugr3CKtNiO4Kp6u93hyjzwCjoOZtRid8vUe4rIEDH5zObL/197qD/e6wP9xr4BOsE7ZClnWTpLtYLL5sLTIuRhYOaFSrn9GL9R/AaAKqY7kS5RfQYLiYls2aX1dX3dZrLSQonA4ToHP646dVesFIhbrzqm0Bj/5VLXfgwb/9efzPcAof+wMqS5zWXB1HSvNP/QhtZEIXD7TtyjctT15Qv60bWzDxE8CBprB4JnnsgIc6/rw1BmtPBDjo4qL2kqRXW1QoTJJulnVbhfCzizRQK8yyKEmiVs0VQrGFGUmSkKwWry1PEpJl2YZiW94o7mXZ6iyiLHOwOex52ltZ54wLnhVwQgKrmj2gQ0U4ZDj0Zm4tuSCdzg8//PBD989/7r561en4NXRDOCquGTLsCPTijkaoE32nc0DeTEi9CI0J1oyDUqA8GDqjqq0wk3Phz0N4alQkKcCe6KtaY1JGF9gZ42bGVHMcqSqShdMjHLbG0swi8hEPl/C3P4SVhyU8SH0FgtOdjDfLTlfhlxKflZRsDrxVtG4WTQ3ZuqIWecGUr9ebFJsWKVXsAqx/mkuxIhNvswfebH9riUVPy5WlBe2KzrLLvKGDPHznzuCPSvNiay7Q2yGJC23QJDFlFySnxjAlsLNzmvKEIn90sYBd0CwH00rvL6enye/+vYeGXbCdGmtRSPiUgz2+95eTw+5/f1pTo8hzpmKqGUkZjKRDwkwckZMZS/PKJTCfz6P5Yx3PpEytP+CzVmxi/z+S488jBDePqM4frZupJYaaIRWIpW1HReasYYxq4luuMaXi0iDXDPqowTlLxRYVztW4R3pHCyT4aK3S8PkEtn5UboF4WfW3BJlzGnyqtns0nrLkirafrsGewA0pHbN09dPNWSulC1k4jvbOguZUHUXX8OZUodIejNPph7WP9KL10X5bruFTi5A6m/rd3rOnXwGScl1uJA101ls7lwE6fgRj6EsaM+IbgKPOS4Ev5YISsOuxgbeP4tpdMQTUI1ixdNf40a4YobEwKzu50xW832lS9upR5jfyOr6gJfg/KzVhywhOV9g8Ajh5Ng9wKgZohfTWyy3nE1fjHsmKFkjb2fg2UqSxM99mS70VA/pp1RlwzfYKVe3GWjKf3sx9EXlnTeq+EZjb45jloGl9MWuWIF97h0KrsbWgf40W9M2UV7ez3yPqWwPWz0yBrt5d7z63ItL67H9FhNoA+9rEao3+GZ1usd/g53tEnnV41ps4XI0VY9UALf12R9liocbv2yc86DcmvN+c8JP+LU5cjWG//MDV34KflaHgbF2kdGU7SFjMM5piBAnCPfwCHr3N4csBBjzwUmZ5YepMh2YdFCxeS/BxEdaz+7uQdEPSCUkvJA9D8igi7xlGUsRl1IVTGriysRVckEQW4CaNC5UuyFjBxEPComlELi9/LKgw3CyWS9Ihl5cQvbVcRsCFZ0LObeDFCbiMDYHAqepQlchYrwm0krHuwemr95bNuz5YrOdAe0QeypZI2HoUdSj4ZU9kFqoakcAob0uVzZ5KMdKH6zylC0In4Ka20SDYzAYNRYDiAzIkv39BBsOo3w9J3/5NHvoJDh8hD6OPKWbpNiclfr6Kg/t1Dq5+rhNZ+/1rsXB92FtyMHQxwhgCHPdKha1i7ntoOqkm0zbW1rR6wJndP/VMFmkCu6diplCClfF7pU7f6RwpNuFpWgvfI77I8zSEQ7GUZS5kzAXuwXEGQxW4MBL4xsdydDpjNpEQpgDxg2gYpFWAnx3bbt2NEJBYMWqkIjOqrZ0FMQ0QQ4CkmbGsFTDhwauCJrjwsAMpD+7OIjj8qkncT/YbxL3f3J82EvcmCt5iKIQmOpdCl/5AVn2qUR326ctXjxZtSvKdwnJjvEwV9oNCDAkn5WesLmu40F5Lc1C2w+BezqTUVQ0Xiebkrj5oRrhJBUFuj6IyNORL3V6Dp48bSsSzX9Dt1Vyl/l5vsN/b6vdquUhuflgk5DpLilb1ay0p1qzWdOcU+hKn0JdzxOO7NMwOng4b54nH2zbne2KYrXPUFSbZuzC83upsu84CWufDa9o+fzEb5JeT5V5ljRnfmTWmJbifDv4F1pgvJdEVo8udESW5K4vLOsq8hsllq53liym3DuzPTr37d2OeaZ11vmpog18N69S6v/9l1No2ztRI7jTg//X1u/fz/p++mcrDw8PDtx8+zl5/nB4eHmbwO4qitSa7dWSAw4D+7PKA3BaP6sKGUaIoQnc9NfQAm/dyMf0P2z7c3CY6FUEYyBxytbgUb5LgIEggu8sfBIIQ8cK0+Vomi+DgMnCB/vCnC7yGlr3PGtLDLgMdz1hG4S+PT0gog3yuIAwwxg1yymCBg4NAjj+zGMbIFcBgONPQEmsfXPpaNg0qCJ3OFhwEdl5BGDjPcVlUJpDlySRY+gG3dVWWVF1p/KM8C0E/kDl0y27eQtNlK43uVj29qvWAc8vYsQTDUcoMe0UXutavPYIG7ew9aAOsH7tWJKELDSKk0HYfjGkaFynolewi52pRRj6hclmjihLecqQS3sH+MgxsyEkdJKoUXQRhwA3L6uUbiEDJm69czCRgBkN9b9r2s2Rjxv7gCsCEhQtPsxtD8VkyMma46PlMihu3HwwfD4aDx4Mh9ODCGG/ahzfHQRef5Xh0K0ZI2Dm0d0f72y+l/bo6dpM2DyFngyVePetW2QuhDeuPrmITXx8xT6fsan443pRiWMtscoYbmueMqggz/W6ddNpksXK7j65gqGUYXFw9mQsSy67PXyQPUzYxNi6GxFIJph7V4xzvzeSGe3vLMFhcPb3Fr3J6T2Hx5lfP7ntM/KySYv8VsD5+tgyD2dWwflumpv4Lgd17sqw2+ADtlczvT6OxTBYjL7eWV1X0exXUm8g0YQoUoVV5VYkakDCQgj1qbzVjKVNGxRpB08hkc+nyoI2Dd8LZdOYzhv6eUknH3qsTgPNlWGhdWGkjVI9rUJ5VwU6DCKJGq/ME6vftZDpfF5PphCQPcLyRLlCMP+i534CjB/V0cTA4VwHOHgSsTAzL8hTzp+dgtR6jeTuJSPkfapwlJgEAv2P7ga/eKl7a0EIc0DVqJh8Tp7RG5CUVZQJqMzWQXF6WZIDUsVySy0tYVaZGsO8vl2FVAGM1CnBrtyWKxYyfN1qVRaxqWJbVmlotC8NtbYHb7+sAuJDcQrl+QBldLqMGQbYAR7u9wwFLSjqDJM7VWZcqE670tbG/gmxHAdDJ/xu8P89ffMvXgPK8l794nr/4Hq4ayJnlPYueCReJ5fw5S9OIPNdGSTF90ULB854rX7+Uip1zNkfGxVWtemnjtuwocjD9AIK6WjyuSayKmNMUY2qVjJl3D6EvC4702rBcg9OUGxshjtngeCSgU8XQGYWw0MLg1Qp4JvQDPqdkptjk9w9aOH3wArOKwZn8vEdfuNpvrJFiRs8ZoWJBcOJoUZHKmusmhUIxGadU8Yk7gIYkTxnE/8L5lMbW3Wsx6uE4nlFxpsPnY/UC8pPLvOaf/vFPqOFl+hvxTiVMXUOoQ1y+Na88ADn2ILSxyEjuXGnj4+5REjoKKePx17GOS+MEp/TrUvTrYqyhlvD9VaLVKD6dMnDnuRrY2GXMMxrP7KaBUFW+6RyIRxbagwcE5g+EiQsYKHME6jagGnZqOQh27tE6qY5Z7O+Oj66BSzRQdS2juMxynKXtg7w7PoJbOsrlhhSEEhMetbRRhYAlgJxz6jP5S81+YeM3mfXLOLlYd39G7n6MLlkFKOF6LUSh3dRBwpW34Kx0XF37AkskCwPuVO5S2pHLGnhEKEpEHsviOlR5BSYpmRaYqWSAff2uiRHz1S0bXGijChu76tNG6lkmKCa0rvDksQKVav2HhAltm1MyQbd6SArBAfOqAJtl2SW7yJniEL6yFgWKWdSB6Lh6i2peWfHx/Xfusp9aMoznId8xS0iRI9UgJ5RXqfiVa099rT7oxPfVAILuhkE5zvCaM6WlABEn1ZQKJ0HteRSsq2M2o6mt6kQFuPQwmwfode3Z/6d//LMG10ajyCpgdgSaJBBgcQWEaKi2BA8hy4rlIAFlEyLoj6k/tI8AAB0yzSiTSclI+vo0foQZILqUiy48oQyP0EU8g22rlLc6LFPlnVFBo026vGJD5jBfdsG1qV0f4bP6VuXDe5fsVcGAh1DgaqB5sagzeBW2IVvd4fGANy+SKQ9BK7xACyNHimVcXG+fqvsAjCwFQWFkRg2Pie9KR83rgaxr2vN1VgUrATWec6kebWBV6G4kRcxGXIzYOVPXON7X4qrAJjlmZs6YqMPmkWS3s+rSjzncmNLASStDrgElGCczpqZsFIOFCqmOXQOJnQ501emQrgXEyVRdKOetcVdrofAAOVL1DuA4XbhMEK023PqNZhH5Vs4BYaU6A0qn7R/wSRBydy9MfYSYCszOA50HTmrQcRkDAHe+VEPYuB1cLJyNU7hi68aBXuAqKBgn3DYnLz/LzFcK1zn50f1FNTA5MOcTmkrkJ6dWtu6xQaDe4E0+M9x/cP3A62TH8ddr4c00P/39fzUoMS7aUZdH3bVf8bRKUy1tmmK9V0/OnuCj5tnU07OQhk8WIylGlRxZSzDNllsJaE2oVVOVEU4K4+BeowFKB+oARNtdDP7RTWHSXt/NgwFC7mhA8HIckPdsSlWSlruGXUaDl9jROiHZoTZRAx4lNpAdNYbGM4aX/yQsh2vwpCAPKmNMzVIB6wmmYCZG6JS8jgnbbYvL2mqeBOC7RE9YEoTWSRx8WobBOI5v2yPsmA1fQ4hFw0bZyuWL4zgmD8cpB/RQNZb2csJHB04ZpgnwISo6Lb24sagW+ShOGhoOrx0DPOpsAN86E38TMn8vnU939Run1bnxfsVsDAkDGIyIJwnUsLw5a8Vn8LM5HbZ5EFwg3c5/8CsysA/6/d+y/+Bx/9fjP9jr/4r8B88AWBcHcrU02XSqWys7fEzH9gafJbMO3lSq7TVh30HXhI1GWofgih2GS/tf5fLwQrxe1gjysHZfbFMFbTgbjp8LYmHY78M/zdV81dAt4ERfxHBCxjsG/y0Irx8xsn0JSmj5WufMNrk++8yHf7uIz4dHgMcNFoStHThCLFQKd/vC9tUt9R88ydZwy0XKBRshikeJjEeK6dGw3x8NArswe+vQ+EFmzCq/c0DmHGy25SnAqAWhU1DjgcbVHWKVKXUV+d0MsjWY8DQ02msgYX8VCW8EptLjldLH8oyJX3am9eGNHR5AvcjSSgYE3FbC70FjsvVyO0nN4kJxswgOTi6Diy7Nedd+Pzj5tPwEB1EzkxB0lUuNEFMzCw6CXjsGSzN1jtE0J5eWfEuK1FQkEGq6Ih5pznvng2gQLMN2m7XidEt9VnRv2kQbOuVielW7TxWKPsAy2pVqIKrS/3L+JwYKoFuHeq0w4EA+M0bBIgKYB+p4X0WuvfZr7KPL1gWMVWvZDgHzEWCNoK72trYmTGt9lNZgvxYfdeJDnTB6qQxeWhePVE7dRxiVAUa1mKFayFAVBdQIAsK4nlpYz0nFEmUEjVeAB6g5Dvf2UMV6OkBd5PEz3Ob3niyRiCuXeRA03eIYRtl27n6Zr7Lpqtz5335D/reW+80RT+VDclaVujPEFTWdA54KS2N8wyLeNohvNE5vsE27IVs22BKQdabP/bUWR9dkvXXJfaybLtabIZwV4voWhdqRfo0E8Fpsk/8hxBr4/3Ef+X+vj/z/rN9QoB2uqx4qNRh13VLVdROo1FnQWT+B0OZiIlHiO0FV3jwNGzLuGCvHHpbGMisvfu50akRVtup0SkluGQMsVu8KRXI5Z2pS2NukJym7wOuwoRnL8FsVosNoBnatFLK0DJuijRMTgMFx51xDMc3pmKccNA6biGlZtFJadAT3e/sgnwfKpjifsxQUldIiD9e4eaV6LtXZBIKFwII2htRvsK4xMaMitu4fu32iGwPMLNV929oogJpb2KQwCvgyo4JOUWKEdQ4kCUtBgGqi5Bi8o1qmheV7Q3kqlY0PxglhXgIi8fVFDp/w7AbbjmIz4KJz5wTUoXXC2p3RvZUxBn93DrBwMM8aSQqRSnjWAvzmRQpJ08b6suGIWIcRmhtFhQZd3YUkuzUoEeb8c0w7Q+hHzWCFv+PizF7g3SUnJV19z8aaG9a8IKwtCR4123zDzbfFGB5ukJobqRZV6yk3s2KMOk69k/KH7ekb/zZKTYO5fjb9B2tQ1b3DozeoIj8iP/39f8h3jCpBZnJuqTUuFEsX1TMs+EgJrrxFW6nhogcYtg3AeGyJz+12HoPfz6hBq/pbNgf3hWUpm75wVIxTHpNjH/UF1xW+xHNgLRKscaGRTT8GtzwluW2dcnEWkUOxQEditfdBObZrTAP329qTMhRC1931+H7MqIIIXVeapedM17wkLOE22EHJYmpHqwPjJtfMxoa5HSYJyVsZ2eAmq8CxBk6MMqDW0glvv6xJ4m5kSjdDpJhI8OIAfUDwJFD1H7ZM+bjzrhT57G6PjtB1Uy6J5UQ347LU+j9a2ndT3qJfBQZsvvJDc+7I6cSTJWnevHdzsrbGEVQm8Pjmtmua87WOZHhrRb+bfGDqnMf+zL6Bo3tYuReEQcpj5iw1bv86/OboO3L+OOoHYe1Mcw3m7n335uXrtx9eAzAgSC3CBlE/6qNBWWqTUVEbqfmMUntrq2Xa7B5d2j26tHt0affo0u7Rpd2jS7tHl3aPLu0eXdo9uvTL3Ui4e3Rp00WMu0eXdo8ureJx9+jS7tGllYuhdo8u7R5d2j26tHt06Td5v97u0aXdo0ubxOfu0aXdo0u7R5fu9d2eu0eXdo8u7R5d2j26tHt0affo0u7Rpe27z62IdPfo0s1v9d09urR7dGn36NLu0aXdo0u7R5d2jy7tHl3aPbq0e3Rp9+jSr8gptHt0affo0u7Rpd2jS7tHl3aPLt2pceY38uhSLeG6l6eUi9rVNPYakJPWU0yfwmAG14QcnASXlzDKR8jih+IfC8wzP/kUBudUcYjKxhtGQn8jBmR4nzG4MOGlTRnoHsPwoeV5zKprXawCV3rYFodI6Fvr1m8yOXr34RjS091V8plM8AojOoeMcDq36fm1tHEsuwxSKqYFppwHts+lveh01rwB5AxvAHF/1PLW4b6LCsLm1SB2GvB/mNTaBpeX9nYRvGDC1refNrZwiPW1Yfk+LZfL/wO+Lapg",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,f={},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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options":{\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(57958)}),"\n",(0,s.jsx)(u(),{...t(17964)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},57958(e){e.exports=JSON.parse('{"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":true},"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"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":true}}')},17964(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/980c6622.a4243b7a.js b/assets/js/980c6622.f03d02d3.js similarity index 63% rename from assets/js/980c6622.a4243b7a.js rename to assets/js/980c6622.f03d02d3.js index d6dbed4bc..c3252ae28 100644 --- a/assets/js/980c6622.a4243b7a.js +++ b/assets/js/980c6622.f03d02d3.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5919],{49757(e,t,n){n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>y,default:()=>h,frontMatter:()=>v,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","source":"@site/docs/API-docs/v1.1/getsigninglinks.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getsigninglinks","permalink":"/docs/API-docs/v1.1/getsigninglinks","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar_label":"Get Signing Links","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uIzcSfpVaXjYjtCWPM7noFCc7cIwMMsZ4Ah88gsFml9Qcs0mGrJasFRrIYd8gp1zzaPMki2L/qCV7khjZzcVWk/Xz1X9xJ0iuopjfin85VVdoKYpFJgqMKmhP2lkxF+9LhAskuNYrq+0K3mh7H+H86hLQytxghK2rgRwEpKBxjRA7yjqYCG6ZvjFEWLoAVCIUnbLpBysy4TwGybouCzEXK6SO3bAekQkvg6yQMDDQnbCyQjEXvYw7XYhMaAbqJZXiGL3LP6Kiy4Jx9EaKTAT8qdYBCzGnUGMmIm0Ni4268gZFJvDBG1egmC+liUygSqykmO8EbX2ipKDtSmRi6UIlaXyCDzJJmQv5zZlSZ6XPS9E0C1YbvbMRIws6Oz3lf4d4Y60UxrisDQyOEZlQzhIjn++E9N5olS5mHyMz7R6ja81m7wUWQ7pV2XvjuXaUH/XZvx/U+uxKNJngANXBjITIEOSW40BYxT+GgZXU5rkYmOfr7nOqXMVIDlH8OVOIfJzPZnUwJ+RO2JaTISGT2CYTpCkRa2u0xbs+bHeFU3e99c2Y8Dhtm3T76qkIX7sKqeT62KAl2ARnVxl4gzIiUNiCXEltwUjC8I//XegxBBeectbeNc9D9nt+enV6evdycMKrx07oSxGsI1i62hZ/r6lP6f99g17dfTkY9NVjgy7tWhpdpL743t2j/XvtGaunVj1DfahSfXQ9U7dE6V4cGDs+b42MqOqgaZt67sOJ9PqkvZ/fLriTcaa4rmGnJk2lmIvZuAhmu1GTbgTLDOu+jafKHYoxSlvk7mHqPFoWYWQeuRhn0uvZ+uX0pWiyYx7p/bPosT55LkskudJ29Ud8i727rjmkbdQOnLbvlF5/j9wqu5iMqbo5VqIsMKT4abt0ibmL1FuPludwinNSfjzvbtAoVyHPYx61k0nP8uk/vw1ck8kwg1NGTj/YD/ZtHcC7DQaePdIWsDT4oHOD7ayv0t0w7CPKymCMZgvaEq6CJIRCrzRJMywASnqZa6M5kZnMMXeAUS3EKdyUSCUGvvpnQJBQ4Npw+oOsyVWSWFIPFzYu3C+N28QMJOR11BZjBLSltIoJ+0Bk4AJIC2gJgw86IkQKDFq30JylIBVBJa1cIcvOYOyrAo3mbIXg8joSRGfqhBhIauMCFtDbYxGLmHz4mreGgMCnylU+YMlZs0ZY1brAmIFyBUJMZcsm2AJyjASesWiFkYXW1jh1n+K3rI0B77iLaGl4iRljZHYK0kYeeC2WPgSDw3xwvFBgC3Ay+TEiBzhtcfPJ5IM9gdshrW4wj5pw8UVfAZvN5lHmvzjkudD0XZ3DO/QuanJhu+deaSrrPFXLWMjw0Uq6QIspfUa1sJdROBUfFx+fzko0fnaNxBkSZ+dXl6nxvoBPP/8Cb1AGC6XbtMmq6oBmC6teFXuujXzrtqFvpiVV1lSyx1WbfLwsYqTegzelpE8//xrhB9yAtl1FsSmTyVWdG63gPVaex2ScTObwbUBWSf0ZUCkJlLSQI8RSciqttQQJvuXm7jmFc7uFOmKAjaYyJQOfJ74DM9gvQ7gj5DJiAc4mjl7ndI+Iz6uIZo2RZfH8yxGw0MQZXQZXr1ptYzCdcQGX2hi40QXvO2zbeVGA74437TE7fAQHl1wQVOIWZECIvGbB1RFLuqm9d4FR6Bb80hnjNhwAtIV32lKcQxHkkvbys32iK3azdvaJo9aFcnBH1okZQtJWYmfxcNq+T476+GG7DbjEwAqT2fu4eN2l022flsDZ+lfSmic2dy2paLRD80D5+lhOGu4Yqvh2eY1hrVW/+H6momeJeCYyYbRCG3G0NJxfXL2B9ZfTU5GNpuOfKO7Zm8tvX/9w/ZrBcCNtHfZyejo95SPvIlXSjjQ9emQeD7fdfqH6v79Ku3FN+EAzb6S2o+dGu+zciqOH6nz8Jl1konSRmGy345r8MZim4eOfagy8Vi0ysZZBM9i0ERU68u9ieHJ+1vYv3nWv1xfwmeftk+j7DcTy+rGWpuYvkYl73B49qJtFk/VrCENrKc6VQk8j3kc77cFiePH6vcgEt9LD9ec+rT/dD5b+JK7DvagFwH95SXuSYbdrV6umGejbq89ydAb21OykRdM0/wVQVQeN","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 Formdata","permalink":"/docs/API-docs/v1.1/getformdata"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var s=n(74848),o=n(28453),r=n(57742),a=n.n(r),l=n(78178),c=n.n(l),g=n(19624),m=n.n(g),p=n(96226),d=n.n(p),u=(n(77675),n(19365),n(51107)),k=n(21312);const v={id:"getsigninglinks",title:"Get Signing Links",description:"The Get Signing Links API enables you to retrieve signing urls of signers for the document.",sidebar_label:"Get Signing Links",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uIzcSfpVaXjYjtCWPM7noFCc7cIwMMsZ4Ah88gsFml9Qcs0mGrJasFRrIYd8gp1zzaPMki2L/qCV7khjZzcVWk/Xz1X9xJ0iuopjfin85VVdoKYpFJgqMKmhP2lkxF+9LhAskuNYrq+0K3mh7H+H86hLQytxghK2rgRwEpKBxjRA7yjqYCG6ZvjFEWLoAVCIUnbLpBysy4TwGybouCzEXK6SO3bAekQkvg6yQMDDQnbCyQjEXvYw7XYhMaAbqJZXiGL3LP6Kiy4Jx9EaKTAT8qdYBCzGnUGMmIm0Ni4268gZFJvDBG1egmC+liUygSqykmO8EbX2ipKDtSmRi6UIlaXyCDzJJmQv5zZlSZ6XPS9E0C1YbvbMRIws6Oz3lf4d4Y60UxrisDQyOEZlQzhIjn++E9N5olS5mHyMz7R6ja81m7wUWQ7pV2XvjuXaUH/XZvx/U+uxKNJngANXBjITIEOSW40BYxT+GgZXU5rkYmOfr7nOqXMVIDlH8OVOIfJzPZnUwJ+RO2JaTISGT2CYTpCkRa2u0xbs+bHeFU3e99c2Y8Dhtm3T76qkIX7sKqeT62KAl2ARnVxl4gzIiUNiCXEltwUjC8I//XegxBBeectbeNc9D9nt+enV6evdycMKrx07oSxGsI1i62hZ/r6lP6f99g17dfTkY9NVjgy7tWhpdpL743t2j/XvtGaunVj1DfahSfXQ9U7dE6V4cGDs+b42MqOqgaZt67sOJ9PqkvZ/fLriTcaa4rmGnJk2lmIvZuAhmu1GTbgTLDOu+jafKHYoxSlvk7mHqPFoWYWQeuRhn0uvZ+uX0pWiyYx7p/bPosT55LkskudJ29Ud8i727rjmkbdQOnLbvlF5/j9wqu5iMqbo5VqIsMKT4abt0ibmL1FuPludwinNSfjzvbtAoVyHPYx61k0nP8uk/vw1ck8kwg1NGTj/YD/ZtHcC7DQaePdIWsDT4oHOD7ayv0t0w7CPKymCMZgvaEq6CJIRCrzRJMywASnqZa6M5kZnMMXeAUS3EKdyUSCUGvvpnQJBQ4Npw+oOsyVWSWFIPFzYu3C+N28QMJOR11BZjBLSltIoJ+0Bk4AJIC2gJgw86IkQKDFq30JylIBVBJa1cIcvOYOyrAo3mbIXg8joSRGfqhBhIauMCFtDbYxGLmHz4mreGgMCnylU+YMlZs0ZY1brAmIFyBUJMZcsm2AJyjASesWiFkYXW1jh1n+K3rI0B77iLaGl4iRljZHYK0kYeeC2WPgSDw3xwvFBgC3Ay+TEiBzhtcfPJ5IM9gdshrW4wj5pw8UVfAZvN5lHmvzjkudD0XZ3DO/QuanJhu+deaSrrPFXLWMjw0Uq6QIspfUa1sJdROBUfFx+fzko0fnaNxBkSZ+dXl6nxvoBPP/8Cb1AGC6XbtMmq6oBmC6teFXuujXzrtqFvpiVV1lSyx1WbfLwsYqTegzelpE8//xrhB9yAtl1FsSmTyVWdG63gPVaex2ScTObwbUBWSf0ZUCkJlLSQI8RSciqttQQJvuXm7jmFc7uFOmKAjaYyJQOfJ74DM9gvQ7gj5DJiAc4mjl7ndI+Iz6uIZo2RZfH8yxGw0MQZXQZXr1ptYzCdcQGX2hi40QXvO2zbeVGA74437TE7fAQHl1wQVOIWZECIvGbB1RFLuqm9d4FR6Bb80hnjNhwAtIV32lKcQxHkkvbys32iK3azdvaJo9aFcnBH1okZQtJWYmfxcNq+T476+GG7DbjEwAqT2fu4eN2l022flsDZ+lfSmic2dy2paLRD80D5+lhOGu4Yqvh2eY1hrVW/+H6momeJeCYyYbRCG3G0NJxfXL2B9ZfTU5GNpuOfKO7Zm8tvX/9w/ZrBcCNtHfZyejo95SPvIlXSjjQ9emQeD7fdfqH6v79Ku3FN+EAzb6S2o+dGu+zciqOH6nz8Jl1konSRmGy345r8MZim4eOfagy8Vi0ysZZBM9i0ERU68u9ieHJ+1vYv3nWv1xfwmeftk+j7DcTy+rGWpuYvkYl73B49qJtFk/VrCENrKc6VQk8j3kc77cFiePH6vcgEt9LD9ec+rT/dD5b+JK7DvagFwH95SXuSYbdrV6umGejbq89ydAb21OykRdM0/wVQVQeN",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={},j=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Signing Links"}),"\n",(0,s.jsx)(a(),{method:"get",path:"/signinglinks/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Signing Links API enables you to retrieve signing urls of signers for the document."}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(k.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(c(),{...n(87174)}),"\n",(0,s.jsx)(m(),{...n(19140)}),"\n",(0,s.jsx)(d(),{...n(70974)})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},87174(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},19140(e){e.exports={title:"Body"}},70974(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","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"}}},"title":"getsigninglinks"}}}},"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5919],{49757(e,t,n){n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>h,default:()=>f,frontMatter:()=>b,metadata:()=>i,toc:()=>I});const i=JSON.parse('{"id":"API-docs/v1.1/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","source":"@site/docs/API-docs/v1.1/getsigninglinks.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getsigninglinks","permalink":"/docs/API-docs/v1.1/getsigninglinks","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar_label":"Get Signing Links","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uIzcSfpVaXjYjtCWPM7noFCc7cIwMMsZ4Ah88gsFml9Qcs0mGrJasFRrIYd8gp1zzaPMki2L/qCV7khjZzcVWk/Xz1X9xJ0iuopjfin85VVdoKYpFJgqMKmhP2lkxF+9LhAskuNYrq+0K3mh7H+H86hLQytxghK2rgRwEpKBxjRA7yjqYCG6ZvjFEWLoAVCIUnbLpBysy4TwGybouCzEXK6SO3bAekQkvg6yQMDDQnbCyQjEXvYw7XYhMaAbqJZXiGL3LP6Kiy4Jx9EaKTAT8qdYBCzGnUGMmIm0Ni4268gZFJvDBG1egmC+liUygSqykmO8EbX2ipKDtSmRi6UIlaXyCDzJJmQv5zZlSZ6XPS9E0C1YbvbMRIws6Oz3lf4d4Y60UxrisDQyOEZlQzhIjn++E9N5olS5mHyMz7R6ja81m7wUWQ7pV2XvjuXaUH/XZvx/U+uxKNJngANXBjITIEOSW40BYxT+GgZXU5rkYmOfr7nOqXMVIDlH8OVOIfJzPZnUwJ+RO2JaTISGT2CYTpCkRa2u0xbs+bHeFU3e99c2Y8Dhtm3T76qkIX7sKqeT62KAl2ARnVxl4gzIiUNiCXEltwUjC8I//XegxBBeectbeNc9D9nt+enV6evdycMKrx07oSxGsI1i62hZ/r6lP6f99g17dfTkY9NVjgy7tWhpdpL743t2j/XvtGaunVj1DfahSfXQ9U7dE6V4cGDs+b42MqOqgaZt67sOJ9PqkvZ/fLriTcaa4rmGnJk2lmIvZuAhmu1GTbgTLDOu+jafKHYoxSlvk7mHqPFoWYWQeuRhn0uvZ+uX0pWiyYx7p/bPosT55LkskudJ29Ud8i727rjmkbdQOnLbvlF5/j9wqu5iMqbo5VqIsMKT4abt0ibmL1FuPludwinNSfjzvbtAoVyHPYx61k0nP8uk/vw1ck8kwg1NGTj/YD/ZtHcC7DQaePdIWsDT4oHOD7ayv0t0w7CPKymCMZgvaEq6CJIRCrzRJMywASnqZa6M5kZnMMXeAUS3EKdyUSCUGvvpnQJBQ4BoN5z/ImlwliUX1eGHjwv3SuE3MQEJeR20xRkBbSquYsI9EBi6AtICWMPigI0KkwKh1i81ZClIRVNLKFbLsDMbOKtBoTlcILq8jQXSmTpCBpDYuYAG9QRaxiMmJr3ltCAh8qlzlA5acNmuEVa0LjBkoVyDEVLdsgi0gx0jgGYtWGFlobY1T9ymAy9oY8I7biJaGt5gxRmanIG3kiddi6WMwOMwHxxsFtgAnkx8jcoTTGjefTD7YE7gd8uoG86gJF1/0JbDZbB6l/otDngtN39U5vEPvoiYXtnvulaayzlO5jIUMH62kC7SY8mdUDHsZhVPxcfXx6axE42fXSJwhcXZ+dZk67wv49PMv8AZlsFC6TZutqg5otrDqVbHn2si3bhsaZ9pSZU0le1y1ycfbIkbqPXhTSvr0868RfsANaNuVFJsymVzVudEK3mPleU7GyWQO3wZkldSfAZWSQEkLOUIsJafSWkuQ4Ftubp9TOLdbqCMG2GgqUzLweeI7MIP9MoQ7Qi4jFuBs4uh1TveI+LyKaNYYWRYPwBwBC02c0WVw9arVNgbTGRdwqY2BG13wwsO2nRcF+O540x6zw0dwcMkFQSVuQQaEyHsWXB2xpJvaexcYhW7BL50xbsMBQFt4py3FORRBLmkvP9snumI3a2efOGpdKAd3ZJ2YISRtJXYWD6ftA+WokR/224BLDKwwmb2Pi9ddOt32aQmcrX8lrXlkc9eSikZLNE+Ur4/lpOmOoYpvl9cY1lr1m+9nKnqWiGciE0YrtBFHW8P5xdUbWH85PRXZaDz+ieKevbn89vUP168ZDDfS1mEvp6fTUz7yLlIl7UjTo1fm8XTb7Teq//uztJvXhA8080ZqO3pvtNvOrTh6qc7Hj9JFJkoXicl2O67JH4NpGj7+qcbAe9UiE2sZNINNK1GhI/8uhjfnZ23/4l33fH0Bn3nfPom+X0Es7x9raWr+Epm4x+3Ri7pZNFm/hzC0luJcKfQ04n201B5shhev34tMcCs93H/u0/7T/WDpT+I6XIxaAPyXt7QnGXa7drdqmoG+vfosR2dgT81OWjRN81+q3Qfy","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 Formdata","permalink":"/docs/API-docs/v1.1/getformdata"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var s=n(74848),o=n(28453),a=n(57742),l=n.n(a),r=n(78178),p=n.n(r),c=n(19624),g=n.n(c),d=n(96226),m=n.n(d),u=(n(77675),n(19365),n(51107)),k=n(21312);const b={id:"getsigninglinks",title:"Get Signing Links",description:"The Get Signing Links API enables you to retrieve signing urls of signers for the document.",sidebar_label:"Get Signing Links",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uIzcSfpVaXjYjtCWPM7noFCc7cIwMMsZ4Ah88gsFml9Qcs0mGrJasFRrIYd8gp1zzaPMki2L/qCV7khjZzcVWk/Xz1X9xJ0iuopjfin85VVdoKYpFJgqMKmhP2lkxF+9LhAskuNYrq+0K3mh7H+H86hLQytxghK2rgRwEpKBxjRA7yjqYCG6ZvjFEWLoAVCIUnbLpBysy4TwGybouCzEXK6SO3bAekQkvg6yQMDDQnbCyQjEXvYw7XYhMaAbqJZXiGL3LP6Kiy4Jx9EaKTAT8qdYBCzGnUGMmIm0Ni4268gZFJvDBG1egmC+liUygSqykmO8EbX2ipKDtSmRi6UIlaXyCDzJJmQv5zZlSZ6XPS9E0C1YbvbMRIws6Oz3lf4d4Y60UxrisDQyOEZlQzhIjn++E9N5olS5mHyMz7R6ja81m7wUWQ7pV2XvjuXaUH/XZvx/U+uxKNJngANXBjITIEOSW40BYxT+GgZXU5rkYmOfr7nOqXMVIDlH8OVOIfJzPZnUwJ+RO2JaTISGT2CYTpCkRa2u0xbs+bHeFU3e99c2Y8Dhtm3T76qkIX7sKqeT62KAl2ARnVxl4gzIiUNiCXEltwUjC8I//XegxBBeectbeNc9D9nt+enV6evdycMKrx07oSxGsI1i62hZ/r6lP6f99g17dfTkY9NVjgy7tWhpdpL743t2j/XvtGaunVj1DfahSfXQ9U7dE6V4cGDs+b42MqOqgaZt67sOJ9PqkvZ/fLriTcaa4rmGnJk2lmIvZuAhmu1GTbgTLDOu+jafKHYoxSlvk7mHqPFoWYWQeuRhn0uvZ+uX0pWiyYx7p/bPosT55LkskudJ29Ud8i727rjmkbdQOnLbvlF5/j9wqu5iMqbo5VqIsMKT4abt0ibmL1FuPludwinNSfjzvbtAoVyHPYx61k0nP8uk/vw1ck8kwg1NGTj/YD/ZtHcC7DQaePdIWsDT4oHOD7ayv0t0w7CPKymCMZgvaEq6CJIRCrzRJMywASnqZa6M5kZnMMXeAUS3EKdyUSCUGvvpnQJBQ4BoN5z/ImlwliUX1eGHjwv3SuE3MQEJeR20xRkBbSquYsI9EBi6AtICWMPigI0KkwKh1i81ZClIRVNLKFbLsDMbOKtBoTlcILq8jQXSmTpCBpDYuYAG9QRaxiMmJr3ltCAh8qlzlA5acNmuEVa0LjBkoVyDEVLdsgi0gx0jgGYtWGFlobY1T9ymAy9oY8I7biJaGt5gxRmanIG3kiddi6WMwOMwHxxsFtgAnkx8jcoTTGjefTD7YE7gd8uoG86gJF1/0JbDZbB6l/otDngtN39U5vEPvoiYXtnvulaayzlO5jIUMH62kC7SY8mdUDHsZhVPxcfXx6axE42fXSJwhcXZ+dZk67wv49PMv8AZlsFC6TZutqg5otrDqVbHn2si3bhsaZ9pSZU0le1y1ycfbIkbqPXhTSvr0868RfsANaNuVFJsymVzVudEK3mPleU7GyWQO3wZkldSfAZWSQEkLOUIsJafSWkuQ4Ftubp9TOLdbqCMG2GgqUzLweeI7MIP9MoQ7Qi4jFuBs4uh1TveI+LyKaNYYWRYPwBwBC02c0WVw9arVNgbTGRdwqY2BG13wwsO2nRcF+O540x6zw0dwcMkFQSVuQQaEyHsWXB2xpJvaexcYhW7BL50xbsMBQFt4py3FORRBLmkvP9snumI3a2efOGpdKAd3ZJ2YISRtJXYWD6ftA+WokR/224BLDKwwmb2Pi9ddOt32aQmcrX8lrXlkc9eSikZLNE+Ur4/lpOmOoYpvl9cY1lr1m+9nKnqWiGciE0YrtBFHW8P5xdUbWH85PRXZaDz+ieKevbn89vUP168ZDDfS1mEvp6fTUz7yLlIl7UjTo1fm8XTb7Teq//uztJvXhA8080ZqO3pvtNvOrTh6qc7Hj9JFJkoXicl2O67JH4NpGj7+qcbAe9UiE2sZNINNK1GhI/8uhjfnZ23/4l33fH0Bn3nfPom+X0Es7x9raWr+Epm4x+3Ri7pZNFm/hzC0luJcKfQ04n201B5shhev34tMcCs93H/u0/7T/WDpT+I6XIxaAPyXt7QnGXa7drdqmoG+vfosR2dgT81OWjRN81+q3Qfy",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,v={},I=[];function x(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Signing Links"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/signinglinks/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Signing Links API enables you to retrieve signing urls of signers for the document."}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(k.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...n(87174)}),"\n",(0,s.jsx)(g(),{...n(19140)}),"\n",(0,s.jsx)(m(),{...n(70974)})]})}function f(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},87174(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},19140(e){e.exports={title:"Body"}},70974(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","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"}}},"title":"getsigninglinks"}}}},"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/98334e25.86374301.js b/assets/js/98334e25.86374301.js deleted file mode 100644 index e4709ad16..000000000 --- a/assets/js/98334e25.86374301.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7024],{92846(e,t,o){o.r(t),o.d(t,{assets:()=>C,contentTitle:()=>k,default:()=>W,frontMatter:()=>m,metadata:()=>n,toc:()=>g});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":"eJy9Vs1u20YQfpXpXtoItKSkKQroFCMwXKNGYtQOfLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZyNIlkHM7sQtppW1CzFPRI4h88qRskbMxE2FcI4EHQOcXl2A1NquYG0bIAslEqy6x8ZrkQjr0EsWv8jFTJRIvfJEeAzOmoBBzDbi2XTKX4f2rpsswxCKRsNOj0hEZg2hIeaXzmmVxYfJu8BCGxGyCmvJv2jtUMyETd9hRiIRzrMaUq3JztEBYyCvTCkSgQ+ydppJFZELs8lkbRt/0kmcNF6/6FjGma3FdpsIUhQFlNHK4Ns+uLfPptO3P4rtlnmeT58/DvJNQA/GEhS2Mfk3/1186L31X47u2PaXAmHn+zB+eBzGhVlKrfKIiRu7QPP/RjI0T615dvWh1ixnZN2GFJniuzgIdUhvgwyYNV7RWszuNuLhRDp10r7P7ubbeSJqpMp2mGaHJVViJiarHbwD+iX6EOW5F/ZYCtLkqX0YW4cmqNJomQbG0UQ6NVk+HT8V2+RYRjr3VfzYnHytSCBZKlP+ldx8n5trrl9booMM7QolnfoZ1yLpCzDkSoRi3FQoc/SxWMoUNgp3ZXnt0Fyr0sSiRuPHA+kWdWZr5NFDFcJo1It8/PWPndRoBLnNmhoNRfiN7829ed14cHaFnoeLNDkUGh9UqjGKYR3fQj/XAspaYwh6DcoQll4SQq5KRVID50mZEjLpZKq0YtQym2VpDwPghzHcVkgVen761iNIyHGpGesgG7K1JNbUuwsr6xeFtquQgIS0CcpgCICmkiZjxr4QCVgP0gAaQu+8CgiBPDutWtesIS8zgloaWSLrTmCYqxy1YrSCt2kTCILVTfQYSCptPebQx2MQ8xBzePbg+AmYmtnaeawYNUuEslE5hgQymyOE2KMcgskhxUDg2BeVYWCljdE2W8T6FY3W4CyPDCU12OLARxYnL00orK9bX/oS7BLmvOWNga2Do9GbgFzgS2UWYTYa3ZsTuNvB6hbToAjn3/UdsFqtHiH/yaHMuaKfmhR+QWeDIuvXe+lSUdWksVuGSnZ/Wk3naDDCZ9ALex25zcLj5mPqpELtJtdIjJAwOb26iFP2CXz88BtcovQGKrtqwZo1HvUayt4UZ66tfJu23ZCEwkbgVZzxrAWfx/cNBuozeFtJ+vjh9wCvcAXKdB3FoYxGV02qVQY3WDstCcNoNIOXHtkk9TSgShJk0kCKECrJUFoqCRJcK62VWYzh1Kyh4W20UlRFMDA9yh2EwXnZlTtAKgPmYE2U6G2O9x4xvQ6olxhYF6+6FAFzRYzoytumbK0NnemC81goreFW5SVSjO00z8F15FVL5oQP3MGCG4IqXIP0CAENjeHqSCS+NM5Zz16o1vnC8iHFBUCTO6sMhRnkXha015/sgZ5xmpU1nyC1KZS7dCSdml1J2k7sIt5Rx/c8k4/m+OG49VigZ4OhPfb6ujjVwemuhyUwWv8NrHk989SSWbwesJZKtwvlxbGeuMnR1+F1cY1+qbL+bvtMR08i80QkQqsMTcDBhXB6fnUJy+/HU5EMtuPfaO7J5cXLs1fXZ+wMD9I2YU/H0/GUSc4GqqUZWBrc0cdrbbO/m/7Jyd3tXsIHmjgtVTx1YjCb7ky5292+80RUNhCTNhtupjdeb7dMft+g5+Nnnoil9EqmvJLv5tuk39h81yxwzUnLMnR8BC2lbtq1f3TrHRxM52c3IhE8dQ4vhUW8FLofrL1/MuuB7sMTonWAP/me+aTAZtNeIdvtjr99+qxEF2DPzQmcb7fbPwHjWKQ9","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=o(74848),i=o(28453),r=o(57742),a=o.n(r),l=o(78178),h=o.n(l),p=o(19624),c=o.n(p),d=o(96226),u=o.n(d),b=(o(77675),o(19365),o(51107));o(21312);const m={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/XAspaYwh6DcoQll4SQq5KRVID50mZEjLpZKq0YtQym2VpDwPghzHcVkgVen761iNIyHGpGesgG7K1JNbUuwsr6xeFtquQgIS0CcpgCICmkiZjxr4QCVgP0gAaQu+8CgiBPDutWtesIS8zgloaWSLrTmCYqxy1YrSCt2kTCILVTfQYSCptPebQx2MQ8xBzePbg+AmYmtnaeawYNUuEslE5hgQymyOE2KMcgskhxUDg2BeVYWCljdE2W8T6FY3W4CyPDCU12OLARxYnL00orK9bX/oS7BLmvOWNga2Do9GbgFzgS2UWYTYa3ZsTuNvB6hbToAjn3/UdsFqtHiH/yaHMuaKfmhR+QWeDIuvXe+lSUdWksVuGSnZ/Wk3naDDCZ9ALex25zcLj5mPqpELtJtdIjJAwOb26iFP2CXz88BtcovQGKrtqwZo1HvUayt4UZ66tfJu23ZCEwkbgVZzxrAWfx/cNBuozeFtJ+vjh9wCvcAXKdB3FoYxGV02qVQY3WDstCcNoNIOXHtkk9TSgShJk0kCKECrJUFoqCRJcK62VWYzh1Kyh4W20UlRFMDA9yh2EwXnZlTtAKgPmYE2U6G2O9x4xvQ6olxhYF6+6FAFzRYzoytumbK0NnemC81goreFW5SVSjO00z8F15FVL5oQP3MGCG4IqXIP0CAENjeHqSCS+NM5Zz16o1vnC8iHFBUCTO6sMhRnkXha015/sgZ5xmpU1nyC1KZS7dCSdml1J2k7sIt5Rx/c8k4/m+OG49VigZ4OhPfb6ujjVwemuhyUwWv8NrHk989SSWbwesJZKtwvlxbGeuMnR1+F1cY1+qbL+bvtMR08i80QkQqsMTcDBhXB6fnUJy+/HU5EMtuPfaO7J5cXLs1fXZ+wMD9I2YU/H0/GUSc4GqqUZWBrc0cdrbbO/m/7Jyd3tXsIHmjgtVTx1YjCb7ky5292+80RUNhCTNhtupjdeb7dMft+g5+Nnnoil9EqmvJLv5tuk39h81yxwzUnLMnR8BC2lbtq1f3TrHRxM52c3IhE8dQ4vhUW8FLofrL1/MuuB7sMTonWAP/me+aTAZtNeIdvtjr99+qxEF2DPzQmcb7fbPwHjWKQ9",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},k=void 0,C={},g=[];function x(e){const t={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)(a(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,s.jsx)(h(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{...o(48132)}),"\n",(0,s.jsx)(u(),{...o(67390)})]})}function W(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},48132(e){e.exports={title:"Body"}},67390(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/98334e25.cbe389b6.js b/assets/js/98334e25.cbe389b6.js new file mode 100644 index 000000000..a581c98a5 --- /dev/null +++ b/assets/js/98334e25.cbe389b6.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7024],{92846(e,o,t){t.r(o),t.d(o,{assets:()=>g,contentTitle:()=>u,default:()=>f,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 n=t(74848),i=t(28453),r=t(57742),p=t.n(r),l=t(78178),a=t.n(l),d=t(19624),c=t.n(d),h=t(96226),b=t.n(h),m=(t(77675),t(19365),t(51107));t(21312);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 N(e){const o={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,n.jsx)(p(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,n.jsx)(a(),{parameters:void 0}),"\n",(0,n.jsx)(c(),{...t(48132)}),"\n",(0,n.jsx)(b(),{...t(67390)})]})}function f(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(N,{...e})}):N(e)}},48132(e){e.exports={title:"Body"}},67390(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.69daa0e7.js b/assets/js/9c9cb35e.69daa0e7.js deleted file mode 100644 index 848e1771f..000000000 --- a/assets/js/9c9cb35e.69daa0e7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4240],{41875(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>s,toc:()=>f});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":"eJztPdtyG7eSv4Kd2irbPMMRSUu2o63dOortTbwnsVW2vKmspMOAMyAJawaYABhRjIpV5+H8wT7t6/m0fMlWN4C58KarHXl38uCIg1uj0d1odDcal4GhEx3sHwdHLMtTapgOTsMgYTpWPDdcimA/OJoy4ovJS8UofCcHh28ITVM506TQTGliJImhkJG40EZm/Dc6ShkxvuOQzKY8nhLN1DkjVJNRWrBccWE0GUtFJkwwRQ0XE5LIuMgYFMy4mZJcsYSNuWAJ0UYVsSkU0xH5mEtBdBHHTOtxkZYjWTC4FCExU4aAKmYKJTShpBD814KRTsfXHvKk0yFmSg2JqSAjBtNJYDYOIFYDZ0ShTArsWOcs5mMOlV1f0Yk4EUc83ycf81TShMxlocjhq38vu4B+4dtxp/OKjYoJ+fim0zl9PDUm1/s7OzTPI5kzoflEpHSko1hmOwlUzJPxE8AgUwx6RVgZ1TydE5okZMaTCTMaZyxILPM5iaVUCRcW9TmdMCKKbMSUDgkVCcmkYoQLQoliNJl3jewWmpH/+PDuLSxHRk1EDtNCh+VwCVcsNuncdg8Y8LN6ZDHzbBfWh4tJSDJ6BgvJDfm14PEZTFszgWh1a4K46nQ+FHkulWEJ+clOYb/TgZJvWSpnhCqG9WOZZVKQnCqaMYPUBgsGxYr9WnDFEksqNE09LvZPRJd0OoJmbL/TIR/twvOECQOrppDozJRr1yCy9c08x/pvRMJjQB4CAF+JHDerAlKh6gdHCLZqDdVAKZboAYczatc/T2lsp6UY0JDh56zZ8UVI5tDxKyakh2AqFf9NCkNTXL5zpgyPaVpfZgAQCdNQhXyUSy6M/+pGID+75YTVxkV0dAigJYDcjAss0Yyc07Rg2kE1C8kUoHrPcsU08oPrFxAvEjJlfDLdOB5NPhXaNDomhQYw61C4sfyqInoZom1MU80IHzdwmdEzVhuNSBRaNI3It3OSsDEtUhMSDhRqVMEi8lYaQvM85TFKJ6ABYDYKMqWLq+zIJ2qSz6GS5zxhIEISPh4zBcwMhdiFa+OhA7rMsQFMDznNTKkgUiwtdCxTqVZJCD838UhiKQwTJiIH55SnCLydrCZcxGmRMDJKaXwWolwNiWKJZfQ5AykdWv7AKiB8Lc4RP0SzFKhQCoBfSDc815WEi8gRMErJf1DoUY2DcF3HquPysYSRAQWeJQnLKE9DRFxIPskRMdykLAQGz6mYhyShhoXEsAszkhchiacsPsO/FE24JKPCGBDsMGaiZJ7ImXC4HEthNP9tDUf6kptjdBCS3ZA8C8mLkPR7IekPQtLfDUn/WUj6L0Iy6IVkMAjJYDckg2cWrMELh2taIrgOQH9gsWy+LuxOecKG0HAIcxtSbZji+gzENfkJ9hwmALjE7rlQsdwm+QR27nIH5JpMeZIwQcZKZkSxmOccpYmVBmXXIcBDFExKaDIu0nROzrnmNRyUncqZALzhiFyRdzkTH/hEEBrHsoA1RgxbpCI6qyUX6RxAPWI00zjz18IwlSuuGYhqoUsMCFPRlt0A4VtdAFxnJUVTAm1ezU2rU1sZ2EF/4BplLmx9utxNZ43dtB+RTqeUc/Dtl19+ORGXJ4KQkwDE3kmwT06CsspJENoy2M2grO9+X8CPp4Pn7uccfj4bvHA/Z1i1v+t+TuHnwDd1zAXfcGCswYWxQzsBS2ogQKXFiVg4aE/EAKdhaJZvmQIUfynw/TYFH2F/CX0BsOAqPBtmbGuszPYpzJYLbjhN9eYJ+xoPaM5LIK2fdlVpZea7MHMUZpunjcUPaM51eKAEN1FbhJturchvBwjFYAuKlvvcJIShFapHK5jci5wOsxmRdgoPBo81cO4LjUtd3hyLzwCLsJ8ewX66GZXllvuA8LkM030hdV2/N8fs8wi1YFRPNuPVVXhAWG1CdF84Xe315hh9ARgFPW8zOqH0AeGyBg4UOKXZlvV2u/297qA32G3gE8wTtkKWdZOkO5/P77YWGRdDCwc0qtXP6MX6ArCagO5YrkRZAhoMF5OyWbN0ddVtvaWFBI3TYQKUTn/+tFovGKVQeV41LuDZv6rlTjz4tz+Q/wjH8JE/obLEqc01e5a3/9TP0EYmdP5I26580/LoBfWXlWMLJhYBHGgLi6eSxw54qOMPXCMw90SAgy4u6k6S7NQWFT4mSTfLuksf4WcXaaD2McuiJImWaq4Qiv2YkSQJyerntd+ThGRZtuGz/d74vJNlq7OIsszB5rDnaW9lnTMueFbAEQnMavaEDhXhlOHQm7m15IJ0Oj///PPP3R9/7L561en4NXRDOCquWTLsCPTinkaoE32ns0/ejEn9E1oTrB0HpUB5MkRzr68wlTPhD0R4bFQkKcCg6Ktaa1JG59gZ42bKVHMcqSqSheMjnLZG0kwj8hFPl/C3P4WVpyU8SX0ToVUYj8abZaer8KXEZyUlmwNvFa2bRVNDtq6oRV4w5ev1JsUmRUoVuwDzn+ZSrMjE2+yBN9vflsSip+XK1IKGRWfaZd7SQR6/c4fwJ6V9cWku0NuB81wQxSbsguTUGKYEdnZOU55Yx0cXP7ALmuVgW9n568lJ8qd/3kHLLhhPjTUpJHzCwSC/89fjg+5/na6pUeQ5UzHVjKQMRtIhYSaOyPGUpXnlE5jNZtHsqY6nUqbWIfBJKza2/w7l6NMQwc0jqvMn62ZqiaFmSQViWTakInPWMEY18S3X2FJxaZBr+j3U4JypYosK52o8IL1jCSQotGZpKD6GrR+VWyBeVv0tQeacBKfVdo/WU5Zc0fb0GuwJ3JDSEUtXi27OWimdy8JxtPcWNKfqKLqGN6cKlQZhnE4vrBXSi6VCW7ZYw6cWIXU29bu9Z0+/AiTlutxIGuist3Y+A/T8CGZ9dCNGfAMyKqn0zlxQAnY9NvAGUly7K4aAegQrlv4aP9oVIzQWZmUnd7qCdzyNy149yvxGXscXtATvbaUmbBnB6QqbR3D+0w0DnIg+miG9+XLL+cTVeECyYgmk7Wx8GynS2Jlvs6XeigH9tOoMuGZ7hap2Yy2ZT2/mvoi8szZ13wjs7XHMctC07syaJcjX3qHQalw3oW+mvHqtB0R9a8D6zBTo6t337nMrIq3P/isi1AbY1yZWa/TP6GSL/QaLHxB51uFZb+JwNVaMVX209NsdZYuFGsu3T7jfa0x4rznhZ71bnLgaw979wNXbgp+VoeBsXaR0ZTtIWMwzmmIICcI9uAOP3ubw5QADHngps7wwdaZDsw4KFq8l+MAI69r9U0i6IemEZCckj0PyJCLvGYZSxGXYhVMauLLBFVyQRBbgJ40Llc7JSMHEQ8KiSUQuL38tqDDczBcL0iGXlxCttVhEwIVnQs5s5MUx+IwNgcip6lCVyFivibSSsd6B09fOWzbrvnLO5R0H2hPyWC6JhK1HUYeCL3sis1DViARGeVuqbPZUiqE+XOcpnRM6Bj+1DQfBZjZqKAIU75MB+dd/I/1B1OuFpGf/Jo/9BAdPkIfRxxSzdJuTEouv4uBenYOrn+tE1l7vWixcH/aWHAxdDDGIAMe9UmGrmPsBmk6qySwba2taPeDM7p96Kos0gd3TBlCyMoCv1OkhAuFQsTFP01oEH/GfPFdDRBRLWeaixlzsHhxoMFqBCyOBc3w4R6czYmMJkQoQQoimQVrF+NnR7ebdiALBwE+pyJRqa2lBXAPMECNppixbipnw4FVxE1x42IGY+/dnExx80yTvZ3sN8t5r7lAbyXsTDW8xFUITnUuhS48gq4pqdId9+u+rh4tlWvKdwnJjyEwV+YNiDEkn5WesLm240F5Pc1AuR8K9nEqpqxouGM1JXr3fDHKTCuLcnkRlcMhdHV/9508basSLL+j4aq5Sb3env7ez1fO15CS5+XGRkOssKdrVr7WkWLNa09YtdBe30N054ul9mmb7zweNE8XTbdvzAzHN1jnqCqPsfZheb3W6XWcDrfPhNa2fX8wKeXey3P0c9pglwf28/wfYY+5Koitml3sjSnJfNpd1lHkNo8tWS8udKbcO7Gen3r37MdAsnXa+aWiD3wzq1Lq3dzdqXTbP1EjuJOD/+e2797PeX76byIODg4O3Hz5OX3+cHBwcZPA7iqK1Rrt1ZIDDgP7srgK5LR7VhQ2jRFGEDntq6D4238nF5F9s+3Bzm8hF5H0mT8Lel/Yk3F1ulFW/zJ61zm3w+STD3XiWuP9ORBAGMscrhlK8SYL9wF5X9Jf3ghCXj2nzrUzmwf5l4C6IwJ8uYB+a7nzScC3yMtDxlGUU/vLLDhcpxzyFrmz4ig7CAIMk4VYlkGWwH8jRJxabIIQwixws40xDH9hu/9LXshfpgtCp/MF+YNkiCAMXelB+IkzEEuK48mQcLPyA27oqv1RdafyjvMkI/cDds1t2g00XSxdJb9VTvYdFhdaqM6oUnQfLd1b9pTMfyuKiibz9Lp37bYUbMKyVN6GwWhAG3LCsPsqGRVPy5piOmYSZYGz3TdvistDsxmNCu3wqxa0auqjU2zT9JEfDW5EjNHbGmTVrfc3VsaWrAzdJ5QAu3rDEK9jd6gZKaK9mRFdRqq+PWKaT+pjWrLYy5tGme6K162nO+EbznFEV4XXNW98cxsvZNI0LvB9diuXGzEpQy5n1F2FwcfVkLkgsu/4SKnmcsrGxsU0klkow9aQeq/pgJjfY3V2Ewfzq6c2/yuk9h8WbXT27n/D2bnWz+Y+A9emLRRhMr4b1+/J+8R8I7O6zRbXHLqkQw5FM5kMvtxZXVfSbGdSD2/FvxDuVMFVDxEjKlFGxggmIrrVHpEegZj4KbUQhXiTkSvuNjMzABq9YzOCKuY+qRVlFnK5j7xj5y1jgWnoNH1BN08VIQy3h+9O2wxEjRvHJhIFJ3tXAxu7iK6OY5kG4OMfKw5Qrds5loT14YKeH3SVlYHq3br8y0rd+jqthpxZJbOce1VcHvsDmipdR3x0dXgOXeMjs2kwA7oIoztL2Qd4dHcJlez526h8EEpeY8KiljSoE1DFyzqm/kFvK9rmNwmLWtipxsg0XRuSuuXfJKkAJ12shCm0eDnCwlpk4VjqusjfAEsnCgEuEu5up2rBcN/CIUJSIPJLFdajyCkxSMinwvoEBlvU37zHutbosz4VN8YHnDRf8XY8Vz5WEfB8VnjxWoFKt/5AwoW1zSsboHAsh+QdgXhVwuii7ZBc5Uxyc0GtRoJhF3bBQa/W1Jg6aN88/vv/B5eyohbR7HvIds4QUOVINckKZEcGv3PLUVxQl4A6mhpsUw1XVA13rzniSM6WlgOOSVBMq+G+WhFEjgdPWiE1paqs6UQFmeYzJB3ptAONl7e9//0cNro2a7ipgdgSaJOAmvQJCPFJaggdNX7EcJKBsQgT9MfXn5U0AoEOmGWYyKRlJX5/GDzGOW5dy0bkYSxenLuIpHCxKeavD8sKrUys1nlHLm/Iyh/myC65N7Ra4v5uzKh/euysbFQyohgBXA82LeZ3BK9erXOoO76vzZj6Ichtc4QVaGDlULOPievtU3Y5nZCkICiMzanhMfFc6amb5sO4lz9dZFXIA1HjOpXqyFjzDM3YkX7od5RWd66uVCmiDmoBrRRI6R4z4NECVisAucq7m5cUq9Fx5TF6hSe+hIIHJDqWI2ZCLITtn6hrqZy12AwAbMTNjTNQx55fQbrZVZoEZpGVorNjSLZwGDgHCjKkJG8ZwgkKeYNdY4k4Huup0SNcC4iS+LpSz+rj8PSjaQMpVvQM4LtNGeQmtUgfqaZMi8r2cAcJCkqcMrkyAhcH2D/gkCLlLPlEfIaYCbwCBwQmyMkDHpZcREktUQ9jIACQlnM0bayCIrdEJeoF8MzBOuG1OXrqXt+so5Izxo/tsGDA5sPgQmkrkdjNdlywDgXqD6UKmuDvi+oFd247jc/hg+ovf//Y/GlQsF1GlI5jCxlIMwKCplvYqVL1Xz2yeHSO0na1wm5CGj+dDKYaVlFtLMM2WWwloTTBHU9ESbo/Awb2+BZQO1AGItnss/E83Rd3y+m4eDBByTwO+lYbtk/dsQlWSlnuaXUaDmbJonZDsUJuoATOIbCA7agyNpwwzjCQsh1xbUpBHsAXbDfhRlZUE1hNMFUwM0YR6HROL27QXtdU8DsDSimbTJAitnTk4XYTBKI5v2yPs5392v3GjDvHToPFtJUPdKI7J41HKAT1UjaTNgPZk36nqNAE+RDVsSWtvLKpFPoqThv7Fa4eU0pyMBmVAog0WWmeM2m6R9Bu8PRtgOrdsBOHJGPiEJx7UBGVllGxatz6beWybrcsF7bSWrq/IFNTv9f4vW7qe9r4eS9du7yuydL0AYJ1z7Wppsun0uVZ2eGfh9gafJLP+h1Sq7TVhB1qEpWtzHYIrdhgs7H+Vcc4L8SsMdtaiVzn7nLHJTwbRMOj14H9LQrCRmRRMD2XW0nT+T0F4fU/j9jWwn8G3uQ1Z304H3+tcZPE0QJ1f66YkX9PkignU8cZFygUbeqQMB73ecC+w+N5dh5wPMmNWu53BbjtTEtQip+YbNSd0Ano6DK/uEVdMqauo6maQbUPCbq837JdI2FtFwhuB93ExWe2RPGPiy860PryxwwOoF1lasXbAbSUsDxqTrX+3k9QsLhQ382D/+DK46NKcd235/vHp4hSozkwl+OBzqRFiaqbBfrCz4pLHbMGgoR5fBmiAC7zI01QkEK62IvZoznfO+1E/WITLbdaKyS31WdG9aRNt6ISLyVXtTiscfYB1tEvVwFSl1+X8LwwUO7cQ9VphwIF+poyCRQZQD+TxvgpkeO0X2YcYrIsaqBZzOQ7AhwE0PPvL29UaX33NVX/s/eTo+i4930E1oaD0TgdBzd8MP2oeZPhZKr3HFTmX7levk/ZRmRvs7qLW87yP6sHTF7jz7j5bnFrk1/wtGKpTdxq4g2rd+u0+Na3BQbBkfW2YQJctoButkRuMkW7IJaOb+7rO1tXf22Rl2ltr3HFdrT/Iu8L6KXH9ic8d+K5/eKudmdasp1cTmqsJ8XKwmk97uJq7PVzNF72GhuLWoOqh0jNQmSh1CTeBSl8ApeAUuIeLsUTWczRXZhIF0Yisu6JXsjSWWZnIs9PxTX7/+z/KVp1OeZ60XiQwDrwrFMnljCnIXg5n+3HKLjC9KTRjGZZptELhfTCagQkBYleEYRObmhzuc4EHx/kIYprTEU85yH57qwatlLXtQ0eQrxXv6M1l8UjZG2vnKewYpWW2loOdzKQ6G0Oed7BVjOAiH9gxmJhSEVs3gBVjaM6GY2yVPlUbBUBzC5oURtHYkIwKOkF7dEjquEpYykHWEyVH4CXTMi2sH8hQnkplzbE4H4wkQxy+vsihCHVjEByKTYG5zp0zSIfWGWcllEt9PgK/Zw6wcDCEGUkKkUrIUg7+0yKFK3DG+jRBBa/DCM2NokKD3uwswG4JSoQ5Pw3TzuT0UTNY4B+4OLP5WLvkuCSrn9hIc8Oa6V6WBcSTZpvvuPm+GEEebqm5kWpetZ5wMy1GuNfUOyl/2J6+85ntazvJ9e9GfrCmK71zcPgGdZUn5Pe//Tf5gVElyFTOLLHGhWLpvEqijznnceUt2kpVAz2BtIDE9QZpVEy8c9pj8KcpNWi/fMtmYCi2HGWjAw+LUcrj8oECDcmnXtp3CMqnB5rpKexVMnDPUpLb1ikXZxE5EHN0KFUGOPiO7RrTQOfqhkcByqcAKojQhaFZes50zR7NEm6d3koWEztaHRg3uebNOpjbQZKQfOl2HbhLKnCsAQm9zdRakiCV/5oLeY1bb80kxEwkeA1U75NE0bGp+g+XjKbogF755G/qeXSErpvaaxCASTfj8qu1NC9pQU1xixZsGFA33migOXfkdOzJkjTzKN2crO3hUxgaow7ud3Ga87UORUidr9+NPzB1zmPmVMINHL2DlXeCMEh5zNxJ2G1fB98d/kDOn0Y92D9L3fIazL3zw5uXr99+eA3AgCC1COtHvaiHBjupTUZFbSTHJ0eVsrcUsFmeQNpHQNpHQNpHQNpHQNpHQNpHQB7yMxXtIyDtIyDtIyDtIyDtIyB/+JzbR0DaR0DaR0AeBj7bR0DaR0BunAupfQSkLGgfAWkfATlpHwFpHwE5aR8BeRiZLNtHQNpHQO5Fh2sfAWkfAWkfAWkfAWkfAfmK3lZoHwH5EhTYPgLSPgJy6yyT7SMg65iqfQSkfQSkfQTk2mlx20dAPgP3to+AtI+AtI+AbBNC7SMg7SMgD8Mt1D4C0j4C0j4C0j4C0j4C0j4Ccq/mmfYRkPYRkP+nj4DU8gzs5CnlmMzEJfe1eUiOl58GOQ2DKSQq2T8OLi+BND+qdLGAz78WmF/h+DQMzqniEM2POU5Cn5IDMhucMchm8dJeNekewfihXXC8TrqU2gVyitgWB4iDrXXruVQO3304grQM7vmSTCaYG4nOIBMCndl0FbV0CfjtMkipmBSYaiGwfS5sptdpMwXJGaYgcX/U8jVAqo4KwmZuEjsN+BcmtbbB5aVNb7JYlPVt0cYWDrG+Nqzf6WKx+F9xGoSB","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(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdtyG7eSv4Kd2irbPMMRSUu2o63dOortTbwnsVW2vKmspMOAMyAJawaYABhRjIpV5+H8wT7t6/m0fMlWN4C58KarHXl38uCIg1uj0d1odDcal4GhEx3sHwdHLMtTapgOTsMgYTpWPDdcimA/OJoy4ovJS8UofCcHh28ITVM506TQTGliJImhkJG40EZm/Dc6ShkxvuOQzKY8nhLN1DkjVJNRWrBccWE0GUtFJkwwRQ0XE5LIuMgYFMy4mZJcsYSNuWAJ0UYVsSkU0xH5mEtBdBHHTOtxkZYjWTC4FCExU4aAKmYKJTShpBD814KRTsfXHvKk0yFmSg2JqSAjBtNJYDYOIFYDZ0ShTArsWOcs5mMOlV1f0Yk4EUc83ycf81TShMxlocjhq38vu4B+4dtxp/OKjYoJ+fim0zl9PDUm1/s7OzTPI5kzoflEpHSko1hmOwlUzJPxE8AgUwx6RVgZ1TydE5okZMaTCTMaZyxILPM5iaVUCRcW9TmdMCKKbMSUDgkVCcmkYoQLQoliNJl3jewWmpH/+PDuLSxHRk1EDtNCh+VwCVcsNuncdg8Y8LN6ZDHzbBfWh4tJSDJ6BgvJDfm14PEZTFszgWh1a4K46nQ+FHkulWEJ+clOYb/TgZJvWSpnhCqG9WOZZVKQnCqaMYPUBgsGxYr9WnDFEksqNE09LvZPRJd0OoJmbL/TIR/twvOECQOrppDozJRr1yCy9c08x/pvRMJjQB4CAF+JHDerAlKh6gdHCLZqDdVAKZboAYczatc/T2lsp6UY0JDh56zZ8UVI5tDxKyakh2AqFf9NCkNTXL5zpgyPaVpfZgAQCdNQhXyUSy6M/+pGID+75YTVxkV0dAigJYDcjAss0Yyc07Rg2kE1C8kUoHrPcsU08oPrFxAvEjJlfDLdOB5NPhXaNDomhQYw61C4sfyqInoZom1MU80IHzdwmdEzVhuNSBRaNI3It3OSsDEtUhMSDhRqVMEi8lYaQvM85TFKJ6ABYDYKMqWLq+zIJ2qSz6GS5zxhIEISPh4zBcwMhdiFa+OhA7rMsQFMDznNTKkgUiwtdCxTqVZJCD838UhiKQwTJiIH55SnCLydrCZcxGmRMDJKaXwWolwNiWKJZfQ5AykdWv7AKiB8Lc4RP0SzFKhQCoBfSDc815WEi8gRMErJf1DoUY2DcF3HquPysYSRAQWeJQnLKE9DRFxIPskRMdykLAQGz6mYhyShhoXEsAszkhchiacsPsO/FE24JKPCGBDsMGaiZJ7ImXC4HEthNP9tDUf6kptjdBCS3ZA8C8mLkPR7IekPQtLfDUn/WUj6L0Iy6IVkMAjJYDckg2cWrMELh2taIrgOQH9gsWy+LuxOecKG0HAIcxtSbZji+gzENfkJ9hwmALjE7rlQsdwm+QR27nIH5JpMeZIwQcZKZkSxmOccpYmVBmXXIcBDFExKaDIu0nROzrnmNRyUncqZALzhiFyRdzkTH/hEEBrHsoA1RgxbpCI6qyUX6RxAPWI00zjz18IwlSuuGYhqoUsMCFPRlt0A4VtdAFxnJUVTAm1ezU2rU1sZ2EF/4BplLmx9utxNZ43dtB+RTqeUc/Dtl19+ORGXJ4KQkwDE3kmwT06CsspJENoy2M2grO9+X8CPp4Pn7uccfj4bvHA/Z1i1v+t+TuHnwDd1zAXfcGCswYWxQzsBS2ogQKXFiVg4aE/EAKdhaJZvmQIUfynw/TYFH2F/CX0BsOAqPBtmbGuszPYpzJYLbjhN9eYJ+xoPaM5LIK2fdlVpZea7MHMUZpunjcUPaM51eKAEN1FbhJturchvBwjFYAuKlvvcJIShFapHK5jci5wOsxmRdgoPBo81cO4LjUtd3hyLzwCLsJ8ewX66GZXllvuA8LkM030hdV2/N8fs8wi1YFRPNuPVVXhAWG1CdF84Xe315hh9ARgFPW8zOqH0AeGyBg4UOKXZlvV2u/297qA32G3gE8wTtkKWdZOkO5/P77YWGRdDCwc0qtXP6MX6ArCagO5YrkRZAhoMF5OyWbN0ddVtvaWFBI3TYQKUTn/+tFovGKVQeV41LuDZv6rlTjz4tz+Q/wjH8JE/obLEqc01e5a3/9TP0EYmdP5I26580/LoBfWXlWMLJhYBHGgLi6eSxw54qOMPXCMw90SAgy4u6k6S7NQWFT4mSTfLuksf4WcXaaD2McuiJImWaq4Qiv2YkSQJyerntd+ThGRZtuGz/d74vJNlq7OIsszB5rDnaW9lnTMueFbAEQnMavaEDhXhlOHQm7m15IJ0Oj///PPP3R9/7L561en4NXRDOCquWTLsCPTinkaoE32ns0/ejEn9E1oTrB0HpUB5MkRzr68wlTPhD0R4bFQkKcCg6Ktaa1JG59gZ42bKVHMcqSqSheMjnLZG0kwj8hFPl/C3P4WVpyU8SX0ToVUYj8abZaer8KXEZyUlmwNvFa2bRVNDtq6oRV4w5ev1JsUmRUoVuwDzn+ZSrMjE2+yBN9vflsSip+XK1IKGRWfaZd7SQR6/c4fwJ6V9cWku0NuB81wQxSbsguTUGKYEdnZOU55Yx0cXP7ALmuVgW9n568lJ8qd/3kHLLhhPjTUpJHzCwSC/89fjg+5/na6pUeQ5UzHVjKQMRtIhYSaOyPGUpXnlE5jNZtHsqY6nUqbWIfBJKza2/w7l6NMQwc0jqvMn62ZqiaFmSQViWTakInPWMEY18S3X2FJxaZBr+j3U4JypYosK52o8IL1jCSQotGZpKD6GrR+VWyBeVv0tQeacBKfVdo/WU5Zc0fb0GuwJ3JDSEUtXi27OWimdy8JxtPcWNKfqKLqGN6cKlQZhnE4vrBXSi6VCW7ZYw6cWIXU29bu9Z0+/AiTlutxIGuist3Y+A/T8CGZ9dCNGfAMyKqn0zlxQAnY9NvAGUly7K4aAegQrlv4aP9oVIzQWZmUnd7qCdzyNy149yvxGXscXtATvbaUmbBnB6QqbR3D+0w0DnIg+miG9+XLL+cTVeECyYgmk7Wx8GynS2Jlvs6XeigH9tOoMuGZ7hap2Yy2ZT2/mvoi8szZ13wjs7XHMctC07syaJcjX3qHQalw3oW+mvHqtB0R9a8D6zBTo6t337nMrIq3P/isi1AbY1yZWa/TP6GSL/QaLHxB51uFZb+JwNVaMVX209NsdZYuFGsu3T7jfa0x4rznhZ71bnLgaw979wNXbgp+VoeBsXaR0ZTtIWMwzmmIICcI9uAOP3ubw5QADHngps7wwdaZDsw4KFq8l+MAI69r9U0i6IemEZCckj0PyJCLvGYZSxGXYhVMauLLBFVyQRBbgJ40Llc7JSMHEQ8KiSUQuL38tqDDczBcL0iGXlxCttVhEwIVnQs5s5MUx+IwNgcip6lCVyFivibSSsd6B09fOWzbrvnLO5R0H2hPyWC6JhK1HUYeCL3sis1DViARGeVuqbPZUiqE+XOcpnRM6Bj+1DQfBZjZqKAIU75MB+dd/I/1B1OuFpGf/Jo/9BAdPkIfRxxSzdJuTEouv4uBenYOrn+tE1l7vWixcH/aWHAxdDDGIAMe9UmGrmPsBmk6qySwba2taPeDM7p96Kos0gd3TBlCyMoCv1OkhAuFQsTFP01oEH/GfPFdDRBRLWeaixlzsHhxoMFqBCyOBc3w4R6czYmMJkQoQQoimQVrF+NnR7ebdiALBwE+pyJRqa2lBXAPMECNppixbipnw4FVxE1x42IGY+/dnExx80yTvZ3sN8t5r7lAbyXsTDW8xFUITnUuhS48gq4pqdId9+u+rh4tlWvKdwnJjyEwV+YNiDEkn5WesLm240F5Pc1AuR8K9nEqpqxouGM1JXr3fDHKTCuLcnkRlcMhdHV/9508basSLL+j4aq5Sb3env7ez1fO15CS5+XGRkOssKdrVr7WkWLNa09YtdBe30N054ul9mmb7zweNE8XTbdvzAzHN1jnqCqPsfZheb3W6XWcDrfPhNa2fX8wKeXey3P0c9pglwf28/wfYY+5Koitml3sjSnJfNpd1lHkNo8tWS8udKbcO7Gen3r37MdAsnXa+aWiD3wzq1Lq3dzdqXTbP1EjuJOD/+e2797PeX76byIODg4O3Hz5OX3+cHBwcZPA7iqK1Rrt1ZIDDgP7srgK5LR7VhQ2jRFGEDntq6D4238nF5F9s+3Bzm8hF5H0mT8Lel/Yk3F1ulFW/zJ61zm3w+STD3XiWuP9ORBAGMscrhlK8SYL9wF5X9Jf3ghCXj2nzrUzmwf5l4C6IwJ8uYB+a7nzScC3yMtDxlGUU/vLLDhcpxzyFrmz4ig7CAIMk4VYlkGWwH8jRJxabIIQwixws40xDH9hu/9LXshfpgtCp/MF+YNkiCAMXelB+IkzEEuK48mQcLPyA27oqv1RdafyjvMkI/cDds1t2g00XSxdJb9VTvYdFhdaqM6oUnQfLd1b9pTMfyuKiibz9Lp37bYUbMKyVN6GwWhAG3LCsPsqGRVPy5piOmYSZYGz3TdvistDsxmNCu3wqxa0auqjU2zT9JEfDW5EjNHbGmTVrfc3VsaWrAzdJ5QAu3rDEK9jd6gZKaK9mRFdRqq+PWKaT+pjWrLYy5tGme6K162nO+EbznFEV4XXNW98cxsvZNI0LvB9diuXGzEpQy5n1F2FwcfVkLkgsu/4SKnmcsrGxsU0klkow9aQeq/pgJjfY3V2Ewfzq6c2/yuk9h8WbXT27n/D2bnWz+Y+A9emLRRhMr4b1+/J+8R8I7O6zRbXHLqkQw5FM5kMvtxZXVfSbGdSD2/FvxDuVMFVDxEjKlFGxggmIrrVHpEegZj4KbUQhXiTkSvuNjMzABq9YzOCKuY+qRVlFnK5j7xj5y1jgWnoNH1BN08VIQy3h+9O2wxEjRvHJhIFJ3tXAxu7iK6OY5kG4OMfKw5Qrds5loT14YKeH3SVlYHq3br8y0rd+jqthpxZJbOce1VcHvsDmipdR3x0dXgOXeMjs2kwA7oIoztL2Qd4dHcJlez526h8EEpeY8KiljSoE1DFyzqm/kFvK9rmNwmLWtipxsg0XRuSuuXfJKkAJ12shCm0eDnCwlpk4VjqusjfAEsnCgEuEu5up2rBcN/CIUJSIPJLFdajyCkxSMinwvoEBlvU37zHutbosz4VN8YHnDRf8XY8Vz5WEfB8VnjxWoFKt/5AwoW1zSsboHAsh+QdgXhVwuii7ZBc5Uxyc0GtRoJhF3bBQa/W1Jg6aN88/vv/B5eyohbR7HvIds4QUOVINckKZEcGv3PLUVxQl4A6mhpsUw1XVA13rzniSM6WlgOOSVBMq+G+WhFEjgdPWiE1paqs6UQFmeYzJB3ptAONl7e9//0cNro2a7ipgdgSaJOAmvQJCPFJaggdNX7EcJKBsQgT9MfXn5U0AoEOmGWYyKRlJX5/GDzGOW5dy0bkYSxenLuIpHCxKeavD8sKrUys1nlHLm/Iyh/myC65N7Ra4v5uzKh/euysbFQyohgBXA82LeZ3BK9erXOoO76vzZj6Ichtc4QVaGDlULOPievtU3Y5nZCkICiMzanhMfFc6amb5sO4lz9dZFXIA1HjOpXqyFjzDM3YkX7od5RWd66uVCmiDmoBrRRI6R4z4NECVisAucq7m5cUq9Fx5TF6hSe+hIIHJDqWI2ZCLITtn6hrqZy12AwAbMTNjTNQx55fQbrZVZoEZpGVorNjSLZwGDgHCjKkJG8ZwgkKeYNdY4k4Huup0SNcC4iS+LpSz+rj8PSjaQMpVvQM4LtNGeQmtUgfqaZMi8r2cAcJCkqcMrkyAhcH2D/gkCLlLPlEfIaYCbwCBwQmyMkDHpZcREktUQ9jIACQlnM0bayCIrdEJeoF8MzBOuG1OXrqXt+so5Izxo/tsGDA5sPgQmkrkdjNdlywDgXqD6UKmuDvi+oFd247jc/hg+ovf//Y/GlQsF1GlI5jCxlIMwKCplvYqVL1Xz2yeHSO0na1wm5CGj+dDKYaVlFtLMM2WWwloTTBHU9ESbo/Awb2+BZQO1AGItnss/E83Rd3y+m4eDBByTwO+lYbtk/dsQlWSlnuaXUaDmbJonZDsUJuoATOIbCA7agyNpwwzjCQsh1xbUpBHsAXbDfhRlZUE1hNMFUwM0YR6HROL27QXtdU8DsDSimbTJAitnTk4XYTBKI5v2yPs5392v3GjDvHToPFtJUPdKI7J41HKAT1UjaTNgPZk36nqNAE+RDVsSWtvLKpFPoqThv7Fa4eU0pyMBmVAog0WWmeM2m6R9Bu8PRtgOrdsBOHJGPiEJx7UBGVllGxatz6beWybrcsF7bSWrq/IFNTv9f4vW7qe9r4eS9du7yuydL0AYJ1z7Wppsun0uVZ2eGfh9gafJLP+h1Sq7TVhB1qEpWtzHYIrdhgs7H+Vcc4L8SsMdtaiVzn7nLHJTwbRMOj14H9LQrCRmRRMD2XW0nT+T0F4fU/j9jWwn8G3uQ1Z304H3+tcZPE0QJ1f66YkX9PkignU8cZFygUbeqQMB73ecC+w+N5dh5wPMmNWu53BbjtTEtQip+YbNSd0Ano6DK/uEVdMqauo6maQbUPCbq837JdI2FtFwhuB93ExWe2RPGPiy860PryxwwOoF1lasXbAbSUsDxqTrX+3k9QsLhQ382D/+DK46NKcd235/vHp4hSozkwl+OBzqRFiaqbBfrCz4pLHbMGgoR5fBmiAC7zI01QkEK62IvZoznfO+1E/WITLbdaKyS31WdG9aRNt6ISLyVXtTiscfYB1tEvVwFSl1+X8LwwUO7cQ9VphwIF+poyCRQZQD+TxvgpkeO0X2YcYrIsaqBZzOQ7AhwE0PPvL29UaX33NVX/s/eTo+i4930E1oaD0TgdBzd8MP2oeZPhZKr3HFTmX7levk/ZRmRvs7qLW87yP6sHTF7jz7j5bnFrk1/wtGKpTdxq4g2rd+u0+Na3BQbBkfW2YQJctoButkRuMkW7IJaOb+7rO1tXf22Rl2ltr3HFdrT/Iu8L6KXH9ic8d+K5/eKudmdasp1cTmqsJ8XKwmk97uJq7PVzNF72GhuLWoOqh0jNQmSh1CTeBSl8ApeAUuIeLsUTWczRXZhIF0Yisu6JXsjSWWZnIs9PxTX7/+z/KVp1OeZ60XiQwDrwrFMnljCnIXg5n+3HKLjC9KTRjGZZptELhfTCagQkBYleEYRObmhzuc4EHx/kIYprTEU85yH57qwatlLXtQ0eQrxXv6M1l8UjZG2vnKewYpWW2loOdzKQ6G0Oed7BVjOAiH9gxmJhSEVs3gBVjaM6GY2yVPlUbBUBzC5oURtHYkIwKOkF7dEjquEpYykHWEyVH4CXTMi2sH8hQnkplzbE4H4wkQxy+vsihCHVjEByKTYG5zp0zSIfWGWcllEt9PgK/Zw6wcDCEGUkKkUrIUg7+0yKFK3DG+jRBBa/DCM2NokKD3uwswG4JSoQ5Pw3TzuT0UTNY4B+4OLP5WLvkuCSrn9hIc8Oa6V6WBcSTZpvvuPm+GEEebqm5kWpetZ5wMy1GuNfUOyl/2J6+85ntazvJ9e9GfrCmK71zcPgGdZUn5Pe//Tf5gVElyFTOLLHGhWLpvEqijznnceUt2kpVAz2BtIDE9QZpVEy8c9pj8KcpNWi/fMtmYCi2HGWjAw+LUcrj8oECDcmnXtp3CMqnB5rpKexVMnDPUpLb1ikXZxE5EHN0KFUGOPiO7RrTQOfqhkcByqcAKojQhaFZes50zR7NEm6d3koWEztaHRg3uebNOpjbQZKQfOl2HbhLKnCsAQm9zdRakiCV/5oLeY1bb80kxEwkeA1U75NE0bGp+g+XjKbogF755G/qeXSErpvaaxCASTfj8qu1NC9pQU1xixZsGFA33migOXfkdOzJkjTzKN2crO3hUxgaow7ud3Ga87UORUidr9+NPzB1zmPmVMINHL2DlXeCMEh5zNxJ2G1fB98d/kDOn0Y92D9L3fIazL3zw5uXr99+eA3AgCC1COtHvaiHBjupTUZFbSTHJ0eVsrcUsFmeQNpHQNpHQNpHQNpHQNpHQNpHQB7yMxXtIyDtIyDtIyDtIyDtIyB/+JzbR0DaR0DaR0AeBj7bR0DaR0BunAupfQSkLGgfAWkfATlpHwFpHwE5aR8BeRiZLNtHQNpHQO5Fh2sfAWkfAWkfAWkfAWkfAfmK3lZoHwH5EhTYPgLSPgJy6yyT7SMg65iqfQSkfQSkfQTk2mlx20dAPgP3to+AtI+AtI+AbBNC7SMg7SMgD8Mt1D4C0j4C0j4C0j4C0j4C0j4Ccq/mmfYRkPYRkP+nj4DU8gzs5CnlmMzEJfe1eUiOl58GOQ2DKSQq2T8OLi+BND+qdLGAz78WmF/h+DQMzqniEM2POU5Cn5IDMhucMchm8dJeNekewfihXXC8TrqU2gVyitgWB4iDrXXruVQO3304grQM7vmSTCaYG4nOIBMCndl0FbV0CfjtMkipmBSYaiGwfS5sptdpMwXJGaYgcX/U8jVAqo4KwmZuEjsN+BcmtbbB5aVNb7JYlPVt0cYWDrG+Nqzf6WKx+F9xGoSB",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,j={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(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:"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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options": {\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(16078)}),"\n",(0,i.jsx)(u(),{...t(79076)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},16078(e){e.exports=JSON.parse('{"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"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":true}}')},79076(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.e9f5b614.js b/assets/js/9c9cb35e.e9f5b614.js new file mode 100644 index 000000000..7a509caae --- /dev/null +++ b/assets/js/9c9cb35e.e9f5b614.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4240],{41875(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,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":"eJztPdtyG7eSv4Kd2irbPMMRSUu2o63dOortTbwnsVW2vKmspMOAMyAJawaYABhRjIpV5+H8wT7t6/m0fMlWN4C58KarHXl38uCIg1uj0d1odDcal4GhEx3sHwdHLMtTapgOTsMgYTpWPDdcimA/OJoy4ovJS8UofCcHh28ITVM506TQTGliJImhkJG40EZm/Dc6ShkxvuOQzKY8nhLN1DkjVJNRWrBccWE0GUtFJkwwRQ0XE5LIuMgYFMy4mZJcsYSNuWAJ0UYVsSkU0xH5mEtBdBHHTOtxkZYjWTC4FCExU4aAKmYKJTShpBD814KRTsfXHvKk0yFmSg2JqSAjBtNJYDYOIFYDZ0ShTArsWOcs5mMOlV1f0Yk4EUc83ycf81TShMxlocjhq38vu4B+4dtxp/OKjYoJ+fim0zl9PDUm1/s7OzTPI5kzoflEpHSko1hmOwlUzJPxE8AgUwx6RVgZ1TydE5okZMaTCTMaZyxILPM5iaVUCRcW9TmdMCKKbMSUDgkVCcmkYoQLQoliNJl3jewWmpH/+PDuLSxHRk1EDtNCh+VwCVcsNuncdg8Y8LN6ZDHzbBfWh4tJSDJ6BgvJDfm14PEZTFszgWh1a4K46nQ+FHkulWEJ+clOYb/TgZJvWSpnhCqG9WOZZVKQnCqaMYPUBgsGxYr9WnDFEksqNE09LvZPRJd0OoJmbL/TIR/twvOECQOrppDozJRr1yCy9c08x/pvRMJjQB4CAF+JHDerAlKh6gdHCLZqDdVAKZboAYczatc/T2lsp6UY0JDh56zZ8UVI5tDxKyakh2AqFf9NCkNTXL5zpgyPaVpfZgAQCdNQhXyUSy6M/+pGID+75YTVxkV0dAigJYDcjAss0Yyc07Rg2kE1C8kUoHrPcsU08oPrFxAvEjJlfDLdOB5NPhXaNDomhQYw61C4sfyqInoZom1MU80IHzdwmdEzVhuNSBRaNI3It3OSsDEtUhMSDhRqVMEi8lYaQvM85TFKJ6ABYDYKMqWLq+zIJ2qSz6GS5zxhIEISPh4zBcwMhdiFa+OhA7rMsQFMDznNTKkgUiwtdCxTqVZJCD838UhiKQwTJiIH55SnCLydrCZcxGmRMDJKaXwWolwNiWKJZfQ5AykdWv7AKiB8Lc4RP0SzFKhQCoBfSDc815WEi8gRMErJf1DoUY2DcF3HquPysYSRAQWeJQnLKE9DRFxIPskRMdykLAQGz6mYhyShhoXEsAszkhchiacsPsO/FE24JKPCGBDsMGaiZJ7ImXC4HEthNP9tDUf6kptjdBCS3ZA8C8mLkPR7IekPQtLfDUn/WUj6L0Iy6IVkMAjJYDckg2cWrMELh2taIrgOQH9gsWy+LuxOecKG0HAIcxtSbZji+gzENfkJ9hwmALjE7rlQsdwm+QR27nIH5JpMeZIwQcZKZkSxmOccpYmVBmXXIcBDFExKaDIu0nROzrnmNRyUncqZALzhiFyRdzkTH/hEEBrHsoA1RgxbpCI6qyUX6RxAPWI00zjz18IwlSuuGYhqoUsMCFPRlt0A4VtdAFxnJUVTAm1ezU2rU1sZ2EF/4BplLmx9utxNZ43dtB+RTqeUc/Dtl19+ORGXJ4KQkwDE3kmwT06CsspJENoy2M2grO9+X8CPp4Pn7uccfj4bvHA/Z1i1v+t+TuHnwDd1zAXfcGCswYWxQzsBS2ogQKXFiVg4aE/EAKdhaJZvmQIUfynw/TYFH2F/CX0BsOAqPBtmbGuszPYpzJYLbjhN9eYJ+xoPaM5LIK2fdlVpZea7MHMUZpunjcUPaM51eKAEN1FbhJturchvBwjFYAuKlvvcJIShFapHK5jci5wOsxmRdgoPBo81cO4LjUtd3hyLzwCLsJ8ewX66GZXllvuA8LkM030hdV2/N8fs8wi1YFRPNuPVVXhAWG1CdF84Xe315hh9ARgFPW8zOqH0AeGyBg4UOKXZlvV2u/297qA32G3gE8wTtkKWdZOkO5/P77YWGRdDCwc0qtXP6MX6ArCagO5YrkRZAhoMF5OyWbN0ddVtvaWFBI3TYQKUTn/+tFovGKVQeV41LuDZv6rlTjz4tz+Q/wjH8JE/obLEqc01e5a3/9TP0EYmdP5I26580/LoBfWXlWMLJhYBHGgLi6eSxw54qOMPXCMw90SAgy4u6k6S7NQWFT4mSTfLuksf4WcXaaD2McuiJImWaq4Qiv2YkSQJyerntd+ThGRZtuGz/d74vJNlq7OIsszB5rDnaW9lnTMueFbAEQnMavaEDhXhlOHQm7m15IJ0Oj///PPP3R9/7L561en4NXRDOCquWTLsCPTinkaoE32ns0/ejEn9E1oTrB0HpUB5MkRzr68wlTPhD0R4bFQkKcCg6Ktaa1JG59gZ42bKVHMcqSqSheMjnLZG0kwj8hFPl/C3P4WVpyU8SX0ToVUYj8abZaer8KXEZyUlmwNvFa2bRVNDtq6oRV4w5ev1JsUmRUoVuwDzn+ZSrMjE2+yBN9vflsSip+XK1IKGRWfaZd7SQR6/c4fwJ6V9cWku0NuB81wQxSbsguTUGKYEdnZOU55Yx0cXP7ALmuVgW9n568lJ8qd/3kHLLhhPjTUpJHzCwSC/89fjg+5/na6pUeQ5UzHVjKQMRtIhYSaOyPGUpXnlE5jNZtHsqY6nUqbWIfBJKza2/w7l6NMQwc0jqvMn62ZqiaFmSQViWTakInPWMEY18S3X2FJxaZBr+j3U4JypYosK52o8IL1jCSQotGZpKD6GrR+VWyBeVv0tQeacBKfVdo/WU5Zc0fb0GuwJ3JDSEUtXi27OWimdy8JxtPcWNKfqKLqGN6cKlQZhnE4vrBXSi6VCW7ZYw6cWIXU29bu9Z0+/AiTlutxIGuist3Y+A/T8CGZ9dCNGfAMyKqn0zlxQAnY9NvAGUly7K4aAegQrlv4aP9oVIzQWZmUnd7qCdzyNy149yvxGXscXtATvbaUmbBnB6QqbR3D+0w0DnIg+miG9+XLL+cTVeECyYgmk7Wx8GynS2Jlvs6XeigH9tOoMuGZ7hap2Yy2ZT2/mvoi8szZ13wjs7XHMctC07syaJcjX3qHQalw3oW+mvHqtB0R9a8D6zBTo6t337nMrIq3P/isi1AbY1yZWa/TP6GSL/QaLHxB51uFZb+JwNVaMVX209NsdZYuFGsu3T7jfa0x4rznhZ71bnLgaw979wNXbgp+VoeBsXaR0ZTtIWMwzmmIICcI9uAOP3ubw5QADHngps7wwdaZDsw4KFq8l+MAI69r9U0i6IemEZCckj0PyJCLvGYZSxGXYhVMauLLBFVyQRBbgJ40Llc7JSMHEQ8KiSUQuL38tqDDczBcL0iGXlxCttVhEwIVnQs5s5MUx+IwNgcip6lCVyFivibSSsd6B09fOWzbrvnLO5R0H2hPyWC6JhK1HUYeCL3sis1DViARGeVuqbPZUiqE+XOcpnRM6Bj+1DQfBZjZqKAIU75MB+dd/I/1B1OuFpGf/Jo/9BAdPkIfRxxSzdJuTEouv4uBenYOrn+tE1l7vWixcH/aWHAxdDDGIAMe9UmGrmPsBmk6qySwba2taPeDM7p96Kos0gd3TBlCyMoCv1OkhAuFQsTFP01oEH/GfPFdDRBRLWeaixlzsHhxoMFqBCyOBc3w4R6czYmMJkQoQQoimQVrF+NnR7ebdiALBwE+pyJRqa2lBXAPMECNppixbipnw4FVxE1x42IGY+/dnExx80yTvZ3sN8t5r7lAbyXsTDW8xFUITnUuhS48gq4pqdId9+u+rh4tlWvKdwnJjyEwV+YNiDEkn5WesLm240F5Pc1AuR8K9nEqpqxouGM1JXr3fDHKTCuLcnkRlcMhdHV/9508basSLL+j4aq5Sb3env7ez1fO15CS5+XGRkOssKdrVr7WkWLNa09YtdBe30N054ul9mmb7zweNE8XTbdvzAzHN1jnqCqPsfZheb3W6XWcDrfPhNa2fX8wKeXey3P0c9pglwf28/wfYY+5Koitml3sjSnJfNpd1lHkNo8tWS8udKbcO7Gen3r37MdAsnXa+aWiD3wzq1Lq3dzdqXTbP1EjuJOD/+e2797PeX76byIODg4O3Hz5OX3+cHBwcZPA7iqK1Rrt1ZIDDgP7srgK5LR7VhQ2jRFGEDntq6D4238nF5F9s+3Bzm8hF5H0mT8Lel/Yk3F1ulFW/zJ61zm3w+STD3XiWuP9ORBAGMscrhlK8SYL9wF5X9Jf3ghCXj2nzrUzmwf5l4C6IwJ8uYB+a7nzScC3yMtDxlGUU/vLLDhcpxzyFrmz4ig7CAIMk4VYlkGWwH8jRJxabIIQwixws40xDH9hu/9LXshfpgtCp/MF+YNkiCAMXelB+IkzEEuK48mQcLPyA27oqv1RdafyjvMkI/cDds1t2g00XSxdJb9VTvYdFhdaqM6oUnQfLd1b9pTMfyuKiibz9Lp37bYUbMKyVN6GwWhAG3LCsPsqGRVPy5piOmYSZYGz3TdvistDsxmNCu3wqxa0auqjU2zT9JEfDW5EjNHbGmTVrfc3VsaWrAzdJ5QAu3rDEK9jd6gZKaK9mRFdRqq+PWKaT+pjWrLYy5tGme6K162nO+EbznFEV4XXNW98cxsvZNI0LvB9diuXGzEpQy5n1F2FwcfVkLkgsu/4SKnmcsrGxsU0klkow9aQeq/pgJjfY3V2Ewfzq6c2/yuk9h8WbXT27n/D2bnWz+Y+A9emLRRhMr4b1+/J+8R8I7O6zRbXHLqkQw5FM5kMvtxZXVfSbGdSD2/FvxDuVMFVDxEjKlFGxggmIrrVHpEegZj4KbUQhXiTkSvuNjMzABq9YzOCKuY+qRVlFnK5j7xj5y1jgWnoNH1BN08VIQy3h+9O2wxEjRvHJhIFJ3tXAxu7iK6OY5kG4OMfKw5Qrds5loT14YKeH3SVlYHq3br8y0rd+jqthpxZJbOce1VcHvsDmipdR3x0dXgOXeMjs2kwA7oIoztL2Qd4dHcJlez526h8EEpeY8KiljSoE1DFyzqm/kFvK9rmNwmLWtipxsg0XRuSuuXfJKkAJ12shCm0eDnCwlpk4VjqusjfAEsnCgEuEu5up2rBcN/CIUJSIPJLFdajyCkxSMinwvoEBlvU37zHutbosz4VN8YHnDRf8XY8Vz5WEfB8VnjxWoFKt/5AwoW1zSsboHAsh+QdgXhVwuii7ZBc5Uxyc0GtRoJhF3bBQa/W1Jg6aN88/vv/B5eyohbR7HvIds4QUOVINckKZEcGv3PLUVxQl4A6mhpsUw1XVA13rzniSM6WlgOOSVBMq+G+WhFEjgdPWiE1paqs6UQFmeYzJB3ptAONl7e9//0cNro2a7ipgdgSaJOAmvQJCPFJaggdNX7EcJKBsQgT9MfXn5U0AoEOmGWYyKRlJX5/GDzGOW5dy0bkYSxenLuIpHCxKeavD8sKrUys1nlHLm/Iyh/myC65N7Ra4v5uzKh/euysbFQyohgBXA82LeZ3BK9erXOoO76vzZj6Ichtc4QVaGDlULOPievtU3Y5nZCkICiMzanhMfFc6amb5sO4lz9dZFXIA1HjOpXqyFjzDM3YkX7od5RWd66uVCmiDmoBrRRI6R4z4NECVisAucq7m5cUq9Fx5TF6hSe+hIIHJDqWI2ZCLITtn6hrqZy12AwAbMTNjTNQx55fQbrZVZoEZpGVorNjSLZwGDgHCjKkJG8ZwgkKeYNdY4k4Huup0SNcC4iS+LpSz+rj8PSjaQMpVvQM4LtNGeQmtUgfqaZMi8r2cAcJCkqcMrkyAhcH2D/gkCLlLPlEfIaYCbwCBwQmyMkDHpZcREktUQ9jIACQlnM0bayCIrdEJeoF8MzBOuG1OXrqXt+so5Izxo/tsGDA5sPgQmkrkdjNdlywDgXqD6UKmuDvi+oFd247jc/hg+ovf//Y/GlQsF1GlI5jCxlIMwKCplvYqVL1Xz2yeHSO0na1wm5CGj+dDKYaVlFtLMM2WWwloTTBHU9ESbo/Awb2+BZQO1AGItnss/E83Rd3y+m4eDBByTwO+lYbtk/dsQlWSlnuaXUaDmbJonZDsUJuoATOIbCA7agyNpwwzjCQsh1xbUpBHsAXbDfhRlZUE1hNMFUwM0YR6HROL27QXtdU8DsDSimbTJAitnTk4XYTBKI5v2yPs5392v3GjDvHToPFtJUPdKI7J41HKAT1UjaTNgPZk36nqNAE+RDVsSWtvLKpFPoqThv7Fa4eU0pyMBmVAog0WWmeM2m6R9Bu8PRtgOrdsBOHJGPiEJx7UBGVllGxatz6beWybrcsF7bSWrq/IFNTv9f4vW7qe9r4eS9du7yuydL0AYJ1z7Wppsun0uVZ2eGfh9gafJLP+h1Sq7TVhB1qEpWtzHYIrdhgs7H+Vcc4L8SsMdtaiVzn7nLHJTwbRMOj14H9LQrCRmRRMD2XW0nT+T0F4fU/j9jWwn8G3uQ1Z304H3+tcZPE0QJ1f66YkX9PkignU8cZFygUbeqQMB73ecC+w+N5dh5wPMmNWu53BbjtTEtQip+YbNSd0Ano6DK/uEVdMqauo6maQbUPCbq837JdI2FtFwhuB93ExWe2RPGPiy860PryxwwOoF1lasXbAbSUsDxqTrX+3k9QsLhQ382D/+DK46NKcd235/vHp4hSozkwl+OBzqRFiaqbBfrCz4pLHbMGgoR5fBmiAC7zI01QkEK62IvZoznfO+1E/WITLbdaKyS31WdG9aRNt6ISLyVXtTiscfYB1tEvVwFSl1+X8LwwUO7cQ9VphwIF+poyCRQZQD+TxvgpkeO0X2YcYrIsaqBZzOQ7AhwE0PPvL29UaX33NVX/s/eTo+i4930E1oaD0TgdBzd8MP2oeZPhZKr3HFTmX7levk/ZRmRvs7qLW87yP6sHTF7jz7j5bnFrk1/wtGKpTdxq4g2rd+u0+Na3BQbBkfW2YQJctoButkRuMkW7IJaOb+7rO1tXf22Rl2ltr3HFdrT/Iu8L6KXH9ic8d+K5/eKudmdasp1cTmqsJ8XKwmk97uJq7PVzNF72GhuLWoOqh0jNQmSh1CTeBSl8ApeAUuIeLsUTWczRXZhIF0Yisu6JXsjSWWZnIs9PxTX7/+z/KVp1OeZ60XiQwDrwrFMnljCnIXg5n+3HKLjC9KTRjGZZptELhfTCagQkBYleEYRObmhzuc4EHx/kIYprTEU85yH57qwatlLXtQ0eQrxXv6M1l8UjZG2vnLIUtozTN1pKwk5lUZ2NI9A7GihHc5ANDBhNTKmLrB7ByDO3ZcI6t8qdqowBqbmGTwigaG5JRQSdokA5JHVkJSzkIe6LkCNxkWqaFdQQZylOprD0WJ4ShZIjE1xc5FKFyDJJDsSlw17nzBunQeuOsiHK5z0fg+MwBFg6WMCNJIVIJacrBgVqkcAfOWKcm6OB1GKG5UVRoUJydCditQYkw56hh2tmcPmoGK/wDF2c2IWuXHJd09RMbaW5YM9/LsoR40mzzHTffFyNIxC01N1LNq9YTbqbFCDebeiflD9vTdz61fW0ruf7lyA/WdqV3Dg7foLLyhPz+t/8mPzCqBJnKmaXWuFAsnVdZ9DHpPK68RVupa6ArkBaQud4gkYqJ9057DP40pQYNmG/ZDCzFlqVseOBhMUp5XL5QoCH71Ev7EEH59kAzP4W9Swb+WUpy2zrl4iwiB2KOHqXKAgffsV1jGuhd3fAqQPkWQAUR+jA0S8+ZrhmkWcKt11vJYmJHqwPjJte8WgdzO0gSki9drwN/SQWOtSChu5laUxLk8l9zI69x7a2ZhZiJBO+B6n2SKDo2Vf/hktUUPdArn/xVPY+O0HVTew4CMOlmXH61puYlNagpb9GEDQPqxiMNNOeOnI49WZJmIqWbk7U9fQpDY1TC/TZOc77Wowi58/W78QemznnMnE64gaN3sPJOEAYpj5k7Crv96+C7wx/I+dOoBxtoqVxeg7l3fnjz8vXbD68BGBCkFmH9qBf10GIntcmoqI3k+OSo0vaWIjbLI0j7Ckj7Ckj7Ckj7Ckj7Ckj7CshDfqeifQWkfQWkfQWkfQWkfQXkD59z+wpI+wpI+wrIw8Bn+wpI+wrIjZMhta+AlAXtKyDtKyAn7Ssg7SsgJ+0rIA8jlWX7Ckj7Csi96HDtKyDtKyDtKyDtKyDtKyBf0eMK7SsgX4IC21dA2ldAbp1msn0FZB1Tta+AtK+AtK+AXDsvbvsKyGfg3vYVkPYVkPYVkG1CqH0FpH0F5GG4hdpXQNpXQNpXQNpXQNpXQNpXQO7VPNO+AtK+AvL/9BWQWqKBnTylHLOZuOy+NhHJ8fLbIKdhMIVMJfvHweUlkOZHlS4W8PnXAhMsHJ+GwTlVHKL5MclJ6HNyQGqDMwbpLF7aqybdIxg/tAuO10mXcrtAUhHb4gBxsLVuPZnK4bsPR5CXwb1fkskEkyPRGaRCoDObr6KWLwG/XQYpFZMCcy0Ets+FTfU6beYgOcMcJO6PWsIGyNVRQdhMTmKnAf/CpNY2uLy0+U0Wi7K+LdrYwiHW14b1O10sFv8LWnKE5g==","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(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdtyG7eSv4Kd2irbPMMRSUu2o63dOortTbwnsVW2vKmspMOAMyAJawaYABhRjIpV5+H8wT7t6/m0fMlWN4C58KarHXl38uCIg1uj0d1odDcal4GhEx3sHwdHLMtTapgOTsMgYTpWPDdcimA/OJoy4ovJS8UofCcHh28ITVM506TQTGliJImhkJG40EZm/Dc6ShkxvuOQzKY8nhLN1DkjVJNRWrBccWE0GUtFJkwwRQ0XE5LIuMgYFMy4mZJcsYSNuWAJ0UYVsSkU0xH5mEtBdBHHTOtxkZYjWTC4FCExU4aAKmYKJTShpBD814KRTsfXHvKk0yFmSg2JqSAjBtNJYDYOIFYDZ0ShTArsWOcs5mMOlV1f0Yk4EUc83ycf81TShMxlocjhq38vu4B+4dtxp/OKjYoJ+fim0zl9PDUm1/s7OzTPI5kzoflEpHSko1hmOwlUzJPxE8AgUwx6RVgZ1TydE5okZMaTCTMaZyxILPM5iaVUCRcW9TmdMCKKbMSUDgkVCcmkYoQLQoliNJl3jewWmpH/+PDuLSxHRk1EDtNCh+VwCVcsNuncdg8Y8LN6ZDHzbBfWh4tJSDJ6BgvJDfm14PEZTFszgWh1a4K46nQ+FHkulWEJ+clOYb/TgZJvWSpnhCqG9WOZZVKQnCqaMYPUBgsGxYr9WnDFEksqNE09LvZPRJd0OoJmbL/TIR/twvOECQOrppDozJRr1yCy9c08x/pvRMJjQB4CAF+JHDerAlKh6gdHCLZqDdVAKZboAYczatc/T2lsp6UY0JDh56zZ8UVI5tDxKyakh2AqFf9NCkNTXL5zpgyPaVpfZgAQCdNQhXyUSy6M/+pGID+75YTVxkV0dAigJYDcjAss0Yyc07Rg2kE1C8kUoHrPcsU08oPrFxAvEjJlfDLdOB5NPhXaNDomhQYw61C4sfyqInoZom1MU80IHzdwmdEzVhuNSBRaNI3It3OSsDEtUhMSDhRqVMEi8lYaQvM85TFKJ6ABYDYKMqWLq+zIJ2qSz6GS5zxhIEISPh4zBcwMhdiFa+OhA7rMsQFMDznNTKkgUiwtdCxTqVZJCD838UhiKQwTJiIH55SnCLydrCZcxGmRMDJKaXwWolwNiWKJZfQ5AykdWv7AKiB8Lc4RP0SzFKhQCoBfSDc815WEi8gRMErJf1DoUY2DcF3HquPysYSRAQWeJQnLKE9DRFxIPskRMdykLAQGz6mYhyShhoXEsAszkhchiacsPsO/FE24JKPCGBDsMGaiZJ7ImXC4HEthNP9tDUf6kptjdBCS3ZA8C8mLkPR7IekPQtLfDUn/WUj6L0Iy6IVkMAjJYDckg2cWrMELh2taIrgOQH9gsWy+LuxOecKG0HAIcxtSbZji+gzENfkJ9hwmALjE7rlQsdwm+QR27nIH5JpMeZIwQcZKZkSxmOccpYmVBmXXIcBDFExKaDIu0nROzrnmNRyUncqZALzhiFyRdzkTH/hEEBrHsoA1RgxbpCI6qyUX6RxAPWI00zjz18IwlSuuGYhqoUsMCFPRlt0A4VtdAFxnJUVTAm1ezU2rU1sZ2EF/4BplLmx9utxNZ43dtB+RTqeUc/Dtl19+ORGXJ4KQkwDE3kmwT06CsspJENoy2M2grO9+X8CPp4Pn7uccfj4bvHA/Z1i1v+t+TuHnwDd1zAXfcGCswYWxQzsBS2ogQKXFiVg4aE/EAKdhaJZvmQIUfynw/TYFH2F/CX0BsOAqPBtmbGuszPYpzJYLbjhN9eYJ+xoPaM5LIK2fdlVpZea7MHMUZpunjcUPaM51eKAEN1FbhJturchvBwjFYAuKlvvcJIShFapHK5jci5wOsxmRdgoPBo81cO4LjUtd3hyLzwCLsJ8ewX66GZXllvuA8LkM030hdV2/N8fs8wi1YFRPNuPVVXhAWG1CdF84Xe315hh9ARgFPW8zOqH0AeGyBg4UOKXZlvV2u/297qA32G3gE8wTtkKWdZOkO5/P77YWGRdDCwc0qtXP6MX6ArCagO5YrkRZAhoMF5OyWbN0ddVtvaWFBI3TYQKUTn/+tFovGKVQeV41LuDZv6rlTjz4tz+Q/wjH8JE/obLEqc01e5a3/9TP0EYmdP5I26580/LoBfWXlWMLJhYBHGgLi6eSxw54qOMPXCMw90SAgy4u6k6S7NQWFT4mSTfLuksf4WcXaaD2McuiJImWaq4Qiv2YkSQJyerntd+ThGRZtuGz/d74vJNlq7OIsszB5rDnaW9lnTMueFbAEQnMavaEDhXhlOHQm7m15IJ0Oj///PPP3R9/7L561en4NXRDOCquWTLsCPTinkaoE32ns0/ejEn9E1oTrB0HpUB5MkRzr68wlTPhD0R4bFQkKcCg6Ktaa1JG59gZ42bKVHMcqSqSheMjnLZG0kwj8hFPl/C3P4WVpyU8SX0ToVUYj8abZaer8KXEZyUlmwNvFa2bRVNDtq6oRV4w5ev1JsUmRUoVuwDzn+ZSrMjE2+yBN9vflsSip+XK1IKGRWfaZd7SQR6/c4fwJ6V9cWku0NuB81wQxSbsguTUGKYEdnZOU55Yx0cXP7ALmuVgW9n568lJ8qd/3kHLLhhPjTUpJHzCwSC/89fjg+5/na6pUeQ5UzHVjKQMRtIhYSaOyPGUpXnlE5jNZtHsqY6nUqbWIfBJKza2/w7l6NMQwc0jqvMn62ZqiaFmSQViWTakInPWMEY18S3X2FJxaZBr+j3U4JypYosK52o8IL1jCSQotGZpKD6GrR+VWyBeVv0tQeacBKfVdo/WU5Zc0fb0GuwJ3JDSEUtXi27OWimdy8JxtPcWNKfqKLqGN6cKlQZhnE4vrBXSi6VCW7ZYw6cWIXU29bu9Z0+/AiTlutxIGuist3Y+A/T8CGZ9dCNGfAMyKqn0zlxQAnY9NvAGUly7K4aAegQrlv4aP9oVIzQWZmUnd7qCdzyNy149yvxGXscXtATvbaUmbBnB6QqbR3D+0w0DnIg+miG9+XLL+cTVeECyYgmk7Wx8GynS2Jlvs6XeigH9tOoMuGZ7hap2Yy2ZT2/mvoi8szZ13wjs7XHMctC07syaJcjX3qHQalw3oW+mvHqtB0R9a8D6zBTo6t337nMrIq3P/isi1AbY1yZWa/TP6GSL/QaLHxB51uFZb+JwNVaMVX209NsdZYuFGsu3T7jfa0x4rznhZ71bnLgaw979wNXbgp+VoeBsXaR0ZTtIWMwzmmIICcI9uAOP3ubw5QADHngps7wwdaZDsw4KFq8l+MAI69r9U0i6IemEZCckj0PyJCLvGYZSxGXYhVMauLLBFVyQRBbgJ40Llc7JSMHEQ8KiSUQuL38tqDDczBcL0iGXlxCttVhEwIVnQs5s5MUx+IwNgcip6lCVyFivibSSsd6B09fOWzbrvnLO5R0H2hPyWC6JhK1HUYeCL3sis1DViARGeVuqbPZUiqE+XOcpnRM6Bj+1DQfBZjZqKAIU75MB+dd/I/1B1OuFpGf/Jo/9BAdPkIfRxxSzdJuTEouv4uBenYOrn+tE1l7vWixcH/aWHAxdDDGIAMe9UmGrmPsBmk6qySwba2taPeDM7p96Kos0gd3TBlCyMoCv1OkhAuFQsTFP01oEH/GfPFdDRBRLWeaixlzsHhxoMFqBCyOBc3w4R6czYmMJkQoQQoimQVrF+NnR7ebdiALBwE+pyJRqa2lBXAPMECNppixbipnw4FVxE1x42IGY+/dnExx80yTvZ3sN8t5r7lAbyXsTDW8xFUITnUuhS48gq4pqdId9+u+rh4tlWvKdwnJjyEwV+YNiDEkn5WesLm240F5Pc1AuR8K9nEqpqxouGM1JXr3fDHKTCuLcnkRlcMhdHV/9508basSLL+j4aq5Sb3env7ez1fO15CS5+XGRkOssKdrVr7WkWLNa09YtdBe30N054ul9mmb7zweNE8XTbdvzAzHN1jnqCqPsfZheb3W6XWcDrfPhNa2fX8wKeXey3P0c9pglwf28/wfYY+5Koitml3sjSnJfNpd1lHkNo8tWS8udKbcO7Gen3r37MdAsnXa+aWiD3wzq1Lq3dzdqXTbP1EjuJOD/+e2797PeX76byIODg4O3Hz5OX3+cHBwcZPA7iqK1Rrt1ZIDDgP7srgK5LR7VhQ2jRFGEDntq6D4238nF5F9s+3Bzm8hF5H0mT8Lel/Yk3F1ulFW/zJ61zm3w+STD3XiWuP9ORBAGMscrhlK8SYL9wF5X9Jf3ghCXj2nzrUzmwf5l4C6IwJ8uYB+a7nzScC3yMtDxlGUU/vLLDhcpxzyFrmz4ig7CAIMk4VYlkGWwH8jRJxabIIQwixws40xDH9hu/9LXshfpgtCp/MF+YNkiCAMXelB+IkzEEuK48mQcLPyA27oqv1RdafyjvMkI/cDds1t2g00XSxdJb9VTvYdFhdaqM6oUnQfLd1b9pTMfyuKiibz9Lp37bYUbMKyVN6GwWhAG3LCsPsqGRVPy5piOmYSZYGz3TdvistDsxmNCu3wqxa0auqjU2zT9JEfDW5EjNHbGmTVrfc3VsaWrAzdJ5QAu3rDEK9jd6gZKaK9mRFdRqq+PWKaT+pjWrLYy5tGme6K162nO+EbznFEV4XXNW98cxsvZNI0LvB9diuXGzEpQy5n1F2FwcfVkLkgsu/4SKnmcsrGxsU0klkow9aQeq/pgJjfY3V2Ewfzq6c2/yuk9h8WbXT27n/D2bnWz+Y+A9emLRRhMr4b1+/J+8R8I7O6zRbXHLqkQw5FM5kMvtxZXVfSbGdSD2/FvxDuVMFVDxEjKlFGxggmIrrVHpEegZj4KbUQhXiTkSvuNjMzABq9YzOCKuY+qRVlFnK5j7xj5y1jgWnoNH1BN08VIQy3h+9O2wxEjRvHJhIFJ3tXAxu7iK6OY5kG4OMfKw5Qrds5loT14YKeH3SVlYHq3br8y0rd+jqthpxZJbOce1VcHvsDmipdR3x0dXgOXeMjs2kwA7oIoztL2Qd4dHcJlez526h8EEpeY8KiljSoE1DFyzqm/kFvK9rmNwmLWtipxsg0XRuSuuXfJKkAJ12shCm0eDnCwlpk4VjqusjfAEsnCgEuEu5up2rBcN/CIUJSIPJLFdajyCkxSMinwvoEBlvU37zHutbosz4VN8YHnDRf8XY8Vz5WEfB8VnjxWoFKt/5AwoW1zSsboHAsh+QdgXhVwuii7ZBc5Uxyc0GtRoJhF3bBQa/W1Jg6aN88/vv/B5eyohbR7HvIds4QUOVINckKZEcGv3PLUVxQl4A6mhpsUw1XVA13rzniSM6WlgOOSVBMq+G+WhFEjgdPWiE1paqs6UQFmeYzJB3ptAONl7e9//0cNro2a7ipgdgSaJOAmvQJCPFJaggdNX7EcJKBsQgT9MfXn5U0AoEOmGWYyKRlJX5/GDzGOW5dy0bkYSxenLuIpHCxKeavD8sKrUys1nlHLm/Iyh/myC65N7Ra4v5uzKh/euysbFQyohgBXA82LeZ3BK9erXOoO76vzZj6Ichtc4QVaGDlULOPievtU3Y5nZCkICiMzanhMfFc6amb5sO4lz9dZFXIA1HjOpXqyFjzDM3YkX7od5RWd66uVCmiDmoBrRRI6R4z4NECVisAucq7m5cUq9Fx5TF6hSe+hIIHJDqWI2ZCLITtn6hrqZy12AwAbMTNjTNQx55fQbrZVZoEZpGVorNjSLZwGDgHCjKkJG8ZwgkKeYNdY4k4Huup0SNcC4iS+LpSz+rj8PSjaQMpVvQM4LtNGeQmtUgfqaZMi8r2cAcJCkqcMrkyAhcH2D/gkCLlLPlEfIaYCbwCBwQmyMkDHpZcREktUQ9jIACQlnM0bayCIrdEJeoF8MzBOuG1OXrqXt+so5Izxo/tsGDA5sPgQmkrkdjNdlywDgXqD6UKmuDvi+oFd247jc/hg+ovf//Y/GlQsF1GlI5jCxlIMwKCplvYqVL1Xz2yeHSO0na1wm5CGj+dDKYaVlFtLMM2WWwloTTBHU9ESbo/Awb2+BZQO1AGItnss/E83Rd3y+m4eDBByTwO+lYbtk/dsQlWSlnuaXUaDmbJonZDsUJuoATOIbCA7agyNpwwzjCQsh1xbUpBHsAXbDfhRlZUE1hNMFUwM0YR6HROL27QXtdU8DsDSimbTJAitnTk4XYTBKI5v2yPs5392v3GjDvHToPFtJUPdKI7J41HKAT1UjaTNgPZk36nqNAE+RDVsSWtvLKpFPoqThv7Fa4eU0pyMBmVAog0WWmeM2m6R9Bu8PRtgOrdsBOHJGPiEJx7UBGVllGxatz6beWybrcsF7bSWrq/IFNTv9f4vW7qe9r4eS9du7yuydL0AYJ1z7Wppsun0uVZ2eGfh9gafJLP+h1Sq7TVhB1qEpWtzHYIrdhgs7H+Vcc4L8SsMdtaiVzn7nLHJTwbRMOj14H9LQrCRmRRMD2XW0nT+T0F4fU/j9jWwn8G3uQ1Z304H3+tcZPE0QJ1f66YkX9PkignU8cZFygUbeqQMB73ecC+w+N5dh5wPMmNWu53BbjtTEtQip+YbNSd0Ano6DK/uEVdMqauo6maQbUPCbq837JdI2FtFwhuB93ExWe2RPGPiy860PryxwwOoF1lasXbAbSUsDxqTrX+3k9QsLhQ382D/+DK46NKcd235/vHp4hSozkwl+OBzqRFiaqbBfrCz4pLHbMGgoR5fBmiAC7zI01QkEK62IvZoznfO+1E/WITLbdaKyS31WdG9aRNt6ISLyVXtTiscfYB1tEvVwFSl1+X8LwwUO7cQ9VphwIF+poyCRQZQD+TxvgpkeO0X2YcYrIsaqBZzOQ7AhwE0PPvL29UaX33NVX/s/eTo+i4930E1oaD0TgdBzd8MP2oeZPhZKr3HFTmX7levk/ZRmRvs7qLW87yP6sHTF7jz7j5bnFrk1/wtGKpTdxq4g2rd+u0+Na3BQbBkfW2YQJctoButkRuMkW7IJaOb+7rO1tXf22Rl2ltr3HFdrT/Iu8L6KXH9ic8d+K5/eKudmdasp1cTmqsJ8XKwmk97uJq7PVzNF72GhuLWoOqh0jNQmSh1CTeBSl8ApeAUuIeLsUTWczRXZhIF0Yisu6JXsjSWWZnIs9PxTX7/+z/KVp1OeZ60XiQwDrwrFMnljCnIXg5n+3HKLjC9KTRjGZZptELhfTCagQkBYleEYRObmhzuc4EHx/kIYprTEU85yH57qwatlLXtQ0eQrxXv6M1l8UjZG2vnLIUtozTN1pKwk5lUZ2NI9A7GihHc5ANDBhNTKmLrB7ByDO3ZcI6t8qdqowBqbmGTwigaG5JRQSdokA5JHVkJSzkIe6LkCNxkWqaFdQQZylOprD0WJ4ShZIjE1xc5FKFyDJJDsSlw17nzBunQeuOsiHK5z0fg+MwBFg6WMCNJIVIJacrBgVqkcAfOWKcm6OB1GKG5UVRoUJydCditQYkw56hh2tmcPmoGK/wDF2c2IWuXHJd09RMbaW5YM9/LsoR40mzzHTffFyNIxC01N1LNq9YTbqbFCDebeiflD9vTdz61fW0ruf7lyA/WdqV3Dg7foLLyhPz+t/8mPzCqBJnKmaXWuFAsnVdZ9DHpPK68RVupa6ArkBaQud4gkYqJ9057DP40pQYNmG/ZDCzFlqVseOBhMUp5XL5QoCH71Ev7EEH59kAzP4W9Swb+WUpy2zrl4iwiB2KOHqXKAgffsV1jGuhd3fAqQPkWQAUR+jA0S8+ZrhmkWcKt11vJYmJHqwPjJte8WgdzO0gSki9drwN/SQWOtSChu5laUxLk8l9zI69x7a2ZhZiJBO+B6n2SKDo2Vf/hktUUPdArn/xVPY+O0HVTew4CMOlmXH61puYlNagpb9GEDQPqxiMNNOeOnI49WZJmIqWbk7U9fQpDY1TC/TZOc77Wowi58/W78QemznnMnE64gaN3sPJOEAYpj5k7Crv96+C7wx/I+dOoBxtoqVxeg7l3fnjz8vXbD68BGBCkFmH9qBf10GIntcmoqI3k+OSo0vaWIjbLI0j7Ckj7Ckj7Ckj7Ckj7Ckj7CshDfqeifQWkfQWkfQWkfQWkfQXkD59z+wpI+wpI+wrIw8Bn+wpI+wrIjZMhta+AlAXtKyDtKyAn7Ssg7SsgJ+0rIA8jlWX7Ckj7Csi96HDtKyDtKyDtKyDtKyDtKyBf0eMK7SsgX4IC21dA2ldAbp1msn0FZB1Tta+AtK+AtK+AXDsvbvsKyGfg3vYVkPYVkPYVkG1CqH0FpH0F5GG4hdpXQNpXQNpXQNpXQNpXQNpXQO7VPNO+AtK+AvL/9BWQWqKBnTylHLOZuOy+NhHJ8fLbIKdhMIVMJfvHweUlkOZHlS4W8PnXAhMsHJ+GwTlVHKL5MclJ6HNyQGqDMwbpLF7aqybdIxg/tAuO10mXcrtAUhHb4gBxsLVuPZnK4bsPR5CXwb1fkskEkyPRGaRCoDObr6KWLwG/XQYpFZMCcy0Ets+FTfU6beYgOcMcJO6PWsIGyNVRQdhMTmKnAf/CpNY2uLy0+U0Wi7K+LdrYwiHW14b1O10sFv8LWnKE5g==",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,f={},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:"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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options": {\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(16078)}),"\n",(0,i.jsx)(u(),{...t(79076)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},16078(e){e.exports=JSON.parse('{"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"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":true}}')},79076(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.073baa5b.js b/assets/js/9cd612ce.073baa5b.js new file mode 100644 index 000000000..5a873efed --- /dev/null +++ b/assets/js/9cd612ce.073baa5b.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4372],{15795(e,t,o){o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>S,default:()=>y,frontMatter:()=>x,metadata:()=>n,toc:()=>h});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),s=o(28453),a=o(57742),i=o.n(a),r=o(78178),d=o.n(r),p=o(19624),c=o.n(p),f=o(96226),m=o.n(f),I=(o(77675),o(19365),o(51107)),u=o(21312);const x={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},S=void 0,b={},h=[];function D(e){const t={p:"p",...(0,s.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)(i(),{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:(0,l.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(d(),{...o(181)}),"\n",(0,l.jsx)(c(),{...o(4311)}),"\n",(0,l.jsx)(m(),{...o(36153)})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(D,{...e})}):D(e)}},181(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},4311(e){e.exports={title:"Body"}},36153(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.0b88ef19.js b/assets/js/9cd612ce.0b88ef19.js deleted file mode 100644 index f5afc4025..000000000 --- a/assets/js/9cd612ce.0b88ef19.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4372],{15795(e,t,o){o.r(t),o.d(t,{assets:()=>I,contentTitle:()=>y,default:()=>Z,frontMatter:()=>b,metadata:()=>i,toc:()=>v});const i=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+zLO1h5xqEMVxXSBV6Zv3DI0gocKEZ+SAbsrUk1jQ0vKX1dyUvGQlIyJqgDIYAaCppcj7YFyLh1igNoCH0zquAEMiz06p1zRryMieopZFzZN0J7OaqQK0YreBt1gSCYHUTPQaSSluPBfTxGMQixBye8kbhEZia29p5rBg1C4R5owoM3MILhBBvLIdgCsgwEDj2ReUYWGljtM3vYv3KRmtwlhuIkprXm10fWZy8NIF7XOtLX4IhYc5bXjawdXA0+jEgF/hcmbuQjkY8EW8GWF1jFhTh7NP+BiyXy0fIf7Uv80bRN00GP6CzQZH1q630XFHVZPG27CoZPlpNb9BghM/OXdjqKGweHl8+pk4q1G5yicQICZOTi7MrFn0FH375L5yj9AYqu2zBmjce9QrmvSnOXFv5Nm1Dy4TSRuBVnPG8BR8vkhioz+B1JenDL78G+B6XoEx3oziU0eiiybTK4QprxxMzjEYpfOmRTVJPA6okQS4NZAihkgylhZIgwbXSWpm7MZyYFTQBPSwVVREMTI9ye2FwXoZyB8hkwAKsiRK9zfHWI6bXAfUCA+vi0ZchYKGIEV1528xba7vOdMF5LJXWcK2KOVKM7aQowHXkZUuOm//WHSz5QlCFK5AeIaChMVw8EImcxjnr2QvVOl9afk1wAdAUzipDIYXCy5K2+pMt0HNOs7LmCVKbQjmkI+nUDCVpb2IX8UAdx+3vQR/fb7ceS/RsMIa9rYtTHZxuelgCo/XPwJqHdVwA87hLYC2VbgfKvx/qiXMdfR3elpfoFyrHbqg9c6Mn8fBEJEKrHE3AnX3h5M3FOSxej6ci2ZmOv+NyT87Pvjz9/vKUneFG2ibscDwdT5nkbKBamh1LX+0+Jx8OtvV2j/pjb89u/hLe08RpqeLyEwNad1vLjRiejun22TlLRGUDMXu95sv1o9ebDZPfN+h5NZolYiG9khmP6Ju1KFTg38Xwrnw2kE9/6J6or+DJF+yTPveLhOEtYiF1w18iEXe42nsvb2abpN8l2K2Wf5Ln6GhH8tFOurfYfXV6fnp1KhLBLXF/jbmLa0z3gw086dj+ftP6wH952XpSYL1uV6TNZjjfsp6V6GLsT3OWZpvN5n/DK+Gk","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 n=o(74848),l=o(28453),s=o(57742),r=o.n(s),a=o(78178),d=o.n(a),p=o(19624),c=o.n(p),f=o(96226),h=o.n(f),m=(o(77675),o(19365),o(51107)),j=o(21312);const b={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"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+zLO1h5xqEMVxXSBV6Zv3DI0gocKEZ+SAbsrUk1jQ0vKX1dyUvGQlIyJqgDIYAaCppcj7YFyLh1igNoCH0zquAEMiz06p1zRryMieopZFzZN0J7OaqQK0YreBt1gSCYHUTPQaSSluPBfTxGMQixBye8kbhEZia29p5rBg1C4R5owoM3MILhBBvLIdgCsgwEDj2ReUYWGljtM3vYv3KRmtwlhuIkprXm10fWZy8NIF7XOtLX4IhYc5bXjawdXA0+jEgF/hcmbuQjkY8EW8GWF1jFhTh7NP+BiyXy0fIf7Uv80bRN00GP6CzQZH1q630XFHVZPG27CoZPlpNb9BghM/OXdjqKGweHl8+pk4q1G5yicQICZOTi7MrFn0FH375L5yj9AYqu2zBmjce9QrmvSnOXFv5Nm1Dy4TSRuBVnPG8BR8vkhioz+B1JenDL78G+B6XoEx3oziU0eiiybTK4QprxxMzjEYpfOmRTVJPA6okQS4NZAihkgylhZIgwbXSWpm7MZyYFTQBPSwVVREMTI9ye2FwXoZyB8hkwAKsiRK9zfHWI6bXAfUCA+vi0ZchYKGIEV1528xba7vOdMF5LJXWcK2KOVKM7aQowHXkZUuOm//WHSz5QlCFK5AeIaChMVw8EImcxjnr2QvVOl9afk1wAdAUzipDIYXCy5K2+pMt0HNOs7LmCVKbQjmkI+nUDCVpb2IX8UAdx+3vQR/fb7ceS/RsMIa9rYtTHZxuelgCo/XPwJqHdVwA87hLYC2VbgfKvx/qiXMdfR3elpfoFyrHbqg9c6Mn8fBEJEKrHE3AnX3h5M3FOSxej6ci2ZmOv+NyT87Pvjz9/vKUneFG2ibscDwdT5nkbKBamh1LX+0+Jx8OtvV2j/pjb89u/hLe08RpqeLyEwNad1vLjRiejun22TlLRGUDMXu95sv1o9ebDZPfN+h5NZolYiG9khmP6Ju1KFTg38Xwrnw2kE9/6J6or+DJF+yTPveLhOEtYiF1w18iEXe42nsvb2abpN8l2K2Wf5Ln6GhH8tFOurfYfXV6fnp1KhLBLXF/jbmLa0z3gw086dj+ftP6wH952XpSYL1uV6TNZjjfsp6V6GLsT3OWZpvN5n/DK+Gk",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,I={},v=[];function u(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,n.jsx)(r(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,n.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(j.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(d(),{...o(181)}),"\n",(0,n.jsx)(c(),{...o(4311)}),"\n",(0,n.jsx)(h(),{...o(36153)})]})}function Z(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},181(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},4311(e){e.exports={title:"Body"}},36153(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.4c8bce3e.js b/assets/js/ac7da374.4c8bce3e.js deleted file mode 100644 index 07d4ba517..000000000 --- a/assets/js/ac7da374.4c8bce3e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2043],{40327(e,t,a){a.r(t),a.d(t,{assets:()=>v,contentTitle:()=>j,default:()=>x,frontMatter:()=>g,metadata:()=>l,toc:()=>f});const l=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":"eJzNV81u48gRfpVKX7Ij0JI8450gPMXZMWaNGDvG2gsD8QhGiyySvW5293YXJQsCgT3kDXLKNY82TxJUk5Qo2TPJIMEiF1usrp+vfrqqeitIlkGk9+IWa6clYRCLROQYMq8cKWtEKm4rhHeokRAGLji/vgTn7UrlGGBjG1grqoAqBLlUWtEGyILH2q4QJASHmSpUBjTIF97WkX2ghClcFiD3HCqAsaCtKdGDQcwxF4mwDr1kXJe5SEUeUQ2gRCKc9LJGQs8+bYWRNYpUDDofFKtQ7JOTVIljRy/fgS0OUAFVkqL1wA4tETqTrMfjL43ymIuUfIOJCLTRbC2o2mkGg09O2xxFWkgdmCGrsJYi3QrauMhJXplSJKKwvpa0p7TtgvUHZ03AwBKv53P+d5SYAWUPCkKTZRhC0Wi9+Z1IRGYNoSGWlM5plcXQzX4OLL59Dsguf8aMOI6eA02qM96ROeLPoeOTjO6m4s9P1WsZ3PfujWiTPjX5OX1Z6PX89ZuT0/nJ/A+3p2/Tsz+m376dzufzv4pEPNWaZfsc5pzgNhGkSO+/22ds0ewBY09pmfnspTDe2BqpUqaENRqCtbemTMBplAGB/AZkKZUBjrT/H0YVvbf+y9H5OmTtyGtltDL4MNTQw9l8/nC6C8LZF2rJWILCNib/bV19yf6XHTp7eLtz6NvnDl2aldQqj53q1j6i+W39GZunzvzzalUdUzwXB86O6Z2TAbPGK9rExvZ0Ip066c7T+wW3C64Uu2+KsRlSJVIxG5rZbDtqhK1glX41tMrGa5GKisiFdDYL0uRL+zS1Dk1QpdFyGaaZrWfSqdnqdHoq2uRYRjr3VfzYnHytSCBZKlP+O7nFPlo3nNEuaQcx26VOOvUX3IhkSMmYq58VFcocfUyfMoWNwn2iPjg0N6o0Mc3R+PFMuUOd2Rp5evBgmUwGkU9/++dOajKB3GZNjYZiQU4/mo/mQ+PB2TX6otEgTQ6Fxie11N3wxTqedcOXLASUtcYQ9AaUISx9nAuqVCQ1cJy4i2TSdeNZYWA2y9IeRlchTOGuQqrQ89HvPU/vHFeaqx9kQ7aWxJoGuLC2/rHQdh0SkLBsgjIYAqCppMmYcUhEAtaDNICG0DuvAkIgz6BVB80a8jIjqKWRJbLuBMaxylErrlbwdtkEgmB1ExEDSaWtxxwGf+K8jjG84BHsEZia2dp5rLhqVghlw6tLApnNEUK8teyCyWGJgcAxFpVhHPuN0TZ7jPnj0QrOchNRUvO6MMbI4uSlCTzQOyxDCnYBc97yjMYO4GTyU0BO8JUyjyGdTD6aE7jfldUdLoMiXHwz3ID1ev2s8l8dyrxX9H2zhB/R2aDI+s1eulRUNct4W8ZKdh+dpvdoMJbP6C7sdeQ2C88vH1NnFWo3u0HiCgmz8+vL2Hdfwadf/w5XKL2Byq67Ys0aj3oD5WCKI9dlvgvbrm1CYWPhVRzxrCs+3rww0BDBu0rSp1//EeAHXIMy/Y1iVyaT62apVbbbW8NkksJ3HuNqN9C6JS+Thve7UEkupZWSIMF10lqZxymcmw00Af1+1WV6lDtwg+OyS3eApQyYgzUHe+V0j4jpdUC9wsC6ePwtETBXvNBR5W1TdtbGYHrnPBZKa7hTeYkUfTvPc3A9ed2ROeAjOFjwhaAKNyA9QkBDU7g+EoknjXPWMwrVgS+s1nbNCUCTO6sMhRRyLwva60/2hZ5xmJU1L5C6EO6X/aRXs0tJdxN7j/dPhI/ck4/6+GG79VigZ4PR7X1enOrL6X4oS+Bq/W/Kmgc2dy2ZxX0Ca6l0N1D+dKwnznb0dfhQ3KBfqQz7ofaZGz2LzDORCK0yNAFHO8P5++srWL2ZzkUymo7/weWeXV1+d/HDzQWD4UbaBex0Op/OmeRsoFqakaWjN9/xaNvut6n/qydiP9gJn2jmtFRxs4qR2vYr0f3uRSgSkY5fh4tEVDYQs2y3fHN/8rptmfxLg553r0UiVtIrueT5f78VuQr8O9+98j4bo29+7B+Mr+DrHpovOjSsL4Z3l5XUDX+JRDzi5ujF2y7aZNhhGHHHcZ5l6Ggk+2wfPlgq311cXdxeiERwKz5cnx7j+tT/YAMvQjvcqzoM/JeXvBcFtttuNWvbHX939FmJ3seBm+O0aNv2X3x179E=","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 s=a(74848),i=a(28453),p=a(57742),n=a.n(p),o=a(78178),d=a.n(o),r=a(19624),m=a.n(r),c=a(96226),h=a.n(c),T=(a(77675),a(19365),a(51107)),u=a(21312);const g={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:"eJzNV81u48gRfpVKX7Ij0JI8450gPMXZMWaNGDvG2gsD8QhGiyySvW5293YXJQsCgT3kDXLKNY82TxJUk5Qo2TPJIMEiF1usrp+vfrqqeitIlkGk9+IWa6clYRCLROQYMq8cKWtEKm4rhHeokRAGLji/vgTn7UrlGGBjG1grqoAqBLlUWtEGyILH2q4QJASHmSpUBjTIF97WkX2ghClcFiD3HCqAsaCtKdGDQcwxF4mwDr1kXJe5SEUeUQ2gRCKc9LJGQs8+bYWRNYpUDDofFKtQ7JOTVIljRy/fgS0OUAFVkqL1wA4tETqTrMfjL43ymIuUfIOJCLTRbC2o2mkGg09O2xxFWkgdmCGrsJYi3QrauMhJXplSJKKwvpa0p7TtgvUHZ03AwBKv53P+d5SYAWUPCkKTZRhC0Wi9+Z1IRGYNoSGWlM5plcXQzX4OLL59Dsguf8aMOI6eA02qM96ROeLPoeOTjO6m4s9P1WsZ3PfujWiTPjX5OX1Z6PX89ZuT0/nJ/A+3p2/Tsz+m376dzufzv4pEPNWaZfsc5pzgNhGkSO+/22ds0ewBY09pmfnspTDe2BqpUqaENRqCtbemTMBplAGB/AZkKZUBjrT/H0YVvbf+y9H5OmTtyGtltDL4MNTQw9l8/nC6C8LZF2rJWILCNib/bV19yf6XHTp7eLtz6NvnDl2aldQqj53q1j6i+W39GZunzvzzalUdUzwXB86O6Z2TAbPGK9rExvZ0Ip066c7T+wW3C64Uu2+KsRlSJVIxG5rZbDtqhK1glX41tMrGa5GKisiFdDYL0uRL+zS1Dk1QpdFyGaaZrWfSqdnqdHoq2uRYRjr3VfzYnHytSCBZKlP+O7nFPlo3nNEuaQcx26VOOvUX3IhkSMmYq58VFcocfUyfMoWNwn2iPjg0N6o0Mc3R+PFMuUOd2Rp5evBgmUwGkU9/++dOajKB3GZNjYZiQU4/mo/mQ+PB2TX6otEgTQ6Fxie11N3wxTqedcOXLASUtcYQ9AaUISx9nAuqVCQ1cJy4i2TSdeNZYWA2y9IeRlchTOGuQqrQ89HvPU/vHFeaqx9kQ7aWxJoGuLC2/rHQdh0SkLBsgjIYAqCppMmYcUhEAtaDNICG0DuvAkIgz6BVB80a8jIjqKWRJbLuBMaxylErrlbwdtkEgmB1ExEDSaWtxxwGf+K8jjG84BHsEZia2dp5rLhqVghlw6tLApnNEUK8teyCyWGJgcAxFpVhHPuN0TZ7jPnj0QrOchNRUvO6MMbI4uSlCTzQOyxDCnYBc97yjMYO4GTyU0BO8JUyjyGdTD6aE7jfldUdLoMiXHwz3ID1ev2s8l8dyrxX9H2zhB/R2aDI+s1eulRUNct4W8ZKdh+dpvdoMJbP6C7sdeQ2C88vH1NnFWo3u0HiCgmz8+vL2Hdfwadf/w5XKL2Byq67Ys0aj3oD5WCKI9dlvgvbrm1CYWPhVRzxrCs+3rww0BDBu0rSp1//EeAHXIMy/Y1iVyaT62apVbbbW8NkksJ3HuNqN9C6JS+Thve7UEkupZWSIMF10lqZxymcmw00Af1+1WV6lDtwg+OyS3eApQyYgzUHe+V0j4jpdUC9wsC6ePwtETBXvNBR5W1TdtbGYHrnPBZKa7hTeYkUfTvPc3A9ed2ROeAjOFjwhaAKNyA9QkBDU7g+EoknjXPWMwrVgS+s1nbNCUCTO6sMhRRyLwva60/2hZ5xmJU1L5C6EO6X/aRXs0tJdxN7j/dPhI/ck4/6+GG79VigZ4PR7X1enOrL6X4oS+Bq/W/Kmgc2dy2ZxX0Ca6l0N1D+dKwnznb0dfhQ3KBfqQz7ofaZGz2LzDORCK0yNAFHO8P5++srWL2ZzkUymo7/weWeXV1+d/HDzQWD4UbaBex0Op/OmeRsoFqakaWjN9/xaNvut6n/qydiP9gJn2jmtFRxs4qR2vYr0f3uRSgSkY5fh4tEVDYQs2y3fHN/8rptmfxLg553r0UiVtIrueT5f78VuQr8O9+98j4bo29+7B+Mr+DrHpovOjSsL4Z3l5XUDX+JRDzi5ujF2y7aZNhhGHHHcZ5l6Ggk+2wfPlgq311cXdxeiERwKz5cnx7j+tT/YAMvQjvcqzoM/JeXvBcFtttuNWvbHX939FmJ3seBm+O0aNv2X3x179E=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,v={},f=[];function y(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(T.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,s.jsx)(n(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.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,s.jsx)(T.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...a(67822)}),"\n",(0,s.jsx)(m(),{...a(37212)}),"\n",(0,s.jsx)(h(),{...a(5350)})]})}function x(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}},67822(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},37212(e){e.exports={title:"Body"}},5350(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.a547ee47.js b/assets/js/ac7da374.a547ee47.js new file mode 100644 index 000000000..498771b61 --- /dev/null +++ b/assets/js/ac7da374.a547ee47.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2043],{40327(e,t,a){a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>x,frontMatter:()=>g,metadata:()=>i,toc:()=>S});const i=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=a(74848),s=a(28453),p=a(57742),n=a.n(p),o=a(78178),d=a.n(o),r=a(19624),m=a.n(r),c=a(96226),v=a.n(c),u=(a(77675),a(19365),a(51107)),f=a(21312);const g={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},h=void 0,y={},S=[];function T(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:(0,l.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(d(),{...a(67822)}),"\n",(0,l.jsx)(m(),{...a(37212)}),"\n",(0,l.jsx)(v(),{...a(5350)})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(T,{...e})}):T(e)}},67822(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},37212(e){e.exports={title:"Body"}},5350(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.5e2aac96.js b/assets/js/b2e6bd40.26dcf7b4.js similarity index 70% rename from assets/js/b2e6bd40.5e2aac96.js rename to assets/js/b2e6bd40.26dcf7b4.js index 0eb5491d3..b9f57c4b2 100644 --- a/assets/js/b2e6bd40.5e2aac96.js +++ b/assets/js/b2e6bd40.26dcf7b4.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7960],{99088(e,t,s){s.r(t),s.d(t,{assets:()=>b,contentTitle:()=>v,default:()=>f,frontMatter:()=>h,metadata:()=>n,toc:()=>j});const n=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+EJIQd2TtukmR30DdmO4rTDCt9HhmUXgUOBKUs+l7Oma++GXNay1fSilXrsMOCyCEwqdA1QVVzltbJtBRunhClB5tMYKh+C8JadFck0rbykvNVd8GSsmG2YACpR0gRxYvQjOg9MypLx7LqS2WEAbD1WBixi+ejS0BCQlvm+xos61QlgGUaDLINcFgovtgEJQBSzok8eQLyLH+FEclNT5Q8wfkSkwmkYX3Qhd7vlI6t5y5WjiJl/aFHSAxRvkHCYHR6PvHFKC3wj14GajEXGMu66sbnHhhMf737ddeL1eP+m+X+3rvBb+m7CAd2i0E17bTa+9FL4Ki9ixh0a6f5Kl16gwls+gH/c2Cp27pwOApJMKpZlco6cKcZPzq8s47b+CDz/+E94gtwoqvU7FmgeLcgPL9ihCLmU+wdYN6/ieQ22DEM9T8TXdrkXwtuL+w48/OfgW10S10o2iUEajq7CQIocbrI3kHt1oNIMLi3Skb2XgK+4h5woWCK7iVEorwYGDSdpSqIcxnKtN4kVd7yN51NsLI/bbNt0OFtxhAVpFjfbMce8RyWuHcoWObBHpWiBgIaib+8rqsEynDZ1pgrNYCinhVhRL9DG286Ig1hnF6yQmwAfuYEkXwle4AW5jC/RjuDpQiSvBGG3JC5Gc7z/tURVGC+XdDArLS9/bz/pCzwnm2HmfiBKEvIMja8x0KUk3sYm4k6aHqAMusd9uLZZo6cAYdp8XI5pyumvLEqhav6SsaR40wyQy0YZgcCO+PrQTGSXa2r0tr9GuRI4NsfqFGz2JmycsY1LkqBwOmOr566s3sPrDeMqyAUP7FZd78uby4tW316/IGWqkCbDn4+l4SiIiqzVXg5OOvLIejrfBG+m/+SjbUMH4qGQkF5F9x7i2DXG+G3ya00tqRax6dse2W7pa3xFTIPEPAS1R8vuMtS9PkZBnLYckpv2ARMouks8nN3Q2bZch0dGD7xAiwUnjPM/R+I/uHRL/q7fXNyxj7bNbrYv4wsDX9MbM1+l7WkcM05c+ybZMcrUMfEl7k02ivdT79jnzQ+TMzQ+Kql1Sm4GH+2Q6hUF/KaijCttt4uORxKb9aekXNRpg292Uu/vdbvcv+2GN/Q==","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":"Get Signer IPs","permalink":"/docs/API-docs/v1.1/getsignerips"}}');var i=s(74848),r=s(28453),a=s(57742),o=s.n(a),d=s(78178),l=s.n(d),p=s(19624),c=s.n(p),u=s(96226),m=s.n(u),q=(s(77675),s(19365),s(51107)),g=s(21312);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:"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+EJIQd2TtukmR30DdmO4rTDCt9HhmUXgUOBKUs+l7Oma++GXNay1fSilXrsMOCyCEwqdA1QVVzltbJtBRunhClB5tMYKh+C8JadFck0rbykvNVd8GSsmG2YACpR0gRxYvQjOg9MypLx7LqS2WEAbD1WBixi+ejS0BCQlvm+xos61QlgGUaDLINcFgovtgEJQBSzok8eQLyLH+FEclNT5Q8wfkSkwmkYX3Qhd7vlI6t5y5WjiJl/aFHSAxRvkHCYHR6PvHFKC3wj14GajEXGMu66sbnHhhMf737ddeL1eP+m+X+3rvBb+m7CAd2i0E17bTa+9FL4Ki9ixh0a6f5Kl16gwls+gH/c2Cp27pwOApJMKpZlco6cKcZPzq8s47b+CDz/+E94gtwoqvU7FmgeLcgPL9ihCLmU+wdYN6/ieQ22DEM9T8TXdrkXwtuL+w48/OfgW10S10o2iUEajq7CQIocbrI3kHt1oNIMLi3Skb2XgK+4h5woWCK7iVEorwYGDSdpSqIcxnKtN4kVd7yN51NsLI/bbNt0OFtxhAVpFjfbMce8RyWuHcoWObBHpWiBgIaib+8rqsEynDZ1pgrNYCinhVhRL9DG286Ig1hnF6yQmwAfuYEkXwle4AW5jC/RjuDpQiSvBGG3JC5Gc7z/tURVGC+XdDArLS9/bz/pCzwnm2HmfiBKEvIMja8x0KUk3sYm4k6aHqAMusd9uLZZo6cAYdp8XI5pyumvLEqhav6SsaR40wyQy0YZgcCO+PrQTGSXa2r0tr9GuRI4NsfqFGz2JmycsY1LkqBwOmOr566s3sPrDeMqyAUP7FZd78uby4tW316/IGWqkCbDn4+l4SiIiqzVXg5OOvLIejrfBG+m/+SjbUMH4qGQkF5F9x7i2DXG+G3ya00tqRax6dse2W7pa3xFTIPEPAS1R8vuMtS9PkZBnLYckpv2ARMouks8nN3Q2bZch0dGD7xAiwUnjPM/R+I/uHRL/q7fXNyxj7bNbrYv4wsDX9MbM1+l7WkcM05c+ybZMcrUMfEl7k02ivdT79jnzQ+TMzQ+Kql1Sm4GH+2Q6hUF/KaijCttt4uORxKb9aekXNRpg292Uu/vdbvcv+2GN/Q==",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,b={},j=[];function y(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)(o(),{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:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(c(),{...s(36467)}),"\n",(0,i.jsx)(m(),{...s(62229)})]})}function f(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}},36467(e){e.exports=JSON.parse('{"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":true}}')},62229(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7960],{99088(e,t,s){s.r(t),s.d(t,{assets:()=>j,contentTitle:()=>h,default:()=>I,frontMatter:()=>v,metadata:()=>n,toc:()=>f});const n=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":"Get Signer IPs","permalink":"/docs/API-docs/v1.1/getsignerips"}}');var i=s(74848),r=s(28453),o=s(57742),a=s.n(o),d=s(78178),p=s.n(d),l=s(19624),u=s.n(l),c=s(96226),m=s.n(c),q=(s(77675),s(19365),s(51107)),g=s(21312);const v={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},h=void 0,j={},f=[];function P(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:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{parameters:void 0}),"\n",(0,i.jsx)(u(),{...s(36467)}),"\n",(0,i.jsx)(m(),{...s(62229)})]})}function I(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(P,{...e})}):P(e)}},36467(e){e.exports=JSON.parse('{"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":true}}')},62229(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.cf8e6065.js b/assets/js/b93339ed.acc67002.js similarity index 58% rename from assets/js/b93339ed.cf8e6065.js rename to assets/js/b93339ed.acc67002.js index 9db34c6e0..c9f776a81 100644 --- a/assets/js/b93339ed.cf8e6065.js +++ b/assets/js/b93339ed.acc67002.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8749],{33727(e,t,o){o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>v,default:()=>j,frontMatter:()=>w,metadata:()=>s,toc:()=>y});const s=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/dYicChwLSl/gLdeN9yTpgEubLS9K2nSSoBD1jqh0DlAVXOV08HBowloC1wBKo/WWOEQnLcEWkRoWnnLcw8NV7xC0p3AlKsCpaCwB6uz1nlwWrYBMXgupLZYwGCPQixc4PANzU0WgVZz3RiLNYXfGqFqRYEugVwXCC7EA5mgCsjQeTCEReTowvCopM7vgv/KVkowmsqQ4JKGuClGEveWK0eVMmIZXDASZqymIQAjwNnsk0Ny8Duh7lw6m31WR3AzhtU1Zk54XH0zpNJms3mUQq8OZd4K/0ObwUc02gmv7XYvXQlft1lIu6mS8UvU9BYVhvCZJNVeR6Fz9ziLaXVRozSLS/QUIW5xdnF+RaKv4Msvf4d3yK2CWm9isOatRbmFariKmIuej7SNhRdKHQKvJsbzGHz93DoweF1z/+WXfzh4jxsQqs8oMmU2u2gzKXK4wsZQ13WzWQqv4/jqhzXwNfeQcwUZgqs5hdJacOBgorQU6m4OZ2oLrUMLG+HrEAy0HuQOzCBeRnc7yLjDArQKEsOd8z0iWm8cyjU60kUNNEPAQniK6Nrqtoq3TcH0xlkshZRwLYoKfbDtrCjA9MubuEyET+BgSQnha9wCtwgOlZ/DxQORsNMaoy2hEBF8qelJRQ5AVRgtlHcpFJaXfq8/2Qd6eCUIrZ5YihTykY6kVzO6JGZib/G4Ov9Mxf1BQzgstxZLtHRhMHvvFyP6cLoZwhIoWv+bsKZ+QFWL52EiwYYLGTvTHx/qCdMB2sZ9KC/RrkWOfXf8SkYvwuEFS5gUOSqHk6nj7O3FO1h/O1+yZNJm/4PkXrw7f/3m/eUbAkOFNBJ2PF/Ol+FtpJ1vuJrcdPCmftjYdvtp7Fd5gPd93uO9XxjJRZiwgr27fjoanpAsYen+7b1KWK2dp+3djnLvk5VdR8s/t2hp/lolbM2t4Bl18JsdK4Sjz8X4uP6qnd987N+vr+DJZ/yTmIeBRdG0suayDU/JhN3h9uBHg27VJcPMQrDi/ut4+dEVadnLPxp/aeiKEmd5jsY/e3Y6b158umIJy/qfAJrwIwOzfEO/SvBNhKoDF2EaC2s7JrmqWl7R2aiSpiyq0ocj2l0Y0foPZNSTZBzObtEK+ks2PSmw28Xxr+vG83HrqxI9r8Np8syq67p/Adn3b0U=","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),a=o(57742),l=o.n(a),i=o(78178),r=o.n(i),p=o(19624),u=o.n(p),m=o(96226),c=o.n(m),f=(o(77675),o(19365),o(51107)),h=o(21312);const w={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/dYicChwLSl/gLdeN9yTpgEubLS9K2nSSoBD1jqh0DlAVXOV08HBowloC1wBKo/WWOEQnLcEWkRoWnnLcw8NV7xC0p3AlKsCpaCwB6uz1nlwWrYBMXgupLZYwGCPQixc4PANzU0WgVZz3RiLNYXfGqFqRYEugVwXCC7EA5mgCsjQeTCEReTowvCopM7vgv/KVkowmsqQ4JKGuClGEveWK0eVMmIZXDASZqymIQAjwNnsk0Ny8Duh7lw6m31WR3AzhtU1Zk54XH0zpNJms3mUQq8OZd4K/0ObwUc02gmv7XYvXQlft1lIu6mS8UvU9BYVhvCZJNVeR6Fz9ziLaXVRozSLS/QUIW5xdnF+RaKv4Msvf4d3yK2CWm9isOatRbmFariKmIuej7SNhRdKHQKvJsbzGHz93DoweF1z/+WXfzh4jxsQqs8oMmU2u2gzKXK4wsZQ13WzWQqv4/jqhzXwNfeQcwUZgqs5hdJacOBgorQU6m4OZ2oLrUMLG+HrEAy0HuQOzCBeRnc7yLjDArQKEsOd8z0iWm8cyjU60kUNNEPAQniK6Nrqtoq3TcH0xlkshZRwLYoKfbDtrCjA9MubuEyET+BgSQnha9wCtwgOlZ/DxQORsNMaoy2hEBF8qelJRQ5AVRgtlHcpFJaXfq8/2Qd6eCUIrZ5YihTykY6kVzO6JGZib/G4Ov9Mxf1BQzgstxZLtHRhMHvvFyP6cLoZwhIoWv+bsKZ+QFWL52EiwYYLGTvTHx/qCdMB2sZ9KC/RrkWOfXf8SkYvwuEFS5gUOSqHk6nj7O3FO1h/O1+yZNJm/4PkXrw7f/3m/eUbAkOFNBJ2PF/Ol+FtpJ1vuJrcdPCmftjYdvtp7Fd5gPd93uO9XxjJRZiwgr27fjoanpAsYen+7b1KWK2dp+3djnLvk5VdR8s/t2hp/lolbM2t4Bl18JsdK4Sjz8X4uP6qnd987N+vr+DJZ/yTmIeBRdG0suayDU/JhN3h9uBHg27VJcPMQrDi/ut4+dEVadnLPxp/aeiKEmd5jsY/e3Y6b158umIJy/qfAJrwIwOzfEO/SvBNhKoDF2EaC2s7JrmqWl7R2aiSpiyq0ocj2l0Y0foPZNSTZBzObtEK+ks2PSmw28Xxr+vG83HrqxI9r8Np8syq67p/Adn3b0U=",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,g={},y=[];function K(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)(l(),{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:(0,d.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,d.jsx)(r(),{...o(38459)}),"\n",(0,d.jsx)(u(),{...o(38697)}),"\n",(0,d.jsx)(c(),{...o(77151)})]})}function j(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(K,{...e})}):K(e)}},38459(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},38697(e){e.exports=JSON.parse('{"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"}}}}}')},77151(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8749],{33727(e,t,o){o.r(t),o.d(t,{assets:()=>w,contentTitle:()=>j,default:()=>b,frontMatter:()=>h,metadata:()=>a,toc:()=>P});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 s=o(74848),n=o(28453),d=o(57742),i=o.n(d),l=o(78178),r=o.n(l),p=o(19624),c=o.n(p),u=o(96226),m=o.n(u),f=(o(77675),o(19365),o(51107)),I=o(21312);const h={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},j=void 0,w={},P=[];function y(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,s.jsx)(i(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,s.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(I.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(r(),{...o(38459)}),"\n",(0,s.jsx)(c(),{...o(38697)}),"\n",(0,s.jsx)(m(),{...o(77151)})]})}function b(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}},38459(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},38697(e){e.exports=JSON.parse('{"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"}}}}}')},77151(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.52cdc692.js b/assets/js/c195e1f1.52cdc692.js new file mode 100644 index 000000000..f0dbe1107 --- /dev/null +++ b/assets/js/c195e1f1.52cdc692.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6192],{35342(e,t,n){n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>x,default:()=>v,frontMatter:()=>g,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtu3DiWv8LVS5KCXL500rtrZIPxdDLdwaQ7RuJsENhGNSWdKjGhSA1JVbnGMDAP8wf7tK/zaf0li3NISVS5qpzKpKdnd90I2jbFy7nx8NzI68TxmU2Oz5PnOm8qUM4ml2lSgM2NqJ3QKjlOzkpg3xngDljbi02NrpiDqpbYfHL6knEp9cKypW6Y02wGCgx+UrBgRTs3y5bsY2Mdq42ei0KoWTfHRBRMKOuAF0xPWVNLzakDpymmQsJDoZgrgU21qbBPxi18+5hpwzKhuFk+YjAHs2ROVEBwKIACgck98LwDZMzOwrIWZ2MGauxRyCVrLBS0mmU5VyyDMLrwKDcWDBPKgZnyHBh37Hw0eg5ZM2PvXo5Glw9L52p7vL/P63qsa1BWzJTkmR3nutovsGNdTB8h0I0l/HvinkXkHF+oC/VBNwSEpxawAqa8kY7NuWyIDEh0thDFDJC2HEHXRCNhmOIVDL7bpq61cQyucqgdQ8C4awykzDpe1SkTSjjBpU2ZqPgMCITRqBQFTBxcuclCuHLCrQMj7Cd7PBqx9yUoBopnEoqUUMGOAQZaAYqO6ExYVoqiAOVJaSAXtSCx8KTopk5Z1jhmoOJCWTZtpFyyubAik4DsxLm7SfVCEUcC1q9rUG/FTDGe57ohTpfCMk2yjBDwORcSAWZaySWCega8soyrgr1AvtZGWGC15Mp2FFAOsX1bQy6mS1of24gDgbphnZobXoFDiNpFuaS5hWVKO8brWoqcR5hMNW4cxD9MdczyEvJPmb5KmeGF0EgNp1XKCqPrQi8UwXU4ZqMRkkiORhfq559/vlDXF4qxiwQ5f5Ecs4uEPl8kqW83wAtEGr9NubQQ2oNYRUN+B1e8qiWg0HbDEWXf5zTI43D6TYLSLXehbgKgF+oIoUdANwPvf9sF9o8atkA7mG8nYL9BYD/qjJ0JJ7dAjF0cdtkN7Bz0FrBvT7oT7I8R9lxXNVfLzZCHDjuKihcSVs8dk67YgsPq9Dth8AQxKLjbQnj8uhvsh4d7B0/2jg6OnnTjKqEmfiLs0Dfzq3XNqNyEmnWf4pVuE8D36rHaY6NRux6qFtZ2RI1QCSWqBhWkdUbkpLmwI+oYPxWr8BDNAPXeaPThw4cPez/+uPf8+WhEhyN347BEgB2XGKzAr77SCjEZRqNj9nLK4iZUexYc6TrTQNqdC6jvug6lXqhWHdKhYVjRGOwSuo4ZHoUVX9JkIFwJZriONu3p6A8P1LWZduWYvaOzBX9vdXA4CKEgPfotihfKYqavNktY6LCbkFVLOg+3bIyVzzvsin+lfR0Oii0bO/TYBfDzi8QfXXtHF8nlUGhDNxSo1jop+RwPU+JBpQ1KGFfU4O0UV3JHpphFHmfALEjI0aLKli3TiBP/Rhs9nHFbNnvosRsvPEaH8Sa8UP+OK8Zn7OZVqddXWPLwgE6+psrAbDn76Psuyx2EJtydjeQr2qqAXFRc1pLnQPJ0tPmYHC69g1Cy8N+FOiTjJAcp7RbRxM93ooi9JmTK4Zcn6+i8Zn99PvhsKN/9cqsWn6cL+h0EuBdrW+pGFijUBlxjlPc3sDs6CsF+NGBrrewtLRxtjzCPAeIQfYUrYR2qrnZ4mO3UwFRIyd4Ha5Em9U2tpc8NMJDgXS6aH1uEsoBaD90XHTlDbDTKYKoNjEZMOK+QuYGCIcUY95iw12gtDyxv8ou0YSW3rAZTCWvxHMG5iwK7VgHiV8I6pNuKI0KQtLCjmBzerYnXKWJPHfrIVWFgwTIYHLZHOxsQ3ZTsIjl4vH/4ZP/o4OhxPOc3X6x++7nP0bgguw73LfjfV/RtLDs/hiM5L7VtnaiBpJBAWRLRsC7qV6E8pb175l3McWca7qD9Qq8NdPLgfxXo49U2YtBrGzIQyWXdjAB9Xi804j9///rN4uCP38/0ycnJyU9v35Uv3s1OTk4q/Hs8HgeswtTffvEpFVOrZfdXoVe71mZaXagkTXSNIRmh1csiOU5CWCPsZtzrbXdRJGnSebIYHbomxJLjJIrWJGkiMDpUc1cmqyEjnX2E3L2kUE4b1kjSxMCfGmGgSI7JGkysW0qc1gp0JJI0gata6gKSY38EJDYvoeLJ8XXiljX1dGgXJmnirdC4JbgjCNIPh1mZH5V1ltzcXPplwbrf62KJU+VaOVAOfw3uOEK9/9Ei6NfRmj2454m3Syk6FkDxOCKpDFLWCbAEKPpqu0L8UxQl897eLZKeqD6g0IcZrD+h2kgSDaW4BB1ZsJDLLn7VB79eTpmuhHN90MZz6Je//LcNUyzwPMnAh8MGdlpyk3bE6LHkxvAlioSDKm7fQCSj19Oop8gJxm+c4srhghRp2EpU6hBP8FFDHMbAWbwQb1v1owY8PbBzXWp1R+/Do2/w3zeH2D/4uLtyvo0R4hQfdTb5IvEpYI7jwwH75Wy5m0Dh+J0Qyq3NFg3JtJbAVTyGtvJN2tps2+cPLlOmr5Kbm7TdTCvKKtJCk7deFCct7jc7DaNFploWYFApboOM5B5UMVmVxR7l1bD5ICA4jI+HfcsWJZAzi80LrpyPqfWekiLfOey34J4PosDCondqGrhIaGP3hqXGP1Zjkm1fikkqzR7QehPbkEA82A9/Z7pYPuhHepPSwyxQlQQQqHOnPuxAa5CJEQCaCpAUAg1qB13FENQuGMfgK4Oqdst9oeZcisJjMFROPb5h9pg7iFSrJlpk1rFzyKHvGut0xQiJMIh0ZxcaZ+HkGLPvuGJC5bIJtnsftWXX162A+c17c8Our1FSwExwQ93cpH0DrjVoIDXjWwzkIOaDUV0T9AO7tmgoXNXCLCkU4huCNooBCOGSxoR5lMbO44GQrwBOtn2gARSd7GJ8/TbWnZ4m6fls6t8idpAqnOT/Dd2f1s9+EGtAebpfP3taP3sPrNQ1+P3syTMVqvDaZAFSjtlT64xWs2crJHi6H9rXs9LAXMCClAFxtZ9llbbdROMA0wfdxDtFWJabJhdc4ry10Tm0LqQ3Ra4csw5qi/td+PQTKhPCwTA+M0AOK8HCG1dqI/5Mhlm74FPOSgPT/3iwQtMHzyjhU4KBp/v8Wej9cko4UnCKqyUjxIVWFnUPJQanjSHVm0tuxDRYgSmrJXCLIWvleO58TJIo2sJxVnL1yaZPM/MMU0ddyumXv/4Ne7TnxEv12hRgPuOgGI1QfY1GbK/3sqfCWNcGQ4NU2C5Aum6/hOydXI7ZC56XqNAsdlDdND786TW4UMx/zSH1mTA+xSMCV6hRKnRj23EoOSjXElByfJ6tC8zSKSc8aO2xkEHJ50K38Q8yAAi9Eynbs6xFaitOVlSNdFyBbqxc/hYnCuaSz/R3AfvnfBlbUT4kdIuflH/GtHMYxQq+tO0y9IHLvCEIvP7wkXA99VthYKfTju+QrQ2QSRD8u5ZYqCpT3FR6DsaIIkjKEM8Us+MKDQ7VhuQPNrsCK7SJ7c8O645Wh09Q9VMa+PXZ6W4S76L0LJkPfh72+uyUzaHfmBjIR7GhPq3s8EEXlusC2FxwLz0pW5QiJ/Wz9OkMUCTi4QSLg1noIQ9F9TZghbBrIUu9aYdnUkMgrluAFcJA7uSSVKJuHAbJRHDnSC/+Q6W7tck9sc90s6Oe2sQ1zmYNAelQkltbCoxNo5IPLPMwTe61cUj0xHkhOjysvc2TlgPYOVonZaCsn4azKYV4U9YoqtIwTY30a6eGqxqMQK33m5A7Oprvto/Q1qciDu2hrMFYrRA2bWZchdMRKxgWGCIirSt913AiWJYBZdH+IdqkpRLz+LCHGIZ/9NkqJvBDaVeSkFDikOAgAWus5zvVe1CgojYwBYO8tJ3ns/YrOS9cWu2zf/Gs7YnlNCUNVtjWOee//PVvSc++jcGI2/zzjOBFYcDaOxhJgXqvQTCthrmAJXP6nnFfwDgkO5jfrRZgIRNJWU8qXXQK3O6m+04x1+FsZ8iEhEeXcLFNXqLW6IwaG5dWUa2VTZH7Xa2UrlE0usBumycRd51Rb0L6voeFosR4sqAuVMv4kOkTQnpl2nUmHLH4N9GRWHt39+Zq6wHqKJ8W6gFBoR1QsNPnf6BCPu/nrEmsYXwvsmv88FsxH944PTFQCfV51vzbvtwBf7YHY+N0xZ3IWTuVHbPQ1echnY7Pt4o9XLWmH3Wb5VfgxTpOeEgnWuUwEWpCxZV3W78/dXlSMnszcAsAFaPdypt3O/qCONJJA3KvlI+M2T+XSdxRDO3fCswMJjkGU0mxwG5ahYgSTCnbmJAXxvWDG0EGbj87whECI12+p3fSUPb7Df6DXiDzOt8WIxB+fuQtI8gDsvEKOVdURoMOMIYCuyJYX0IkVL/EqmYK3ndeau3XQ9rSOuk2nNr44UCYu9XbgtJuY3OpSV2GGMNKvelvfjAROTZoOXLElxOtJv0x8Rlh9K0CtCY3P/SWVLBHfBQgOE0o/SgdSGjv7+MPOzwjVvm7eTEkyFda8Cft4Ji9gRk3hezsJ89GVOAp47Eg+aU2SQPFlTaIHXeO5yWQPimgBkVl1A/6aH8UCg8ZMAPeocMQ1N2n1dsQOfdIvnvzColg+tgHmE7024mhYE1NPq0HOfhIHTq3nKV/civx1rlag5rkWurPSiMGut5Ek5wnmWx8Uhlz0Znk+afk8iZNsjz/0hnR+h4kDVNqOhq03bofkeU5e5hJgQLGTUZMq5ePjkPEgheoyYjfK8GLwbbw4ksKecBoEQXfxsEc+zXYvM6AYEQ99vD88pFfep3BsUYq7rD6kPu+7OfulOSvltPclk/tUpBpV7ax6xR9KRKmJG+2pCUncV6SUifUeVgrEUFCWB0dHOCPoSA+H2hkDHs0OSoHukHxL0n6+ZUP20naVnfsSpPyozj681U+PzptiwiG2nNHzt5dFLAuwbxyvQEh2aDDt6ISrvk0Ru45vYe47HWHF00b8VsoKRRMWgZOCp1PWuxvyHS0ls92FrGO3bT/h7y+Y/nEC+TjdVIUZU7UA4pT9oWFIU+Eag31TbvDMaWiXeeMtV2G9pkwDMs+aCSJ+VeTRzBGm12pd+ptYQuuqXtM/MR3UfDxwcEk74n4ZA0Rg+eFN+PO9CdQX3H7bUS3Ry5e3vnlEdSrSvYqMQneIX1PBtjG7R5JC3ljhFtSMdjVHq/Fnv9+fH6JJVYVuFJjWVmtLUGMVWHHyf5Q1e1fR7ruJsFpzbwtMaNd2G0sy1WR6avbd+h4Lfbnh2MsQFkds/bO3Zb+0OztOsQ6PhNqdte4y55ib5GrnnEDuvVarxZ/BNwNgS1xr1BjVwLH4AMyAoXlTV/P9qJleVd4tr6WrKvYOm+Lr+IKq67A6lbVVAdVWxnVFUZF1U9R8VNfzzQoZ6IKpahAKa4obAuK4nqiztkJJUODuiASuL5oJ0mGhTm+tHClFOTvq2wYFjbcZ+v/D2XrV5L1XnjWZX0PnwxynEFC4wRaW7MaJ3kGKYTVDMLGMPWGKHVYwEdIUexXYpPh+/q43ZO1IaowZH04opsv9nVx3dh3W++HBTfs812qyCHYrCWS2B4fmNiXqBuFmupYE3aXgfEYJMW86rq9B5nrqruLOxpF4tGNGo06fepFHIMTrxvDar0AM238Bd+phCu6oYzDoKJvfbkf8ApDGHJJl8dnFM4qxEw4LjtXPuc1z4QUeM77Sxp+s/Wmgh3jleu2YPCBoTvtMAeJ5kEXY8arda3+X2jzaYqFhxgsyfCeNQZSQJVc5T416E8pSkig29dfgbbOINTCw6aVM7jDKq74jPZ+Gu8lVoBEVWiZ0Rnm2q2Wjd/Bjgupja98IIToLhgR8QWWextg2IpHiIESd8I8pHdt6lP6liQFUVB414beD+C5ExiJc5o1Sur8k4+MN1KyWqOVhbpNTwcw4nBnuLL0goAvtgg86AgW4inQXv5+ZwE5/EoouvKOdfrnnVy9h8wKB/2t/8ViccsseDQc871wPzQZewO1tsJps+xHz4Qrm4xMiXiS7g8/0/ft0wqRodDPUejcrnl4QOd2vwRZ77/1sTO7f3L6kgzTR+yXv/wXewXcKFbqhZfWvDEgl/0rDkg5z3lPts6u9K8QNK5Eiuc8XFgi9d1S8H3JHQVQ0TARKmwpf+HhtMmkyPvXGPAKaXgNoa8qpUh1eIwhXE3CIg/Oaj9aCvVpzE7U0r/O0J1i2E7jBmjQyRm9SBG9mhBdmDiLVofKgpz7ByFCQBwK4WuhjG5mfrUYmIDc8KYW4nZSFKxeua2FiZ8eHLqJ5WtWqOaWAvjrLngNblENSyNBFbUWCp8SKAyfun7+dCVqS2forab25ldLjjRM07HE78SAcdfqQ90rRu5Q31IIHRe0g0dCeC2COJ23YslQWv8esfY1+WQWRMECtLbXpoUdmMq+nr4FMxd56+Fv2NH71Hk/SRMpcgjBoXBSnXx/+orNvxkfJGnkOnzG5t5/9fK7Fz+9fYHAoCL1BDscH4wPKGCmrau4ilZa+yRLdNlmQPno1sv9ey7377ncv+dy/57L/Xsu9++53L/ncv+ey/17Lvfvudy/53L/nsv9ey7377ncv+dy/57L/Xsu/0vecwn5Y9xB+7XkQkW1LD7/fr5SapSkyXH8hMtlmpSYrz8+T66vMd7wDlN02PynhpJG55dpMudGoINL+ZhQol6sr0eNo0wP34QCpkdsw2swa+Fvk+IKM+JEEp9y+gTLlfdnbrDYL2TGETTf4zsPwN4ZztPPcKveAlP7fsRJjvGTrX3jAofT12/PMM8V7rhX9FxNYvgCk1N84aH1poJ/6gTbrhPJ1ayhIp/Ez3nj7xaUw0qAT1QJEH5BrNbSY1gi4NHA/yNSawdcX/sqA8pl+/7+08YRgbBtb2TO5c3Nzf8AzDuokQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var i=n(74848),r=n(28453),o=n(57742),a=n.n(o),l=n(78178),d=n.n(l),p=n(19624),c=n.n(p),h=n(96226),m=n.n(h),u=(n(77675),n(19365),n(51107)),f=n(21312);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:"eJztPNtu3DiWv8LVS5KCXL500rtrZIPxdDLdwaQ7RuJsENhGNSWdKjGhSA1JVbnGMDAP8wf7tK/zaf0li3NISVS5qpzKpKdnd90I2jbFy7nx8NzI68TxmU2Oz5PnOm8qUM4ml2lSgM2NqJ3QKjlOzkpg3xngDljbi02NrpiDqpbYfHL6knEp9cKypW6Y02wGCgx+UrBgRTs3y5bsY2Mdq42ei0KoWTfHRBRMKOuAF0xPWVNLzakDpymmQsJDoZgrgU21qbBPxi18+5hpwzKhuFk+YjAHs2ROVEBwKIACgck98LwDZMzOwrIWZ2MGauxRyCVrLBS0mmU5VyyDMLrwKDcWDBPKgZnyHBh37Hw0eg5ZM2PvXo5Glw9L52p7vL/P63qsa1BWzJTkmR3nutovsGNdTB8h0I0l/HvinkXkHF+oC/VBNwSEpxawAqa8kY7NuWyIDEh0thDFDJC2HEHXRCNhmOIVDL7bpq61cQyucqgdQ8C4awykzDpe1SkTSjjBpU2ZqPgMCITRqBQFTBxcuclCuHLCrQMj7Cd7PBqx9yUoBopnEoqUUMGOAQZaAYqO6ExYVoqiAOVJaSAXtSCx8KTopk5Z1jhmoOJCWTZtpFyyubAik4DsxLm7SfVCEUcC1q9rUG/FTDGe57ohTpfCMk2yjBDwORcSAWZaySWCega8soyrgr1AvtZGWGC15Mp2FFAOsX1bQy6mS1of24gDgbphnZobXoFDiNpFuaS5hWVKO8brWoqcR5hMNW4cxD9MdczyEvJPmb5KmeGF0EgNp1XKCqPrQi8UwXU4ZqMRkkiORhfq559/vlDXF4qxiwQ5f5Ecs4uEPl8kqW83wAtEGr9NubQQ2oNYRUN+B1e8qiWg0HbDEWXf5zTI43D6TYLSLXehbgKgF+oIoUdANwPvf9sF9o8atkA7mG8nYL9BYD/qjJ0JJ7dAjF0cdtkN7Bz0FrBvT7oT7I8R9lxXNVfLzZCHDjuKihcSVs8dk67YgsPq9Dth8AQxKLjbQnj8uhvsh4d7B0/2jg6OnnTjKqEmfiLs0Dfzq3XNqNyEmnWf4pVuE8D36rHaY6NRux6qFtZ2RI1QCSWqBhWkdUbkpLmwI+oYPxWr8BDNAPXeaPThw4cPez/+uPf8+WhEhyN347BEgB2XGKzAr77SCjEZRqNj9nLK4iZUexYc6TrTQNqdC6jvug6lXqhWHdKhYVjRGOwSuo4ZHoUVX9JkIFwJZriONu3p6A8P1LWZduWYvaOzBX9vdXA4CKEgPfotihfKYqavNktY6LCbkFVLOg+3bIyVzzvsin+lfR0Oii0bO/TYBfDzi8QfXXtHF8nlUGhDNxSo1jop+RwPU+JBpQ1KGFfU4O0UV3JHpphFHmfALEjI0aLKli3TiBP/Rhs9nHFbNnvosRsvPEaH8Sa8UP+OK8Zn7OZVqddXWPLwgE6+psrAbDn76Psuyx2EJtydjeQr2qqAXFRc1pLnQPJ0tPmYHC69g1Cy8N+FOiTjJAcp7RbRxM93ooi9JmTK4Zcn6+i8Zn99PvhsKN/9cqsWn6cL+h0EuBdrW+pGFijUBlxjlPc3sDs6CsF+NGBrrewtLRxtjzCPAeIQfYUrYR2qrnZ4mO3UwFRIyd4Ha5Em9U2tpc8NMJDgXS6aH1uEsoBaD90XHTlDbDTKYKoNjEZMOK+QuYGCIcUY95iw12gtDyxv8ou0YSW3rAZTCWvxHMG5iwK7VgHiV8I6pNuKI0KQtLCjmBzerYnXKWJPHfrIVWFgwTIYHLZHOxsQ3ZTsIjl4vH/4ZP/o4OhxPOc3X6x++7nP0bgguw73LfjfV/RtLDs/hiM5L7VtnaiBpJBAWRLRsC7qV6E8pb175l3McWca7qD9Qq8NdPLgfxXo49U2YtBrGzIQyWXdjAB9Xi804j9///rN4uCP38/0ycnJyU9v35Uv3s1OTk4q/Hs8HgeswtTffvEpFVOrZfdXoVe71mZaXagkTXSNIRmh1csiOU5CWCPsZtzrbXdRJGnSebIYHbomxJLjJIrWJGkiMDpUc1cmqyEjnX2E3L2kUE4b1kjSxMCfGmGgSI7JGkysW0qc1gp0JJI0gata6gKSY38EJDYvoeLJ8XXiljX1dGgXJmnirdC4JbgjCNIPh1mZH5V1ltzcXPplwbrf62KJU+VaOVAOfw3uOEK9/9Ei6NfRmj2454m3Syk6FkDxOCKpDFLWCbAEKPpqu0L8UxQl897eLZKeqD6g0IcZrD+h2kgSDaW4BB1ZsJDLLn7VB79eTpmuhHN90MZz6Je//LcNUyzwPMnAh8MGdlpyk3bE6LHkxvAlioSDKm7fQCSj19Oop8gJxm+c4srhghRp2EpU6hBP8FFDHMbAWbwQb1v1owY8PbBzXWp1R+/Do2/w3zeH2D/4uLtyvo0R4hQfdTb5IvEpYI7jwwH75Wy5m0Dh+J0Qyq3NFg3JtJbAVTyGtvJN2tps2+cPLlOmr5Kbm7TdTCvKKtJCk7deFCct7jc7DaNFploWYFApboOM5B5UMVmVxR7l1bD5ICA4jI+HfcsWJZAzi80LrpyPqfWekiLfOey34J4PosDCondqGrhIaGP3hqXGP1Zjkm1fikkqzR7QehPbkEA82A9/Z7pYPuhHepPSwyxQlQQQqHOnPuxAa5CJEQCaCpAUAg1qB13FENQuGMfgK4Oqdst9oeZcisJjMFROPb5h9pg7iFSrJlpk1rFzyKHvGut0xQiJMIh0ZxcaZ+HkGLPvuGJC5bIJtnsftWXX162A+c17c8Our1FSwExwQ93cpH0DrjVoIDXjWwzkIOaDUV0T9AO7tmgoXNXCLCkU4huCNooBCOGSxoR5lMbO44GQrwBOtn2gARSd7GJ8/TbWnZ4m6fls6t8idpAqnOT/Dd2f1s9+EGtAebpfP3taP3sPrNQ1+P3syTMVqvDaZAFSjtlT64xWs2crJHi6H9rXs9LAXMCClAFxtZ9llbbdROMA0wfdxDtFWJabJhdc4ry10Tm0LqQ3Ra4csw5qi/td+PQTKhPCwTA+M0AOK8HCG1dqI/5Mhlm74FPOSgPT/3iwQtMHzyjhU4KBp/v8Wej9cko4UnCKqyUjxIVWFnUPJQanjSHVm0tuxDRYgSmrJXCLIWvleO58TJIo2sJxVnL1yaZPM/MMU0ddyumXv/4Ne7TnxEv12hRgPuOgGI1QfY1GbK/3sqfCWNcGQ4NU2C5Aum6/hOydXI7ZC56XqNAsdlDdND786TW4UMx/zSH1mTA+xSMCV6hRKnRj23EoOSjXElByfJ6tC8zSKSc8aO2xkEHJ50K38Q8yAAi9Eynbs6xFaitOVlSNdFyBbqxc/hYnCuaSz/R3AfvnfBlbUT4kdIuflH/GtHMYxQq+tO0y9IHLvCEIvP7wkXA99VthYKfTju+QrQ2QSRD8u5ZYqCpT3FR6DsaIIkjKEM8Us+MKDQ7VhuQPNrsCK7SJ7c8O645Wh09Q9VMa+PXZ6W4S76L0LJkPfh72+uyUzaHfmBjIR7GhPq3s8EEXlusC2FxwLz0pW5QiJ/Wz9OkMUCTi4QSLg1noIQ9F9TZghbBrIUu9aYdnUkMgrluAFcJA7uSSVKJuHAbJRHDnSC/+Q6W7tck9sc90s6Oe2sQ1zmYNAelQkltbCoxNo5IPLPMwTe61cUj0xHkhOjysvc2TlgPYOVonZaCsn4azKYV4U9YoqtIwTY30a6eGqxqMQK33m5A7Oprvto/Q1qciDu2hrMFYrRA2bWZchdMRKxgWGCIirSt913AiWJYBZdH+IdqkpRLz+LCHGIZ/9NkqJvBDaVeSkFDikOAgAWus5zvVe1CgojYwBYO8tJ3ns/YrOS9cWu2zf/Gs7YnlNCUNVtjWOee//PVvSc++jcGI2/zzjOBFYcDaOxhJgXqvQTCthrmAJXP6nnFfwDgkO5jfrRZgIRNJWU8qXXQK3O6m+04x1+FsZ8iEhEeXcLFNXqLW6IwaG5dWUa2VTZH7Xa2UrlE0usBumycRd51Rb0L6voeFosR4sqAuVMv4kOkTQnpl2nUmHLH4N9GRWHt39+Zq6wHqKJ8W6gFBoR1QsNPnf6BCPu/nrEmsYXwvsmv88FsxH944PTFQCfV51vzbvtwBf7YHY+N0xZ3IWTuVHbPQ1echnY7Pt4o9XLWmH3Wb5VfgxTpOeEgnWuUwEWpCxZV3W78/dXlSMnszcAsAFaPdypt3O/qCONJJA3KvlI+M2T+XSdxRDO3fCswMJjkGU0mxwG5ahYgSTCnbmJAXxvWDG0EGbj87whECI12+p3fSUPb7Df6DXiDzOt8WIxB+fuQtI8gDsvEKOVdURoMOMIYCuyJYX0IkVL/EqmYK3ndeau3XQ9rSOuk2nNr44UCYu9XbgtJuY3OpSV2GGMNKvelvfjAROTZoOXLElxOtJv0x8Rlh9K0CtCY3P/SWVLBHfBQgOE0o/SgdSGjv7+MPOzwjVvm7eTEkyFda8Cft4Ji9gRk3hezsJ89GVOAp47Eg+aU2SQPFlTaIHXeO5yWQPimgBkVl1A/6aH8UCg8ZMAPeocMQ1N2n1dsQOfdIvnvzColg+tgHmE7024mhYE1NPq0HOfhIHTq3nKV/civx1rlag5rkWurPSiMGut5Ek5wnmWx8Uhlz0Znk+afk8iZNsjz/0hnR+h4kDVNqOhq03bofkeU5e5hJgQLGTUZMq5ePjkPEgheoyYjfK8GLwbbw4ksKecBoEQXfxsEc+zXYvM6AYEQ99vD88pFfep3BsUYq7rD6kPu+7OfulOSvltPclk/tUpBpV7ax6xR9KRKmJG+2pCUncV6SUifUeVgrEUFCWB0dHOCPoSA+H2hkDHs0OSoHukHxL0n6+ZUP20naVnfsSpPyozj681U+PzptiwiG2nNHzt5dFLAuwbxyvQEh2aDDt6ISrvk0Ru45vYe47HWHF00b8VsoKRRMWgZOCp1PWuxvyHS0ls92FrGO3bT/h7y+Y/nEC+TjdVIUZU7UA4pT9oWFIU+Eag31TbvDMaWiXeeMtV2G9pkwDMs+aCSJ+VeTRzBGm12pd+ptYQuuqXtM/MR3UfDxwcEk74n4ZA0Rg+eFN+PO9CdQX3H7bUS3Ry5e3vnlEdSrSvYqMQneIX1PBtjG7R5JC3ljhFtSMdjVHq/Fnv9+fH6JJVYVuFJjWVmtLUGMVWHHyf5Q1e1fR7ruJsFpzbwtMaNd2G0sy1WR6avbd+h4Lfbnh2MsQFkds/bO3Zb+0OztOsQ6PhNqdte4y55ib5GrnnEDuvVarxZ/BNwNgS1xr1BjVwLH4AMyAoXlTV/P9qJleVd4tr6WrKvYOm+Lr+IKq67A6lbVVAdVWxnVFUZF1U9R8VNfzzQoZ6IKpahAKa4obAuK4nqiztkJJUODuiASuL5oJ0mGhTm+tHClFOTvq2wYFjbcZ+v/D2XrV5L1XnjWZX0PnwxynEFC4wRaW7MaJ3kGKYTVDMLGMPWGKHVYwEdIUexXYpPh+/q43ZO1IaowZH04opsv9nVx3dh3W++HBTfs812qyCHYrCWS2B4fmNiXqBuFmupYE3aXgfEYJMW86rq9B5nrqruLOxpF4tGNGo06fepFHIMTrxvDar0AM238Bd+phCu6oYzDoKJvfbkf8ApDGHJJl8dnFM4qxEw4LjtXPuc1z4QUeM77Sxp+s/Wmgh3jleu2YPCBoTvtMAeJ5kEXY8arda3+X2jzaYqFhxgsyfCeNQZSQJVc5T416E8pSkig29dfgbbOINTCw6aVM7jDKq74jPZ+Gu8lVoBEVWiZ0Rnm2q2Wjd/Bjgupja98IIToLhgR8QWWextg2IpHiIESd8I8pHdt6lP6liQFUVB414beD+C5ExiJc5o1Sur8k4+MN1KyWqOVhbpNTwcw4nBnuLL0goAvtgg86AgW4inQXv5+ZwE5/EoouvKOdfrnnVy9h8wKB/2t/8ViccsseDQc871wPzQZewO1tsJps+xHz4Qrm4xMiXiS7g8/0/ft0wqRodDPUejcrnl4QOd2vwRZ77/1sTO7f3L6kgzTR+yXv/wXewXcKFbqhZfWvDEgl/0rDkg5z3lPts6u9K8QNK5Eiuc8XFgi9d1S8H3JHQVQ0TARKmwpf+HhtMmkyPvXGPAKaXgNoa8qpUh1eIwhXE3CIg/Oaj9aCvVpzE7U0r/O0J1i2E7jBmjQyRm9SBG9mhBdmDiLVofKgpz7ByFCQBwK4WuhjG5mfrUYmIDc8KYW4nZSFKxeua2FiZ8eHLqJ5WtWqOaWAvjrLngNblENSyNBFbUWCp8SKAyfun7+dCVqS2forab25ldLjjRM07HE78SAcdfqQ90rRu5Q31IIHRe0g0dCeC2COJ23YslQWv8esfY1+WQWRMECtLbXpoUdmMq+nr4FMxd56+Fv2NH71Hk/SRMpcgjBoXBSnXx/+orNvxkfJGnkOnzG5t5/9fK7Fz+9fYHAoCL1BDscH4wPKGCmrau4ilZa+yRLdNlmQPno1sv9ey7377ncv+dy/57L/Xsu9++53L/ncv+ey/17Lvfvudy/53L/nsv9ey7377ncv+dy/57L/Xsu/0vecwn5Y9xB+7XkQkW1LD7/fr5SapSkyXH8hMtlmpSYrz8+T66vMd7wDlN02PynhpJG55dpMudGoINL+ZhQol6sr0eNo0wP34QCpkdsw2swa+Fvk+IKM+JEEp9y+gTLlfdnbrDYL2TGETTf4zsPwN4ZztPPcKveAlP7fsRJjvGTrX3jAofT12/PMM8V7rhX9FxNYvgCk1N84aH1poJ/6gTbrhPJ1ayhIp/Ez3nj7xaUw0qAT1QJEH5BrNbSY1gi4NHA/yNSawdcX/sqA8pl+/7+08YRgbBtb2TO5c3Nzf8AzDuokQ==",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,j={},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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,i.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com",\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe",\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo",\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd",\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025",\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text",\n "hint": "Provide text",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"7",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"8",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"9",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"10",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"11",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "cells",\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "hide_text_with_asterisks": false \n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(t.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{...n(77488)}),"\n",(0,i.jsx)(c(),{...n(67810)}),"\n",(0,i.jsx)(m(),{...n(65288)})]})}function v(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}},77488(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"objectId of Template","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},67810(e){e.exports=JSON.parse('{"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":false},"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\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"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":"**true** - Only the first signer receives the signature request email initially. Each subsequent signer is notified in sequence, only after the previous signer has completed their signing. This is the default behavior.\\n\\n**false** - All signers receive the signature request email simultaneously.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","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. \\n\\n**false** - this option will disable OTP verification, allowing users to sign the document directly without additional steps.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"enableTour":{"type":"boolean","description":"**true** - this option will enable a guided tour for signers, providing instructions during the signing process. \\n\\n**false** - disable the guided tour, ensuring a faster, uninterrupted signing experience.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\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 \\"\\".\\n","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\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 \\"\\".\\n","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. \\n\\n**false** - Restricts signers from adding any additional elements to the document. This is the default value.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"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). If the field is omitted or provided as an empty/invalid value, the template value is used.","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.","example":""},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\nIf this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).\\nIf omitted or provided empty string (\\"\\") the template value is used.\\n"},"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":true}}')},65288(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.6895b540.js b/assets/js/c195e1f1.6895b540.js deleted file mode 100644 index 3d38371f6..000000000 --- a/assets/js/c195e1f1.6895b540.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6192],{35342(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>v});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":"eJztPNtu3DiWv8LVS5KCXL500rtrZIPxdDLdwaQ7RuJsENhGNSWdKjGhSA1JVbnGMDAP8wf7tK/zaf0li3NISVS5qpzKpKdnd90I2jbFy7nx8NzI68TxmU2Oz5PnOm8qUM4ml2lSgM2NqJ3QKjlOzkpg3xngDljbi02NrpiDqpbYfHL6knEp9cKypW6Y02wGCgx+UrBgRTs3y5bsY2Mdq42ei0KoWTfHRBRMKOuAF0xPWVNLzakDpymmQsJDoZgrgU21qbBPxi18+5hpwzKhuFk+YjAHs2ROVEBwKIACgck98LwDZMzOwrIWZ2MGauxRyCVrLBS0mmU5VyyDMLrwKDcWDBPKgZnyHBh37Hw0eg5ZM2PvXo5Glw9L52p7vL/P63qsa1BWzJTkmR3nutovsGNdTB8h0I0l/HvinkXkHF+oC/VBNwSEpxawAqa8kY7NuWyIDEh0thDFDJC2HEHXRCNhmOIVDL7bpq61cQyucqgdQ8C4awykzDpe1SkTSjjBpU2ZqPgMCITRqBQFTBxcuclCuHLCrQMj7Cd7PBqx9yUoBopnEoqUUMGOAQZaAYqO6ExYVoqiAOVJaSAXtSCx8KTopk5Z1jhmoOJCWTZtpFyyubAik4DsxLm7SfVCEUcC1q9rUG/FTDGe57ohTpfCMk2yjBDwORcSAWZaySWCega8soyrgr1AvtZGWGC15Mp2FFAOsX1bQy6mS1of24gDgbphnZobXoFDiNpFuaS5hWVKO8brWoqcR5hMNW4cxD9MdczyEvJPmb5KmeGF0EgNp1XKCqPrQi8UwXU4ZqMRkkiORhfq559/vlDXF4qxiwQ5f5Ecs4uEPl8kqW83wAtEGr9NubQQ2oNYRUN+B1e8qiWg0HbDEWXf5zTI43D6TYLSLXehbgKgF+oIoUdANwPvf9sF9o8atkA7mG8nYL9BYD/qjJ0JJ7dAjF0cdtkN7Bz0FrBvT7oT7I8R9lxXNVfLzZCHDjuKihcSVs8dk67YgsPq9Dth8AQxKLjbQnj8uhvsh4d7B0/2jg6OnnTjKqEmfiLs0Dfzq3XNqNyEmnWf4pVuE8D36rHaY6NRux6qFtZ2RI1QCSWqBhWkdUbkpLmwI+oYPxWr8BDNAPXeaPThw4cPez/+uPf8+WhEhyN347BEgB2XGKzAr77SCjEZRqNj9nLK4iZUexYc6TrTQNqdC6jvug6lXqhWHdKhYVjRGOwSuo4ZHoUVX9JkIFwJZriONu3p6A8P1LWZduWYvaOzBX9vdXA4CKEgPfotihfKYqavNktY6LCbkFVLOg+3bIyVzzvsin+lfR0Oii0bO/TYBfDzi8QfXXtHF8nlUGhDNxSo1jop+RwPU+JBpQ1KGFfU4O0UV3JHpphFHmfALEjI0aLKli3TiBP/Rhs9nHFbNnvosRsvPEaH8Sa8UP+OK8Zn7OZVqddXWPLwgE6+psrAbDn76Psuyx2EJtydjeQr2qqAXFRc1pLnQPJ0tPmYHC69g1Cy8N+FOiTjJAcp7RbRxM93ooi9JmTK4Zcn6+i8Zn99PvhsKN/9cqsWn6cL+h0EuBdrW+pGFijUBlxjlPc3sDs6CsF+NGBrrewtLRxtjzCPAeIQfYUrYR2qrnZ4mO3UwFRIyd4Ha5Em9U2tpc8NMJDgXS6aH1uEsoBaD90XHTlDbDTKYKoNjEZMOK+QuYGCIcUY95iw12gtDyxv8ou0YSW3rAZTCWvxHMG5iwK7VgHiV8I6pNuKI0KQtLCjmBzerYnXKWJPHfrIVWFgwTIYHLZHOxsQ3ZTsIjl4vH/4ZP/o4OhxPOc3X6x++7nP0bgguw73LfjfV/RtLDs/hiM5L7VtnaiBpJBAWRLRsC7qV6E8pb175l3McWca7qD9Qq8NdPLgfxXo49U2YtBrGzIQyWXdjAB9Xi804j9///rN4uCP38/0ycnJyU9v35Uv3s1OTk4q/Hs8HgeswtTffvEpFVOrZfdXoVe71mZaXagkTXSNIRmh1csiOU5CWCPsZtzrbXdRJGnSebIYHbomxJLjJIrWJGkiMDpUc1cmqyEjnX2E3L2kUE4b1kjSxMCfGmGgSI7JGkysW0qc1gp0JJI0gata6gKSY38EJDYvoeLJ8XXiljX1dGgXJmnirdC4JbgjCNIPh1mZH5V1ltzcXPplwbrf62KJU+VaOVAOfw3uOEK9/9Ei6NfRmj2454m3Syk6FkDxOCKpDFLWCbAEKPpqu0L8UxQl897eLZKeqD6g0IcZrD+h2kgSDaW4BB1ZsJDLLn7VB79eTpmuhHN90MZz6Je//LcNUyzwPMnAh8MGdlpyk3bE6LHkxvAlioSDKm7fQCSj19Oop8gJxm+c4srhghRp2EpU6hBP8FFDHMbAWbwQb1v1owY8PbBzXWp1R+/Do2/w3zeH2D/4uLtyvo0R4hQfdTb5IvEpYI7jwwH75Wy5m0Dh+J0Qyq3NFg3JtJbAVTyGtvJN2tps2+cPLlOmr5Kbm7TdTCvKKtJCk7deFCct7jc7DaNFploWYFApboOM5B5UMVmVxR7l1bD5ICA4jI+HfcsWJZAzi80LrpyPqfWekiLfOey34J4PosDCondqGrhIaGP3hqXGP1Zjkm1fikkqzR7QehPbkEA82A9/Z7pYPuhHepPSwyxQlQQQqHOnPuxAa5CJEQCaCpAUAg1qB13FENQuGMfgK4Oqdst9oeZcisJjMFROPb5h9pg7iFSrJlpk1rFzyKHvGut0xQiJMIh0ZxcaZ+HkGLPvuGJC5bIJtnsftWXX162A+c17c8Our1FSwExwQ93cpH0DrjVoIDXjWwzkIOaDUV0T9AO7tmgoXNXCLCkU4huCNooBCOGSxoR5lMbO44GQrwBOtn2gARSd7GJ8/TbWnZ4m6fls6t8idpAqnOT/Dd2f1s9+EGtAebpfP3taP3sPrNQ1+P3syTMVqvDaZAFSjtlT64xWs2crJHi6H9rXs9LAXMCClAFxtZ9llbbdROMA0wfdxDtFWJabJhdc4ry10Tm0LqQ3Ra4csw5qi/td+PQTKhPCwTA+M0AOK8HCG1dqI/5Mhlm74FPOSgPT/3iwQtMHzyjhU4KBp/v8Wej9cko4UnCKqyUjxIVWFnUPJQanjSHVm0tuxDRYgSmrJXCLIWvleO58TJIo2sJxVnL1yaZPM/MMU0ddyumXv/4Ne7TnxEv12hRgPuOgGI1QfY1GbK/3sqfCWNcGQ4NU2C5Aum6/hOydXI7ZC56XqNAsdlDdND786TW4UMx/zSH1mTA+xSMCV6hRKnRj23EoOSjXElByfJ6tC8zSKSc8aO2xkEHJ50K38Q8yAAi9Eynbs6xFaitOVlSNdFyBbqxc/hYnCuaSz/R3AfvnfBlbUT4kdIuflH/GtHMYxQq+tO0y9IHLvCEIvP7wkXA99VthYKfTju+QrQ2QSRD8u5ZYqCpT3FR6DsaIIkjKEM8Us+MKDQ7VhuQPNrsCK7SJ7c8O645Wh09Q9VMa+PXZ6W4S76L0LJkPfh72+uyUzaHfmBjIR7GhPq3s8EEXlusC2FxwLz0pW5QiJ/Wz9OkMUCTi4QSLg1noIQ9F9TZghbBrIUu9aYdnUkMgrluAFcJA7uSSVKJuHAbJRHDnSC/+Q6W7tck9sc90s6Oe2sQ1zmYNAelQkltbCoxNo5IPLPMwTe61cUj0xHkhOjysvc2TlgPYOVonZaCsn4azKYV4U9YoqtIwTY30a6eGqxqMQK33m5A7Oprvto/Q1qciDu2hrMFYrRA2bWZchdMRKxgWGCIirSt913AiWJYBZdH+IdqkpRLz+LCHGIZ/9NkqJvBDaVeSkFDikOAgAWus5zvVe1CgojYwBYO8tJ3ns/YrOS9cWu2zf/Gs7YnlNCUNVtjWOee//PVvSc++jcGI2/zzjOBFYcDaOxhJgXqvQTCthrmAJXP6nnFfwDgkO5jfrRZgIRNJWU8qXXQK3O6m+04x1+FsZ8iEhEeXcLFNXqLW6IwaG5dWUa2VTZH7Xa2UrlE0usBumycRd51Rb0L6voeFosR4sqAuVMv4kOkTQnpl2nUmHLH4N9GRWHt39+Zq6wHqKJ8W6gFBoR1QsNPnf6BCPu/nrEmsYXwvsmv88FsxH944PTFQCfV51vzbvtwBf7YHY+N0xZ3IWTuVHbPQ1echnY7Pt4o9XLWmH3Wb5VfgxTpOeEgnWuUwEWpCxZV3W78/dXlSMnszcAsAFaPdypt3O/qCONJJA3KvlI+M2T+XSdxRDO3fCswMJjkGU0mxwG5ahYgSTCnbmJAXxvWDG0EGbj87whECI12+p3fSUPb7Df6DXiDzOt8WIxB+fuQtI8gDsvEKOVdURoMOMIYCuyJYX0IkVL/EqmYK3ndeau3XQ9rSOuk2nNr44UCYu9XbgtJuY3OpSV2GGMNKvelvfjAROTZoOXLElxOtJv0x8Rlh9K0CtCY3P/SWVLBHfBQgOE0o/SgdSGjv7+MPOzwjVvm7eTEkyFda8Cft4Ji9gRk3hezsJ89GVOAp47Eg+aU2SQPFlTaIHXeO5yWQPimgBkVl1A/6aH8UCg8ZMAPeocMQ1N2n1dsQOfdIvnvzColg+tgHmE7024mhYE1NPq0HOfhIHTq3nKV/civx1rlag5rkWurPSiMGut5Ek5wnmWx8Uhlz0Znk+afk8iZNsjz/0hnR+h4kDVNqOhq03bofkeU5e5hJgQLGTUZMq5ePjkPEgheoyYjfK8GLwbbw4ksKecBoEQXfxsEc+zXYvM6AYEQ99vD88pFfep3BsUYq7rD6kPu+7OfulOSvltPclk/tUpBpV7ax6xR9KRKmJG+2pCUncV6SUifUeVgrEUFCWB0dHOCPoSA+H2hkDHs0OSoHukHxL0n6+ZUP20naVnfsSpPyozj681U+PzptiwiG2nNHzt5dFLAuwbxyvQEh2aDDt6ISrvk0Ru45vYe47HWHF00b8VsoKRRMWgZOCp1PWuxvyHS0ls92FrGO3bT/h7y+Y/nEC+TjdVIUZU7UA4pT9oWFIU+Eag31TbvDMaWiXeeMtV2G9pkwDMs+aCSJ+VeTRzBGm12pd+ptYQuuqXtM/MR3UfDxwcEk74n4ZA0Rg+eFN+PO9CdQX3H7bUS3Ry5e3vnlEdSrSvYqMQneIX1PBtjG7R5JC3ljhFtSMdjVHq/Fnv9+fH6JJVYVuFJjWVmtLUGMVWHHyf5Q1e1fR7ruJsFpzbwtMaNd2G0sy1WR6avbd+h4Lfbnh2MsQFkds/bO3Zb+0OztOsQ6PhNqdte4y55ib5GrnnEDuvVarxZ/BNwNgS1xr1BjVwLH4AMyAoXlTV/P9qJleVd4tr6WrKvYOm+Lr+IKq67A6lbVVAdVWxnVFUZF1U9R8VNfzzQoZ6IKpahAKa4obAuK4nqiztkJJUODuiASuL5oJ0mGhTm+tHClFOTvq2wYFjbcZ+v/D2XrV5L1XnjWZX0PnwxynEFC4wRaW7MaJ3kGKYTVDMLGMPWGKHVYwEdIUexXYpPh+/q43ZO1IaowZH04opsv9nVx3dh3W++HBTfs812qyCHYrCWS2B4fmNiXqBuFmupYE3aXgfEYJMW86rq9B5nrqruLOxpF4tGNGo06fepFHIMTrxvDar0AM238Bd+phCu6oYzDoKJvfbkf8ApDGHJJl8dnFM4qxEw4LjtXPuc1z4QUeM77Sxp+s/Wmgh3jleu2YPCBoTvtMJdoHXQhZrxZ16r/hTafplh3iLGSDK9ZYxwFVMlV7jOD/pCifAR6ff0NaOsMAi08aFo5gxus4orPaOun8VZiBUjUhJYZnWGq3WrZ+A3suJDa+MIHwoeughENX2C1twGGrXiCGChxI8xDdtemPqNvSVAQBYVXbej5AJ47gYE4p1mjpM4/+cB4IyWrNRpZqNr0dAAjDneGK0sPCPhai8CCjmAhnALt3e93FpDBr4SiG+9Ypn/eidV7yKxw0F/6XywWt6yCR8Mx3wv3Q5OxN1BrK5w2y370TLiyyciSiCfp/vAzfd++rBDZCf0chc7tmncHdG73S5D1/lsfOrP7J6cvyS59xH75y3+xV8CNYqVeeGHNGwNy2T/igJTznPdk68xK/whB40qkeM7DfSXS3i0F35fcUfwU7RKhwo7y9x1Om0yKvH+MAW+QhscQ+qJSClSHtxjCzSSs8eCs9qOlUJ/G7EQt/eMM3SGG7TRugAYdnNGDFNGjCdF9ibNodagsyLl/DyLEw6EQvhTK6GbmV4uBCcgNL2ohbidFweqVy1qY9+nBoYtYvmSFSm4pfr/uftfgEtWwMhJUUWuh8CWBwvCp6+dPV4K2dITeamovfrXkSMM0HUv8TgwYd60+0r1i4w7VLUXQcUE7eCOE1yKI03krlgyl9e8Ra1+ST1ZBFCtAY3ttVtiBqezr6Vswc5G3Dv6GHb1PnfeTNJEihxAbCgfVyfenr9j8m/FBkkaew2ds7v1XL7978dPbFwgMKlJPsMPxwfiA4mXauoqraKW1L7JEd20GlI8uvdw/53L/nMv9cy73z7ncP+dy/5zL/XMu98+53D/ncv+cy/1zLvfPudw/53L/nMv9cy73z7ncP+fyv+Q5l5A+xh20X0suVFTK4tPv5yuVRkmaHMcvuFymSYnp+uPz5Poa4w3vMEOHzX9qKGd0fpkmc24EOriUjgkV6sX6ctQ4yvTwTahfesQ2PAazFv42J64wIU4k8RmnT7BceX7mBmv9QmIcQfM9vvMA7J3hPP0Mt8otMLPvR5zkGD/Z2jeubzh9/fYM01zhintFr9Ukhi8wN8UXHlpvKviXTrDtOpFczRqq8Un8nDf+akE5LAT4RIUA4RfEai09hhUCHg38PyK1dsD1tS8yoFS27+8/bRwRCNv2RuZc3tzc/A/cmqgs","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),o=n(57742),a=n.n(o),l=n(78178),d=n.n(l),p=n(19624),c=n.n(p),h=n(96226),m=n.n(h),u=(n(77675),n(19365),n(51107)),f=n(21312);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:"eJztPNtu3DiWv8LVS5KCXL500rtrZIPxdDLdwaQ7RuJsENhGNSWdKjGhSA1JVbnGMDAP8wf7tK/zaf0li3NISVS5qpzKpKdnd90I2jbFy7nx8NzI68TxmU2Oz5PnOm8qUM4ml2lSgM2NqJ3QKjlOzkpg3xngDljbi02NrpiDqpbYfHL6knEp9cKypW6Y02wGCgx+UrBgRTs3y5bsY2Mdq42ei0KoWTfHRBRMKOuAF0xPWVNLzakDpymmQsJDoZgrgU21qbBPxi18+5hpwzKhuFk+YjAHs2ROVEBwKIACgck98LwDZMzOwrIWZ2MGauxRyCVrLBS0mmU5VyyDMLrwKDcWDBPKgZnyHBh37Hw0eg5ZM2PvXo5Glw9L52p7vL/P63qsa1BWzJTkmR3nutovsGNdTB8h0I0l/HvinkXkHF+oC/VBNwSEpxawAqa8kY7NuWyIDEh0thDFDJC2HEHXRCNhmOIVDL7bpq61cQyucqgdQ8C4awykzDpe1SkTSjjBpU2ZqPgMCITRqBQFTBxcuclCuHLCrQMj7Cd7PBqx9yUoBopnEoqUUMGOAQZaAYqO6ExYVoqiAOVJaSAXtSCx8KTopk5Z1jhmoOJCWTZtpFyyubAik4DsxLm7SfVCEUcC1q9rUG/FTDGe57ohTpfCMk2yjBDwORcSAWZaySWCega8soyrgr1AvtZGWGC15Mp2FFAOsX1bQy6mS1of24gDgbphnZobXoFDiNpFuaS5hWVKO8brWoqcR5hMNW4cxD9MdczyEvJPmb5KmeGF0EgNp1XKCqPrQi8UwXU4ZqMRkkiORhfq559/vlDXF4qxiwQ5f5Ecs4uEPl8kqW83wAtEGr9NubQQ2oNYRUN+B1e8qiWg0HbDEWXf5zTI43D6TYLSLXehbgKgF+oIoUdANwPvf9sF9o8atkA7mG8nYL9BYD/qjJ0JJ7dAjF0cdtkN7Bz0FrBvT7oT7I8R9lxXNVfLzZCHDjuKihcSVs8dk67YgsPq9Dth8AQxKLjbQnj8uhvsh4d7B0/2jg6OnnTjKqEmfiLs0Dfzq3XNqNyEmnWf4pVuE8D36rHaY6NRux6qFtZ2RI1QCSWqBhWkdUbkpLmwI+oYPxWr8BDNAPXeaPThw4cPez/+uPf8+WhEhyN347BEgB2XGKzAr77SCjEZRqNj9nLK4iZUexYc6TrTQNqdC6jvug6lXqhWHdKhYVjRGOwSuo4ZHoUVX9JkIFwJZriONu3p6A8P1LWZduWYvaOzBX9vdXA4CKEgPfotihfKYqavNktY6LCbkFVLOg+3bIyVzzvsin+lfR0Oii0bO/TYBfDzi8QfXXtHF8nlUGhDNxSo1jop+RwPU+JBpQ1KGFfU4O0UV3JHpphFHmfALEjI0aLKli3TiBP/Rhs9nHFbNnvosRsvPEaH8Sa8UP+OK8Zn7OZVqddXWPLwgE6+psrAbDn76Psuyx2EJtydjeQr2qqAXFRc1pLnQPJ0tPmYHC69g1Cy8N+FOiTjJAcp7RbRxM93ooi9JmTK4Zcn6+i8Zn99PvhsKN/9cqsWn6cL+h0EuBdrW+pGFijUBlxjlPc3sDs6CsF+NGBrrewtLRxtjzCPAeIQfYUrYR2qrnZ4mO3UwFRIyd4Ha5Em9U2tpc8NMJDgXS6aH1uEsoBaD90XHTlDbDTKYKoNjEZMOK+QuYGCIcUY95iw12gtDyxv8ou0YSW3rAZTCWvxHMG5iwK7VgHiV8I6pNuKI0KQtLCjmBzerYnXKWJPHfrIVWFgwTIYHLZHOxsQ3ZTsIjl4vH/4ZP/o4OhxPOc3X6x++7nP0bgguw73LfjfV/RtLDs/hiM5L7VtnaiBpJBAWRLRsC7qV6E8pb175l3McWca7qD9Qq8NdPLgfxXo49U2YtBrGzIQyWXdjAB9Xi804j9///rN4uCP38/0ycnJyU9v35Uv3s1OTk4q/Hs8HgeswtTffvEpFVOrZfdXoVe71mZaXagkTXSNIRmh1csiOU5CWCPsZtzrbXdRJGnSebIYHbomxJLjJIrWJGkiMDpUc1cmqyEjnX2E3L2kUE4b1kjSxMCfGmGgSI7JGkysW0qc1gp0JJI0gata6gKSY38EJDYvoeLJ8XXiljX1dGgXJmnirdC4JbgjCNIPh1mZH5V1ltzcXPplwbrf62KJU+VaOVAOfw3uOEK9/9Ei6NfRmj2454m3Syk6FkDxOCKpDFLWCbAEKPpqu0L8UxQl897eLZKeqD6g0IcZrD+h2kgSDaW4BB1ZsJDLLn7VB79eTpmuhHN90MZz6Je//LcNUyzwPMnAh8MGdlpyk3bE6LHkxvAlioSDKm7fQCSj19Oop8gJxm+c4srhghRp2EpU6hBP8FFDHMbAWbwQb1v1owY8PbBzXWp1R+/Do2/w3zeH2D/4uLtyvo0R4hQfdTb5IvEpYI7jwwH75Wy5m0Dh+J0Qyq3NFg3JtJbAVTyGtvJN2tps2+cPLlOmr5Kbm7TdTCvKKtJCk7deFCct7jc7DaNFploWYFApboOM5B5UMVmVxR7l1bD5ICA4jI+HfcsWJZAzi80LrpyPqfWekiLfOey34J4PosDCondqGrhIaGP3hqXGP1Zjkm1fikkqzR7QehPbkEA82A9/Z7pYPuhHepPSwyxQlQQQqHOnPuxAa5CJEQCaCpAUAg1qB13FENQuGMfgK4Oqdst9oeZcisJjMFROPb5h9pg7iFSrJlpk1rFzyKHvGut0xQiJMIh0ZxcaZ+HkGLPvuGJC5bIJtnsftWXX162A+c17c8Our1FSwExwQ93cpH0DrjVoIDXjWwzkIOaDUV0T9AO7tmgoXNXCLCkU4huCNooBCOGSxoR5lMbO44GQrwBOtn2gARSd7GJ8/TbWnZ4m6fls6t8idpAqnOT/Dd2f1s9+EGtAebpfP3taP3sPrNQ1+P3syTMVqvDaZAFSjtlT64xWs2crJHi6H9rXs9LAXMCClAFxtZ9llbbdROMA0wfdxDtFWJabJhdc4ry10Tm0LqQ3Ra4csw5qi/td+PQTKhPCwTA+M0AOK8HCG1dqI/5Mhlm74FPOSgPT/3iwQtMHzyjhU4KBp/v8Wej9cko4UnCKqyUjxIVWFnUPJQanjSHVm0tuxDRYgSmrJXCLIWvleO58TJIo2sJxVnL1yaZPM/MMU0ddyumXv/4Ne7TnxEv12hRgPuOgGI1QfY1GbK/3sqfCWNcGQ4NU2C5Aum6/hOydXI7ZC56XqNAsdlDdND786TW4UMx/zSH1mTA+xSMCV6hRKnRj23EoOSjXElByfJ6tC8zSKSc8aO2xkEHJ50K38Q8yAAi9Eynbs6xFaitOVlSNdFyBbqxc/hYnCuaSz/R3AfvnfBlbUT4kdIuflH/GtHMYxQq+tO0y9IHLvCEIvP7wkXA99VthYKfTju+QrQ2QSRD8u5ZYqCpT3FR6DsaIIkjKEM8Us+MKDQ7VhuQPNrsCK7SJ7c8O645Wh09Q9VMa+PXZ6W4S76L0LJkPfh72+uyUzaHfmBjIR7GhPq3s8EEXlusC2FxwLz0pW5QiJ/Wz9OkMUCTi4QSLg1noIQ9F9TZghbBrIUu9aYdnUkMgrluAFcJA7uSSVKJuHAbJRHDnSC/+Q6W7tck9sc90s6Oe2sQ1zmYNAelQkltbCoxNo5IPLPMwTe61cUj0xHkhOjysvc2TlgPYOVonZaCsn4azKYV4U9YoqtIwTY30a6eGqxqMQK33m5A7Oprvto/Q1qciDu2hrMFYrRA2bWZchdMRKxgWGCIirSt913AiWJYBZdH+IdqkpRLz+LCHGIZ/9NkqJvBDaVeSkFDikOAgAWus5zvVe1CgojYwBYO8tJ3ns/YrOS9cWu2zf/Gs7YnlNCUNVtjWOee//PVvSc++jcGI2/zzjOBFYcDaOxhJgXqvQTCthrmAJXP6nnFfwDgkO5jfrRZgIRNJWU8qXXQK3O6m+04x1+FsZ8iEhEeXcLFNXqLW6IwaG5dWUa2VTZH7Xa2UrlE0usBumycRd51Rb0L6voeFosR4sqAuVMv4kOkTQnpl2nUmHLH4N9GRWHt39+Zq6wHqKJ8W6gFBoR1QsNPnf6BCPu/nrEmsYXwvsmv88FsxH944PTFQCfV51vzbvtwBf7YHY+N0xZ3IWTuVHbPQ1echnY7Pt4o9XLWmH3Wb5VfgxTpOeEgnWuUwEWpCxZV3W78/dXlSMnszcAsAFaPdypt3O/qCONJJA3KvlI+M2T+XSdxRDO3fCswMJjkGU0mxwG5ahYgSTCnbmJAXxvWDG0EGbj87whECI12+p3fSUPb7Df6DXiDzOt8WIxB+fuQtI8gDsvEKOVdURoMOMIYCuyJYX0IkVL/EqmYK3ndeau3XQ9rSOuk2nNr44UCYu9XbgtJuY3OpSV2GGMNKvelvfjAROTZoOXLElxOtJv0x8Rlh9K0CtCY3P/SWVLBHfBQgOE0o/SgdSGjv7+MPOzwjVvm7eTEkyFda8Cft4Ji9gRk3hezsJ89GVOAp47Eg+aU2SQPFlTaIHXeO5yWQPimgBkVl1A/6aH8UCg8ZMAPeocMQ1N2n1dsQOfdIvnvzColg+tgHmE7024mhYE1NPq0HOfhIHTq3nKV/civx1rlag5rkWurPSiMGut5Ek5wnmWx8Uhlz0Znk+afk8iZNsjz/0hnR+h4kDVNqOhq03bofkeU5e5hJgQLGTUZMq5ePjkPEgheoyYjfK8GLwbbw4ksKecBoEQXfxsEc+zXYvM6AYEQ99vD88pFfep3BsUYq7rD6kPu+7OfulOSvltPclk/tUpBpV7ax6xR9KRKmJG+2pCUncV6SUifUeVgrEUFCWB0dHOCPoSA+H2hkDHs0OSoHukHxL0n6+ZUP20naVnfsSpPyozj681U+PzptiwiG2nNHzt5dFLAuwbxyvQEh2aDDt6ISrvk0Ru45vYe47HWHF00b8VsoKRRMWgZOCp1PWuxvyHS0ls92FrGO3bT/h7y+Y/nEC+TjdVIUZU7UA4pT9oWFIU+Eag31TbvDMaWiXeeMtV2G9pkwDMs+aCSJ+VeTRzBGm12pd+ptYQuuqXtM/MR3UfDxwcEk74n4ZA0Rg+eFN+PO9CdQX3H7bUS3Ry5e3vnlEdSrSvYqMQneIX1PBtjG7R5JC3ljhFtSMdjVHq/Fnv9+fH6JJVYVuFJjWVmtLUGMVWHHyf5Q1e1fR7ruJsFpzbwtMaNd2G0sy1WR6avbd+h4Lfbnh2MsQFkds/bO3Zb+0OztOsQ6PhNqdte4y55ib5GrnnEDuvVarxZ/BNwNgS1xr1BjVwLH4AMyAoXlTV/P9qJleVd4tr6WrKvYOm+Lr+IKq67A6lbVVAdVWxnVFUZF1U9R8VNfzzQoZ6IKpahAKa4obAuK4nqiztkJJUODuiASuL5oJ0mGhTm+tHClFOTvq2wYFjbcZ+v/D2XrV5L1XnjWZX0PnwxynEFC4wRaW7MaJ3kGKYTVDMLGMPWGKHVYwEdIUexXYpPh+/q43ZO1IaowZH04opsv9nVx3dh3W++HBTfs812qyCHYrCWS2B4fmNiXqBuFmupYE3aXgfEYJMW86rq9B5nrqruLOxpF4tGNGo06fepFHIMTrxvDar0AM238Bd+phCu6oYzDoKJvfbkf8ApDGHJJl8dnFM4qxEw4LjtXPuc1z4QUeM77Sxp+s/Wmgh3jleu2YPCBoTvtMJdoHXQhZrxZ16r/hTafplh3iLGSDK9ZYxwFVMlV7jOD/pCifAR6ff0NaOsMAi08aFo5gxus4orPaOun8VZiBUjUhJYZnWGq3WrZ+A3suJDa+MIHwoeughENX2C1twGGrXiCGChxI8xDdtemPqNvSVAQBYVXbej5AJ47gYE4p1mjpM4/+cB4IyWrNRpZqNr0dAAjDneGK0sPCPhai8CCjmAhnALt3e93FpDBr4SiG+9Ypn/eidV7yKxw0F/6XywWt6yCR8Mx3wv3Q5OxN1BrK5w2y370TLiyyciSiCfp/vAzfd++rBDZCf0chc7tmncHdG73S5D1/lsfOrP7J6cvyS59xH75y3+xV8CNYqVeeGHNGwNy2T/igJTznPdk68xK/whB40qkeM7DfSXS3i0F35fcUfwU7RKhwo7y9x1Om0yKvH+MAW+QhscQ+qJSClSHtxjCzSSs8eCs9qOlUJ/G7EQt/eMM3SGG7TRugAYdnNGDFNGjCdF9ibNodagsyLl/DyLEw6EQvhTK6GbmV4uBCcgNL2ohbidFweqVy1qY9+nBoYtYvmSFSm4pfr/uftfgEtWwMhJUUWuh8CWBwvCp6+dPV4K2dITeamovfrXkSMM0HUv8TgwYd60+0r1i4w7VLUXQcUE7eCOE1yKI03krlgyl9e8Ra1+ST1ZBFCtAY3ttVtiBqezr6Vswc5G3Dv6GHb1PnfeTNJEihxAbCgfVyfenr9j8m/FBkkaew2ds7v1XL7978dPbFwgMKlJPsMPxwfiA4mXauoqraKW1L7JEd20GlI8uvdw/53L/nMv9cy73z7ncP+dy/5zL/XMu98+53D/ncv+cy/1zLvfPudw/53L/nMv9cy73z7ncP+fyv+Q5l5A+xh20X0suVFTK4tPv5yuVRkmaHMcvuFymSYnp+uPz5Poa4w3vMEOHzX9qKGd0fpkmc24EOriUjgkV6sX6ctQ4yvTwTahfesQ2PAazFv42J64wIU4k8RmnT7BceX7mBmv9QmIcQfM9vvMA7J3hPP0Mt8otMLPvR5zkGD/Z2jeubzh9/fYM01zhintFr9Ukhi8wN8UXHlpvKviXTrDtOpFczRqq8Un8nDf+akE5LAT4RIUA4RfEai09hhUCHg38PyK1dsD1tS8yoFS27+8/bRwRCNv2RuZc3tzc/A/cmqgs",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={},v=[];function b(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)(u.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)(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.p,{children:[(0,s.jsx)(t.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hint": "Provide text",\n "hide_text_with_asterisks": false\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 "decimalplaces": 2,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"11",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "cells",\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "hide_text_with_asterisks": false \n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\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.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(t.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...n(77488)}),"\n",(0,s.jsx)(c(),{...n(67810)}),"\n",(0,s.jsx)(m(),{...n(65288)})]})}function j(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},77488(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"objectId of Template","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},67810(e){e.exports=JSON.parse('{"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":false},"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\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"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":"**true** - Only the first signer receives the signature request email initially. Each subsequent signer is notified in sequence, only after the previous signer has completed their signing. This is the default behavior.\\n\\n**false** - All signers receive the signature request email simultaneously.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","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. \\n\\n**false** - this option will disable OTP verification, allowing users to sign the document directly without additional steps.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"enableTour":{"type":"boolean","description":"**true** - this option will enable a guided tour for signers, providing instructions during the signing process. \\n\\n**false** - disable the guided tour, ensuring a faster, uninterrupted signing experience.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\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 \\"\\".\\n","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\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 \\"\\".\\n","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. \\n\\n**false** - Restricts signers from adding any additional elements to the document. This is the default value.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"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). If the field is omitted or provided as an empty/invalid value, the template value is used.","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.","example":""},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\nIf this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).\\nIf omitted or provided empty string (\\"\\") the template value is used.\\n"},"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":true}}')},65288(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.10aaef2b.js b/assets/js/c4fbe420.83c3cb4c.js similarity index 94% rename from assets/js/c4fbe420.10aaef2b.js rename to assets/js/c4fbe420.83c3cb4c.js index 221da73b0..de46f4b7b 100644 --- a/assets/js/c4fbe420.10aaef2b.js +++ b/assets/js/c4fbe420.83c3cb4c.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3795],{74646(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>w,frontMatter:()=>x,metadata:()=>i,toc:()=>b});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":"eJztPdlyGzmSv4Kt2AjbnCJF0pIPbezGqG21Wx7rWFtuty1pNWAVSMKqAsoAShStYMQ8zB/s077Op/WXbGQCqIOXDsse9S77oS0WrkQiM5HITCQuA0MHOtg8Cg5ZmiXUMB2chEHMdKR4ZrgUwWZwOGTEF5OXivYNFwOydbBDmKC9hGmSa6Y0MZJEikGlKNdGpvwrlBLjew6JZuoc2lJNeknOMsWF0aQvFRkwwRTFjmMZ5SmDghE3Q5IpFrM+Fywm2qg8MrliukXeZ1IQnUcR07qfJ3ZkLgWRfUKLMUNihgxBVczkSmhCSS74l5yRRkP2PrPI7MSNBnkYM80HghoWA3C++SmPH4VkNOTRkERUkB6DqcYwUwcwq4Dbo1AmBY6pMxbxPofKrrMW2YpjDjDSJBmHhJJGI1dJo0G4JpmS5zxmsR9N9vuAUoqoJVwYpvo0YogrBr2IAQ7jOydUxKRPI55wU0cjibk2ivdyGLl1LI7FIc82yfsskTQmY5krcvDy57K6kQS+HTUaL1kvH5D3O43GycOhMZneXFujWdaSGROArYT2dCuS6VoMFbO4j7hiikGviC9GNU/GhMYxGfF4wIzGBREkktmYRFKqmAtLGhkdMCLytMeUDnE2qVSMcEEoUYzG46aRzVwz8vrd/h6gIaWmRQ6SXIfFcDFXLDLJ2HYP6PGzemBX58k60BAXg5Ck9AywxA35kvPoDKatmcCldSSDuGo0PgC8BXa4djQeE2KGXJMR6w2lPCPsHIpHPEmIUXwwYKrROBZ//etfj8XlsSDkOMAax8EmOQ5cF8dBaIvMOGO25OX+i/e723uHp4cfD7aLck+pU3V2XhY1+jyZ7uH92zdFsaDpdPHe1m45gJDGlR8kjGpGFDvnbITrAEtt5+qxUDSryAnbuiiBRkxp+HoEXwi5tP/UoXm382pv+20VFluDpZQntSrbu1s7b2p1sqEU9W4Oftnfq/eTq0ovO3uvLFJs+QT+OXHwuhXZcgt0uLO7/e5wa/cAKk/cOgI1vMuzTCpY/g+WoDdhmY/FTyyRI0IVQ+qJZJpKQTKqaMoMysYhNVis2JecKxZb4UaTxHPG5rFokkYDcLPZaJD3VkrxmAkDckQh61uSwwYtWx9IB+rviJhHwEpWLIwzBpKwVhVYDKq+c6LJVq0wHsguK36Ao0bUSoMsAcEDVRUDqWb4Oat3fBGSMXT8kgEd2W6HUvGvUhiaIBGdM2V4RJMq0wOAKCoNVSiyMsmF8V/dCOSjY27gfWRpJ5UAtBiQm3KBJZqRc5rkTDuoRiEZAlRvWaaYRgnt+gXEi5gMGR8MF45H48+5NrWOSa693PVQuLH8qiJ6GaKtTxPNCO/XcJnSM1YZjcjM7gct8tOYxKxP88SEhIO8MipnLbInDaFZlvAI91KgAbtR5Yo1cZUd+bTq5HNg9xPYQWIOewlIJyjELlwbDx3Qpd2AYHood82QCiLF1EJHMpFqloTwcx2PJJLCMGFaZOuc8gSBt5PVhIsoyWNGegmNzkLUBEKiYO+DVRmzJJGj0PIHVsEdGXGO+CGaJUCFUgD8QrrhuS733BY5BEYp+A8KPapxEK6rWHUyvy9hZECBZ0mCcihExIXks+wRw03CQmDwjIpxSGKrZLAL05MXIYmGLDrDvxSNuSS93Bgp7MRiJbNYjoTDZV8Ko/nXORzpS26O0W5I1kPyJCTPQtJph6TTDUlnPSSdJyHpPAtJtx2Sbjck3fWQdJ9YsLrPHK5pgeAqAJ2uxbL5Y2F3yGN2Cg1PYW6nVBumuD4DcU1wR7eqaxw6LerCFIob7Fxxbccf8jhmgvSVTIliEc84ShMrDYquQ4CHKJiU0KSfJ8mYnHPNKzgoOpUjgWodfOWK7GdMvINtlkaRzGGNEcMWqYjOcslFMgZQDxlNNc58G5TDTHHNQFQLXWBAmJK2rDoE36oC4DorKeoSaPFqLlqdysrADvqGa5S5sPXpYjcd1XbTTos0GoWcm1akSm2pqFLoHbCbQVnH/b6AH4+7T93PMfx80n3mfo6wamfd/RzCz65v6pgLvjnd5TgABDo9yQpYUgEBKk0A/FJh6OJEDE2zJZOA4h81Ab9RwUfYYUJfUOpkVXgWzNnWcPMtZ/sYZssFN5wmevGEfY17NOcpkOZPu6w0M/N1mDmKs8XTdjrtvZlzFR5UgWEbtUW47VaK/IaAUHSXoGi6z0ViGFqhgjSDyY2W02IWI9JO4d7gsQLOXaFxqsubY/EJYBF21EPYURejsth07xE+p2G6K6TO6/fmmH3aQj0YFZTFeHUV7hFW6xDdFU5ne705Rp8BRkHTW4xOKL1HuKyAY60gqDbbsvZ6s7PR7La76zV8grnKVkjTZhw3x+Pxt61FysWphaNid8ECejG/AKxooD0WK1GUgA7DxaBoVi+dXXVbb2ohQed0mAC1059Ard4LFkpUn2fNC3j6L2u5Mw/+7Y/ku3AQ77HCSOoU54qN1dsDq6doI2M6fqBtV75pcfiC+tPqsQUTiwAOtI1GQ8kjBzzU8UeuHhh8WoCDJi7qWhyvVRYVPsZxM02bUx/hZxNpoPIxTVtx3JqqOUMo9mNK4jgks5/nfo9jkqbpgs/2e+3zWprOzqKVpg42hz1PezPrnHLB0xwOSWBmtWf0GE3fhx69qVtLLkij8fHjx4/N3d3my5eNhl9DN4Sj4ootw45AL+5ohCrRNxqbZKdPqp/QnmAtOSgFirMh2tZ9haEcCX8ksiZPEudgYPZVrT0ppWPsjHEzZKo+jlQlycIBEs5bPWmGLfIez5fwtz+HFeclPEs9B8HpDseLZaer8KPEZykl6wMvFa2LRVNNts6oRV4wZfP1JsUGeUIVuwADoJ42Ut92D7zZ/jYlFj0tl8YWNC064y7ztg7ycN8dwx8VFsapuUBvW87TRhQbsAuSUWOYEtjZOU14bD1iTes1uqBpBtaVtf86Po7/9K9raNsF86mxRoWYDzg4aNb+62ir+elkTo08y5iKwD2QMBhJh4SZqEWOhizJSh/RaDRqjR7raChlYh1En7Viffv/U9n7fIrgZi2qs0fzZmqJoWJLBWKZNqUic1YwRjXxLedYU3FpkGs6bdTgnLFiiQrnatwjvWMKJCi0huljdLMEKUXlFoiXlX9LkDnHwUm53aP9lMVXtD25BnsCNyS0x5LZopuzVkLHMncc7f0F9ak6iq7gzalChUkYp9OueIBSejFVeFx6f6b41CKkyqZ+t/fs6VeAJFwXG0kNndXWzmuAvh/BrN+4x4hvQHoFlX4zFxSAXY8NvIkU1+6KIaAewYqFx8aPdsUItYWZ2cmdruBdT/2iV48yv5FX8QUtwSVeqglLRnC6wuIRnE9/wQDHooOGSG/AXHI+cTXukayYAmk5G99GitR25ttsqbdiQD+tKgPO2V6hqt1YC+bTi7mvRfatVd03Aot7FLEMNK1vZs0C5GvvUGg1rhrRF1NetdY9or45YH1nCnT17nr3uRWRVmf/ByLUGtjXJlZr9E/pYIn9BovvEXlW4Zlv4nA1ZoxVHbT02x1liYUay5dPuNOuTXijPuEn7VucuGrDfvuBq70EPzNDwdk6T+jMdhCziKc0wSAShLv7DTx6m8OXAwx44IVMs9xUmQ7NOihYvJbgQyOsc/dPIWmGpBGStZA8DMmjFnnLMJgiKgIvnNLAlQ2v4BAsloOnNMpVMiY9BRMPCWsNWuTy8ktOheFmPJmQBrm8hAjCyaQFXHgm5MjGXhyB19gQiKQrD1WxjPScyDsZ6TU4fa3tsVHzpXMvrznQHpGHckokLD2KOhT82BOZhapCJDDKXqGy2VMpBvtwnSV0TGgfPNU2IASb2bihFqB4k3TJv/8H6XRb7XZI2vZviO60E+w+Qh5GH1PEkmVOSiy+ioPbVQ4uf84TWRvta7FwddhbcjB0cYphBDjulQpbydz30HRSTmbaWFvR6gFndv/UQ5knMeyeNt6XFQGdhU7faBwo1oc4zTKCj/hPnqchIoolLHVRYy52D44zGK3AhZHANz6co9Hosb6ESAUIKEXDIC1j/OzYduuuRYFg0KFUZEi1tbMgpgFiiJg1Q5ZOxUx48Mq4CS487EDKnbuzCHaf14n7yUaNuDfq+9NC4l5EwUsMhdBEZ1Lowh/IyqIK1akigHbu0WKaknynsNwYMlNG/qAQQ8JJ+BmryhoutNfSHJTTkXAvhlLqsoYLRnNyV2/Wg9ykgji3R60iNORb3V6dp49rSsSzH+j2qq9Se32ts7G21O815SK5+WGRkOssKVrVr7WkWLNc05VT6FucQt/OEY/v0jDbedqtnSceL9uc74lhtspRV5hk78Lwequz7TwLaJUPr2n7/GE2yG8ny/XvYY2ZEtxPO/8Ea8y3kuiM0eXOiJLclcVlHmVew+Sy1M7yzZRbBfa7U+/G3Zhnps46z2va4PNulVo3Nr6NWqeNMxWSOw74rz/tvx21//JqILe2trb23r0fbr8fbG1tpfC71WrNNdnNIwMcBvRndzHMbfGoLiwYpdVqobueGrqJzdcyMfg32z5c3Kbl4vG+kx9h40f7Eb5dbhRVf8yeNc9p8P0kw7fybBAGMsPLsFLsxMFmEMOVW3/RMwhx1Zg2P8l4HGxeBu5eCPzp4vSh5dpnDZd3LwMdDVlK4S+/2nDdF+4LBqG/pheEAUZGwt1foMZg0105DEKIrcjAHM409IHtNi99LXubMgidph9sBpYbgjBw8QbFJ8JEJCF4K4v7wcQPuKyr4kvZlcY/iluv0A9cObtlN9h0MnXd+VY9VXuYlGgtO6NK0XEwfbPa3zXz8SsuhMgb7ZKx3024AWtacQEKqwVhwA1Lq6MsWDQlb47piEmYCQZ037QtLgtNbzwmtMNbnbdp6EJRb9P0s+yd3oocobGzycxZ62uuji2dHbhOKltw34bFXq9ulhdPQnsfo3UVpfr6iGU6qI5pbWkzYx4uuh5auZXmLG40yxhVLbyleevr45hBgCZRjjfaC2lcm1kBajGzziQMLq6ezAWJZNPfPSUPE9Y3NqCJRFIJph5VA1TvzeS66+uTMBhfPb3xH3J6T2HxRlfP7gNe2i0vNP8zYH38bBIGw6th/aW4VvxPBHb9yaTcY93t9iKrRU/G41MvtyZXVfSbGdSDFAk7Yl/FTFUQ0ZMyYVTMYAJCau3J6AFolw9CG0aI9we50n4js1kTFIsY3Cz3obQoq4jTdezFIn8DC/xJ2/ABtTOd9zTUEr4/bTvsMZ+JAVKH2Brcpt5Auzyj0RByPrjgxtKtlEHyA5lrDx6Y52F3SRhY3K2vrwjvrR7fKtiphA/bubeqqwNfYHPFO6j7hwfXwCWeLZs2AYC7F4qztH2Q/cMDuGPP+079g+jhAhMetbRWhYA6Rs459fdwC9k+tqFXzJpUpc8AUXouWu52e5PMAhRzPReiEG582iujRbqYmY7LFB6wRDI34AlxOVOINizTNTwiFAUiD2V+Haq8ApOUDHK8ZGCAZf2Fewx2Le/Ic2Fz0eAxw0V8VwPEMyUhMU2JJ48VqFTpPyRMaNuckj56xEJIUAOYVzkcKoou2UXGFAfP81wUKGZRd5qrufpaHQf1C+fv375xiVsqceyeh3zHLCZ5hlSDnFAkQvArNz31GUUJuIOp00WK4azqgf50ZzPJmNKQ3EcRqQZU8K8u2Q9oJHDI6rEhTWxVJyrAGo+B+ECvNWC8rP397/+owLVQ050FzI5A4xh8o1dAiCdJS/Cg6SuWgQSUdYigP6b+PL0JAHTINKepjAtG0ten8QMM3taFXHSexcKzqfNoCAeLQt7qsLjl6tRKjUfT4oK8zGC+7IJrU7n87S/kzMqHt+6eRgkDqiHA1UDzYlxl8NLjKqe6w2vqvJ4GotgGZ3iB5kaeKpZycb19qmq+M7IQBLmRKTU8Ir4r3aon97BeJc/XaRlnANR4zqV6NBc8w1N2KF+4HeUlHeurlQpog5qAa0ViOkaM+HxUpYrALjKuxsVtKnRYeUxeoUlvoCCByZ5KEbFTLk7ZOVPXUD8rARsAWI+ZEWOiijm/hHazLRMKjCAbQ23Fpq7e1HAIEKZMDdhpBCco5Al2jSVuNKCrRoM0LSBO4utcOWOPS9uDog2kXNk7gOMSbBQ3z0p1oJo7q0V+kSNAWEgym0YJLAy2f8AnQchdzonqCBEVeO0H7EyQjAE6LpyLkE+iHMIGBCAp4Wx2rIEgsrYm6AXSzMA44bI5eeleXKmjkCrGj+6TYMDkwOJDaCKR281wXo4MBGoHs4QMcXfE9QNzth3Hp+7BrBe//+1/IN2ZD6PSLZjCwlKMu6CJlvb+U7VXz2yeHa3pbIbbhDS8Pz6V4rSUcnMJpt5yKQHNieGoK1rC7RE4uNe3gNKBOgDRdo+Ff3Rd1E2v7+LBACF3NOCeNGyTvGUDquKk2NPsMhpMl0arhGSHWkQNmDhkAdlRY2g0ZJhYJGYZJFyTgjyALdhuwA/KZCSwnmCqYOIULafXMbG4TXtSWc2jAAysaDaNg9Cal4OTSRj0oui2PcJ+/mf3GzfqED91a99m8ij2oog87CUc0ENVT9o0eI82napOY+BDVMOmtPbaolrkozip6V+8ckhpkeI/h0QbIzTPGLXcIuk3+DIHIkt7EJOM8U544kFNUJZGybp167uZx5bZulyszsrS9QcyBXXa7f/Llq7H7T+OpWu9/QeydD0DYJ1P7Wppsuj0OVd2eB/h8gafJbP+h0Sq5TVhB5qEhUdzHoJLduhO7H+lcc4L8SsMdtaiVzr7nLHJTwbR0G234Z8pIehzyfoMp2V63WT8L0F4fU/j8jXw2UyXI+unYfcXnYk0GgLOFlg1yurLSazqQV1j49fD3quI7/PXO++/7nT2+I7eEW83ohc7T3bOst9+ffH6eYuNX3ei7q/j37q/mo8fEr3zWfLol9fDT+JX3XuxkX/87ZP6+NuO+vjhraEfNrZ6Yih6r37m0Xjjc6/b5m9evG5/+tAZ9V793P706/PsE3b+c/vT2Vk7Svde9MQW1Mk+/vaffP/z9uPdr9tfdw+3L3a/Js9bdO/L5xcX0fPds+0nzU87qrm73/vL5y8me7sRP977jT95xnbZB3HYfhPVqIGLhAt26pf6FOd9CottKWl93rK/kymzevsIU9gqCQqfO8AYNSZ0ACcQQJ26QypgSl3FLzeDbBki1tvt006BhI1ZJOwIvF6MqaIP5RkTP3am1eGNHR5AvUiTUmgF3FbC8qA22ep3O0nNolxxMw42jy6DiybNeNOWbx6dTE7gDG2GEoILMqkRYmqGwWawNh1rABm70ZN9dGl5sGA0TUUM4XczzEYzvnbeaXWCSTjdZi5zLqnP8uZNm2hDB1wMrmp3UqLoHSyjXakaokqFNeN/YaCxunWo1goDDuQzZBRMTYB5oI63ZYTGtl9jHzsxLxyiXMvpAAcf31ALWZjeh+cEIVRiEI58AAD69AuXflBOKCjc7kFQcaTDj4prHH4W2vxRSc2FX9kr2x3UUrvr66jOPe2g3vP4GaoU608mJxb5FUcShh5VvSHuBF4167tPdTN3EEyZlWu23WnT7kIz6wIrqxtyyprovs4z4nU2FpnPNuZarVxX8y0UrrB6/J1/lHUn2eufSiuHwTnr6fWf+mpC/B+s5uM2ruZ6G1fzWbumerk1KHsoFSjUkgolyU2gVIRA2zkB7uGiL5H1HM0VmVFBMiLrzijMLIlkWiQmbTR8k9///o+iVaNRHJRpkQd/P1ckkyOm4P0AzJ+fsAtM14pvG6RYptG8hrfbaAq2EQjKEYYNbPJ/uJ0Grinn/IhoRnuQgx9cK3hLCM2vld1DtyD/LN44HMv8gbL3784T2DAKk3M1ff9IqrN+IkeQFZ/04FoiGGiYGFIRWf+GFWNop4fzeZkOVhsFQHMLmhRG0ciQlAo6QEN7SKq4ilnCQdYTJXvg/tMyya2Dy1CeSGXtzDgfjIxDHG5fZFCESj8IDsWGwFznzsulQ+tltBLKJfbvgUM3A1g4WPiMJLlIJOTgB8dwnsCFPmOdtXC2qMIIzY2iQsOBwJm23RIUCHMOKKadLe29ZrDAb7g4s/llm+SoIKsPrKe5YfXkNdMC4lG9zStufsl7kFdcam6kGpetB9wM8x7uNdVOih+2p1f+7YjKTnL9m57vrE1Or20d7KCq8oj8/rf/Jm8YVYIM5cgSa5QrlozLZyrwRQVceYu2QtNAFyfN4VkGgzQqBt7rrosnEKhBw+weG4EF3HKUjXY8yHsJj4r3QTSk0nphXwEpHv6oJ9uwV+PA70xJZlsnXJy1yJYY2+cuCssifMd2tWmg13jBsxvlYxuHldFZqllyznTF0A6PaKA3X8l8YEerAuMmV78pCHPbimOSTd0WBD9QCY61jKEbnVoTGTxUMeeCYe0WXz2pMhMxXmrVmwQ1srL/cMoajJ71mU/+5mH5DortpvIWC2DSzbj4ak3oU1pQXdyiaR4G1LVXUGjGHTkdebIk9axQNydre6oWhkaogvtdnGZ8rqcUngLQ+/138MZM5I+ECzh6DSuvBWGQ8Ii5I77bvrZeHbwh549b7SCs6JbXYO61NzsvtvfebQMwIEgtwjqtdquNlkipTUpFZSR8S6cg1OmdrRLZu3qCZ/UEz+oJntUTPKsneFZP8Kye4Fk9wbN6gmf1BM+9x+7qCZ7VEzyL7qyunuBZPcEzfe179QTP6gme1RM89wKfqyd4Vk/w3DgX2eoJnqJg9QTP6gme49UTPKsneI5XT/Dcjzyyqyd4Vk/w3IkOt3qCZ/UEz+oJntUTPKsneP5AL5usnuD5ERS4eoJn9QTPrbO8rp7gmcdUqyd4Vk/wrJ7guXZa6tUTPN+Be1dP8Kye4Fk9wbNYBK2e4Fk9wXM/nEKrJ3hWT/CsnuBZPcGzeoJn9QTPnRpnVk/wrJ7g+X/2BE8lG8ZallAuKlmobLKco6mHeU7CYAjJdDaPgstLoMj3KplM4POXHJOAHJ2EwTlVHIL4MQ9P6PPGQPqNMwYpV17YGybNQxg+tOuMd56n0g9B4hvbYgunvrRuNd/Pwf67Q8gd4h4PSmWMmcnoCNJ10JHNqVLJ6YHfLoOEikGO+UAC2+fE5lke1vPknGGeHPdHJakI5JMpIawn0LHTgP/DpOY2uLy0OXgmk6K+LVrYwiHW14blO5lMJv8LlaF97Q==","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 Signing Links","permalink":"/docs/API-docs/v1.1/getsigninglinks"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),g=t(21312);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:"eJztPdlyGzmSv4Kt2AjbnCJF0pIPbezGqG21Wx7rWFtuty1pNWAVSMKqAsoAShStYMQ8zB/s077Op/WXbGQCqIOXDsse9S77oS0WrkQiM5HITCQuA0MHOtg8Cg5ZmiXUMB2chEHMdKR4ZrgUwWZwOGTEF5OXivYNFwOydbBDmKC9hGmSa6Y0MZJEikGlKNdGpvwrlBLjew6JZuoc2lJNeknOMsWF0aQvFRkwwRTFjmMZ5SmDghE3Q5IpFrM+Fywm2qg8MrliukXeZ1IQnUcR07qfJ3ZkLgWRfUKLMUNihgxBVczkSmhCSS74l5yRRkP2PrPI7MSNBnkYM80HghoWA3C++SmPH4VkNOTRkERUkB6DqcYwUwcwq4Dbo1AmBY6pMxbxPofKrrMW2YpjDjDSJBmHhJJGI1dJo0G4JpmS5zxmsR9N9vuAUoqoJVwYpvo0YogrBr2IAQ7jOydUxKRPI55wU0cjibk2ivdyGLl1LI7FIc82yfsskTQmY5krcvDy57K6kQS+HTUaL1kvH5D3O43GycOhMZneXFujWdaSGROArYT2dCuS6VoMFbO4j7hiikGviC9GNU/GhMYxGfF4wIzGBREkktmYRFKqmAtLGhkdMCLytMeUDnE2qVSMcEEoUYzG46aRzVwz8vrd/h6gIaWmRQ6SXIfFcDFXLDLJ2HYP6PGzemBX58k60BAXg5Ck9AywxA35kvPoDKatmcCldSSDuGo0PgC8BXa4djQeE2KGXJMR6w2lPCPsHIpHPEmIUXwwYKrROBZ//etfj8XlsSDkOMAax8EmOQ5cF8dBaIvMOGO25OX+i/e723uHp4cfD7aLck+pU3V2XhY1+jyZ7uH92zdFsaDpdPHe1m45gJDGlR8kjGpGFDvnbITrAEtt5+qxUDSryAnbuiiBRkxp+HoEXwi5tP/UoXm382pv+20VFluDpZQntSrbu1s7b2p1sqEU9W4Oftnfq/eTq0ovO3uvLFJs+QT+OXHwuhXZcgt0uLO7/e5wa/cAKk/cOgI1vMuzTCpY/g+WoDdhmY/FTyyRI0IVQ+qJZJpKQTKqaMoMysYhNVis2JecKxZb4UaTxHPG5rFokkYDcLPZaJD3VkrxmAkDckQh61uSwwYtWx9IB+rviJhHwEpWLIwzBpKwVhVYDKq+c6LJVq0wHsguK36Ao0bUSoMsAcEDVRUDqWb4Oat3fBGSMXT8kgEd2W6HUvGvUhiaIBGdM2V4RJMq0wOAKCoNVSiyMsmF8V/dCOSjY27gfWRpJ5UAtBiQm3KBJZqRc5rkTDuoRiEZAlRvWaaYRgnt+gXEi5gMGR8MF45H48+5NrWOSa693PVQuLH8qiJ6GaKtTxPNCO/XcJnSM1YZjcjM7gct8tOYxKxP88SEhIO8MipnLbInDaFZlvAI91KgAbtR5Yo1cZUd+bTq5HNg9xPYQWIOewlIJyjELlwbDx3Qpd2AYHood82QCiLF1EJHMpFqloTwcx2PJJLCMGFaZOuc8gSBt5PVhIsoyWNGegmNzkLUBEKiYO+DVRmzJJGj0PIHVsEdGXGO+CGaJUCFUgD8QrrhuS733BY5BEYp+A8KPapxEK6rWHUyvy9hZECBZ0mCcihExIXks+wRw03CQmDwjIpxSGKrZLAL05MXIYmGLDrDvxSNuSS93Bgp7MRiJbNYjoTDZV8Ko/nXORzpS26O0W5I1kPyJCTPQtJph6TTDUlnPSSdJyHpPAtJtx2Sbjck3fWQdJ9YsLrPHK5pgeAqAJ2uxbL5Y2F3yGN2Cg1PYW6nVBumuD4DcU1wR7eqaxw6LerCFIob7Fxxbccf8jhmgvSVTIliEc84ShMrDYquQ4CHKJiU0KSfJ8mYnHPNKzgoOpUjgWodfOWK7GdMvINtlkaRzGGNEcMWqYjOcslFMgZQDxlNNc58G5TDTHHNQFQLXWBAmJK2rDoE36oC4DorKeoSaPFqLlqdysrADvqGa5S5sPXpYjcd1XbTTos0GoWcm1akSm2pqFLoHbCbQVnH/b6AH4+7T93PMfx80n3mfo6wamfd/RzCz65v6pgLvjnd5TgABDo9yQpYUgEBKk0A/FJh6OJEDE2zJZOA4h81Ab9RwUfYYUJfUOpkVXgWzNnWcPMtZ/sYZssFN5wmevGEfY17NOcpkOZPu6w0M/N1mDmKs8XTdjrtvZlzFR5UgWEbtUW47VaK/IaAUHSXoGi6z0ViGFqhgjSDyY2W02IWI9JO4d7gsQLOXaFxqsubY/EJYBF21EPYURejsth07xE+p2G6K6TO6/fmmH3aQj0YFZTFeHUV7hFW6xDdFU5ne705Rp8BRkHTW4xOKL1HuKyAY60gqDbbsvZ6s7PR7La76zV8grnKVkjTZhw3x+Pxt61FysWphaNid8ECejG/AKxooD0WK1GUgA7DxaBoVi+dXXVbb2ohQed0mAC1059Ard4LFkpUn2fNC3j6L2u5Mw/+7Y/ku3AQ77HCSOoU54qN1dsDq6doI2M6fqBtV75pcfiC+tPqsQUTiwAOtI1GQ8kjBzzU8UeuHhh8WoCDJi7qWhyvVRYVPsZxM02bUx/hZxNpoPIxTVtx3JqqOUMo9mNK4jgks5/nfo9jkqbpgs/2e+3zWprOzqKVpg42hz1PezPrnHLB0xwOSWBmtWf0GE3fhx69qVtLLkij8fHjx4/N3d3my5eNhl9DN4Sj4ootw45AL+5ohCrRNxqbZKdPqp/QnmAtOSgFirMh2tZ9haEcCX8ksiZPEudgYPZVrT0ppWPsjHEzZKo+jlQlycIBEs5bPWmGLfIez5fwtz+HFeclPEs9B8HpDseLZaer8KPEZykl6wMvFa2LRVNNts6oRV4wZfP1JsUGeUIVuwADoJ42Ut92D7zZ/jYlFj0tl8YWNC064y7ztg7ycN8dwx8VFsapuUBvW87TRhQbsAuSUWOYEtjZOU14bD1iTes1uqBpBtaVtf86Po7/9K9raNsF86mxRoWYDzg4aNb+62ir+elkTo08y5iKwD2QMBhJh4SZqEWOhizJSh/RaDRqjR7raChlYh1En7Viffv/U9n7fIrgZi2qs0fzZmqJoWJLBWKZNqUic1YwRjXxLedYU3FpkGs6bdTgnLFiiQrnatwjvWMKJCi0huljdLMEKUXlFoiXlX9LkDnHwUm53aP9lMVXtD25BnsCNyS0x5LZopuzVkLHMncc7f0F9ak6iq7gzalChUkYp9OueIBSejFVeFx6f6b41CKkyqZ+t/fs6VeAJFwXG0kNndXWzmuAvh/BrN+4x4hvQHoFlX4zFxSAXY8NvIkU1+6KIaAewYqFx8aPdsUItYWZ2cmdruBdT/2iV48yv5FX8QUtwSVeqglLRnC6wuIRnE9/wQDHooOGSG/AXHI+cTXukayYAmk5G99GitR25ttsqbdiQD+tKgPO2V6hqt1YC+bTi7mvRfatVd03Aot7FLEMNK1vZs0C5GvvUGg1rhrRF1NetdY9or45YH1nCnT17nr3uRWRVmf/ByLUGtjXJlZr9E/pYIn9BovvEXlW4Zlv4nA1ZoxVHbT02x1liYUay5dPuNOuTXijPuEn7VucuGrDfvuBq70EPzNDwdk6T+jMdhCziKc0wSAShLv7DTx6m8OXAwx44IVMs9xUmQ7NOihYvJbgQyOsc/dPIWmGpBGStZA8DMmjFnnLMJgiKgIvnNLAlQ2v4BAsloOnNMpVMiY9BRMPCWsNWuTy8ktOheFmPJmQBrm8hAjCyaQFXHgm5MjGXhyB19gQiKQrD1WxjPScyDsZ6TU4fa3tsVHzpXMvrznQHpGHckokLD2KOhT82BOZhapCJDDKXqGy2VMpBvtwnSV0TGgfPNU2IASb2bihFqB4k3TJv/8H6XRb7XZI2vZviO60E+w+Qh5GH1PEkmVOSiy+ioPbVQ4uf84TWRvta7FwddhbcjB0cYphBDjulQpbydz30HRSTmbaWFvR6gFndv/UQ5knMeyeNt6XFQGdhU7faBwo1oc4zTKCj/hPnqchIoolLHVRYy52D44zGK3AhZHANz6co9Hosb6ESAUIKEXDIC1j/OzYduuuRYFg0KFUZEi1tbMgpgFiiJg1Q5ZOxUx48Mq4CS487EDKnbuzCHaf14n7yUaNuDfq+9NC4l5EwUsMhdBEZ1Lowh/IyqIK1akigHbu0WKaknynsNwYMlNG/qAQQ8JJ+BmryhoutNfSHJTTkXAvhlLqsoYLRnNyV2/Wg9ykgji3R60iNORb3V6dp49rSsSzH+j2qq9Se32ts7G21O815SK5+WGRkOssKVrVr7WkWLNc05VT6FucQt/OEY/v0jDbedqtnSceL9uc74lhtspRV5hk78Lwequz7TwLaJUPr2n7/GE2yG8ny/XvYY2ZEtxPO/8Ea8y3kuiM0eXOiJLclcVlHmVew+Sy1M7yzZRbBfa7U+/G3Zhnps46z2va4PNulVo3Nr6NWqeNMxWSOw74rz/tvx21//JqILe2trb23r0fbr8fbG1tpfC71WrNNdnNIwMcBvRndzHMbfGoLiwYpdVqobueGrqJzdcyMfg32z5c3Kbl4vG+kx9h40f7Eb5dbhRVf8yeNc9p8P0kw7fybBAGMsPLsFLsxMFmEMOVW3/RMwhx1Zg2P8l4HGxeBu5eCPzp4vSh5dpnDZd3LwMdDVlK4S+/2nDdF+4LBqG/pheEAUZGwt1foMZg0105DEKIrcjAHM409IHtNi99LXubMgidph9sBpYbgjBw8QbFJ8JEJCF4K4v7wcQPuKyr4kvZlcY/iluv0A9cObtlN9h0MnXd+VY9VXuYlGgtO6NK0XEwfbPa3zXz8SsuhMgb7ZKx3024AWtacQEKqwVhwA1Lq6MsWDQlb47piEmYCQZ037QtLgtNbzwmtMNbnbdp6EJRb9P0s+yd3oocobGzycxZ62uuji2dHbhOKltw34bFXq9ulhdPQnsfo3UVpfr6iGU6qI5pbWkzYx4uuh5auZXmLG40yxhVLbyleevr45hBgCZRjjfaC2lcm1kBajGzziQMLq6ezAWJZNPfPSUPE9Y3NqCJRFIJph5VA1TvzeS66+uTMBhfPb3xH3J6T2HxRlfP7gNe2i0vNP8zYH38bBIGw6th/aW4VvxPBHb9yaTcY93t9iKrRU/G41MvtyZXVfSbGdSDFAk7Yl/FTFUQ0ZMyYVTMYAJCau3J6AFolw9CG0aI9we50n4js1kTFIsY3Cz3obQoq4jTdezFIn8DC/xJ2/ABtTOd9zTUEr4/bTvsMZ+JAVKH2Brcpt5Auzyj0RByPrjgxtKtlEHyA5lrDx6Y52F3SRhY3K2vrwjvrR7fKtiphA/bubeqqwNfYHPFO6j7hwfXwCWeLZs2AYC7F4qztH2Q/cMDuGPP+079g+jhAhMetbRWhYA6Rs459fdwC9k+tqFXzJpUpc8AUXouWu52e5PMAhRzPReiEG582iujRbqYmY7LFB6wRDI34AlxOVOINizTNTwiFAUiD2V+Haq8ApOUDHK8ZGCAZf2Fewx2Le/Ic2Fz0eAxw0V8VwPEMyUhMU2JJ48VqFTpPyRMaNuckj56xEJIUAOYVzkcKoou2UXGFAfP81wUKGZRd5qrufpaHQf1C+fv375xiVsqceyeh3zHLCZ5hlSDnFAkQvArNz31GUUJuIOp00WK4azqgf50ZzPJmNKQ3EcRqQZU8K8u2Q9oJHDI6rEhTWxVJyrAGo+B+ECvNWC8rP397/+owLVQ050FzI5A4xh8o1dAiCdJS/Cg6SuWgQSUdYigP6b+PL0JAHTINKepjAtG0ten8QMM3taFXHSexcKzqfNoCAeLQt7qsLjl6tRKjUfT4oK8zGC+7IJrU7n87S/kzMqHt+6eRgkDqiHA1UDzYlxl8NLjKqe6w2vqvJ4GotgGZ3iB5kaeKpZycb19qmq+M7IQBLmRKTU8Ir4r3aon97BeJc/XaRlnANR4zqV6NBc8w1N2KF+4HeUlHeurlQpog5qAa0ViOkaM+HxUpYrALjKuxsVtKnRYeUxeoUlvoCCByZ5KEbFTLk7ZOVPXUD8rARsAWI+ZEWOiijm/hHazLRMKjCAbQ23Fpq7e1HAIEKZMDdhpBCco5Al2jSVuNKCrRoM0LSBO4utcOWOPS9uDog2kXNk7gOMSbBQ3z0p1oJo7q0V+kSNAWEgym0YJLAy2f8AnQchdzonqCBEVeO0H7EyQjAE6LpyLkE+iHMIGBCAp4Wx2rIEgsrYm6AXSzMA44bI5eeleXKmjkCrGj+6TYMDkwOJDaCKR281wXo4MBGoHs4QMcXfE9QNzth3Hp+7BrBe//+1/IN2ZD6PSLZjCwlKMu6CJlvb+U7VXz2yeHa3pbIbbhDS8Pz6V4rSUcnMJpt5yKQHNieGoK1rC7RE4uNe3gNKBOgDRdo+Ff3Rd1E2v7+LBACF3NOCeNGyTvGUDquKk2NPsMhpMl0arhGSHWkQNmDhkAdlRY2g0ZJhYJGYZJFyTgjyALdhuwA/KZCSwnmCqYOIULafXMbG4TXtSWc2jAAysaDaNg9Cal4OTSRj0oui2PcJ+/mf3GzfqED91a99m8ij2oog87CUc0ENVT9o0eI82napOY+BDVMOmtPbaolrkozip6V+8ckhpkeI/h0QbIzTPGLXcIuk3+DIHIkt7EJOM8U544kFNUJZGybp167uZx5bZulyszsrS9QcyBXXa7f/Llq7H7T+OpWu9/QeydD0DYJ1P7Wppsuj0OVd2eB/h8gafJbP+h0Sq5TVhB5qEhUdzHoJLduhO7H+lcc4L8SsMdtaiVzr7nLHJTwbR0G234Z8pIehzyfoMp2V63WT8L0F4fU/j8jXw2UyXI+unYfcXnYk0GgLOFlg1yurLSazqQV1j49fD3quI7/PXO++/7nT2+I7eEW83ohc7T3bOst9+ffH6eYuNX3ei7q/j37q/mo8fEr3zWfLol9fDT+JX3XuxkX/87ZP6+NuO+vjhraEfNrZ6Yih6r37m0Xjjc6/b5m9evG5/+tAZ9V793P706/PsE3b+c/vT2Vk7Svde9MQW1Mk+/vaffP/z9uPdr9tfdw+3L3a/Js9bdO/L5xcX0fPds+0nzU87qrm73/vL5y8me7sRP977jT95xnbZB3HYfhPVqIGLhAt26pf6FOd9CottKWl93rK/kymzevsIU9gqCQqfO8AYNSZ0ACcQQJ26QypgSl3FLzeDbBki1tvt006BhI1ZJOwIvF6MqaIP5RkTP3am1eGNHR5AvUiTUmgF3FbC8qA22ep3O0nNolxxMw42jy6DiybNeNOWbx6dTE7gDG2GEoILMqkRYmqGwWawNh1rABm70ZN9dGl5sGA0TUUM4XczzEYzvnbeaXWCSTjdZi5zLqnP8uZNm2hDB1wMrmp3UqLoHSyjXakaokqFNeN/YaCxunWo1goDDuQzZBRMTYB5oI63ZYTGtl9jHzsxLxyiXMvpAAcf31ALWZjeh+cEIVRiEI58AAD69AuXflBOKCjc7kFQcaTDj4prHH4W2vxRSc2FX9kr2x3UUrvr66jOPe2g3vP4GaoU608mJxb5FUcShh5VvSHuBF4167tPdTN3EEyZlWu23WnT7kIz6wIrqxtyyprovs4z4nU2FpnPNuZarVxX8y0UrrB6/J1/lHUn2eufSiuHwTnr6fWf+mpC/B+s5uM2ruZ6G1fzWbumerk1KHsoFSjUkgolyU2gVIRA2zkB7uGiL5H1HM0VmVFBMiLrzijMLIlkWiQmbTR8k9///o+iVaNRHJRpkQd/P1ckkyOm4P0AzJ+fsAtM14pvG6RYptG8hrfbaAq2EQjKEYYNbPJ/uJ0Grinn/IhoRnuQgx9cK3hLCM2vld1DtyD/LN44HMv8gbL3784T2DAKk3M1ff9IqrN+IkeQFZ/04FoiGGiYGFIRWf+GFWNop4fzeZkOVhsFQHMLmhRG0ciQlAo6QEN7SKq4ilnCQdYTJXvg/tMyya2Dy1CeSGXtzDgfjIxDHG5fZFCESj8IDsWGwFznzsulQ+tltBLKJfbvgUM3A1g4WPiMJLlIJOTgB8dwnsCFPmOdtXC2qMIIzY2iQsOBwJm23RIUCHMOKKadLe29ZrDAb7g4s/llm+SoIKsPrKe5YfXkNdMC4lG9zStufsl7kFdcam6kGpetB9wM8x7uNdVOih+2p1f+7YjKTnL9m57vrE1Or20d7KCq8oj8/rf/Jm8YVYIM5cgSa5QrlozLZyrwRQVceYu2QtNAFyfN4VkGgzQqBt7rrosnEKhBw+weG4EF3HKUjXY8yHsJj4r3QTSk0nphXwEpHv6oJ9uwV+PA70xJZlsnXJy1yJYY2+cuCssifMd2tWmg13jBsxvlYxuHldFZqllyznTF0A6PaKA3X8l8YEerAuMmV78pCHPbimOSTd0WBD9QCY61jKEbnVoTGTxUMeeCYe0WXz2pMhMxXmrVmwQ1srL/cMoajJ71mU/+5mH5DortpvIWC2DSzbj4ak3oU1pQXdyiaR4G1LVXUGjGHTkdebIk9axQNydre6oWhkaogvtdnGZ8rqcUngLQ+/138MZM5I+ECzh6DSuvBWGQ8Ii5I77bvrZeHbwh549b7SCs6JbXYO61NzsvtvfebQMwIEgtwjqtdquNlkipTUpFZSR8S6cg1OmdrRLZu3qCZ/UEz+oJntUTPKsneFZP8Kye4Fk9wbN6gmf1BM+9x+7qCZ7VEzyL7qyunuBZPcEzfe179QTP6gme1RM89wKfqyd4Vk/w3DgX2eoJnqJg9QTP6gme49UTPKsneI5XT/Dcjzyyqyd4Vk/w3IkOt3qCZ/UEz+oJntUTPKsneP5AL5usnuD5ERS4eoJn9QTPrbO8rp7gmcdUqyd4Vk/wrJ7guXZa6tUTPN+Be1dP8Kye4Fk9wbNYBK2e4Fk9wXM/nEKrJ3hWT/CsnuBZPcGzeoJn9QTPnRpnVk/wrJ7g+X/2BE8lG8ZallAuKlmobLKco6mHeU7CYAjJdDaPgstLoMj3KplM4POXHJOAHJ2EwTlVHIL4MQ9P6PPGQPqNMwYpV17YGybNQxg+tOuMd56n0g9B4hvbYgunvrRuNd/Pwf67Q8gd4h4PSmWMmcnoCNJ10JHNqVLJ6YHfLoOEikGO+UAC2+fE5lke1vPknGGeHPdHJakI5JMpIawn0LHTgP/DpOY2uLy0OXgmk6K+LVrYwiHW14blO5lMJv8LlaF97Q==",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,y={},b=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options": {\n "hint": "Provide signature"\n }\n\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(82145)}),"\n",(0,s.jsx)(u(),{...t(66631)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},82145(e){e.exports=JSON.parse('{"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"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":true}}')},66631(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3795],{74646(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>f,default:()=>w,frontMatter:()=>g,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":"eJztPdlyGzmSv4Kt2AjbnCJF0pIPbezGqG21Wx7rWFtuty1pNWAVSMKqAsoAShStYMQ8zB/s077Op/WXbGQCqIOXDsse9S77oS0WrkQiM5HITCQuA0MHOtg8Cg5ZmiXUMB2chEHMdKR4ZrgUwWZwOGTEF5OXivYNFwOydbBDmKC9hGmSa6Y0MZJEikGlKNdGpvwrlBLjew6JZuoc2lJNeknOMsWF0aQvFRkwwRTFjmMZ5SmDghE3Q5IpFrM+Fywm2qg8MrliukXeZ1IQnUcR07qfJ3ZkLgWRfUKLMUNihgxBVczkSmhCSS74l5yRRkP2PrPI7MSNBnkYM80HghoWA3C++SmPH4VkNOTRkERUkB6DqcYwUwcwq4Dbo1AmBY6pMxbxPofKrrMW2YpjDjDSJBmHhJJGI1dJo0G4JpmS5zxmsR9N9vuAUoqoJVwYpvo0YogrBr2IAQ7jOydUxKRPI55wU0cjibk2ivdyGLl1LI7FIc82yfsskTQmY5krcvDy57K6kQS+HTUaL1kvH5D3O43GycOhMZneXFujWdaSGROArYT2dCuS6VoMFbO4j7hiikGviC9GNU/GhMYxGfF4wIzGBREkktmYRFKqmAtLGhkdMCLytMeUDnE2qVSMcEEoUYzG46aRzVwz8vrd/h6gIaWmRQ6SXIfFcDFXLDLJ2HYP6PGzemBX58k60BAXg5Ck9AywxA35kvPoDKatmcCldSSDuGo0PgC8BXa4djQeE2KGXJMR6w2lPCPsHIpHPEmIUXwwYKrROBZ//etfj8XlsSDkOMAax8EmOQ5cF8dBaIvMOGO25OX+i/e723uHp4cfD7aLck+pU3V2XhY1+jyZ7uH92zdFsaDpdPHe1m45gJDGlR8kjGpGFDvnbITrAEtt5+qxUDSryAnbuiiBRkxp+HoEXwi5tP/UoXm382pv+20VFluDpZQntSrbu1s7b2p1sqEU9W4Oftnfq/eTq0ovO3uvLFJs+QT+OXHwuhXZcgt0uLO7/e5wa/cAKk/cOgI1vMuzTCpY/g+WoDdhmY/FTyyRI0IVQ+qJZJpKQTKqaMoMysYhNVis2JecKxZb4UaTxHPG5rFokkYDcLPZaJD3VkrxmAkDckQh61uSwwYtWx9IB+rviJhHwEpWLIwzBpKwVhVYDKq+c6LJVq0wHsguK36Ao0bUSoMsAcEDVRUDqWb4Oat3fBGSMXT8kgEd2W6HUvGvUhiaIBGdM2V4RJMq0wOAKCoNVSiyMsmF8V/dCOSjY27gfWRpJ5UAtBiQm3KBJZqRc5rkTDuoRiEZAlRvWaaYRgnt+gXEi5gMGR8MF45H48+5NrWOSa693PVQuLH8qiJ6GaKtTxPNCO/XcJnSM1YZjcjM7gct8tOYxKxP88SEhIO8MipnLbInDaFZlvAI91KgAbtR5Yo1cZUd+bTq5HNg9xPYQWIOewlIJyjELlwbDx3Qpd2AYHood82QCiLF1EJHMpFqloTwcx2PJJLCMGFaZOuc8gSBt5PVhIsoyWNGegmNzkLUBEKiYO+DVRmzJJGj0PIHVsEdGXGO+CGaJUCFUgD8QrrhuS733BY5BEYp+A8KPapxEK6rWHUyvy9hZECBZ0mCcihExIXks+wRw03CQmDwjIpxSGKrZLAL05MXIYmGLDrDvxSNuSS93Bgp7MRiJbNYjoTDZV8Ko/nXORzpS26O0W5I1kPyJCTPQtJph6TTDUlnPSSdJyHpPAtJtx2Sbjck3fWQdJ9YsLrPHK5pgeAqAJ2uxbL5Y2F3yGN2Cg1PYW6nVBumuD4DcU1wR7eqaxw6LerCFIob7Fxxbccf8jhmgvSVTIliEc84ShMrDYquQ4CHKJiU0KSfJ8mYnHPNKzgoOpUjgWodfOWK7GdMvINtlkaRzGGNEcMWqYjOcslFMgZQDxlNNc58G5TDTHHNQFQLXWBAmJK2rDoE36oC4DorKeoSaPFqLlqdysrADvqGa5S5sPXpYjcd1XbTTos0GoWcm1akSm2pqFLoHbCbQVnH/b6AH4+7T93PMfx80n3mfo6wamfd/RzCz65v6pgLvjnd5TgABDo9yQpYUgEBKk0A/FJh6OJEDE2zJZOA4h81Ab9RwUfYYUJfUOpkVXgWzNnWcPMtZ/sYZssFN5wmevGEfY17NOcpkOZPu6w0M/N1mDmKs8XTdjrtvZlzFR5UgWEbtUW47VaK/IaAUHSXoGi6z0ViGFqhgjSDyY2W02IWI9JO4d7gsQLOXaFxqsubY/EJYBF21EPYURejsth07xE+p2G6K6TO6/fmmH3aQj0YFZTFeHUV7hFW6xDdFU5ne705Rp8BRkHTW4xOKL1HuKyAY60gqDbbsvZ6s7PR7La76zV8grnKVkjTZhw3x+Pxt61FysWphaNid8ECejG/AKxooD0WK1GUgA7DxaBoVi+dXXVbb2ohQed0mAC1059Ard4LFkpUn2fNC3j6L2u5Mw/+7Y/ku3AQ77HCSOoU54qN1dsDq6doI2M6fqBtV75pcfiC+tPqsQUTiwAOtI1GQ8kjBzzU8UeuHhh8WoCDJi7qWhyvVRYVPsZxM02bUx/hZxNpoPIxTVtx3JqqOUMo9mNK4jgks5/nfo9jkqbpgs/2e+3zWprOzqKVpg42hz1PezPrnHLB0xwOSWBmtWf0GE3fhx69qVtLLkij8fHjx4/N3d3my5eNhl9DN4Sj4ootw45AL+5ohCrRNxqbZKdPqp/QnmAtOSgFirMh2tZ9haEcCX8ksiZPEudgYPZVrT0ppWPsjHEzZKo+jlQlycIBEs5bPWmGLfIez5fwtz+HFeclPEs9B8HpDseLZaer8KPEZykl6wMvFa2LRVNNts6oRV4wZfP1JsUGeUIVuwADoJ42Ut92D7zZ/jYlFj0tl8YWNC064y7ztg7ycN8dwx8VFsapuUBvW87TRhQbsAuSUWOYEtjZOU14bD1iTes1uqBpBtaVtf86Po7/9K9raNsF86mxRoWYDzg4aNb+62ir+elkTo08y5iKwD2QMBhJh4SZqEWOhizJSh/RaDRqjR7raChlYh1En7Viffv/U9n7fIrgZi2qs0fzZmqJoWJLBWKZNqUic1YwRjXxLedYU3FpkGs6bdTgnLFiiQrnatwjvWMKJCi0huljdLMEKUXlFoiXlX9LkDnHwUm53aP9lMVXtD25BnsCNyS0x5LZopuzVkLHMncc7f0F9ak6iq7gzalChUkYp9OueIBSejFVeFx6f6b41CKkyqZ+t/fs6VeAJFwXG0kNndXWzmuAvh/BrN+4x4hvQHoFlX4zFxSAXY8NvIkU1+6KIaAewYqFx8aPdsUItYWZ2cmdruBdT/2iV48yv5FX8QUtwSVeqglLRnC6wuIRnE9/wQDHooOGSG/AXHI+cTXukayYAmk5G99GitR25ttsqbdiQD+tKgPO2V6hqt1YC+bTi7mvRfatVd03Aot7FLEMNK1vZs0C5GvvUGg1rhrRF1NetdY9or45YH1nCnT17nr3uRWRVmf/ByLUGtjXJlZr9E/pYIn9BovvEXlW4Zlv4nA1ZoxVHbT02x1liYUay5dPuNOuTXijPuEn7VucuGrDfvuBq70EPzNDwdk6T+jMdhCziKc0wSAShLv7DTx6m8OXAwx44IVMs9xUmQ7NOihYvJbgQyOsc/dPIWmGpBGStZA8DMmjFnnLMJgiKgIvnNLAlQ2v4BAsloOnNMpVMiY9BRMPCWsNWuTy8ktOheFmPJmQBrm8hAjCyaQFXHgm5MjGXhyB19gQiKQrD1WxjPScyDsZ6TU4fa3tsVHzpXMvrznQHpGHckokLD2KOhT82BOZhapCJDDKXqGy2VMpBvtwnSV0TGgfPNU2IASb2bihFqB4k3TJv/8H6XRb7XZI2vZviO60E+w+Qh5GH1PEkmVOSiy+ioPbVQ4uf84TWRvta7FwddhbcjB0cYphBDjulQpbydz30HRSTmbaWFvR6gFndv/UQ5knMeyeNt6XFQGdhU7faBwo1oc4zTKCj/hPnqchIoolLHVRYy52D44zGK3AhZHANz6co9Hosb6ESAUIKEXDIC1j/OzYduuuRYFg0KFUZEi1tbMgpgFiiJg1Q5ZOxUx48Mq4CS487EDKnbuzCHaf14n7yUaNuDfq+9NC4l5EwUsMhdBEZ1Lowh/IyqIK1akigHbu0WKaknynsNwYMlNG/qAQQ8JJ+BmryhoutNfSHJTTkXAvhlLqsoYLRnNyV2/Wg9ykgji3R60iNORb3V6dp49rSsSzH+j2qq9Se32ts7G21O815SK5+WGRkOssKVrVr7WkWLNc05VT6FucQt/OEY/v0jDbedqtnSceL9uc74lhtspRV5hk78Lwequz7TwLaJUPr2n7/GE2yG8ny/XvYY2ZEtxPO/8Ea8y3kuiM0eXOiJLclcVlHmVew+Sy1M7yzZRbBfa7U+/G3Zhnps46z2va4PNulVo3Nr6NWqeNMxWSOw74rz/tvx21//JqILe2trb23r0fbr8fbG1tpfC71WrNNdnNIwMcBvRndzHMbfGoLiwYpdVqobueGrqJzdcyMfg32z5c3Kbl4vG+kx9h40f7Eb5dbhRVf8yeNc9p8P0kw7fybBAGMsPLsFLsxMFmEMOVW3/RMwhx1Zg2P8l4HGxeBu5eCPzp4vSh5dpnDZd3LwMdDVlK4S+/2nDdF+4LBqG/pheEAUZGwt1foMZg0105DEKIrcjAHM409IHtNi99LXubMgidph9sBpYbgjBw8QbFJ8JEJCF4K4v7wcQPuKyr4kvZlcY/iluv0A9cObtlN9h0MnXd+VY9VXuYlGgtO6NK0XEwfbPa3zXz8SsuhMgb7ZKx3024AWtacQEKqwVhwA1Lq6MsWDQlb47piEmYCQZ037QtLgtNbzwmtMNbnbdp6EJRb9P0s+yd3oocobGzycxZ62uuji2dHbhOKltw34bFXq9ulhdPQnsfo3UVpfr6iGU6qI5pbWkzYx4uuh5auZXmLG40yxhVLbyleevr45hBgCZRjjfaC2lcm1kBajGzziQMLq6ezAWJZNPfPSUPE9Y3NqCJRFIJph5VA1TvzeS66+uTMBhfPb3xH3J6T2HxRlfP7gNe2i0vNP8zYH38bBIGw6th/aW4VvxPBHb9yaTcY93t9iKrRU/G41MvtyZXVfSbGdSDFAk7Yl/FTFUQ0ZMyYVTMYAJCau3J6AFolw9CG0aI9we50n4js1kTFIsY3Cz3obQoq4jTdezFIn8DC/xJ2/ABtTOd9zTUEr4/bTvsMZ+JAVKH2Brcpt5Auzyj0RByPrjgxtKtlEHyA5lrDx6Y52F3SRhY3K2vrwjvrR7fKtiphA/bubeqqwNfYHPFO6j7hwfXwCWeLZs2AYC7F4qztH2Q/cMDuGPP+079g+jhAhMetbRWhYA6Rs459fdwC9k+tqFXzJpUpc8AUXouWu52e5PMAhRzPReiEG582iujRbqYmY7LFB6wRDI34AlxOVOINizTNTwiFAUiD2V+Haq8ApOUDHK8ZGCAZf2Fewx2Le/Ic2Fz0eAxw0V8VwPEMyUhMU2JJ48VqFTpPyRMaNuckj56xEJIUAOYVzkcKoou2UXGFAfP81wUKGZRd5qrufpaHQf1C+fv375xiVsqceyeh3zHLCZ5hlSDnFAkQvArNz31GUUJuIOp00WK4azqgf50ZzPJmNKQ3EcRqQZU8K8u2Q9oJHDI6rEhTWxVJyrAGo+B+ECvNWC8rP397/+owLVQ050FzI5A4xh8o1dAiCdJS/Cg6SuWgQSUdYigP6b+PL0JAHTINKepjAtG0ten8QMM3taFXHSexcKzqfNoCAeLQt7qsLjl6tRKjUfT4oK8zGC+7IJrU7n87S/kzMqHt+6eRgkDqiHA1UDzYlxl8NLjKqe6w2vqvJ4GotgGZ3iB5kaeKpZycb19qmq+M7IQBLmRKTU8Ir4r3aon97BeJc/XaRlnANR4zqV6NBc8w1N2KF+4HeUlHeurlQpog5qAa0ViOkaM+HxUpYrALjKuxsVtKnRYeUxeoUlvoCCByZ5KEbFTLk7ZOVPXUD8rARsAWI+ZEWOiijm/hHazLRMKjCAbQ23Fpq7e1HAIEKZMDdhpBCco5Al2jSVuNKCrRoM0LSBO4utcOWOPS9uDog2kXNk7gOMSbBQ3z0p1oJo7q0V+kSNAWEgym0YJLAy2f8AnQchdzonqCBEVeO0H7EyQjAE6LpyLkE+iHMIGBCAp4Wx2rIEgsrYm6AXSzMA44bI5eeleXKmjkCrGj+6TYMDkwOJDaCKR281wXo4MBGoHs4QMcXfE9QNzth3Hp+7BrBe//+1/IN2ZD6PSLZjCwlKMu6CJlvb+U7VXz2yeHa3pbIbbhDS8Pz6V4rSUcnMJpt5yKQHNieGoK1rC7RE4uNe3gNKBOgDRdo+Ff3Rd1E2v7+LBACF3NOCeNGyTvGUDquKk2NPsMhpMl0arhGSHWkQNmDhkAdlRY2g0ZJhYJGYZJFyTgjyALdhuwA/KZCSwnmCqYOIULafXMbG4TXtSWc2jAAysaDaNg9Cal4OTSRj0oui2PcJ+/mf3GzfqED91a99m8ij2oog87CUc0ENVT9o0eI82napOY+BDVMOmtPbaolrkozip6V+8ckhpkeI/h0QbIzTPGLXcIuk3+DIHIkt7EJOM8U544kFNUJZGybp167uZx5bZulyszsrS9QcyBXXa7f/Llq7H7T+OpWu9/QeydD0DYJ1P7Wppsuj0OVd2eB/h8gafJbP+h0Sq5TVhB5qEhUdzHoJLduhO7H+lcc4L8SsMdtaiVzr7nLHJTwbR0G234Z8pIehzyfoMp2V63WT8L0F4fU/j8jXw2UyXI+unYfcXnYk0GgLOFlg1yurLSazqQV1j49fD3quI7/PXO++/7nT2+I7eEW83ohc7T3bOst9+ffH6eYuNX3ei7q/j37q/mo8fEr3zWfLol9fDT+JX3XuxkX/87ZP6+NuO+vjhraEfNrZ6Yih6r37m0Xjjc6/b5m9evG5/+tAZ9V793P706/PsE3b+c/vT2Vk7Svde9MQW1Mk+/vaffP/z9uPdr9tfdw+3L3a/Js9bdO/L5xcX0fPds+0nzU87qrm73/vL5y8me7sRP977jT95xnbZB3HYfhPVqIGLhAt26pf6FOd9CottKWl93rK/kymzevsIU9gqCQqfO8AYNSZ0ACcQQJ26QypgSl3FLzeDbBki1tvt006BhI1ZJOwIvF6MqaIP5RkTP3am1eGNHR5AvUiTUmgF3FbC8qA22ep3O0nNolxxMw42jy6DiybNeNOWbx6dTE7gDG2GEoILMqkRYmqGwWawNh1rABm70ZN9dGl5sGA0TUUM4XczzEYzvnbeaXWCSTjdZi5zLqnP8uZNm2hDB1wMrmp3UqLoHSyjXakaokqFNeN/YaCxunWo1goDDuQzZBRMTYB5oI63ZYTGtl9jHzsxLxyiXMvpAAcf31ALWZjeh+cEIVRiEI58AAD69AuXflBOKCjc7kFQcaTDj4prHH4W2vxRSc2FX9kr2x3UUrvr66jOPe2g3vP4GaoU608mJxb5FUcShh5VvSHuBF4167tPdTN3EEyZlWu23WnT7kIz6wIrqxtyyprovs4z4nU2FpnPNuZarVxX8y0UrrB6/J1/lHUn2eufSiuHwTnr6fWf+mpC/B+s5uM2ruZ6G1fzWbumerk1KHsoFSjUkgolyU2gVIRA2zkB7uGiL5H1HM0VmVFBMiLrzijMLIlkWiQmbTR8k9///o+iVaNRHJRpkQd/P1ckkyOm4P0AzJ+fsAtM14pvG6RYptG8hrfbaAq2EQjKEYYNbPJ/uJ0Grinn/IhoRnuQgx9cK3hLCM2vld1DtyD/LN44HMv8gbL3785ZAjtGYXOu5u8fSXXWT+QI0uKTHtxLBAsNE0MqIuvgsHIMDfVwQC/zwWqjAGpuYZPCKBoZklJBB2hpD0kVWTFLOAh7omQP/H9aJrn1cBnKE6msoRknhKFxiMTtiwyKUOsHyaHYELjr3Lm5dGjdjFZEucz+PfDoZgALBxOfkSQXiYQk/OAZzhO40WestxYOF1UYoblRVGg4ETjbtluDAmHOA8W0M6a91wxW+A0XZzbBbJMcFXT1gfU0N6yevWZaQjyqt3nFzS95DxKLS82NVOOy9YCbYd7DzabaSfHD9vTKPx5R2Uquf9XznTXK6bWtgx3UVR6R3//23+QNo0qQoRxZao1yxZJx+U4FPqmAK2/RVqga6OOkObzLYJBIxcC73XXxBgI1aJndYyMwgVuWsuGOB3kv4VHxQIiGXFov7DMgxcsf9Wwb9m4cOJ4pyWzrhIuzFtkSY/veRWFahO/YrjYNdBsveHejfG3jsDI6SzVLzpmuWNrhFQ105yuZD+xoVWDc5OpXBWFuW3FMsqnrguAIKsGxpjH0o1NrI4OXKubcMKxd46tnVWYixlutepOgSlb2H06Zg9G1PvPJXz0sH0Kx3VQeYwFMuhkXX60NfUoNqstbtM3DgLr2DArNuCOnI0+WpJ4W6uZkbY/VwtAIdXC/jdOMz3WVwlsAer//Dh6ZifyZcAFHr2HltSAMEh4xd8Z3+9fWq4M35Pxxqx2EFeXyGsy99mbnxfbeu20ABgSpRVin1W610RQptUmpqIyEj+kUhDq9tVVCe1dv8Kze4Fm9wbN6g2f1Bs/qDZ7VGzyrN3hWb/Cs3uC599hdvcGzeoNn0aXV1Rs8qzd4pu99r97gWb3Bs3qD517gc/UGz+oNnhsnI1u9wVMUrN7gWb3Bc7x6g2f1Bs/x6g2e+5FIdvUGz+oNnjvR4VZv8Kze4Fm9wbN6g2f1Bs8f6GmT1Rs8P4ICV2/wrN7guXWa19UbPPOYavUGz+oNntUbPNfOS716g+c7cO/qDZ7VGzyrN3gWi6DVGzyrN3juh1No9QbP6g2e1Rs8qzd4Vm/wrN7guVPjzOoNntUbPP/P3uCppMNYyxLKRSUNlc2WczT1Ms9JGAwhm87mUXB5CRT5XiWTCXz+kmMWkKOTMDinikMQPybiCX3iGMi/ccYg58oLe8OkeQjDh3ad8c7zVP4hyHxjW2zh1JfWrSb8Odh/dwjJQ9zrQamMMTUZHUG+DjqySVUqST3w22WQUDHIMSFIYPuc2ETLw3qinDNMlOP+qGQVgYQyJYT1DDp2GvB/mNTcBpeXNgnPZFLUt0ULWzjE+tqwfCeTyeR/AavMflI=","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 Signing Links","permalink":"/docs/API-docs/v1.1/getsigninglinks"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdlyGzmSv4Kt2AjbnCJF0pIPbezGqG21Wx7rWFtuty1pNWAVSMKqAsoAShStYMQ8zB/s077Op/WXbGQCqIOXDsse9S77oS0WrkQiM5HITCQuA0MHOtg8Cg5ZmiXUMB2chEHMdKR4ZrgUwWZwOGTEF5OXivYNFwOydbBDmKC9hGmSa6Y0MZJEikGlKNdGpvwrlBLjew6JZuoc2lJNeknOMsWF0aQvFRkwwRTFjmMZ5SmDghE3Q5IpFrM+Fywm2qg8MrliukXeZ1IQnUcR07qfJ3ZkLgWRfUKLMUNihgxBVczkSmhCSS74l5yRRkP2PrPI7MSNBnkYM80HghoWA3C++SmPH4VkNOTRkERUkB6DqcYwUwcwq4Dbo1AmBY6pMxbxPofKrrMW2YpjDjDSJBmHhJJGI1dJo0G4JpmS5zxmsR9N9vuAUoqoJVwYpvo0YogrBr2IAQ7jOydUxKRPI55wU0cjibk2ivdyGLl1LI7FIc82yfsskTQmY5krcvDy57K6kQS+HTUaL1kvH5D3O43GycOhMZneXFujWdaSGROArYT2dCuS6VoMFbO4j7hiikGviC9GNU/GhMYxGfF4wIzGBREkktmYRFKqmAtLGhkdMCLytMeUDnE2qVSMcEEoUYzG46aRzVwz8vrd/h6gIaWmRQ6SXIfFcDFXLDLJ2HYP6PGzemBX58k60BAXg5Ck9AywxA35kvPoDKatmcCldSSDuGo0PgC8BXa4djQeE2KGXJMR6w2lPCPsHIpHPEmIUXwwYKrROBZ//etfj8XlsSDkOMAax8EmOQ5cF8dBaIvMOGO25OX+i/e723uHp4cfD7aLck+pU3V2XhY1+jyZ7uH92zdFsaDpdPHe1m45gJDGlR8kjGpGFDvnbITrAEtt5+qxUDSryAnbuiiBRkxp+HoEXwi5tP/UoXm382pv+20VFluDpZQntSrbu1s7b2p1sqEU9W4Oftnfq/eTq0ovO3uvLFJs+QT+OXHwuhXZcgt0uLO7/e5wa/cAKk/cOgI1vMuzTCpY/g+WoDdhmY/FTyyRI0IVQ+qJZJpKQTKqaMoMysYhNVis2JecKxZb4UaTxHPG5rFokkYDcLPZaJD3VkrxmAkDckQh61uSwwYtWx9IB+rviJhHwEpWLIwzBpKwVhVYDKq+c6LJVq0wHsguK36Ao0bUSoMsAcEDVRUDqWb4Oat3fBGSMXT8kgEd2W6HUvGvUhiaIBGdM2V4RJMq0wOAKCoNVSiyMsmF8V/dCOSjY27gfWRpJ5UAtBiQm3KBJZqRc5rkTDuoRiEZAlRvWaaYRgnt+gXEi5gMGR8MF45H48+5NrWOSa693PVQuLH8qiJ6GaKtTxPNCO/XcJnSM1YZjcjM7gct8tOYxKxP88SEhIO8MipnLbInDaFZlvAI91KgAbtR5Yo1cZUd+bTq5HNg9xPYQWIOewlIJyjELlwbDx3Qpd2AYHood82QCiLF1EJHMpFqloTwcx2PJJLCMGFaZOuc8gSBt5PVhIsoyWNGegmNzkLUBEKiYO+DVRmzJJGj0PIHVsEdGXGO+CGaJUCFUgD8QrrhuS733BY5BEYp+A8KPapxEK6rWHUyvy9hZECBZ0mCcihExIXks+wRw03CQmDwjIpxSGKrZLAL05MXIYmGLDrDvxSNuSS93Bgp7MRiJbNYjoTDZV8Ko/nXORzpS26O0W5I1kPyJCTPQtJph6TTDUlnPSSdJyHpPAtJtx2Sbjck3fWQdJ9YsLrPHK5pgeAqAJ2uxbL5Y2F3yGN2Cg1PYW6nVBumuD4DcU1wR7eqaxw6LerCFIob7Fxxbccf8jhmgvSVTIliEc84ShMrDYquQ4CHKJiU0KSfJ8mYnHPNKzgoOpUjgWodfOWK7GdMvINtlkaRzGGNEcMWqYjOcslFMgZQDxlNNc58G5TDTHHNQFQLXWBAmJK2rDoE36oC4DorKeoSaPFqLlqdysrADvqGa5S5sPXpYjcd1XbTTos0GoWcm1akSm2pqFLoHbCbQVnH/b6AH4+7T93PMfx80n3mfo6wamfd/RzCz65v6pgLvjnd5TgABDo9yQpYUgEBKk0A/FJh6OJEDE2zJZOA4h81Ab9RwUfYYUJfUOpkVXgWzNnWcPMtZ/sYZssFN5wmevGEfY17NOcpkOZPu6w0M/N1mDmKs8XTdjrtvZlzFR5UgWEbtUW47VaK/IaAUHSXoGi6z0ViGFqhgjSDyY2W02IWI9JO4d7gsQLOXaFxqsubY/EJYBF21EPYURejsth07xE+p2G6K6TO6/fmmH3aQj0YFZTFeHUV7hFW6xDdFU5ne705Rp8BRkHTW4xOKL1HuKyAY60gqDbbsvZ6s7PR7La76zV8grnKVkjTZhw3x+Pxt61FysWphaNid8ECejG/AKxooD0WK1GUgA7DxaBoVi+dXXVbb2ohQed0mAC1059Ard4LFkpUn2fNC3j6L2u5Mw/+7Y/ku3AQ77HCSOoU54qN1dsDq6doI2M6fqBtV75pcfiC+tPqsQUTiwAOtI1GQ8kjBzzU8UeuHhh8WoCDJi7qWhyvVRYVPsZxM02bUx/hZxNpoPIxTVtx3JqqOUMo9mNK4jgks5/nfo9jkqbpgs/2e+3zWprOzqKVpg42hz1PezPrnHLB0xwOSWBmtWf0GE3fhx69qVtLLkij8fHjx4/N3d3my5eNhl9DN4Sj4ootw45AL+5ohCrRNxqbZKdPqp/QnmAtOSgFirMh2tZ9haEcCX8ksiZPEudgYPZVrT0ppWPsjHEzZKo+jlQlycIBEs5bPWmGLfIez5fwtz+HFeclPEs9B8HpDseLZaer8KPEZykl6wMvFa2LRVNNts6oRV4wZfP1JsUGeUIVuwADoJ42Ut92D7zZ/jYlFj0tl8YWNC064y7ztg7ycN8dwx8VFsapuUBvW87TRhQbsAuSUWOYEtjZOU14bD1iTes1uqBpBtaVtf86Po7/9K9raNsF86mxRoWYDzg4aNb+62ir+elkTo08y5iKwD2QMBhJh4SZqEWOhizJSh/RaDRqjR7raChlYh1En7Viffv/U9n7fIrgZi2qs0fzZmqJoWJLBWKZNqUic1YwRjXxLedYU3FpkGs6bdTgnLFiiQrnatwjvWMKJCi0huljdLMEKUXlFoiXlX9LkDnHwUm53aP9lMVXtD25BnsCNyS0x5LZopuzVkLHMncc7f0F9ak6iq7gzalChUkYp9OueIBSejFVeFx6f6b41CKkyqZ+t/fs6VeAJFwXG0kNndXWzmuAvh/BrN+4x4hvQHoFlX4zFxSAXY8NvIkU1+6KIaAewYqFx8aPdsUItYWZ2cmdruBdT/2iV48yv5FX8QUtwSVeqglLRnC6wuIRnE9/wQDHooOGSG/AXHI+cTXukayYAmk5G99GitR25ttsqbdiQD+tKgPO2V6hqt1YC+bTi7mvRfatVd03Aot7FLEMNK1vZs0C5GvvUGg1rhrRF1NetdY9or45YH1nCnT17nr3uRWRVmf/ByLUGtjXJlZr9E/pYIn9BovvEXlW4Zlv4nA1ZoxVHbT02x1liYUay5dPuNOuTXijPuEn7VucuGrDfvuBq70EPzNDwdk6T+jMdhCziKc0wSAShLv7DTx6m8OXAwx44IVMs9xUmQ7NOihYvJbgQyOsc/dPIWmGpBGStZA8DMmjFnnLMJgiKgIvnNLAlQ2v4BAsloOnNMpVMiY9BRMPCWsNWuTy8ktOheFmPJmQBrm8hAjCyaQFXHgm5MjGXhyB19gQiKQrD1WxjPScyDsZ6TU4fa3tsVHzpXMvrznQHpGHckokLD2KOhT82BOZhapCJDDKXqGy2VMpBvtwnSV0TGgfPNU2IASb2bihFqB4k3TJv/8H6XRb7XZI2vZviO60E+w+Qh5GH1PEkmVOSiy+ioPbVQ4uf84TWRvta7FwddhbcjB0cYphBDjulQpbydz30HRSTmbaWFvR6gFndv/UQ5knMeyeNt6XFQGdhU7faBwo1oc4zTKCj/hPnqchIoolLHVRYy52D44zGK3AhZHANz6co9Hosb6ESAUIKEXDIC1j/OzYduuuRYFg0KFUZEi1tbMgpgFiiJg1Q5ZOxUx48Mq4CS487EDKnbuzCHaf14n7yUaNuDfq+9NC4l5EwUsMhdBEZ1Lowh/IyqIK1akigHbu0WKaknynsNwYMlNG/qAQQ8JJ+BmryhoutNfSHJTTkXAvhlLqsoYLRnNyV2/Wg9ykgji3R60iNORb3V6dp49rSsSzH+j2qq9Se32ts7G21O815SK5+WGRkOssKVrVr7WkWLNc05VT6FucQt/OEY/v0jDbedqtnSceL9uc74lhtspRV5hk78Lwequz7TwLaJUPr2n7/GE2yG8ny/XvYY2ZEtxPO/8Ea8y3kuiM0eXOiJLclcVlHmVew+Sy1M7yzZRbBfa7U+/G3Zhnps46z2va4PNulVo3Nr6NWqeNMxWSOw74rz/tvx21//JqILe2trb23r0fbr8fbG1tpfC71WrNNdnNIwMcBvRndzHMbfGoLiwYpdVqobueGrqJzdcyMfg32z5c3Kbl4vG+kx9h40f7Eb5dbhRVf8yeNc9p8P0kw7fybBAGMsPLsFLsxMFmEMOVW3/RMwhx1Zg2P8l4HGxeBu5eCPzp4vSh5dpnDZd3LwMdDVlK4S+/2nDdF+4LBqG/pheEAUZGwt1foMZg0105DEKIrcjAHM409IHtNi99LXubMgidph9sBpYbgjBw8QbFJ8JEJCF4K4v7wcQPuKyr4kvZlcY/iluv0A9cObtlN9h0MnXd+VY9VXuYlGgtO6NK0XEwfbPa3zXz8SsuhMgb7ZKx3024AWtacQEKqwVhwA1Lq6MsWDQlb47piEmYCQZ037QtLgtNbzwmtMNbnbdp6EJRb9P0s+yd3oocobGzycxZ62uuji2dHbhOKltw34bFXq9ulhdPQnsfo3UVpfr6iGU6qI5pbWkzYx4uuh5auZXmLG40yxhVLbyleevr45hBgCZRjjfaC2lcm1kBajGzziQMLq6ezAWJZNPfPSUPE9Y3NqCJRFIJph5VA1TvzeS66+uTMBhfPb3xH3J6T2HxRlfP7gNe2i0vNP8zYH38bBIGw6th/aW4VvxPBHb9yaTcY93t9iKrRU/G41MvtyZXVfSbGdSDFAk7Yl/FTFUQ0ZMyYVTMYAJCau3J6AFolw9CG0aI9we50n4js1kTFIsY3Cz3obQoq4jTdezFIn8DC/xJ2/ABtTOd9zTUEr4/bTvsMZ+JAVKH2Brcpt5Auzyj0RByPrjgxtKtlEHyA5lrDx6Y52F3SRhY3K2vrwjvrR7fKtiphA/bubeqqwNfYHPFO6j7hwfXwCWeLZs2AYC7F4qztH2Q/cMDuGPP+079g+jhAhMetbRWhYA6Rs459fdwC9k+tqFXzJpUpc8AUXouWu52e5PMAhRzPReiEG582iujRbqYmY7LFB6wRDI34AlxOVOINizTNTwiFAUiD2V+Haq8ApOUDHK8ZGCAZf2Fewx2Le/Ic2Fz0eAxw0V8VwPEMyUhMU2JJ48VqFTpPyRMaNuckj56xEJIUAOYVzkcKoou2UXGFAfP81wUKGZRd5qrufpaHQf1C+fv375xiVsqceyeh3zHLCZ5hlSDnFAkQvArNz31GUUJuIOp00WK4azqgf50ZzPJmNKQ3EcRqQZU8K8u2Q9oJHDI6rEhTWxVJyrAGo+B+ECvNWC8rP397/+owLVQ050FzI5A4xh8o1dAiCdJS/Cg6SuWgQSUdYigP6b+PL0JAHTINKepjAtG0ten8QMM3taFXHSexcKzqfNoCAeLQt7qsLjl6tRKjUfT4oK8zGC+7IJrU7n87S/kzMqHt+6eRgkDqiHA1UDzYlxl8NLjKqe6w2vqvJ4GotgGZ3iB5kaeKpZycb19qmq+M7IQBLmRKTU8Ir4r3aon97BeJc/XaRlnANR4zqV6NBc8w1N2KF+4HeUlHeurlQpog5qAa0ViOkaM+HxUpYrALjKuxsVtKnRYeUxeoUlvoCCByZ5KEbFTLk7ZOVPXUD8rARsAWI+ZEWOiijm/hHazLRMKjCAbQ23Fpq7e1HAIEKZMDdhpBCco5Al2jSVuNKCrRoM0LSBO4utcOWOPS9uDog2kXNk7gOMSbBQ3z0p1oJo7q0V+kSNAWEgym0YJLAy2f8AnQchdzonqCBEVeO0H7EyQjAE6LpyLkE+iHMIGBCAp4Wx2rIEgsrYm6AXSzMA44bI5eeleXKmjkCrGj+6TYMDkwOJDaCKR281wXo4MBGoHs4QMcXfE9QNzth3Hp+7BrBe//+1/IN2ZD6PSLZjCwlKMu6CJlvb+U7VXz2yeHa3pbIbbhDS8Pz6V4rSUcnMJpt5yKQHNieGoK1rC7RE4uNe3gNKBOgDRdo+Ff3Rd1E2v7+LBACF3NOCeNGyTvGUDquKk2NPsMhpMl0arhGSHWkQNmDhkAdlRY2g0ZJhYJGYZJFyTgjyALdhuwA/KZCSwnmCqYOIULafXMbG4TXtSWc2jAAysaDaNg9Cal4OTSRj0oui2PcJ+/mf3GzfqED91a99m8ij2oog87CUc0ENVT9o0eI82napOY+BDVMOmtPbaolrkozip6V+8ckhpkeI/h0QbIzTPGLXcIuk3+DIHIkt7EJOM8U544kFNUJZGybp167uZx5bZulyszsrS9QcyBXXa7f/Llq7H7T+OpWu9/QeydD0DYJ1P7Wppsuj0OVd2eB/h8gafJbP+h0Sq5TVhB5qEhUdzHoJLduhO7H+lcc4L8SsMdtaiVzr7nLHJTwbR0G234Z8pIehzyfoMp2V63WT8L0F4fU/j8jXw2UyXI+unYfcXnYk0GgLOFlg1yurLSazqQV1j49fD3quI7/PXO++/7nT2+I7eEW83ohc7T3bOst9+ffH6eYuNX3ei7q/j37q/mo8fEr3zWfLol9fDT+JX3XuxkX/87ZP6+NuO+vjhraEfNrZ6Yih6r37m0Xjjc6/b5m9evG5/+tAZ9V793P706/PsE3b+c/vT2Vk7Svde9MQW1Mk+/vaffP/z9uPdr9tfdw+3L3a/Js9bdO/L5xcX0fPds+0nzU87qrm73/vL5y8me7sRP977jT95xnbZB3HYfhPVqIGLhAt26pf6FOd9CottKWl93rK/kymzevsIU9gqCQqfO8AYNSZ0ACcQQJ26QypgSl3FLzeDbBki1tvt006BhI1ZJOwIvF6MqaIP5RkTP3am1eGNHR5AvUiTUmgF3FbC8qA22ep3O0nNolxxMw42jy6DiybNeNOWbx6dTE7gDG2GEoILMqkRYmqGwWawNh1rABm70ZN9dGl5sGA0TUUM4XczzEYzvnbeaXWCSTjdZi5zLqnP8uZNm2hDB1wMrmp3UqLoHSyjXakaokqFNeN/YaCxunWo1goDDuQzZBRMTYB5oI63ZYTGtl9jHzsxLxyiXMvpAAcf31ALWZjeh+cEIVRiEI58AAD69AuXflBOKCjc7kFQcaTDj4prHH4W2vxRSc2FX9kr2x3UUrvr66jOPe2g3vP4GaoU608mJxb5FUcShh5VvSHuBF4167tPdTN3EEyZlWu23WnT7kIz6wIrqxtyyprovs4z4nU2FpnPNuZarVxX8y0UrrB6/J1/lHUn2eufSiuHwTnr6fWf+mpC/B+s5uM2ruZ6G1fzWbumerk1KHsoFSjUkgolyU2gVIRA2zkB7uGiL5H1HM0VmVFBMiLrzijMLIlkWiQmbTR8k9///o+iVaNRHJRpkQd/P1ckkyOm4P0AzJ+fsAtM14pvG6RYptG8hrfbaAq2EQjKEYYNbPJ/uJ0Grinn/IhoRnuQgx9cK3hLCM2vld1DtyD/LN44HMv8gbL3785ZAjtGYXOu5u8fSXXWT+QI0uKTHtxLBAsNE0MqIuvgsHIMDfVwQC/zwWqjAGpuYZPCKBoZklJBB2hpD0kVWTFLOAh7omQP/H9aJrn1cBnKE6msoRknhKFxiMTtiwyKUOsHyaHYELjr3Lm5dGjdjFZEucz+PfDoZgALBxOfkSQXiYQk/OAZzhO40WestxYOF1UYoblRVGg4ETjbtluDAmHOA8W0M6a91wxW+A0XZzbBbJMcFXT1gfU0N6yevWZaQjyqt3nFzS95DxKLS82NVOOy9YCbYd7DzabaSfHD9vTKPx5R2Uquf9XznTXK6bWtgx3UVR6R3//23+QNo0qQoRxZao1yxZJx+U4FPqmAK2/RVqga6OOkObzLYJBIxcC73XXxBgI1aJndYyMwgVuWsuGOB3kv4VHxQIiGXFov7DMgxcsf9Wwb9m4cOJ4pyWzrhIuzFtkSY/veRWFahO/YrjYNdBsveHejfG3jsDI6SzVLzpmuWNrhFQ105yuZD+xoVWDc5OpXBWFuW3FMsqnrguAIKsGxpjH0o1NrI4OXKubcMKxd46tnVWYixlutepOgSlb2H06Zg9G1PvPJXz0sH0Kx3VQeYwFMuhkXX60NfUoNqstbtM3DgLr2DArNuCOnI0+WpJ4W6uZkbY/VwtAIdXC/jdOMz3WVwlsAer//Dh6ZifyZcAFHr2HltSAMEh4xd8Z3+9fWq4M35Pxxqx2EFeXyGsy99mbnxfbeu20ABgSpRVin1W610RQptUmpqIyEj+kUhDq9tVVCe1dv8Kze4Fm9wbN6g2f1Bs/qDZ7VGzyrN3hWb/Cs3uC599hdvcGzeoNn0aXV1Rs8qzd4pu99r97gWb3Bs3qD517gc/UGz+oNnhsnI1u9wVMUrN7gWb3Bc7x6g2f1Bs/x6g2e+5FIdvUGz+oNnjvR4VZv8Kze4Fm9wbN6g2f1Bs8f6GmT1Rs8P4ICV2/wrN7guXWa19UbPPOYavUGz+oNntUbPNfOS716g+c7cO/qDZ7VGzyrN3gWi6DVGzyrN3juh1No9QbP6g2e1Rs8qzd4Vm/wrN7guVPjzOoNntUbPP/P3uCppMNYyxLKRSUNlc2WczT1Ms9JGAwhm87mUXB5CRT5XiWTCXz+kmMWkKOTMDinikMQPybiCX3iGMi/ccYg58oLe8OkeQjDh3ad8c7zVP4hyHxjW2zh1JfWrSb8Odh/dwjJQ9zrQamMMTUZHUG+DjqySVUqST3w22WQUDHIMSFIYPuc2ETLw3qinDNMlOP+qGQVgYQyJYT1DDp2GvB/mNTcBpeXNgnPZFLUt0ULWzjE+tqwfCeTyeR/AavMflI=",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,b={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options": {\n "hint": "Provide signature"\n }\n\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\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 "hint": "Provide name",\n "hide_text_with_asterisks": false\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 "hint": "Provide job title",\n "hide_text_with_asterisks": false\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 "hint": "Provide company",\n "hide_text_with_asterisks": false\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 "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\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 "hide_text_with_asterisks": false\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:"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 "hint": "Provide 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": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\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.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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\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 "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(82145)}),"\n",(0,s.jsx)(u(),{...t(66631)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},82145(e){e.exports=JSON.parse('{"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":true},"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":false},"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":false},"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":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"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":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"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":true}}')},66631(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.0e8215f8.js b/assets/js/c7e3ab5f.0e8215f8.js new file mode 100644 index 000000000..5dfc2b65a --- /dev/null +++ b/assets/js/c7e3ab5f.0e8215f8.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4833],{69222(e,t,o){o.r(t),o.d(t,{assets:()=>f,contentTitle:()=>k,default:()=>I,frontMatter:()=>v,metadata:()=>a,toc:()=>g});const a=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 n=o(74848),i=o(28453),r=o(57742),c=o.n(r),s=o(78178),l=o.n(s),p=o(19624),d=o.n(p),m=o(96226),u=o.n(m),h=(o(77675),o(19365),o(51107)),y=o(21312);const v={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},k=void 0,f={},g=[];function b(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,n.jsx)(c(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(l(),{...o(39903)}),"\n",(0,n.jsx)(d(),{...o(56949)}),"\n",(0,n.jsx)(u(),{...o(21531)})]})}function I(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}},39903(e){e.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"Provide objectId of contact to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},56949(e){e.exports={title:"Body"}},21531(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.9fa0d100.js b/assets/js/c7e3ab5f.9fa0d100.js deleted file mode 100644 index 826c75c80..000000000 --- a/assets/js/c7e3ab5f.9fa0d100.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4833],{69222(t,e,o){o.r(e),o.d(e,{assets:()=>k,contentTitle:()=>b,default:()=>C,frontMatter:()=>y,metadata:()=>a,toc:()=>P});const a=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/++Z9BajQC5YqmRkupHMfv7Xv7rgng3QrDvDEgrYK5wUedG0xiWKezYWhHlLXBGM0atCUsgyQEpUtN0gDjxB2kkF7m2miuYmZz7VTfuwhxDLcVUoWBj74IvAYoXBqufZANOR7hthzchZULizlvDxlIyJuoLcYIaCtpC2bsE5GBCyAtoCUMPuiIECmw07p1zVkKfPtraWWJrDuDfawUGs3VCsHlTSSIzjTJYyCpjQuooI+H95CYMDznmRwQ2t2l9gErrpolQtlohTGDwimEmO4sh2AV5BgJPPuiC4ystLHGFYuUPx6r4B23EC0N7wr7PrI4BWkjT/jWlz4FA2A+OJ7P2Do4Gv0UkRN8qe0izkaj9/YI7oayusU8asL7L/sbsFqtnlX+q0OZt5q+a3L4Eb2LmlxY76RLTVWTp9uyr2T4aDW9RYupfPbuwk6HckV8fvmYOqnQ+Mk1EldInJxdXaSu+wo+/PovuEQZLFRu1RZr0QQ0ayh7U4xcm/kWtqFpwtylwqsY8aItPl7FMFKP4G0l6cOv/47wA65A2+5GcSij0VWTG13ADdaeJ2QcjWbwJiCbpJ4GVEmCQlrIEWIluZSWWvIm20obbRdjOLNraCIGWGmqUjEwPckdhMG4DOmOkMuICpxNEr3N8c4jptcRzRIj6+LhlyOg0rzMURVcU7bW9p3pggs418bArVYlUortTCnwHXnVktMWu3MH53whqMI1yIAQ0dIYrp6IpJPGexfYC906P3f8TOAEoFXeaUtxBirIOe30Z7tCLxjmtO4/I7UQygGOrFMzpKS9iV3EA3X8nnvykz5+2G4DzjGwwRT2Li9ed+V015clcLX+L2XN47p/g/BGUEtt2oHyzVM9abJjqOO7+TWGpS6wG2ofudGTxDwRmTC6QBtxb2M4e3t1CcvX46nI9qbj77jck8uLN+c/XJ+zM9xIW8COx9PxlEneRaql3bN0+FB8Otk2u1XqT/us7HYAwkeaeCN1WsESqJtud7oTu2fmbO9FeZ+JykVihs2Gr/hPwWy3TP6lwcAr2n0mljJomfOicLcRSkf+rYb34UfR/PLH7qn5Cn7v4/TFQPoNx/J6s5Sm4S+RiQWuD5/H2/tt1m857GrLcFYU6GlP9Nm+fLB0fnt+eX5zLjLBzfpwwVqkBav7wQZe9Oxw82p94L+8Br4osNm0y9t2O/C3Rx+V6GLsuRmm++12+18syg3K","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 n=o(74848),r=o(28453),c=o(57742),i=o.n(c),l=o(78178),s=o.n(l),p=o(19624),d=o.n(p),u=o(96226),m=o.n(u),I=(o(77675),o(19365),o(51107)),f=o(21312);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/++Z9BajQC5YqmRkupHMfv7Xv7rgng3QrDvDEgrYK5wUedG0xiWKezYWhHlLXBGM0atCUsgyQEpUtN0gDjxB2kkF7m2miuYmZz7VTfuwhxDLcVUoWBj74IvAYoXBqufZANOR7hthzchZULizlvDxlIyJuoLcYIaCtpC2bsE5GBCyAtoCUMPuiIECmw07p1zVkKfPtraWWJrDuDfawUGs3VCsHlTSSIzjTJYyCpjQuooI+H95CYMDznmRwQ2t2l9gErrpolQtlohTGDwimEmO4sh2AV5BgJPPuiC4ystLHGFYuUPx6r4B23EC0N7wr7PrI4BWkjT/jWlz4FA2A+OJ7P2Do4Gv0UkRN8qe0izkaj9/YI7oayusU8asL7L/sbsFqtnlX+q0OZt5q+a3L4Eb2LmlxY76RLTVWTp9uyr2T4aDW9RYupfPbuwk6HckV8fvmYOqnQ+Mk1EldInJxdXaSu+wo+/PovuEQZLFRu1RZr0QQ0ayh7U4xcm/kWtqFpwtylwqsY8aItPl7FMFKP4G0l6cOv/47wA65A2+5GcSij0VWTG13ADdaeJ2QcjWbwJiCbpJ4GVEmCQlrIEWIluZSWWvIm20obbRdjOLNraCIGWGmqUjEwPckdhMG4DOmOkMuICpxNEr3N8c4jptcRzRIj6+LhlyOg0rzMURVcU7bW9p3pggs418bArVYlUortTCnwHXnVktMWu3MH53whqMI1yIAQ0dIYrp6IpJPGexfYC906P3f8TOAEoFXeaUtxBirIOe30Z7tCLxjmtO4/I7UQygGOrFMzpKS9iV3EA3X8nnvykz5+2G4DzjGwwRT2Li9ed+V015clcLX+L2XN47p/g/BGUEtt2oHyzVM9abJjqOO7+TWGpS6wG2ofudGTxDwRmTC6QBtxb2M4e3t1CcvX46nI9qbj77jck8uLN+c/XJ+zM9xIW8COx9PxlEneRaql3bN0+FB8Otk2u1XqT/us7HYAwkeaeCN1WsESqJtud7oTu2fmbO9FeZ+JykVihs2Gr/hPwWy3TP6lwcAr2n0mljJomfOicLcRSkf+rYb34UfR/PLH7qn5Cn7v4/TFQPoNx/J6s5Sm4S+RiQWuD5/H2/tt1m857GrLcFYU6GlP9Nm+fLB0fnt+eX5zLjLBzfpwwVqkBav7wQZe9Oxw82p94L+8Br4osNm0y9t2O/C3Rx+V6GLsuRmm++12+18syg3K",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,k={},P=[];function j(t){const e={p:"p",...(0,r.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,n.jsx)(i(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,n.jsx)(e.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,n.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(s(),{...o(39903)}),"\n",(0,n.jsx)(d(),{...o(56949)}),"\n",(0,n.jsx)(m(),{...o(21531)})]})}function C(t={}){const{wrapper:e}={...(0,r.R)(),...t.components};return e?(0,n.jsx)(e,{...t,children:(0,n.jsx)(j,{...t})}):j(t)}},39903(t){t.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"Provide objectId of contact to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},56949(t){t.exports={title:"Body"}},21531(t){t.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d0524430.2e7753be.js b/assets/js/d0524430.92382723.js similarity index 62% rename from assets/js/d0524430.2e7753be.js rename to assets/js/d0524430.92382723.js index f4e200565..29831a65c 100644 --- a/assets/js/d0524430.2e7753be.js +++ b/assets/js/d0524430.92382723.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6235],{40707(e,n,t){t.r(n),t.d(n,{assets:()=>I,contentTitle:()=>x,default:()=>b,frontMatter:()=>R,metadata:()=>o,toc:()=>M});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/m6oQpvgTNKmAZ47PeWOJFWX1Lk2D2Mq60bAYZRbodBaQJVyFRNhGdCIasJcASqHJjPCIlhnSGkRVNPKGR47mHLFJxhKtXVfJSgFoR6MHuXWgdUy9xqD40JqEwrG3h6FmIRicfcxoymgUbq7G0wJfTOESS4StBHEOqGaNQWZTFAJjNA6yEgXEaMlobmSOn7w8aPTFzJNuUdwCXq8oSOxO8OVpftL0KUMQeWwzGg6xjEo2GhcW6QAnwr1YIuHwG0FqxscWeHw7h8lQOfz+ZMd9O0mzxvhfs5HcImZtsJps1hzT4RL85HfdXUh1Z8g6Q0q9PCp7am1jETH9ukmptFWijJrXaEjhNhWp9/z6fpbePfb/+AUuVGQ6nkAa5wblAuYlEuR50Lkg9uqbAtj7YGXksfjAL7iLlt68Cbl7t1v/7dwjnMQqthRZEqj0c9HUsQwKKp4ttFow0m43paVPQsu5Q5irmCEYFNOUJoJDhyywC2FemhCRy2oL2FgLlyoENK459swwz9fynBbGHHqZWjlOco1m2uNaHxqUc7Qkiw6M0cImIjtemRdmcI4g2N6/92IZILO29ZJEsiK4XkYJofX1MExbQiX4gK4QbCoXBP6Wyx+Js8ybUgLEZQfa+rfUABQJZkW1IIpqqSV/GgNdP+KEFo9MxRcyCt3RFvF1mInFhZXo03/2Nk6DzbTrcExGlrQm72OSyYKON2WsARC6+fAms4Dylo89tcQ/4IMB9MP23L8lQDN1F6Mr9DMRFy+Y96zo1ueuMUiJkWMymLtqtF50z+F2XfNQxbVDq8/sblbp72T7vlVl5ShRBocdtQ8bB7SEN02plzVVroqOnnXG5287RNuub6L7ft/+9rJvv+3b/7s+397COz7f/v+377/t+//fXlJY9//2yPqK+v/FTVRh4+ulUkufA26aK2F8vFt2QWjllxKheX2LVsuqThxbeRqRcO/5mioKn0XsRk3go+oxHl7t4rKSirVmx9wwdrsJDz5Dga0MJHLPBRlt0rxVAoOHJ04xsztpK3XvvsXVwMWsVHRrpzqhHgMn1Mrk89Zm/m2py8A+oYajS2Z5GqS8wnRBplU/KXq0Wbl+MFXjosfZFU5pRY1DTdLysEM+iSjnmVYLkNVerWq6MPUezkKx5bUFLi71Wr1B3rYGrI=","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 s=t(74848),i=t(28453),r=t(57742),l=t.n(r),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),m=t.n(h),E=(t(77675),t(19365),t(51107)),u=t(21312);const R={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/m6oQpvgTNKmAZ47PeWOJFWX1Lk2D2Mq60bAYZRbodBaQJVyFRNhGdCIasJcASqHJjPCIlhnSGkRVNPKGR47mHLFJxhKtXVfJSgFoR6MHuXWgdUy9xqD40JqEwrG3h6FmIRicfcxoymgUbq7G0wJfTOESS4StBHEOqGaNQWZTFAJjNA6yEgXEaMlobmSOn7w8aPTFzJNuUdwCXq8oSOxO8OVpftL0KUMQeWwzGg6xjEo2GhcW6QAnwr1YIuHwG0FqxscWeHw7h8lQOfz+ZMd9O0mzxvhfs5HcImZtsJps1hzT4RL85HfdXUh1Z8g6Q0q9PCp7am1jETH9ukmptFWijJrXaEjhNhWp9/z6fpbePfb/+AUuVGQ6nkAa5wblAuYlEuR50Lkg9uqbAtj7YGXksfjAL7iLlt68Cbl7t1v/7dwjnMQqthRZEqj0c9HUsQwKKp4ttFow0m43paVPQsu5Q5irmCEYFNOUJoJDhyywC2FemhCRy2oL2FgLlyoENK459swwz9fynBbGHHqZWjlOco1m2uNaHxqUc7Qkiw6M0cImIjtemRdmcI4g2N6/92IZILO29ZJEsiK4XkYJofX1MExbQiX4gK4QbCoXBP6Wyx+Js8ybUgLEZQfa+rfUABQJZkW1IIpqqSV/GgNdP+KEFo9MxRcyCt3RFvF1mInFhZXo03/2Nk6DzbTrcExGlrQm72OSyYKON2WsARC6+fAms4Dylo89tcQ/4IMB9MP23L8lQDN1F6Mr9DMRFy+Y96zo1ueuMUiJkWMymLtqtF50z+F2XfNQxbVDq8/sblbp72T7vlVl5ShRBocdtQ8bB7SEN02plzVVroqOnnXG5287RNuub6L7ft/+9rJvv+3b/7s+397COz7f/v+377/t+//fXlJY9//2yPqK+v/FTVRh4+ulUkufA26aK2F8vFt2QWjllxKheX2LVsuqThxbeRqRcO/5mioKn0XsRk3go+oxHl7t4rKSirVmx9wwdrsJDz5Dga0MJHLPBRlt0rxVAoOHJ04xsztpK3XvvsXVwMWsVHRrpzqhHgMn1Mrk89Zm/m2py8A+oYajS2Z5GqS8wnRBplU/KXq0Wbl+MFXjosfZFU5pRY1DTdLysEM+iSjnmVYLkNVerWq6MPUezkKx5bUFLi71Wr1B3rYGrI=",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,I={},M=[{value:"Events:",id:"events",level:3}];function N(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(E.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,s.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(E.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(51637)}),"\n",(0,s.jsx)(m(),{...t(39067)})]})}function b(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(N,{...e})}):N(e)}},51637(e){e.exports=JSON.parse('{"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"}}}}}')},39067(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6235],{40707(e,n,t){t.r(n),t.d(n,{assets:()=>I,contentTitle:()=>g,default:()=>x,frontMatter:()=>N,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(57742),a=t.n(r),d=t(78178),l=t.n(d),c=t(19624),h=t.n(c),p=t(96226),m=t.n(p),E=(t(77675),t(19365),t(51107)),u=t(21312);const N={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},g=void 0,I={},v=[{value:"Events:",id:"events",level:3}];function M(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,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:(0,i.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(51637)}),"\n",(0,i.jsx)(m(),{...t(39067)})]})}function x(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(M,{...e})}):M(e)}},51637(e){e.exports=JSON.parse('{"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"}}}}}')},39067(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.a2e9d89a.js b/assets/js/d480dde9.2ba7de5a.js similarity index 57% rename from assets/js/d480dde9.a2e9d89a.js rename to assets/js/d480dde9.2ba7de5a.js index 75232050c..dc3ee5595 100644 --- a/assets/js/d480dde9.a2e9d89a.js +++ b/assets/js/d480dde9.2ba7de5a.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3230],{29737(e,t,o){o.r(t),o.d(t,{assets:()=>Y,contentTitle:()=>m,default:()=>W,frontMatter:()=>u,metadata:()=>l,toc:()=>w});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++sdWqteD0hdNjY4TAvt37s69biIEv8Aoc0W7EiYW701uMYlhnd6oG2yEurZIZJdgHOM0akYozdSwtiB5Mm4KhQ46N9YIcIXNi3SEPexTH24q5AqjPH0TETSUOLcCd9AN+1qzaOrchYWPs4n1C8pAQ96QcUgE6CrtCmHsCpGBj6AdoGOMIRpCII7itGld846jLhhq7fQURXcG+7kq0RpBK0SfN8RA3jbJY2BtrI9YQhePQywp5fDsPsgTCLXwdYhYCWrmCNPGlEgZFL5EoNSmEoIrIUdiCOKLKZBEaeOsL2apfjJRIXiZGkZb8JMDH0Wco3Y08bFufelKsE1YiF5GM7YO9npvCKXAF8bNaNTr3bkTuN3C6gZzMozjb7sOWCwWD5D/+FDmpeGfmhx+weDJsI/LnfTUcNXkqVv2lWz/tJpeosMEn71e2OkofUEPm0+ogwptGFwhC0JocHp5ngbtY/j44Te4QB0dVH7RgrVoItolTDtTkrm28m3atnMSJj4Br5KMFy34Ir5vkLjL4E2l+eOH3wle4QKM23SUhNLrXTa5NQVcYx2sZqRebwTPI4pJ7mjAlWYotIMcgSotUJobDRpCK22Nm/Xh1C2hkYW0MFwlMAg9yR2EIXnZlpsg14QleJckOpv9nUdCrwntHEl0ybbLEbA0sse5ir6Zttb2ndkEF3FirIUbU06RU2ynZQlhQ1605HT27NzBiTQEV7gEHREIHffh8kgkvTQh+ChemNb5iZdLSgqArgzeOKYRlFFPeKc/2wG9kDQb7z5BalOot+nINmq2JWk7cRPxltq/k5l8NMcPx23ECUYxmMLe1SWYDZxuO1iCoPXfwFo2tEwtXaQDAmttbLtQfjzWk5Y5xppeT64wzk2Bm6X2mY4eJOaBypQ1BTrCvSPh9OXlBcy/6w9Vtrcd/0ZzDy7On5+9ujoTZ2SQtgl70h/2h0IKnrjWbs/S4S19vNlWu+vpn1/emyXMeM+DYLVJZ0+KarW5V27VYnfvV55YSKuVdNWbaNdrIb9vMMohNM7UXEejc9nNt+N11q1uOXBmuJTsFQUGueDm2jbt/j+6+w6OpxdnF2fXZypTMoEOr4ZZuho2P8RA9+SWe+oPz4nWB/mU2+aTAqtVe5Gs11v+9umzEpsYO27J4Xi9Xv8Jg1+qhA==","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),r=o(57742),d=o.n(r),i=o(78178),a=o.n(i),p=o(19624),c=o.n(p),h=o(96226),b=o.n(h),k=(o(77675),o(19365),o(51107));o(21312);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++sdWqteD0hdNjY4TAvt37s69biIEv8Aoc0W7EiYW701uMYlhnd6oG2yEurZIZJdgHOM0akYozdSwtiB5Mm4KhQ46N9YIcIXNi3SEPexTH24q5AqjPH0TETSUOLcCd9AN+1qzaOrchYWPs4n1C8pAQ96QcUgE6CrtCmHsCpGBj6AdoGOMIRpCII7itGld846jLhhq7fQURXcG+7kq0RpBK0SfN8RA3jbJY2BtrI9YQhePQywp5fDsPsgTCLXwdYhYCWrmCNPGlEgZFL5EoNSmEoIrIUdiCOKLKZBEaeOsL2apfjJRIXiZGkZb8JMDH0Wco3Y08bFufelKsE1YiF5GM7YO9npvCKXAF8bNaNTr3bkTuN3C6gZzMozjb7sOWCwWD5D/+FDmpeGfmhx+weDJsI/LnfTUcNXkqVv2lWz/tJpeosMEn71e2OkofUEPm0+ogwptGFwhC0JocHp5ngbtY/j44Te4QB0dVH7RgrVoItolTDtTkrm28m3atnMSJj4Br5KMFy34Ir5vkLjL4E2l+eOH3wle4QKM23SUhNLrXTa5NQVcYx2sZqRebwTPI4pJ7mjAlWYotIMcgSotUJobDRpCK22Nm/Xh1C2hkYW0MFwlMAg9yR2EIXnZlpsg14QleJckOpv9nUdCrwntHEl0ybbLEbA0sse5ir6Zttb2ndkEF3FirIUbU06RU2ynZQlhQ1605HT27NzBiTQEV7gEHREIHffh8kgkvTQh+ChemNb5iZdLSgqArgzeOKYRlFFPeKc/2wG9kDQb7z5BalOot+nINmq2JWk7cRPxltq/k5l8NMcPx23ECUYxmMLe1SWYDZxuO1iCoPXfwFo2tEwtXaQDAmttbLtQfjzWk5Y5xppeT64wzk2Bm6X2mY4eJOaBypQ1BTrCvSPh9OXlBcy/6w9Vtrcd/0ZzDy7On5+9ujoTZ2SQtgl70h/2h0IKnrjWbs/S4S19vNlWu+vpn1/emyXMeM+DYLVJZ0+KarW5V27VYnfvV55YSKuVdNWbaNdrIb9vMMohNM7UXEejc9nNt+N11q1uOXBmuJTsFQUGueDm2jbt/j+6+w6OpxdnF2fXZypTMoEOr4ZZuho2P8RA9+SWe+oPz4nWB/mU2+aTAqtVe5Gs11v+9umzEpsYO27J4Xi9Xv8Jg1+qhA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},m=void 0,Y={},w=[];function I(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)(d(),{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)(c(),{...o(70875)}),"\n",(0,s.jsx)(b(),{...o(67117)})]})}function W(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(I,{...e})}):I(e)}},70875(e){e.exports={title:"Body"}},67117(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3230],{29737(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),r=o(57742),i=o.n(r),a=o(78178),c=o.n(a),d=o(19624),h=o.n(d),p=o(96226),b=o.n(p),k=(o(77675),o(19365),o(51107));o(21312);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 T(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)(i(),{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)(c(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...o(70875)}),"\n",(0,s.jsx)(b(),{...o(67117)})]})}function I(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(T,{...e})}):T(e)}},70875(e){e.exports={title:"Body"}},67117(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.552e34c0.js b/assets/js/da66eb9c.3444bc9f.js similarity index 74% rename from assets/js/da66eb9c.552e34c0.js rename to assets/js/da66eb9c.3444bc9f.js index 682471680..5cc7347a9 100644 --- a/assets/js/da66eb9c.552e34c0.js +++ b/assets/js/da66eb9c.3444bc9f.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2703],{37055(e,t,i){i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>g,default:()=>S,frontMatter:()=>f,metadata:()=>n,toc:()=>y});const n=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":"eJzdWc2OHLcRfpUKL5YGvTMjWXKQOXkjC7YQQVpoVxCQ1WLAblZP08smaZI9s4PFAD7kDXLKNY/mJwmK7L/50Z8tJEAutpZNFqu+KlZ9VXPPAl95trhmP5iiqVEHz24yJtAXTtogjWYLdlUhvLWCB4RuF5xfvACulNl4aDw6D8FAbYQst8C1gCZtDxWCwMCl8mBK4OAtFrKUBYhW0BRembiRBwiV9FGw0WrbSQ+mE8ahxA1Y7niNAZ3PYGsaKLjWJkBRcb1KF5ZSIRhdIMiQNOiUlh4KhzygmLKMGYuOk4kvBFuwdElnH8vYcBFbXN8zzWtkC9bJWkrBMiYJHstDxQ4xe/EDGbx3e7RRI4poVI6tXSTH4S+NdCjYIrgGM+bDVtFtXtZWIcsY3lllBLJFyZWnDUWFNWeLexa2Nu4MTuoVy1hpXM3DsLLb3ST56MNfjdjSmX1VL5xZS4GQozIjfEfIB6yt4gE9POABFHIfwGgc7e0MeMgyVhgdCMLFPePWKllEkGc/e7rt/lh1k/+MRUTckUuCRE9fE+CfNpDA4RGmBfPxHz3kbJcxbcIXi7kgExEcriVuYjx7udIpPsey93D8siv6qBjL2NEZJdBRRB7LG07TTtQ8V/j66mK0NTdGIddH0UhRBWfJABMXYSOVgiQDXl9dwBodPczoqym8jW867nFYoFzT8xtvgcIIhLXkgDWXKoNNJYuKAn4LdeMDoG5jqIUOR08+BjGcwbFCQvqTGmUpHUi9GtLNkWAQ0mER1BY2MlSmCcCFkHScK/ABrZ+OUYxa9EBemcb9cSQ5rBopUEAwjYPSuKhlTFY2PjOyQGofXFPQYQ+iIe9GO2gr/ds6U6D3A04dKrRpJD8D1D4d51ByH9Bl0GhJyLvGBhS9SLyz6CTqAk9CEMFdxvzdAu4/H4sLdLUMvrOUXMOFAFQY6wn4pqiAp+88NA59BlLLILnyGfjAa+szMA4C3lFegWAsJU+8kz6Q8hspVhg8yA/F0RukN1KMdCidqaP3CRu9HQdCr1cwB+KuyKnSt1Wr5I0KsOaqOY2ZwxRuy8apU691H6vLVPgwSX/75iVsKnTY+x1diqOc0k4SjFRG40uji0MXJX20H4bLUYbgTTBLh7XUAj8nti8xRFDIrcH0Id0EU/MgC+hE+Sm0W5MDghlHaA0POvByrPhaGvfwAwCSuCVV6qXUS1yj24601E2doztS8lVcpvgQfOshx7BB1GPdOjcmFpEqEOm2qVDDHia0yw9G72n5NNUOWW6XRi+H2D2J475thypPJiR9MoEzuBo7MHIR4w7SrE4ZFeLlXbYl3QkgolApWuh/fj+A3+v3ejKJKnziMmJMX+lCom8LeIMr7oRC7xPtScBSzGbA+wg23VWUn4fQF4OWVGtHuwuiA1EnBB4CLyoU5DSBFrWgXPGNRy2WUeo3Ax+Zvo/F1KJeFkYZN/Yad45vibsFrP3xw92NvHnNctVg5GfE0nLFi1t2s8tYXhS/VyKVr+/bv6eFqVkWlx7vrR1R8Lwo4EGuJMHDXR6zgt0+XLSFmguqCTGhHNTsPacm8CM1PuLFCXQUUwACb5exIMMeVVmOuO8yJyq52+3iO/bWaJ+exuP5/Jhh9l1Dy3ipJFDKKhultn/6epQxLX+KPHEvHv/kL578ZMk1rUrn4eOHHs8ff3v2aH42//PVo+8WT/6yePrddD6f/51l7K5WA19lJI2N0Yt/jxakVlLjskNt+Xg+X37bQvnkFHotG7UtTV9zJQWUEpUAutN/RQDROeN+J1v+iH4fM59M7ox/8pHQoZRVmkaL/7W5pzT6uIFPlk96E58em/hCJ8io870yt6j/GxYO9oyvD+l6UnU/qmXaFL+zPWPH68lIj0XjZNjGtvnujFt5lr4vrm+oGa0xVIZabtukPjtUbMFmXXaZ3Y/yzI6RPLfuuvDItVgVgvWL2cxzLXJzNzUWNVUSxXNP+XPGrZytH00fsV12eIZb+0X7sTn70iM+8JXUq0+duxmguiR3Jo/tATaUGCv/hlRjWn+Md7VjiAo50TzyAEXJm6Hlf975unfnYZ/ctcmf1/keFqeTvey4lWVsr11tSdK472qXTvYh7bd9vk0iD/htv+8UrXz6ITbXnhpThdNlv636n1vBd+SW0kQfto/ltUV9SXDSU4sxcIjkO1SFqbFrTSaT7shv//h3f2oy6V2RunWiYa8bB9Zs0JWNin4rFd5Jor10DOv4zceJGbXOyGsia2oL1C2uHBEsIVcyUKfc9hUFtzyXSlIuoW2GTjsYpSM/hXcVhgodffrGEeEQuFaUgfq+Qa8GorEx7raksR6xwrzxUhNjRF1xXdDG7j3EdpCIKbWy1kmP4IMjpWVSzejgeBGg5pqvYj+XwRgrgUpS0gBncppGeKOa1G/TMNK42EEne+JELmL4nIZsDoFWiQ85rOjxrtum22dp6JEeD5mgBeToA1jSRRaYppVameI2TSIbpcAaSuSSK2LGYx3peHBce6o2SZfOBT1gbW+HviX3bz2Sg19KfesXk8l7fQbXfVi9w9zLgDcPukS02WyOEtDD/TM/yvBTk8MbtMbLYNx2OL2SoWrymLTGQvo/kqQfUWMMn1FKGmQIU/jjHEirswqVnV2mJsHPzi9exNr3EH779Z/wErnTUJlNCtaicai2sOquIuSS5xNsfemKExfehIoQL1LwtbPPDsF3FQ+//fovD69wQxOF9KLIlMnkosmVLOCqG3dOJgt4FgfGoxFoHOMWXFOr7itOoURjMA42nVZS307hXG/jpGpodWg9ntszI6bXzt0ecu4x9jV0ortzOmgUG2yPao2+m3znCCgksepQOdOs0m1jZVrjHJbUG7xL0xSy7VwIsO1yN2ShZn5QB0uThhRb4A7BxznJxcGR+KWx1jjSop3SlKYb2KEW1kgd/AKE42UY5GcH7Wkc9B0tJQh5D0fWiuldkl5ia3G/Sj1gdlhO99OtwxIdXRjNHvxiZRtO111YAkXrHwlrIk2UtXgROV3sxFJd//5QTuRX6Gr/urxEt5YFttziAy96FjfPWMaULFD7caE///HiJay/nc6pSPUk5TMe9+zli2fPX10+J2UokSbAHk3n03nsrI0PNdejmw5+IDosbfcDo/1//T2ppWo0xZxZxWUkyu1wMJHcazbiUIvxT0k3GauMD7Tl/p6SwFundjta/qWJ/OX6JmNr7iRRpsiE24mbOD1zGsP94E334wx82a9SJw3qCKkmNhqno4mM3eL24OexHXGglpWSxmnHs6TX2RXJGSQcNTlEq9OJ86JAGz66d9xVXLy9ItLW/tRVx1/NmOMb4nN8k5RNk/vIt+PaPVNcrxq+or1J5C4NUKt9En4bSXj7DzLqJBz77DxZQf8lm04euL9PBH+36/enTx880eLa7Sbf3Ox2u/8AzKSLEA==","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 o=i(74848),a=i(28453),s=i(57742),r=i.n(s),d=i(78178),l=i.n(d),c=i(19624),p=i.n(c),u=i(96226),m=i.n(u),h=(i(77675),i(19365),i(51107)),x=i(21312);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:"eJzdWc2OHLcRfpUKL5YGvTMjWXKQOXkjC7YQQVpoVxCQ1WLAblZP08smaZI9s4PFAD7kDXLKNY/mJwmK7L/50Z8tJEAutpZNFqu+KlZ9VXPPAl95trhmP5iiqVEHz24yJtAXTtogjWYLdlUhvLWCB4RuF5xfvACulNl4aDw6D8FAbYQst8C1gCZtDxWCwMCl8mBK4OAtFrKUBYhW0BRembiRBwiV9FGw0WrbSQ+mE8ahxA1Y7niNAZ3PYGsaKLjWJkBRcb1KF5ZSIRhdIMiQNOiUlh4KhzygmLKMGYuOk4kvBFuwdElnH8vYcBFbXN8zzWtkC9bJWkrBMiYJHstDxQ4xe/EDGbx3e7RRI4poVI6tXSTH4S+NdCjYIrgGM+bDVtFtXtZWIcsY3lllBLJFyZWnDUWFNWeLexa2Nu4MTuoVy1hpXM3DsLLb3ST56MNfjdjSmX1VL5xZS4GQozIjfEfIB6yt4gE9POABFHIfwGgc7e0MeMgyVhgdCMLFPePWKllEkGc/e7rt/lh1k/+MRUTckUuCRE9fE+CfNpDA4RGmBfPxHz3kbJcxbcIXi7kgExEcriVuYjx7udIpPsey93D8siv6qBjL2NEZJdBRRB7LG07TTtQ8V/j66mK0NTdGIddH0UhRBWfJABMXYSOVgiQDXl9dwBodPczoqym8jW867nFYoFzT8xtvgcIIhLXkgDWXKoNNJYuKAn4LdeMDoG5jqIUOR08+BjGcwbFCQvqTGmUpHUi9GtLNkWAQ0mER1BY2MlSmCcCFkHScK/ABrZ+OUYxa9EBemcb9cSQ5rBopUEAwjYPSuKhlTFY2PjOyQGofXFPQYQ+iIe9GO2gr/ds6U6D3A04dKrRpJD8D1D4d51ByH9Bl0GhJyLvGBhS9SLyz6CTqAk9CEMFdxvzdAu4/H4sLdLUMvrOUXMOFAFQY6wn4pqiAp+88NA59BlLLILnyGfjAa+szMA4C3lFegWAsJU+8kz6Q8hspVhg8yA/F0RukN1KMdCidqaP3CRu9HQdCr1cwB+KuyKnSt1Wr5I0KsOaqOY2ZwxRuy8apU691H6vLVPgwSX/75iVsKnTY+x1diqOc0k4SjFRG40uji0MXJX20H4bLUYbgTTBLh7XUAj8nti8xRFDIrcH0Id0EU/MgC+hE+Sm0W5MDghlHaA0POvByrPhaGvfwAwCSuCVV6qXUS1yj24601E2doztS8lVcpvgQfOshx7BB1GPdOjcmFpEqEOm2qVDDHia0yw9G72n5NNUOWW6XRi+H2D2J475thypPJiR9MoEzuBo7MHIR4w7SrE4ZFeLlXbYl3QkgolApWuh/fj+A3+v3ejKJKnziMmJMX+lCom8LeIMr7oRC7xPtScBSzGbA+wg23VWUn4fQF4OWVGtHuwuiA1EnBB4CLyoU5DSBFrWgXPGNRy2WUeo3Ax+Zvo/F1KJeFkYZN/Yad45vibsFrP3xw92NvHnNctVg5GfE0nLFi1t2s8tYXhS/VyKVr+/bv6eFqVkWlx7vrR1R8Lwo4EGuJMHDXR6zgt0+XLSFmguqCTGhHNTsPacm8CM1PuLFCXQUUwACb5exIMMeVVmOuO8yJyq52+3iO/bWaJ+exuP5/Jhh9l1Dy3ipJFDKKhultn/6epQxLX+KPHEvHv/kL578ZMk1rUrn4eOHHs8ff3v2aH42//PVo+8WT/6yePrddD6f/51l7K5WA19lJI2N0Yt/jxakVlLjskNt+Xg+X37bQvnkFHotG7UtTV9zJQWUEpUAutN/RQDROeN+J1v+iH4fM59M7ox/8pHQoZRVmkaL/7W5pzT6uIFPlk96E58em/hCJ8io870yt6j/GxYO9oyvD+l6UnU/qmXaFL+zPWPH68lIj0XjZNjGtvnujFt5lr4vrm+oGa0xVIZabtukPjtUbMFmXXaZ3Y/yzI6RPLfuuvDItVgVgvWL2cxzLXJzNzUWNVUSxXNP+XPGrZytH00fsV12eIZb+0X7sTn70iM+8JXUq0+duxmguiR3Jo/tATaUGCv/hlRjWn+Md7VjiAo50TzyAEXJm6Hlf975unfnYZ/ctcmf1/keFqeTvey4lWVsr11tSdK472qXTvYh7bd9vk0iD/htv+8UrXz6ITbXnhpThdNlv636n1vBd+SW0kQfto/ltUV9SXDSU4sxcIjkO1SFqbFrTSaT7shv//h3f2oy6V2RunWiYa8bB9Zs0JWNin4rFd5Jor10DOv4zceJGbXOyGsia2oL1C2uHBEsIVcyUKfc9hUFtzyXSlIuoW2GTjsYpSM/hXcVhgodffrGEeEQuFaUgfq+Qa8GorEx7raksR6xwrzxUhNjRF1xXdDG7j3EdpCIKbWy1kmP4IMjpWVSzejgeBGg5pqvYj+XwRgrgUpS0gBncppGeKOa1G/TMNK42EEne+JELmL4nIZsDoFWiQ85rOjxrtum22dp6JEeD5mgBeToA1jSRRaYppVameI2TSIbpcAaSuSSK2LGYx3peHBce6o2SZfOBT1gbW+HviX3bz2Sg19KfesXk8l7fQbXfVi9w9zLgDcPukS02WyOEtDD/TM/yvBTk8MbtMbLYNx2OL2SoWrymLTGQvo/kqQfUWMMn1FKGmQIU/jjHEirswqVnV2mJsHPzi9exNr3EH779Z/wErnTUJlNCtaicai2sOquIuSS5xNsfemKExfehIoQL1LwtbPPDsF3FQ+//fovD69wQxOF9KLIlMnkosmVLOCqG3dOJgt4FgfGoxFoHOMWXFOr7itOoURjMA42nVZS307hXG/jpGpodWg9ntszI6bXzt0ecu4x9jV0ortzOmgUG2yPao2+m3znCCgksepQOdOs0m1jZVrjHJbUG7xL0xSy7VwIsO1yN2ShZn5QB0uThhRb4A7BxznJxcGR+KWx1jjSop3SlKYb2KEW1kgd/AKE42UY5GcH7Wkc9B0tJQh5D0fWiuldkl5ia3G/Sj1gdlhO99OtwxIdXRjNHvxiZRtO111YAkXrHwlrIk2UtXgROV3sxFJd//5QTuRX6Gr/urxEt5YFttziAy96FjfPWMaULFD7caE///HiJay/nc6pSPUk5TMe9+zli2fPX10+J2UokSbAHk3n03nsrI0PNdejmw5+IDosbfcDo/1//T2ppWo0xZxZxWUkyu1wMJHcazbiUIvxT0k3GauMD7Tl/p6SwFundjta/qWJ/OX6JmNr7iRRpsiE24mbOD1zGsP94E334wx82a9SJw3qCKkmNhqno4mM3eL24OexHXGglpWSxmnHs6TX2RXJGSQcNTlEq9OJ86JAGz66d9xVXLy9ItLW/tRVx1/NmOMb4nN8k5RNk/vIt+PaPVNcrxq+or1J5C4NUKt9En4bSXj7DzLqJBz77DxZQf8lm04euL9PBH+36/enTx880eLa7Sbf3Ox2u/8AzKSLEA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,b={},y=[];function j(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,o.jsx)(r(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(l(),{...i(38679)}),"\n",(0,o.jsx)(p(),{...i(96925)}),"\n",(0,o.jsx)(m(),{...i(24083)})]})}function S(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(j,{...e})}):j(e)}},38679(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"ID of the document that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},96925(e){e.exports=JSON.parse('{"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":false},"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":false},"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":false},"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":false},"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},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"}},"title":"document_document_id_body"}}}}}')},24083(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2703],{37055(e,t,i){i.r(t),i.d(t,{assets:()=>x,contentTitle:()=>v,default:()=>P,frontMatter:()=>y,metadata:()=>o,toc:()=>g});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":"eJzdWc2OHLcRfpUKL5YGvTMjWXKQOXkjC7YQQVpoVxCQ1WLAblZP08smaZI9s4PFAD7kDXLKNY/mJwmK7L/50Z8tJEAutpZNFqu+KlZ9VXPPAl95trhmP5iiqVEHz24yJtAXTtogjWYLdlUhvLWCB4RuF5xfvACulNl4aDw6D8FAbYQst8C1gCZtDxWCwMCl8mBK4OAtFrKUBYhW0BRembiRBwiV9FGw0WrbSQ+mE8ahxA1Y7niNAZ3PYGsaKLjWJkBRcb1KF5ZSIRhdIMiQNOiUlh4KhzygmLKMGYuOk4kvBFuwdElnH8vYcBFbXN8zzWtkC9bJWkrBMiYJHstDxQ4xe/EDGbx3e7RRI4poVI6tXSTH4S+NdCjYIrgGM+bDVtFtXtZWIcsY3lllBLJFyZWnDUWFNWeLexa2Nu4MTuoVy1hpXM3DsLLb3ST56MNfjdjSmX1VL5xZS4GQozIjfEfIB6yt4gE9POABFHIfwGgc7e0MeMgyVhgdCMLFPePWKllEkGc/e7rt/lh1k/+MRUTckUuCRE9fE+CfNpDA4RGmBfPxHz3kbJcxbcIXi7kgExEcriVuYjx7udIpPsey93D8siv6qBjL2NEZJdBRRB7LG07TTtQ8V/j66mK0NTdGIddH0UhRBWfJABMXYSOVgiQDXl9dwBodPczoqym8jW867nFYoFzT8xtvgcIIhLXkgDWXKoNNJYuKAn4LdeMDoG5jqIUOR08+BjGcwbFCQvqTGmUpHUi9GtLNkWAQ0mER1BY2MlSmCcCFkHScK/ABrZ+OUYxa9EBemcb9cSQ5rBopUEAwjYPSuKhlTFY2PjOyQGofXFPQYQ+iIe9GO2gr/ds6U6D3A04dKrRpJD8D1D4d51ByH9Bl0GhJyLvGBhS9SLyz6CTqAk9CEMFdxvzdAu4/H4sLdLUMvrOUXMOFAFQY6wn4pqiAp+88NA59BlLLILnyGfjAa+szMA4C3lFegWAsJU+8kz6Q8hspVhg8yA/F0RukN1KMdCidqaP3CRu9HQdCr1cwB+KuyKnSt1Wr5I0KsOaqOY2ZwxRuy8apU691H6vLVPgwSX/75iVsKnTY+x1diqOc0k4SjFRG40uji0MXJX20H4bLUYbgTTBLh7XUAj8nti8xRFDIrcH0Id0EU/MgC+hE+Sm0W5MDghlHaA0POvByrPhaGvfwAwCSuCVV6qXUS1yj24601E2doztS8lVcpvgQfOshx7BB1GPdOjcmFpEqEOm2qVDDHia0yw9G72n5NNUOWW6XRi+H2D2J475thypPJiR9MoEzuBo7MHIR4w7SrE4ZFeLlXbYl3QkgolApWuh/fj+A3+v3ejKJKnziMmJMX+lCom8LeIMr7oRC7xPtScBSzGbA+wg23VWUn4fQF4OWVGtHuwuiA1EnBB4CLyoU5DSBFrWgXPGNRy2WUeo3Ax+Zvo/F1KJeFkYZN/Yad45vibsFrP3xw92NvHnNctVg5GfE0nLFi1t2s8tYXhS/VyKVr+/bv6eFqVkWlx7vrR1R8Lwo4EGuJMHDXR6zgt0+XLSFmguqCTGhHNTsPacm8CM1PuLFCXQUUwACb5exIMMeVVmOuO8yJyq52+3iO/bWaJ+exuP5/Jhh9l1Dy3ipJFDKKhultn/6epQxLX+KPHEvHv/kL578ZMk1rUrn4eOHHs8ff3v2aH42//PVo+8WT/6yePrddD6f/51l7K5WA19lJI2N0Yt/jxakVlLjskNt+Xg+X37bQvnkFHotG7UtTV9zJQWUEpUAutN/RQDROeN+J1v+iH4fM59M7ox/8pHQoZRVmkaL/7W5pzT6uIFPlk96E58em/hCJ8io870yt6j/GxYO9oyvD+l6UnU/qmXaFL+zPWPH68lIj0XjZNjGtvnujFt5lr4vrm+oGa0xVIZabtukPjtUbMFmXXaZ3Y/yzI6RPLfuuvDItVgVgvWL2cxzLXJzNzUWNVUSxXNP+XPGrZytH00fsV12eIZb+0X7sTn70iM+8JXUq0+duxmguiR3Jo/tATaUGCv/hlRjWn+Md7VjiAo50TzyAEXJm6Hlf975unfnYZ/ctcmf1/keFqeTvey4lWVsr11tSdK472qXTvYh7bd9vk0iD/htv+8UrXz6ITbXnhpThdNlv636n1vBd+SW0kQfto/ltUV9SXDSU4sxcIjkO1SFqbFrTSaT7shv//h3f2oy6V2RunWiYa8bB9Zs0JWNin4rFd5Jor10DOv4zceJGbXOyGsia2oL1C2uHBEsIVcyUKfc9hUFtzyXSlIuoW2GTjsYpSM/hXcVhgodffrGEeEQuEZFKahvHPRqYBob425LmusRLcwbLzVRRtQV1wVt7B5E7AeJmVIva530CD440lom3YwOjhcBaq75KjZ0GYzBEqgkZQ1wJqdxhDeqSQ03TSONiy10MiiO5CKIz2nK5hBolQiRw4pe77rtun2Wph7p9ZAJWkCOPoAlXWSBaVyplSlu0yiyUQqsoUwuuSJqPNaRjgfHtadyk3TpfNAD1jZ36Ft2/9Yjefil1Ld+MZm812dw3cfVO8y9DHjzoMtEm83mKAM93D/zoww/NTm8QWu8DMZth9MrGaomj1lrLKT/I0n6ETXG+BnlpEGGMIU/ToK0OqtQ2dll6hL87PziRSx+D+G3X/8JL5E7DZXZpGgtGodqC6vuKkIueT7B1teuOHLhTagI8SIFXzv87BB8V/Hw26//8vAKNzRSSE+KTJlMLppcyQKuunnnZLKAZ3FiPJqBxjluwTX16r7iFEo0B+Ng02kl9e0UzvU2jqqGXofW47k9M2J+7dztIeceY2NDJ7o7p4NGscP2qNbou9F3joBCEq0OlTPNKt02VqY1zmFJzcG7NE4h286FANsud1MW6uYHdbA0aUqxBe4QfByUXBwciV8aa40jLdoxTWm6iR1qYY3UwS9AOF6GQX520J/GSd/RUoKQ93BkrZjeJeklthb3q9QEZof1dD/fOizR0YXR7MEvVrbhdN2FJVC0/pGwJtZEWYsXkdTFViwV9u8P5USCha72r8tLdGtZYEsuPvCiZ3HzjGVMyQK1H1f68x8vXsL62+mcqlTPUj7jcc9evnj2/NXlc1KGEmkC7NF0Pp3H1tr4UHM9uungF6LD2nY/UNr/1x+UWq5GY8yZVVxGptxOBxPLvWYjErUY/5Z0k7HK+EBb7u8pCbx1arej5V+aSGCubzK25k4SZ4pUuB25idNDpzHcD950v87Al/0sddKgjpFqoqNxPJrY2C1uD34f2xEJamkpaZx2PEt6nV2RnEHCUZdDvDqdOC8KtOGje8dtxcXbK2Jt7W9ddfzZjDm+IULHN0nZNLqPhDuu3TPF9arhK9qbRO7SBLXaZ+G3kYW3/yCjTsKxT8+TFfRfsunkgfv7xPB3u35/+vTBEy2u3W7yzc1ut/sPt1iLdQ==","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 n=i(74848),a=i(28453),s=i(57742),d=i.n(s),l=i(78178),r=i.n(l),c=i(19624),u=i.n(c),p=i(96226),m=i.n(p),h=(i(77675),i(19365),i(51107)),f=i(21312);const y={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWc2OHLcRfpUKL5YGvTMjWXKQOXkjC7YQQVpoVxCQ1WLAblZP08smaZI9s4PFAD7kDXLKNY/mJwmK7L/50Z8tJEAutpZNFqu+KlZ9VXPPAl95trhmP5iiqVEHz24yJtAXTtogjWYLdlUhvLWCB4RuF5xfvACulNl4aDw6D8FAbYQst8C1gCZtDxWCwMCl8mBK4OAtFrKUBYhW0BRembiRBwiV9FGw0WrbSQ+mE8ahxA1Y7niNAZ3PYGsaKLjWJkBRcb1KF5ZSIRhdIMiQNOiUlh4KhzygmLKMGYuOk4kvBFuwdElnH8vYcBFbXN8zzWtkC9bJWkrBMiYJHstDxQ4xe/EDGbx3e7RRI4poVI6tXSTH4S+NdCjYIrgGM+bDVtFtXtZWIcsY3lllBLJFyZWnDUWFNWeLexa2Nu4MTuoVy1hpXM3DsLLb3ST56MNfjdjSmX1VL5xZS4GQozIjfEfIB6yt4gE9POABFHIfwGgc7e0MeMgyVhgdCMLFPePWKllEkGc/e7rt/lh1k/+MRUTckUuCRE9fE+CfNpDA4RGmBfPxHz3kbJcxbcIXi7kgExEcriVuYjx7udIpPsey93D8siv6qBjL2NEZJdBRRB7LG07TTtQ8V/j66mK0NTdGIddH0UhRBWfJABMXYSOVgiQDXl9dwBodPczoqym8jW867nFYoFzT8xtvgcIIhLXkgDWXKoNNJYuKAn4LdeMDoG5jqIUOR08+BjGcwbFCQvqTGmUpHUi9GtLNkWAQ0mER1BY2MlSmCcCFkHScK/ABrZ+OUYxa9EBemcb9cSQ5rBopUEAwjYPSuKhlTFY2PjOyQGofXFPQYQ+iIe9GO2gr/ds6U6D3A04dKrRpJD8D1D4d51ByH9Bl0GhJyLvGBhS9SLyz6CTqAk9CEMFdxvzdAu4/H4sLdLUMvrOUXMOFAFQY6wn4pqiAp+88NA59BlLLILnyGfjAa+szMA4C3lFegWAsJU+8kz6Q8hspVhg8yA/F0RukN1KMdCidqaP3CRu9HQdCr1cwB+KuyKnSt1Wr5I0KsOaqOY2ZwxRuy8apU691H6vLVPgwSX/75iVsKnTY+x1diqOc0k4SjFRG40uji0MXJX20H4bLUYbgTTBLh7XUAj8nti8xRFDIrcH0Id0EU/MgC+hE+Sm0W5MDghlHaA0POvByrPhaGvfwAwCSuCVV6qXUS1yj24601E2doztS8lVcpvgQfOshx7BB1GPdOjcmFpEqEOm2qVDDHia0yw9G72n5NNUOWW6XRi+H2D2J475thypPJiR9MoEzuBo7MHIR4w7SrE4ZFeLlXbYl3QkgolApWuh/fj+A3+v3ejKJKnziMmJMX+lCom8LeIMr7oRC7xPtScBSzGbA+wg23VWUn4fQF4OWVGtHuwuiA1EnBB4CLyoU5DSBFrWgXPGNRy2WUeo3Ax+Zvo/F1KJeFkYZN/Yad45vibsFrP3xw92NvHnNctVg5GfE0nLFi1t2s8tYXhS/VyKVr+/bv6eFqVkWlx7vrR1R8Lwo4EGuJMHDXR6zgt0+XLSFmguqCTGhHNTsPacm8CM1PuLFCXQUUwACb5exIMMeVVmOuO8yJyq52+3iO/bWaJ+exuP5/Jhh9l1Dy3ipJFDKKhultn/6epQxLX+KPHEvHv/kL578ZMk1rUrn4eOHHs8ff3v2aH42//PVo+8WT/6yePrddD6f/51l7K5WA19lJI2N0Yt/jxakVlLjskNt+Xg+X37bQvnkFHotG7UtTV9zJQWUEpUAutN/RQDROeN+J1v+iH4fM59M7ox/8pHQoZRVmkaL/7W5pzT6uIFPlk96E58em/hCJ8io870yt6j/GxYO9oyvD+l6UnU/qmXaFL+zPWPH68lIj0XjZNjGtvnujFt5lr4vrm+oGa0xVIZabtukPjtUbMFmXXaZ3Y/yzI6RPLfuuvDItVgVgvWL2cxzLXJzNzUWNVUSxXNP+XPGrZytH00fsV12eIZb+0X7sTn70iM+8JXUq0+duxmguiR3Jo/tATaUGCv/hlRjWn+Md7VjiAo50TzyAEXJm6Hlf975unfnYZ/ctcmf1/keFqeTvey4lWVsr11tSdK472qXTvYh7bd9vk0iD/htv+8UrXz6ITbXnhpThdNlv636n1vBd+SW0kQfto/ltUV9SXDSU4sxcIjkO1SFqbFrTSaT7shv//h3f2oy6V2RunWiYa8bB9Zs0JWNin4rFd5Jor10DOv4zceJGbXOyGsia2oL1C2uHBEsIVcyUKfc9hUFtzyXSlIuoW2GTjsYpSM/hXcVhgodffrGEeEQuEZFKahvHPRqYBob425LmusRLcwbLzVRRtQV1wVt7B5E7AeJmVIva530CD440lom3YwOjhcBaq75KjZ0GYzBEqgkZQ1wJqdxhDeqSQ03TSONiy10MiiO5CKIz2nK5hBolQiRw4pe77rtun2Wph7p9ZAJWkCOPoAlXWSBaVyplSlu0yiyUQqsoUwuuSJqPNaRjgfHtadyk3TpfNAD1jZ36Ft2/9Yjefil1Ld+MZm812dw3cfVO8y9DHjzoMtEm83mKAM93D/zoww/NTm8QWu8DMZth9MrGaomj1lrLKT/I0n6ETXG+BnlpEGGMIU/ToK0OqtQ2dll6hL87PziRSx+D+G3X/8JL5E7DZXZpGgtGodqC6vuKkIueT7B1teuOHLhTagI8SIFXzv87BB8V/Hw26//8vAKNzRSSE+KTJlMLppcyQKuunnnZLKAZ3FiPJqBxjluwTX16r7iFEo0B+Ng02kl9e0UzvU2jqqGXofW47k9M2J+7dztIeceY2NDJ7o7p4NGscP2qNbou9F3joBCEq0OlTPNKt02VqY1zmFJzcG7NE4h286FANsud1MW6uYHdbA0aUqxBe4QfByUXBwciV8aa40jLdoxTWm6iR1qYY3UwS9AOF6GQX520J/GSd/RUoKQ93BkrZjeJeklthb3q9QEZof1dD/fOizR0YXR7MEvVrbhdN2FJVC0/pGwJtZEWYsXkdTFViwV9u8P5USCha72r8tLdGtZYEsuPvCiZ3HzjGVMyQK1H1f68x8vXsL62+mcqlTPUj7jcc9evnj2/NXlc1KGEmkC7NF0Pp3H1tr4UHM9uungF6LD2nY/UNr/1x+UWq5GY8yZVVxGptxOBxPLvWYjErUY/5Z0k7HK+EBb7u8pCbx1arej5V+aSGCubzK25k4SZ4pUuB25idNDpzHcD950v87Al/0sddKgjpFqoqNxPJrY2C1uD34f2xEJamkpaZx2PEt6nV2RnEHCUZdDvDqdOC8KtOGje8dtxcXbK2Jt7W9ddfzZjDm+IULHN0nZNLqPhDuu3TPF9arhK9qbRO7SBLXaZ+G3kYW3/yCjTsKxT8+TFfRfsunkgfv7xPB3u35/+vTBEy2u3W7yzc1ut/sPt1iLdQ==",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,x={},g=[];function j(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,n.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(r(),{...i(38679)}),"\n",(0,n.jsx)(u(),{...i(96925)}),"\n",(0,n.jsx)(m(),{...i(24083)})]})}function P(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(j,{...e})}):j(e)}},38679(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"ID of the document that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},96925(e){e.exports=JSON.parse('{"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":false},"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":false},"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":false},"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":false},"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},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"}},"title":"document_document_id_body"}}}}}')},24083(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.cdf4efaf.js b/assets/js/runtime~main.fcb26af5.js similarity index 87% rename from assets/js/runtime~main.cdf4efaf.js rename to assets/js/runtime~main.fcb26af5.js index fc9ea9a1b..51998e1c2 100644 --- a/assets/js/runtime~main.cdf4efaf.js +++ b/assets/js/runtime~main.fcb26af5.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every(e=>t.O[e](c[o]))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;("object"==typeof r||"function"==typeof r)&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach(a=>d[a]=()=>e[a]);return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce((a,c)=>(t.f[c](e,a),a),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",225:"0a7196e9",284:"107ddcf4",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",791:"4acb0154",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1170:"c1e4445e",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",2075:"5c485335",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3522:"e785206d",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",3979:"64218a31",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4360:"fdd9b680",4372:"9cd612ce",4466:"56b0ffe9",4504:"5a9dd378",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",5919:"980c6622",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6302:"873e7b96",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6827:"0edab2fb",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7381:"20f41f87",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7797:"767ebc75",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8045:"fff7b69d",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",9144:"dc8c216b",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:"7775a8c7",89:"5fffa456",108:"64a23058",157:"091ea7cc",225:"8462aa74",284:"1c228532",285:"8435fee8",291:"a279f85b",300:"75038f51",414:"d9ebe090",419:"9c4ab6f7",448:"bbb653b1",490:"d60e1aa5",539:"83e3b2e8",560:"7803705b",636:"62348973",746:"325cb926",791:"2288be4d",841:"6a4b2b2a",849:"67efe465",850:"1804dfd1",930:"9839796a",956:"a9f72a7c",962:"015ebae2",1071:"c7360ae7",1170:"5a136b56",1179:"f0770394",1235:"003a3080",1440:"57b00896",1477:"0bf93bf5",1640:"19c88b9d",1651:"b6511a1f",1665:"70b02a21",1679:"73c2d6cf",1688:"2eece972",1706:"8e5b964f",1903:"785e5b99",1912:"cc2345fe",1924:"f8e076e4",1972:"ff8b2872",2042:"32fe4d68",2043:"4c8bce3e",2075:"df6204f3",2089:"9933bb5d",2131:"19ba9fe4",2237:"108a9157",2264:"cc833a03",2634:"888e8dd3",2661:"811da9ef",2703:"552e34c0",2711:"0fb5e6f4",2723:"38950730",2908:"08ef6789",3021:"796c3720",3073:"b2fc1997",3128:"daf594c6",3148:"2c761e08",3230:"a2e9d89a",3249:"8f79f73c",3276:"008069e2",3333:"3f02f75e",3381:"d96d7994",3392:"b97ea8b4",3404:"1f15063a",3460:"2dd0ae0e",3522:"34ed0fa3",3633:"3543e66d",3637:"6da0a8ef",3694:"eee67721",3724:"7ab9019b",3795:"10aaef2b",3841:"ed30d7af",3891:"834d9fec",3976:"764c295e",3979:"a0a09b08",4001:"153f1231",4106:"414f7bf5",4132:"7b747113",4134:"9b3a8f1c",4212:"0e755c39",4232:"a3f67927",4240:"69daa0e7",4360:"2c92b14d",4372:"0b88ef19",4466:"0bbb4afd",4504:"e8c61b63",4528:"46620c6e",4584:"912dd911",4813:"54f83ddb",4833:"9fa0d100",4865:"8f6972fe",4952:"2f23e17d",5277:"51dc7184",5305:"27ce96bb",5314:"4618bbd3",5342:"7c540bbe",5373:"c21db2c6",5453:"43c63b5b",5506:"03f5edc2",5510:"04b3013f",5524:"231bf8ca",5550:"56699010",5557:"d57a200d",5597:"7ebbc525",5742:"3a86eee7",5752:"aabfabae",5794:"93887e5a",5855:"fe0cb846",5881:"1b445937",5919:"a4243b7a",5939:"1b48abd3",5970:"34d283be",6007:"9fdd6943",6011:"c1668ab5",6061:"abda21d3",6157:"901c6cfd",6173:"105dd0ca",6192:"6895b540",6235:"2e7753be",6288:"20a24892",6295:"339131ae",6302:"b085f100",6318:"1f3b4b7a",6328:"144e834f",6353:"66bcd084",6463:"aac36e3b",6473:"e486fbe3",6505:"1a09839e",6648:"71eb864c",6653:"7a297ce4",6743:"78b01270",6827:"019b45cf",6841:"66228efa",6887:"7787cb28",6940:"cbf19973",6969:"b3417929",7024:"86374301",7068:"49b54587",7075:"8d450b23",7098:"8d5f8fb2",7318:"6b9423c6",7381:"1bea2d82",7458:"2fcc11dd",7465:"99ac3ed0",7472:"3d15491a",7477:"34d27d99",7570:"03fef906",7574:"685b1e0d",7627:"7889e0e7",7643:"b7548944",7696:"ddf4fc1f",7757:"c5cdb34e",7797:"3737fe1e",7904:"da1a989a",7910:"fb0513ce",7960:"5e2aac96",7968:"1ceec687",8e3:"5f213fe5",8025:"17a95b1d",8045:"d21f5ddf",8046:"e134ab25",8097:"2e99f5e1",8110:"90090a5e",8121:"2d763874",8130:"76b1143f",8146:"5c2d59cd",8168:"5aa219c0",8209:"62c19f54",8446:"0d3ab8a6",8462:"1f56558e",8474:"888ddfc8",8503:"fb529628",8564:"08a333f9",8609:"02c23c06",8734:"9c808716",8737:"8e85287d",8749:"cf8e6065",8901:"ca710393",8927:"9f798ddf",8947:"5ba068d6",9024:"4374b082",9048:"0aba8270",9070:"9cbda560",9099:"a8f0af8c",9144:"ad5401bb",9190:"213303b0",9239:"9a4ec69f",9241:"a7b876f3",9260:"2347dc4f",9325:"a55b9919",9328:"0483f371",9340:"8c6018fb",9342:"29e99769",9350:"bf61376f",9426:"9c1f84e8",9429:"962e495c",9490:"c1150a5d",9570:"b73d3f30",9611:"e86f0734",9647:"74f05f80",9785:"bb17f8c9",9858:"1304f4ed",9979:"316d7e72"}[e]+".js",t.miniCssF=e=>{},t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach(e=>e(c)),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","0a7196e9":"225","107ddcf4":"284","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746","4acb0154":"791",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962",c1e4445e:"1170","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","5c485335":"2075",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",e785206d:"3522",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976","64218a31":"3979",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240",fdd9b680:"4360","9cd612ce":"4372","56b0ffe9":"4466","5a9dd378":"4504",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","980c6622":"5919","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295","873e7b96":"6302",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743","0edab2fb":"6827",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318","20f41f87":"7381",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","767ebc75":"7797","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025",fff7b69d:"8045","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",dc8c216b:"9144","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 b=new Promise((c,b)=>f=e[a]=[c,b]);c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}},"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,[d,r,o]=c,l=0;if(d.some(a=>0!==e[a])){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every(e=>t.O[e](c[o]))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;("object"==typeof r||"function"==typeof r)&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach(a=>d[a]=()=>e[a]);return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce((a,c)=>(t.f[c](e,a),a),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",225:"0a7196e9",284:"107ddcf4",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",791:"4acb0154",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1170:"c1e4445e",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",2075:"5c485335",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3522:"e785206d",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",3979:"64218a31",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4360:"fdd9b680",4372:"9cd612ce",4466:"56b0ffe9",4504:"5a9dd378",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",5919:"980c6622",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6302:"873e7b96",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6827:"0edab2fb",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7381:"20f41f87",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7797:"767ebc75",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8045:"fff7b69d",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",9144:"dc8c216b",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:"f6a38190",89:"5fffa456",108:"64a23058",157:"091ea7cc",225:"8462aa74",284:"1c228532",285:"323d81b9",291:"a279f85b",300:"75038f51",414:"d9ebe090",419:"9c4ab6f7",448:"bbb653b1",490:"d60e1aa5",539:"83e3b2e8",560:"7803705b",636:"62348973",746:"325cb926",791:"2288be4d",841:"6a4b2b2a",849:"67efe465",850:"1804dfd1",930:"9839796a",956:"a9f72a7c",962:"015ebae2",1071:"c7360ae7",1170:"5a136b56",1179:"f0770394",1235:"003a3080",1440:"57b00896",1477:"0bf93bf5",1640:"19c88b9d",1651:"456209b0",1665:"1ede26e4",1679:"09d89b2c",1688:"2eece972",1706:"7a9128dc",1903:"785e5b99",1912:"cc2345fe",1924:"f8e076e4",1972:"ff8b2872",2042:"32fe4d68",2043:"a547ee47",2075:"df6204f3",2089:"9933bb5d",2131:"19ba9fe4",2237:"108a9157",2264:"cc833a03",2634:"888e8dd3",2661:"811da9ef",2703:"3444bc9f",2711:"0fb5e6f4",2723:"38950730",2908:"08ef6789",3021:"796c3720",3073:"b2fc1997",3128:"daf594c6",3148:"2c761e08",3230:"2ba7de5a",3249:"8f79f73c",3276:"008069e2",3333:"3f02f75e",3381:"d96d7994",3392:"b97ea8b4",3404:"287ef655",3460:"2c09e8ba",3522:"34ed0fa3",3633:"3543e66d",3637:"6da0a8ef",3694:"eee67721",3724:"7ab9019b",3795:"83c3cb4c",3841:"ed30d7af",3891:"834d9fec",3976:"764c295e",3979:"2dc08ef1",4001:"153f1231",4106:"414f7bf5",4132:"7b747113",4134:"9b3a8f1c",4212:"0e755c39",4232:"31c1c944",4240:"e9f5b614",4360:"2c92b14d",4372:"073baa5b",4466:"0bbb4afd",4504:"e8c61b63",4528:"46620c6e",4584:"912dd911",4813:"54f83ddb",4833:"0e8215f8",4865:"d44ee1ec",4952:"2f23e17d",5277:"51dc7184",5305:"27ce96bb",5314:"4618bbd3",5342:"e04ea00d",5373:"9d8345bc",5453:"43c63b5b",5506:"03f5edc2",5510:"04b3013f",5524:"231bf8ca",5550:"56699010",5557:"d57a200d",5597:"7ebbc525",5742:"3a86eee7",5752:"f7d7ed8f",5794:"93887e5a",5855:"fe0cb846",5881:"1b445937",5919:"f03d02d3",5939:"1b48abd3",5970:"34d283be",6007:"9fdd6943",6011:"c1668ab5",6061:"abda21d3",6157:"901c6cfd",6173:"105dd0ca",6192:"52cdc692",6235:"92382723",6288:"20a24892",6295:"339131ae",6302:"b085f100",6318:"1f3b4b7a",6328:"144e834f",6353:"66bcd084",6463:"aac36e3b",6473:"e486fbe3",6505:"1a09839e",6648:"71eb864c",6653:"7a297ce4",6743:"78b01270",6827:"019b45cf",6841:"66228efa",6887:"7787cb28",6940:"cbf19973",6969:"b3417929",7024:"cbe389b6",7068:"49b54587",7075:"cdb488f7",7098:"8d5f8fb2",7318:"6b9423c6",7381:"1bea2d82",7458:"2fcc11dd",7465:"99ac3ed0",7472:"3d15491a",7477:"34d27d99",7570:"03fef906",7574:"685b1e0d",7627:"7889e0e7",7643:"b7548944",7696:"ddf4fc1f",7757:"c5cdb34e",7797:"c1c27f9c",7904:"48a68cda",7910:"fb0513ce",7960:"26dcf7b4",7968:"1ceec687",8e3:"5f213fe5",8025:"17a95b1d",8045:"d21f5ddf",8046:"e134ab25",8097:"2e99f5e1",8110:"90090a5e",8121:"2d763874",8130:"76b1143f",8146:"5c2d59cd",8168:"5aa219c0",8209:"62c19f54",8446:"0d3ab8a6",8462:"1f56558e",8474:"888ddfc8",8503:"fb529628",8564:"338d50e6",8609:"02c23c06",8734:"9c808716",8737:"8e85287d",8749:"acc67002",8901:"7e9acdf0",8927:"9f798ddf",8947:"5ba068d6",9024:"4374b082",9048:"0aba8270",9070:"e97dbd53",9099:"e208adbc",9144:"ad5401bb",9190:"213303b0",9239:"9a4ec69f",9241:"a7b876f3",9260:"2347dc4f",9325:"a55b9919",9328:"0483f371",9340:"8c6018fb",9342:"29e99769",9350:"51187a34",9426:"9c1f84e8",9429:"962e495c",9490:"c1150a5d",9570:"b73d3f30",9611:"e86f0734",9647:"74f05f80",9785:"bb17f8c9",9858:"1304f4ed",9979:"316d7e72"}[e]+".js",t.miniCssF=e=>{},t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach(e=>e(c)),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","0a7196e9":"225","107ddcf4":"284","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746","4acb0154":"791",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962",c1e4445e:"1170","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","5c485335":"2075",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",e785206d:"3522",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976","64218a31":"3979",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240",fdd9b680:"4360","9cd612ce":"4372","56b0ffe9":"4466","5a9dd378":"4504",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","980c6622":"5919","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295","873e7b96":"6302",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743","0edab2fb":"6827",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318","20f41f87":"7381",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","767ebc75":"7797","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025",fff7b69d:"8045","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",dc8c216b:"9144","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 b=new Promise((c,b)=>f=e[a]=[c,b]);c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}},"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,[d,r,o]=c,l=0;if(d.some(a=>0!==e[a])){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index 2716ccf84..1e8e87690 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 e88b9d7d1..9bfe54b5a 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 ee9302f85..13c3e222f 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 c454e93d3..84ef0188b 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 28ab3077b..a2a831a2f 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 492f5ea2a..64678c754 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 501e7d08d..14f3c3ab3 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 77bf8da87..d66c179f1 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 a72d43892..139b6432c 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 dde818433..b13c05e84 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 51e209f81..a59045743 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 f76fce753..b2c0014f1 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 ac56c260d..7bbf3714a 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 321a76c06..e29ab4d26 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 c2f3baf03..0415d943d 100644 --- a/docs/API-docs/v1.1/createdocument/index.html +++ b/docs/API-docs/v1.1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html index 2b497f51e..e9df1dc13 100644 --- a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createfolder/index.html b/docs/API-docs/v1.1/createfolder/index.html index 518e7d9cb..e53e1fd76 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 37b3e3b22..583b8108e 100644 --- a/docs/API-docs/v1.1/createtemplate/index.html +++ b/docs/API-docs/v1.1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/delete-template/index.html b/docs/API-docs/v1.1/delete-template/index.html index 608760313..3baa6e695 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 8e2c70735..7b037d424 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 32d75d88b..213eb83db 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 d02e64717..789c87747 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 6abd66e13..7a1069a69 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 1b185ac54..bb15ab7ab 100644 --- a/docs/API-docs/v1.1/draftdocument/index.html +++ b/docs/API-docs/v1.1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/drafttemplate/index.html b/docs/API-docs/v1.1/drafttemplate/index.html index 2ec9fa6c1..9d6673ab4 100644 --- a/docs/API-docs/v1.1/drafttemplate/index.html +++ b/docs/API-docs/v1.1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/folderlist/index.html b/docs/API-docs/v1.1/folderlist/index.html index 408b6ec00..055e57d6f 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 686e3b5cd..130348c49 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 2e90237b2..a6a196e54 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 39eb23b1d..a192c1113 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 e0b9269da..1d0c93092 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 681f52048..9b72da4c7 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 7d05d5245..6fa2b3d55 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 563e40f36..563f46872 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 846bae10d..703e48b33 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/getformdata/index.html b/docs/API-docs/v1.1/getformdata/index.html index dd944b53c..1f5f7fabb 100644 --- a/docs/API-docs/v1.1/getformdata/index.html +++ b/docs/API-docs/v1.1/getformdata/index.html @@ -5,7 +5,7 @@ Get Formdata | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getsignerips/index.html b/docs/API-docs/v1.1/getsignerips/index.html index f8736e658..8ccdc6c83 100644 --- a/docs/API-docs/v1.1/getsignerips/index.html +++ b/docs/API-docs/v1.1/getsignerips/index.html @@ -5,7 +5,7 @@ Get Signer IPs | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getsigninglinks/index.html b/docs/API-docs/v1.1/getsigninglinks/index.html index a8af97dd4..e7551bbe3 100644 --- a/docs/API-docs/v1.1/getsigninglinks/index.html +++ b/docs/API-docs/v1.1/getsigninglinks/index.html @@ -5,7 +5,7 @@ Get Signing Links | OpenSign™ - + diff --git a/docs/API-docs/v1.1/gettemplatelist/index.html b/docs/API-docs/v1.1/gettemplatelist/index.html index e922b3b39..03c477a52 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 77c0288ca..3f28b1c9f 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 cc1555d4f..314f239a7 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 155ade500..c25d2686e 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™ - + @@ -15,7 +15,7 @@
Version: 1.0.0

OpenSign API v1.1

Welcome to the OpenSign™ API v1.1 documentation.

-

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

+

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

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

Useful Links:

    diff --git a/docs/API-docs/v1.1/publictemplate/index.html b/docs/API-docs/v1.1/publictemplate/index.html index 976fb84ad..e76f10edc 100644 --- a/docs/API-docs/v1.1/publictemplate/index.html +++ b/docs/API-docs/v1.1/publictemplate/index.html @@ -5,7 +5,7 @@ Public Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/resendrequestmail/index.html b/docs/API-docs/v1.1/resendrequestmail/index.html index 0bd59ba21..4f2d904f8 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 72e8fd34f..882d324fc 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 bcef4c150..a6fc79696 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 304348f21..0ca030063 100644 --- a/docs/API-docs/v1.1/selfsign/index.html +++ b/docs/API-docs/v1.1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/v1.1/update-document/index.html b/docs/API-docs/v1.1/update-document/index.html index ab4893ce3..d0c2ce895 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 ee70576fb..8760118ef 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 647f587bf..0d10f83ea 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 0f342fbf7..c5c1be19a 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 9e186489b..cd83b9b6e 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 d9cb0a0aa..43aed66eb 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 906aa1d9d..270d7a3f6 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 d101cc291..8c65c17c6 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 91a22a669..27c5cbf25 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 90fea0e5d..bdc0a4baf 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 0bc11cc2a..cc44f7ca3 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 33336995c..f4cf68df8 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 b47878249..9016fefc8 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 2b054f250..161f91917 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 3667b0982..e329416b6 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 513817b1c..d2f83fedd 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 7f0a904cd..5cd258345 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 8bf42c476..4652a2467 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 816ac35ac..3405e1732 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 9d07d3c31..06e2fac89 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 2769dc2f2..f8301120f 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 c6c0ab5fd..5f896c9c2 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 d289f52ff..56701a3a5 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 f3cb3beb2..57c031a55 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 563872a71..5eae07797 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 8ce98b611..e53f8ae4d 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 94f2ca9d0..6ef85afde 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 5ad8f8043..aca217a9f 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 68ef05c58..dc42709f5 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 faf7e5b37..8e975045b 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 3b6e84823..367672fdc 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 6371804ed..45efa518b 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 52c30ef7e..4839b591d 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 7312ab363..8c271c5d9 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 f57e2a08f..087fa6250 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 7d89f6388..5e88ed8c9 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/console/index.html b/docs/category/console/index.html index 00420db07..48e91116c 100644 --- a/docs/category/console/index.html +++ b/docs/category/console/index.html @@ -5,7 +5,7 @@ Console | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index e46ba9651..ce6e238cb 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 0463c4806..1f3d13574 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 022432cca..4cc63c4ce 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 e25ec925e..43013cabd 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 aa688d6d9..3cf5d9f32 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 21f14d211..1988aefac 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 21dfd254a..8e175e590 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 e5c484439..70dfa1132 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 631c275bb..46027cda2 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 75ac8a604..ba6241713 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 9732b72a5..3fb4200f9 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 25502b3d5..8ddc0e282 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 86bd4496a..e37b54e73 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 65825bbd0..6162c8ab3 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/Credit-Deductions/index.html b/docs/help/FAQs/Credit-Deductions/index.html index 9de714385..01de7f285 100644 --- a/docs/help/FAQs/Credit-Deductions/index.html +++ b/docs/help/FAQs/Credit-Deductions/index.html @@ -5,7 +5,7 @@ Credit-Deductions | 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 41af36831..968b5a05e 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 82e456844..1e298688a 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 0df765b90..6d1f55348 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 996033a36..2a8684699 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 9bac52a59..97dde2598 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 b34ca407c..ea237b351 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/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 6fe419050..502d99baf 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 91c7c25b8..1583970c2 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/New-Document/widgets/index.html b/docs/help/New-Document/widgets/index.html index fe11f73a4..db1524ab6 100644 --- a/docs/help/New-Document/widgets/index.html +++ b/docs/help/New-Document/widgets/index.html @@ -5,7 +5,7 @@ Widgets in OpenSign | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index a039158dd..326363a1c 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 eb58773b0..4449ce4f4 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 850b8b1e4..88e51ab1b 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 31d027b26..ea23c4377 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 d68937191..014ca6eb9 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 f1dc6c03a..034a0ed80 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 b5c584119..81868bcc9 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 ab5723459..d3689bc09 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 4eed69274..87d5cd3c0 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 49cf0f3ee..1d6bff818 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 102c64ec7..5d4719322 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 15e5cef4e..72e61fa8d 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 dd736ffaa..66809ad22 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 90209f4a9..2661580c3 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 7bd99b953..f6ccacc7d 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 5468f787d..64ffc8003 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 e1270d21d..7c9630e34 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 fffb294b5..c3cd8e987 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 6dc684b70..f488ffd3f 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 02332a31c..8c4771c54 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 c0a2fce79..62361feff 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 a3e06fc4d..53eda9af0 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 4155f9b24..cae65e29c 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 c58d65fa5..5f934eccc 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 7b4f8c55a..c64683a1b 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Bulk Document Send for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index 98ac6238e..33e361827 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/Console/analystics/index.html b/docs/help/User Menu/Console/analystics/index.html index 4ff6cba5e..e3578ce27 100644 --- a/docs/help/User Menu/Console/analystics/index.html +++ b/docs/help/User Menu/Console/analystics/index.html @@ -5,7 +5,7 @@ Analytics | OpenSign™ - + diff --git a/docs/help/User Menu/Console/branding/index.html b/docs/help/User Menu/Console/branding/index.html index 44547b243..7538d46d0 100644 --- a/docs/help/User Menu/Console/branding/index.html +++ b/docs/help/User Menu/Console/branding/index.html @@ -5,7 +5,7 @@ Branding | OpenSign™ - + diff --git a/docs/help/User Menu/Console/custom_filestorage/index.html b/docs/help/User Menu/Console/custom_filestorage/index.html index 6d8a371ca..df522e7e4 100644 --- a/docs/help/User Menu/Console/custom_filestorage/index.html +++ b/docs/help/User Menu/Console/custom_filestorage/index.html @@ -5,7 +5,7 @@ Custom File Storage | OpenSign™ - + diff --git a/docs/help/User Menu/Console/emails/index.html b/docs/help/User Menu/Console/emails/index.html index 94c3ac5fa..048b1eb2b 100644 --- a/docs/help/User Menu/Console/emails/index.html +++ b/docs/help/User Menu/Console/emails/index.html @@ -5,7 +5,7 @@ Mail | OpenSign™ - + diff --git a/docs/help/User Menu/Console/general/index.html b/docs/help/User Menu/Console/general/index.html index 450e9ab0c..adc570a7a 100644 --- a/docs/help/User Menu/Console/general/index.html +++ b/docs/help/User Menu/Console/general/index.html @@ -5,7 +5,7 @@ General | OpenSign™ - + diff --git a/docs/help/User Menu/Console/globalSMTP/index.html b/docs/help/User Menu/Console/globalSMTP/index.html index 04d0aafc7..4000c5cc3 100644 --- a/docs/help/User Menu/Console/globalSMTP/index.html +++ b/docs/help/User Menu/Console/globalSMTP/index.html @@ -5,7 +5,7 @@ Global SMTP | OpenSign™ - + diff --git a/docs/help/User Menu/Console/orgadmin/index.html b/docs/help/User Menu/Console/orgadmin/index.html index 87267ee00..dc6cf3604 100644 --- a/docs/help/User Menu/Console/orgadmin/index.html +++ b/docs/help/User Menu/Console/orgadmin/index.html @@ -5,7 +5,7 @@ Org Admins | OpenSign™ - + diff --git a/docs/help/User Menu/Console/organizations/index.html b/docs/help/User Menu/Console/organizations/index.html index 77db79a27..4b0d696a8 100644 --- a/docs/help/User Menu/Console/organizations/index.html +++ b/docs/help/User Menu/Console/organizations/index.html @@ -5,7 +5,7 @@ Organizations | OpenSign™ - + diff --git a/docs/help/User Menu/Console/signing_certificate/index.html b/docs/help/User Menu/Console/signing_certificate/index.html index 0c8f74058..dc503c51b 100644 --- a/docs/help/User Menu/Console/signing_certificate/index.html +++ b/docs/help/User Menu/Console/signing_certificate/index.html @@ -5,7 +5,7 @@ Custom Signing Certificate | OpenSign™ - + diff --git a/docs/help/User Menu/Profile/index.html b/docs/help/User Menu/Profile/index.html index ad6e1fefb..f2136227f 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 e715e141b..caee0d9fb 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 63eb465d5..510be282e 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 800644840..7f135acf7 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 84d5106ee..3c1dbd755 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 b3a99bce0..b85a3581c 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 ed7949a01..88fb8309c 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 fc18d6cc8..152a7c4f2 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 e00261a75..7f7974bb2 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 27e489872..b319ca123 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 e304e0bce..ef9c3da48 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 73f799b32..5afb4b9b6 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 cb2dae057..ec9f25801 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 00e889789..9b2268453 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +